Table of Contents
A low-level client representing Service Quotas
With Service Quotas, you can view and manage your quotas easily as your AWS workloads grow. Quotas, also referred to as limits, are the maximum number of resources that you can create in your AWS account. For more information, see the Service Quotas User Guide .
import boto3
client = boto3.client('service-quotas')
These are the available methods:
Associates your quota request template with your organization. When a new account is created in your organization, the quota increase requests in the template are automatically applied to the account. You can add a quota increase request for any adjustable quota to your template.
See also: AWS API Documentation
Request Syntax
response = client.associate_service_quota_template()
{}
Response Structure
Exceptions
Check if an operation can be paginated.
Deletes the quota increase request for the specified quota from your quota request template.
See also: AWS API Documentation
Request Syntax
response = client.delete_service_quota_increase_request_from_template(
ServiceCode='string',
QuotaCode='string',
AwsRegion='string'
)
[REQUIRED]
The service identifier.
[REQUIRED]
The quota identifier.
[REQUIRED]
The AWS Region.
dict
Response Syntax
{}
Response Structure
Exceptions
Disables your quota request template. After a template is disabled, the quota increase requests in the template are not applied to new accounts in your organization. Disabling a quota request template does not apply its quota increase requests.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_service_quota_template()
{}
Response Structure
Exceptions
Retrieves the status of the association for the quota request template.
See also: AWS API Documentation
Request Syntax
response = client.get_association_for_service_quota_template()
{
'ServiceQuotaTemplateAssociationStatus': 'ASSOCIATED'|'DISASSOCIATED'
}
Response Structure
The association status. If the status is ASSOCIATED , the quota increase requests in the template are automatically applied to new accounts in your organization.
Exceptions
Retrieves the default value for the specified quota. The default value does not reflect any quota increases.
See also: AWS API Documentation
Request Syntax
response = client.get_aws_default_service_quota(
ServiceCode='string',
QuotaCode='string'
)
[REQUIRED]
The service identifier.
[REQUIRED]
The quota identifier.
dict
Response Syntax
{
'Quota': {
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaArn': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'Value': 123.0,
'Unit': 'string',
'Adjustable': True|False,
'GlobalQuota': True|False,
'UsageMetric': {
'MetricNamespace': 'string',
'MetricName': 'string',
'MetricDimensions': {
'string': 'string'
},
'MetricStatisticRecommendation': 'string'
},
'Period': {
'PeriodValue': 123,
'PeriodUnit': 'MICROSECOND'|'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'
},
'ErrorReason': {
'ErrorCode': 'DEPENDENCY_ACCESS_DENIED_ERROR'|'DEPENDENCY_THROTTLING_ERROR'|'DEPENDENCY_SERVICE_ERROR'|'SERVICE_QUOTA_NOT_AVAILABLE_ERROR',
'ErrorMessage': 'string'
}
}
}
Response Structure
(dict) --
Quota (dict) --
Information about the quota.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
QuotaArn (string) --
The Amazon Resource Name (ARN) of the quota.
QuotaCode (string) --
The quota identifier.
QuotaName (string) --
The quota name.
Value (float) --
The quota value.
Unit (string) --
The unit of measurement.
Adjustable (boolean) --
Indicates whether the quota value can be increased.
GlobalQuota (boolean) --
Indicates whether the quota is global.
UsageMetric (dict) --
Information about the measurement.
MetricNamespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric.
MetricDimensions (dict) --
The metric dimension. This is a name/value pair that is part of the identity of a metric.
MetricStatisticRecommendation (string) --
The metric statistic that we recommend you use when determining quota usage.
Period (dict) --
The period of time.
PeriodValue (integer) --
The value.
PeriodUnit (string) --
The time unit.
ErrorReason (dict) --
The error code and error reason.
ErrorCode (string) --
Service Quotas returns the following error values:
ErrorMessage (string) --
The error message.
Exceptions
Create a paginator for an operation.
Retrieves information about the specified quota increase request.
See also: AWS API Documentation
Request Syntax
response = client.get_requested_service_quota_change(
RequestId='string'
)
[REQUIRED]
The ID of the quota increase request.
{
'RequestedQuota': {
'Id': 'string',
'CaseId': 'string',
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'DesiredValue': 123.0,
'Status': 'PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED',
'Created': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Requester': 'string',
'QuotaArn': 'string',
'GlobalQuota': True|False,
'Unit': 'string'
}
}
Response Structure
Information about the quota increase request.
The unique identifier.
The case ID.
The service identifier.
The service name.
The quota identifier.
The quota name.
The new, increased value for the quota.
The state of the quota increase request.
The date and time when the quota increase request was received and the case ID was created.
The date and time of the most recent change.
The IAM identity of the requester.
The Amazon Resource Name (ARN) of the quota.
Indicates whether the quota is global.
The unit of measurement.
Exceptions
Retrieves the applied quota value for the specified quota. For some quotas, only the default values are available. If the applied quota value is not available for a quota, the quota is not retrieved.
See also: AWS API Documentation
Request Syntax
response = client.get_service_quota(
ServiceCode='string',
QuotaCode='string'
)
[REQUIRED]
The service identifier.
[REQUIRED]
The quota identifier.
dict
Response Syntax
{
'Quota': {
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaArn': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'Value': 123.0,
'Unit': 'string',
'Adjustable': True|False,
'GlobalQuota': True|False,
'UsageMetric': {
'MetricNamespace': 'string',
'MetricName': 'string',
'MetricDimensions': {
'string': 'string'
},
'MetricStatisticRecommendation': 'string'
},
'Period': {
'PeriodValue': 123,
'PeriodUnit': 'MICROSECOND'|'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'
},
'ErrorReason': {
'ErrorCode': 'DEPENDENCY_ACCESS_DENIED_ERROR'|'DEPENDENCY_THROTTLING_ERROR'|'DEPENDENCY_SERVICE_ERROR'|'SERVICE_QUOTA_NOT_AVAILABLE_ERROR',
'ErrorMessage': 'string'
}
}
}
Response Structure
(dict) --
Quota (dict) --
Information about the quota.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
QuotaArn (string) --
The Amazon Resource Name (ARN) of the quota.
QuotaCode (string) --
The quota identifier.
QuotaName (string) --
The quota name.
Value (float) --
The quota value.
Unit (string) --
The unit of measurement.
Adjustable (boolean) --
Indicates whether the quota value can be increased.
GlobalQuota (boolean) --
Indicates whether the quota is global.
UsageMetric (dict) --
Information about the measurement.
MetricNamespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric.
MetricDimensions (dict) --
The metric dimension. This is a name/value pair that is part of the identity of a metric.
MetricStatisticRecommendation (string) --
The metric statistic that we recommend you use when determining quota usage.
Period (dict) --
The period of time.
PeriodValue (integer) --
The value.
PeriodUnit (string) --
The time unit.
ErrorReason (dict) --
The error code and error reason.
ErrorCode (string) --
Service Quotas returns the following error values:
ErrorMessage (string) --
The error message.
Exceptions
Retrieves information about the specified quota increase request in your quota request template.
See also: AWS API Documentation
Request Syntax
response = client.get_service_quota_increase_request_from_template(
ServiceCode='string',
QuotaCode='string',
AwsRegion='string'
)
[REQUIRED]
The service identifier.
[REQUIRED]
The quota identifier.
[REQUIRED]
The AWS Region.
dict
Response Syntax
{
'ServiceQuotaIncreaseRequestInTemplate': {
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'DesiredValue': 123.0,
'AwsRegion': 'string',
'Unit': 'string',
'GlobalQuota': True|False
}
}
Response Structure
(dict) --
ServiceQuotaIncreaseRequestInTemplate (dict) --
Information about the quota increase request.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
QuotaCode (string) --
The quota identifier.
QuotaName (string) --
The quota name.
DesiredValue (float) --
The new, increased value of the quota.
AwsRegion (string) --
The AWS Region.
Unit (string) --
The unit of measurement.
GlobalQuota (boolean) --
Indicates whether the quota is global.
Exceptions
Returns an object that can wait for some condition.
Lists the default values for the quotas for the specified AWS service. A default value does not reflect any quota increases.
See also: AWS API Documentation
Request Syntax
response = client.list_aws_default_service_quotas(
ServiceCode='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The service identifier.
dict
Response Syntax
{
'NextToken': 'string',
'Quotas': [
{
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaArn': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'Value': 123.0,
'Unit': 'string',
'Adjustable': True|False,
'GlobalQuota': True|False,
'UsageMetric': {
'MetricNamespace': 'string',
'MetricName': 'string',
'MetricDimensions': {
'string': 'string'
},
'MetricStatisticRecommendation': 'string'
},
'Period': {
'PeriodValue': 123,
'PeriodUnit': 'MICROSECOND'|'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'
},
'ErrorReason': {
'ErrorCode': 'DEPENDENCY_ACCESS_DENIED_ERROR'|'DEPENDENCY_THROTTLING_ERROR'|'DEPENDENCY_SERVICE_ERROR'|'SERVICE_QUOTA_NOT_AVAILABLE_ERROR',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Quotas (list) --
Information about the quotas.
(dict) --
Information about a quota.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
QuotaArn (string) --
The Amazon Resource Name (ARN) of the quota.
QuotaCode (string) --
The quota identifier.
QuotaName (string) --
The quota name.
Value (float) --
The quota value.
Unit (string) --
The unit of measurement.
Adjustable (boolean) --
Indicates whether the quota value can be increased.
GlobalQuota (boolean) --
Indicates whether the quota is global.
UsageMetric (dict) --
Information about the measurement.
MetricNamespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric.
MetricDimensions (dict) --
The metric dimension. This is a name/value pair that is part of the identity of a metric.
MetricStatisticRecommendation (string) --
The metric statistic that we recommend you use when determining quota usage.
Period (dict) --
The period of time.
PeriodValue (integer) --
The value.
PeriodUnit (string) --
The time unit.
ErrorReason (dict) --
The error code and error reason.
ErrorCode (string) --
Service Quotas returns the following error values:
ErrorMessage (string) --
The error message.
Exceptions
Retrieves the quota increase requests for the specified service.
See also: AWS API Documentation
Request Syntax
response = client.list_requested_service_quota_change_history(
ServiceCode='string',
Status='PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'NextToken': 'string',
'RequestedQuotas': [
{
'Id': 'string',
'CaseId': 'string',
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'DesiredValue': 123.0,
'Status': 'PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED',
'Created': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Requester': 'string',
'QuotaArn': 'string',
'GlobalQuota': True|False,
'Unit': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
RequestedQuotas (list) --
Information about the quota increase requests.
(dict) --
Information about a quota increase request.
Id (string) --
The unique identifier.
CaseId (string) --
The case ID.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
QuotaCode (string) --
The quota identifier.
QuotaName (string) --
The quota name.
DesiredValue (float) --
The new, increased value for the quota.
Status (string) --
The state of the quota increase request.
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.
Exceptions
Retrieves the quota increase requests for the specified quota.
See also: AWS API Documentation
Request Syntax
response = client.list_requested_service_quota_change_history_by_quota(
ServiceCode='string',
QuotaCode='string',
Status='PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The service identifier.
[REQUIRED]
The quota identifier.
dict
Response Syntax
{
'NextToken': 'string',
'RequestedQuotas': [
{
'Id': 'string',
'CaseId': 'string',
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'DesiredValue': 123.0,
'Status': 'PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED',
'Created': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Requester': 'string',
'QuotaArn': 'string',
'GlobalQuota': True|False,
'Unit': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
RequestedQuotas (list) --
Information about the quota increase requests.
(dict) --
Information about a quota increase request.
Id (string) --
The unique identifier.
CaseId (string) --
The case ID.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
QuotaCode (string) --
The quota identifier.
QuotaName (string) --
The quota name.
DesiredValue (float) --
The new, increased value for the quota.
Status (string) --
The state of the quota increase request.
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.
Exceptions
Lists the quota increase requests in the specified quota request template.
See also: AWS API Documentation
Request Syntax
response = client.list_service_quota_increase_requests_in_template(
ServiceCode='string',
AwsRegion='string',
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'ServiceQuotaIncreaseRequestInTemplateList': [
{
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'DesiredValue': 123.0,
'AwsRegion': 'string',
'Unit': 'string',
'GlobalQuota': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ServiceQuotaIncreaseRequestInTemplateList (list) --
Information about the quota increase requests.
(dict) --
Information about a quota increase request.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
QuotaCode (string) --
The quota identifier.
QuotaName (string) --
The quota name.
DesiredValue (float) --
The new, increased value of the quota.
AwsRegion (string) --
The AWS Region.
Unit (string) --
The unit of measurement.
GlobalQuota (boolean) --
Indicates whether the quota is global.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
Lists the applied quota values for the specified AWS service. For some quotas, only the default values are available. If the applied quota value is not available for a quota, the quota is not retrieved.
See also: AWS API Documentation
Request Syntax
response = client.list_service_quotas(
ServiceCode='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The service identifier.
dict
Response Syntax
{
'NextToken': 'string',
'Quotas': [
{
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaArn': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'Value': 123.0,
'Unit': 'string',
'Adjustable': True|False,
'GlobalQuota': True|False,
'UsageMetric': {
'MetricNamespace': 'string',
'MetricName': 'string',
'MetricDimensions': {
'string': 'string'
},
'MetricStatisticRecommendation': 'string'
},
'Period': {
'PeriodValue': 123,
'PeriodUnit': 'MICROSECOND'|'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'
},
'ErrorReason': {
'ErrorCode': 'DEPENDENCY_ACCESS_DENIED_ERROR'|'DEPENDENCY_THROTTLING_ERROR'|'DEPENDENCY_SERVICE_ERROR'|'SERVICE_QUOTA_NOT_AVAILABLE_ERROR',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Quotas (list) --
Information about the quotas.
(dict) --
Information about a quota.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
QuotaArn (string) --
The Amazon Resource Name (ARN) of the quota.
QuotaCode (string) --
The quota identifier.
QuotaName (string) --
The quota name.
Value (float) --
The quota value.
Unit (string) --
The unit of measurement.
Adjustable (boolean) --
Indicates whether the quota value can be increased.
GlobalQuota (boolean) --
Indicates whether the quota is global.
UsageMetric (dict) --
Information about the measurement.
MetricNamespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric.
MetricDimensions (dict) --
The metric dimension. This is a name/value pair that is part of the identity of a metric.
MetricStatisticRecommendation (string) --
The metric statistic that we recommend you use when determining quota usage.
Period (dict) --
The period of time.
PeriodValue (integer) --
The value.
PeriodUnit (string) --
The time unit.
ErrorReason (dict) --
The error code and error reason.
ErrorCode (string) --
Service Quotas returns the following error values:
ErrorMessage (string) --
The error message.
Exceptions
Lists the names and codes for the services integrated with Service Quotas.
See also: AWS API Documentation
Request Syntax
response = client.list_services(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'NextToken': 'string',
'Services': [
{
'ServiceCode': 'string',
'ServiceName': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Services (list) --
Information about the services.
(dict) --
Information about a service.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
Exceptions
Returns a list of the tags assigned to the specified applied quota.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) for the applied quota for which you want to list tags. You can get this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
A complex data type that contains zero or more tag elements.
A complex data type that contains a tag key and tag value.
A string that contains a tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.
A string that contains an optional tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.
Exceptions
Adds a quota increase request to your quota request template.
See also: AWS API Documentation
Request Syntax
response = client.put_service_quota_increase_request_into_template(
QuotaCode='string',
ServiceCode='string',
AwsRegion='string',
DesiredValue=123.0
)
[REQUIRED]
The quota identifier.
[REQUIRED]
The service identifier.
[REQUIRED]
The AWS Region.
[REQUIRED]
The new, increased value for the quota.
dict
Response Syntax
{
'ServiceQuotaIncreaseRequestInTemplate': {
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'DesiredValue': 123.0,
'AwsRegion': 'string',
'Unit': 'string',
'GlobalQuota': True|False
}
}
Response Structure
(dict) --
ServiceQuotaIncreaseRequestInTemplate (dict) --
Information about the quota increase request.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
QuotaCode (string) --
The quota identifier.
QuotaName (string) --
The quota name.
DesiredValue (float) --
The new, increased value of the quota.
AwsRegion (string) --
The AWS Region.
Unit (string) --
The unit of measurement.
GlobalQuota (boolean) --
Indicates whether the quota is global.
Exceptions
Submits a quota increase request for the specified quota.
See also: AWS API Documentation
Request Syntax
response = client.request_service_quota_increase(
ServiceCode='string',
QuotaCode='string',
DesiredValue=123.0
)
[REQUIRED]
The service identifier.
[REQUIRED]
The quota identifier.
[REQUIRED]
The new, increased value for the quota.
dict
Response Syntax
{
'RequestedQuota': {
'Id': 'string',
'CaseId': 'string',
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'DesiredValue': 123.0,
'Status': 'PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED',
'Created': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Requester': 'string',
'QuotaArn': 'string',
'GlobalQuota': True|False,
'Unit': 'string'
}
}
Response Structure
(dict) --
RequestedQuota (dict) --
Information about the quota increase request.
Id (string) --
The unique identifier.
CaseId (string) --
The case ID.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
QuotaCode (string) --
The quota identifier.
QuotaName (string) --
The quota name.
DesiredValue (float) --
The new, increased value for the quota.
Status (string) --
The state of the quota increase request.
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.
Exceptions
Adds tags to the specified applied quota. You can include one or more tags to add to the quota.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) for the applied quota. You can get this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.
[REQUIRED]
The tags that you want to add to the resource.
A complex data type that contains a tag key and tag value.
A string that contains a tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.
A string that contains an optional tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes tags from the specified applied quota. You can specify one or more tags to remove.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) for the applied quota that you want to untag. You can get this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.
[REQUIRED]
The keys of the tags that you want to remove from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
The available paginators are:
paginator = client.get_paginator('list_aws_default_service_quotas')
Creates an iterator that will paginate through responses from ServiceQuotas.Client.list_aws_default_service_quotas().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ServiceCode='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The service identifier.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Quotas': [
{
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaArn': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'Value': 123.0,
'Unit': 'string',
'Adjustable': True|False,
'GlobalQuota': True|False,
'UsageMetric': {
'MetricNamespace': 'string',
'MetricName': 'string',
'MetricDimensions': {
'string': 'string'
},
'MetricStatisticRecommendation': 'string'
},
'Period': {
'PeriodValue': 123,
'PeriodUnit': 'MICROSECOND'|'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'
},
'ErrorReason': {
'ErrorCode': 'DEPENDENCY_ACCESS_DENIED_ERROR'|'DEPENDENCY_THROTTLING_ERROR'|'DEPENDENCY_SERVICE_ERROR'|'SERVICE_QUOTA_NOT_AVAILABLE_ERROR',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
Quotas (list) --
Information about the quotas.
(dict) --
Information about a quota.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
QuotaArn (string) --
The Amazon Resource Name (ARN) of the quota.
QuotaCode (string) --
The quota identifier.
QuotaName (string) --
The quota name.
Value (float) --
The quota value.
Unit (string) --
The unit of measurement.
Adjustable (boolean) --
Indicates whether the quota value can be increased.
GlobalQuota (boolean) --
Indicates whether the quota is global.
UsageMetric (dict) --
Information about the measurement.
MetricNamespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric.
MetricDimensions (dict) --
The metric dimension. This is a name/value pair that is part of the identity of a metric.
MetricStatisticRecommendation (string) --
The metric statistic that we recommend you use when determining quota usage.
Period (dict) --
The period of time.
PeriodValue (integer) --
The value.
PeriodUnit (string) --
The time unit.
ErrorReason (dict) --
The error code and error reason.
ErrorCode (string) --
Service Quotas returns the following error values:
ErrorMessage (string) --
The error message.
paginator = client.get_paginator('list_requested_service_quota_change_history')
Creates an iterator that will paginate through responses from ServiceQuotas.Client.list_requested_service_quota_change_history().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ServiceCode='string',
Status='PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'RequestedQuotas': [
{
'Id': 'string',
'CaseId': 'string',
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'DesiredValue': 123.0,
'Status': 'PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED',
'Created': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Requester': 'string',
'QuotaArn': 'string',
'GlobalQuota': True|False,
'Unit': 'string'
},
]
}
Response Structure
(dict) --
RequestedQuotas (list) --
Information about the quota increase requests.
(dict) --
Information about a quota increase request.
Id (string) --
The unique identifier.
CaseId (string) --
The case ID.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
QuotaCode (string) --
The quota identifier.
QuotaName (string) --
The quota name.
DesiredValue (float) --
The new, increased value for the quota.
Status (string) --
The state of the quota increase request.
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.
paginator = client.get_paginator('list_requested_service_quota_change_history_by_quota')
Creates an iterator that will paginate through responses from ServiceQuotas.Client.list_requested_service_quota_change_history_by_quota().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ServiceCode='string',
QuotaCode='string',
Status='PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The service identifier.
[REQUIRED]
The quota identifier.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'RequestedQuotas': [
{
'Id': 'string',
'CaseId': 'string',
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'DesiredValue': 123.0,
'Status': 'PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED',
'Created': datetime(2015, 1, 1),
'LastUpdated': datetime(2015, 1, 1),
'Requester': 'string',
'QuotaArn': 'string',
'GlobalQuota': True|False,
'Unit': 'string'
},
]
}
Response Structure
(dict) --
RequestedQuotas (list) --
Information about the quota increase requests.
(dict) --
Information about a quota increase request.
Id (string) --
The unique identifier.
CaseId (string) --
The case ID.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
QuotaCode (string) --
The quota identifier.
QuotaName (string) --
The quota name.
DesiredValue (float) --
The new, increased value for the quota.
Status (string) --
The state of the quota increase request.
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.
paginator = client.get_paginator('list_service_quota_increase_requests_in_template')
Creates an iterator that will paginate through responses from ServiceQuotas.Client.list_service_quota_increase_requests_in_template().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ServiceCode='string',
AwsRegion='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ServiceQuotaIncreaseRequestInTemplateList': [
{
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'DesiredValue': 123.0,
'AwsRegion': 'string',
'Unit': 'string',
'GlobalQuota': True|False
},
],
}
Response Structure
(dict) --
ServiceQuotaIncreaseRequestInTemplateList (list) --
Information about the quota increase requests.
(dict) --
Information about a quota increase request.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
QuotaCode (string) --
The quota identifier.
QuotaName (string) --
The quota name.
DesiredValue (float) --
The new, increased value of the quota.
AwsRegion (string) --
The AWS Region.
Unit (string) --
The unit of measurement.
GlobalQuota (boolean) --
Indicates whether the quota is global.
paginator = client.get_paginator('list_service_quotas')
Creates an iterator that will paginate through responses from ServiceQuotas.Client.list_service_quotas().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ServiceCode='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The service identifier.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Quotas': [
{
'ServiceCode': 'string',
'ServiceName': 'string',
'QuotaArn': 'string',
'QuotaCode': 'string',
'QuotaName': 'string',
'Value': 123.0,
'Unit': 'string',
'Adjustable': True|False,
'GlobalQuota': True|False,
'UsageMetric': {
'MetricNamespace': 'string',
'MetricName': 'string',
'MetricDimensions': {
'string': 'string'
},
'MetricStatisticRecommendation': 'string'
},
'Period': {
'PeriodValue': 123,
'PeriodUnit': 'MICROSECOND'|'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR'|'DAY'|'WEEK'
},
'ErrorReason': {
'ErrorCode': 'DEPENDENCY_ACCESS_DENIED_ERROR'|'DEPENDENCY_THROTTLING_ERROR'|'DEPENDENCY_SERVICE_ERROR'|'SERVICE_QUOTA_NOT_AVAILABLE_ERROR',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
Quotas (list) --
Information about the quotas.
(dict) --
Information about a quota.
ServiceCode (string) --
The service identifier.
ServiceName (string) --
The service name.
QuotaArn (string) --
The Amazon Resource Name (ARN) of the quota.
QuotaCode (string) --
The quota identifier.
QuotaName (string) --
The quota name.
Value (float) --
The quota value.
Unit (string) --
The unit of measurement.
Adjustable (boolean) --
Indicates whether the quota value can be increased.
GlobalQuota (boolean) --
Indicates whether the quota is global.
UsageMetric (dict) --
Information about the measurement.
MetricNamespace (string) --
The namespace of the metric.
MetricName (string) --
The name of the metric.
MetricDimensions (dict) --
The metric dimension. This is a name/value pair that is part of the identity of a metric.
MetricStatisticRecommendation (string) --
The metric statistic that we recommend you use when determining quota usage.
Period (dict) --
The period of time.
PeriodValue (integer) --
The value.
PeriodUnit (string) --
The time unit.
ErrorReason (dict) --
The error code and error reason.
ErrorCode (string) --
Service Quotas returns the following error values:
ErrorMessage (string) --
The error message.
paginator = client.get_paginator('list_services')
Creates an iterator that will paginate through responses from ServiceQuotas.Client.list_services().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Services': [
{
'ServiceCode': 'string',
'ServiceName': 'string'
},
]
}
Response Structure
Information about the services.
Information about a service.
The service identifier.
The service name.