Service Quotas 2019-06-24
- Client: Aws\ServiceQuotas\ServiceQuotasClient
- Service ID: service-quotas
- Version: 2019-06-24
This page describes the parameters and results for the operations of the Service Quotas (2019-06-24), and shows how to use the Aws\ServiceQuotas\ServiceQuotasClient object to call the described operations. This documentation is specific to the 2019-06-24 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateServiceQuotaTemplate ( array $params = [] )
Associates your quota request template with your organization.
- DeleteServiceQuotaIncreaseRequestFromTemplate ( array $params = [] )
Deletes the quota increase request for the specified quota from your quota request template.
- DisassociateServiceQuotaTemplate ( array $params = [] )
Disables your quota request template.
- GetAWSDefaultServiceQuota ( array $params = [] )
Retrieves the default value for the specified quota.
- GetAssociationForServiceQuotaTemplate ( array $params = [] )
Retrieves the status of the association for the quota request template.
- GetRequestedServiceQuotaChange ( array $params = [] )
Retrieves information about the specified quota increase request.
- GetServiceQuota ( array $params = [] )
Retrieves the applied quota value for the specified quota.
- GetServiceQuotaIncreaseRequestFromTemplate ( array $params = [] )
Retrieves information about the specified quota increase request in your quota request template.
- ListAWSDefaultServiceQuotas ( array $params = [] )
Lists the default values for the quotas for the specified AWS service.
- ListRequestedServiceQuotaChangeHistory ( array $params = [] )
Retrieves the quota increase requests for the specified service.
- ListRequestedServiceQuotaChangeHistoryByQuota ( array $params = [] )
Retrieves the quota increase requests for the specified quota.
- ListServiceQuotaIncreaseRequestsInTemplate ( array $params = [] )
Lists the quota increase requests in the specified quota request template.
- ListServiceQuotas ( array $params = [] )
Lists the applied quota values for the specified AWS service.
- ListServices ( array $params = [] )
Lists the names and codes for the services integrated with Service Quotas.
- ListTagsForResource ( array $params = [] )
Returns a list of the tags assigned to the specified applied quota.
- PutServiceQuotaIncreaseRequestIntoTemplate ( array $params = [] )
Adds a quota increase request to your quota request template.
- RequestServiceQuotaIncrease ( array $params = [] )
Submits a quota increase request for the specified quota.
- TagResource ( array $params = [] )
Adds tags to the specified applied quota.
- UntagResource ( array $params = [] )
Removes tags from the specified applied quota.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AssociateServiceQuotaTemplate
$result = $client->associateServiceQuotaTemplate([/* ... */]); $promise = $client->associateServiceQuotaTemplateAsync([/* ... */]);
Associates your quota request template with your organization. When a new account is created in your organization, the quota increase requests in the template are automatically applied to the account. You can add a quota increase request for any adjustable quota to your template.
Parameter Syntax
$result = $client->associateServiceQuotaTemplate([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
DependencyAccessDeniedException:
You can't perform this action because a dependency does not have access.
-
You do not have sufficient permission to perform this action.
-
Something went wrong.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
-
AWSServiceAccessNotEnabledException:
The action you attempted is not allowed unless Service Access with Service Quotas is enabled in your organization.
-
OrganizationNotInAllFeaturesModeException:
The organization that your account belongs to is not in All Features mode.
-
TemplatesNotAvailableInRegionException:
The Service Quotas template is not available in this AWS Region.
-
NoAvailableOrganizationException:
The account making this call is not a member of an organization.
DeleteServiceQuotaIncreaseRequestFromTemplate
$result = $client->deleteServiceQuotaIncreaseRequestFromTemplate([/* ... */]); $promise = $client->deleteServiceQuotaIncreaseRequestFromTemplateAsync([/* ... */]);
Deletes the quota increase request for the specified quota from your quota request template.
Parameter Syntax
$result = $client->deleteServiceQuotaIncreaseRequestFromTemplate([
'AwsRegion' => '<string>', // REQUIRED
'QuotaCode' => '<string>', // REQUIRED
'ServiceCode' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
You do not have sufficient permission to perform this action.
-
Something went wrong.
-
DependencyAccessDeniedException:
You can't perform this action because a dependency does not have access.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
-
The specified resource does not exist.
-
Invalid input was provided.
-
AWSServiceAccessNotEnabledException:
The action you attempted is not allowed unless Service Access with Service Quotas is enabled in your organization.
-
TemplatesNotAvailableInRegionException:
The Service Quotas template is not available in this AWS Region.
-
NoAvailableOrganizationException:
The account making this call is not a member of an organization.
DisassociateServiceQuotaTemplate
$result = $client->disassociateServiceQuotaTemplate([/* ... */]); $promise = $client->disassociateServiceQuotaTemplateAsync([/* ... */]);
Disables your quota request template. After a template is disabled, the quota increase requests in the template are not applied to new accounts in your organization. Disabling a quota request template does not apply its quota increase requests.
Parameter Syntax
$result = $client->disassociateServiceQuotaTemplate([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
DependencyAccessDeniedException:
You can't perform this action because a dependency does not have access.
-
ServiceQuotaTemplateNotInUseException:
The quota request template is not associated with your organization.
-
You do not have sufficient permission to perform this action.
-
Something went wrong.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
-
AWSServiceAccessNotEnabledException:
The action you attempted is not allowed unless Service Access with Service Quotas is enabled in your organization.
-
TemplatesNotAvailableInRegionException:
The Service Quotas template is not available in this AWS Region.
-
NoAvailableOrganizationException:
The account making this call is not a member of an organization.
GetAWSDefaultServiceQuota
$result = $client->getAWSDefaultServiceQuota([/* ... */]); $promise = $client->getAWSDefaultServiceQuotaAsync([/* ... */]);
Retrieves the default value for the specified quota. The default value does not reflect any quota increases.
Parameter Syntax
$result = $client->getAWSDefaultServiceQuota([
'QuotaCode' => '<string>', // REQUIRED
'ServiceCode' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Quota' => [
'Adjustable' => true || false,
'ErrorReason' => [
'ErrorCode' => 'DEPENDENCY_ACCESS_DENIED_ERROR|DEPENDENCY_THROTTLING_ERROR|DEPENDENCY_SERVICE_ERROR|SERVICE_QUOTA_NOT_AVAILABLE_ERROR',
'ErrorMessage' => '<string>',
],
'GlobalQuota' => true || false,
'Period' => [
'PeriodUnit' => 'MICROSECOND|MILLISECOND|SECOND|MINUTE|HOUR|DAY|WEEK',
'PeriodValue' => <integer>,
],
'QuotaArn' => '<string>',
'QuotaCode' => '<string>',
'QuotaName' => '<string>',
'ServiceCode' => '<string>',
'ServiceName' => '<string>',
'Unit' => '<string>',
'UsageMetric' => [
'MetricDimensions' => ['<string>', ...],
'MetricName' => '<string>',
'MetricNamespace' => '<string>',
'MetricStatisticRecommendation' => '<string>',
],
'Value' => <float>,
],
]
Result Details
Members
- Quota
-
- Type: ServiceQuota structure
Information about the quota.
Errors
-
You do not have sufficient permission to perform this action.
-
The specified resource does not exist.
-
Invalid input was provided.
-
Something went wrong.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
GetAssociationForServiceQuotaTemplate
$result = $client->getAssociationForServiceQuotaTemplate([/* ... */]); $promise = $client->getAssociationForServiceQuotaTemplateAsync([/* ... */]);
Retrieves the status of the association for the quota request template.
Parameter Syntax
$result = $client->getAssociationForServiceQuotaTemplate([ ]);
Parameter Details
Members
Result Syntax
[
'ServiceQuotaTemplateAssociationStatus' => 'ASSOCIATED|DISASSOCIATED',
]
Result Details
Members
Errors
-
DependencyAccessDeniedException:
You can't perform this action because a dependency does not have access.
-
ServiceQuotaTemplateNotInUseException:
The quota request template is not associated with your organization.
-
You do not have sufficient permission to perform this action.
-
Something went wrong.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
-
AWSServiceAccessNotEnabledException:
The action you attempted is not allowed unless Service Access with Service Quotas is enabled in your organization.
-
TemplatesNotAvailableInRegionException:
The Service Quotas template is not available in this AWS Region.
-
NoAvailableOrganizationException:
The account making this call is not a member of an organization.
GetRequestedServiceQuotaChange
$result = $client->getRequestedServiceQuotaChange([/* ... */]); $promise = $client->getRequestedServiceQuotaChangeAsync([/* ... */]);
Retrieves information about the specified quota increase request.
Parameter Syntax
$result = $client->getRequestedServiceQuotaChange([
'RequestId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'RequestedQuota' => [
'CaseId' => '<string>',
'Created' => <DateTime>,
'DesiredValue' => <float>,
'GlobalQuota' => true || false,
'Id' => '<string>',
'LastUpdated' => <DateTime>,
'QuotaArn' => '<string>',
'QuotaCode' => '<string>',
'QuotaName' => '<string>',
'Requester' => '<string>',
'ServiceCode' => '<string>',
'ServiceName' => '<string>',
'Status' => 'PENDING|CASE_OPENED|APPROVED|DENIED|CASE_CLOSED',
'Unit' => '<string>',
],
]
Result Details
Members
- RequestedQuota
-
- Type: RequestedServiceQuotaChange structure
Information about the quota increase request.
Errors
-
You do not have sufficient permission to perform this action.
-
The specified resource does not exist.
-
Invalid input was provided.
-
Something went wrong.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
GetServiceQuota
$result = $client->getServiceQuota([/* ... */]); $promise = $client->getServiceQuotaAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->getServiceQuota([
'QuotaCode' => '<string>', // REQUIRED
'ServiceCode' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Quota' => [
'Adjustable' => true || false,
'ErrorReason' => [
'ErrorCode' => 'DEPENDENCY_ACCESS_DENIED_ERROR|DEPENDENCY_THROTTLING_ERROR|DEPENDENCY_SERVICE_ERROR|SERVICE_QUOTA_NOT_AVAILABLE_ERROR',
'ErrorMessage' => '<string>',
],
'GlobalQuota' => true || false,
'Period' => [
'PeriodUnit' => 'MICROSECOND|MILLISECOND|SECOND|MINUTE|HOUR|DAY|WEEK',
'PeriodValue' => <integer>,
],
'QuotaArn' => '<string>',
'QuotaCode' => '<string>',
'QuotaName' => '<string>',
'ServiceCode' => '<string>',
'ServiceName' => '<string>',
'Unit' => '<string>',
'UsageMetric' => [
'MetricDimensions' => ['<string>', ...],
'MetricName' => '<string>',
'MetricNamespace' => '<string>',
'MetricStatisticRecommendation' => '<string>',
],
'Value' => <float>,
],
]
Result Details
Members
- Quota
-
- Type: ServiceQuota structure
Information about the quota.
Errors
-
You do not have sufficient permission to perform this action.
-
The specified resource does not exist.
-
Invalid input was provided.
-
Something went wrong.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
GetServiceQuotaIncreaseRequestFromTemplate
$result = $client->getServiceQuotaIncreaseRequestFromTemplate([/* ... */]); $promise = $client->getServiceQuotaIncreaseRequestFromTemplateAsync([/* ... */]);
Retrieves information about the specified quota increase request in your quota request template.
Parameter Syntax
$result = $client->getServiceQuotaIncreaseRequestFromTemplate([
'AwsRegion' => '<string>', // REQUIRED
'QuotaCode' => '<string>', // REQUIRED
'ServiceCode' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ServiceQuotaIncreaseRequestInTemplate' => [
'AwsRegion' => '<string>',
'DesiredValue' => <float>,
'GlobalQuota' => true || false,
'QuotaCode' => '<string>',
'QuotaName' => '<string>',
'ServiceCode' => '<string>',
'ServiceName' => '<string>',
'Unit' => '<string>',
],
]
Result Details
Members
- ServiceQuotaIncreaseRequestInTemplate
-
- Type: ServiceQuotaIncreaseRequestInTemplate structure
Information about the quota increase request.
Errors
-
You do not have sufficient permission to perform this action.
-
DependencyAccessDeniedException:
You can't perform this action because a dependency does not have access.
-
Something went wrong.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
-
The specified resource does not exist.
-
Invalid input was provided.
-
AWSServiceAccessNotEnabledException:
The action you attempted is not allowed unless Service Access with Service Quotas is enabled in your organization.
-
TemplatesNotAvailableInRegionException:
The Service Quotas template is not available in this AWS Region.
-
NoAvailableOrganizationException:
The account making this call is not a member of an organization.
ListAWSDefaultServiceQuotas
$result = $client->listAWSDefaultServiceQuotas([/* ... */]); $promise = $client->listAWSDefaultServiceQuotasAsync([/* ... */]);
Lists the default values for the quotas for the specified AWS service. A default value does not reflect any quota increases.
Parameter Syntax
$result = $client->listAWSDefaultServiceQuotas([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ServiceCode' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.
- NextToken
-
- Type: string
The token for the next page of results.
- ServiceCode
-
- Required: Yes
- Type: string
The service identifier.
Result Syntax
[
'NextToken' => '<string>',
'Quotas' => [
[
'Adjustable' => true || false,
'ErrorReason' => [
'ErrorCode' => 'DEPENDENCY_ACCESS_DENIED_ERROR|DEPENDENCY_THROTTLING_ERROR|DEPENDENCY_SERVICE_ERROR|SERVICE_QUOTA_NOT_AVAILABLE_ERROR',
'ErrorMessage' => '<string>',
],
'GlobalQuota' => true || false,
'Period' => [
'PeriodUnit' => 'MICROSECOND|MILLISECOND|SECOND|MINUTE|HOUR|DAY|WEEK',
'PeriodValue' => <integer>,
],
'QuotaArn' => '<string>',
'QuotaCode' => '<string>',
'QuotaName' => '<string>',
'ServiceCode' => '<string>',
'ServiceName' => '<string>',
'Unit' => '<string>',
'UsageMetric' => [
'MetricDimensions' => ['<string>', ...],
'MetricName' => '<string>',
'MetricNamespace' => '<string>',
'MetricStatisticRecommendation' => '<string>',
],
'Value' => <float>,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Quotas
-
- Type: Array of ServiceQuota structures
Information about the quotas.
Errors
-
You do not have sufficient permission to perform this action.
-
The specified resource does not exist.
-
Invalid input was provided.
-
InvalidPaginationTokenException:
Invalid input was provided.
-
Something went wrong.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
ListRequestedServiceQuotaChangeHistory
$result = $client->listRequestedServiceQuotaChangeHistory([/* ... */]); $promise = $client->listRequestedServiceQuotaChangeHistoryAsync([/* ... */]);
Retrieves the quota increase requests for the specified service.
Parameter Syntax
$result = $client->listRequestedServiceQuotaChangeHistory([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ServiceCode' => '<string>',
'Status' => 'PENDING|CASE_OPENED|APPROVED|DENIED|CASE_CLOSED',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.
- NextToken
-
- Type: string
The token for the next page of results.
- ServiceCode
-
- Type: string
The service identifier.
- Status
-
- Type: string
The status of the quota increase request.
Result Syntax
[
'NextToken' => '<string>',
'RequestedQuotas' => [
[
'CaseId' => '<string>',
'Created' => <DateTime>,
'DesiredValue' => <float>,
'GlobalQuota' => true || false,
'Id' => '<string>',
'LastUpdated' => <DateTime>,
'QuotaArn' => '<string>',
'QuotaCode' => '<string>',
'QuotaName' => '<string>',
'Requester' => '<string>',
'ServiceCode' => '<string>',
'ServiceName' => '<string>',
'Status' => 'PENDING|CASE_OPENED|APPROVED|DENIED|CASE_CLOSED',
'Unit' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- RequestedQuotas
-
- Type: Array of RequestedServiceQuotaChange structures
Information about the quota increase requests.
Errors
-
You do not have sufficient permission to perform this action.
-
The specified resource does not exist.
-
Invalid input was provided.
-
InvalidPaginationTokenException:
Invalid input was provided.
-
Something went wrong.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
ListRequestedServiceQuotaChangeHistoryByQuota
$result = $client->listRequestedServiceQuotaChangeHistoryByQuota([/* ... */]); $promise = $client->listRequestedServiceQuotaChangeHistoryByQuotaAsync([/* ... */]);
Retrieves the quota increase requests for the specified quota.
Parameter Syntax
$result = $client->listRequestedServiceQuotaChangeHistoryByQuota([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'QuotaCode' => '<string>', // REQUIRED
'ServiceCode' => '<string>', // REQUIRED
'Status' => 'PENDING|CASE_OPENED|APPROVED|DENIED|CASE_CLOSED',
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.
- NextToken
-
- Type: string
The token for the next page of results.
- QuotaCode
-
- Required: Yes
- Type: string
The quota identifier.
- ServiceCode
-
- Required: Yes
- Type: string
The service identifier.
- Status
-
- Type: string
The status value of the quota increase request.
Result Syntax
[
'NextToken' => '<string>',
'RequestedQuotas' => [
[
'CaseId' => '<string>',
'Created' => <DateTime>,
'DesiredValue' => <float>,
'GlobalQuota' => true || false,
'Id' => '<string>',
'LastUpdated' => <DateTime>,
'QuotaArn' => '<string>',
'QuotaCode' => '<string>',
'QuotaName' => '<string>',
'Requester' => '<string>',
'ServiceCode' => '<string>',
'ServiceName' => '<string>',
'Status' => 'PENDING|CASE_OPENED|APPROVED|DENIED|CASE_CLOSED',
'Unit' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- RequestedQuotas
-
- Type: Array of RequestedServiceQuotaChange structures
Information about the quota increase requests.
Errors
-
You do not have sufficient permission to perform this action.
-
The specified resource does not exist.
-
Invalid input was provided.
-
InvalidPaginationTokenException:
Invalid input was provided.
-
Something went wrong.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
ListServiceQuotaIncreaseRequestsInTemplate
$result = $client->listServiceQuotaIncreaseRequestsInTemplate([/* ... */]); $promise = $client->listServiceQuotaIncreaseRequestsInTemplateAsync([/* ... */]);
Lists the quota increase requests in the specified quota request template.
Parameter Syntax
$result = $client->listServiceQuotaIncreaseRequestsInTemplate([
'AwsRegion' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ServiceCode' => '<string>',
]);
Parameter Details
Members
- AwsRegion
-
- Type: string
The AWS Region.
- MaxResults
-
- Type: int
The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.
- NextToken
-
- Type: string
The token for the next page of results.
- ServiceCode
-
- Type: string
The service identifier.
Result Syntax
[
'NextToken' => '<string>',
'ServiceQuotaIncreaseRequestInTemplateList' => [
[
'AwsRegion' => '<string>',
'DesiredValue' => <float>,
'GlobalQuota' => true || false,
'QuotaCode' => '<string>',
'QuotaName' => '<string>',
'ServiceCode' => '<string>',
'ServiceName' => '<string>',
'Unit' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- ServiceQuotaIncreaseRequestInTemplateList
-
- Type: Array of ServiceQuotaIncreaseRequestInTemplate structures
Information about the quota increase requests.
Errors
-
You do not have sufficient permission to perform this action.
-
DependencyAccessDeniedException:
You can't perform this action because a dependency does not have access.
-
Something went wrong.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
-
Invalid input was provided.
-
AWSServiceAccessNotEnabledException:
The action you attempted is not allowed unless Service Access with Service Quotas is enabled in your organization.
-
TemplatesNotAvailableInRegionException:
The Service Quotas template is not available in this AWS Region.
-
NoAvailableOrganizationException:
The account making this call is not a member of an organization.
ListServiceQuotas
$result = $client->listServiceQuotas([/* ... */]); $promise = $client->listServiceQuotasAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listServiceQuotas([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ServiceCode' => '<string>', // REQUIRED
]);
Parameter Details
Members
- MaxResults
-
- Type: int
The maximum number of results to return with a single call. To retrieve the remaining results, if any, make another call with the token returned from this call.
- NextToken
-
- Type: string
The token for the next page of results.
- ServiceCode
-
- Required: Yes
- Type: string
The service identifier.
Result Syntax
[
'NextToken' => '<string>',
'Quotas' => [
[
'Adjustable' => true || false,
'ErrorReason' => [
'ErrorCode' => 'DEPENDENCY_ACCESS_DENIED_ERROR|DEPENDENCY_THROTTLING_ERROR|DEPENDENCY_SERVICE_ERROR|SERVICE_QUOTA_NOT_AVAILABLE_ERROR',
'ErrorMessage' => '<string>',
],
'GlobalQuota' => true || false,
'Period' => [
'PeriodUnit' => 'MICROSECOND|MILLISECOND|SECOND|MINUTE|HOUR|DAY|WEEK',
'PeriodValue' => <integer>,
],
'QuotaArn' => '<string>',
'QuotaCode' => '<string>',
'QuotaName' => '<string>',
'ServiceCode' => '<string>',
'ServiceName' => '<string>',
'Unit' => '<string>',
'UsageMetric' => [
'MetricDimensions' => ['<string>', ...],
'MetricName' => '<string>',
'MetricNamespace' => '<string>',
'MetricStatisticRecommendation' => '<string>',
],
'Value' => <float>,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Quotas
-
- Type: Array of ServiceQuota structures
Information about the quotas.
Errors
-
You do not have sufficient permission to perform this action.
-
The specified resource does not exist.
-
Invalid input was provided.
-
InvalidPaginationTokenException:
Invalid input was provided.
-
Something went wrong.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
ListServices
$result = $client->listServices([/* ... */]); $promise = $client->listServicesAsync([/* ... */]);
Lists the names and codes for the services integrated with Service Quotas.
Parameter Syntax
$result = $client->listServices([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'Services' => [
[
'ServiceCode' => '<string>',
'ServiceName' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Services
-
- Type: Array of ServiceInfo structures
Information about the services.
Errors
-
You do not have sufficient permission to perform this action.
-
Invalid input was provided.
-
InvalidPaginationTokenException:
Invalid input was provided.
-
Something went wrong.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Returns a list of the tags assigned to the specified applied quota.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceARN' => '<string>', // REQUIRED
]);
Parameter Details
Members
- ResourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the applied quota for which you want to list tags. You can get this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.
Result Syntax
[
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- Tags
-
- Type: Array of Tag structures
A complex data type that contains zero or more tag elements.
Errors
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
-
The specified resource does not exist.
-
Invalid input was provided.
-
You do not have sufficient permission to perform this action.
-
Something went wrong.
PutServiceQuotaIncreaseRequestIntoTemplate
$result = $client->putServiceQuotaIncreaseRequestIntoTemplate([/* ... */]); $promise = $client->putServiceQuotaIncreaseRequestIntoTemplateAsync([/* ... */]);
Adds a quota increase request to your quota request template.
Parameter Syntax
$result = $client->putServiceQuotaIncreaseRequestIntoTemplate([
'AwsRegion' => '<string>', // REQUIRED
'DesiredValue' => <float>, // REQUIRED
'QuotaCode' => '<string>', // REQUIRED
'ServiceCode' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ServiceQuotaIncreaseRequestInTemplate' => [
'AwsRegion' => '<string>',
'DesiredValue' => <float>,
'GlobalQuota' => true || false,
'QuotaCode' => '<string>',
'QuotaName' => '<string>',
'ServiceCode' => '<string>',
'ServiceName' => '<string>',
'Unit' => '<string>',
],
]
Result Details
Members
- ServiceQuotaIncreaseRequestInTemplate
-
- Type: ServiceQuotaIncreaseRequestInTemplate structure
Information about the quota increase request.
Errors
-
You do not have sufficient permission to perform this action.
-
DependencyAccessDeniedException:
You can't perform this action because a dependency does not have access.
-
Something went wrong.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
-
Invalid input was provided.
-
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.
-
The specified resource does not exist.
-
AWSServiceAccessNotEnabledException:
The action you attempted is not allowed unless Service Access with Service Quotas is enabled in your organization.
-
TemplatesNotAvailableInRegionException:
The Service Quotas template is not available in this AWS Region.
-
NoAvailableOrganizationException:
The account making this call is not a member of an organization.
RequestServiceQuotaIncrease
$result = $client->requestServiceQuotaIncrease([/* ... */]); $promise = $client->requestServiceQuotaIncreaseAsync([/* ... */]);
Submits a quota increase request for the specified quota.
Parameter Syntax
$result = $client->requestServiceQuotaIncrease([
'DesiredValue' => <float>, // REQUIRED
'QuotaCode' => '<string>', // REQUIRED
'ServiceCode' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'RequestedQuota' => [
'CaseId' => '<string>',
'Created' => <DateTime>,
'DesiredValue' => <float>,
'GlobalQuota' => true || false,
'Id' => '<string>',
'LastUpdated' => <DateTime>,
'QuotaArn' => '<string>',
'QuotaCode' => '<string>',
'QuotaName' => '<string>',
'Requester' => '<string>',
'ServiceCode' => '<string>',
'ServiceName' => '<string>',
'Status' => 'PENDING|CASE_OPENED|APPROVED|DENIED|CASE_CLOSED',
'Unit' => '<string>',
],
]
Result Details
Members
- RequestedQuota
-
- Type: RequestedServiceQuotaChange structure
Information about the quota increase request.
Errors
-
DependencyAccessDeniedException:
You can't perform this action because a dependency does not have access.
-
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.
-
ResourceAlreadyExistsException:
The specified resource already exists.
-
You do not have sufficient permission to perform this action.
-
The specified resource does not exist.
-
Invalid input was provided.
-
InvalidResourceStateException:
The resource is in an invalid state.
-
Something went wrong.
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds tags to the specified applied quota. You can include one or more tags to add to the quota.
Parameter Syntax
$result = $client->tagResource([
'ResourceARN' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ResourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the applied quota. You can get this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
The tags that you want to add to the resource.
Result Syntax
[]
Result Details
Errors
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
-
The specified resource does not exist.
-
You've exceeded the number of tags allowed for a resource. For more information, see Tag restrictions in the Service Quotas User Guide.
-
The specified tag is a reserved word and cannot be used.
-
Invalid input was provided.
-
You do not have sufficient permission to perform this action.
-
Something went wrong.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes tags from the specified applied quota. You can specify one or more tags to remove.
Parameter Syntax
$result = $client->untagResource([
'ResourceARN' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- ResourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the applied quota that you want to untag. You can get this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.
- TagKeys
-
- Required: Yes
- Type: Array of strings
The keys of the tags that you want to remove from the resource.
Result Syntax
[]
Result Details
Errors
-
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
-
The specified resource does not exist.
-
Invalid input was provided.
-
You do not have sufficient permission to perform this action.
-
Something went wrong.
Shapes
AWSServiceAccessNotEnabledException
Description
The action you attempted is not allowed unless Service Access with Service Quotas is enabled in your organization.
Members
AccessDeniedException
Description
You do not have sufficient permission to perform this action.
Members
DependencyAccessDeniedException
Description
You can't perform this action because a dependency does not have access.
Members
ErrorReason
Description
An error that explains why an action did not succeed.
Members
- ErrorCode
-
- Type: 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
-
- Type: string
The error message.
IllegalArgumentException
InvalidPaginationTokenException
InvalidResourceStateException
MetricInfo
Description
Information about the CloudWatch metric that reflects quota usage.
Members
- MetricDimensions
-
- Type: Associative array of custom strings keys (MetricDimensionName) to strings
The metric dimension. This is a name/value pair that is part of the identity of a metric.
- MetricName
-
- Type: string
The name of the metric.
- MetricNamespace
-
- Type: string
The namespace of the metric.
- MetricStatisticRecommendation
-
- Type: string
The metric statistic that we recommend you use when determining quota usage.
NoAvailableOrganizationException
Description
The account making this call is not a member of an organization.
Members
NoSuchResourceException
OrganizationNotInAllFeaturesModeException
Description
The organization that your account belongs to is not in All Features mode.
Members
QuotaExceededException
Description
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.
Members
QuotaPeriod
Description
Information about the quota period.
Members
RequestedServiceQuotaChange
Description
Information about a quota increase request.
Members
- CaseId
-
- Type: string
The case ID.
- Created
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the quota increase request was received and the case ID was created.
- DesiredValue
-
- Type: double
The new, increased value for the quota.
- GlobalQuota
-
- Type: boolean
Indicates whether the quota is global.
- Id
-
- Type: string
The unique identifier.
- LastUpdated
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time of the most recent change.
- QuotaArn
-
- Type: string
The Amazon Resource Name (ARN) of the quota.
- QuotaCode
-
- Type: string
The quota identifier.
- QuotaName
-
- Type: string
The quota name.
- Requester
-
- Type: string
The IAM identity of the requester.
- ServiceCode
-
- Type: string
The service identifier.
- ServiceName
-
- Type: string
The service name.
- Status
-
- Type: string
The state of the quota increase request.
- Unit
-
- Type: string
The unit of measurement.
ResourceAlreadyExistsException
ServiceException
ServiceInfo
Description
Information about a service.
Members
ServiceQuota
Description
Information about a quota.
Members
- Adjustable
-
- Type: boolean
Indicates whether the quota value can be increased.
- ErrorReason
-
- Type: ErrorReason structure
The error code and error reason.
- GlobalQuota
-
- Type: boolean
Indicates whether the quota is global.
- Period
-
- Type: QuotaPeriod structure
The period of time.
- QuotaArn
-
- Type: string
The Amazon Resource Name (ARN) of the quota.
- QuotaCode
-
- Type: string
The quota identifier.
- QuotaName
-
- Type: string
The quota name.
- ServiceCode
-
- Type: string
The service identifier.
- ServiceName
-
- Type: string
The service name.
- Unit
-
- Type: string
The unit of measurement.
- UsageMetric
-
- Type: MetricInfo structure
Information about the measurement.
- Value
-
- Type: double
The quota value.
ServiceQuotaIncreaseRequestInTemplate
Description
Information about a quota increase request.
Members
- AwsRegion
-
- Type: string
The AWS Region.
- DesiredValue
-
- Type: double
The new, increased value of the quota.
- GlobalQuota
-
- Type: boolean
Indicates whether the quota is global.
- QuotaCode
-
- Type: string
The quota identifier.
- QuotaName
-
- Type: string
The quota name.
- ServiceCode
-
- Type: string
The service identifier.
- ServiceName
-
- Type: string
The service name.
- Unit
-
- Type: string
The unit of measurement.
ServiceQuotaTemplateNotInUseException
Description
The quota request template is not associated with your organization.
Members
Tag
Description
A complex data type that contains a tag key and tag value.
Members
- Key
-
- Required: Yes
- Type: string
A string that contains a tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.
- Value
-
- Required: Yes
- Type: string
A string that contains an optional tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.
TagPolicyViolationException
TemplatesNotAvailableInRegionException
Description
The Service Quotas template is not available in this AWS Region.
Members
TooManyRequestsException
Description
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
Members
TooManyTagsException
Description
You've exceeded the number of tags allowed for a resource. For more information, see Tag restrictions in the Service Quotas User Guide.