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

Table Of Contents

ListServiceQuotas¶