View on GitHub
ServiceQuotas Structure Reference
ServiceQuotas
public struct ServiceQuotasClient object for interacting with AWS ServiceQuotas service.
Service Quotas is a web service that you can use to manage many of your AWS service quotas. Quotas, also referred to as limits, are the maximum values for a resource, item, or operation. This guide provide descriptions of the Service Quotas actions that you can call from an API. For the Service Quotas user guide, which explains how to use Service Quotas from the console, see What is Service Quotas. AWS provides SDKs that consist of libraries and sample code for programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc…,). The SDKs provide a convenient way to create programmatic access to Service Quotas and AWS. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the ServiceQuotas client
Declaration
Swift
public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)Parameters
accessKeyIdPublic access key provided by AWS
secretAccessKeyPrivate access key provided by AWS
sessionTokenToken provided by STS.AssumeRole() which allows access to another AWS account
regionRegion of server you want to communicate with
endpointCustom endpoint URL to use instead of standard AWS servers
middlewaresArray of middlewares to apply to requests and responses
eventLoopGroupProviderEventLoopGroup to use. Use
useAWSClientSharedif the client shall manage its own EventLoopGroup.
-
Associates the Service Quotas template with your organization so that when new accounts are created in your organization, the template submits increase requests for the specified service quotas. Use the Service Quotas template to request an increase for any adjustable quota value. After you define the Service Quotas template, use this operation to associate, or enable, the template.
Declaration
Swift
public func associateServiceQuotaTemplate(_ input: AssociateServiceQuotaTemplateRequest) -> EventLoopFuture<AssociateServiceQuotaTemplateResponse> -
Removes a service quota increase request from the Service Quotas template.
Declaration
Swift
public func deleteServiceQuotaIncreaseRequestFromTemplate(_ input: DeleteServiceQuotaIncreaseRequestFromTemplateRequest) -> EventLoopFuture<DeleteServiceQuotaIncreaseRequestFromTemplateResponse> -
Disables the Service Quotas template. Once the template is disabled, it does not request quota increases for new accounts in your organization. Disabling the quota template does not apply the quota increase requests from the template. Related operations To enable the quota template, call AssociateServiceQuotaTemplate. To delete a specific service quota from the template, use DeleteServiceQuotaIncreaseRequestFromTemplate.
Declaration
Swift
public func disassociateServiceQuotaTemplate(_ input: DisassociateServiceQuotaTemplateRequest) -> EventLoopFuture<DisassociateServiceQuotaTemplateResponse> -
Retrieves the default service quotas values. The Value returned for each quota is the AWS default value, even if the quotas have been increased..
Declaration
Swift
public func getAWSDefaultServiceQuota(_ input: GetAWSDefaultServiceQuotaRequest) -> EventLoopFuture<GetAWSDefaultServiceQuotaResponse> -
Retrieves the ServiceQuotaTemplateAssociationStatus value from the service. Use this action to determine if the Service Quota template is associated, or enabled.
Declaration
Swift
public func getAssociationForServiceQuotaTemplate(_ input: GetAssociationForServiceQuotaTemplateRequest) -> EventLoopFuture<GetAssociationForServiceQuotaTemplateResponse> -
Retrieves the details for a particular increase request.
Declaration
Swift
public func getRequestedServiceQuotaChange(_ input: GetRequestedServiceQuotaChangeRequest) -> EventLoopFuture<GetRequestedServiceQuotaChangeResponse> -
Returns the details for the specified service quota. This operation provides a different Value than the GetAWSDefaultServiceQuota operation. This operation returns the applied value for each quota. GetAWSDefaultServiceQuota returns the default AWS value for each quota.
Declaration
Swift
public func getServiceQuota(_ input: GetServiceQuotaRequest) -> EventLoopFuture<GetServiceQuotaResponse> -
Returns the details of the service quota increase request in your template.
Declaration
Swift
public func getServiceQuotaIncreaseRequestFromTemplate(_ input: GetServiceQuotaIncreaseRequestFromTemplateRequest) -> EventLoopFuture<GetServiceQuotaIncreaseRequestFromTemplateResponse> -
Lists all default service quotas for the specified AWS service or all AWS services. ListAWSDefaultServiceQuotas is similar to ListServiceQuotas except for the Value object. The Value object returned by ListAWSDefaultServiceQuotas is the default value assigned by AWS. This request returns a list of all service quotas for the specified service. The listing of each you’ll see the default values are the values that AWS provides for the quotas. Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.
Declaration
Swift
public func listAWSDefaultServiceQuotas(_ input: ListAWSDefaultServiceQuotasRequest) -> EventLoopFuture<ListAWSDefaultServiceQuotasResponse> -
Requests a list of the changes to quotas for a service.
Declaration
Swift
public func listRequestedServiceQuotaChangeHistory(_ input: ListRequestedServiceQuotaChangeHistoryRequest) -> EventLoopFuture<ListRequestedServiceQuotaChangeHistoryResponse> -
Requests a list of the changes to specific service quotas. This command provides additional granularity over the ListRequestedServiceQuotaChangeHistory command. Once a quota change request has reached CASE_CLOSED, APPROVED, or DENIED, the history has been kept for 90 days.
Declaration
Swift
public func listRequestedServiceQuotaChangeHistoryByQuota(_ input: ListRequestedServiceQuotaChangeHistoryByQuotaRequest) -> EventLoopFuture<ListRequestedServiceQuotaChangeHistoryByQuotaResponse> -
Returns a list of the quota increase requests in the template.
Declaration
Swift
public func listServiceQuotaIncreaseRequestsInTemplate(_ input: ListServiceQuotaIncreaseRequestsInTemplateRequest) -> EventLoopFuture<ListServiceQuotaIncreaseRequestsInTemplateResponse> -
Lists all service quotas for the specified AWS service. This request returns a list of the service quotas for the specified service. you’ll see the default values are the values that AWS provides for the quotas. Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.
Declaration
Swift
public func listServiceQuotas(_ input: ListServiceQuotasRequest) -> EventLoopFuture<ListServiceQuotasResponse> -
Lists the AWS services available in Service Quotas. Not all AWS services are available in Service Quotas. To list the see the list of the service quotas for a specific service, use ListServiceQuotas.
Declaration
Swift
public func listServices(_ input: ListServicesRequest) -> EventLoopFuture<ListServicesResponse> -
Defines and adds a quota to the service quota template. To add a quota to the template, you must provide the ServiceCode, QuotaCode, AwsRegion, and DesiredValue. Once you add a quota to the template, use ListServiceQuotaIncreaseRequestsInTemplate to see the list of quotas in the template.
Declaration
Swift
public func putServiceQuotaIncreaseRequestIntoTemplate(_ input: PutServiceQuotaIncreaseRequestIntoTemplateRequest) -> EventLoopFuture<PutServiceQuotaIncreaseRequestIntoTemplateResponse> -
Retrieves the details of a service quota increase request. The response to this command provides the details in the RequestedServiceQuotaChange object.
Declaration
Swift
public func requestServiceQuotaIncrease(_ input: RequestServiceQuotaIncreaseRequest) -> EventLoopFuture<RequestServiceQuotaIncreaseResponse>
-
Lists all default service quotas for the specified AWS service or all AWS services. ListAWSDefaultServiceQuotas is similar to ListServiceQuotas except for the Value object. The Value object returned by ListAWSDefaultServiceQuotas is the default value assigned by AWS. This request returns a list of all service quotas for the specified service. The listing of each you’ll see the default values are the values that AWS provides for the quotas. Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.
Declaration
Swift
public func listAWSDefaultServiceQuotasPaginator(_ input: ListAWSDefaultServiceQuotasRequest, onPage: @escaping (ListAWSDefaultServiceQuotasResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Requests a list of the changes to quotas for a service.
Declaration
Swift
public func listRequestedServiceQuotaChangeHistoryPaginator(_ input: ListRequestedServiceQuotaChangeHistoryRequest, onPage: @escaping (ListRequestedServiceQuotaChangeHistoryResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Requests a list of the changes to specific service quotas. This command provides additional granularity over the ListRequestedServiceQuotaChangeHistory command. Once a quota change request has reached CASE_CLOSED, APPROVED, or DENIED, the history has been kept for 90 days.
Declaration
Swift
public func listRequestedServiceQuotaChangeHistoryByQuotaPaginator(_ input: ListRequestedServiceQuotaChangeHistoryByQuotaRequest, onPage: @escaping (ListRequestedServiceQuotaChangeHistoryByQuotaResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Returns a list of the quota increase requests in the template.
Declaration
Swift
public func listServiceQuotaIncreaseRequestsInTemplatePaginator(_ input: ListServiceQuotaIncreaseRequestsInTemplateRequest, onPage: @escaping (ListServiceQuotaIncreaseRequestsInTemplateResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists all service quotas for the specified AWS service. This request returns a list of the service quotas for the specified service. you’ll see the default values are the values that AWS provides for the quotas. Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.
Declaration
Swift
public func listServiceQuotasPaginator(_ input: ListServiceQuotasRequest, onPage: @escaping (ListServiceQuotasResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void> -
Lists the AWS services available in Service Quotas. Not all AWS services are available in Service Quotas. To list the see the list of the service quotas for a specific service, use ListServiceQuotas.
Declaration
Swift
public func listServicesPaginator(_ input: ListServicesRequest, onPage: @escaping (ListServicesResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct ListAWSDefaultServiceQuotasRequest : AWSShapeextension ServiceQuotas.ListAWSDefaultServiceQuotasRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListRequestedServiceQuotaChangeHistoryRequest : AWSShapeextension ServiceQuotas.ListRequestedServiceQuotaChangeHistoryRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListRequestedServiceQuotaChangeHistoryByQuotaRequest : AWSShapeextension ServiceQuotas.ListRequestedServiceQuotaChangeHistoryByQuotaRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListServiceQuotaIncreaseRequestsInTemplateRequest : AWSShapeextension ServiceQuotas.ListServiceQuotaIncreaseRequestsInTemplateRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListServiceQuotasRequest : AWSShapeextension ServiceQuotas.ListServiceQuotasRequest: AWSPaginateStringToken -
Undocumented
See moreDeclaration
Swift
public struct ListServicesRequest : AWSShapeextension ServiceQuotas.ListServicesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum ErrorCode : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum PeriodUnit : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum RequestStatus : String, CustomStringConvertible, Codable -
Undocumented
See moreDeclaration
Swift
public enum ServiceQuotaTemplateAssociationStatus : String, CustomStringConvertible, Codable