ServiceQuotas / Paginator / ListServiceQuotas

ListServiceQuotas

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',
    QuotaCode='string',
    QuotaAppliedAtLevel='ACCOUNT'|'RESOURCE'|'ALL',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ServiceCode (string) –

  [REQUIRED]

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

• QuotaCode (string) – Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.

• QuotaAppliedAtLevel (string) – Filters the response to return applied quota values for the ACCOUNT, RESOURCE, or ALL levels. ACCOUNT is the default.

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

Response Structure

• (dict) –

  • Quotas (list) –

    Information about the quotas.

    • (dict) –

      Information about a quota.

      • ServiceCode (string) –

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

      • ServiceName (string) –

        Specifies the service name.

      • QuotaArn (string) –

        The Amazon Resource Name (ARN) of the quota.

      • QuotaCode (string) –

        Specifies the quota identifier. To find the quota code for a specific quota, use the ListServiceQuotas operation, and look for the QuotaCode response in the output for the quota you want.

      • QuotaName (string) –

        Specifies the quota name.

      • Value (float) –

        The quota value.

      • Unit (string) –

        The unit of measurement.

      • Adjustable (boolean) –

        Indicates whether the quota value can be increased.

      • GlobalQuota (boolean) –

        Indicates whether the quota is global.

      • UsageMetric (dict) –

        Information about the measurement.

        • MetricNamespace (string) –

          The namespace of the metric.

        • MetricName (string) –

          The name of the metric.

        • MetricDimensions (dict) –

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

          • (string) –

            • (string) –

        • MetricStatisticRecommendation (string) –

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

      • Period (dict) –

        The period of time.

        • PeriodValue (integer) –

          The value associated with the reported PeriodUnit.

        • PeriodUnit (string) –

          The time unit.

      • ErrorReason (dict) –

        The error code and error reason.

        • ErrorCode (string) –

          Service Quotas returns the following error values:

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

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

          • DEPENDENCY_SERVICE_ERROR - The Amazon Web Services service is not available.

          • SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.

        • ErrorMessage (string) –

          The error message.

      • QuotaAppliedAtLevel (string) –

        Filters the response to return applied quota values for the ACCOUNT, RESOURCE, or ALL levels. ACCOUNT is the default.

      • QuotaContext (dict) –

        The context for this service quota.

        • ContextScope (string) –

          Specifies the scope to which the quota value is applied. If the scope is RESOURCE, the quota value is applied to each resource in the Amazon Web Services account. If the scope is ACCOUNT, the quota value is applied to the Amazon Web Services account.

        • ContextScopeType (string) –

          Specifies the resource type to which the quota can be applied.

        • ContextId (string) –

          Specifies the resource, or resources, to which the quota applies. The value for this field is either an Amazon Resource Name (ARN) or *. If the value is an ARN, the quota value applies to that resource. If the value is *, then the quota value applies to all resources listed in the ContextScopeType field. The quota value applies to all resources for which you haven’t previously applied a quota value, and any new resources you create in your Amazon Web Services account.

      • Description (string) –

        The quota description.