apigateway/aws.sdk.kotlin.services.apigateway/ApiGatewayClient

ApiGatewayClient

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 Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

Types

Builder

class Builder : AbstractSdkClientBuilder<ApiGatewayClient.Config, ApiGatewayClient.Config.Builder, ApiGatewayClient>

Companion

object Companion : AbstractAwsSdkClientFactory<ApiGatewayClient.Config, ApiGatewayClient.Config.Builder, ApiGatewayClient, ApiGatewayClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: ApiGatewayClient.Config

ApiGatewayClient's configuration

Functions

createApiKey

abstract suspend fun createApiKey(input: CreateApiKeyRequest = CreateApiKeyRequest { }): CreateApiKeyResponse

Create an ApiKey resource.

createAuthorizer

abstract suspend fun createAuthorizer(input: CreateAuthorizerRequest): CreateAuthorizerResponse

Adds a new Authorizer resource to an existing RestApi resource.

createBasePathMapping

abstract suspend fun createBasePathMapping(input: CreateBasePathMappingRequest): CreateBasePathMappingResponse

Creates a new BasePathMapping resource.

createDeployment

abstract suspend fun createDeployment(input: CreateDeploymentRequest): CreateDeploymentResponse

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

createDocumentationPart

abstract suspend fun createDocumentationPart(input: CreateDocumentationPartRequest): CreateDocumentationPartResponse

Creates a documentation part.

createDocumentationVersion

abstract suspend fun createDocumentationVersion(input: CreateDocumentationVersionRequest): CreateDocumentationVersionResponse

Creates a documentation version

createDomainName

abstract suspend fun createDomainName(input: CreateDomainNameRequest): CreateDomainNameResponse

Creates a new domain name.

createDomainNameAccessAssociation

abstract suspend fun createDomainNameAccessAssociation(input: CreateDomainNameAccessAssociationRequest): CreateDomainNameAccessAssociationResponse

Creates a domain name access association resource between an access association source and a private custom domain name.

createModel

abstract suspend fun createModel(input: CreateModelRequest): CreateModelResponse

Adds a new Model resource to an existing RestApi resource.

createRequestValidator

abstract suspend fun createRequestValidator(input: CreateRequestValidatorRequest): CreateRequestValidatorResponse

Creates a RequestValidator of a given RestApi.

createResource

abstract suspend fun createResource(input: CreateResourceRequest): CreateResourceResponse

Creates a Resource resource.

createRestApi

abstract suspend fun createRestApi(input: CreateRestApiRequest): CreateRestApiResponse

Creates a new RestApi resource.

createStage

abstract suspend fun createStage(input: CreateStageRequest): CreateStageResponse

Creates a new Stage resource that references a pre-existing Deployment for the API.

createUsagePlan

abstract suspend fun createUsagePlan(input: CreateUsagePlanRequest): CreateUsagePlanResponse

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

createUsagePlanKey

abstract suspend fun createUsagePlanKey(input: CreateUsagePlanKeyRequest): CreateUsagePlanKeyResponse

Creates a usage plan key for adding an existing API key to a usage plan.

createVpcLink

abstract suspend fun createVpcLink(input: CreateVpcLinkRequest): CreateVpcLinkResponse

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.

deleteApiKey

abstract suspend fun deleteApiKey(input: DeleteApiKeyRequest): DeleteApiKeyResponse

Deletes the ApiKey resource.

deleteAuthorizer

abstract suspend fun deleteAuthorizer(input: DeleteAuthorizerRequest): DeleteAuthorizerResponse

Deletes an existing Authorizer resource.

deleteBasePathMapping

abstract suspend fun deleteBasePathMapping(input: DeleteBasePathMappingRequest): DeleteBasePathMappingResponse

Deletes the BasePathMapping resource.

deleteClientCertificate

abstract suspend fun deleteClientCertificate(input: DeleteClientCertificateRequest): DeleteClientCertificateResponse

Deletes the ClientCertificate resource.

deleteDeployment

abstract suspend fun deleteDeployment(input: DeleteDeploymentRequest): DeleteDeploymentResponse

Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

deleteDocumentationPart

abstract suspend fun deleteDocumentationPart(input: DeleteDocumentationPartRequest): DeleteDocumentationPartResponse

Deletes a documentation part

deleteDocumentationVersion

abstract suspend fun deleteDocumentationVersion(input: DeleteDocumentationVersionRequest): DeleteDocumentationVersionResponse

Deletes a documentation version.

deleteDomainName

abstract suspend fun deleteDomainName(input: DeleteDomainNameRequest): DeleteDomainNameResponse

Deletes the DomainName resource.

deleteDomainNameAccessAssociation

abstract suspend fun deleteDomainNameAccessAssociation(input: DeleteDomainNameAccessAssociationRequest): DeleteDomainNameAccessAssociationResponse

Deletes the DomainNameAccessAssociation resource.

deleteGatewayResponse

abstract suspend fun deleteGatewayResponse(input: DeleteGatewayResponseRequest): DeleteGatewayResponseResponse

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

deleteIntegration

abstract suspend fun deleteIntegration(input: DeleteIntegrationRequest): DeleteIntegrationResponse

Represents a delete integration.

deleteIntegrationResponse

abstract suspend fun deleteIntegrationResponse(input: DeleteIntegrationResponseRequest): DeleteIntegrationResponseResponse

Represents a delete integration response.

deleteMethod

abstract suspend fun deleteMethod(input: DeleteMethodRequest): DeleteMethodResponse

Deletes an existing Method resource.

deleteMethodResponse

abstract suspend fun deleteMethodResponse(input: DeleteMethodResponseRequest): DeleteMethodResponseResponse

Deletes an existing MethodResponse resource.

deleteModel

abstract suspend fun deleteModel(input: DeleteModelRequest): DeleteModelResponse

Deletes a model.

deleteRequestValidator

abstract suspend fun deleteRequestValidator(input: DeleteRequestValidatorRequest): DeleteRequestValidatorResponse

Deletes a RequestValidator of a given RestApi.

deleteResource

abstract suspend fun deleteResource(input: DeleteResourceRequest): DeleteResourceResponse

Deletes a Resource resource.

deleteRestApi

abstract suspend fun deleteRestApi(input: DeleteRestApiRequest): DeleteRestApiResponse

Deletes the specified API.

deleteStage

abstract suspend fun deleteStage(input: DeleteStageRequest): DeleteStageResponse

Deletes a Stage resource.

deleteUsagePlan

abstract suspend fun deleteUsagePlan(input: DeleteUsagePlanRequest): DeleteUsagePlanResponse

Deletes a usage plan of a given plan Id.

deleteUsagePlanKey

abstract suspend fun deleteUsagePlanKey(input: DeleteUsagePlanKeyRequest): DeleteUsagePlanKeyResponse

Deletes a usage plan key and remove the underlying API key from the associated usage plan.

deleteVpcLink

abstract suspend fun deleteVpcLink(input: DeleteVpcLinkRequest): DeleteVpcLinkResponse

Deletes an existing VpcLink of a specified identifier.

flushStageAuthorizersCache

abstract suspend fun flushStageAuthorizersCache(input: FlushStageAuthorizersCacheRequest): FlushStageAuthorizersCacheResponse

Flushes all authorizer cache entries on a stage.

flushStageCache

abstract suspend fun flushStageCache(input: FlushStageCacheRequest): FlushStageCacheResponse

Flushes a stage's cache.

generateClientCertificate

abstract suspend fun generateClientCertificate(input: GenerateClientCertificateRequest = GenerateClientCertificateRequest { }): GenerateClientCertificateResponse

Generates a ClientCertificate resource.

getAccount

abstract suspend fun getAccount(input: GetAccountRequest = GetAccountRequest { }): GetAccountResponse

Gets information about the current Account resource.

getApiKey

abstract suspend fun getApiKey(input: GetApiKeyRequest): GetApiKeyResponse

Gets information about the current ApiKey resource.

getApiKeys

abstract suspend fun getApiKeys(input: GetApiKeysRequest = GetApiKeysRequest { }): GetApiKeysResponse

Gets information about the current ApiKeys resource.

getAuthorizer

abstract suspend fun getAuthorizer(input: GetAuthorizerRequest): GetAuthorizerResponse

Describe an existing Authorizer resource.

getAuthorizers

abstract suspend fun getAuthorizers(input: GetAuthorizersRequest): GetAuthorizersResponse

Describe an existing Authorizers resource.

getBasePathMapping

abstract suspend fun getBasePathMapping(input: GetBasePathMappingRequest): GetBasePathMappingResponse

Describe a BasePathMapping resource.

getBasePathMappings

abstract suspend fun getBasePathMappings(input: GetBasePathMappingsRequest): GetBasePathMappingsResponse

Represents a collection of BasePathMapping resources.

getClientCertificate

abstract suspend fun getClientCertificate(input: GetClientCertificateRequest): GetClientCertificateResponse

Gets information about the current ClientCertificate resource.

getClientCertificates

abstract suspend fun getClientCertificates(input: GetClientCertificatesRequest = GetClientCertificatesRequest { }): GetClientCertificatesResponse

Gets a collection of ClientCertificate resources.

getDeployment

abstract suspend fun getDeployment(input: GetDeploymentRequest): GetDeploymentResponse

Gets information about a Deployment resource.

getDeployments

abstract suspend fun getDeployments(input: GetDeploymentsRequest): GetDeploymentsResponse

Gets information about a Deployments collection.

getDocumentationPart

abstract suspend fun getDocumentationPart(input: GetDocumentationPartRequest): GetDocumentationPartResponse

Gets a documentation part.

getDocumentationParts

abstract suspend fun getDocumentationParts(input: GetDocumentationPartsRequest): GetDocumentationPartsResponse

Gets documentation parts.

getDocumentationVersion

abstract suspend fun getDocumentationVersion(input: GetDocumentationVersionRequest): GetDocumentationVersionResponse

Gets a documentation version.

getDocumentationVersions

abstract suspend fun getDocumentationVersions(input: GetDocumentationVersionsRequest): GetDocumentationVersionsResponse

Gets documentation versions.

getDomainName

abstract suspend fun getDomainName(input: GetDomainNameRequest): GetDomainNameResponse

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

getDomainNameAccessAssociations

abstract suspend fun getDomainNameAccessAssociations(input: GetDomainNameAccessAssociationsRequest = GetDomainNameAccessAssociationsRequest { }): GetDomainNameAccessAssociationsResponse

Represents a collection on DomainNameAccessAssociations resources.

getDomainNames

abstract suspend fun getDomainNames(input: GetDomainNamesRequest = GetDomainNamesRequest { }): GetDomainNamesResponse

Represents a collection of DomainName resources.

getExport

abstract suspend fun getExport(input: GetExportRequest): GetExportResponse

Exports a deployed version of a RestApi in a specified format.

getGatewayResponse

abstract suspend fun getGatewayResponse(input: GetGatewayResponseRequest): GetGatewayResponseResponse

Gets a GatewayResponse of a specified response type on the given RestApi.

getGatewayResponses

abstract suspend fun getGatewayResponses(input: GetGatewayResponsesRequest): GetGatewayResponsesResponse

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.

getIntegration

abstract suspend fun getIntegration(input: GetIntegrationRequest): GetIntegrationResponse

Get the integration settings.

getIntegrationResponse

abstract suspend fun getIntegrationResponse(input: GetIntegrationResponseRequest): GetIntegrationResponseResponse

Represents a get integration response.

getMethod

abstract suspend fun getMethod(input: GetMethodRequest): GetMethodResponse

Describe an existing Method resource.

getMethodResponse

abstract suspend fun getMethodResponse(input: GetMethodResponseRequest): GetMethodResponseResponse

Describes a MethodResponse resource.

getModel

abstract suspend fun getModel(input: GetModelRequest): GetModelResponse

Describes an existing model defined for a RestApi resource.

getModels

abstract suspend fun getModels(input: GetModelsRequest): GetModelsResponse

Describes existing Models defined for a RestApi resource.

getModelTemplate

abstract suspend fun getModelTemplate(input: GetModelTemplateRequest): GetModelTemplateResponse

Generates a sample mapping template that can be used to transform a payload into the structure of a model.

getRequestValidator

abstract suspend fun getRequestValidator(input: GetRequestValidatorRequest): GetRequestValidatorResponse

Gets a RequestValidator of a given RestApi.

getRequestValidators

abstract suspend fun getRequestValidators(input: GetRequestValidatorsRequest): GetRequestValidatorsResponse

Gets the RequestValidators collection of a given RestApi.

getResource

abstract suspend fun getResource(input: GetResourceRequest): GetResourceResponse

Lists information about a resource.

getResources

abstract suspend fun getResources(input: GetResourcesRequest): GetResourcesResponse

Lists information about a collection of Resource resources.

getRestApi

abstract suspend fun getRestApi(input: GetRestApiRequest): GetRestApiResponse

Lists the RestApi resource in the collection.

getRestApis

abstract suspend fun getRestApis(input: GetRestApisRequest = GetRestApisRequest { }): GetRestApisResponse

Lists the RestApis resources for your collection.

getSdk

abstract suspend fun getSdk(input: GetSdkRequest): GetSdkResponse

Generates a client SDK for a RestApi and Stage.

getSdkType

abstract suspend fun getSdkType(input: GetSdkTypeRequest): GetSdkTypeResponse

Gets an SDK type.

getSdkTypes

abstract suspend fun getSdkTypes(input: GetSdkTypesRequest = GetSdkTypesRequest { }): GetSdkTypesResponse

Gets SDK types

getStage

abstract suspend fun getStage(input: GetStageRequest): GetStageResponse

Gets information about a Stage resource.

getStages

abstract suspend fun getStages(input: GetStagesRequest): GetStagesResponse

Gets information about one or more Stage resources.

getTags

abstract suspend fun getTags(input: GetTagsRequest): GetTagsResponse

Gets the Tags collection for a given resource.

getUsage

abstract suspend fun getUsage(input: GetUsageRequest): GetUsageResponse

Gets the usage data of a usage plan in a specified time interval.

getUsagePlan

abstract suspend fun getUsagePlan(input: GetUsagePlanRequest): GetUsagePlanResponse

Gets a usage plan of a given plan identifier.

getUsagePlanKey

abstract suspend fun getUsagePlanKey(input: GetUsagePlanKeyRequest): GetUsagePlanKeyResponse

Gets a usage plan key of a given key identifier.

getUsagePlanKeys

abstract suspend fun getUsagePlanKeys(input: GetUsagePlanKeysRequest): GetUsagePlanKeysResponse

Gets all the usage plan keys representing the API keys added to a specified usage plan.

getUsagePlans

abstract suspend fun getUsagePlans(input: GetUsagePlansRequest = GetUsagePlansRequest { }): GetUsagePlansResponse

Gets all the usage plans of the caller's account.

getVpcLink

abstract suspend fun getVpcLink(input: GetVpcLinkRequest): GetVpcLinkResponse

Gets a specified VPC link under the caller's account in a region.

getVpcLinks

abstract suspend fun getVpcLinks(input: GetVpcLinksRequest = GetVpcLinksRequest { }): GetVpcLinksResponse

Gets the VpcLinks collection under the caller's account in a selected region.

importApiKeys

abstract suspend fun importApiKeys(input: ImportApiKeysRequest): ImportApiKeysResponse

Import API keys from an external source, such as a CSV-formatted file.

importDocumentationParts

abstract suspend fun importDocumentationParts(input: ImportDocumentationPartsRequest): ImportDocumentationPartsResponse

Imports documentation parts

importRestApi

abstract suspend fun importRestApi(input: ImportRestApiRequest): ImportRestApiResponse

A feature of the API Gateway control service for creating a new API from an external API definition file.

putGatewayResponse

abstract suspend fun putGatewayResponse(input: PutGatewayResponseRequest): PutGatewayResponseResponse

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

putIntegration

abstract suspend fun putIntegration(input: PutIntegrationRequest): PutIntegrationResponse

Sets up a method's integration.

putIntegrationResponse

abstract suspend fun putIntegrationResponse(input: PutIntegrationResponseRequest): PutIntegrationResponseResponse

Represents a put integration.

putMethod

abstract suspend fun putMethod(input: PutMethodRequest): PutMethodResponse

Add a method to an existing Resource resource.

putMethodResponse

abstract suspend fun putMethodResponse(input: PutMethodResponseRequest): PutMethodResponseResponse

Adds a MethodResponse to an existing Method resource.

putRestApi

abstract suspend fun putRestApi(input: PutRestApiRequest): PutRestApiResponse

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.

rejectDomainNameAccessAssociation

abstract suspend fun rejectDomainNameAccessAssociation(input: RejectDomainNameAccessAssociationRequest): RejectDomainNameAccessAssociationResponse

Rejects a domain name access association with a private custom domain name.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds or updates a tag on a given resource.

testInvokeAuthorizer

abstract suspend fun testInvokeAuthorizer(input: TestInvokeAuthorizerRequest): TestInvokeAuthorizerResponse

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

testInvokeMethod

abstract suspend fun testInvokeMethod(input: TestInvokeMethodRequest): TestInvokeMethodResponse

Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes a tag from a given resource.

updateAccount

abstract suspend fun updateAccount(input: UpdateAccountRequest = UpdateAccountRequest { }): UpdateAccountResponse

Changes information about the current Account resource.

updateApiKey

abstract suspend fun updateApiKey(input: UpdateApiKeyRequest): UpdateApiKeyResponse

Changes information about an ApiKey resource.

updateAuthorizer

abstract suspend fun updateAuthorizer(input: UpdateAuthorizerRequest): UpdateAuthorizerResponse

Updates an existing Authorizer resource.

updateBasePathMapping

abstract suspend fun updateBasePathMapping(input: UpdateBasePathMappingRequest): UpdateBasePathMappingResponse

Changes information about the BasePathMapping resource.

updateClientCertificate

abstract suspend fun updateClientCertificate(input: UpdateClientCertificateRequest): UpdateClientCertificateResponse

Changes information about an ClientCertificate resource.

updateDeployment

abstract suspend fun updateDeployment(input: UpdateDeploymentRequest): UpdateDeploymentResponse

Changes information about a Deployment resource.

updateDocumentationPart

abstract suspend fun updateDocumentationPart(input: UpdateDocumentationPartRequest): UpdateDocumentationPartResponse

Updates a documentation part.

updateDocumentationVersion

abstract suspend fun updateDocumentationVersion(input: UpdateDocumentationVersionRequest): UpdateDocumentationVersionResponse

Updates a documentation version.

updateDomainName

abstract suspend fun updateDomainName(input: UpdateDomainNameRequest): UpdateDomainNameResponse

Changes information about the DomainName resource.

updateGatewayResponse

abstract suspend fun updateGatewayResponse(input: UpdateGatewayResponseRequest): UpdateGatewayResponseResponse

Updates a GatewayResponse of a specified response type on the given RestApi.

updateIntegration

abstract suspend fun updateIntegration(input: UpdateIntegrationRequest): UpdateIntegrationResponse

Represents an update integration.

updateIntegrationResponse

abstract suspend fun updateIntegrationResponse(input: UpdateIntegrationResponseRequest): UpdateIntegrationResponseResponse

Represents an update integration response.

updateMethod

abstract suspend fun updateMethod(input: UpdateMethodRequest): UpdateMethodResponse

Updates an existing Method resource.

updateMethodResponse

abstract suspend fun updateMethodResponse(input: UpdateMethodResponseRequest): UpdateMethodResponseResponse

Updates an existing MethodResponse resource.

updateModel

abstract suspend fun updateModel(input: UpdateModelRequest): UpdateModelResponse

Changes information about a model. The maximum size of the model is 400 KB.

updateRequestValidator

abstract suspend fun updateRequestValidator(input: UpdateRequestValidatorRequest): UpdateRequestValidatorResponse

Updates a RequestValidator of a given RestApi.

updateResource

abstract suspend fun updateResource(input: UpdateResourceRequest): UpdateResourceResponse

Changes information about a Resource resource.

updateRestApi

abstract suspend fun updateRestApi(input: UpdateRestApiRequest): UpdateRestApiResponse

Changes information about the specified API.

updateStage

abstract suspend fun updateStage(input: UpdateStageRequest): UpdateStageResponse

Changes information about a Stage resource.

updateUsage

abstract suspend fun updateUsage(input: UpdateUsageRequest): UpdateUsageResponse

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

updateUsagePlan

abstract suspend fun updateUsagePlan(input: UpdateUsagePlanRequest): UpdateUsagePlanResponse

Updates a usage plan of a given plan Id.

updateVpcLink

abstract suspend fun updateVpcLink(input: UpdateVpcLinkRequest): UpdateVpcLinkResponse

Updates an existing VpcLink of a specified identifier.

Inherited functions

expect abstract fun close()

createApiKey

inline suspend fun ApiGatewayClient.createApiKey(crossinline block: CreateApiKeyRequest.Builder.() -> Unit): CreateApiKeyResponse

Create an ApiKey resource.

createAuthorizer

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

Adds a new Authorizer resource to an existing RestApi resource.

createBasePathMapping

inline suspend fun ApiGatewayClient.createBasePathMapping(crossinline block: CreateBasePathMappingRequest.Builder.() -> Unit): CreateBasePathMappingResponse

Creates a new BasePathMapping resource.

createDeployment

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

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

createDocumentationPart

inline suspend fun ApiGatewayClient.createDocumentationPart(crossinline block: CreateDocumentationPartRequest.Builder.() -> Unit): CreateDocumentationPartResponse

Creates a documentation part.

createDocumentationVersion

inline suspend fun ApiGatewayClient.createDocumentationVersion(crossinline block: CreateDocumentationVersionRequest.Builder.() -> Unit): CreateDocumentationVersionResponse

Creates a documentation version

createDomainName

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

Creates a new domain name.

createDomainNameAccessAssociation

inline suspend fun ApiGatewayClient.createDomainNameAccessAssociation(crossinline block: CreateDomainNameAccessAssociationRequest.Builder.() -> Unit): CreateDomainNameAccessAssociationResponse

Creates a domain name access association resource between an access association source and a private custom domain name.

createModel

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

Adds a new Model resource to an existing RestApi resource.

createRequestValidator

inline suspend fun ApiGatewayClient.createRequestValidator(crossinline block: CreateRequestValidatorRequest.Builder.() -> Unit): CreateRequestValidatorResponse

Creates a RequestValidator of a given RestApi.

createResource

inline suspend fun ApiGatewayClient.createResource(crossinline block: CreateResourceRequest.Builder.() -> Unit): CreateResourceResponse

Creates a Resource resource.

createRestApi

inline suspend fun ApiGatewayClient.createRestApi(crossinline block: CreateRestApiRequest.Builder.() -> Unit): CreateRestApiResponse

Creates a new RestApi resource.

createStage

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

Creates a new Stage resource that references a pre-existing Deployment for the API.

createUsagePlan

inline suspend fun ApiGatewayClient.createUsagePlan(crossinline block: CreateUsagePlanRequest.Builder.() -> Unit): CreateUsagePlanResponse

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

createUsagePlanKey

inline suspend fun ApiGatewayClient.createUsagePlanKey(crossinline block: CreateUsagePlanKeyRequest.Builder.() -> Unit): CreateUsagePlanKeyResponse

Creates a usage plan key for adding an existing API key to a usage plan.

createVpcLink

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

deleteApiKey

inline suspend fun ApiGatewayClient.deleteApiKey(crossinline block: DeleteApiKeyRequest.Builder.() -> Unit): DeleteApiKeyResponse

Deletes the ApiKey resource.

deleteAuthorizer

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

Deletes an existing Authorizer resource.

deleteBasePathMapping

inline suspend fun ApiGatewayClient.deleteBasePathMapping(crossinline block: DeleteBasePathMappingRequest.Builder.() -> Unit): DeleteBasePathMappingResponse

Deletes the BasePathMapping resource.

deleteClientCertificate

inline suspend fun ApiGatewayClient.deleteClientCertificate(crossinline block: DeleteClientCertificateRequest.Builder.() -> Unit): DeleteClientCertificateResponse

Deletes the ClientCertificate resource.

deleteDeployment

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

Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

deleteDocumentationPart

inline suspend fun ApiGatewayClient.deleteDocumentationPart(crossinline block: DeleteDocumentationPartRequest.Builder.() -> Unit): DeleteDocumentationPartResponse

Deletes a documentation part

deleteDocumentationVersion

inline suspend fun ApiGatewayClient.deleteDocumentationVersion(crossinline block: DeleteDocumentationVersionRequest.Builder.() -> Unit): DeleteDocumentationVersionResponse

Deletes a documentation version.

deleteDomainName

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

Deletes the DomainName resource.

deleteDomainNameAccessAssociation

inline suspend fun ApiGatewayClient.deleteDomainNameAccessAssociation(crossinline block: DeleteDomainNameAccessAssociationRequest.Builder.() -> Unit): DeleteDomainNameAccessAssociationResponse

Deletes the DomainNameAccessAssociation resource.

deleteGatewayResponse

inline suspend fun ApiGatewayClient.deleteGatewayResponse(crossinline block: DeleteGatewayResponseRequest.Builder.() -> Unit): DeleteGatewayResponseResponse

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

deleteIntegration

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

Represents a delete integration.

deleteIntegrationResponse

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

Represents a delete integration response.

deleteMethod

inline suspend fun ApiGatewayClient.deleteMethod(crossinline block: DeleteMethodRequest.Builder.() -> Unit): DeleteMethodResponse

Deletes an existing Method resource.

deleteMethodResponse

inline suspend fun ApiGatewayClient.deleteMethodResponse(crossinline block: DeleteMethodResponseRequest.Builder.() -> Unit): DeleteMethodResponseResponse

Deletes an existing MethodResponse resource.

deleteModel

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

Deletes a model.

deleteRequestValidator

inline suspend fun ApiGatewayClient.deleteRequestValidator(crossinline block: DeleteRequestValidatorRequest.Builder.() -> Unit): DeleteRequestValidatorResponse

Deletes a RequestValidator of a given RestApi.

deleteResource

inline suspend fun ApiGatewayClient.deleteResource(crossinline block: DeleteResourceRequest.Builder.() -> Unit): DeleteResourceResponse

Deletes a Resource resource.

deleteRestApi

inline suspend fun ApiGatewayClient.deleteRestApi(crossinline block: DeleteRestApiRequest.Builder.() -> Unit): DeleteRestApiResponse

Deletes the specified API.

deleteStage

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

Deletes a Stage resource.

deleteUsagePlan

inline suspend fun ApiGatewayClient.deleteUsagePlan(crossinline block: DeleteUsagePlanRequest.Builder.() -> Unit): DeleteUsagePlanResponse

Deletes a usage plan of a given plan Id.

deleteUsagePlanKey

inline suspend fun ApiGatewayClient.deleteUsagePlanKey(crossinline block: DeleteUsagePlanKeyRequest.Builder.() -> Unit): DeleteUsagePlanKeyResponse

Deletes a usage plan key and remove the underlying API key from the associated usage plan.

deleteVpcLink

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

Deletes an existing VpcLink of a specified identifier.

flushStageAuthorizersCache

inline suspend fun ApiGatewayClient.flushStageAuthorizersCache(crossinline block: FlushStageAuthorizersCacheRequest.Builder.() -> Unit): FlushStageAuthorizersCacheResponse

Flushes all authorizer cache entries on a stage.

flushStageCache

inline suspend fun ApiGatewayClient.flushStageCache(crossinline block: FlushStageCacheRequest.Builder.() -> Unit): FlushStageCacheResponse

Flushes a stage's cache.

generateClientCertificate

inline suspend fun ApiGatewayClient.generateClientCertificate(crossinline block: GenerateClientCertificateRequest.Builder.() -> Unit): GenerateClientCertificateResponse

Generates a ClientCertificate resource.

getAccount

inline suspend fun ApiGatewayClient.getAccount(crossinline block: GetAccountRequest.Builder.() -> Unit): GetAccountResponse

Gets information about the current Account resource.

getApiKey

inline suspend fun ApiGatewayClient.getApiKey(crossinline block: GetApiKeyRequest.Builder.() -> Unit): GetApiKeyResponse

Gets information about the current ApiKey resource.

getApiKeys

inline suspend fun ApiGatewayClient.getApiKeys(crossinline block: GetApiKeysRequest.Builder.() -> Unit): GetApiKeysResponse

Gets information about the current ApiKeys resource.

getApiKeysPaginated

fun ApiGatewayClient.getApiKeysPaginated(initialRequest: GetApiKeysRequest = GetApiKeysRequest { }): Flow<GetApiKeysResponse>

fun ApiGatewayClient.getApiKeysPaginated(block: GetApiKeysRequest.Builder.() -> Unit): Flow<GetApiKeysResponse>

Paginate over GetApiKeysResponse results.

getAuthorizer

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

Describe an existing Authorizer resource.

getAuthorizers

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

Describe an existing Authorizers resource.

getBasePathMapping

inline suspend fun ApiGatewayClient.getBasePathMapping(crossinline block: GetBasePathMappingRequest.Builder.() -> Unit): GetBasePathMappingResponse

Describe a BasePathMapping resource.

getBasePathMappings

inline suspend fun ApiGatewayClient.getBasePathMappings(crossinline block: GetBasePathMappingsRequest.Builder.() -> Unit): GetBasePathMappingsResponse

Represents a collection of BasePathMapping resources.

getBasePathMappingsPaginated

fun ApiGatewayClient.getBasePathMappingsPaginated(initialRequest: GetBasePathMappingsRequest): Flow<GetBasePathMappingsResponse>

fun ApiGatewayClient.getBasePathMappingsPaginated(block: GetBasePathMappingsRequest.Builder.() -> Unit): Flow<GetBasePathMappingsResponse>

Paginate over GetBasePathMappingsResponse results.

getClientCertificate

inline suspend fun ApiGatewayClient.getClientCertificate(crossinline block: GetClientCertificateRequest.Builder.() -> Unit): GetClientCertificateResponse

Gets information about the current ClientCertificate resource.

getClientCertificates

inline suspend fun ApiGatewayClient.getClientCertificates(crossinline block: GetClientCertificatesRequest.Builder.() -> Unit): GetClientCertificatesResponse

Gets a collection of ClientCertificate resources.

getClientCertificatesPaginated

fun ApiGatewayClient.getClientCertificatesPaginated(initialRequest: GetClientCertificatesRequest = GetClientCertificatesRequest { }): Flow<GetClientCertificatesResponse>

fun ApiGatewayClient.getClientCertificatesPaginated(block: GetClientCertificatesRequest.Builder.() -> Unit): Flow<GetClientCertificatesResponse>

Paginate over GetClientCertificatesResponse results.

getDeployment

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

Gets information about a Deployment resource.

getDeployments

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

Gets information about a Deployments collection.

getDeploymentsPaginated

fun ApiGatewayClient.getDeploymentsPaginated(initialRequest: GetDeploymentsRequest): Flow<GetDeploymentsResponse>

fun ApiGatewayClient.getDeploymentsPaginated(block: GetDeploymentsRequest.Builder.() -> Unit): Flow<GetDeploymentsResponse>

Paginate over GetDeploymentsResponse results.

getDocumentationPart

inline suspend fun ApiGatewayClient.getDocumentationPart(crossinline block: GetDocumentationPartRequest.Builder.() -> Unit): GetDocumentationPartResponse

Gets a documentation part.

getDocumentationParts

inline suspend fun ApiGatewayClient.getDocumentationParts(crossinline block: GetDocumentationPartsRequest.Builder.() -> Unit): GetDocumentationPartsResponse

Gets documentation parts.

getDocumentationVersion

inline suspend fun ApiGatewayClient.getDocumentationVersion(crossinline block: GetDocumentationVersionRequest.Builder.() -> Unit): GetDocumentationVersionResponse

Gets a documentation version.

getDocumentationVersions

inline suspend fun ApiGatewayClient.getDocumentationVersions(crossinline block: GetDocumentationVersionsRequest.Builder.() -> Unit): GetDocumentationVersionsResponse

Gets documentation versions.

getDomainName

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

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

getDomainNameAccessAssociations

inline suspend fun ApiGatewayClient.getDomainNameAccessAssociations(crossinline block: GetDomainNameAccessAssociationsRequest.Builder.() -> Unit): GetDomainNameAccessAssociationsResponse

Represents a collection on DomainNameAccessAssociations resources.

getDomainNames

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

Represents a collection of DomainName resources.

getDomainNamesPaginated

fun ApiGatewayClient.getDomainNamesPaginated(initialRequest: GetDomainNamesRequest = GetDomainNamesRequest { }): Flow<GetDomainNamesResponse>

fun ApiGatewayClient.getDomainNamesPaginated(block: GetDomainNamesRequest.Builder.() -> Unit): Flow<GetDomainNamesResponse>

Paginate over GetDomainNamesResponse results.

getExport

inline suspend fun ApiGatewayClient.getExport(crossinline block: GetExportRequest.Builder.() -> Unit): GetExportResponse

Exports a deployed version of a RestApi in a specified format.

getGatewayResponse

inline suspend fun ApiGatewayClient.getGatewayResponse(crossinline block: GetGatewayResponseRequest.Builder.() -> Unit): GetGatewayResponseResponse

Gets a GatewayResponse of a specified response type on the given RestApi.

getGatewayResponses

inline suspend fun ApiGatewayClient.getGatewayResponses(crossinline block: GetGatewayResponsesRequest.Builder.() -> Unit): GetGatewayResponsesResponse

getIntegration

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

Get the integration settings.

getIntegrationResponse

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

Represents a get integration response.

getMethod

inline suspend fun ApiGatewayClient.getMethod(crossinline block: GetMethodRequest.Builder.() -> Unit): GetMethodResponse

Describe an existing Method resource.

getMethodResponse

inline suspend fun ApiGatewayClient.getMethodResponse(crossinline block: GetMethodResponseRequest.Builder.() -> Unit): GetMethodResponseResponse

Describes a MethodResponse resource.

getModel

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

Describes an existing model defined for a RestApi resource.

getModels

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

Describes existing Models defined for a RestApi resource.

getModelsPaginated

fun ApiGatewayClient.getModelsPaginated(initialRequest: GetModelsRequest): Flow<GetModelsResponse>

fun ApiGatewayClient.getModelsPaginated(block: GetModelsRequest.Builder.() -> Unit): Flow<GetModelsResponse>

Paginate over GetModelsResponse results.

getModelTemplate

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

Generates a sample mapping template that can be used to transform a payload into the structure of a model.

getRequestValidator

inline suspend fun ApiGatewayClient.getRequestValidator(crossinline block: GetRequestValidatorRequest.Builder.() -> Unit): GetRequestValidatorResponse

Gets a RequestValidator of a given RestApi.

getRequestValidators

inline suspend fun ApiGatewayClient.getRequestValidators(crossinline block: GetRequestValidatorsRequest.Builder.() -> Unit): GetRequestValidatorsResponse

Gets the RequestValidators collection of a given RestApi.

getResource

inline suspend fun ApiGatewayClient.getResource(crossinline block: GetResourceRequest.Builder.() -> Unit): GetResourceResponse

Lists information about a resource.

getResources

inline suspend fun ApiGatewayClient.getResources(crossinline block: GetResourcesRequest.Builder.() -> Unit): GetResourcesResponse

Lists information about a collection of Resource resources.

getResourcesPaginated

fun ApiGatewayClient.getResourcesPaginated(initialRequest: GetResourcesRequest): Flow<GetResourcesResponse>

fun ApiGatewayClient.getResourcesPaginated(block: GetResourcesRequest.Builder.() -> Unit): Flow<GetResourcesResponse>

Paginate over GetResourcesResponse results.

getRestApi

inline suspend fun ApiGatewayClient.getRestApi(crossinline block: GetRestApiRequest.Builder.() -> Unit): GetRestApiResponse

Lists the RestApi resource in the collection.

getRestApis

inline suspend fun ApiGatewayClient.getRestApis(crossinline block: GetRestApisRequest.Builder.() -> Unit): GetRestApisResponse

Lists the RestApis resources for your collection.

getRestApisPaginated

fun ApiGatewayClient.getRestApisPaginated(initialRequest: GetRestApisRequest = GetRestApisRequest { }): Flow<GetRestApisResponse>

fun ApiGatewayClient.getRestApisPaginated(block: GetRestApisRequest.Builder.() -> Unit): Flow<GetRestApisResponse>

Paginate over GetRestApisResponse results.

getSdk

inline suspend fun ApiGatewayClient.getSdk(crossinline block: GetSdkRequest.Builder.() -> Unit): GetSdkResponse

Generates a client SDK for a RestApi and Stage.

getSdkType

inline suspend fun ApiGatewayClient.getSdkType(crossinline block: GetSdkTypeRequest.Builder.() -> Unit): GetSdkTypeResponse

Gets an SDK type.

getSdkTypes

inline suspend fun ApiGatewayClient.getSdkTypes(crossinline block: GetSdkTypesRequest.Builder.() -> Unit): GetSdkTypesResponse

Gets SDK types

getStage

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

Gets information about a Stage resource.

getStages

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

Gets information about one or more Stage resources.

getTags

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

Gets the Tags collection for a given resource.

getUsage

inline suspend fun ApiGatewayClient.getUsage(crossinline block: GetUsageRequest.Builder.() -> Unit): GetUsageResponse

Gets the usage data of a usage plan in a specified time interval.

getUsagePaginated

fun ApiGatewayClient.getUsagePaginated(initialRequest: GetUsageRequest): Flow<GetUsageResponse>

fun ApiGatewayClient.getUsagePaginated(block: GetUsageRequest.Builder.() -> Unit): Flow<GetUsageResponse>

Paginate over GetUsageResponse results.

getUsagePlan

inline suspend fun ApiGatewayClient.getUsagePlan(crossinline block: GetUsagePlanRequest.Builder.() -> Unit): GetUsagePlanResponse

Gets a usage plan of a given plan identifier.

getUsagePlanKey

inline suspend fun ApiGatewayClient.getUsagePlanKey(crossinline block: GetUsagePlanKeyRequest.Builder.() -> Unit): GetUsagePlanKeyResponse

Gets a usage plan key of a given key identifier.

getUsagePlanKeys

inline suspend fun ApiGatewayClient.getUsagePlanKeys(crossinline block: GetUsagePlanKeysRequest.Builder.() -> Unit): GetUsagePlanKeysResponse

Gets all the usage plan keys representing the API keys added to a specified usage plan.

getUsagePlanKeysPaginated

fun ApiGatewayClient.getUsagePlanKeysPaginated(initialRequest: GetUsagePlanKeysRequest): Flow<GetUsagePlanKeysResponse>

fun ApiGatewayClient.getUsagePlanKeysPaginated(block: GetUsagePlanKeysRequest.Builder.() -> Unit): Flow<GetUsagePlanKeysResponse>

Paginate over GetUsagePlanKeysResponse results.

getUsagePlans

inline suspend fun ApiGatewayClient.getUsagePlans(crossinline block: GetUsagePlansRequest.Builder.() -> Unit): GetUsagePlansResponse

Gets all the usage plans of the caller's account.

getUsagePlansPaginated

fun ApiGatewayClient.getUsagePlansPaginated(initialRequest: GetUsagePlansRequest = GetUsagePlansRequest { }): Flow<GetUsagePlansResponse>

fun ApiGatewayClient.getUsagePlansPaginated(block: GetUsagePlansRequest.Builder.() -> Unit): Flow<GetUsagePlansResponse>

Paginate over GetUsagePlansResponse results.

getVpcLink

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

Gets a specified VPC link under the caller's account in a region.

getVpcLinks

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

Gets the VpcLinks collection under the caller's account in a selected region.

getVpcLinksPaginated

fun ApiGatewayClient.getVpcLinksPaginated(initialRequest: GetVpcLinksRequest = GetVpcLinksRequest { }): Flow<GetVpcLinksResponse>

fun ApiGatewayClient.getVpcLinksPaginated(block: GetVpcLinksRequest.Builder.() -> Unit): Flow<GetVpcLinksResponse>

Paginate over GetVpcLinksResponse results.

importApiKeys

inline suspend fun ApiGatewayClient.importApiKeys(crossinline block: ImportApiKeysRequest.Builder.() -> Unit): ImportApiKeysResponse

Import API keys from an external source, such as a CSV-formatted file.

importDocumentationParts

inline suspend fun ApiGatewayClient.importDocumentationParts(crossinline block: ImportDocumentationPartsRequest.Builder.() -> Unit): ImportDocumentationPartsResponse

Imports documentation parts

importRestApi

inline suspend fun ApiGatewayClient.importRestApi(crossinline block: ImportRestApiRequest.Builder.() -> Unit): ImportRestApiResponse

A feature of the API Gateway control service for creating a new API from an external API definition file.

putGatewayResponse

inline suspend fun ApiGatewayClient.putGatewayResponse(crossinline block: PutGatewayResponseRequest.Builder.() -> Unit): PutGatewayResponseResponse

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

putIntegration

inline suspend fun ApiGatewayClient.putIntegration(crossinline block: PutIntegrationRequest.Builder.() -> Unit): PutIntegrationResponse

Sets up a method's integration.

putIntegrationResponse

inline suspend fun ApiGatewayClient.putIntegrationResponse(crossinline block: PutIntegrationResponseRequest.Builder.() -> Unit): PutIntegrationResponseResponse

Represents a put integration.

putMethod

inline suspend fun ApiGatewayClient.putMethod(crossinline block: PutMethodRequest.Builder.() -> Unit): PutMethodResponse

Add a method to an existing Resource resource.

putMethodResponse

inline suspend fun ApiGatewayClient.putMethodResponse(crossinline block: PutMethodResponseRequest.Builder.() -> Unit): PutMethodResponseResponse

Adds a MethodResponse to an existing Method resource.

putRestApi

inline suspend fun ApiGatewayClient.putRestApi(crossinline block: PutRestApiRequest.Builder.() -> Unit): PutRestApiResponse

rejectDomainNameAccessAssociation

inline suspend fun ApiGatewayClient.rejectDomainNameAccessAssociation(crossinline block: RejectDomainNameAccessAssociationRequest.Builder.() -> Unit): RejectDomainNameAccessAssociationResponse

Rejects a domain name access association with a private custom domain name.

tagResource

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

Adds or updates a tag on a given resource.

testInvokeAuthorizer

inline suspend fun ApiGatewayClient.testInvokeAuthorizer(crossinline block: TestInvokeAuthorizerRequest.Builder.() -> Unit): TestInvokeAuthorizerResponse

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

testInvokeMethod

inline suspend fun ApiGatewayClient.testInvokeMethod(crossinline block: TestInvokeMethodRequest.Builder.() -> Unit): TestInvokeMethodResponse

Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.

untagResource

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

Removes a tag from a given resource.

updateAccount

inline suspend fun ApiGatewayClient.updateAccount(crossinline block: UpdateAccountRequest.Builder.() -> Unit): UpdateAccountResponse

Changes information about the current Account resource.

updateApiKey

inline suspend fun ApiGatewayClient.updateApiKey(crossinline block: UpdateApiKeyRequest.Builder.() -> Unit): UpdateApiKeyResponse

Changes information about an ApiKey resource.

updateAuthorizer

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

Updates an existing Authorizer resource.

updateBasePathMapping

inline suspend fun ApiGatewayClient.updateBasePathMapping(crossinline block: UpdateBasePathMappingRequest.Builder.() -> Unit): UpdateBasePathMappingResponse

Changes information about the BasePathMapping resource.

updateClientCertificate

inline suspend fun ApiGatewayClient.updateClientCertificate(crossinline block: UpdateClientCertificateRequest.Builder.() -> Unit): UpdateClientCertificateResponse

Changes information about an ClientCertificate resource.

updateDeployment

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

Changes information about a Deployment resource.

updateDocumentationPart

inline suspend fun ApiGatewayClient.updateDocumentationPart(crossinline block: UpdateDocumentationPartRequest.Builder.() -> Unit): UpdateDocumentationPartResponse

Updates a documentation part.

updateDocumentationVersion

inline suspend fun ApiGatewayClient.updateDocumentationVersion(crossinline block: UpdateDocumentationVersionRequest.Builder.() -> Unit): UpdateDocumentationVersionResponse

Updates a documentation version.

updateDomainName

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

Changes information about the DomainName resource.

updateGatewayResponse

inline suspend fun ApiGatewayClient.updateGatewayResponse(crossinline block: UpdateGatewayResponseRequest.Builder.() -> Unit): UpdateGatewayResponseResponse

Updates a GatewayResponse of a specified response type on the given RestApi.

updateIntegration

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

Represents an update integration.

updateIntegrationResponse

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

Represents an update integration response.

updateMethod

inline suspend fun ApiGatewayClient.updateMethod(crossinline block: UpdateMethodRequest.Builder.() -> Unit): UpdateMethodResponse

Updates an existing Method resource.

updateMethodResponse

inline suspend fun ApiGatewayClient.updateMethodResponse(crossinline block: UpdateMethodResponseRequest.Builder.() -> Unit): UpdateMethodResponseResponse

Updates an existing MethodResponse resource.

updateModel

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

Changes information about a model. The maximum size of the model is 400 KB.

updateRequestValidator

inline suspend fun ApiGatewayClient.updateRequestValidator(crossinline block: UpdateRequestValidatorRequest.Builder.() -> Unit): UpdateRequestValidatorResponse

Updates a RequestValidator of a given RestApi.

updateResource

inline suspend fun ApiGatewayClient.updateResource(crossinline block: UpdateResourceRequest.Builder.() -> Unit): UpdateResourceResponse

Changes information about a Resource resource.

updateRestApi

inline suspend fun ApiGatewayClient.updateRestApi(crossinline block: UpdateRestApiRequest.Builder.() -> Unit): UpdateRestApiResponse

Changes information about the specified API.

updateStage

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

Changes information about a Stage resource.

updateUsage

inline suspend fun ApiGatewayClient.updateUsage(crossinline block: UpdateUsageRequest.Builder.() -> Unit): UpdateUsageResponse

Grants a temporary extension to the remaining quota of a usage plan associated with a specified API key.

updateUsagePlan

inline suspend fun ApiGatewayClient.updateUsagePlan(crossinline block: UpdateUsagePlanRequest.Builder.() -> Unit): UpdateUsagePlanResponse

Updates a usage plan of a given plan Id.

updateVpcLink

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

Updates an existing VpcLink of a specified identifier.

withConfig

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

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.