Service Quotas

2023/08/28 - Service Quotas - 8 updated api methods

Changes  Service Quotas now supports viewing the applied quota value and requesting a quota increase for a specific resource in an AWS account.

GetAWSDefaultServiceQuota (updated) Link ¶
Changes (response) 
{'Quota': {'QuotaAppliedAtLevel': 'ACCOUNT | RESOURCE | ALL',
           'QuotaContext': {'ContextId': 'string',
                            'ContextScope': 'RESOURCE | ACCOUNT',
                            'ContextScopeType': 'string'}}}

Retrieves the default value for the specified quota. The default value does not reflect any quota increases.

See also: AWS API Documentation

Request Syntax

client.get_aws_default_service_quota(
    ServiceCode='string',
    QuotaCode='string'
)
type ServiceCode

string

param ServiceCode

[REQUIRED]

Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.

type QuotaCode

string

param QuotaCode

[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.

rtype

dict

returns

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'
        },
        'QuotaAppliedAtLevel': 'ACCOUNT'|'RESOURCE'|'ALL',
        'QuotaContext': {
            'ContextScope': 'RESOURCE'|'ACCOUNT',
            'ContextScopeType': 'string',
            'ContextId': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Quota (dict) --

      Information about the quota.

      • 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.

      • QuotaArn (string) --

        The Amazon Resource Name (ARN) of the quota.

      • 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.

      • 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.

          • (string) --

            • (string) --

        • MetricStatisticRecommendation (string) --

          The metric statistic that we recommend you use when determining quota usage.

      • Period (dict) --

        The period of time.

        • PeriodValue (integer) --

          The value associated with the reported PeriodUnit .

        • PeriodUnit (string) --

          The time unit.

      • ErrorReason (dict) --

        The error code and error reason.

        • ErrorCode (string) --

          Service Quotas returns the following error values:

          • DEPENDENCY_ACCESS_DENIED_ERROR - The caller does not have the required permissions to complete the action. To resolve the error, you must have permission to access the Amazon Web Service or quota.

          • DEPENDENCY_THROTTLING_ERROR - The Amazon Web Service is throttling Service Quotas.

          • DEPENDENCY_SERVICE_ERROR - The Amazon Web Service is not available.

          • SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.

        • ErrorMessage (string) --

          The error message.

      • QuotaAppliedAtLevel (string) --

        Specifies at which level of granularity that the quota value is applied.

      • QuotaContext (dict) --

        The context for this service quota.

        • ContextScope (string) --

          Specifies whether the quota applies to an Amazon Web Services account, or to a resource.

        • ContextScopeType (string) --

          When the ContextScope is RESOURCE , then this specifies the resource type of the specified resource.

        • ContextId (string) --

          Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field depends on the context scope associated with the specified service quota.

GetRequestedServiceQuotaChange (updated) Link ¶
Changes (response) 
{'RequestedQuota': {'QuotaContext': {'ContextId': 'string',
                                     'ContextScope': 'RESOURCE | ACCOUNT',
                                     'ContextScopeType': 'string'},
                    'QuotaRequestedAtLevel': 'ACCOUNT | RESOURCE | ALL',
                    'Status': {'NOT_APPROVED', 'INVALID_REQUEST'}}}

Retrieves information about the specified quota increase request.

See also: AWS API Documentation

Request Syntax

client.get_requested_service_quota_change(
    RequestId='string'
)
type RequestId

string

param RequestId

[REQUIRED]

Specifies the ID of the quota increase request.

rtype

dict

returns

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'|'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.

      • 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.

      • 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) --

        Specifies at which level within the Amazon Web Services account the quota request applies to.

      • QuotaContext (dict) --

        The context for this service quota.

        • ContextScope (string) --

          Specifies whether the quota applies to an Amazon Web Services account, or to a resource.

        • ContextScopeType (string) --

          When the ContextScope is RESOURCE , then this specifies the resource type of the specified resource.

        • ContextId (string) --

          Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field depends on the context scope associated with the specified service quota.

GetServiceQuota (updated) Link ¶
Changes (request, response)
Request 
{'ContextId': 'string'}
Response 
{'Quota': {'QuotaAppliedAtLevel': 'ACCOUNT | RESOURCE | ALL',
           'QuotaContext': {'ContextId': 'string',
                            'ContextScope': 'RESOURCE | ACCOUNT',
                            'ContextScopeType': 'string'}}}

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

client.get_service_quota(
    ServiceCode='string',
    QuotaCode='string',
    ContextId='string'
)
type ServiceCode

string

param ServiceCode

[REQUIRED]

Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.

type QuotaCode

string

param QuotaCode

[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.

type ContextId

string

param ContextId

Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field depends on the context scope associated with the specified service quota.

rtype

dict

returns

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'
        },
        'QuotaAppliedAtLevel': 'ACCOUNT'|'RESOURCE'|'ALL',
        'QuotaContext': {
            'ContextScope': 'RESOURCE'|'ACCOUNT',
            'ContextScopeType': 'string',
            'ContextId': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Quota (dict) --

      Information about the quota.

      • 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.

      • QuotaArn (string) --

        The Amazon Resource Name (ARN) of the quota.

      • 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.

      • 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.

          • (string) --

            • (string) --

        • MetricStatisticRecommendation (string) --

          The metric statistic that we recommend you use when determining quota usage.

      • Period (dict) --

        The period of time.

        • PeriodValue (integer) --

          The value associated with the reported PeriodUnit .

        • PeriodUnit (string) --

          The time unit.

      • ErrorReason (dict) --

        The error code and error reason.

        • ErrorCode (string) --

          Service Quotas returns the following error values:

          • DEPENDENCY_ACCESS_DENIED_ERROR - The caller does not have the required permissions to complete the action. To resolve the error, you must have permission to access the Amazon Web Service or quota.

          • DEPENDENCY_THROTTLING_ERROR - The Amazon Web Service is throttling Service Quotas.

          • DEPENDENCY_SERVICE_ERROR - The Amazon Web Service is not available.

          • SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.

        • ErrorMessage (string) --

          The error message.

      • QuotaAppliedAtLevel (string) --

        Specifies at which level of granularity that the quota value is applied.

      • QuotaContext (dict) --

        The context for this service quota.

        • ContextScope (string) --

          Specifies whether the quota applies to an Amazon Web Services account, or to a resource.

        • ContextScopeType (string) --

          When the ContextScope is RESOURCE , then this specifies the resource type of the specified resource.

        • ContextId (string) --

          Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field depends on the context scope associated with the specified service quota.

ListAWSDefaultServiceQuotas (updated) Link ¶
Changes (response) 
{'Quotas': {'QuotaAppliedAtLevel': 'ACCOUNT | RESOURCE | ALL',
            'QuotaContext': {'ContextId': 'string',
                             'ContextScope': 'RESOURCE | ACCOUNT',
                             'ContextScopeType': 'string'}}}

Lists the default values for the quotas for the specified Amazon Web Service. A default value does not reflect any quota increases.

See also: AWS API Documentation

Request Syntax

client.list_aws_default_service_quotas(
    ServiceCode='string',
    NextToken='string',
    MaxResults=123
)
type ServiceCode

string

param ServiceCode

[REQUIRED]

Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.

type NextToken

string

param NextToken

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.

type MaxResults

integer

param MaxResults

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.

Note

An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

rtype

dict

returns

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'
            },
            'QuotaAppliedAtLevel': '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 .

    • Quotas (list) --

      Information about the quotas.

      • (dict) --

        Information about a quota.

        • 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.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the quota.

        • 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.

        • 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.

            • (string) --

              • (string) --

          • MetricStatisticRecommendation (string) --

            The metric statistic that we recommend you use when determining quota usage.

        • Period (dict) --

          The period of time.

          • PeriodValue (integer) --

            The value associated with the reported PeriodUnit .

          • PeriodUnit (string) --

            The time unit.

        • ErrorReason (dict) --

          The error code and error reason.

          • ErrorCode (string) --

            Service Quotas returns the following error values:

            • DEPENDENCY_ACCESS_DENIED_ERROR - The caller does not have the required permissions to complete the action. To resolve the error, you must have permission to access the Amazon Web Service or quota.

            • DEPENDENCY_THROTTLING_ERROR - The Amazon Web Service is throttling Service Quotas.

            • DEPENDENCY_SERVICE_ERROR - The Amazon Web Service is not available.

            • SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.

          • ErrorMessage (string) --

            The error message.

        • QuotaAppliedAtLevel (string) --

          Specifies at which level of granularity that the quota value is applied.

        • QuotaContext (dict) --

          The context for this service quota.

          • ContextScope (string) --

            Specifies whether the quota applies to an Amazon Web Services account, or to a resource.

          • ContextScopeType (string) --

            When the ContextScope is RESOURCE , then this specifies the resource type of the specified resource.

          • ContextId (string) --

            Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field depends on the context scope associated with the specified service quota.

ListRequestedServiceQuotaChangeHistory (updated) Link ¶
Changes (request, response)
Request 
{'QuotaRequestedAtLevel': 'ACCOUNT | RESOURCE | ALL',
 'Status': {'NOT_APPROVED', 'INVALID_REQUEST'}}
Response 
{'RequestedQuotas': {'QuotaContext': {'ContextId': 'string',
                                      'ContextScope': 'RESOURCE | ACCOUNT',
                                      'ContextScopeType': 'string'},
                     'QuotaRequestedAtLevel': 'ACCOUNT | RESOURCE | ALL',
                     'Status': {'NOT_APPROVED', 'INVALID_REQUEST'}}}

Retrieves the quota increase requests for the specified Amazon Web Service.

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'
)
type ServiceCode

string

param ServiceCode

Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.

type Status

string

param Status

Specifies that you want to filter the results to only the requests with the matching status.

type NextToken

string

param NextToken

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.

type MaxResults

integer

param MaxResults

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.

Note

An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

type QuotaRequestedAtLevel

string

param QuotaRequestedAtLevel

Specifies at which level within the Amazon Web Services account the quota request applies to.

rtype

dict

returns

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'|'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.

        • 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.

        • 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) --

          Specifies at which level within the Amazon Web Services account the quota request applies to.

        • QuotaContext (dict) --

          The context for this service quota.

          • ContextScope (string) --

            Specifies whether the quota applies to an Amazon Web Services account, or to a resource.

          • ContextScopeType (string) --

            When the ContextScope is RESOURCE , then this specifies the resource type of the specified resource.

          • ContextId (string) --

            Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field depends on the context scope associated with the specified service quota.

ListRequestedServiceQuotaChangeHistoryByQuota (updated) Link ¶
Changes (request, response)
Request 
{'QuotaRequestedAtLevel': 'ACCOUNT | RESOURCE | ALL',
 'Status': {'NOT_APPROVED', 'INVALID_REQUEST'}}
Response 
{'RequestedQuotas': {'QuotaContext': {'ContextId': 'string',
                                      'ContextScope': 'RESOURCE | ACCOUNT',
                                      'ContextScopeType': 'string'},
                     'QuotaRequestedAtLevel': 'ACCOUNT | RESOURCE | ALL',
                     'Status': {'NOT_APPROVED', 'INVALID_REQUEST'}}}

Retrieves the quota increase requests for the specified quota.

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'
)
type ServiceCode

string

param ServiceCode

[REQUIRED]

Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.

type QuotaCode

string

param QuotaCode

[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.

type Status

string

param Status

Specifies that you want to filter the results to only the requests with the matching status.

type NextToken

string

param NextToken

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.

type MaxResults

integer

param MaxResults

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.

Note

An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

type QuotaRequestedAtLevel

string

param QuotaRequestedAtLevel

Specifies at which level within the Amazon Web Services account the quota request applies to.

rtype

dict

returns

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'|'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.

        • 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.

        • 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) --

          Specifies at which level within the Amazon Web Services account the quota request applies to.

        • QuotaContext (dict) --

          The context for this service quota.

          • ContextScope (string) --

            Specifies whether the quota applies to an Amazon Web Services account, or to a resource.

          • ContextScopeType (string) --

            When the ContextScope is RESOURCE , then this specifies the resource type of the specified resource.

          • ContextId (string) --

            Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field depends on the context scope associated with the specified service quota.

ListServiceQuotas (updated) Link ¶
Changes (request, response)
Request 
{'QuotaAppliedAtLevel': 'ACCOUNT | RESOURCE | ALL', 'QuotaCode': 'string'}
Response 
{'Quotas': {'QuotaAppliedAtLevel': 'ACCOUNT | RESOURCE | ALL',
            'QuotaContext': {'ContextId': 'string',
                             'ContextScope': 'RESOURCE | ACCOUNT',
                             'ContextScopeType': 'string'}}}

Lists the applied quota values for the specified Amazon Web 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

client.list_service_quotas(
    ServiceCode='string',
    NextToken='string',
    MaxResults=123,
    QuotaCode='string',
    QuotaAppliedAtLevel='ACCOUNT'|'RESOURCE'|'ALL'
)
type ServiceCode

string

param ServiceCode

[REQUIRED]

Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.

type NextToken

string

param NextToken

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.

type MaxResults

integer

param MaxResults

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.

Note

An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

type QuotaCode

string

param QuotaCode

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.

type QuotaAppliedAtLevel

string

param QuotaAppliedAtLevel

Specifies at which level of granularity that the quota value is applied.

rtype

dict

returns

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'
            },
            'QuotaAppliedAtLevel': '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 .

    • Quotas (list) --

      Information about the quotas.

      • (dict) --

        Information about a quota.

        • 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.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the quota.

        • 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.

        • 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.

            • (string) --

              • (string) --

          • MetricStatisticRecommendation (string) --

            The metric statistic that we recommend you use when determining quota usage.

        • Period (dict) --

          The period of time.

          • PeriodValue (integer) --

            The value associated with the reported PeriodUnit .

          • PeriodUnit (string) --

            The time unit.

        • ErrorReason (dict) --

          The error code and error reason.

          • ErrorCode (string) --

            Service Quotas returns the following error values:

            • DEPENDENCY_ACCESS_DENIED_ERROR - The caller does not have the required permissions to complete the action. To resolve the error, you must have permission to access the Amazon Web Service or quota.

            • DEPENDENCY_THROTTLING_ERROR - The Amazon Web Service is throttling Service Quotas.

            • DEPENDENCY_SERVICE_ERROR - The Amazon Web Service is not available.

            • SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.

          • ErrorMessage (string) --

            The error message.

        • QuotaAppliedAtLevel (string) --

          Specifies at which level of granularity that the quota value is applied.

        • QuotaContext (dict) --

          The context for this service quota.

          • ContextScope (string) --

            Specifies whether the quota applies to an Amazon Web Services account, or to a resource.

          • ContextScopeType (string) --

            When the ContextScope is RESOURCE , then this specifies the resource type of the specified resource.

          • ContextId (string) --

            Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field depends on the context scope associated with the specified service quota.

RequestServiceQuotaIncrease (updated) Link ¶
Changes (request, response)
Request 
{'ContextId': 'string'}
Response 
{'RequestedQuota': {'QuotaContext': {'ContextId': 'string',
                                     'ContextScope': 'RESOURCE | ACCOUNT',
                                     'ContextScopeType': 'string'},
                    'QuotaRequestedAtLevel': 'ACCOUNT | RESOURCE | ALL',
                    'Status': {'NOT_APPROVED', 'INVALID_REQUEST'}}}

Submits a quota increase request for the specified quota.

See also: AWS API Documentation

Request Syntax

client.request_service_quota_increase(
    ServiceCode='string',
    QuotaCode='string',
    DesiredValue=123.0,
    ContextId='string'
)
type ServiceCode

string

param ServiceCode

[REQUIRED]

Specifies the service identifier. To find the service code value for an Amazon Web Services service, use the ListServices operation.

type QuotaCode

string

param QuotaCode

[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.

type DesiredValue

float

param DesiredValue

[REQUIRED]

Specifies the new, increased value for the quota.

type ContextId

string

param ContextId

Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field depends on the context scope associated with the specified service quota.

rtype

dict

returns

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'|'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.

      • 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.

      • 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) --

        Specifies at which level within the Amazon Web Services account the quota request applies to.

      • QuotaContext (dict) --

        The context for this service quota.

        • ContextScope (string) --

          Specifies whether the quota applies to an Amazon Web Services account, or to a resource.

        • ContextScopeType (string) --

          When the ContextScope is RESOURCE , then this specifies the resource type of the specified resource.

        • ContextId (string) --

          Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field depends on the context scope associated with the specified service quota.