AWS SDK for PHP 3.x

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 Amazon Web Service.
ListRequestedServiceQuotaChangeHistory ( array $params = [] ): Retrieves the quota increase requests for the specified Amazon Web 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 Amazon Web Service.
ListServices ( array $params = [] ): Lists the names and codes for the Amazon Web 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:

ListAWSDefaultServiceQuotas
ListRequestedServiceQuotaChangeHistory
ListRequestedServiceQuotaChangeHistoryByQuota
ListServiceQuotaIncreaseRequestsInTemplate
ListServiceQuotas
ListServices

Operations

AssociateServiceQuotaTemplate

$result = $client->associateServiceQuotaTemplate([/* ... */]);
$promise = $client->associateServiceQuotaTemplateAsync([/* ... */]);

Associates your quota request template with your organization. When a new Amazon Web Services 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

The results for this operation are always empty.

Errors

DependencyAccessDeniedException:
You can't perform this action because a dependency does not have access.
AccessDeniedException:
You do not have sufficient permission to perform this action.
ServiceException:
Something went wrong.
TooManyRequestsException:
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 Amazon Web Services account belongs to is not in All Features mode.
TemplatesNotAvailableInRegionException:
The Service Quotas template is not available in this Amazon Web Services Region.
NoAvailableOrganizationException:
The Amazon Web Services 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

AwsRegion

Required: Yes
Type: string

Specifies the Amazon Web Services Region for which the request was made.

QuotaCode

Required: Yes
Type: string

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

ServiceCode

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
You do not have sufficient permission to perform this action.
ServiceException:
Something went wrong.
DependencyAccessDeniedException:
You can't perform this action because a dependency does not have access.
TooManyRequestsException:
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
NoSuchResourceException:
The specified resource does not exist.
IllegalArgumentException:
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 Amazon Web Services Region.
NoAvailableOrganizationException:
The Amazon Web Services 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 Amazon Web Services 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

The results for this operation are always empty.

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.
AccessDeniedException:
You do not have sufficient permission to perform this action.
ServiceException:
Something went wrong.
TooManyRequestsException:
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 Amazon Web Services Region.
NoAvailableOrganizationException:
The Amazon Web Services 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

QuotaCode

Required: Yes
Type: string

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

ServiceCode

Required: Yes
Type: string

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

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>,
        ],
        'QuotaAppliedAtLevel' => 'ACCOUNT|RESOURCE|ALL',
        'QuotaArn' => '<string>',
        'QuotaCode' => '<string>',
        'QuotaContext' => [
            'ContextId' => '<string>',
            'ContextScope' => 'RESOURCE|ACCOUNT',
            'ContextScopeType' => '<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

AccessDeniedException:
You do not have sufficient permission to perform this action.
NoSuchResourceException:
The specified resource does not exist.
IllegalArgumentException:
Invalid input was provided.
ServiceException:
Something went wrong.
TooManyRequestsException:
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

ServiceQuotaTemplateAssociationStatus

Type: string

The association status. If the status is ASSOCIATED, the quota increase requests in the template are automatically applied to new Amazon Web Services accounts in your organization.

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.
AccessDeniedException:
You do not have sufficient permission to perform this action.
ServiceException:
Something went wrong.
TooManyRequestsException:
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 Amazon Web Services Region.
NoAvailableOrganizationException:
The Amazon Web Services 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

Members

RequestId

Required: Yes
Type: string

Specifies the ID of the quota increase request.

Result Syntax

[
    'RequestedQuota' => [
        'CaseId' => '<string>',
        'Created' => <DateTime>,
        'DesiredValue' => <float>,
        'GlobalQuota' => true || false,
        'Id' => '<string>',
        'LastUpdated' => <DateTime>,
        'QuotaArn' => '<string>',
        'QuotaCode' => '<string>',
        'QuotaContext' => [
            'ContextId' => '<string>',
            'ContextScope' => 'RESOURCE|ACCOUNT',
            'ContextScopeType' => '<string>',
        ],
        'QuotaName' => '<string>',
        'QuotaRequestedAtLevel' => 'ACCOUNT|RESOURCE|ALL',
        'Requester' => '<string>',
        'ServiceCode' => '<string>',
        'ServiceName' => '<string>',
        'Status' => 'PENDING|CASE_OPENED|APPROVED|DENIED|CASE_CLOSED|NOT_APPROVED|INVALID_REQUEST',
        'Unit' => '<string>',
    ],
]

Result Details

Members

RequestedQuota

Type: RequestedServiceQuotaChange structure

Information about the quota increase request.

Errors

AccessDeniedException:
You do not have sufficient permission to perform this action.
NoSuchResourceException:
The specified resource does not exist.
IllegalArgumentException:
Invalid input was provided.
ServiceException:
Something went wrong.
TooManyRequestsException:
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([
    'ContextId' => '<string>',
    'QuotaCode' => '<string>', // REQUIRED
    'ServiceCode' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContextId

Type: string

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

QuotaCode

Required: Yes
Type: string

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

ServiceCode

Required: Yes
Type: string

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

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>,
        ],
        'QuotaAppliedAtLevel' => 'ACCOUNT|RESOURCE|ALL',
        'QuotaArn' => '<string>',
        'QuotaCode' => '<string>',
        'QuotaContext' => [
            'ContextId' => '<string>',
            'ContextScope' => 'RESOURCE|ACCOUNT',
            'ContextScopeType' => '<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

AccessDeniedException:
You do not have sufficient permission to perform this action.
NoSuchResourceException:
The specified resource does not exist.
IllegalArgumentException:
Invalid input was provided.
ServiceException:
Something went wrong.
TooManyRequestsException:
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

AwsRegion

Required: Yes
Type: string

Specifies the Amazon Web Services Region for which you made the request.

QuotaCode

Required: Yes
Type: string

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

ServiceCode

Required: Yes
Type: string

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

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

AccessDeniedException:
You do not have sufficient permission to perform this action.
DependencyAccessDeniedException:
You can't perform this action because a dependency does not have access.
ServiceException:
Something went wrong.
TooManyRequestsException:
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
NoSuchResourceException:
The specified resource does not exist.
IllegalArgumentException:
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 Amazon Web Services Region.
NoAvailableOrganizationException:
The Amazon Web Services 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 Amazon Web 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

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.

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.

NextToken

Type: string

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.

ServiceCode

Required: Yes
Type: string

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

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>,
            ],
            'QuotaAppliedAtLevel' => 'ACCOUNT|RESOURCE|ALL',
            'QuotaArn' => '<string>',
            'QuotaCode' => '<string>',
            'QuotaContext' => [
                'ContextId' => '<string>',
                'ContextScope' => 'RESOURCE|ACCOUNT',
                'ContextScopeType' => '<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

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.

Quotas

Type: Array of ServiceQuota structures

Information about the quotas.

Errors

AccessDeniedException:
You do not have sufficient permission to perform this action.
NoSuchResourceException:
The specified resource does not exist.
IllegalArgumentException:
Invalid input was provided.
InvalidPaginationTokenException:
Invalid input was provided.
ServiceException:
Something went wrong.
TooManyRequestsException:
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 Amazon Web Service.

Parameter Syntax

$result = $client->listRequestedServiceQuotaChangeHistory([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'QuotaRequestedAtLevel' => 'ACCOUNT|RESOURCE|ALL',
    'ServiceCode' => '<string>',
    'Status' => 'PENDING|CASE_OPENED|APPROVED|DENIED|CASE_CLOSED|NOT_APPROVED|INVALID_REQUEST',
]);

Parameter Details

Members

MaxResults

Type: int

NextToken

Type: string

QuotaRequestedAtLevel

Type: string

Specifies at which level within the Amazon Web Services account the quota request applies to.

ServiceCode

Type: string

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

Status

Type: string

Specifies that you want to filter the results to only the requests with the matching status.

Result Syntax

[
    'NextToken' => '<string>',
    'RequestedQuotas' => [
        [
            'CaseId' => '<string>',
            'Created' => <DateTime>,
            'DesiredValue' => <float>,
            'GlobalQuota' => true || false,
            'Id' => '<string>',
            'LastUpdated' => <DateTime>,
            'QuotaArn' => '<string>',
            'QuotaCode' => '<string>',
            'QuotaContext' => [
                'ContextId' => '<string>',
                'ContextScope' => 'RESOURCE|ACCOUNT',
                'ContextScopeType' => '<string>',
            ],
            'QuotaName' => '<string>',
            'QuotaRequestedAtLevel' => 'ACCOUNT|RESOURCE|ALL',
            'Requester' => '<string>',
            'ServiceCode' => '<string>',
            'ServiceName' => '<string>',
            'Status' => 'PENDING|CASE_OPENED|APPROVED|DENIED|CASE_CLOSED|NOT_APPROVED|INVALID_REQUEST',
            'Unit' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

RequestedQuotas

Type: Array of RequestedServiceQuotaChange structures

Information about the quota increase requests.

Errors

AccessDeniedException:
You do not have sufficient permission to perform this action.
NoSuchResourceException:
The specified resource does not exist.
IllegalArgumentException:
Invalid input was provided.
InvalidPaginationTokenException:
Invalid input was provided.
ServiceException:
Something went wrong.
TooManyRequestsException:
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
    'QuotaRequestedAtLevel' => 'ACCOUNT|RESOURCE|ALL',
    'ServiceCode' => '<string>', // REQUIRED
    'Status' => 'PENDING|CASE_OPENED|APPROVED|DENIED|CASE_CLOSED|NOT_APPROVED|INVALID_REQUEST',
]);

Parameter Details

Members

MaxResults

Type: int

NextToken

Type: string

QuotaCode

Required: Yes
Type: string

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

QuotaRequestedAtLevel

Type: string

Specifies at which level within the Amazon Web Services account the quota request applies to.

ServiceCode

Required: Yes
Type: string

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

Status

Type: string

Specifies that you want to filter the results to only the requests with the matching status.

Result Syntax

[
    'NextToken' => '<string>',
    'RequestedQuotas' => [
        [
            'CaseId' => '<string>',
            'Created' => <DateTime>,
            'DesiredValue' => <float>,
            'GlobalQuota' => true || false,
            'Id' => '<string>',
            'LastUpdated' => <DateTime>,
            'QuotaArn' => '<string>',
            'QuotaCode' => '<string>',
            'QuotaContext' => [
                'ContextId' => '<string>',
                'ContextScope' => 'RESOURCE|ACCOUNT',
                'ContextScopeType' => '<string>',
            ],
            'QuotaName' => '<string>',
            'QuotaRequestedAtLevel' => 'ACCOUNT|RESOURCE|ALL',
            'Requester' => '<string>',
            'ServiceCode' => '<string>',
            'ServiceName' => '<string>',
            'Status' => 'PENDING|CASE_OPENED|APPROVED|DENIED|CASE_CLOSED|NOT_APPROVED|INVALID_REQUEST',
            'Unit' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

RequestedQuotas

Type: Array of RequestedServiceQuotaChange structures

Information about the quota increase requests.

Errors

AccessDeniedException:
You do not have sufficient permission to perform this action.
NoSuchResourceException:
The specified resource does not exist.
IllegalArgumentException:
Invalid input was provided.
InvalidPaginationTokenException:
Invalid input was provided.
ServiceException:
Something went wrong.
TooManyRequestsException:
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

Specifies the Amazon Web Services Region for which you made the request.

MaxResults

Type: int

NextToken

Type: string

ServiceCode

Type: string

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

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

ServiceQuotaIncreaseRequestInTemplateList

Type: Array of ServiceQuotaIncreaseRequestInTemplate structures

Information about the quota increase requests.

Errors

AccessDeniedException:
You do not have sufficient permission to perform this action.
DependencyAccessDeniedException:
You can't perform this action because a dependency does not have access.
ServiceException:
Something went wrong.
TooManyRequestsException:
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
IllegalArgumentException:
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 Amazon Web Services Region.
NoAvailableOrganizationException:
The Amazon Web Services 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 Amazon Web 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>',
    'QuotaAppliedAtLevel' => 'ACCOUNT|RESOURCE|ALL',
    'QuotaCode' => '<string>',
    'ServiceCode' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

NextToken

Type: string

QuotaAppliedAtLevel

Type: string

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

QuotaCode

Type: string

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

ServiceCode

Required: Yes
Type: string

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

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>,
            ],
            'QuotaAppliedAtLevel' => 'ACCOUNT|RESOURCE|ALL',
            'QuotaArn' => '<string>',
            'QuotaCode' => '<string>',
            'QuotaContext' => [
                'ContextId' => '<string>',
                'ContextScope' => 'RESOURCE|ACCOUNT',
                'ContextScopeType' => '<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

Quotas

Type: Array of ServiceQuota structures

Information about the quotas.

Errors

AccessDeniedException:
You do not have sufficient permission to perform this action.
NoSuchResourceException:
The specified resource does not exist.
IllegalArgumentException:
Invalid input was provided.
InvalidPaginationTokenException:
Invalid input was provided.
ServiceException:
Something went wrong.
TooManyRequestsException:
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 Amazon Web Services integrated with Service Quotas.

Parameter Syntax

$result = $client->listServices([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

NextToken

Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'Services' => [
        [
            'ServiceCode' => '<string>',
            'ServiceName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

Services

Type: Array of ServiceInfo structures

The list of the Amazon Web Service names and service codes.

Errors

AccessDeniedException:
You do not have sufficient permission to perform this action.
IllegalArgumentException:
Invalid input was provided.
InvalidPaginationTokenException:
Invalid input was provided.
ServiceException:
Something went wrong.
TooManyRequestsException:
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 CLI command or the ListServiceQuotas Amazon Web Services 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

TooManyRequestsException:
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
NoSuchResourceException:
The specified resource does not exist.
IllegalArgumentException:
Invalid input was provided.
AccessDeniedException:
You do not have sufficient permission to perform this action.
ServiceException:
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

AwsRegion

Required: Yes
Type: string

Specifies the Amazon Web Services Region to which the template applies.

DesiredValue

Required: Yes
Type: double

Specifies the new, increased value for the quota.

QuotaCode

Required: Yes
Type: string

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

ServiceCode

Required: Yes
Type: string

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

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

AccessDeniedException:
You do not have sufficient permission to perform this action.
DependencyAccessDeniedException:
You can't perform this action because a dependency does not have access.
ServiceException:
Something went wrong.
TooManyRequestsException:
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
IllegalArgumentException:
Invalid input was provided.
QuotaExceededException:
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.
NoSuchResourceException:
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 Amazon Web Services Region.
NoAvailableOrganizationException:
The Amazon Web Services 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([
    'ContextId' => '<string>',
    'DesiredValue' => <float>, // REQUIRED
    'QuotaCode' => '<string>', // REQUIRED
    'ServiceCode' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContextId

Type: string

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

DesiredValue

Required: Yes
Type: double

Specifies the new, increased value for the quota.

QuotaCode

Required: Yes
Type: string

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

ServiceCode

Required: Yes
Type: string

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

Result Syntax

[
    'RequestedQuota' => [
        'CaseId' => '<string>',
        'Created' => <DateTime>,
        'DesiredValue' => <float>,
        'GlobalQuota' => true || false,
        'Id' => '<string>',
        'LastUpdated' => <DateTime>,
        'QuotaArn' => '<string>',
        'QuotaCode' => '<string>',
        'QuotaContext' => [
            'ContextId' => '<string>',
            'ContextScope' => 'RESOURCE|ACCOUNT',
            'ContextScopeType' => '<string>',
        ],
        'QuotaName' => '<string>',
        'QuotaRequestedAtLevel' => 'ACCOUNT|RESOURCE|ALL',
        'Requester' => '<string>',
        'ServiceCode' => '<string>',
        'ServiceName' => '<string>',
        'Status' => 'PENDING|CASE_OPENED|APPROVED|DENIED|CASE_CLOSED|NOT_APPROVED|INVALID_REQUEST',
        '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.
QuotaExceededException:
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.
AccessDeniedException:
You do not have sufficient permission to perform this action.
NoSuchResourceException:
The specified resource does not exist.
IllegalArgumentException:
Invalid input was provided.
InvalidResourceStateException:
The resource is in an invalid state.
ServiceException:
Something went wrong.
TooManyRequestsException:
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 CLI command or the ListServiceQuotas Amazon Web Services API operation.

Tags

Required: Yes
Type: Array of Tag structures

The tags that you want to add to the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

TooManyRequestsException:
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
NoSuchResourceException:
The specified resource does not exist.
TooManyTagsException:
You've exceeded the number of tags allowed for a resource. For more information, see Tag restrictions in the Service Quotas User Guide.
TagPolicyViolationException:
The specified tag is a reserved word and cannot be used.
IllegalArgumentException:
Invalid input was provided.
AccessDeniedException:
You do not have sufficient permission to perform this action.
ServiceException:
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 CLI command or the ListServiceQuotas Amazon Web Services 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

The results for this operation are always empty.

Errors

TooManyRequestsException:
Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.
NoSuchResourceException:
The specified resource does not exist.
IllegalArgumentException:
Invalid input was provided.
AccessDeniedException:
You do not have sufficient permission to perform this action.
ServiceException:
Something went wrong.

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 Amazon Web Service or quota.
DEPENDENCY_THROTTLING_ERROR - The Amazon Web Service is throttling Service Quotas.
DEPENDENCY_SERVICE_ERROR - The Amazon Web Service is not available.
SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service Quotas.

ErrorMessage

Type: string

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

Type: string

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

ContextScope

Type: string

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

ContextScopeType

Type: string

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

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

Message

Type: string

QuotaPeriod

Description

Information about the quota period.

Members

PeriodUnit

Type: string

The time unit.

PeriodValue

Type: int

The value associated with the reported PeriodUnit.

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

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.

QuotaContext

Type: QuotaContextInfo structure

The context for this service quota.

QuotaName

Type: string

Specifies the quota name.

QuotaRequestedAtLevel

Type: string

Specifies at which level within the Amazon Web Services account the quota request applies to.

Requester

Type: string

The IAM identity of the requester.

ServiceCode

Type: string

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

ServiceName

Type: string

Specifies the service name.

Status

Type: string

The state of the quota increase request.

Unit

Type: string

Type: string

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

ServiceName

Type: string

Specifies the service name.

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.

QuotaAppliedAtLevel

Type: string

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

QuotaArn

Type: string

The Amazon Resource Name (ARN) of the quota.

QuotaCode

Type: string

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

QuotaContext

Type: QuotaContextInfo structure

The context for this service quota.

QuotaName

Type: string

Specifies the quota name.

ServiceCode

Type: string

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

ServiceName

Type: string

Specifies 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 Amazon Web Services Region.

DesiredValue

Type: double

The new, increased value of the quota.

GlobalQuota

Type: boolean

Indicates whether the quota is global.

QuotaCode

Type: string

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

QuotaName

Type: string

Specifies the quota name.

ServiceCode

Type: string

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

ServiceName

Type: string

Specifies the service name.

Unit

Type: string

Type: string

Service Quotas 2019-06-24

Operation Summary

Paginators

Operations

AssociateServiceQuotaTemplate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteServiceQuotaIncreaseRequestFromTemplate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DisassociateServiceQuotaTemplate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetAWSDefaultServiceQuota

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetAssociationForServiceQuotaTemplate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetRequestedServiceQuotaChange

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetServiceQuota

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetServiceQuotaIncreaseRequestFromTemplate

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListAWSDefaultServiceQuotas

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ListRequestedServiceQuotaChangeHistory

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members