AWS.ServiceQuotas reference

GetAutoManagementConfiguration

Source: src/AWS/ServiceQuotas/GetAutoManagementConfiguration.ts

Runtime binding for servicequotas:GetAutoManagementConfiguration — read the account’s Service Quotas Auto Management opt-in status (opt-in type, notification target, excluded quotas) from inside a Function.

GetAutoManagementConfiguration: Auto Management

// init
const getAutoManagementConfiguration =
  yield* AWS.ServiceQuotas.GetAutoManagementConfiguration();

// runtime — fails with the typed NoSuchResourceException when the
// account has not opted in to Auto Management
const config = yield* getAutoManagementConfiguration();
const optIn = config.OptInType; // NotifyOnly | NotifyAndAdjust

GetAWSDefaultServiceQuota

Source: src/AWS/ServiceQuotas/GetAWSDefaultServiceQuota.ts

Runtime binding for servicequotas:GetAWSDefaultServiceQuota — read the AWS default value of a quota (the value that applies when no account override exists) from inside a Function.

GetAWSDefaultServiceQuota: Reading Quotas

// init
const getAWSDefaultServiceQuota =
  yield* AWS.ServiceQuotas.GetAWSDefaultServiceQuota();

// runtime
const { Quota } = yield* getAWSDefaultServiceQuota({
  ServiceCode: "vpc",
  QuotaCode: "L-F678F1CE",
});
const defaultValue = Quota?.Value;

GetQuotaUtilizationReport

Source: src/AWS/ServiceQuotas/GetQuotaUtilizationReport.ts

Runtime binding for servicequotas:GetQuotaUtilizationReport — read the result of a utilization report started with StartQuotaUtilizationReport from inside a Function.

GetQuotaUtilizationReport: Utilization Reports

// init
const getQuotaUtilizationReport =
  yield* AWS.ServiceQuotas.GetQuotaUtilizationReport();

// runtime
const { Status, QuotaUtilizationList } = yield* getQuotaUtilizationReport({
  ReportId: reportId,
});

GetRequestedServiceQuotaChange

Source: src/AWS/ServiceQuotas/GetRequestedServiceQuotaChange.ts

Runtime binding for servicequotas:GetRequestedServiceQuotaChange — read the status of a quota increase request from inside a Function (e.g. to poll a request submitted with RequestServiceQuotaIncrease).

GetRequestedServiceQuotaChange: Quota Increase Requests

// init
const getRequestedServiceQuotaChange =
  yield* AWS.ServiceQuotas.GetRequestedServiceQuotaChange();

// runtime
const { RequestedQuota } = yield* getRequestedServiceQuotaChange({
  RequestId: requestId,
});
const status = RequestedQuota?.Status; // PENDING | APPROVED | ...

GetServiceQuota

Source: src/AWS/ServiceQuotas/GetServiceQuota.ts

Runtime binding for servicequotas:GetServiceQuota — read the applied value of any Service Quotas quota (account-level or resource-level) from inside a Function.

Service Quotas is a read-mostly control-plane service with no resource to manage for reads: the binding takes no arguments and grants the function servicequotas:GetServiceQuota (the action has no resource-level IAM). Pass the raw distilled request — no marshalling.

GetServiceQuota: Reading Quotas

// init
const getServiceQuota = yield* AWS.ServiceQuotas.GetServiceQuota();

// runtime
const { Quota } = yield* getServiceQuota({
  ServiceCode: "lambda",
  QuotaCode: "L-B99A9384",
});
const applied = Quota?.Value;

ListAWSDefaultServiceQuotas

Source: src/AWS/ServiceQuotas/ListAWSDefaultServiceQuotas.ts

Runtime binding for servicequotas:ListAWSDefaultServiceQuotas — list the AWS default values for every quota of a service from inside a Function.

ListAWSDefaultServiceQuotas: Listing Quotas

// init
const listAWSDefaultServiceQuotas =
  yield* AWS.ServiceQuotas.ListAWSDefaultServiceQuotas();

// runtime
const { Quotas } = yield* listAWSDefaultServiceQuotas({
  ServiceCode: "lambda",
});

ListRequestedServiceQuotaChangeHistory

Source: src/AWS/ServiceQuotas/ListRequestedServiceQuotaChangeHistory.ts

Runtime binding for servicequotas:ListRequestedServiceQuotaChangeHistory — list quota increase requests in the account’s 90-day request history from inside a Function, optionally filtered by service or status.

ListRequestedServiceQuotaChangeHistory: Quota Increase Requests

// init
const listRequestedServiceQuotaChangeHistory =
  yield* AWS.ServiceQuotas.ListRequestedServiceQuotaChangeHistory();

// runtime
const { RequestedQuotas } = yield* listRequestedServiceQuotaChangeHistory({
  Status: "PENDING",
});

ListRequestedServiceQuotaChangeHistoryByQuota

Source: src/AWS/ServiceQuotas/ListRequestedServiceQuotaChangeHistoryByQuota.ts

Runtime binding for servicequotas:ListRequestedServiceQuotaChangeHistoryByQuota — list quota increase requests for one specific quota from inside a Function.

ListRequestedServiceQuotaChangeHistoryByQuota: Quota Increase Requests

// init
const listRequestedServiceQuotaChangeHistoryByQuota =
  yield* AWS.ServiceQuotas.ListRequestedServiceQuotaChangeHistoryByQuota();

// runtime
const { RequestedQuotas } =
  yield* listRequestedServiceQuotaChangeHistoryByQuota({
    ServiceCode: "lambda",
    QuotaCode: "L-B99A9384",
  });

ListServiceQuotas

Source: src/AWS/ServiceQuotas/ListServiceQuotas.ts

Runtime binding for servicequotas:ListServiceQuotas — list the applied quota values for a service from inside a Function.

ListServiceQuotas: Listing Quotas

// init
const listServiceQuotas = yield* AWS.ServiceQuotas.ListServiceQuotas();

// runtime
const { Quotas } = yield* listServiceQuotas({
  ServiceCode: "vpc",
  MaxResults: 50,
});

ListServices

Source: src/AWS/ServiceQuotas/ListServices.ts

Runtime binding for servicequotas:ListServices — list the services that integrate with Service Quotas (and their service codes) from inside a Function.

ListServices: Listing Quotas

// init
const listServices = yield* AWS.ServiceQuotas.ListServices();

// runtime
const { Services } = yield* listServices({ MaxResults: 100 });
const lambda = Services?.find((s) => s.ServiceCode === "lambda");

RequestServiceQuotaIncrease

Source: src/AWS/ServiceQuotas/RequestServiceQuotaIncrease.ts

Runtime binding for servicequotas:RequestServiceQuotaIncrease — submit a quota increase request from inside a Function (e.g. automatically request more capacity when utilization approaches the limit).

Caution

Submitting a request may open an AWS Support case and cannot be cancelled through the Service Quotas API. For declaratively managed increases prefer the ServiceQuotaIncreaseRequest resource.

RequestServiceQuotaIncrease: Quota Increase Requests

// init
const requestServiceQuotaIncrease =
  yield* AWS.ServiceQuotas.RequestServiceQuotaIncrease();

// runtime
const { RequestedQuota } = yield* requestServiceQuotaIncrease({
  ServiceCode: "lambda",
  QuotaCode: "L-B99A9384",
  DesiredValue: 2000,
});
const requestId = RequestedQuota?.Id;

StartQuotaUtilizationReport

Source: src/AWS/ServiceQuotas/StartQuotaUtilizationReport.ts

Runtime binding for servicequotas:StartQuotaUtilizationReport — kick off an asynchronous account-wide quota utilization report from inside a Function. Poll the result with GetQuotaUtilizationReport.

StartQuotaUtilizationReport: Utilization Reports

// init
const startQuotaUtilizationReport =
  yield* AWS.ServiceQuotas.StartQuotaUtilizationReport();

// runtime
const { ReportId } = yield* startQuotaUtilizationReport();