ServiceQuotas

Client

class ServiceQuotas.Client

A low-level client representing Service Quotas

Service Quotas is a web service that you can use to manage many of your AWS service quotas. Quotas, also referred to as limits, are the maximum values for a resource, item, or operation. This guide provide descriptions of the Service Quotas actions that you can call from an API. For the Service Quotas user guide, which explains how to use Service Quotas from the console, see What is Service Quotas .

Note

AWS provides SDKs that consist of libraries and sample code for programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc...,). The SDKs provide a convenient way to create programmatic access to Service Quotas and AWS. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.

client = session.create_client('service-quotas')

These are the available methods:

associate_service_quota_template()

Associates the Service Quotas template with your organization so that when new accounts are created in your organization, the template submits increase requests for the specified service quotas. Use the Service Quotas template to request an increase for any adjustable quota value. After you define the Service Quotas template, use this operation to associate, or enable, the template.

See also: AWS API Documentation

Request Syntax

response = client.associate_service_quota_template()
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
delete_service_quota_increase_request_from_template(**kwargs)

Removes a service quota increase request from the Service Quotas template.

See also: AWS API Documentation

Request Syntax

response = client.delete_service_quota_increase_request_from_template(
    ServiceCode='string',
    QuotaCode='string',
    AwsRegion='string'
)
Parameters
  • ServiceCode (string) --

    [REQUIRED]

    Specifies the code for the service that you want to delete.

  • QuotaCode (string) --

    [REQUIRED]

    Specifies the code for the quota that you want to delete.

  • AwsRegion (string) --

    [REQUIRED]

    Specifies the AWS Region for the quota that you want to delete.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

disassociate_service_quota_template()

Disables the Service Quotas template. Once the template is disabled, it does not request quota increases for new accounts in your organization. Disabling the quota template does not apply the quota increase requests from the template.

Related operations
  • To enable the quota template, call AssociateServiceQuotaTemplate .
  • To delete a specific service quota from the template, use DeleteServiceQuotaIncreaseRequestFromTemplate .

See also: AWS API Documentation

Request Syntax

response = client.disassociate_service_quota_template()
Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_association_for_service_quota_template()

Retrieves the ServiceQuotaTemplateAssociationStatus value from the service. Use this action to determine if the Service Quota template is associated, or enabled.

See also: AWS API Documentation

Request Syntax

response = client.get_association_for_service_quota_template()
Return type
dict
Returns
Response Syntax
{
    'ServiceQuotaTemplateAssociationStatus': 'ASSOCIATED'|'DISASSOCIATED'
}

Response Structure

  • (dict) --
    • ServiceQuotaTemplateAssociationStatus (string) --

      Specifies whether the template is ASSOCIATED or DISASSOCIATED . If the template is ASSOCIATED , then it requests service quota increases for all new accounts created in your organization.

Exceptions

get_aws_default_service_quota(**kwargs)

Retrieves the default service quotas values. The Value returned for each quota is the AWS default value, even if the quotas have been increased..

See also: AWS API Documentation

Request Syntax

response = client.get_aws_default_service_quota(
    ServiceCode='string',
    QuotaCode='string'
)
Parameters
  • ServiceCode (string) --

    [REQUIRED]

    Specifies the service that you want to use.

  • QuotaCode (string) --

    [REQUIRED]

    Identifies the service quota you want to select.

Return type

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

Response Structure

  • (dict) --

    • Quota (dict) --

      Returns the ServiceQuota object which contains all values for a quota.

      • ServiceCode (string) --

        Specifies the service that you want to use.

      • ServiceName (string) --

        The name of the AWS service specified in the increase request.

      • QuotaArn (string) --

        The Amazon Resource Name (ARN) of the service quota.

      • QuotaCode (string) --

        The code identifier for the service quota specified.

      • QuotaName (string) --

        The name identifier of the service quota.

      • Value (float) --

        The value of service quota.

      • Unit (string) --

        The unit of measurement for the value of the service quota.

      • Adjustable (boolean) --

        Specifies if the quota value can be increased.

      • GlobalQuota (boolean) --

        Specifies if the quota is global.

      • UsageMetric (dict) --

        Specifies the details about the measurement.

        • MetricNamespace (string) --

          The namespace of the metric. The namespace is a container for CloudWatch metrics. You can specify a name for the namespace when you create a metric.

        • MetricName (string) --

          The name of the CloudWatch metric that measures usage of a service quota. This is a required field.

        • MetricDimensions (dict) --

          A dimension is a name/value pair that is part of the identity of a metric. Every metric has specific characteristics that describe it, and you can think of dimensions as categories for those characteristics. These dimensions are part of the CloudWatch Metric Identity that measures usage against a particular service quota.

          • (string) --
            • (string) --
        • MetricStatisticRecommendation (string) --

          Statistics are metric data aggregations over specified periods of time. This is the recommended statistic to use when comparing usage in the CloudWatch Metric against your Service Quota.

      • Period (dict) --

        Identifies the unit and value of how time is measured.

        • PeriodValue (integer) --

          The value of a period.

        • PeriodUnit (string) --

          The time unit of a period.

      • ErrorReason (dict) --

        Specifies the ErrorCode and ErrorMessage when success isn't achieved.

        • ErrorCode (string) --

          Service Quotas returns the following error values.

          DEPENDENCY_ACCESS_DENIED_ERROR is returned when the caller does not have permission to call the service or service quota. To resolve the error, you need permission to access the service or service quota.

          DEPENDENCY_THROTTLING_ERROR is returned when the service being called is throttling Service Quotas.

          DEPENDENCY_SERVICE_ERROR is returned when the service being called has availability issues.

          SERVICE_QUOTA_NOT_AVAILABLE_ERROR is returned when there was an error in Service Quotas.

        • ErrorMessage (string) --

          The error message that provides more detail.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_requested_service_quota_change(**kwargs)

Retrieves the details for a particular increase request.

See also: AWS API Documentation

Request Syntax

response = client.get_requested_service_quota_change(
    RequestId='string'
)
Parameters
RequestId (string) --

[REQUIRED]

Identifies the quota increase request.

Return type
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',
        'Created': datetime(2015, 1, 1),
        'LastUpdated': datetime(2015, 1, 1),
        'Requester': 'string',
        'QuotaArn': 'string',
        'GlobalQuota': True|False,
        'Unit': 'string'
    }
}

Response Structure

  • (dict) --
    • RequestedQuota (dict) --

      Returns the RequestedServiceQuotaChange object for the specific increase request.

      • Id (string) --

        The unique identifier of a requested service quota change.

      • CaseId (string) --

        The case Id for the service quota increase request.

      • ServiceCode (string) --

        Specifies the service that you want to use.

      • ServiceName (string) --

        The name of the AWS service specified in the increase request.

      • QuotaCode (string) --

        Specifies the service quota that you want to use.

      • QuotaName (string) --

        Name of the service quota.

      • DesiredValue (float) --

        New increased value for the service quota.

      • Status (string) --

        State of the service quota increase request.

      • Created (datetime) --

        The date and time when the service quota increase request was received and the case Id was created.

      • LastUpdated (datetime) --

        The date and time of the most recent change in the service quota increase request.

      • Requester (string) --

        The IAM identity who submitted the service quota increase request.

      • QuotaArn (string) --

        The Amazon Resource Name (ARN) of the service quota.

      • GlobalQuota (boolean) --

        Identifies if the quota is global.

      • Unit (string) --

        Specifies the unit used for the quota.

Exceptions

get_service_quota(**kwargs)

Returns the details for the specified service quota. This operation provides a different Value than the GetAWSDefaultServiceQuota operation. This operation returns the applied value for each quota. GetAWSDefaultServiceQuota returns the default AWS value for each quota.

See also: AWS API Documentation

Request Syntax

response = client.get_service_quota(
    ServiceCode='string',
    QuotaCode='string'
)
Parameters
  • ServiceCode (string) --

    [REQUIRED]

    Specifies the service that you want to use.

  • QuotaCode (string) --

    [REQUIRED]

    Identifies the service quota you want to select.

Return type

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

Response Structure

  • (dict) --

    • Quota (dict) --

      Returns the ServiceQuota object which contains all values for a quota.

      • ServiceCode (string) --

        Specifies the service that you want to use.

      • ServiceName (string) --

        The name of the AWS service specified in the increase request.

      • QuotaArn (string) --

        The Amazon Resource Name (ARN) of the service quota.

      • QuotaCode (string) --

        The code identifier for the service quota specified.

      • QuotaName (string) --

        The name identifier of the service quota.

      • Value (float) --

        The value of service quota.

      • Unit (string) --

        The unit of measurement for the value of the service quota.

      • Adjustable (boolean) --

        Specifies if the quota value can be increased.

      • GlobalQuota (boolean) --

        Specifies if the quota is global.

      • UsageMetric (dict) --

        Specifies the details about the measurement.

        • MetricNamespace (string) --

          The namespace of the metric. The namespace is a container for CloudWatch metrics. You can specify a name for the namespace when you create a metric.

        • MetricName (string) --

          The name of the CloudWatch metric that measures usage of a service quota. This is a required field.

        • MetricDimensions (dict) --

          A dimension is a name/value pair that is part of the identity of a metric. Every metric has specific characteristics that describe it, and you can think of dimensions as categories for those characteristics. These dimensions are part of the CloudWatch Metric Identity that measures usage against a particular service quota.

          • (string) --
            • (string) --
        • MetricStatisticRecommendation (string) --

          Statistics are metric data aggregations over specified periods of time. This is the recommended statistic to use when comparing usage in the CloudWatch Metric against your Service Quota.

      • Period (dict) --

        Identifies the unit and value of how time is measured.

        • PeriodValue (integer) --

          The value of a period.

        • PeriodUnit (string) --

          The time unit of a period.

      • ErrorReason (dict) --

        Specifies the ErrorCode and ErrorMessage when success isn't achieved.

        • ErrorCode (string) --

          Service Quotas returns the following error values.

          DEPENDENCY_ACCESS_DENIED_ERROR is returned when the caller does not have permission to call the service or service quota. To resolve the error, you need permission to access the service or service quota.

          DEPENDENCY_THROTTLING_ERROR is returned when the service being called is throttling Service Quotas.

          DEPENDENCY_SERVICE_ERROR is returned when the service being called has availability issues.

          SERVICE_QUOTA_NOT_AVAILABLE_ERROR is returned when there was an error in Service Quotas.

        • ErrorMessage (string) --

          The error message that provides more detail.

Exceptions

get_service_quota_increase_request_from_template(**kwargs)

Returns the details of the service quota increase request in your template.

See also: AWS API Documentation

Request Syntax

response = client.get_service_quota_increase_request_from_template(
    ServiceCode='string',
    QuotaCode='string',
    AwsRegion='string'
)
Parameters
  • ServiceCode (string) --

    [REQUIRED]

    Specifies the service that you want to use.

  • QuotaCode (string) --

    [REQUIRED]

    Specifies the quota you want.

  • AwsRegion (string) --

    [REQUIRED]

    Specifies the AWS Region for the quota that you want to use.

Return type

dict

Returns

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

      This object contains the details about the quota increase request.

      • ServiceCode (string) --

        The code identifier for the AWS service specified in the increase request.

      • ServiceName (string) --

        The name of the AWS service specified in the increase request.

      • QuotaCode (string) --

        The code identifier for the service quota specified in the increase request.

      • QuotaName (string) --

        The name of the service quota in the increase request.

      • DesiredValue (float) --

        Identifies the new, increased value of the service quota in the increase request.

      • AwsRegion (string) --

        The AWS Region where the increase request occurs.

      • Unit (string) --

        The unit of measure for the increase request.

      • GlobalQuota (boolean) --

        Specifies if the quota is a global quota.

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_aws_default_service_quotas(**kwargs)

Lists all default service quotas for the specified AWS service or all AWS services. ListAWSDefaultServiceQuotas is similar to ListServiceQuotas except for the Value object. The Value object returned by ListAWSDefaultServiceQuotas is the default value assigned by AWS. This request returns a list of all service quotas for the specified service. The listing of each you'll see the default values are the values that AWS provides for the quotas.

Note

Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.

See also: AWS API Documentation

Request Syntax

response = client.list_aws_default_service_quotas(
    ServiceCode='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • ServiceCode (string) --

    [REQUIRED]

    Specifies the service that you want to use.

  • NextToken (string) -- (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
  • MaxResults (integer) -- (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
Return type

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'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    • Quotas (list) --

      A list of the quotas in the account with the AWS default values.

      • (dict) --

        A structure that contains the full set of details that define the service quota.

        • ServiceCode (string) --

          Specifies the service that you want to use.

        • ServiceName (string) --

          The name of the AWS service specified in the increase request.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the service quota.

        • QuotaCode (string) --

          The code identifier for the service quota specified.

        • QuotaName (string) --

          The name identifier of the service quota.

        • Value (float) --

          The value of service quota.

        • Unit (string) --

          The unit of measurement for the value of the service quota.

        • Adjustable (boolean) --

          Specifies if the quota value can be increased.

        • GlobalQuota (boolean) --

          Specifies if the quota is global.

        • UsageMetric (dict) --

          Specifies the details about the measurement.

          • MetricNamespace (string) --

            The namespace of the metric. The namespace is a container for CloudWatch metrics. You can specify a name for the namespace when you create a metric.

          • MetricName (string) --

            The name of the CloudWatch metric that measures usage of a service quota. This is a required field.

          • MetricDimensions (dict) --

            A dimension is a name/value pair that is part of the identity of a metric. Every metric has specific characteristics that describe it, and you can think of dimensions as categories for those characteristics. These dimensions are part of the CloudWatch Metric Identity that measures usage against a particular service quota.

            • (string) --
              • (string) --
          • MetricStatisticRecommendation (string) --

            Statistics are metric data aggregations over specified periods of time. This is the recommended statistic to use when comparing usage in the CloudWatch Metric against your Service Quota.

        • Period (dict) --

          Identifies the unit and value of how time is measured.

          • PeriodValue (integer) --

            The value of a period.

          • PeriodUnit (string) --

            The time unit of a period.

        • ErrorReason (dict) --

          Specifies the ErrorCode and ErrorMessage when success isn't achieved.

          • ErrorCode (string) --

            Service Quotas returns the following error values.

            DEPENDENCY_ACCESS_DENIED_ERROR is returned when the caller does not have permission to call the service or service quota. To resolve the error, you need permission to access the service or service quota.

            DEPENDENCY_THROTTLING_ERROR is returned when the service being called is throttling Service Quotas.

            DEPENDENCY_SERVICE_ERROR is returned when the service being called has availability issues.

            SERVICE_QUOTA_NOT_AVAILABLE_ERROR is returned when there was an error in Service Quotas.

          • ErrorMessage (string) --

            The error message that provides more detail.

Exceptions

list_requested_service_quota_change_history(**kwargs)

Requests a list of the changes to quotas for a 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
)
Parameters
  • ServiceCode (string) -- Specifies the service that you want to use.
  • Status (string) -- Specifies the status value of the quota increase request.
  • NextToken (string) -- (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
  • MaxResults (integer) -- (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
Return type

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',
            'Created': datetime(2015, 1, 1),
            'LastUpdated': datetime(2015, 1, 1),
            'Requester': 'string',
            'QuotaArn': 'string',
            'GlobalQuota': True|False,
            'Unit': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null ).

    • RequestedQuotas (list) --

      Returns a list of service quota requests.

      • (dict) --

        A structure that contains information about a requested change for a quota.

        • Id (string) --

          The unique identifier of a requested service quota change.

        • CaseId (string) --

          The case Id for the service quota increase request.

        • ServiceCode (string) --

          Specifies the service that you want to use.

        • ServiceName (string) --

          The name of the AWS service specified in the increase request.

        • QuotaCode (string) --

          Specifies the service quota that you want to use.

        • QuotaName (string) --

          Name of the service quota.

        • DesiredValue (float) --

          New increased value for the service quota.

        • Status (string) --

          State of the service quota increase request.

        • Created (datetime) --

          The date and time when the service quota increase request was received and the case Id was created.

        • LastUpdated (datetime) --

          The date and time of the most recent change in the service quota increase request.

        • Requester (string) --

          The IAM identity who submitted the service quota increase request.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the service quota.

        • GlobalQuota (boolean) --

          Identifies if the quota is global.

        • Unit (string) --

          Specifies the unit used for the quota.

Exceptions

list_requested_service_quota_change_history_by_quota(**kwargs)

Requests a list of the changes to specific service quotas. This command provides additional granularity over the ListRequestedServiceQuotaChangeHistory command. Once a quota change request has reached CASE_CLOSED, APPROVED, or DENIED , the history has been kept for 90 days.

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
)
Parameters
  • ServiceCode (string) --

    [REQUIRED]

    Specifies the service that you want to use.

  • QuotaCode (string) --

    [REQUIRED]

    Specifies the service quota that you want to use

  • Status (string) -- Specifies the status value of the quota increase request.
  • NextToken (string) -- (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
  • MaxResults (integer) -- (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
Return type

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',
            'Created': datetime(2015, 1, 1),
            'LastUpdated': datetime(2015, 1, 1),
            'Requester': 'string',
            'QuotaArn': 'string',
            'GlobalQuota': True|False,
            'Unit': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null ).

    • RequestedQuotas (list) --

      Returns a list of service quota requests.

      • (dict) --

        A structure that contains information about a requested change for a quota.

        • Id (string) --

          The unique identifier of a requested service quota change.

        • CaseId (string) --

          The case Id for the service quota increase request.

        • ServiceCode (string) --

          Specifies the service that you want to use.

        • ServiceName (string) --

          The name of the AWS service specified in the increase request.

        • QuotaCode (string) --

          Specifies the service quota that you want to use.

        • QuotaName (string) --

          Name of the service quota.

        • DesiredValue (float) --

          New increased value for the service quota.

        • Status (string) --

          State of the service quota increase request.

        • Created (datetime) --

          The date and time when the service quota increase request was received and the case Id was created.

        • LastUpdated (datetime) --

          The date and time of the most recent change in the service quota increase request.

        • Requester (string) --

          The IAM identity who submitted the service quota increase request.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the service quota.

        • GlobalQuota (boolean) --

          Identifies if the quota is global.

        • Unit (string) --

          Specifies the unit used for the quota.

Exceptions

list_service_quota_increase_requests_in_template(**kwargs)

Returns a list of the quota increase requests in the 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
)
Parameters
  • ServiceCode (string) -- The identifier for a service. When performing an operation, use the ServiceCode to specify a particular service.
  • AwsRegion (string) -- Specifies the AWS Region for the quota that you want to use.
  • NextToken (string) -- (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
  • MaxResults (integer) -- (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
Return type

dict

Returns

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

      Returns the list of values of the quota increase request in the template.

      • (dict) --

        A structure that contains information about one service quota increase request.

        • ServiceCode (string) --

          The code identifier for the AWS service specified in the increase request.

        • ServiceName (string) --

          The name of the AWS service specified in the increase request.

        • QuotaCode (string) --

          The code identifier for the service quota specified in the increase request.

        • QuotaName (string) --

          The name of the service quota in the increase request.

        • DesiredValue (float) --

          Identifies the new, increased value of the service quota in the increase request.

        • AwsRegion (string) --

          The AWS Region where the increase request occurs.

        • Unit (string) --

          The unit of measure for the increase request.

        • GlobalQuota (boolean) --

          Specifies if the quota is a global quota.

    • NextToken (string) --

      If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null ).

Exceptions

list_service_quotas(**kwargs)

Lists all service quotas for the specified AWS service. This request returns a list of the service quotas for the specified service. you'll see the default values are the values that AWS provides for the quotas.

Note

Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.

See also: AWS API Documentation

Request Syntax

response = client.list_service_quotas(
    ServiceCode='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • ServiceCode (string) --

    [REQUIRED]

    The identifier for a service. When performing an operation, use the ServiceCode to specify a particular service.

  • NextToken (string) -- (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
  • MaxResults (integer) -- (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
Return type

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'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null ).

    • Quotas (list) --

      The response information for a quota lists all attribute information for the quota.

      • (dict) --

        A structure that contains the full set of details that define the service quota.

        • ServiceCode (string) --

          Specifies the service that you want to use.

        • ServiceName (string) --

          The name of the AWS service specified in the increase request.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the service quota.

        • QuotaCode (string) --

          The code identifier for the service quota specified.

        • QuotaName (string) --

          The name identifier of the service quota.

        • Value (float) --

          The value of service quota.

        • Unit (string) --

          The unit of measurement for the value of the service quota.

        • Adjustable (boolean) --

          Specifies if the quota value can be increased.

        • GlobalQuota (boolean) --

          Specifies if the quota is global.

        • UsageMetric (dict) --

          Specifies the details about the measurement.

          • MetricNamespace (string) --

            The namespace of the metric. The namespace is a container for CloudWatch metrics. You can specify a name for the namespace when you create a metric.

          • MetricName (string) --

            The name of the CloudWatch metric that measures usage of a service quota. This is a required field.

          • MetricDimensions (dict) --

            A dimension is a name/value pair that is part of the identity of a metric. Every metric has specific characteristics that describe it, and you can think of dimensions as categories for those characteristics. These dimensions are part of the CloudWatch Metric Identity that measures usage against a particular service quota.

            • (string) --
              • (string) --
          • MetricStatisticRecommendation (string) --

            Statistics are metric data aggregations over specified periods of time. This is the recommended statistic to use when comparing usage in the CloudWatch Metric against your Service Quota.

        • Period (dict) --

          Identifies the unit and value of how time is measured.

          • PeriodValue (integer) --

            The value of a period.

          • PeriodUnit (string) --

            The time unit of a period.

        • ErrorReason (dict) --

          Specifies the ErrorCode and ErrorMessage when success isn't achieved.

          • ErrorCode (string) --

            Service Quotas returns the following error values.

            DEPENDENCY_ACCESS_DENIED_ERROR is returned when the caller does not have permission to call the service or service quota. To resolve the error, you need permission to access the service or service quota.

            DEPENDENCY_THROTTLING_ERROR is returned when the service being called is throttling Service Quotas.

            DEPENDENCY_SERVICE_ERROR is returned when the service being called has availability issues.

            SERVICE_QUOTA_NOT_AVAILABLE_ERROR is returned when there was an error in Service Quotas.

          • ErrorMessage (string) --

            The error message that provides more detail.

Exceptions

list_services(**kwargs)

Lists the AWS services available in Service Quotas. Not all AWS services are available in Service Quotas. To list the see the list of the service quotas for a specific service, use ListServiceQuotas .

See also: AWS API Documentation

Request Syntax

response = client.list_services(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
  • MaxResults (integer) -- (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'Services': [
        {
            'ServiceCode': 'string',
            'ServiceName': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null ).

    • Services (list) --

      Returns a list of services.

      • (dict) --

        A structure that contains the ServiceName and ServiceCode . It does not include all details of the service quota. To get those values, use the ListServiceQuotas operation.

        • ServiceCode (string) --

          Specifies the service that you want to use.

        • ServiceName (string) --

          The name of the AWS service specified in the increase request.

Exceptions

put_service_quota_increase_request_into_template(**kwargs)

Defines and adds a quota to the service quota template. To add a quota to the template, you must provide the ServiceCode , QuotaCode , AwsRegion , and DesiredValue . Once you add a quota to the template, use ListServiceQuotaIncreaseRequestsInTemplate to see the list of quotas in the 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
)
Parameters
  • QuotaCode (string) --

    [REQUIRED]

    Specifies the service quota that you want to use.

  • ServiceCode (string) --

    [REQUIRED]

    Specifies the service that you want to use.

  • AwsRegion (string) --

    [REQUIRED]

    Specifies the AWS Region for the quota.

  • DesiredValue (float) --

    [REQUIRED]

    Specifies the new, increased value for the quota.

Return type

dict

Returns

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

      A structure that contains information about one service quota increase request.

      • ServiceCode (string) --

        The code identifier for the AWS service specified in the increase request.

      • ServiceName (string) --

        The name of the AWS service specified in the increase request.

      • QuotaCode (string) --

        The code identifier for the service quota specified in the increase request.

      • QuotaName (string) --

        The name of the service quota in the increase request.

      • DesiredValue (float) --

        Identifies the new, increased value of the service quota in the increase request.

      • AwsRegion (string) --

        The AWS Region where the increase request occurs.

      • Unit (string) --

        The unit of measure for the increase request.

      • GlobalQuota (boolean) --

        Specifies if the quota is a global quota.

Exceptions

request_service_quota_increase(**kwargs)

Retrieves the details of a service quota increase request. The response to this command provides the details in the RequestedServiceQuotaChange object.

See also: AWS API Documentation

Request Syntax

response = client.request_service_quota_increase(
    ServiceCode='string',
    QuotaCode='string',
    DesiredValue=123.0
)
Parameters
  • ServiceCode (string) --

    [REQUIRED]

    Specifies the service that you want to use.

  • QuotaCode (string) --

    [REQUIRED]

    Specifies the service quota that you want to use.

  • DesiredValue (float) --

    [REQUIRED]

    Specifies the value submitted in the service quota increase request.

Return type

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',
        'Created': datetime(2015, 1, 1),
        'LastUpdated': datetime(2015, 1, 1),
        'Requester': 'string',
        'QuotaArn': 'string',
        'GlobalQuota': True|False,
        'Unit': 'string'
    }
}

Response Structure

  • (dict) --

    • RequestedQuota (dict) --

      Returns a list of service quota requests.

      • Id (string) --

        The unique identifier of a requested service quota change.

      • CaseId (string) --

        The case Id for the service quota increase request.

      • ServiceCode (string) --

        Specifies the service that you want to use.

      • ServiceName (string) --

        The name of the AWS service specified in the increase request.

      • QuotaCode (string) --

        Specifies the service quota that you want to use.

      • QuotaName (string) --

        Name of the service quota.

      • DesiredValue (float) --

        New increased value for the service quota.

      • Status (string) --

        State of the service quota increase request.

      • Created (datetime) --

        The date and time when the service quota increase request was received and the case Id was created.

      • LastUpdated (datetime) --

        The date and time of the most recent change in the service quota increase request.

      • Requester (string) --

        The IAM identity who submitted the service quota increase request.

      • QuotaArn (string) --

        The Amazon Resource Name (ARN) of the service quota.

      • GlobalQuota (boolean) --

        Identifies if the quota is global.

      • Unit (string) --

        Specifies the unit used for the quota.

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class ServiceQuotas.Client.exceptions.AWSServiceAccessNotEnabledException

The action you attempted is not allowed unless Service Access with Service Quotas is enabled in your organization. To enable, call AssociateServiceQuotaTemplate .

Example

try:
  ...
except client.exceptions.AWSServiceAccessNotEnabledException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The action you attempted is not allowed unless Service Access with Service Quotas is enabled in your organization. To enable, call AssociateServiceQuotaTemplate .

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ServiceQuotas.Client.exceptions.AccessDeniedException

You do not have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You do not have sufficient access to perform this action.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ServiceQuotas.Client.exceptions.DependencyAccessDeniedException

You can't perform this action because a dependency does not have access.

Example

try:
  ...
except client.exceptions.DependencyAccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You can't perform this action because a dependency does not have access.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ServiceQuotas.Client.exceptions.IllegalArgumentException

Invalid input was provided.

Example

try:
  ...
except client.exceptions.IllegalArgumentException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Invalid input was provided.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ServiceQuotas.Client.exceptions.InvalidPaginationTokenException

Invalid input was provided.

Example

try:
  ...
except client.exceptions.InvalidPaginationTokenException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Invalid input was provided.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ServiceQuotas.Client.exceptions.InvalidResourceStateException

Invalid input was provided for the .

Example

try:
  ...
except client.exceptions.InvalidResourceStateException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Invalid input was provided for the .

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ServiceQuotas.Client.exceptions.NoAvailableOrganizationException

The account making this call is not a member of an organization.

Example

try:
  ...
except client.exceptions.NoAvailableOrganizationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The account making this call is not a member of an organization.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ServiceQuotas.Client.exceptions.NoSuchResourceException

The specified resource does not exist.

Example

try:
  ...
except client.exceptions.NoSuchResourceException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified resource does not exist.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ServiceQuotas.Client.exceptions.OrganizationNotInAllFeaturesModeException

The organization that your account belongs to, is not in All Features mode. To enable all features mode, see EnableAllFeatures .

Example

try:
  ...
except client.exceptions.OrganizationNotInAllFeaturesModeException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The organization that your account belongs to, is not in All Features mode. To enable all features mode, see EnableAllFeatures .

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ServiceQuotas.Client.exceptions.QuotaExceededException

You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

Example

try:
  ...
except client.exceptions.QuotaExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ServiceQuotas.Client.exceptions.ResourceAlreadyExistsException

The specified resource already exists.

Example

try:
  ...
except client.exceptions.ResourceAlreadyExistsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The specified resource already exists.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ServiceQuotas.Client.exceptions.ServiceException

Something went wrong.

Example

try:
  ...
except client.exceptions.ServiceException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Something went wrong.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ServiceQuotas.Client.exceptions.ServiceQuotaTemplateNotInUseException

The quota request template is not associated with your organization.

To use the template, call AssociateServiceQuotaTemplate .

Example

try:
  ...
except client.exceptions.ServiceQuotaTemplateNotInUseException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The quota request template is not associated with your organization.

    To use the template, call AssociateServiceQuotaTemplate .

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ServiceQuotas.Client.exceptions.TemplatesNotAvailableInRegionException

The Service Quotas template is not available in the Region where you are making the request. Please make the request in us-east-1.

Example

try:
  ...
except client.exceptions.TemplatesNotAvailableInRegionException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The Service Quotas template is not available in the Region where you are making the request. Please make the request in us-east-1.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ServiceQuotas.Client.exceptions.TooManyRequestsException

Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.

Example

try:
  ...
except client.exceptions.TooManyRequestsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class ServiceQuotas.Paginator.ListAWSDefaultServiceQuotas
paginator = client.get_paginator('list_aws_default_service_quotas')
paginate(**kwargs)

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'
    }
)
Parameters
  • ServiceCode (string) --

    [REQUIRED]

    Specifies the service that you want to use.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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

      A list of the quotas in the account with the AWS default values.

      • (dict) --

        A structure that contains the full set of details that define the service quota.

        • ServiceCode (string) --

          Specifies the service that you want to use.

        • ServiceName (string) --

          The name of the AWS service specified in the increase request.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the service quota.

        • QuotaCode (string) --

          The code identifier for the service quota specified.

        • QuotaName (string) --

          The name identifier of the service quota.

        • Value (float) --

          The value of service quota.

        • Unit (string) --

          The unit of measurement for the value of the service quota.

        • Adjustable (boolean) --

          Specifies if the quota value can be increased.

        • GlobalQuota (boolean) --

          Specifies if the quota is global.

        • UsageMetric (dict) --

          Specifies the details about the measurement.

          • MetricNamespace (string) --

            The namespace of the metric. The namespace is a container for CloudWatch metrics. You can specify a name for the namespace when you create a metric.

          • MetricName (string) --

            The name of the CloudWatch metric that measures usage of a service quota. This is a required field.

          • MetricDimensions (dict) --

            A dimension is a name/value pair that is part of the identity of a metric. Every metric has specific characteristics that describe it, and you can think of dimensions as categories for those characteristics. These dimensions are part of the CloudWatch Metric Identity that measures usage against a particular service quota.

            • (string) --
              • (string) --
          • MetricStatisticRecommendation (string) --

            Statistics are metric data aggregations over specified periods of time. This is the recommended statistic to use when comparing usage in the CloudWatch Metric against your Service Quota.

        • Period (dict) --

          Identifies the unit and value of how time is measured.

          • PeriodValue (integer) --

            The value of a period.

          • PeriodUnit (string) --

            The time unit of a period.

        • ErrorReason (dict) --

          Specifies the ErrorCode and ErrorMessage when success isn't achieved.

          • ErrorCode (string) --

            Service Quotas returns the following error values.

            DEPENDENCY_ACCESS_DENIED_ERROR is returned when the caller does not have permission to call the service or service quota. To resolve the error, you need permission to access the service or service quota.

            DEPENDENCY_THROTTLING_ERROR is returned when the service being called is throttling Service Quotas.

            DEPENDENCY_SERVICE_ERROR is returned when the service being called has availability issues.

            SERVICE_QUOTA_NOT_AVAILABLE_ERROR is returned when there was an error in Service Quotas.

          • ErrorMessage (string) --

            The error message that provides more detail.

class ServiceQuotas.Paginator.ListRequestedServiceQuotaChangeHistory
paginator = client.get_paginator('list_requested_service_quota_change_history')
paginate(**kwargs)

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'
    }
)
Parameters
  • ServiceCode (string) -- Specifies the service that you want to use.
  • Status (string) -- Specifies the status value of the quota increase request.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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

      Returns a list of service quota requests.

      • (dict) --

        A structure that contains information about a requested change for a quota.

        • Id (string) --

          The unique identifier of a requested service quota change.

        • CaseId (string) --

          The case Id for the service quota increase request.

        • ServiceCode (string) --

          Specifies the service that you want to use.

        • ServiceName (string) --

          The name of the AWS service specified in the increase request.

        • QuotaCode (string) --

          Specifies the service quota that you want to use.

        • QuotaName (string) --

          Name of the service quota.

        • DesiredValue (float) --

          New increased value for the service quota.

        • Status (string) --

          State of the service quota increase request.

        • Created (datetime) --

          The date and time when the service quota increase request was received and the case Id was created.

        • LastUpdated (datetime) --

          The date and time of the most recent change in the service quota increase request.

        • Requester (string) --

          The IAM identity who submitted the service quota increase request.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the service quota.

        • GlobalQuota (boolean) --

          Identifies if the quota is global.

        • Unit (string) --

          Specifies the unit used for the quota.

class ServiceQuotas.Paginator.ListRequestedServiceQuotaChangeHistoryByQuota
paginator = client.get_paginator('list_requested_service_quota_change_history_by_quota')
paginate(**kwargs)

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'
    }
)
Parameters
  • ServiceCode (string) --

    [REQUIRED]

    Specifies the service that you want to use.

  • QuotaCode (string) --

    [REQUIRED]

    Specifies the service quota that you want to use

  • Status (string) -- Specifies the status value of the quota increase request.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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

      Returns a list of service quota requests.

      • (dict) --

        A structure that contains information about a requested change for a quota.

        • Id (string) --

          The unique identifier of a requested service quota change.

        • CaseId (string) --

          The case Id for the service quota increase request.

        • ServiceCode (string) --

          Specifies the service that you want to use.

        • ServiceName (string) --

          The name of the AWS service specified in the increase request.

        • QuotaCode (string) --

          Specifies the service quota that you want to use.

        • QuotaName (string) --

          Name of the service quota.

        • DesiredValue (float) --

          New increased value for the service quota.

        • Status (string) --

          State of the service quota increase request.

        • Created (datetime) --

          The date and time when the service quota increase request was received and the case Id was created.

        • LastUpdated (datetime) --

          The date and time of the most recent change in the service quota increase request.

        • Requester (string) --

          The IAM identity who submitted the service quota increase request.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the service quota.

        • GlobalQuota (boolean) --

          Identifies if the quota is global.

        • Unit (string) --

          Specifies the unit used for the quota.

class ServiceQuotas.Paginator.ListServiceQuotaIncreaseRequestsInTemplate
paginator = client.get_paginator('list_service_quota_increase_requests_in_template')
paginate(**kwargs)

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'
    }
)
Parameters
  • ServiceCode (string) -- The identifier for a service. When performing an operation, use the ServiceCode to specify a particular service.
  • AwsRegion (string) -- Specifies the AWS Region for the quota that you want to use.
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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

      Returns the list of values of the quota increase request in the template.

      • (dict) --

        A structure that contains information about one service quota increase request.

        • ServiceCode (string) --

          The code identifier for the AWS service specified in the increase request.

        • ServiceName (string) --

          The name of the AWS service specified in the increase request.

        • QuotaCode (string) --

          The code identifier for the service quota specified in the increase request.

        • QuotaName (string) --

          The name of the service quota in the increase request.

        • DesiredValue (float) --

          Identifies the new, increased value of the service quota in the increase request.

        • AwsRegion (string) --

          The AWS Region where the increase request occurs.

        • Unit (string) --

          The unit of measure for the increase request.

        • GlobalQuota (boolean) --

          Specifies if the quota is a global quota.

class ServiceQuotas.Paginator.ListServiceQuotas
paginator = client.get_paginator('list_service_quotas')
paginate(**kwargs)

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'
    }
)
Parameters
  • ServiceCode (string) --

    [REQUIRED]

    The identifier for a service. When performing an operation, use the ServiceCode to specify a particular service.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      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.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

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

      The response information for a quota lists all attribute information for the quota.

      • (dict) --

        A structure that contains the full set of details that define the service quota.

        • ServiceCode (string) --

          Specifies the service that you want to use.

        • ServiceName (string) --

          The name of the AWS service specified in the increase request.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the service quota.

        • QuotaCode (string) --

          The code identifier for the service quota specified.

        • QuotaName (string) --

          The name identifier of the service quota.

        • Value (float) --

          The value of service quota.

        • Unit (string) --

          The unit of measurement for the value of the service quota.

        • Adjustable (boolean) --

          Specifies if the quota value can be increased.

        • GlobalQuota (boolean) --

          Specifies if the quota is global.

        • UsageMetric (dict) --

          Specifies the details about the measurement.

          • MetricNamespace (string) --

            The namespace of the metric. The namespace is a container for CloudWatch metrics. You can specify a name for the namespace when you create a metric.

          • MetricName (string) --

            The name of the CloudWatch metric that measures usage of a service quota. This is a required field.

          • MetricDimensions (dict) --

            A dimension is a name/value pair that is part of the identity of a metric. Every metric has specific characteristics that describe it, and you can think of dimensions as categories for those characteristics. These dimensions are part of the CloudWatch Metric Identity that measures usage against a particular service quota.

            • (string) --
              • (string) --
          • MetricStatisticRecommendation (string) --

            Statistics are metric data aggregations over specified periods of time. This is the recommended statistic to use when comparing usage in the CloudWatch Metric against your Service Quota.

        • Period (dict) --

          Identifies the unit and value of how time is measured.

          • PeriodValue (integer) --

            The value of a period.

          • PeriodUnit (string) --

            The time unit of a period.

        • ErrorReason (dict) --

          Specifies the ErrorCode and ErrorMessage when success isn't achieved.

          • ErrorCode (string) --

            Service Quotas returns the following error values.

            DEPENDENCY_ACCESS_DENIED_ERROR is returned when the caller does not have permission to call the service or service quota. To resolve the error, you need permission to access the service or service quota.

            DEPENDENCY_THROTTLING_ERROR is returned when the service being called is throttling Service Quotas.

            DEPENDENCY_SERVICE_ERROR is returned when the service being called has availability issues.

            SERVICE_QUOTA_NOT_AVAILABLE_ERROR is returned when there was an error in Service Quotas.

          • ErrorMessage (string) --

            The error message that provides more detail.

class ServiceQuotas.Paginator.ListServices
paginator = client.get_paginator('list_services')
paginate(**kwargs)

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'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    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.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Services': [
        {
            'ServiceCode': 'string',
            'ServiceName': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • Services (list) --

      Returns a list of services.

      • (dict) --

        A structure that contains the ServiceName and ServiceCode . It does not include all details of the service quota. To get those values, use the ListServiceQuotas operation.

        • ServiceCode (string) --

          Specifies the service that you want to use.

        • ServiceName (string) --

          The name of the AWS service specified in the increase request.