ServiceQuotas / Client / get_service_quota

get_service_quota

ServiceQuotas.Client.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',
    ContextId='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) –

  [REQUIRED]

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

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

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

Response Structure

• (dict) –

  • Quota (dict) –

    Information about the quota.

    • ServiceCode (string) –

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

    • ServiceName (string) –

      Specifies the service name.

    • QuotaArn (string) –

      The Amazon Resource Name (ARN) of the quota.

    • QuotaCode (string) –

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

    • QuotaName (string) –

      Specifies the quota name.

    • Value (float) –

      The quota value.

    • Unit (string) –

      The unit of measurement.

    • Adjustable (boolean) –

      Indicates whether the quota value can be increased.

    • GlobalQuota (boolean) –

      Indicates whether the quota is global.

    • UsageMetric (dict) –

      Information about the measurement.

      • MetricNamespace (string) –

        The namespace of the metric.

      • MetricName (string) –

        The name of the metric.

      • MetricDimensions (dict) –

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

        • (string) –

          • (string) –

      • MetricStatisticRecommendation (string) –

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

    • Period (dict) –

      The period of time.

      • PeriodValue (integer) –

        The value associated with the reported PeriodUnit.

      • PeriodUnit (string) –

        The time unit.

    • ErrorReason (dict) –

      The error code and error reason.

      • ErrorCode (string) –

        Service Quotas returns the following error values:

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

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

        • DEPENDENCY_SERVICE_ERROR - The Amazon Web Service is not available.

        • SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.

      • ErrorMessage (string) –

        The error message.

    • QuotaAppliedAtLevel (string) –

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

    • QuotaContext (dict) –

      The context for this service quota.

      • ContextScope (string) –

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

      • ContextScopeType (string) –

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

      • ContextId (string) –

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

Exceptions

• ServiceQuotas.Client.exceptions.AccessDeniedException

• ServiceQuotas.Client.exceptions.NoSuchResourceException

• ServiceQuotas.Client.exceptions.IllegalArgumentException

• ServiceQuotas.Client.exceptions.ServiceException

• ServiceQuotas.Client.exceptions.TooManyRequestsException