ApiGatewayV2Client

Amazon API Gateway V2

Properties

Link copied to clipboard
abstract override val config: ApiGatewayV2Client.Config

ApiGatewayV2Client's configuration

Functions

Link copied to clipboard
abstract suspend fun createApi(input: CreateApiRequest): CreateApiResponse

Creates an Api resource.

Link copied to clipboard

Creates an API mapping.

Link copied to clipboard

Creates an Authorizer for an API.

Link copied to clipboard

Creates a Deployment for an API.

Link copied to clipboard

Creates a domain name.

Link copied to clipboard

Creates an Integration.

Link copied to clipboard

Creates an IntegrationResponses.

Link copied to clipboard
abstract suspend fun createModel(input: CreateModelRequest): CreateModelResponse

Creates a Model for an API.

Link copied to clipboard
abstract suspend fun createRoute(input: CreateRouteRequest): CreateRouteResponse

Creates a Route for an API.

Link copied to clipboard

Creates a RouteResponse for a Route.

Link copied to clipboard

Creates a RoutingRule.

Link copied to clipboard
abstract suspend fun createStage(input: CreateStageRequest): CreateStageResponse

Creates a Stage for an API.

Link copied to clipboard

Creates a VPC link.

Link copied to clipboard

Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.

Link copied to clipboard
abstract suspend fun deleteApi(input: DeleteApiRequest): DeleteApiResponse

Deletes an Api resource.

Link copied to clipboard

Deletes an API mapping.

Link copied to clipboard

Deletes an Authorizer.

Link copied to clipboard

Deletes a CORS configuration.

Link copied to clipboard

Deletes a Deployment.

Link copied to clipboard

Deletes a domain name.

Link copied to clipboard

Deletes an Integration.

Link copied to clipboard

Deletes an IntegrationResponses.

Link copied to clipboard
abstract suspend fun deleteModel(input: DeleteModelRequest): DeleteModelResponse

Deletes a Model.

Link copied to clipboard
abstract suspend fun deleteRoute(input: DeleteRouteRequest): DeleteRouteResponse

Deletes a Route.

Link copied to clipboard

Deletes a route request parameter. Supported only for WebSocket APIs.

Link copied to clipboard

Deletes a RouteResponse.

Link copied to clipboard

Deletes the RouteSettings for a stage.

Link copied to clipboard

Deletes a routing rule.

Link copied to clipboard
abstract suspend fun deleteStage(input: DeleteStageRequest): DeleteStageResponse

Deletes a Stage.

Link copied to clipboard

Deletes a VPC link.

Link copied to clipboard
abstract suspend fun exportApi(input: ExportApiRequest): ExportApiResponse
Link copied to clipboard
abstract suspend fun getApi(input: GetApiRequest): GetApiResponse

Gets an Api resource.

Link copied to clipboard

Gets an API mapping.

Link copied to clipboard

Gets API mappings.

Link copied to clipboard
abstract suspend fun getApis(input: GetApisRequest = GetApisRequest { }): GetApisResponse

Gets a collection of Api resources.

Link copied to clipboard

Gets an Authorizer.

Link copied to clipboard

Gets the Authorizers for an API.

Link copied to clipboard

Gets a Deployment.

Link copied to clipboard

Gets the Deployments for an API.

Link copied to clipboard

Gets a domain name.

Link copied to clipboard
abstract suspend fun getDomainNames(input: GetDomainNamesRequest = GetDomainNamesRequest { }): GetDomainNamesResponse

Gets the domain names for an AWS account.

Link copied to clipboard

Gets an Integration.

Link copied to clipboard

Gets an IntegrationResponses.

Link copied to clipboard

Gets the IntegrationResponses for an Integration.

Link copied to clipboard

Gets the Integrations for an API.

Link copied to clipboard
abstract suspend fun getModel(input: GetModelRequest): GetModelResponse

Gets a Model.

Link copied to clipboard
abstract suspend fun getModels(input: GetModelsRequest): GetModelsResponse

Gets the Models for an API.

Link copied to clipboard

Gets a model template.

Link copied to clipboard
abstract suspend fun getRoute(input: GetRouteRequest): GetRouteResponse

Gets a Route.

Link copied to clipboard

Gets a RouteResponse.

Link copied to clipboard

Gets the RouteResponses for a Route.

Link copied to clipboard
abstract suspend fun getRoutes(input: GetRoutesRequest): GetRoutesResponse

Gets the Routes for an API.

Link copied to clipboard

Gets a routing rule.

Link copied to clipboard
abstract suspend fun getStage(input: GetStageRequest): GetStageResponse

Gets a Stage.

Link copied to clipboard
abstract suspend fun getStages(input: GetStagesRequest): GetStagesResponse

Gets the Stages for an API.

Link copied to clipboard
abstract suspend fun getTags(input: GetTagsRequest): GetTagsResponse

Gets a collection of Tag resources.

Link copied to clipboard
abstract suspend fun getVpcLink(input: GetVpcLinkRequest): GetVpcLinkResponse

Gets a VPC link.

Link copied to clipboard
abstract suspend fun getVpcLinks(input: GetVpcLinksRequest = GetVpcLinksRequest { }): GetVpcLinksResponse

Gets a collection of VPC links.

Link copied to clipboard
abstract suspend fun importApi(input: ImportApiRequest): ImportApiResponse

Imports an API.

Link copied to clipboard

Lists routing rules.

Link copied to clipboard

Updates a routing rule.

Link copied to clipboard
abstract suspend fun reimportApi(input: ReimportApiRequest): ReimportApiResponse

Puts an Api resource.

Link copied to clipboard

Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Creates a new Tag resource to represent a tag.

Link copied to clipboard

Deletes a Tag.

Link copied to clipboard
abstract suspend fun updateApi(input: UpdateApiRequest): UpdateApiResponse

Updates an Api resource.

Link copied to clipboard

The API mapping.

Link copied to clipboard

Updates an Authorizer.

Link copied to clipboard

Updates a Deployment.

Link copied to clipboard

Updates a domain name.

Link copied to clipboard

Updates an Integration.

Link copied to clipboard

Updates an IntegrationResponses.

Link copied to clipboard
abstract suspend fun updateModel(input: UpdateModelRequest): UpdateModelResponse

Updates a Model.

Link copied to clipboard
abstract suspend fun updateRoute(input: UpdateRouteRequest): UpdateRouteResponse

Updates a Route.

Link copied to clipboard

Updates a RouteResponse.

Link copied to clipboard
abstract suspend fun updateStage(input: UpdateStageRequest): UpdateStageResponse

Updates a Stage.

Link copied to clipboard

Updates a VPC link.

Inherited functions

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun ApiGatewayV2Client.createApi(crossinline block: CreateApiRequest.Builder.() -> Unit): CreateApiResponse

Creates an Api resource.

Link copied to clipboard

Creates an API mapping.

Link copied to clipboard

Creates an Authorizer for an API.

Link copied to clipboard

Creates a Deployment for an API.

Link copied to clipboard

Creates a domain name.

Link copied to clipboard

Creates an Integration.

Link copied to clipboard

Creates an IntegrationResponses.

Link copied to clipboard

Creates a Model for an API.

Link copied to clipboard

Creates a Route for an API.

Link copied to clipboard

Creates a RouteResponse for a Route.

Link copied to clipboard

Creates a RoutingRule.

Link copied to clipboard

Creates a Stage for an API.

Link copied to clipboard

Creates a VPC link.

Link copied to clipboard

Deletes the AccessLogSettings for a Stage. To disable access logging for a Stage, delete its AccessLogSettings.

Link copied to clipboard
inline suspend fun ApiGatewayV2Client.deleteApi(crossinline block: DeleteApiRequest.Builder.() -> Unit): DeleteApiResponse

Deletes an Api resource.

Link copied to clipboard

Deletes an API mapping.

Link copied to clipboard

Deletes an Authorizer.

Link copied to clipboard

Deletes a CORS configuration.

Link copied to clipboard

Deletes a Deployment.

Link copied to clipboard

Deletes a domain name.

Link copied to clipboard

Deletes an Integration.

Link copied to clipboard

Deletes an IntegrationResponses.

Link copied to clipboard

Deletes a Model.

Link copied to clipboard

Deletes a Route.

Link copied to clipboard

Deletes a route request parameter. Supported only for WebSocket APIs.

Link copied to clipboard

Deletes a RouteResponse.

Link copied to clipboard

Deletes the RouteSettings for a stage.

Link copied to clipboard

Deletes a routing rule.

Link copied to clipboard

Deletes a Stage.

Link copied to clipboard

Deletes a VPC link.

Link copied to clipboard
inline suspend fun ApiGatewayV2Client.exportApi(crossinline block: ExportApiRequest.Builder.() -> Unit): ExportApiResponse
Link copied to clipboard
inline suspend fun ApiGatewayV2Client.getApi(crossinline block: GetApiRequest.Builder.() -> Unit): GetApiResponse

Gets an Api resource.

Link copied to clipboard

Gets an API mapping.

Link copied to clipboard

Gets API mappings.

Link copied to clipboard
inline suspend fun ApiGatewayV2Client.getApis(crossinline block: GetApisRequest.Builder.() -> Unit): GetApisResponse

Gets a collection of Api resources.

Link copied to clipboard

Gets an Authorizer.

Link copied to clipboard

Gets the Authorizers for an API.

Link copied to clipboard

Gets a Deployment.

Link copied to clipboard

Gets the Deployments for an API.

Link copied to clipboard

Gets a domain name.

Link copied to clipboard

Gets the domain names for an AWS account.

Link copied to clipboard

Gets an Integration.

Link copied to clipboard

Gets an IntegrationResponses.

Link copied to clipboard

Gets the IntegrationResponses for an Integration.

Link copied to clipboard

Gets the Integrations for an API.

Link copied to clipboard
inline suspend fun ApiGatewayV2Client.getModel(crossinline block: GetModelRequest.Builder.() -> Unit): GetModelResponse

Gets a Model.

Link copied to clipboard
inline suspend fun ApiGatewayV2Client.getModels(crossinline block: GetModelsRequest.Builder.() -> Unit): GetModelsResponse

Gets the Models for an API.

Link copied to clipboard

Gets a model template.

Link copied to clipboard
inline suspend fun ApiGatewayV2Client.getRoute(crossinline block: GetRouteRequest.Builder.() -> Unit): GetRouteResponse

Gets a Route.

Link copied to clipboard

Gets a RouteResponse.

Link copied to clipboard

Gets the RouteResponses for a Route.

Link copied to clipboard
inline suspend fun ApiGatewayV2Client.getRoutes(crossinline block: GetRoutesRequest.Builder.() -> Unit): GetRoutesResponse

Gets the Routes for an API.

Link copied to clipboard

Gets a routing rule.

Link copied to clipboard
inline suspend fun ApiGatewayV2Client.getStage(crossinline block: GetStageRequest.Builder.() -> Unit): GetStageResponse

Gets a Stage.

Link copied to clipboard
inline suspend fun ApiGatewayV2Client.getStages(crossinline block: GetStagesRequest.Builder.() -> Unit): GetStagesResponse

Gets the Stages for an API.

Link copied to clipboard
inline suspend fun ApiGatewayV2Client.getTags(crossinline block: GetTagsRequest.Builder.() -> Unit): GetTagsResponse

Gets a collection of Tag resources.

Link copied to clipboard
inline suspend fun ApiGatewayV2Client.getVpcLink(crossinline block: GetVpcLinkRequest.Builder.() -> Unit): GetVpcLinkResponse

Gets a VPC link.

Link copied to clipboard

Gets a collection of VPC links.

Link copied to clipboard
inline suspend fun ApiGatewayV2Client.importApi(crossinline block: ImportApiRequest.Builder.() -> Unit): ImportApiResponse

Imports an API.

Link copied to clipboard

Lists routing rules.

Link copied to clipboard

Updates a routing rule.

Link copied to clipboard

Puts an Api resource.

Link copied to clipboard

Resets all authorizer cache entries on a stage. Supported only for HTTP APIs.

Link copied to clipboard

Creates a new Tag resource to represent a tag.

Link copied to clipboard

Deletes a Tag.

Link copied to clipboard
inline suspend fun ApiGatewayV2Client.updateApi(crossinline block: UpdateApiRequest.Builder.() -> Unit): UpdateApiResponse

Updates an Api resource.

Link copied to clipboard

The API mapping.

Link copied to clipboard

Updates an Authorizer.

Link copied to clipboard

Updates a Deployment.

Link copied to clipboard

Updates a domain name.

Link copied to clipboard

Updates an Integration.

Link copied to clipboard

Updates an IntegrationResponses.

Link copied to clipboard

Updates a Model.

Link copied to clipboard

Updates a Route.

Link copied to clipboard

Updates a RouteResponse.

Link copied to clipboard

Updates a Stage.

Link copied to clipboard

Updates a VPC link.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.