apigatewayv2/aws.sdk.kotlin.services.apigatewayv2

Package-level declarations

Types

ApiGatewayV2Client

interface ApiGatewayV2Client : SdkClient

Amazon API Gateway V2

Properties

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

const val ServiceId: String

Inherited functions

inline suspend fun ApiGatewayV2Client.createApi(crossinline block: CreateApiRequest.Builder.() -> Unit): CreateApiResponse

Creates an Api resource.

createApiMapping

inline suspend fun ApiGatewayV2Client.createApiMapping(crossinline block: CreateApiMappingRequest.Builder.() -> Unit): CreateApiMappingResponse

Creates an API mapping.

createAuthorizer

inline suspend fun ApiGatewayV2Client.createAuthorizer(crossinline block: CreateAuthorizerRequest.Builder.() -> Unit): CreateAuthorizerResponse

Creates an Authorizer for an API.

createDeployment

inline suspend fun ApiGatewayV2Client.createDeployment(crossinline block: CreateDeploymentRequest.Builder.() -> Unit): CreateDeploymentResponse

Creates a Deployment for an API.

createDomainName

inline suspend fun ApiGatewayV2Client.createDomainName(crossinline block: CreateDomainNameRequest.Builder.() -> Unit): CreateDomainNameResponse

Creates a domain name.

createIntegration

inline suspend fun ApiGatewayV2Client.createIntegration(crossinline block: CreateIntegrationRequest.Builder.() -> Unit): CreateIntegrationResponse

Creates an Integration.

createIntegrationResponse

inline suspend fun ApiGatewayV2Client.createIntegrationResponse(crossinline block: CreateIntegrationResponseRequest.Builder.() -> Unit): CreateIntegrationResponseResponse

Creates an IntegrationResponses.

inline suspend fun ApiGatewayV2Client.createModel(crossinline block: CreateModelRequest.Builder.() -> Unit): CreateModelResponse

Creates a Model for an API.

inline suspend fun ApiGatewayV2Client.createRoute(crossinline block: CreateRouteRequest.Builder.() -> Unit): CreateRouteResponse

Creates a Route for an API.

createRouteResponse

inline suspend fun ApiGatewayV2Client.createRouteResponse(crossinline block: CreateRouteResponseRequest.Builder.() -> Unit): CreateRouteResponseResponse

Creates a RouteResponse for a Route.

createRoutingRule

inline suspend fun ApiGatewayV2Client.createRoutingRule(crossinline block: CreateRoutingRuleRequest.Builder.() -> Unit): CreateRoutingRuleResponse

Creates a RoutingRule.

inline suspend fun ApiGatewayV2Client.createStage(crossinline block: CreateStageRequest.Builder.() -> Unit): CreateStageResponse

Creates a Stage for an API.

inline suspend fun ApiGatewayV2Client.createVpcLink(crossinline block: CreateVpcLinkRequest.Builder.() -> Unit): CreateVpcLinkResponse

Creates a VPC link.

deleteAccessLogSettings

inline suspend fun ApiGatewayV2Client.deleteAccessLogSettings(crossinline block: DeleteAccessLogSettingsRequest.Builder.() -> Unit): DeleteAccessLogSettingsResponse

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

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

Deletes an Api resource.

deleteApiMapping

inline suspend fun ApiGatewayV2Client.deleteApiMapping(crossinline block: DeleteApiMappingRequest.Builder.() -> Unit): DeleteApiMappingResponse

Deletes an API mapping.

deleteAuthorizer

inline suspend fun ApiGatewayV2Client.deleteAuthorizer(crossinline block: DeleteAuthorizerRequest.Builder.() -> Unit): DeleteAuthorizerResponse

Deletes an Authorizer.

deleteCorsConfiguration

inline suspend fun ApiGatewayV2Client.deleteCorsConfiguration(crossinline block: DeleteCorsConfigurationRequest.Builder.() -> Unit): DeleteCorsConfigurationResponse

Deletes a CORS configuration.

deleteDeployment

inline suspend fun ApiGatewayV2Client.deleteDeployment(crossinline block: DeleteDeploymentRequest.Builder.() -> Unit): DeleteDeploymentResponse

Deletes a Deployment.

deleteDomainName

inline suspend fun ApiGatewayV2Client.deleteDomainName(crossinline block: DeleteDomainNameRequest.Builder.() -> Unit): DeleteDomainNameResponse

Deletes a domain name.

deleteIntegration

inline suspend fun ApiGatewayV2Client.deleteIntegration(crossinline block: DeleteIntegrationRequest.Builder.() -> Unit): DeleteIntegrationResponse

Deletes an Integration.

deleteIntegrationResponse

inline suspend fun ApiGatewayV2Client.deleteIntegrationResponse(crossinline block: DeleteIntegrationResponseRequest.Builder.() -> Unit): DeleteIntegrationResponseResponse

Deletes an IntegrationResponses.

inline suspend fun ApiGatewayV2Client.deleteModel(crossinline block: DeleteModelRequest.Builder.() -> Unit): DeleteModelResponse

Deletes a Model.

inline suspend fun ApiGatewayV2Client.deleteRoute(crossinline block: DeleteRouteRequest.Builder.() -> Unit): DeleteRouteResponse

Deletes a Route.

deleteRouteRequestParameter

inline suspend fun ApiGatewayV2Client.deleteRouteRequestParameter(crossinline block: DeleteRouteRequestParameterRequest.Builder.() -> Unit): DeleteRouteRequestParameterResponse

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

deleteRouteResponse

inline suspend fun ApiGatewayV2Client.deleteRouteResponse(crossinline block: DeleteRouteResponseRequest.Builder.() -> Unit): DeleteRouteResponseResponse

Deletes a RouteResponse.

deleteRouteSettings

inline suspend fun ApiGatewayV2Client.deleteRouteSettings(crossinline block: DeleteRouteSettingsRequest.Builder.() -> Unit): DeleteRouteSettingsResponse

Deletes the RouteSettings for a stage.

deleteRoutingRule

inline suspend fun ApiGatewayV2Client.deleteRoutingRule(crossinline block: DeleteRoutingRuleRequest.Builder.() -> Unit): DeleteRoutingRuleResponse

Deletes a routing rule.

inline suspend fun ApiGatewayV2Client.deleteStage(crossinline block: DeleteStageRequest.Builder.() -> Unit): DeleteStageResponse

Deletes a Stage.

inline suspend fun ApiGatewayV2Client.deleteVpcLink(crossinline block: DeleteVpcLinkRequest.Builder.() -> Unit): DeleteVpcLinkResponse

Deletes a VPC link.

inline suspend fun ApiGatewayV2Client.exportApi(crossinline block: ExportApiRequest.Builder.() -> Unit): ExportApiResponse

inline suspend fun ApiGatewayV2Client.getApi(crossinline block: GetApiRequest.Builder.() -> Unit): GetApiResponse

Gets an Api resource.

inline suspend fun ApiGatewayV2Client.getApiMapping(crossinline block: GetApiMappingRequest.Builder.() -> Unit): GetApiMappingResponse

Gets an API mapping.

inline suspend fun ApiGatewayV2Client.getApiMappings(crossinline block: GetApiMappingsRequest.Builder.() -> Unit): GetApiMappingsResponse

Gets API mappings.

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

Gets a collection of Api resources.

inline suspend fun ApiGatewayV2Client.getAuthorizer(crossinline block: GetAuthorizerRequest.Builder.() -> Unit): GetAuthorizerResponse

Gets an Authorizer.

inline suspend fun ApiGatewayV2Client.getAuthorizers(crossinline block: GetAuthorizersRequest.Builder.() -> Unit): GetAuthorizersResponse

Gets the Authorizers for an API.

inline suspend fun ApiGatewayV2Client.getDeployment(crossinline block: GetDeploymentRequest.Builder.() -> Unit): GetDeploymentResponse

Gets a Deployment.

inline suspend fun ApiGatewayV2Client.getDeployments(crossinline block: GetDeploymentsRequest.Builder.() -> Unit): GetDeploymentsResponse

Gets the Deployments for an API.

inline suspend fun ApiGatewayV2Client.getDomainName(crossinline block: GetDomainNameRequest.Builder.() -> Unit): GetDomainNameResponse

Gets a domain name.

inline suspend fun ApiGatewayV2Client.getDomainNames(crossinline block: GetDomainNamesRequest.Builder.() -> Unit): GetDomainNamesResponse

Gets the domain names for an AWS account.

inline suspend fun ApiGatewayV2Client.getIntegration(crossinline block: GetIntegrationRequest.Builder.() -> Unit): GetIntegrationResponse

Gets an Integration.

getIntegrationResponse

inline suspend fun ApiGatewayV2Client.getIntegrationResponse(crossinline block: GetIntegrationResponseRequest.Builder.() -> Unit): GetIntegrationResponseResponse

Gets an IntegrationResponses.

getIntegrationResponses

inline suspend fun ApiGatewayV2Client.getIntegrationResponses(crossinline block: GetIntegrationResponsesRequest.Builder.() -> Unit): GetIntegrationResponsesResponse

Gets the IntegrationResponses for an Integration.

getIntegrations

inline suspend fun ApiGatewayV2Client.getIntegrations(crossinline block: GetIntegrationsRequest.Builder.() -> Unit): GetIntegrationsResponse

Gets the Integrations for an API.

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

Gets a Model.

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

Gets the Models for an API.

getModelTemplate

inline suspend fun ApiGatewayV2Client.getModelTemplate(crossinline block: GetModelTemplateRequest.Builder.() -> Unit): GetModelTemplateResponse

Gets a model template.

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

Gets a Route.

getRouteResponse

inline suspend fun ApiGatewayV2Client.getRouteResponse(crossinline block: GetRouteResponseRequest.Builder.() -> Unit): GetRouteResponseResponse

Gets a RouteResponse.

getRouteResponses

inline suspend fun ApiGatewayV2Client.getRouteResponses(crossinline block: GetRouteResponsesRequest.Builder.() -> Unit): GetRouteResponsesResponse

Gets the RouteResponses for a Route.

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

Gets the Routes for an API.

inline suspend fun ApiGatewayV2Client.getRoutingRule(crossinline block: GetRoutingRuleRequest.Builder.() -> Unit): GetRoutingRuleResponse

Gets a routing rule.

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

Gets a Stage.

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

Gets the Stages for an API.

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

Gets a collection of Tag resources.

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

Gets a VPC link.

inline suspend fun ApiGatewayV2Client.getVpcLinks(crossinline block: GetVpcLinksRequest.Builder.() -> Unit): GetVpcLinksResponse

Gets a collection of VPC links.

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

Imports an API.

listRoutingRules

inline suspend fun ApiGatewayV2Client.listRoutingRules(crossinline block: ListRoutingRulesRequest.Builder.() -> Unit): ListRoutingRulesResponse

Lists routing rules.

inline suspend fun ApiGatewayV2Client.putRoutingRule(crossinline block: PutRoutingRuleRequest.Builder.() -> Unit): PutRoutingRuleResponse

Updates a routing rule.

inline suspend fun ApiGatewayV2Client.reimportApi(crossinline block: ReimportApiRequest.Builder.() -> Unit): ReimportApiResponse

Puts an Api resource.

resetAuthorizersCache

inline suspend fun ApiGatewayV2Client.resetAuthorizersCache(crossinline block: ResetAuthorizersCacheRequest.Builder.() -> Unit): ResetAuthorizersCacheResponse

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

inline suspend fun ApiGatewayV2Client.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Creates a new Tag resource to represent a tag.

inline suspend fun ApiGatewayV2Client.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Deletes a Tag.

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

Updates an Api resource.

updateApiMapping

inline suspend fun ApiGatewayV2Client.updateApiMapping(crossinline block: UpdateApiMappingRequest.Builder.() -> Unit): UpdateApiMappingResponse

The API mapping.

updateAuthorizer

inline suspend fun ApiGatewayV2Client.updateAuthorizer(crossinline block: UpdateAuthorizerRequest.Builder.() -> Unit): UpdateAuthorizerResponse

Updates an Authorizer.

updateDeployment

inline suspend fun ApiGatewayV2Client.updateDeployment(crossinline block: UpdateDeploymentRequest.Builder.() -> Unit): UpdateDeploymentResponse

Updates a Deployment.

updateDomainName

inline suspend fun ApiGatewayV2Client.updateDomainName(crossinline block: UpdateDomainNameRequest.Builder.() -> Unit): UpdateDomainNameResponse

Updates a domain name.

updateIntegration

inline suspend fun ApiGatewayV2Client.updateIntegration(crossinline block: UpdateIntegrationRequest.Builder.() -> Unit): UpdateIntegrationResponse

Updates an Integration.

updateIntegrationResponse

inline suspend fun ApiGatewayV2Client.updateIntegrationResponse(crossinline block: UpdateIntegrationResponseRequest.Builder.() -> Unit): UpdateIntegrationResponseResponse

Updates an IntegrationResponses.

inline suspend fun ApiGatewayV2Client.updateModel(crossinline block: UpdateModelRequest.Builder.() -> Unit): UpdateModelResponse

Updates a Model.

inline suspend fun ApiGatewayV2Client.updateRoute(crossinline block: UpdateRouteRequest.Builder.() -> Unit): UpdateRouteResponse

Updates a Route.

updateRouteResponse

inline suspend fun ApiGatewayV2Client.updateRouteResponse(crossinline block: UpdateRouteResponseRequest.Builder.() -> Unit): UpdateRouteResponseResponse

Updates a RouteResponse.

inline suspend fun ApiGatewayV2Client.updateStage(crossinline block: UpdateStageRequest.Builder.() -> Unit): UpdateStageResponse

Updates a Stage.

inline suspend fun ApiGatewayV2Client.updateVpcLink(crossinline block: UpdateVpcLinkRequest.Builder.() -> Unit): UpdateVpcLinkResponse

Updates a VPC link.

fun ApiGatewayV2Client.withConfig(block: ApiGatewayV2Client.Config.Builder.() -> Unit): ApiGatewayV2Client

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.