Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListServiceQuotas

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. Filter responses to return applied quota values at either the account level, resource level, or all levels.

Related Actions

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "QuotaAppliedAtLevel": "string",
   "QuotaCode": "string",
   "ServiceCode": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

Specifies the maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

Note

An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

Specifies a value for receiving additional results after you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^[a-zA-Z0-9/+]*={0,2}$

Required: No

QuotaAppliedAtLevel

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

Type: String

Valid Values: ACCOUNT | RESOURCE | ALL

Required: No

QuotaCode

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z][a-zA-Z0-9-]{1,128}

Required: No

ServiceCode

Specifies the service identifier. To find the service code value for an AWS service, use the ListServices operation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [a-zA-Z][a-zA-Z0-9-]{1,63}

Required: Yes

Response Syntax


{
   "NextToken": "string",
   "Quotas": [ 
      { 
         "Adjustable": boolean,
         "Description": "string",
         "ErrorReason": { 
            "ErrorCode": "string",
            "ErrorMessage": "string"
         },
         "GlobalQuota": boolean,
         "Period": { 
            "PeriodUnit": "string",
            "PeriodValue": number
         },
         "QuotaAppliedAtLevel": "string",
         "QuotaArn": "string",
         "QuotaCode": "string",
         "QuotaContext": { 
            "ContextId": "string",
            "ContextScope": "string",
            "ContextScopeType": "string"
         },
         "QuotaName": "string",
         "ServiceCode": "string",
         "ServiceName": "string",
         "Unit": "string",
         "UsageMetric": { 
            "MetricDimensions": { 
               "string" : "string" 
            },
            "MetricName": "string",
            "MetricNamespace": "string",
            "MetricStatisticRecommendation": "string"
         },
         "Value": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^[a-zA-Z0-9/+]*={0,2}$

Quotas

Information about the quotas.

Type: Array of ServiceQuota objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient permission to perform this action.

HTTP Status Code: 400

IllegalArgumentException

Invalid input was provided.

HTTP Status Code: 400

InvalidPaginationTokenException

Invalid input was provided.

HTTP Status Code: 400

NoSuchResourceException

The specified resource does not exist.

HTTP Status Code: 400

ServiceException

Something went wrong.

HTTP Status Code: 500

TooManyRequestsException

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

HTTP Status Code: 400