codegen-resources.service-2.json Maven / Gradle / Ivy
Show all versions of servicequotas Show documentation
{
"version":"2.0",
"metadata":{
"apiVersion":"2019-06-24",
"endpointPrefix":"servicequotas",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Service Quotas",
"serviceId":"Service Quotas",
"signatureVersion":"v4",
"targetPrefix":"ServiceQuotasV20190624",
"uid":"service-quotas-2019-06-24"
},
"operations":{
"AssociateServiceQuotaTemplate":{
"name":"AssociateServiceQuotaTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateServiceQuotaTemplateRequest"},
"output":{"shape":"AssociateServiceQuotaTemplateResponse"},
"errors":[
{"shape":"DependencyAccessDeniedException"},
{"shape":"AccessDeniedException"},
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"},
{"shape":"AWSServiceAccessNotEnabledException"},
{"shape":"OrganizationNotInAllFeaturesModeException"},
{"shape":"TemplatesNotAvailableInRegionException"},
{"shape":"NoAvailableOrganizationException"}
],
"documentation":"Associates the Service Quotas template with your organization so that when new accounts are created in your organization, the template submits increase requests for the specified service quotas. Use the Service Quotas template to request an increase for any adjustable quota value. After you define the Service Quotas template, use this operation to associate, or enable, the template.
"
},
"DeleteServiceQuotaIncreaseRequestFromTemplate":{
"name":"DeleteServiceQuotaIncreaseRequestFromTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteServiceQuotaIncreaseRequestFromTemplateRequest"},
"output":{"shape":"DeleteServiceQuotaIncreaseRequestFromTemplateResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ServiceException"},
{"shape":"DependencyAccessDeniedException"},
{"shape":"TooManyRequestsException"},
{"shape":"NoSuchResourceException"},
{"shape":"IllegalArgumentException"},
{"shape":"AWSServiceAccessNotEnabledException"},
{"shape":"TemplatesNotAvailableInRegionException"},
{"shape":"NoAvailableOrganizationException"}
],
"documentation":"Removes a service quota increase request from the Service Quotas template.
"
},
"DisassociateServiceQuotaTemplate":{
"name":"DisassociateServiceQuotaTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateServiceQuotaTemplateRequest"},
"output":{"shape":"DisassociateServiceQuotaTemplateResponse"},
"errors":[
{"shape":"DependencyAccessDeniedException"},
{"shape":"ServiceQuotaTemplateNotInUseException"},
{"shape":"AccessDeniedException"},
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"},
{"shape":"AWSServiceAccessNotEnabledException"},
{"shape":"TemplatesNotAvailableInRegionException"},
{"shape":"NoAvailableOrganizationException"}
],
"documentation":"Disables the Service Quotas template. Once the template is disabled, it does not request quota increases for new accounts in your organization. Disabling the quota template does not apply the quota increase requests from the template.
Related operations
-
To enable the quota template, call AssociateServiceQuotaTemplate.
-
To delete a specific service quota from the template, use DeleteServiceQuotaIncreaseRequestFromTemplate.
"
},
"GetAWSDefaultServiceQuota":{
"name":"GetAWSDefaultServiceQuota",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetAWSDefaultServiceQuotaRequest"},
"output":{"shape":"GetAWSDefaultServiceQuotaResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"NoSuchResourceException"},
{"shape":"IllegalArgumentException"},
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"Retrieves the default service quotas values. The Value returned for each quota is the AWS default value, even if the quotas have been increased..
"
},
"GetAssociationForServiceQuotaTemplate":{
"name":"GetAssociationForServiceQuotaTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetAssociationForServiceQuotaTemplateRequest"},
"output":{"shape":"GetAssociationForServiceQuotaTemplateResponse"},
"errors":[
{"shape":"DependencyAccessDeniedException"},
{"shape":"ServiceQuotaTemplateNotInUseException"},
{"shape":"AccessDeniedException"},
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"},
{"shape":"AWSServiceAccessNotEnabledException"},
{"shape":"TemplatesNotAvailableInRegionException"},
{"shape":"NoAvailableOrganizationException"}
],
"documentation":"Retrieves the ServiceQuotaTemplateAssociationStatus value from the service. Use this action to determine if the Service Quota template is associated, or enabled.
"
},
"GetRequestedServiceQuotaChange":{
"name":"GetRequestedServiceQuotaChange",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetRequestedServiceQuotaChangeRequest"},
"output":{"shape":"GetRequestedServiceQuotaChangeResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"NoSuchResourceException"},
{"shape":"IllegalArgumentException"},
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"Retrieves the details for a particular increase request.
"
},
"GetServiceQuota":{
"name":"GetServiceQuota",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetServiceQuotaRequest"},
"output":{"shape":"GetServiceQuotaResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"NoSuchResourceException"},
{"shape":"IllegalArgumentException"},
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"Returns the details for the specified service quota. This operation provides a different Value than the GetAWSDefaultServiceQuota operation. This operation returns the applied value for each quota. GetAWSDefaultServiceQuota returns the default AWS value for each quota.
"
},
"GetServiceQuotaIncreaseRequestFromTemplate":{
"name":"GetServiceQuotaIncreaseRequestFromTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetServiceQuotaIncreaseRequestFromTemplateRequest"},
"output":{"shape":"GetServiceQuotaIncreaseRequestFromTemplateResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"DependencyAccessDeniedException"},
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"},
{"shape":"NoSuchResourceException"},
{"shape":"IllegalArgumentException"},
{"shape":"AWSServiceAccessNotEnabledException"},
{"shape":"TemplatesNotAvailableInRegionException"},
{"shape":"NoAvailableOrganizationException"}
],
"documentation":"Returns the details of the service quota increase request in your template.
"
},
"ListAWSDefaultServiceQuotas":{
"name":"ListAWSDefaultServiceQuotas",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListAWSDefaultServiceQuotasRequest"},
"output":{"shape":"ListAWSDefaultServiceQuotasResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"NoSuchResourceException"},
{"shape":"IllegalArgumentException"},
{"shape":"InvalidPaginationTokenException"},
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"Lists all default service quotas for the specified AWS service or all AWS services. ListAWSDefaultServiceQuotas is similar to ListServiceQuotas except for the Value object. The Value object returned by ListAWSDefaultServiceQuotas is the default value assigned by AWS. This request returns a list of all service quotas for the specified service. The listing of each you'll see the default values are the values that AWS provides for the quotas.
Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.
"
},
"ListRequestedServiceQuotaChangeHistory":{
"name":"ListRequestedServiceQuotaChangeHistory",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListRequestedServiceQuotaChangeHistoryRequest"},
"output":{"shape":"ListRequestedServiceQuotaChangeHistoryResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"NoSuchResourceException"},
{"shape":"IllegalArgumentException"},
{"shape":"InvalidPaginationTokenException"},
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"Requests a list of the changes to quotas for a service.
"
},
"ListRequestedServiceQuotaChangeHistoryByQuota":{
"name":"ListRequestedServiceQuotaChangeHistoryByQuota",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListRequestedServiceQuotaChangeHistoryByQuotaRequest"},
"output":{"shape":"ListRequestedServiceQuotaChangeHistoryByQuotaResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"NoSuchResourceException"},
{"shape":"IllegalArgumentException"},
{"shape":"InvalidPaginationTokenException"},
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"Requests a list of the changes to specific service quotas. This command provides additional granularity over the ListRequestedServiceQuotaChangeHistory command. Once a quota change request has reached CASE_CLOSED, APPROVED, or DENIED, the history has been kept for 90 days.
"
},
"ListServiceQuotaIncreaseRequestsInTemplate":{
"name":"ListServiceQuotaIncreaseRequestsInTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListServiceQuotaIncreaseRequestsInTemplateRequest"},
"output":{"shape":"ListServiceQuotaIncreaseRequestsInTemplateResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"DependencyAccessDeniedException"},
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"},
{"shape":"IllegalArgumentException"},
{"shape":"AWSServiceAccessNotEnabledException"},
{"shape":"TemplatesNotAvailableInRegionException"},
{"shape":"NoAvailableOrganizationException"}
],
"documentation":"Returns a list of the quota increase requests in the template.
"
},
"ListServiceQuotas":{
"name":"ListServiceQuotas",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListServiceQuotasRequest"},
"output":{"shape":"ListServiceQuotasResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"NoSuchResourceException"},
{"shape":"IllegalArgumentException"},
{"shape":"InvalidPaginationTokenException"},
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"Lists all service quotas for the specified AWS service. This request returns a list of the service quotas for the specified service. you'll see the default values are the values that AWS provides for the quotas.
Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.
"
},
"ListServices":{
"name":"ListServices",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListServicesRequest"},
"output":{"shape":"ListServicesResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"IllegalArgumentException"},
{"shape":"InvalidPaginationTokenException"},
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"Lists the AWS services available in Service Quotas. Not all AWS services are available in Service Quotas. To list the see the list of the service quotas for a specific service, use ListServiceQuotas.
"
},
"PutServiceQuotaIncreaseRequestIntoTemplate":{
"name":"PutServiceQuotaIncreaseRequestIntoTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutServiceQuotaIncreaseRequestIntoTemplateRequest"},
"output":{"shape":"PutServiceQuotaIncreaseRequestIntoTemplateResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"DependencyAccessDeniedException"},
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"},
{"shape":"IllegalArgumentException"},
{"shape":"QuotaExceededException"},
{"shape":"NoSuchResourceException"},
{"shape":"AWSServiceAccessNotEnabledException"},
{"shape":"TemplatesNotAvailableInRegionException"},
{"shape":"NoAvailableOrganizationException"}
],
"documentation":"Defines and adds a quota to the service quota template. To add a quota to the template, you must provide the ServiceCode, QuotaCode, AwsRegion, and DesiredValue. Once you add a quota to the template, use ListServiceQuotaIncreaseRequestsInTemplate to see the list of quotas in the template.
"
},
"RequestServiceQuotaIncrease":{
"name":"RequestServiceQuotaIncrease",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RequestServiceQuotaIncreaseRequest"},
"output":{"shape":"RequestServiceQuotaIncreaseResponse"},
"errors":[
{"shape":"DependencyAccessDeniedException"},
{"shape":"QuotaExceededException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"AccessDeniedException"},
{"shape":"NoSuchResourceException"},
{"shape":"IllegalArgumentException"},
{"shape":"InvalidResourceStateException"},
{"shape":"ServiceException"},
{"shape":"TooManyRequestsException"}
],
"documentation":"Retrieves the details of a service quota increase request. The response to this command provides the details in the RequestedServiceQuotaChange object.
"
}
},
"shapes":{
"AWSServiceAccessNotEnabledException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"The action you attempted is not allowed unless Service Access with Service Quotas is enabled in your organization. To enable, call AssociateServiceQuotaTemplate.
",
"exception":true
},
"AccessDeniedException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"You do not have sufficient access to perform this action.
",
"exception":true
},
"AssociateServiceQuotaTemplateRequest":{
"type":"structure",
"members":{
}
},
"AssociateServiceQuotaTemplateResponse":{
"type":"structure",
"members":{
}
},
"AwsRegion":{
"type":"string",
"max":64,
"min":1,
"pattern":"[a-zA-Z][a-zA-Z0-9-]{1,128}"
},
"CustomerServiceEngagementId":{"type":"string"},
"DateTime":{"type":"timestamp"},
"DeleteServiceQuotaIncreaseRequestFromTemplateRequest":{
"type":"structure",
"required":[
"ServiceCode",
"QuotaCode",
"AwsRegion"
],
"members":{
"ServiceCode":{
"shape":"ServiceCode",
"documentation":"Specifies the code for the service that you want to delete.
"
},
"QuotaCode":{
"shape":"QuotaCode",
"documentation":"Specifies the code for the quota that you want to delete.
"
},
"AwsRegion":{
"shape":"AwsRegion",
"documentation":"Specifies the AWS Region for the quota that you want to delete.
"
}
}
},
"DeleteServiceQuotaIncreaseRequestFromTemplateResponse":{
"type":"structure",
"members":{
}
},
"DependencyAccessDeniedException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"You can't perform this action because a dependency does not have access.
",
"exception":true
},
"DisassociateServiceQuotaTemplateRequest":{
"type":"structure",
"members":{
}
},
"DisassociateServiceQuotaTemplateResponse":{
"type":"structure",
"members":{
}
},
"ErrorCode":{
"type":"string",
"enum":[
"DEPENDENCY_ACCESS_DENIED_ERROR",
"DEPENDENCY_THROTTLING_ERROR",
"DEPENDENCY_SERVICE_ERROR",
"SERVICE_QUOTA_NOT_AVAILABLE_ERROR"
]
},
"ErrorMessage":{"type":"string"},
"ErrorReason":{
"type":"structure",
"members":{
"ErrorCode":{
"shape":"ErrorCode",
"documentation":"Service Quotas returns the following error values.
DEPENDENCY_ACCESS_DENIED_ERROR is returned when the caller does not have permission to call the service or service quota. To resolve the error, you need permission to access the service or service quota.
DEPENDENCY_THROTTLING_ERROR is returned when the service being called is throttling Service Quotas.
DEPENDENCY_SERVICE_ERROR is returned when the service being called has availability issues.
SERVICE_QUOTA_NOT_AVAILABLE_ERROR is returned when there was an error in Service Quotas.
"
},
"ErrorMessage":{
"shape":"ErrorMessage",
"documentation":"The error message that provides more detail.
"
}
},
"documentation":"Returns an error that explains why the action did not succeed.
"
},
"ExceptionMessage":{"type":"string"},
"GetAWSDefaultServiceQuotaRequest":{
"type":"structure",
"required":[
"ServiceCode",
"QuotaCode"
],
"members":{
"ServiceCode":{
"shape":"ServiceCode",
"documentation":"Specifies the service that you want to use.
"
},
"QuotaCode":{
"shape":"QuotaCode",
"documentation":"Identifies the service quota you want to select.
"
}
}
},
"GetAWSDefaultServiceQuotaResponse":{
"type":"structure",
"members":{
"Quota":{
"shape":"ServiceQuota",
"documentation":"Returns the ServiceQuota object which contains all values for a quota.
"
}
}
},
"GetAssociationForServiceQuotaTemplateRequest":{
"type":"structure",
"members":{
}
},
"GetAssociationForServiceQuotaTemplateResponse":{
"type":"structure",
"members":{
"ServiceQuotaTemplateAssociationStatus":{
"shape":"ServiceQuotaTemplateAssociationStatus",
"documentation":"Specifies whether the template is ASSOCIATED or DISASSOCIATED. If the template is ASSOCIATED, then it requests service quota increases for all new accounts created in your organization.
"
}
}
},
"GetRequestedServiceQuotaChangeRequest":{
"type":"structure",
"required":["RequestId"],
"members":{
"RequestId":{
"shape":"RequestId",
"documentation":"Identifies the quota increase request.
"
}
}
},
"GetRequestedServiceQuotaChangeResponse":{
"type":"structure",
"members":{
"RequestedQuota":{
"shape":"RequestedServiceQuotaChange",
"documentation":"Returns the RequestedServiceQuotaChange object for the specific increase request.
"
}
}
},
"GetServiceQuotaIncreaseRequestFromTemplateRequest":{
"type":"structure",
"required":[
"ServiceCode",
"QuotaCode",
"AwsRegion"
],
"members":{
"ServiceCode":{
"shape":"ServiceCode",
"documentation":"Specifies the service that you want to use.
"
},
"QuotaCode":{
"shape":"QuotaCode",
"documentation":"Specifies the quota you want.
"
},
"AwsRegion":{
"shape":"AwsRegion",
"documentation":"Specifies the AWS Region for the quota that you want to use.
"
}
}
},
"GetServiceQuotaIncreaseRequestFromTemplateResponse":{
"type":"structure",
"members":{
"ServiceQuotaIncreaseRequestInTemplate":{
"shape":"ServiceQuotaIncreaseRequestInTemplate",
"documentation":"This object contains the details about the quota increase request.
"
}
}
},
"GetServiceQuotaRequest":{
"type":"structure",
"required":[
"ServiceCode",
"QuotaCode"
],
"members":{
"ServiceCode":{
"shape":"ServiceCode",
"documentation":"Specifies the service that you want to use.
"
},
"QuotaCode":{
"shape":"QuotaCode",
"documentation":"Identifies the service quota you want to select.
"
}
}
},
"GetServiceQuotaResponse":{
"type":"structure",
"members":{
"Quota":{
"shape":"ServiceQuota",
"documentation":"Returns the ServiceQuota object which contains all values for a quota.
"
}
}
},
"GlobalQuota":{"type":"boolean"},
"IllegalArgumentException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"Invalid input was provided.
",
"exception":true
},
"InvalidPaginationTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"Invalid input was provided.
",
"exception":true
},
"InvalidResourceStateException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"Invalid input was provided for the .
",
"exception":true
},
"ListAWSDefaultServiceQuotasRequest":{
"type":"structure",
"required":["ServiceCode"],
"members":{
"ServiceCode":{
"shape":"ServiceCode",
"documentation":"Specifies the service that you want to use.
"
},
"NextToken":{
"shape":"NextToken",
"documentation":"(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
"
}
}
},
"ListAWSDefaultServiceQuotasResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
"
},
"Quotas":{
"shape":"ServiceQuotaListDefinition",
"documentation":"A list of the quotas in the account with the AWS default values.
"
}
}
},
"ListRequestedServiceQuotaChangeHistoryByQuotaRequest":{
"type":"structure",
"required":[
"ServiceCode",
"QuotaCode"
],
"members":{
"ServiceCode":{
"shape":"ServiceCode",
"documentation":"Specifies the service that you want to use.
"
},
"QuotaCode":{
"shape":"QuotaCode",
"documentation":"Specifies the service quota that you want to use
"
},
"Status":{
"shape":"RequestStatus",
"documentation":"Specifies the status value of the quota increase request.
"
},
"NextToken":{
"shape":"NextToken",
"documentation":"(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
"
}
}
},
"ListRequestedServiceQuotaChangeHistoryByQuotaResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).
"
},
"RequestedQuotas":{
"shape":"RequestedServiceQuotaChangeHistoryListDefinition",
"documentation":"Returns a list of service quota requests.
"
}
}
},
"ListRequestedServiceQuotaChangeHistoryRequest":{
"type":"structure",
"members":{
"ServiceCode":{
"shape":"ServiceCode",
"documentation":"Specifies the service that you want to use.
"
},
"Status":{
"shape":"RequestStatus",
"documentation":"Specifies the status value of the quota increase request.
"
},
"NextToken":{
"shape":"NextToken",
"documentation":"(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
"
}
}
},
"ListRequestedServiceQuotaChangeHistoryResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).
"
},
"RequestedQuotas":{
"shape":"RequestedServiceQuotaChangeHistoryListDefinition",
"documentation":"Returns a list of service quota requests.
"
}
}
},
"ListServiceQuotaIncreaseRequestsInTemplateRequest":{
"type":"structure",
"members":{
"ServiceCode":{
"shape":"ServiceCode",
"documentation":"The identifier for a service. When performing an operation, use the ServiceCode to specify a particular service.
"
},
"AwsRegion":{
"shape":"AwsRegion",
"documentation":"Specifies the AWS Region for the quota that you want to use.
"
},
"NextToken":{
"shape":"NextToken",
"documentation":"(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
"
}
}
},
"ListServiceQuotaIncreaseRequestsInTemplateResponse":{
"type":"structure",
"members":{
"ServiceQuotaIncreaseRequestInTemplateList":{
"shape":"ServiceQuotaIncreaseRequestInTemplateList",
"documentation":"Returns the list of values of the quota increase request in the template.
"
},
"NextToken":{
"shape":"NextToken",
"documentation":"If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).
"
}
}
},
"ListServiceQuotasRequest":{
"type":"structure",
"required":["ServiceCode"],
"members":{
"ServiceCode":{
"shape":"ServiceCode",
"documentation":"The identifier for a service. When performing an operation, use the ServiceCode to specify a particular service.
"
},
"NextToken":{
"shape":"NextToken",
"documentation":"(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
"
}
}
},
"ListServiceQuotasResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).
"
},
"Quotas":{
"shape":"ServiceQuotaListDefinition",
"documentation":"The response information for a quota lists all attribute information for the quota.
"
}
}
},
"ListServicesRequest":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.
"
}
}
},
"ListServicesResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).
"
},
"Services":{
"shape":"ServiceInfoListDefinition",
"documentation":"Returns a list of services.
"
}
}
},
"MaxResults":{
"type":"integer",
"max":100,
"min":1
},
"MetricDimensionName":{"type":"string"},
"MetricDimensionValue":{"type":"string"},
"MetricDimensionsMapDefinition":{
"type":"map",
"key":{"shape":"MetricDimensionName"},
"value":{"shape":"MetricDimensionValue"},
"max":10
},
"MetricInfo":{
"type":"structure",
"members":{
"MetricNamespace":{
"shape":"QuotaMetricNamespace",
"documentation":"The namespace of the metric. The namespace is a container for CloudWatch metrics. You can specify a name for the namespace when you create a metric.
"
},
"MetricName":{
"shape":"QuotaMetricName",
"documentation":"The name of the CloudWatch metric that measures usage of a service quota. This is a required field.
"
},
"MetricDimensions":{
"shape":"MetricDimensionsMapDefinition",
"documentation":"A dimension is a name/value pair that is part of the identity of a metric. Every metric has specific characteristics that describe it, and you can think of dimensions as categories for those characteristics. These dimensions are part of the CloudWatch Metric Identity that measures usage against a particular service quota.
"
},
"MetricStatisticRecommendation":{
"shape":"Statistic",
"documentation":"Statistics are metric data aggregations over specified periods of time. This is the recommended statistic to use when comparing usage in the CloudWatch Metric against your Service Quota.
"
}
},
"documentation":"A structure that uses CloudWatch metrics to gather data about the service quota.
"
},
"NextToken":{
"type":"string",
"max":2048,
"pattern":"^[a-zA-Z0-9/+]*={0,2}$"
},
"NoAvailableOrganizationException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"The account making this call is not a member of an organization.
",
"exception":true
},
"NoSuchResourceException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"The specified resource does not exist.
",
"exception":true
},
"OrganizationNotInAllFeaturesModeException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"The organization that your account belongs to, is not in All Features mode. To enable all features mode, see EnableAllFeatures.
",
"exception":true
},
"PeriodUnit":{
"type":"string",
"enum":[
"MICROSECOND",
"MILLISECOND",
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"WEEK"
]
},
"PeriodValue":{"type":"integer"},
"PutServiceQuotaIncreaseRequestIntoTemplateRequest":{
"type":"structure",
"required":[
"QuotaCode",
"ServiceCode",
"AwsRegion",
"DesiredValue"
],
"members":{
"QuotaCode":{
"shape":"QuotaCode",
"documentation":"Specifies the service quota that you want to use.
"
},
"ServiceCode":{
"shape":"ServiceCode",
"documentation":"Specifies the service that you want to use.
"
},
"AwsRegion":{
"shape":"AwsRegion",
"documentation":"Specifies the AWS Region for the quota.
"
},
"DesiredValue":{
"shape":"QuotaValue",
"documentation":"Specifies the new, increased value for the quota.
"
}
}
},
"PutServiceQuotaIncreaseRequestIntoTemplateResponse":{
"type":"structure",
"members":{
"ServiceQuotaIncreaseRequestInTemplate":{
"shape":"ServiceQuotaIncreaseRequestInTemplate",
"documentation":"A structure that contains information about one service quota increase request.
"
}
}
},
"QuotaAdjustable":{"type":"boolean"},
"QuotaArn":{"type":"string"},
"QuotaCode":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z][a-zA-Z0-9-]{1,128}"
},
"QuotaExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
",
"exception":true
},
"QuotaMetricName":{"type":"string"},
"QuotaMetricNamespace":{"type":"string"},
"QuotaName":{"type":"string"},
"QuotaPeriod":{
"type":"structure",
"members":{
"PeriodValue":{
"shape":"PeriodValue",
"documentation":"The value of a period.
"
},
"PeriodUnit":{
"shape":"PeriodUnit",
"documentation":"The time unit of a period.
"
}
},
"documentation":"A structure that contains information about the quota period.
"
},
"QuotaUnit":{"type":"string"},
"QuotaValue":{
"type":"double",
"max":10000000000,
"min":0
},
"RequestId":{
"type":"string",
"max":128,
"min":1,
"pattern":"[0-9a-zA-Z][a-zA-Z0-9-]{1,128}"
},
"RequestServiceQuotaIncreaseRequest":{
"type":"structure",
"required":[
"ServiceCode",
"QuotaCode",
"DesiredValue"
],
"members":{
"ServiceCode":{
"shape":"ServiceCode",
"documentation":"Specifies the service that you want to use.
"
},
"QuotaCode":{
"shape":"QuotaCode",
"documentation":"Specifies the service quota that you want to use.
"
},
"DesiredValue":{
"shape":"QuotaValue",
"documentation":"Specifies the value submitted in the service quota increase request.
"
}
}
},
"RequestServiceQuotaIncreaseResponse":{
"type":"structure",
"members":{
"RequestedQuota":{
"shape":"RequestedServiceQuotaChange",
"documentation":"Returns a list of service quota requests.
"
}
}
},
"RequestStatus":{
"type":"string",
"enum":[
"PENDING",
"CASE_OPENED",
"APPROVED",
"DENIED",
"CASE_CLOSED"
]
},
"RequestedServiceQuotaChange":{
"type":"structure",
"members":{
"Id":{
"shape":"RequestId",
"documentation":"The unique identifier of a requested service quota change.
"
},
"CaseId":{
"shape":"CustomerServiceEngagementId",
"documentation":"The case Id for the service quota increase request.
"
},
"ServiceCode":{
"shape":"ServiceCode",
"documentation":"Specifies the service that you want to use.
"
},
"ServiceName":{
"shape":"ServiceName",
"documentation":"The name of the AWS service specified in the increase request.
"
},
"QuotaCode":{
"shape":"QuotaCode",
"documentation":"Specifies the service quota that you want to use.
"
},
"QuotaName":{
"shape":"QuotaName",
"documentation":"Name of the service quota.
"
},
"DesiredValue":{
"shape":"QuotaValue",
"documentation":"New increased value for the service quota.
"
},
"Status":{
"shape":"RequestStatus",
"documentation":"State of the service quota increase request.
"
},
"Created":{
"shape":"DateTime",
"documentation":"The date and time when the service quota increase request was received and the case Id was created.
"
},
"LastUpdated":{
"shape":"DateTime",
"documentation":"The date and time of the most recent change in the service quota increase request.
"
},
"Requester":{
"shape":"Requester",
"documentation":"The IAM identity who submitted the service quota increase request.
"
},
"QuotaArn":{
"shape":"QuotaArn",
"documentation":"The Amazon Resource Name (ARN) of the service quota.
"
},
"GlobalQuota":{
"shape":"GlobalQuota",
"documentation":"Identifies if the quota is global.
"
},
"Unit":{
"shape":"QuotaUnit",
"documentation":"Specifies the unit used for the quota.
"
}
},
"documentation":"A structure that contains information about a requested change for a quota.
"
},
"RequestedServiceQuotaChangeHistoryListDefinition":{
"type":"list",
"member":{"shape":"RequestedServiceQuotaChange"}
},
"Requester":{"type":"string"},
"ResourceAlreadyExistsException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"The specified resource already exists.
",
"exception":true
},
"ServiceCode":{
"type":"string",
"max":63,
"min":1,
"pattern":"[a-zA-Z][a-zA-Z0-9-]{1,63}"
},
"ServiceException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"Something went wrong.
",
"exception":true,
"fault":true
},
"ServiceInfo":{
"type":"structure",
"members":{
"ServiceCode":{
"shape":"ServiceCode",
"documentation":"Specifies the service that you want to use.
"
},
"ServiceName":{
"shape":"ServiceName",
"documentation":"The name of the AWS service specified in the increase request.
"
}
},
"documentation":"A structure that contains the ServiceName and ServiceCode. It does not include all details of the service quota. To get those values, use the ListServiceQuotas operation.
"
},
"ServiceInfoListDefinition":{
"type":"list",
"member":{"shape":"ServiceInfo"}
},
"ServiceName":{"type":"string"},
"ServiceQuota":{
"type":"structure",
"members":{
"ServiceCode":{
"shape":"ServiceCode",
"documentation":"Specifies the service that you want to use.
"
},
"ServiceName":{
"shape":"ServiceName",
"documentation":"The name of the AWS service specified in the increase request.
"
},
"QuotaArn":{
"shape":"QuotaArn",
"documentation":"The Amazon Resource Name (ARN) of the service quota.
"
},
"QuotaCode":{
"shape":"QuotaCode",
"documentation":"The code identifier for the service quota specified.
"
},
"QuotaName":{
"shape":"QuotaName",
"documentation":"The name identifier of the service quota.
"
},
"Value":{
"shape":"QuotaValue",
"documentation":"The value of service quota.
"
},
"Unit":{
"shape":"QuotaUnit",
"documentation":"The unit of measurement for the value of the service quota.
"
},
"Adjustable":{
"shape":"QuotaAdjustable",
"documentation":"Specifies if the quota value can be increased.
"
},
"GlobalQuota":{
"shape":"GlobalQuota",
"documentation":"Specifies if the quota is global.
"
},
"UsageMetric":{
"shape":"MetricInfo",
"documentation":"Specifies the details about the measurement.
"
},
"Period":{
"shape":"QuotaPeriod",
"documentation":"Identifies the unit and value of how time is measured.
"
},
"ErrorReason":{
"shape":"ErrorReason",
"documentation":"Specifies the ErrorCode and ErrorMessage when success isn't achieved.
"
}
},
"documentation":"A structure that contains the full set of details that define the service quota.
"
},
"ServiceQuotaIncreaseRequestInTemplate":{
"type":"structure",
"members":{
"ServiceCode":{
"shape":"ServiceCode",
"documentation":"The code identifier for the AWS service specified in the increase request.
"
},
"ServiceName":{
"shape":"ServiceName",
"documentation":"The name of the AWS service specified in the increase request.
"
},
"QuotaCode":{
"shape":"QuotaCode",
"documentation":"The code identifier for the service quota specified in the increase request.
"
},
"QuotaName":{
"shape":"QuotaName",
"documentation":"The name of the service quota in the increase request.
"
},
"DesiredValue":{
"shape":"QuotaValue",
"documentation":"Identifies the new, increased value of the service quota in the increase request.
"
},
"AwsRegion":{
"shape":"AwsRegion",
"documentation":"The AWS Region where the increase request occurs.
"
},
"Unit":{
"shape":"QuotaUnit",
"documentation":"The unit of measure for the increase request.
"
},
"GlobalQuota":{
"shape":"GlobalQuota",
"documentation":"Specifies if the quota is a global quota.
"
}
},
"documentation":"A structure that contains information about one service quota increase request.
"
},
"ServiceQuotaIncreaseRequestInTemplateList":{
"type":"list",
"member":{"shape":"ServiceQuotaIncreaseRequestInTemplate"}
},
"ServiceQuotaListDefinition":{
"type":"list",
"member":{"shape":"ServiceQuota"}
},
"ServiceQuotaTemplateAssociationStatus":{
"type":"string",
"enum":[
"ASSOCIATED",
"DISASSOCIATED"
]
},
"ServiceQuotaTemplateNotInUseException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"The quota request template is not associated with your organization.
To use the template, call AssociateServiceQuotaTemplate.
",
"exception":true
},
"Statistic":{
"type":"string",
"max":256,
"min":1,
"pattern":"(Sum|Maximum)"
},
"TemplatesNotAvailableInRegionException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"The Service Quotas template is not available in the Region where you are making the request. Please make the request in us-east-1.
",
"exception":true
},
"TooManyRequestsException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
",
"exception":true
}
},
"documentation":" Service Quotas is a web service that you can use to manage many of your AWS service quotas. Quotas, also referred to as limits, are the maximum values for a resource, item, or operation. This guide provide descriptions of the Service Quotas actions that you can call from an API. For the Service Quotas user guide, which explains how to use Service Quotas from the console, see What is Service Quotas.
AWS provides SDKs that consist of libraries and sample code for programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc...,). The SDKs provide a convenient way to create programmatic access to Service Quotas and AWS. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.
"
}