ApiGatewayV2
public struct ApiGatewayV2
Client object for interacting with AWS ApiGatewayV2 service.
Amazon API Gateway V2
-
Undocumented
Declaration
Swift
public let client: AWSClient
-
Initialize the ApiGatewayV2 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.
-
Creates an Api resource.
Declaration
Swift
public func createApi(_ input: CreateApiRequest) -> EventLoopFuture<CreateApiResponse>
-
Creates an API mapping.
Declaration
Swift
public func createApiMapping(_ input: CreateApiMappingRequest) -> EventLoopFuture<CreateApiMappingResponse>
-
Creates an Authorizer for an API.
Declaration
Swift
public func createAuthorizer(_ input: CreateAuthorizerRequest) -> EventLoopFuture<CreateAuthorizerResponse>
-
Creates a Deployment for an API.
Declaration
Swift
public func createDeployment(_ input: CreateDeploymentRequest) -> EventLoopFuture<CreateDeploymentResponse>
-
Creates a domain name.
Declaration
Swift
public func createDomainName(_ input: CreateDomainNameRequest) -> EventLoopFuture<CreateDomainNameResponse>
-
Creates an Integration.
Declaration
Swift
public func createIntegration(_ input: CreateIntegrationRequest) -> EventLoopFuture<CreateIntegrationResult>
-
Creates an IntegrationResponses.
Declaration
Swift
public func createIntegrationResponse(_ input: CreateIntegrationResponseRequest) -> EventLoopFuture<CreateIntegrationResponseResponse>
-
Creates a Model for an API.
Declaration
Swift
public func createModel(_ input: CreateModelRequest) -> EventLoopFuture<CreateModelResponse>
-
Creates a Route for an API.
Declaration
Swift
public func createRoute(_ input: CreateRouteRequest) -> EventLoopFuture<CreateRouteResult>
-
Creates a RouteResponse for a Route.
Declaration
Swift
public func createRouteResponse(_ input: CreateRouteResponseRequest) -> EventLoopFuture<CreateRouteResponseResponse>
-
Creates a Stage for an API.
Declaration
Swift
public func createStage(_ input: CreateStageRequest) -> EventLoopFuture<CreateStageResponse>
-
Creates a VPC link.
Declaration
Swift
public func createVpcLink(_ input: CreateVpcLinkRequest) -> EventLoopFuture<CreateVpcLinkResponse>
-
Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.
Declaration
Swift
@discardableResult public func deleteAccessLogSettings(_ input: DeleteAccessLogSettingsRequest) -> EventLoopFuture<Void>
-
Deletes an Api resource.
Declaration
Swift
@discardableResult public func deleteApi(_ input: DeleteApiRequest) -> EventLoopFuture<Void>
-
Deletes an API mapping.
Declaration
Swift
@discardableResult public func deleteApiMapping(_ input: DeleteApiMappingRequest) -> EventLoopFuture<Void>
-
Deletes an Authorizer.
Declaration
Swift
@discardableResult public func deleteAuthorizer(_ input: DeleteAuthorizerRequest) -> EventLoopFuture<Void>
-
Deletes a CORS configuration.
Declaration
Swift
@discardableResult public func deleteCorsConfiguration(_ input: DeleteCorsConfigurationRequest) -> EventLoopFuture<Void>
-
Deletes a Deployment.
Declaration
Swift
@discardableResult public func deleteDeployment(_ input: DeleteDeploymentRequest) -> EventLoopFuture<Void>
-
Deletes a domain name.
Declaration
Swift
@discardableResult public func deleteDomainName(_ input: DeleteDomainNameRequest) -> EventLoopFuture<Void>
-
Deletes an Integration.
Declaration
Swift
@discardableResult public func deleteIntegration(_ input: DeleteIntegrationRequest) -> EventLoopFuture<Void>
-
Deletes an IntegrationResponses.
Declaration
Swift
@discardableResult public func deleteIntegrationResponse(_ input: DeleteIntegrationResponseRequest) -> EventLoopFuture<Void>
-
Deletes a Model.
Declaration
Swift
@discardableResult public func deleteModel(_ input: DeleteModelRequest) -> EventLoopFuture<Void>
-
Deletes a Route.
Declaration
Swift
@discardableResult public func deleteRoute(_ input: DeleteRouteRequest) -> EventLoopFuture<Void>
-
Deletes a route request parameter.
Declaration
Swift
@discardableResult public func deleteRouteRequestParameter(_ input: DeleteRouteRequestParameterRequest) -> EventLoopFuture<Void>
-
Deletes a RouteResponse.
Declaration
Swift
@discardableResult public func deleteRouteResponse(_ input: DeleteRouteResponseRequest) -> EventLoopFuture<Void>
-
Deletes the RouteSettings for a stage.
Declaration
Swift
@discardableResult public func deleteRouteSettings(_ input: DeleteRouteSettingsRequest) -> EventLoopFuture<Void>
-
Deletes a Stage.
Declaration
Swift
@discardableResult public func deleteStage(_ input: DeleteStageRequest) -> EventLoopFuture<Void>
-
Deletes a VPC link.
Declaration
Swift
public func deleteVpcLink(_ input: DeleteVpcLinkRequest) -> EventLoopFuture<DeleteVpcLinkResponse>
-
Exports a definition of an API in a particular output format and specification.
Declaration
Swift
public func exportApi(_ input: ExportApiRequest) -> EventLoopFuture<ExportApiResponse>
-
Gets an Api resource.
Declaration
Swift
public func getApi(_ input: GetApiRequest) -> EventLoopFuture<GetApiResponse>
-
Gets an API mapping.
Declaration
Swift
public func getApiMapping(_ input: GetApiMappingRequest) -> EventLoopFuture<GetApiMappingResponse>
-
Gets API mappings.
Declaration
Swift
public func getApiMappings(_ input: GetApiMappingsRequest) -> EventLoopFuture<GetApiMappingsResponse>
-
Gets a collection of Api resources.
Declaration
Swift
public func getApis(_ input: GetApisRequest) -> EventLoopFuture<GetApisResponse>
-
Gets an Authorizer.
Declaration
Swift
public func getAuthorizer(_ input: GetAuthorizerRequest) -> EventLoopFuture<GetAuthorizerResponse>
-
Gets the Authorizers for an API.
Declaration
Swift
public func getAuthorizers(_ input: GetAuthorizersRequest) -> EventLoopFuture<GetAuthorizersResponse>
-
Gets a Deployment.
Declaration
Swift
public func getDeployment(_ input: GetDeploymentRequest) -> EventLoopFuture<GetDeploymentResponse>
-
Gets the Deployments for an API.
Declaration
Swift
public func getDeployments(_ input: GetDeploymentsRequest) -> EventLoopFuture<GetDeploymentsResponse>
-
Gets a domain name.
Declaration
Swift
public func getDomainName(_ input: GetDomainNameRequest) -> EventLoopFuture<GetDomainNameResponse>
-
Gets the domain names for an AWS account.
Declaration
Swift
public func getDomainNames(_ input: GetDomainNamesRequest) -> EventLoopFuture<GetDomainNamesResponse>
-
Gets an Integration.
Declaration
Swift
public func getIntegration(_ input: GetIntegrationRequest) -> EventLoopFuture<GetIntegrationResult>
-
Gets an IntegrationResponses.
Declaration
Swift
public func getIntegrationResponse(_ input: GetIntegrationResponseRequest) -> EventLoopFuture<GetIntegrationResponseResponse>
-
Gets the IntegrationResponses for an Integration.
Declaration
Swift
public func getIntegrationResponses(_ input: GetIntegrationResponsesRequest) -> EventLoopFuture<GetIntegrationResponsesResponse>
-
Gets the Integrations for an API.
Declaration
Swift
public func getIntegrations(_ input: GetIntegrationsRequest) -> EventLoopFuture<GetIntegrationsResponse>
-
Gets a Model.
Declaration
Swift
public func getModel(_ input: GetModelRequest) -> EventLoopFuture<GetModelResponse>
-
Gets a model template.
Declaration
Swift
public func getModelTemplate(_ input: GetModelTemplateRequest) -> EventLoopFuture<GetModelTemplateResponse>
-
Gets the Models for an API.
Declaration
Swift
public func getModels(_ input: GetModelsRequest) -> EventLoopFuture<GetModelsResponse>
-
Gets a Route.
Declaration
Swift
public func getRoute(_ input: GetRouteRequest) -> EventLoopFuture<GetRouteResult>
-
Gets a RouteResponse.
Declaration
Swift
public func getRouteResponse(_ input: GetRouteResponseRequest) -> EventLoopFuture<GetRouteResponseResponse>
-
Gets the RouteResponses for a Route.
Declaration
Swift
public func getRouteResponses(_ input: GetRouteResponsesRequest) -> EventLoopFuture<GetRouteResponsesResponse>
-
Gets the Routes for an API.
Declaration
Swift
public func getRoutes(_ input: GetRoutesRequest) -> EventLoopFuture<GetRoutesResponse>
-
Gets a Stage.
Declaration
Swift
public func getStage(_ input: GetStageRequest) -> EventLoopFuture<GetStageResponse>
-
Gets the Stages for an API.
Declaration
Swift
public func getStages(_ input: GetStagesRequest) -> EventLoopFuture<GetStagesResponse>
-
Gets a collection of Tag resources.
Declaration
Swift
public func getTags(_ input: GetTagsRequest) -> EventLoopFuture<GetTagsResponse>
-
Gets a VPC link.
Declaration
Swift
public func getVpcLink(_ input: GetVpcLinkRequest) -> EventLoopFuture<GetVpcLinkResponse>
-
Gets a collection of VPC links.
Declaration
Swift
public func getVpcLinks(_ input: GetVpcLinksRequest) -> EventLoopFuture<GetVpcLinksResponse>
-
Imports an API.
Declaration
Swift
public func importApi(_ input: ImportApiRequest) -> EventLoopFuture<ImportApiResponse>
-
Puts an Api resource.
Declaration
Swift
public func reimportApi(_ input: ReimportApiRequest) -> EventLoopFuture<ReimportApiResponse>
-
Resets all authorizer cache entries for the specified stage. Supported only for HTTP API Lambda authorizers.
Declaration
Swift
@discardableResult public func resetAuthorizersCache(_ input: ResetAuthorizersCacheRequest) -> EventLoopFuture<Void>
-
Creates a new Tag resource to represent a tag.
Declaration
Swift
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>
-
Deletes a Tag.
Declaration
Swift
@discardableResult public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<Void>
-
Updates an Api resource.
Declaration
Swift
public func updateApi(_ input: UpdateApiRequest) -> EventLoopFuture<UpdateApiResponse>
-
The API mapping.
Declaration
Swift
public func updateApiMapping(_ input: UpdateApiMappingRequest) -> EventLoopFuture<UpdateApiMappingResponse>
-
Updates an Authorizer.
Declaration
Swift
public func updateAuthorizer(_ input: UpdateAuthorizerRequest) -> EventLoopFuture<UpdateAuthorizerResponse>
-
Updates a Deployment.
Declaration
Swift
public func updateDeployment(_ input: UpdateDeploymentRequest) -> EventLoopFuture<UpdateDeploymentResponse>
-
Updates a domain name.
Declaration
Swift
public func updateDomainName(_ input: UpdateDomainNameRequest) -> EventLoopFuture<UpdateDomainNameResponse>
-
Updates an Integration.
Declaration
Swift
public func updateIntegration(_ input: UpdateIntegrationRequest) -> EventLoopFuture<UpdateIntegrationResult>
-
Updates an IntegrationResponses.
Declaration
Swift
public func updateIntegrationResponse(_ input: UpdateIntegrationResponseRequest) -> EventLoopFuture<UpdateIntegrationResponseResponse>
-
Updates a Model.
Declaration
Swift
public func updateModel(_ input: UpdateModelRequest) -> EventLoopFuture<UpdateModelResponse>
-
Updates a Route.
Declaration
Swift
public func updateRoute(_ input: UpdateRouteRequest) -> EventLoopFuture<UpdateRouteResult>
-
Updates a RouteResponse.
Declaration
Swift
public func updateRouteResponse(_ input: UpdateRouteResponseRequest) -> EventLoopFuture<UpdateRouteResponseResponse>
-
Updates a Stage.
Declaration
Swift
public func updateStage(_ input: UpdateStageRequest) -> EventLoopFuture<UpdateStageResponse>
-
Updates a VPC link.
Declaration
Swift
public func updateVpcLink(_ input: UpdateVpcLinkRequest) -> EventLoopFuture<UpdateVpcLinkResponse>
-
Undocumented
See moreDeclaration
Swift
public enum AuthorizationType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum AuthorizerType : 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 DeploymentStatus : 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 IntegrationType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum LoggingLevel : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum PassthroughBehavior : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum ProtocolType : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum SecurityPolicy : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum VpcLinkStatus : String, CustomStringConvertible, Codable
-
Undocumented
See moreDeclaration
Swift
public enum VpcLinkVersion : String, CustomStringConvertible, Codable