GetServiceQuota
Retrieves the applied quota value for the specified account-level or resource-level 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.
Related Actions
Request Syntax
{
"ContextId": "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.
- ContextId
-
Specifies the resource with an Amazon Resource Name (ARN).
Type: String
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: Yes
- 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
{
"Quota": {
"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.
- Quota
-
Information about the quota.
Type: ServiceQuota object
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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: