APIGateway
public struct APIGateway
Client object for interacting with AWS APIGateway service.
Amazon API Gateway Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the APIGateway 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
accessKeyId
Public access key provided by AWS
secretAccessKey
Private access key provided by AWS
sessionToken
Token provided by STS.AssumeRole() which allows access to another AWS account
region
Region of server you want to communicate with
endpoint
Custom endpoint URL to use instead of standard AWS servers
middlewares
Array of middlewares to apply to requests and responses
eventLoopGroupProvider
EventLoopGroup to use. Use
useAWSClientShared
if the client shall manage its own EventLoopGroup.
-
Create an ApiKey resource. AWS CLI
Declaration
Swift
public func createApiKey(_ input: CreateApiKeyRequest) -> EventLoopFuture<ApiKey>
-
Adds a new Authorizer resource to an existing RestApi resource. AWS CLI
Declaration
Swift
public func createAuthorizer(_ input: CreateAuthorizerRequest) -> EventLoopFuture<Authorizer>
-
Creates a new BasePathMapping resource.
Declaration
Swift
public func createBasePathMapping(_ input: CreateBasePathMappingRequest) -> EventLoopFuture<BasePathMapping>
-
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
Declaration
Swift
public func createDeployment(_ input: CreateDeploymentRequest) -> EventLoopFuture<Deployment>
-
Undocumented
Declaration
Swift
public func createDocumentationPart(_ input: CreateDocumentationPartRequest) -> EventLoopFuture<DocumentationPart>
-
Undocumented
Declaration
Swift
public func createDocumentationVersion(_ input: CreateDocumentationVersionRequest) -> EventLoopFuture<DocumentationVersion>
-
Creates a new domain name.
Declaration
Swift
public func createDomainName(_ input: CreateDomainNameRequest) -> EventLoopFuture<DomainName>
-
Adds a new Model resource to an existing RestApi resource.
Declaration
Swift
public func createModel(_ input: CreateModelRequest) -> EventLoopFuture<Model>
-
Creates a ReqeustValidator of a given RestApi.
Declaration
Swift
public func createRequestValidator(_ input: CreateRequestValidatorRequest) -> EventLoopFuture<RequestValidator>
-
Creates a Resource resource.
Declaration
Swift
public func createResource(_ input: CreateResourceRequest) -> EventLoopFuture<Resource>
-
Creates a new RestApi resource.
Declaration
Swift
public func createRestApi(_ input: CreateRestApiRequest) -> EventLoopFuture<RestApi>
-
Creates a new Stage resource that references a pre-existing Deployment for the API.
Declaration
Swift
public func createStage(_ input: CreateStageRequest) -> EventLoopFuture<Stage>
-
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
Declaration
Swift
public func createUsagePlan(_ input: CreateUsagePlanRequest) -> EventLoopFuture<UsagePlan>
-
Creates a usage plan key for adding an existing API key to a usage plan.
Declaration
Swift
public func createUsagePlanKey(_ input: CreateUsagePlanKeyRequest) -> EventLoopFuture<UsagePlanKey>
-
Creates a VPC link, under the caller’s account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.
Declaration
Swift
public func createVpcLink(_ input: CreateVpcLinkRequest) -> EventLoopFuture<VpcLink>
-
Deletes the ApiKey resource.
Declaration
Swift
@discardableResult public func deleteApiKey(_ input: DeleteApiKeyRequest) -> EventLoopFuture<Void>
-
Deletes an existing Authorizer resource. AWS CLI
Declaration
Swift
@discardableResult public func deleteAuthorizer(_ input: DeleteAuthorizerRequest) -> EventLoopFuture<Void>
-
Deletes the BasePathMapping resource.
Declaration
Swift
@discardableResult public func deleteBasePathMapping(_ input: DeleteBasePathMappingRequest) -> EventLoopFuture<Void>
-
Deletes the ClientCertificate resource.
Declaration
Swift
@discardableResult public func deleteClientCertificate(_ input: DeleteClientCertificateRequest) -> EventLoopFuture<Void>
-
Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.
Declaration
Swift
@discardableResult public func deleteDeployment(_ input: DeleteDeploymentRequest) -> EventLoopFuture<Void>
-
Undocumented
Declaration
Swift
@discardableResult public func deleteDocumentationPart(_ input: DeleteDocumentationPartRequest) -> EventLoopFuture<Void>
-
Undocumented
Declaration
Swift
@discardableResult public func deleteDocumentationVersion(_ input: DeleteDocumentationVersionRequest) -> EventLoopFuture<Void>
-
Deletes the DomainName resource.
Declaration
Swift
@discardableResult public func deleteDomainName(_ input: DeleteDomainNameRequest) -> EventLoopFuture<Void>
-
Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.
Declaration
Swift
@discardableResult public func deleteGatewayResponse(_ input: DeleteGatewayResponseRequest) -> EventLoopFuture<Void>
-
Represents a delete integration.
Declaration
Swift
@discardableResult public func deleteIntegration(_ input: DeleteIntegrationRequest) -> EventLoopFuture<Void>
-
Represents a delete integration response.
Declaration
Swift
@discardableResult public func deleteIntegrationResponse(_ input: DeleteIntegrationResponseRequest) -> EventLoopFuture<Void>
-
Deletes an existing Method resource.
Declaration
Swift
@discardableResult public func deleteMethod(_ input: DeleteMethodRequest) -> EventLoopFuture<Void>
-
Deletes an existing MethodResponse resource.
Declaration
Swift
@discardableResult public func deleteMethodResponse(_ input: DeleteMethodResponseRequest) -> EventLoopFuture<Void>
-
Deletes a model.
Declaration
Swift
@discardableResult public func deleteModel(_ input: DeleteModelRequest) -> EventLoopFuture<Void>
-
Deletes a RequestValidator of a given RestApi.
Declaration
Swift
@discardableResult public func deleteRequestValidator(_ input: DeleteRequestValidatorRequest) -> EventLoopFuture<Void>
-
Deletes a Resource resource.
Declaration
Swift
@discardableResult public func deleteResource(_ input: DeleteResourceRequest) -> EventLoopFuture<Void>
-
Deletes the specified API.
Declaration
Swift
@discardableResult public func deleteRestApi(_ input: DeleteRestApiRequest) -> EventLoopFuture<Void>
-
Deletes a Stage resource.
Declaration
Swift
@discardableResult public func deleteStage(_ input: DeleteStageRequest) -> EventLoopFuture<Void>
-
Deletes a usage plan of a given plan Id.
Declaration
Swift
@discardableResult public func deleteUsagePlan(_ input: DeleteUsagePlanRequest) -> EventLoopFuture<Void>
-
Deletes a usage plan key and remove the underlying API key from the associated usage plan.
Declaration
Swift
@discardableResult public func deleteUsagePlanKey(_ input: DeleteUsagePlanKeyRequest) -> EventLoopFuture<Void>
-
Deletes an existing VpcLink of a specified identifier.
Declaration
Swift
@discardableResult public func deleteVpcLink(_ input: DeleteVpcLinkRequest) -> EventLoopFuture<Void>
-
Flushes all authorizer cache entries on a stage.
Declaration
Swift
@discardableResult public func flushStageAuthorizersCache(_ input: FlushStageAuthorizersCacheRequest) -> EventLoopFuture<Void>
-
Flushes a stage’s cache.
Declaration
Swift
@discardableResult public func flushStageCache(_ input: FlushStageCacheRequest) -> EventLoopFuture<Void>
-
Generates a ClientCertificate resource.
Declaration
Swift
public func generateClientCertificate(_ input: GenerateClientCertificateRequest) -> EventLoopFuture<ClientCertificate>
-
Gets information about the current Account resource.
Declaration
Swift
public func getAccount(_ input: GetAccountRequest) -> EventLoopFuture<Account>
-
Gets information about the current ApiKey resource.
Declaration
Swift
public func getApiKey(_ input: GetApiKeyRequest) -> EventLoopFuture<ApiKey>
-
Gets information about the current ApiKeys resource.
Declaration
Swift
public func getApiKeys(_ input: GetApiKeysRequest) -> EventLoopFuture<ApiKeys>
-
Describe an existing Authorizer resource. AWS CLI
Declaration
Swift
public func getAuthorizer(_ input: GetAuthorizerRequest) -> EventLoopFuture<Authorizer>
-
Describe an existing Authorizers resource. AWS CLI
Declaration
Swift
public func getAuthorizers(_ input: GetAuthorizersRequest) -> EventLoopFuture<Authorizers>
-
Describe a BasePathMapping resource.
Declaration
Swift
public func getBasePathMapping(_ input: GetBasePathMappingRequest) -> EventLoopFuture<BasePathMapping>
-
Represents a collection of BasePathMapping resources.
Declaration
Swift
public func getBasePathMappings(_ input: GetBasePathMappingsRequest) -> EventLoopFuture<BasePathMappings>
-
Gets information about the current ClientCertificate resource.
Declaration
Swift
public func getClientCertificate(_ input: GetClientCertificateRequest) -> EventLoopFuture<ClientCertificate>
-
Gets a collection of ClientCertificate resources.
Declaration
Swift
public func getClientCertificates(_ input: GetClientCertificatesRequest) -> EventLoopFuture<ClientCertificates>
-
Gets information about a Deployment resource.
Declaration
Swift
public func getDeployment(_ input: GetDeploymentRequest) -> EventLoopFuture<Deployment>
-
Gets information about a Deployments collection.
Declaration
Swift
public func getDeployments(_ input: GetDeploymentsRequest) -> EventLoopFuture<Deployments>
-
Undocumented
Declaration
Swift
public func getDocumentationPart(_ input: GetDocumentationPartRequest) -> EventLoopFuture<DocumentationPart>
-
Undocumented
Declaration
Swift
public func getDocumentationParts(_ input: GetDocumentationPartsRequest) -> EventLoopFuture<DocumentationParts>
-
Undocumented
Declaration
Swift
public func getDocumentationVersion(_ input: GetDocumentationVersionRequest) -> EventLoopFuture<DocumentationVersion>
-
Undocumented
Declaration
Swift
public func getDocumentationVersions(_ input: GetDocumentationVersionsRequest) -> EventLoopFuture<DocumentationVersions>
-
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
Declaration
Swift
public func getDomainName(_ input: GetDomainNameRequest) -> EventLoopFuture<DomainName>
-
Represents a collection of DomainName resources.
Declaration
Swift
public func getDomainNames(_ input: GetDomainNamesRequest) -> EventLoopFuture<DomainNames>
-
Exports a deployed version of a RestApi in a specified format.
Declaration
Swift
public func getExport(_ input: GetExportRequest) -> EventLoopFuture<ExportResponse>
-
Gets a GatewayResponse of a specified response type on the given RestApi.
Declaration
Swift
public func getGatewayResponse(_ input: GetGatewayResponseRequest) -> EventLoopFuture<GatewayResponse>
-
Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.
Declaration
Swift
public func getGatewayResponses(_ input: GetGatewayResponsesRequest) -> EventLoopFuture<GatewayResponses>
-
Get the integration settings.
Declaration
Swift
public func getIntegration(_ input: GetIntegrationRequest) -> EventLoopFuture<Integration>
-
Represents a get integration response.
Declaration
Swift
public func getIntegrationResponse(_ input: GetIntegrationResponseRequest) -> EventLoopFuture<IntegrationResponse>
-
Describe an existing Method resource.
Declaration
Swift
public func getMethod(_ input: GetMethodRequest) -> EventLoopFuture<Method>
-
Describes a MethodResponse resource.
Declaration
Swift
public func getMethodResponse(_ input: GetMethodResponseRequest) -> EventLoopFuture<MethodResponse>
-
Describes an existing model defined for a RestApi resource.
Declaration
Swift
public func getModel(_ input: GetModelRequest) -> EventLoopFuture<Model>
-
Generates a sample mapping template that can be used to transform a payload into the structure of a model.
Declaration
Swift
public func getModelTemplate(_ input: GetModelTemplateRequest) -> EventLoopFuture<Template>
-
Describes existing Models defined for a RestApi resource.
Declaration
Swift
public func getModels(_ input: GetModelsRequest) -> EventLoopFuture<Models>
-
Gets a RequestValidator of a given RestApi.
Declaration
Swift
public func getRequestValidator(_ input: GetRequestValidatorRequest) -> EventLoopFuture<RequestValidator>
-
Gets the RequestValidators collection of a given RestApi.
Declaration
Swift
public func getRequestValidators(_ input: GetRequestValidatorsRequest) -> EventLoopFuture<RequestValidators>
-
Lists information about a resource.
Declaration
Swift
public func getResource(_ input: GetResourceRequest) -> EventLoopFuture<Resource>
-
Lists information about a collection of Resource resources.
Declaration
Swift
public func getResources(_ input: GetResourcesRequest) -> EventLoopFuture<Resources>
-
Lists the RestApi resource in the collection.
Declaration
Swift
public func getRestApi(_ input: GetRestApiRequest) -> EventLoopFuture<RestApi>
-
Lists the RestApis resources for your collection.
Declaration
Swift
public func getRestApis(_ input: GetRestApisRequest) -> EventLoopFuture<RestApis>
-
Generates a client SDK for a RestApi and Stage.
Declaration
Swift
public func getSdk(_ input: GetSdkRequest) -> EventLoopFuture<SdkResponse>
-
Undocumented
Declaration
Swift
public func getSdkType(_ input: GetSdkTypeRequest) -> EventLoopFuture<SdkType>
-
Undocumented
Declaration
Swift
public func getSdkTypes(_ input: GetSdkTypesRequest) -> EventLoopFuture<SdkTypes>
-
Gets information about a Stage resource.
Declaration
Swift
public func getStage(_ input: GetStageRequest) -> EventLoopFuture<Stage>
-
Gets information about one or more Stage resources.
Declaration
Swift
public func getStages(_ input: GetStagesRequest) -> EventLoopFuture<Stages>
-
Gets the Tags collection for a given resource.
Declaration
Swift
public func getTags(_ input: GetTagsRequest) -> EventLoopFuture<Tags>
-
Gets the usage data of a usage plan in a specified time interval.
Declaration
Swift
public func getUsage(_ input: GetUsageRequest) -> EventLoopFuture<Usage>
-
Gets a usage plan of a given plan identifier.
Declaration
Swift
public func getUsagePlan(_ input: GetUsagePlanRequest) -> EventLoopFuture<UsagePlan>
-
Gets a usage plan key of a given key identifier.
Declaration
Swift
public func getUsagePlanKey(_ input: GetUsagePlanKeyRequest) -> EventLoopFuture<UsagePlanKey>
-
Gets all the usage plan keys representing the API keys added to a specified usage plan.
Declaration
Swift
public func getUsagePlanKeys(_ input: GetUsagePlanKeysRequest) -> EventLoopFuture<UsagePlanKeys>
-
Gets all the usage plans of the caller’s account.
Declaration
Swift
public func getUsagePlans(_ input: GetUsagePlansRequest) -> EventLoopFuture<UsagePlans>
-
Gets a specified VPC link under the caller’s account in a region.
Declaration
Swift
public func getVpcLink(_ input: GetVpcLinkRequest) -> EventLoopFuture<VpcLink>
-
Gets the VpcLinks collection under the caller’s account in a selected region.
Declaration
Swift
public func getVpcLinks(_ input: GetVpcLinksRequest) -> EventLoopFuture<VpcLinks>
-
Import API keys from an external source, such as a CSV-formatted file.
Declaration
Swift
public func importApiKeys(_ input: ImportApiKeysRequest) -> EventLoopFuture<ApiKeyIds>
-
Undocumented
Declaration
Swift
public func importDocumentationParts(_ input: ImportDocumentationPartsRequest) -> EventLoopFuture<DocumentationPartIds>
-
A feature of the API Gateway control service for creating a new API from an external API definition file.
Declaration
Swift
public func importRestApi(_ input: ImportRestApiRequest) -> EventLoopFuture<RestApi>
-
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
Declaration
Swift
public func putGatewayResponse(_ input: PutGatewayResponseRequest) -> EventLoopFuture<GatewayResponse>
-
Sets up a method’s integration.
Declaration
Swift
public func putIntegration(_ input: PutIntegrationRequest) -> EventLoopFuture<Integration>
-
Represents a put integration.
Declaration
Swift
public func putIntegrationResponse(_ input: PutIntegrationResponseRequest) -> EventLoopFuture<IntegrationResponse>
-
Add a method to an existing Resource resource.
Declaration
Swift
public func putMethod(_ input: PutMethodRequest) -> EventLoopFuture<Method>
-
Adds a MethodResponse to an existing Method resource.
Declaration
Swift
public func putMethodResponse(_ input: PutMethodResponseRequest) -> EventLoopFuture<MethodResponse>
-
A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.
Declaration
Swift
public func putRestApi(_ input: PutRestApiRequest) -> EventLoopFuture<RestApi>
-
Adds or updates a tag on a given resource.
Declaration
Swift
@discardableResult public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<Void>
-
Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body. Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer
Declaration
Swift
public func testInvokeAuthorizer(_ input: TestInvokeAuthorizerRequest) -> EventLoopFuture<TestInvokeAuthorizerResponse>
-
Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.
Declaration
Swift
public func testInvokeMethod(_ input: TestInvokeMethodRequest) -> EventLoopFuture<TestInvokeMethodResponse>
-
Removes a tag from a given resource.
Declaration
Swift
@discardableResult public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<Void>
-
Changes information about the current Account resource.
Declaration
Swift
public func updateAccount(_ input: UpdateAccountRequest) -> EventLoopFuture<Account>
-
Changes information about an ApiKey resource.
Declaration
Swift
public func updateApiKey(_ input: UpdateApiKeyRequest) -> EventLoopFuture<ApiKey>
-
Updates an existing Authorizer resource. AWS CLI
Declaration
Swift
public func updateAuthorizer(_ input: UpdateAuthorizerRequest) -> EventLoopFuture<Authorizer>
-
Changes information about the BasePathMapping resource.
Declaration
Swift
public func updateBasePathMapping(_ input: UpdateBasePathMappingRequest) -> EventLoopFuture<BasePathMapping>
-
Changes information about an ClientCertificate resource.
Declaration
Swift
public func updateClientCertificate(_ input: UpdateClientCertificateRequest) -> EventLoopFuture<ClientCertificate>
-
Changes information about a Deployment resource.
Declaration
Swift
public func updateDeployment(_ input: UpdateDeploymentRequest) -> EventLoopFuture<Deployment>
-
Undocumented
Declaration
Swift
public func updateDocumentationPart(_ input: UpdateDocumentationPartRequest) -> EventLoopFuture<DocumentationPart>
-
Undocumented
Declaration
Swift
public func updateDocumentationVersion(_ input: UpdateDocumentationVersionRequest) -> EventLoopFuture<DocumentationVersion>
-
Changes information about the DomainName resource.
Declaration
Swift
public func updateDomainName(_ input: UpdateDomainNameRequest) -> EventLoopFuture<DomainName>
-
Updates a GatewayResponse of a specified response type on the given RestApi.
Declaration
Swift
public func updateGatewayResponse(_ input: UpdateGatewayResponseRequest) -> EventLoopFuture<GatewayResponse>
-
Represents an update integration.
Declaration
Swift
public func updateIntegration(_ input: UpdateIntegrationRequest) -> EventLoopFuture<Integration>
-
Represents an update integration response.
Declaration
Swift
public func updateIntegrationResponse(_ input: UpdateIntegrationResponseRequest) -> EventLoopFuture<IntegrationResponse>
-
Updates an existing Method resource.
Declaration
Swift
public func updateMethod(_ input: UpdateMethodRequest) -> EventLoopFuture<Method>
-
Updates an existing MethodResponse resource.
Declaration
Swift
public func updateMethodResponse(_ input: UpdateMethodResponseRequest) -> EventLoopFuture<MethodResponse>
-
Changes information about a model.
Declaration
Swift
public func updateModel(_ input: UpdateModelRequest) -> EventLoopFuture<Model>
-
Updates a RequestValidator of a given RestApi.
Declaration
Swift
public func updateRequestValidator(_ input: UpdateRequestValidatorRequest) -> EventLoopFuture<RequestValidator>
-
Changes information about a Resource resource.
Declaration
Swift
public func updateResource(_ input: UpdateResourceRequest) -> EventLoopFuture<Resource>
-
Changes information about the specified API.
Declaration
Swift
public func updateRestApi(_ input: UpdateRestApiRequest) -> EventLoopFuture<RestApi>
-
Changes information about a Stage resource.
Declaration
Swift
public func updateStage(_ input: UpdateStageRequest) -> EventLoopFuture<Stage>
-
Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.
Declaration
Swift
public func updateUsage(_ input: UpdateUsageRequest) -> EventLoopFuture<Usage>
-
Updates a usage plan of a given plan Id.
Declaration
Swift
public func updateUsagePlan(_ input: UpdateUsagePlanRequest) -> EventLoopFuture<UsagePlan>
-
Updates an existing VpcLink of a specified identifier.
Declaration
Swift
public func updateVpcLink(_ input: UpdateVpcLinkRequest) -> EventLoopFuture<VpcLink>
-
Gets information about the current ApiKeys resource.
Declaration
Swift
public func getApiKeysPaginator(_ input: GetApiKeysRequest, onPage: @escaping (ApiKeys, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Represents a collection of BasePathMapping resources.
Declaration
Swift
public func getBasePathMappingsPaginator(_ input: GetBasePathMappingsRequest, onPage: @escaping (BasePathMappings, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Gets a collection of ClientCertificate resources.
Declaration
Swift
public func getClientCertificatesPaginator(_ input: GetClientCertificatesRequest, onPage: @escaping (ClientCertificates, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Gets information about a Deployments collection.
Declaration
Swift
public func getDeploymentsPaginator(_ input: GetDeploymentsRequest, onPage: @escaping (Deployments, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Represents a collection of DomainName resources.
Declaration
Swift
public func getDomainNamesPaginator(_ input: GetDomainNamesRequest, onPage: @escaping (DomainNames, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Describes existing Models defined for a RestApi resource.
Declaration
Swift
public func getModelsPaginator(_ input: GetModelsRequest, onPage: @escaping (Models, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists information about a collection of Resource resources.
Declaration
Swift
public func getResourcesPaginator(_ input: GetResourcesRequest, onPage: @escaping (Resources, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Lists the RestApis resources for your collection.
Declaration
Swift
public func getRestApisPaginator(_ input: GetRestApisRequest, onPage: @escaping (RestApis, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Gets the usage data of a usage plan in a specified time interval.
Declaration
Swift
public func getUsagePaginator(_ input: GetUsageRequest, onPage: @escaping (Usage, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Gets all the usage plan keys representing the API keys added to a specified usage plan.
Declaration
Swift
public func getUsagePlanKeysPaginator(_ input: GetUsagePlanKeysRequest, onPage: @escaping (UsagePlanKeys, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Gets all the usage plans of the caller’s account.
Declaration
Swift
public func getUsagePlansPaginator(_ input: GetUsagePlansRequest, onPage: @escaping (UsagePlans, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Gets the VpcLinks collection under the caller’s account in a selected region.
Declaration
Swift
public func getVpcLinksPaginator(_ input: GetVpcLinksRequest, onPage: @escaping (VpcLinks, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>
-
Undocumented
See moreDeclaration
Swift
public struct GetApiKeysRequest : AWSShape
extension APIGateway.GetApiKeysRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetBasePathMappingsRequest : AWSShape
extension APIGateway.GetBasePathMappingsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetClientCertificatesRequest : AWSShape
extension APIGateway.GetClientCertificatesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetDeploymentsRequest : AWSShape
extension APIGateway.GetDeploymentsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetDomainNamesRequest : AWSShape
extension APIGateway.GetDomainNamesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetModelsRequest : AWSShape
extension APIGateway.GetModelsRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetResourcesRequest : AWSShape
extension APIGateway.GetResourcesRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetRestApisRequest : AWSShape
extension APIGateway.GetRestApisRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetUsageRequest : AWSShape
extension APIGateway.GetUsageRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetUsagePlanKeysRequest : AWSShape
extension APIGateway.GetUsagePlanKeysRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetUsagePlansRequest : AWSShape
extension APIGateway.GetUsagePlansRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public struct GetVpcLinksRequest : AWSShape
extension APIGateway.GetVpcLinksRequest: AWSPaginateStringToken
-
Undocumented
See moreDeclaration
Swift
public enum ApiKeySourceType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ApiKeysFormat : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum AuthorizerType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum CacheClusterSize : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum CacheClusterStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ConnectionType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ContentHandlingStrategy : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum DocumentationPartType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum DomainNameStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum EndpointType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum GatewayResponseType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum IntegrationType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum LocationStatusType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum Op : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum PutMode : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum QuotaPeriodType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SecurityPolicy : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum UnauthorizedCacheControlHeaderStrategy : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum VpcLinkStatus : String, CustomStringConvertible, Codable