2025/12/15 - Service Quotas - 2 new4 updated api methods
Changes Add support for SQ Dashboard Api
Initiates the generation of a quota utilization report for your Amazon Web Services account. This asynchronous operation analyzes your quota usage across all Amazon Web Services services and returns a unique report identifier that you can use to retrieve the results.
The report generation process may take several seconds to complete, depending on the number of quotas in your account. Use the GetQuotaUtilizationReport operation to check the status and retrieve the results when the report is ready.
See also: AWS API Documentation
Request Syntax
client.start_quota_utilization_report()
dict
Response Syntax
{
'ReportId': 'string',
'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
'Message': 'string'
}
Response Structure
(dict) --
ReportId (string) --
A unique identifier for the quota utilization report. Use this identifier with the GetQuotaUtilizationReport operation to retrieve the report results.
Status (string) --
The current status of the report generation. The status will be PENDING when the report is first initiated.
Message (string) --
An optional message providing additional information about the report generation status. This field may contain details about the report initiation or indicate if an existing recent report is being reused.
Retrieves the quota utilization report for your Amazon Web Services account. This operation returns paginated results showing your quota usage across all Amazon Web Services services, sorted by utilization percentage in descending order (highest utilization first).
You must first initiate a report using the StartQuotaUtilizationReport operation. The report generation process is asynchronous and may take several seconds to complete. Poll this operation periodically to check the status and retrieve results when the report is ready.
Each report contains up to 1,000 quota records per page. Use the NextToken parameter to retrieve additional pages of results. Reports are automatically deleted after 15 minutes.
See also: AWS API Documentation
Request Syntax
client.get_quota_utilization_report(
ReportId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The unique identifier for the quota utilization report. This identifier is returned by the StartQuotaUtilizationReport operation.
string
A token that indicates the next page of results to retrieve. This token is returned in the response when there are more results available. Omit this parameter for the first request.
integer
The maximum number of results to return per page. The default value is 1,000 and the maximum allowed value is 1,000.
dict
Response Syntax
{
'ReportId': 'string',
'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
'GeneratedAt': datetime(2015, 1, 1),
'TotalCount': 123,
'Quotas': [
{
'QuotaCode': 'string',
'ServiceCode': 'string',
'QuotaName': 'string',
'Namespace': 'string',
'Utilization': 123.0,
'DefaultValue': 123.0,
'AppliedValue': 123.0,
'ServiceName': 'string',
'Adjustable': True|False
},
],
'NextToken': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
}
Response Structure
(dict) --
ReportId (string) --
The unique identifier for the quota utilization report.
Status (string) --
The current status of the report generation. Possible values are:
PENDING - The report generation is in progress. Retry this operation after a few seconds.
IN_PROGRESS - The report is being processed. Continue polling until the status changes to COMPLETED.
COMPLETED - The report is ready and quota utilization data is available in the response.
FAILED - The report generation failed. Check the ErrorCode and ErrorMessage fields for details.
GeneratedAt (datetime) --
The timestamp when the report was generated, in ISO 8601 format.
TotalCount (integer) --
The total number of quotas included in the report across all pages.
Quotas (list) --
A list of quota utilization records, sorted by utilization percentage in descending order. Each record includes the quota code, service code, service name, quota name, namespace, utilization percentage, default value, applied value, and whether the quota is adjustable. Up to 1,000 records are returned per page.
(dict) --
Information about a quota's utilization, including the quota code, service information, current usage, and applied limits.
QuotaCode (string) --
The quota identifier.
ServiceCode (string) --
The service identifier.
QuotaName (string) --
The quota name.
Namespace (string) --
The namespace of the metric used to track quota usage.
Utilization (float) --
The utilization percentage of the quota, calculated as (current usage / applied value) × 100. Values range from 0.0 to 100.0 or higher if usage exceeds the quota limit.
DefaultValue (float) --
The default value of the quota.
AppliedValue (float) --
The applied value of the quota, which may be higher than the default value if a quota increase has been requested and approved.
ServiceName (string) --
The service name.
Adjustable (boolean) --
Indicates whether the quota value can be increased.
NextToken (string) --
A token that indicates more results are available. Include this token in the next request to retrieve the next page of results. If this field is not present, you have retrieved all available results.
ErrorCode (string) --
An error code indicating the reason for failure when the report status is FAILED. This field is only present when the status is FAILED.
ErrorMessage (string) --
A detailed error message describing the failure when the report status is FAILED. This field is only present when the status is FAILED.
{'RequestedQuota': {'RequestType': 'AutomaticManagement'}}
Retrieves information about the specified quota increase request.
See also: AWS API Documentation
Request Syntax
client.get_requested_service_quota_change(
RequestId='string'
)
string
[REQUIRED]
Specifies the ID of the quota increase request.
dict
Response Syntax
{
'RequestedQuota': {
'Id': 'string',
'RequestType': 'AutomaticManagement',
'CaseId': 'string',
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'DesiredValue': 123.0,
'Status': 'PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED'|'NOT_APPROVED'|'INVALID_REQUEST',
'Created': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Requester': 'string',
'QuotaArn': 'string',
'GlobalQuota': True|False,
'Unit': 'string',
'QuotaRequestedAtLevel': 'ACCOUNT'|'RESOURCE'|'ALL',
'QuotaContext': {
'ContextScope': 'RESOURCE'|'ACCOUNT',
'ContextScopeType': 'string',
'ContextId': 'string'
}
}
}
Response Structure
(dict) --
RequestedQuota (dict) --
Information about the quota increase request.
Id (string) --
The unique identifier.
RequestType (string) --
The type of quota increase request. Possible values include:
AutomaticManagement - The request was automatically created by Service Quotas Automatic Management when quota utilization approached the limit.
If this field is not present, the request was manually created by a user.
CaseId (string) --
The case ID.
ServiceCode (string) --
Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.
ServiceName (string) --
Specifies the service name.
QuotaCode (string) --
Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.
QuotaName (string) --
Specifies the quota name.
DesiredValue (float) --
The new, increased value for the quota.
Status (string) --
The state of the quota increase request.
PENDING: The quota increase request is under review by Amazon Web Services.
CASE_OPENED: Service Quotas opened a support case to process the quota increase request. Follow-up on the support case for more information.
APPROVED: The quota increase request is approved.
DENIED: The quota increase request can't be approved by Service Quotas. Contact Amazon Web Services Support for more details.
NOT APPROVED: The quota increase request can't be approved by Service Quotas. Contact Amazon Web Services Support for more details.
CASE_CLOSED: The support case associated with this quota increase request was closed. Check the support case correspondence for the outcome of your quota request.
INVALID_REQUEST: Service Quotas couldn't process your resource-level quota increase request because the Amazon Resource Name (ARN) specified as part of the ContextId is invalid.
Created (datetime) --
The date and time when the quota increase request was received and the case ID was created.
LastUpdated (datetime) --
The date and time of the most recent change.
Requester (string) --
The IAM identity of the requester.
QuotaArn (string) --
The Amazon Resource Name (ARN) of the quota.
GlobalQuota (boolean) --
Indicates whether the quota is global.
Unit (string) --
The unit of measurement.
QuotaRequestedAtLevel (string) --
Filters the response to return quota requests for the ACCOUNT, RESOURCE, or ALL levels. ACCOUNT is the default.
QuotaContext (dict) --
The context for this service quota.
ContextScope (string) --
Specifies the scope to which the quota value is applied. If the scope is RESOURCE, the quota value is applied to each resource in the Amazon Web Services account. If the scope is ACCOUNT, the quota value is applied to the Amazon Web Services account.
ContextScopeType (string) --
Specifies the resource type to which the quota can be applied.
ContextId (string) --
Specifies the resource, or resources, to which the quota applies. The value for this field is either an Amazon Resource Name (ARN) or *. If the value is an ARN, the quota value applies to that resource. If the value is *, then the quota value applies to all resources listed in the ContextScopeType field. The quota value applies to all resources for which you haven’t previously applied a quota value, and any new resources you create in your Amazon Web Services account.
{'RequestedQuotas': {'RequestType': 'AutomaticManagement'}}
Retrieves the quota increase requests for the specified Amazon Web Services service. Filter responses to return quota requests at either the account level, resource level, or all levels. Responses include any open or closed requests within 90 days.
See also: AWS API Documentation
Request Syntax
client.list_requested_service_quota_change_history(
ServiceCode='string',
Status='PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED'|'NOT_APPROVED'|'INVALID_REQUEST',
NextToken='string',
MaxResults=123,
QuotaRequestedAtLevel='ACCOUNT'|'RESOURCE'|'ALL'
)
string
Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.
string
Specifies that you want to filter the results to only the requests with the matching status.
string
Specifies a value for receiving additional results after you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
integer
Specifies the maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.
string
Filters the response to return quota requests for the ACCOUNT, RESOURCE, or ALL levels. ACCOUNT is the default.
dict
Response Syntax
{
'NextToken': 'string',
'RequestedQuotas': [
{
'Id': 'string',
'RequestType': 'AutomaticManagement',
'CaseId': 'string',
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'DesiredValue': 123.0,
'Status': 'PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED'|'NOT_APPROVED'|'INVALID_REQUEST',
'Created': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Requester': 'string',
'QuotaArn': 'string',
'GlobalQuota': True|False,
'Unit': 'string',
'QuotaRequestedAtLevel': 'ACCOUNT'|'RESOURCE'|'ALL',
'QuotaContext': {
'ContextScope': 'RESOURCE'|'ACCOUNT',
'ContextScopeType': 'string',
'ContextId': 'string'
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
RequestedQuotas (list) --
Information about the quota increase requests.
(dict) --
Information about a quota increase request.
Id (string) --
The unique identifier.
RequestType (string) --
The type of quota increase request. Possible values include:
AutomaticManagement - The request was automatically created by Service Quotas Automatic Management when quota utilization approached the limit.
If this field is not present, the request was manually created by a user.
CaseId (string) --
The case ID.
ServiceCode (string) --
Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.
ServiceName (string) --
Specifies the service name.
QuotaCode (string) --
Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.
QuotaName (string) --
Specifies the quota name.
DesiredValue (float) --
The new, increased value for the quota.
Status (string) --
The state of the quota increase request.
PENDING: The quota increase request is under review by Amazon Web Services.
CASE_OPENED: Service Quotas opened a support case to process the quota increase request. Follow-up on the support case for more information.
APPROVED: The quota increase request is approved.
DENIED: The quota increase request can't be approved by Service Quotas. Contact Amazon Web Services Support for more details.
NOT APPROVED: The quota increase request can't be approved by Service Quotas. Contact Amazon Web Services Support for more details.
CASE_CLOSED: The support case associated with this quota increase request was closed. Check the support case correspondence for the outcome of your quota request.
INVALID_REQUEST: Service Quotas couldn't process your resource-level quota increase request because the Amazon Resource Name (ARN) specified as part of the ContextId is invalid.
Created (datetime) --
The date and time when the quota increase request was received and the case ID was created.
LastUpdated (datetime) --
The date and time of the most recent change.
Requester (string) --
The IAM identity of the requester.
QuotaArn (string) --
The Amazon Resource Name (ARN) of the quota.
GlobalQuota (boolean) --
Indicates whether the quota is global.
Unit (string) --
The unit of measurement.
QuotaRequestedAtLevel (string) --
Filters the response to return quota requests for the ACCOUNT, RESOURCE, or ALL levels. ACCOUNT is the default.
QuotaContext (dict) --
The context for this service quota.
ContextScope (string) --
Specifies the scope to which the quota value is applied. If the scope is RESOURCE, the quota value is applied to each resource in the Amazon Web Services account. If the scope is ACCOUNT, the quota value is applied to the Amazon Web Services account.
ContextScopeType (string) --
Specifies the resource type to which the quota can be applied.
ContextId (string) --
Specifies the resource, or resources, to which the quota applies. The value for this field is either an Amazon Resource Name (ARN) or *. If the value is an ARN, the quota value applies to that resource. If the value is *, then the quota value applies to all resources listed in the ContextScopeType field. The quota value applies to all resources for which you haven’t previously applied a quota value, and any new resources you create in your Amazon Web Services account.
{'RequestedQuotas': {'RequestType': 'AutomaticManagement'}}
Retrieves the quota increase requests for the specified quota. Filter responses to return quota requests at either the account level, resource level, or all levels.
See also: AWS API Documentation
Request Syntax
client.list_requested_service_quota_change_history_by_quota(
ServiceCode='string',
QuotaCode='string',
Status='PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED'|'NOT_APPROVED'|'INVALID_REQUEST',
NextToken='string',
MaxResults=123,
QuotaRequestedAtLevel='ACCOUNT'|'RESOURCE'|'ALL'
)
string
[REQUIRED]
Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.
string
[REQUIRED]
Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.
string
Specifies that you want to filter the results to only the requests with the matching status.
string
Specifies a value for receiving additional results after you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.
integer
Specifies the maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.
string
Filters the response to return quota requests for the ACCOUNT, RESOURCE, or ALL levels. ACCOUNT is the default.
dict
Response Syntax
{
'NextToken': 'string',
'RequestedQuotas': [
{
'Id': 'string',
'RequestType': 'AutomaticManagement',
'CaseId': 'string',
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'DesiredValue': 123.0,
'Status': 'PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED'|'NOT_APPROVED'|'INVALID_REQUEST',
'Created': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Requester': 'string',
'QuotaArn': 'string',
'GlobalQuota': True|False,
'Unit': 'string',
'QuotaRequestedAtLevel': 'ACCOUNT'|'RESOURCE'|'ALL',
'QuotaContext': {
'ContextScope': 'RESOURCE'|'ACCOUNT',
'ContextScopeType': 'string',
'ContextId': 'string'
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
RequestedQuotas (list) --
Information about the quota increase requests.
(dict) --
Information about a quota increase request.
Id (string) --
The unique identifier.
RequestType (string) --
The type of quota increase request. Possible values include:
AutomaticManagement - The request was automatically created by Service Quotas Automatic Management when quota utilization approached the limit.
If this field is not present, the request was manually created by a user.
CaseId (string) --
The case ID.
ServiceCode (string) --
Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.
ServiceName (string) --
Specifies the service name.
QuotaCode (string) --
Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.
QuotaName (string) --
Specifies the quota name.
DesiredValue (float) --
The new, increased value for the quota.
Status (string) --
The state of the quota increase request.
PENDING: The quota increase request is under review by Amazon Web Services.
CASE_OPENED: Service Quotas opened a support case to process the quota increase request. Follow-up on the support case for more information.
APPROVED: The quota increase request is approved.
DENIED: The quota increase request can't be approved by Service Quotas. Contact Amazon Web Services Support for more details.
NOT APPROVED: The quota increase request can't be approved by Service Quotas. Contact Amazon Web Services Support for more details.
CASE_CLOSED: The support case associated with this quota increase request was closed. Check the support case correspondence for the outcome of your quota request.
INVALID_REQUEST: Service Quotas couldn't process your resource-level quota increase request because the Amazon Resource Name (ARN) specified as part of the ContextId is invalid.
Created (datetime) --
The date and time when the quota increase request was received and the case ID was created.
LastUpdated (datetime) --
The date and time of the most recent change.
Requester (string) --
The IAM identity of the requester.
QuotaArn (string) --
The Amazon Resource Name (ARN) of the quota.
GlobalQuota (boolean) --
Indicates whether the quota is global.
Unit (string) --
The unit of measurement.
QuotaRequestedAtLevel (string) --
Filters the response to return quota requests for the ACCOUNT, RESOURCE, or ALL levels. ACCOUNT is the default.
QuotaContext (dict) --
The context for this service quota.
ContextScope (string) --
Specifies the scope to which the quota value is applied. If the scope is RESOURCE, the quota value is applied to each resource in the Amazon Web Services account. If the scope is ACCOUNT, the quota value is applied to the Amazon Web Services account.
ContextScopeType (string) --
Specifies the resource type to which the quota can be applied.
ContextId (string) --
Specifies the resource, or resources, to which the quota applies. The value for this field is either an Amazon Resource Name (ARN) or *. If the value is an ARN, the quota value applies to that resource. If the value is *, then the quota value applies to all resources listed in the ContextScopeType field. The quota value applies to all resources for which you haven’t previously applied a quota value, and any new resources you create in your Amazon Web Services account.
{'RequestedQuota': {'RequestType': 'AutomaticManagement'}}
Submits a quota increase request for the specified quota at the account or resource level.
See also: AWS API Documentation
Request Syntax
client.request_service_quota_increase(
ServiceCode='string',
QuotaCode='string',
DesiredValue=123.0,
ContextId='string',
SupportCaseAllowed=True|False
)
string
[REQUIRED]
Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.
string
[REQUIRED]
Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.
float
[REQUIRED]
Specifies the new, increased value for the quota.
string
Specifies the resource with an Amazon Resource Name (ARN).
boolean
Specifies if an Amazon Web Services Support case can be opened for the quota increase request. This parameter is optional.
By default, this flag is set to True and Amazon Web Services may create a support case for some quota increase requests. You can set this flag to False if you do not want a support case created when you request a quota increase. If you set the flag to False, Amazon Web Services does not open a support case and updates the request status to Not approved.
dict
Response Syntax
{
'RequestedQuota': {
'Id': 'string',
'RequestType': 'AutomaticManagement',
'CaseId': 'string',
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'DesiredValue': 123.0,
'Status': 'PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED'|'NOT_APPROVED'|'INVALID_REQUEST',
'Created': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Requester': 'string',
'QuotaArn': 'string',
'GlobalQuota': True|False,
'Unit': 'string',
'QuotaRequestedAtLevel': 'ACCOUNT'|'RESOURCE'|'ALL',
'QuotaContext': {
'ContextScope': 'RESOURCE'|'ACCOUNT',
'ContextScopeType': 'string',
'ContextId': 'string'
}
}
}
Response Structure
(dict) --
RequestedQuota (dict) --
Information about the quota increase request.
Id (string) --
The unique identifier.
RequestType (string) --
The type of quota increase request. Possible values include:
AutomaticManagement - The request was automatically created by Service Quotas Automatic Management when quota utilization approached the limit.
If this field is not present, the request was manually created by a user.
CaseId (string) --
The case ID.
ServiceCode (string) --
Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.
ServiceName (string) --
Specifies the service name.
QuotaCode (string) --
Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.
QuotaName (string) --
Specifies the quota name.
DesiredValue (float) --
The new, increased value for the quota.
Status (string) --
The state of the quota increase request.
PENDING: The quota increase request is under review by Amazon Web Services.
CASE_OPENED: Service Quotas opened a support case to process the quota increase request. Follow-up on the support case for more information.
APPROVED: The quota increase request is approved.
DENIED: The quota increase request can't be approved by Service Quotas. Contact Amazon Web Services Support for more details.
NOT APPROVED: The quota increase request can't be approved by Service Quotas. Contact Amazon Web Services Support for more details.
CASE_CLOSED: The support case associated with this quota increase request was closed. Check the support case correspondence for the outcome of your quota request.
INVALID_REQUEST: Service Quotas couldn't process your resource-level quota increase request because the Amazon Resource Name (ARN) specified as part of the ContextId is invalid.
Created (datetime) --
The date and time when the quota increase request was received and the case ID was created.
LastUpdated (datetime) --
The date and time of the most recent change.
Requester (string) --
The IAM identity of the requester.
QuotaArn (string) --
The Amazon Resource Name (ARN) of the quota.
GlobalQuota (boolean) --
Indicates whether the quota is global.
Unit (string) --
The unit of measurement.
QuotaRequestedAtLevel (string) --
Filters the response to return quota requests for the ACCOUNT, RESOURCE, or ALL levels. ACCOUNT is the default.
QuotaContext (dict) --
The context for this service quota.
ContextScope (string) --
Specifies the scope to which the quota value is applied. If the scope is RESOURCE, the quota value is applied to each resource in the Amazon Web Services account. If the scope is ACCOUNT, the quota value is applied to the Amazon Web Services account.
ContextScopeType (string) --
Specifies the resource type to which the quota can be applied.
ContextId (string) --
Specifies the resource, or resources, to which the quota applies. The value for this field is either an Amazon Resource Name (ARN) or *. If the value is an ARN, the quota value applies to that resource. If the value is *, then the quota value applies to all resources listed in the ContextScopeType field. The quota value applies to all resources for which you haven’t previously applied a quota value, and any new resources you create in your Amazon Web Services account.