ServiceQuotas

Client

class ServiceQuotas.Client

A low-level client representing Service Quotas

With Service Quotas, you can view and manage your quotas easily as your AWS workloads grow. Quotas, also referred to as limits, are the maximum number of resources that you can create in your AWS account. For more information, see the Service Quotas User Guide .

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

These are the available methods:

associate_service_quota_template()

Associates your quota request template with your organization. When a new account is created in your organization, the quota increase requests in the template are automatically applied to the account. You can add a quota increase request for any adjustable quota to your template.

See also: AWS API Documentation

Request Syntax

response = client.associate_service_quota_template()
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)

Deletes the quota increase request for the specified quota from your quota request template.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The service identifier.

  • QuotaCode (string) --

    [REQUIRED]

    The quota identifier.

  • AwsRegion (string) --

    [REQUIRED]

    The AWS Region.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

disassociate_service_quota_template()

Disables your quota request template. After a template is disabled, the quota increase requests in the template are not applied to new accounts in your organization. Disabling a quota request template does not apply its quota increase requests.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_service_quota_template()
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 status of the association for the quota request template.

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

      The association status. If the status is ASSOCIATED , the quota increase requests in the template are automatically applied to new accounts in your organization.

Exceptions

get_aws_default_service_quota(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The service identifier.

  • QuotaCode (string) --

    [REQUIRED]

    The quota identifier.

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

      Information about the quota.

      • ServiceCode (string) --

        The service identifier.

      • ServiceName (string) --

        The service name.

      • QuotaArn (string) --

        The Amazon Resource Name (ARN) of the quota.

      • QuotaCode (string) --

        The quota identifier.

      • QuotaName (string) --

        The quota name.

      • Value (float) --

        The quota value.

      • Unit (string) --

        The unit of measurement.

      • Adjustable (boolean) --

        Indicates whether the quota value can be increased.

      • GlobalQuota (boolean) --

        Indicates whether the quota is global.

      • UsageMetric (dict) --

        Information about the measurement.

        • MetricNamespace (string) --

          The namespace of the metric.

        • MetricName (string) --

          The name of the metric.

        • MetricDimensions (dict) --

          The metric dimension. This is a name/value pair that is part of the identity of a metric.

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

        • 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 service or quota.
          • DEPENDENCY_THROTTLING_ERROR - The service is throttling Service Quotas.
          • DEPENDENCY_SERVICE_ERROR - The service is not available.
          • SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.
        • ErrorMessage (string) --

          The error message.

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 information about the specified quota increase request.

See also: AWS API Documentation

Request Syntax

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

[REQUIRED]

The ID of 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) --

      Information about the quota increase request.

      • Id (string) --

        The unique identifier.

      • CaseId (string) --

        The case ID.

      • ServiceCode (string) --

        The service identifier.

      • ServiceName (string) --

        The service name.

      • QuotaCode (string) --

        The quota identifier.

      • QuotaName (string) --

        The quota name.

      • DesiredValue (float) --

        The new, increased value for the quota.

      • Status (string) --

        The state of the quota increase request.

      • Created (datetime) --

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

      • LastUpdated (datetime) --

        The date and time of the most recent change.

      • Requester (string) --

        The IAM identity of the requester.

      • QuotaArn (string) --

        The Amazon Resource Name (ARN) of the quota.

      • GlobalQuota (boolean) --

        Indicates whether the quota is global.

      • Unit (string) --

        The unit of measurement.

Exceptions

get_service_quota(**kwargs)

Retrieves the applied quota value for the specified quota. For some quotas, only the default values are available. If the applied quota value is not available for a quota, the quota is not retrieved.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The service identifier.

  • QuotaCode (string) --

    [REQUIRED]

    The quota identifier.

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

      Information about the quota.

      • ServiceCode (string) --

        The service identifier.

      • ServiceName (string) --

        The service name.

      • QuotaArn (string) --

        The Amazon Resource Name (ARN) of the quota.

      • QuotaCode (string) --

        The quota identifier.

      • QuotaName (string) --

        The quota name.

      • Value (float) --

        The quota value.

      • Unit (string) --

        The unit of measurement.

      • Adjustable (boolean) --

        Indicates whether the quota value can be increased.

      • GlobalQuota (boolean) --

        Indicates whether the quota is global.

      • UsageMetric (dict) --

        Information about the measurement.

        • MetricNamespace (string) --

          The namespace of the metric.

        • MetricName (string) --

          The name of the metric.

        • MetricDimensions (dict) --

          The metric dimension. This is a name/value pair that is part of the identity of a metric.

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

        • 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 service or quota.
          • DEPENDENCY_THROTTLING_ERROR - The service is throttling Service Quotas.
          • DEPENDENCY_SERVICE_ERROR - The service is not available.
          • SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.
        • ErrorMessage (string) --

          The error message.

Exceptions

get_service_quota_increase_request_from_template(**kwargs)

Retrieves information about the specified quota increase request in your quota request template.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The service identifier.

  • QuotaCode (string) --

    [REQUIRED]

    The quota identifier.

  • AwsRegion (string) --

    [REQUIRED]

    The AWS Region.

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

      Information about the quota increase request.

      • ServiceCode (string) --

        The service identifier.

      • ServiceName (string) --

        The service name.

      • QuotaCode (string) --

        The quota identifier.

      • QuotaName (string) --

        The quota name.

      • DesiredValue (float) --

        The new, increased value of the quota.

      • AwsRegion (string) --

        The AWS Region.

      • Unit (string) --

        The unit of measurement.

      • GlobalQuota (boolean) --

        Indicates whether the quota is global.

Exceptions

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 the default values for the quotas for the specified AWS service. A default value does not reflect any quota increases.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The service identifier.

  • NextToken (string) -- The token for the next page of results.
  • MaxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.
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) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    • Quotas (list) --

      Information about the quotas.

      • (dict) --

        Information about a quota.

        • ServiceCode (string) --

          The service identifier.

        • ServiceName (string) --

          The service name.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the quota.

        • QuotaCode (string) --

          The quota identifier.

        • QuotaName (string) --

          The quota name.

        • Value (float) --

          The quota value.

        • Unit (string) --

          The unit of measurement.

        • Adjustable (boolean) --

          Indicates whether the quota value can be increased.

        • GlobalQuota (boolean) --

          Indicates whether the quota is global.

        • UsageMetric (dict) --

          Information about the measurement.

          • MetricNamespace (string) --

            The namespace of the metric.

          • MetricName (string) --

            The name of the metric.

          • MetricDimensions (dict) --

            The metric dimension. This is a name/value pair that is part of the identity of a metric.

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

          • 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 service or quota.
            • DEPENDENCY_THROTTLING_ERROR - The service is throttling Service Quotas.
            • DEPENDENCY_SERVICE_ERROR - The service is not available.
            • SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.
          • ErrorMessage (string) --

            The error message.

Exceptions

list_requested_service_quota_change_history(**kwargs)

Retrieves the quota increase requests for the specified service.

See also: AWS API Documentation

Request Syntax

response = client.list_requested_service_quota_change_history(
    ServiceCode='string',
    Status='PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED',
    NextToken='string',
    MaxResults=123
)
Parameters
  • ServiceCode (string) -- The service identifier.
  • Status (string) -- The status of the quota increase request.
  • NextToken (string) -- The token for the next page of results.
  • MaxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.
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) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    • RequestedQuotas (list) --

      Information about the quota increase requests.

      • (dict) --

        Information about a quota increase request.

        • Id (string) --

          The unique identifier.

        • CaseId (string) --

          The case ID.

        • ServiceCode (string) --

          The service identifier.

        • ServiceName (string) --

          The service name.

        • QuotaCode (string) --

          The quota identifier.

        • QuotaName (string) --

          The quota name.

        • DesiredValue (float) --

          The new, increased value for the quota.

        • Status (string) --

          The state of the quota increase request.

        • Created (datetime) --

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

        • LastUpdated (datetime) --

          The date and time of the most recent change.

        • Requester (string) --

          The IAM identity of the requester.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the quota.

        • GlobalQuota (boolean) --

          Indicates whether the quota is global.

        • Unit (string) --

          The unit of measurement.

Exceptions

list_requested_service_quota_change_history_by_quota(**kwargs)

Retrieves the quota increase requests for the specified quota.

See also: AWS API Documentation

Request Syntax

response = client.list_requested_service_quota_change_history_by_quota(
    ServiceCode='string',
    QuotaCode='string',
    Status='PENDING'|'CASE_OPENED'|'APPROVED'|'DENIED'|'CASE_CLOSED',
    NextToken='string',
    MaxResults=123
)
Parameters
  • ServiceCode (string) --

    [REQUIRED]

    The service identifier.

  • QuotaCode (string) --

    [REQUIRED]

    The quota identifier.

  • Status (string) -- The status value of the quota increase request.
  • NextToken (string) -- The token for the next page of results.
  • MaxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.
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) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    • RequestedQuotas (list) --

      Information about the quota increase requests.

      • (dict) --

        Information about a quota increase request.

        • Id (string) --

          The unique identifier.

        • CaseId (string) --

          The case ID.

        • ServiceCode (string) --

          The service identifier.

        • ServiceName (string) --

          The service name.

        • QuotaCode (string) --

          The quota identifier.

        • QuotaName (string) --

          The quota name.

        • DesiredValue (float) --

          The new, increased value for the quota.

        • Status (string) --

          The state of the quota increase request.

        • Created (datetime) --

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

        • LastUpdated (datetime) --

          The date and time of the most recent change.

        • Requester (string) --

          The IAM identity of the requester.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the quota.

        • GlobalQuota (boolean) --

          Indicates whether the quota is global.

        • Unit (string) --

          The unit of measurement.

Exceptions

list_service_quota_increase_requests_in_template(**kwargs)

Lists the quota increase requests in the specified quota request template.

See also: AWS API Documentation

Request Syntax

response = client.list_service_quota_increase_requests_in_template(
    ServiceCode='string',
    AwsRegion='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • ServiceCode (string) -- The service identifier.
  • AwsRegion (string) -- The AWS Region.
  • NextToken (string) -- The token for the next page of results.
  • MaxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.
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) --

      Information about the quota increase requests.

      • (dict) --

        Information about a quota increase request.

        • ServiceCode (string) --

          The service identifier.

        • ServiceName (string) --

          The service name.

        • QuotaCode (string) --

          The quota identifier.

        • QuotaName (string) --

          The quota name.

        • DesiredValue (float) --

          The new, increased value of the quota.

        • AwsRegion (string) --

          The AWS Region.

        • Unit (string) --

          The unit of measurement.

        • GlobalQuota (boolean) --

          Indicates whether the quota is global.

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

list_service_quotas(**kwargs)

Lists the applied quota values for the specified AWS service. For some quotas, only the default values are available. If the applied quota value is not available for a quota, the quota is not retrieved.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The service identifier.

  • NextToken (string) -- The token for the next page of results.
  • MaxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.
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) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    • Quotas (list) --

      Information about the quotas.

      • (dict) --

        Information about a quota.

        • ServiceCode (string) --

          The service identifier.

        • ServiceName (string) --

          The service name.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the quota.

        • QuotaCode (string) --

          The quota identifier.

        • QuotaName (string) --

          The quota name.

        • Value (float) --

          The quota value.

        • Unit (string) --

          The unit of measurement.

        • Adjustable (boolean) --

          Indicates whether the quota value can be increased.

        • GlobalQuota (boolean) --

          Indicates whether the quota is global.

        • UsageMetric (dict) --

          Information about the measurement.

          • MetricNamespace (string) --

            The namespace of the metric.

          • MetricName (string) --

            The name of the metric.

          • MetricDimensions (dict) --

            The metric dimension. This is a name/value pair that is part of the identity of a metric.

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

          • 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 service or quota.
            • DEPENDENCY_THROTTLING_ERROR - The service is throttling Service Quotas.
            • DEPENDENCY_SERVICE_ERROR - The service is not available.
            • SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.
          • ErrorMessage (string) --

            The error message.

Exceptions

list_services(**kwargs)

Lists the names and codes for the services integrated with Service Quotas.

See also: AWS API Documentation

Request Syntax

response = client.list_services(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- The token for the next page of results.
  • MaxResults (integer) -- The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.
Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    • Services (list) --

      Information about the services.

      • (dict) --

        Information about a service.

        • ServiceCode (string) --

          The service identifier.

        • ServiceName (string) --

          The service name.

Exceptions

list_tags_for_resource(**kwargs)

Returns a list of the tags assigned to the specified applied quota.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceARN='string'
)
Parameters
ResourceARN (string) --

[REQUIRED]

The Amazon Resource Name (ARN) for the applied quota for which you want to list tags. You can get this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.

Return type
dict
Returns
Response Syntax
{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • Tags (list) --

      A complex data type that contains zero or more tag elements.

      • (dict) --

        A complex data type that contains a tag key and tag value.

        • Key (string) --

          A string that contains a tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

        • Value (string) --

          A string that contains an optional tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

Exceptions

put_service_quota_increase_request_into_template(**kwargs)

Adds a quota increase request to your quota request template.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The quota identifier.

  • ServiceCode (string) --

    [REQUIRED]

    The service identifier.

  • AwsRegion (string) --

    [REQUIRED]

    The AWS Region.

  • DesiredValue (float) --

    [REQUIRED]

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

      Information about the quota increase request.

      • ServiceCode (string) --

        The service identifier.

      • ServiceName (string) --

        The service name.

      • QuotaCode (string) --

        The quota identifier.

      • QuotaName (string) --

        The quota name.

      • DesiredValue (float) --

        The new, increased value of the quota.

      • AwsRegion (string) --

        The AWS Region.

      • Unit (string) --

        The unit of measurement.

      • GlobalQuota (boolean) --

        Indicates whether the quota is global.

Exceptions

request_service_quota_increase(**kwargs)

Submits a quota increase request for the specified quota.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The service identifier.

  • QuotaCode (string) --

    [REQUIRED]

    The quota identifier.

  • DesiredValue (float) --

    [REQUIRED]

    The new, increased value for the quota.

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

      Information about the quota increase request.

      • Id (string) --

        The unique identifier.

      • CaseId (string) --

        The case ID.

      • ServiceCode (string) --

        The service identifier.

      • ServiceName (string) --

        The service name.

      • QuotaCode (string) --

        The quota identifier.

      • QuotaName (string) --

        The quota name.

      • DesiredValue (float) --

        The new, increased value for the quota.

      • Status (string) --

        The state of the quota increase request.

      • Created (datetime) --

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

      • LastUpdated (datetime) --

        The date and time of the most recent change.

      • Requester (string) --

        The IAM identity of the requester.

      • QuotaArn (string) --

        The Amazon Resource Name (ARN) of the quota.

      • GlobalQuota (boolean) --

        Indicates whether the quota is global.

      • Unit (string) --

        The unit of measurement.

Exceptions

tag_resource(**kwargs)

Adds tags to the specified applied quota. You can include one or more tags to add to the quota.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceARN (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) for the applied quota. You can get this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.

  • Tags (list) --

    [REQUIRED]

    The tags that you want to add to the resource.

    • (dict) --

      A complex data type that contains a tag key and tag value.

      • Key (string) -- [REQUIRED]

        A string that contains a tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

      • Value (string) -- [REQUIRED]

        A string that contains an optional tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes tags from the specified applied quota. You can specify one or more tags to remove.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceARN='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceARN (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) for the applied quota that you want to untag. You can get this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.

  • TagKeys (list) --

    [REQUIRED]

    The keys of the tags that you want to remove from the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

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.

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.

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

The resource is in an invalid state.

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

    The resource is in an invalid state.

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

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.

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

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.

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

The specified tag is a reserved word and cannot be used.

Example

try:
  ...
except client.exceptions.TagPolicyViolationException 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 tag is a reserved word and cannot be used.

    • 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 this AWS Region.

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 this AWS Region.

    • 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.
class ServiceQuotas.Client.exceptions.TooManyTagsException

You've exceeded the number of tags allowed for a resource. For more information, see Tag restrictions in the Service Quotas User Guide .

Example

try:
  ...
except client.exceptions.TooManyTagsException 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've exceeded the number of tags allowed for a resource. For more information, see Tag restrictions in the Service Quotas User Guide .

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

    The service identifier.

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

      Information about the quotas.

      • (dict) --

        Information about a quota.

        • ServiceCode (string) --

          The service identifier.

        • ServiceName (string) --

          The service name.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the quota.

        • QuotaCode (string) --

          The quota identifier.

        • QuotaName (string) --

          The quota name.

        • Value (float) --

          The quota value.

        • Unit (string) --

          The unit of measurement.

        • Adjustable (boolean) --

          Indicates whether the quota value can be increased.

        • GlobalQuota (boolean) --

          Indicates whether the quota is global.

        • UsageMetric (dict) --

          Information about the measurement.

          • MetricNamespace (string) --

            The namespace of the metric.

          • MetricName (string) --

            The name of the metric.

          • MetricDimensions (dict) --

            The metric dimension. This is a name/value pair that is part of the identity of a metric.

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

          • 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 service or quota.
            • DEPENDENCY_THROTTLING_ERROR - The service is throttling Service Quotas.
            • DEPENDENCY_SERVICE_ERROR - The service is not available.
            • SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.
          • ErrorMessage (string) --

            The error message.

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) -- The service identifier.
  • Status (string) -- The status 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) --

      Information about the quota increase requests.

      • (dict) --

        Information about a quota increase request.

        • Id (string) --

          The unique identifier.

        • CaseId (string) --

          The case ID.

        • ServiceCode (string) --

          The service identifier.

        • ServiceName (string) --

          The service name.

        • QuotaCode (string) --

          The quota identifier.

        • QuotaName (string) --

          The quota name.

        • DesiredValue (float) --

          The new, increased value for the quota.

        • Status (string) --

          The state of the quota increase request.

        • Created (datetime) --

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

        • LastUpdated (datetime) --

          The date and time of the most recent change.

        • Requester (string) --

          The IAM identity of the requester.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the quota.

        • GlobalQuota (boolean) --

          Indicates whether the quota is global.

        • Unit (string) --

          The unit of measurement.

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]

    The service identifier.

  • QuotaCode (string) --

    [REQUIRED]

    The quota identifier.

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

      Information about the quota increase requests.

      • (dict) --

        Information about a quota increase request.

        • Id (string) --

          The unique identifier.

        • CaseId (string) --

          The case ID.

        • ServiceCode (string) --

          The service identifier.

        • ServiceName (string) --

          The service name.

        • QuotaCode (string) --

          The quota identifier.

        • QuotaName (string) --

          The quota name.

        • DesiredValue (float) --

          The new, increased value for the quota.

        • Status (string) --

          The state of the quota increase request.

        • Created (datetime) --

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

        • LastUpdated (datetime) --

          The date and time of the most recent change.

        • Requester (string) --

          The IAM identity of the requester.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the quota.

        • GlobalQuota (boolean) --

          Indicates whether the quota is global.

        • Unit (string) --

          The unit of measurement.

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 service identifier.
  • AwsRegion (string) -- The AWS Region.
  • 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) --

      Information about the quota increase requests.

      • (dict) --

        Information about a quota increase request.

        • ServiceCode (string) --

          The service identifier.

        • ServiceName (string) --

          The service name.

        • QuotaCode (string) --

          The quota identifier.

        • QuotaName (string) --

          The quota name.

        • DesiredValue (float) --

          The new, increased value of the quota.

        • AwsRegion (string) --

          The AWS Region.

        • Unit (string) --

          The unit of measurement.

        • GlobalQuota (boolean) --

          Indicates whether the quota is global.

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 service identifier.

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

      Information about the quotas.

      • (dict) --

        Information about a quota.

        • ServiceCode (string) --

          The service identifier.

        • ServiceName (string) --

          The service name.

        • QuotaArn (string) --

          The Amazon Resource Name (ARN) of the quota.

        • QuotaCode (string) --

          The quota identifier.

        • QuotaName (string) --

          The quota name.

        • Value (float) --

          The quota value.

        • Unit (string) --

          The unit of measurement.

        • Adjustable (boolean) --

          Indicates whether the quota value can be increased.

        • GlobalQuota (boolean) --

          Indicates whether the quota is global.

        • UsageMetric (dict) --

          Information about the measurement.

          • MetricNamespace (string) --

            The namespace of the metric.

          • MetricName (string) --

            The name of the metric.

          • MetricDimensions (dict) --

            The metric dimension. This is a name/value pair that is part of the identity of a metric.

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

          • 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 service or quota.
            • DEPENDENCY_THROTTLING_ERROR - The service is throttling Service Quotas.
            • DEPENDENCY_SERVICE_ERROR - The service is not available.
            • SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.
          • ErrorMessage (string) --

            The error message.

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

      Information about the services.

      • (dict) --

        Information about a service.

        • ServiceCode (string) --

          The service identifier.

        • ServiceName (string) --

          The service name.