com.amazonaws.services.servicequotas

Interface AWSServiceQuotas

All Known Subinterfaces:

AWSServiceQuotasAsync

All Known Implementing Classes:

AbstractAWSServiceQuotas, AbstractAWSServiceQuotasAsync, AWSServiceQuotasAsyncClient, AWSServiceQuotasClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSServiceQuotas

Interface for accessing Service Quotas.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSServiceQuotas instead.

With Service Quotas, you can view and manage your quotas easily as your AWS workloads grow. Quotas, also referred to as limits, are the maximum number of resources that you can create in your AWS account. For more information, see the Service Quotas User Guide.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssociateServiceQuotaTemplateResult	associateServiceQuotaTemplate(AssociateServiceQuotaTemplateRequest associateServiceQuotaTemplateRequest) Associates your quota request template with your organization.
DeleteServiceQuotaIncreaseRequestFromTemplateResult	deleteServiceQuotaIncreaseRequestFromTemplate(DeleteServiceQuotaIncreaseRequestFromTemplateRequest deleteServiceQuotaIncreaseRequestFromTemplateRequest) Deletes the quota increase request for the specified quota from your quota request template.
DisassociateServiceQuotaTemplateResult	disassociateServiceQuotaTemplate(DisassociateServiceQuotaTemplateRequest disassociateServiceQuotaTemplateRequest) Disables your quota request template.
GetAssociationForServiceQuotaTemplateResult	getAssociationForServiceQuotaTemplate(GetAssociationForServiceQuotaTemplateRequest getAssociationForServiceQuotaTemplateRequest) Retrieves the status of the association for the quota request template.
GetAWSDefaultServiceQuotaResult	getAWSDefaultServiceQuota(GetAWSDefaultServiceQuotaRequest getAWSDefaultServiceQuotaRequest) Retrieves the default value for the specified quota.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetRequestedServiceQuotaChangeResult	getRequestedServiceQuotaChange(GetRequestedServiceQuotaChangeRequest getRequestedServiceQuotaChangeRequest) Retrieves information about the specified quota increase request.
GetServiceQuotaResult	getServiceQuota(GetServiceQuotaRequest getServiceQuotaRequest) Retrieves the applied quota value for the specified quota.
GetServiceQuotaIncreaseRequestFromTemplateResult	getServiceQuotaIncreaseRequestFromTemplate(GetServiceQuotaIncreaseRequestFromTemplateRequest getServiceQuotaIncreaseRequestFromTemplateRequest) Retrieves information about the specified quota increase request in your quota request template.
ListAWSDefaultServiceQuotasResult	listAWSDefaultServiceQuotas(ListAWSDefaultServiceQuotasRequest listAWSDefaultServiceQuotasRequest) Lists the default values for the quotas for the specified AWS service.
ListRequestedServiceQuotaChangeHistoryResult	listRequestedServiceQuotaChangeHistory(ListRequestedServiceQuotaChangeHistoryRequest listRequestedServiceQuotaChangeHistoryRequest) Retrieves the quota increase requests for the specified service.
ListRequestedServiceQuotaChangeHistoryByQuotaResult	listRequestedServiceQuotaChangeHistoryByQuota(ListRequestedServiceQuotaChangeHistoryByQuotaRequest listRequestedServiceQuotaChangeHistoryByQuotaRequest) Retrieves the quota increase requests for the specified quota.
ListServiceQuotaIncreaseRequestsInTemplateResult	listServiceQuotaIncreaseRequestsInTemplate(ListServiceQuotaIncreaseRequestsInTemplateRequest listServiceQuotaIncreaseRequestsInTemplateRequest) Lists the quota increase requests in the specified quota request template.
ListServiceQuotasResult	listServiceQuotas(ListServiceQuotasRequest listServiceQuotasRequest) Lists the applied quota values for the specified AWS service.
ListServicesResult	listServices(ListServicesRequest listServicesRequest) Lists the names and codes for the services integrated with Service Quotas.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of the tags assigned to the specified applied quota.
PutServiceQuotaIncreaseRequestIntoTemplateResult	putServiceQuotaIncreaseRequestIntoTemplate(PutServiceQuotaIncreaseRequestIntoTemplateRequest putServiceQuotaIncreaseRequestIntoTemplateRequest) Adds a quota increase request to your quota request template.
RequestServiceQuotaIncreaseResult	requestServiceQuotaIncrease(RequestServiceQuotaIncreaseRequest requestServiceQuotaIncreaseRequest) Submits a quota increase request for the specified quota.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds tags to the specified applied quota.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from the specified applied quota.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateServiceQuotaTemplate

AssociateServiceQuotaTemplateResult associateServiceQuotaTemplate(AssociateServiceQuotaTemplateRequest associateServiceQuotaTemplateRequest)

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.

Parameters:

associateServiceQuotaTemplateRequest -

Returns:

Result of the AssociateServiceQuotaTemplate operation returned by the service.

Throws:

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 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.

See Also:

AWS API Documentation

deleteServiceQuotaIncreaseRequestFromTemplate

DeleteServiceQuotaIncreaseRequestFromTemplateResult deleteServiceQuotaIncreaseRequestFromTemplate(DeleteServiceQuotaIncreaseRequestFromTemplateRequest deleteServiceQuotaIncreaseRequestFromTemplateRequest)

Deletes the quota increase request for the specified quota from your quota request template.

Parameters:

deleteServiceQuotaIncreaseRequestFromTemplateRequest -

Returns:

Result of the DeleteServiceQuotaIncreaseRequestFromTemplate operation returned by the service.

Throws:

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 AWS Region.

NoAvailableOrganizationException - The account making this call is not a member of an organization.

See Also:

AWS API Documentation

disassociateServiceQuotaTemplate

DisassociateServiceQuotaTemplateResult disassociateServiceQuotaTemplate(DisassociateServiceQuotaTemplateRequest disassociateServiceQuotaTemplateRequest)

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.

Parameters:

disassociateServiceQuotaTemplateRequest -

Returns:

Result of the DisassociateServiceQuotaTemplate operation returned by the service.

Throws:

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 AWS Region.

NoAvailableOrganizationException - The account making this call is not a member of an organization.

See Also:

AWS API Documentation

getAWSDefaultServiceQuota

GetAWSDefaultServiceQuotaResult getAWSDefaultServiceQuota(GetAWSDefaultServiceQuotaRequest getAWSDefaultServiceQuotaRequest)

Retrieves the default value for the specified quota. The default value does not reflect any quota increases.

Parameters:

getAWSDefaultServiceQuotaRequest -

Returns:

Result of the GetAWSDefaultServiceQuota operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getAssociationForServiceQuotaTemplate

GetAssociationForServiceQuotaTemplateResult getAssociationForServiceQuotaTemplate(GetAssociationForServiceQuotaTemplateRequest getAssociationForServiceQuotaTemplateRequest)

Retrieves the status of the association for the quota request template.

Parameters:

getAssociationForServiceQuotaTemplateRequest -

Returns:

Result of the GetAssociationForServiceQuotaTemplate operation returned by the service.

Throws:

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 AWS Region.

NoAvailableOrganizationException - The account making this call is not a member of an organization.

See Also:

AWS API Documentation

getRequestedServiceQuotaChange

GetRequestedServiceQuotaChangeResult getRequestedServiceQuotaChange(GetRequestedServiceQuotaChangeRequest getRequestedServiceQuotaChangeRequest)

Retrieves information about the specified quota increase request.

Parameters:

getRequestedServiceQuotaChangeRequest -

Returns:

Result of the GetRequestedServiceQuotaChange operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getServiceQuota

GetServiceQuotaResult getServiceQuota(GetServiceQuotaRequest getServiceQuotaRequest)

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.

Parameters:

getServiceQuotaRequest -

Returns:

Result of the GetServiceQuota operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getServiceQuotaIncreaseRequestFromTemplate

GetServiceQuotaIncreaseRequestFromTemplateResult getServiceQuotaIncreaseRequestFromTemplate(GetServiceQuotaIncreaseRequestFromTemplateRequest getServiceQuotaIncreaseRequestFromTemplateRequest)

Retrieves information about the specified quota increase request in your quota request template.

Parameters:

getServiceQuotaIncreaseRequestFromTemplateRequest -

Returns:

Result of the GetServiceQuotaIncreaseRequestFromTemplate operation returned by the service.

Throws:

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 AWS Region.

NoAvailableOrganizationException - The account making this call is not a member of an organization.

See Also:

AWS API Documentation

listAWSDefaultServiceQuotas

ListAWSDefaultServiceQuotasResult listAWSDefaultServiceQuotas(ListAWSDefaultServiceQuotasRequest listAWSDefaultServiceQuotasRequest)

Lists the default values for the quotas for the specified AWS service. A default value does not reflect any quota increases.

Parameters:

listAWSDefaultServiceQuotasRequest -

Returns:

Result of the ListAWSDefaultServiceQuotas operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listRequestedServiceQuotaChangeHistory

ListRequestedServiceQuotaChangeHistoryResult listRequestedServiceQuotaChangeHistory(ListRequestedServiceQuotaChangeHistoryRequest listRequestedServiceQuotaChangeHistoryRequest)

Retrieves the quota increase requests for the specified service.

Parameters:

listRequestedServiceQuotaChangeHistoryRequest -

Returns:

Result of the ListRequestedServiceQuotaChangeHistory operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listRequestedServiceQuotaChangeHistoryByQuota

ListRequestedServiceQuotaChangeHistoryByQuotaResult listRequestedServiceQuotaChangeHistoryByQuota(ListRequestedServiceQuotaChangeHistoryByQuotaRequest listRequestedServiceQuotaChangeHistoryByQuotaRequest)

Retrieves the quota increase requests for the specified quota.

Parameters:

listRequestedServiceQuotaChangeHistoryByQuotaRequest -

Returns:

Result of the ListRequestedServiceQuotaChangeHistoryByQuota operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listServiceQuotaIncreaseRequestsInTemplate

ListServiceQuotaIncreaseRequestsInTemplateResult listServiceQuotaIncreaseRequestsInTemplate(ListServiceQuotaIncreaseRequestsInTemplateRequest listServiceQuotaIncreaseRequestsInTemplateRequest)

Lists the quota increase requests in the specified quota request template.

Parameters:

listServiceQuotaIncreaseRequestsInTemplateRequest -

Returns:

Result of the ListServiceQuotaIncreaseRequestsInTemplate operation returned by the service.

Throws:

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 AWS Region.

NoAvailableOrganizationException - The account making this call is not a member of an organization.

See Also:

AWS API Documentation

listServiceQuotas

ListServiceQuotasResult listServiceQuotas(ListServiceQuotasRequest listServiceQuotasRequest)

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.

Parameters:

listServiceQuotasRequest -

Returns:

Result of the ListServiceQuotas operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listServices

ListServicesResult listServices(ListServicesRequest listServicesRequest)

Lists the names and codes for the services integrated with Service Quotas.

Parameters:

listServicesRequest -

Returns:

Result of the ListServices operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Returns a list of the tags assigned to the specified applied quota.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

putServiceQuotaIncreaseRequestIntoTemplate

PutServiceQuotaIncreaseRequestIntoTemplateResult putServiceQuotaIncreaseRequestIntoTemplate(PutServiceQuotaIncreaseRequestIntoTemplateRequest putServiceQuotaIncreaseRequestIntoTemplateRequest)

Adds a quota increase request to your quota request template.

Parameters:

putServiceQuotaIncreaseRequestIntoTemplateRequest -

Returns:

Result of the PutServiceQuotaIncreaseRequestIntoTemplate operation returned by the service.

Throws:

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 AWS Region.

NoAvailableOrganizationException - The account making this call is not a member of an organization.

See Also:

AWS API Documentation

requestServiceQuotaIncrease

RequestServiceQuotaIncreaseResult requestServiceQuotaIncrease(RequestServiceQuotaIncreaseRequest requestServiceQuotaIncreaseRequest)

Submits a quota increase request for the specified quota.

Parameters:

requestServiceQuotaIncreaseRequest -

Returns:

Result of the RequestServiceQuotaIncrease operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds tags to the specified applied quota. You can include one or more tags to add to the quota.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from the specified applied quota. You can specify one or more tags to remove.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.