AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing APIGateway

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.

Inheritance Hierarchy

Amazon.APIGateway.IAmazonAPIGateway

Namespace: Amazon.APIGateway
Assembly: AWSSDK.APIGateway.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonAPIGateway
         IAmazonService, IDisposable

The IAmazonAPIGateway type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.APIGateway.Model.IAPIGatewayPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateApiKey(CreateApiKeyRequest)

Create an ApiKey resource.

Public Method CreateApiKeyAsync(CreateApiKeyRequest, CancellationToken)

Create an ApiKey resource.

Public Method CreateAuthorizer(CreateAuthorizerRequest)

Adds a new Authorizer resource to an existing RestApi resource.

Public Method CreateAuthorizerAsync(CreateAuthorizerRequest, CancellationToken)

Adds a new Authorizer resource to an existing RestApi resource.

Public Method CreateBasePathMapping(CreateBasePathMappingRequest)

Creates a new BasePathMapping resource.

Public Method CreateBasePathMappingAsync(CreateBasePathMappingRequest, CancellationToken)

Creates a new BasePathMapping resource.

Public Method CreateDeployment(CreateDeploymentRequest)

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

Public Method CreateDeploymentAsync(CreateDeploymentRequest, CancellationToken)

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

Public Method CreateDocumentationPart(CreateDocumentationPartRequest)

Creates a documentation part.

Public Method CreateDocumentationPartAsync(CreateDocumentationPartRequest, CancellationToken)

Creates a documentation part.

Public Method CreateDocumentationVersion(CreateDocumentationVersionRequest)

Creates a documentation version

Public Method CreateDocumentationVersionAsync(CreateDocumentationVersionRequest, CancellationToken)

Creates a documentation version

Public Method CreateDomainName(CreateDomainNameRequest)

Creates a new domain name.

Public Method CreateDomainNameAsync(CreateDomainNameRequest, CancellationToken)

Creates a new domain name.

Public Method CreateModel(CreateModelRequest)

Adds a new Model resource to an existing RestApi resource.

Public Method CreateModelAsync(CreateModelRequest, CancellationToken)

Adds a new Model resource to an existing RestApi resource.

Public Method CreateRequestValidator(CreateRequestValidatorRequest)

Creates a RequestValidator of a given RestApi.

Public Method CreateRequestValidatorAsync(CreateRequestValidatorRequest, CancellationToken)

Creates a RequestValidator of a given RestApi.

Public Method CreateResource(CreateResourceRequest)

Creates a Resource resource.

Public Method CreateResourceAsync(CreateResourceRequest, CancellationToken)

Creates a Resource resource.

Public Method CreateRestApi(CreateRestApiRequest)

Creates a new RestApi resource.

Public Method CreateRestApiAsync(CreateRestApiRequest, CancellationToken)

Creates a new RestApi resource.

Public Method CreateStage(CreateStageRequest)

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

Public Method CreateStageAsync(CreateStageRequest, CancellationToken)

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

Public Method CreateUsagePlan(CreateUsagePlanRequest)

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

Public Method CreateUsagePlanAsync(CreateUsagePlanRequest, CancellationToken)

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

Public Method CreateUsagePlanKey(CreateUsagePlanKeyRequest)

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

Public Method CreateUsagePlanKeyAsync(CreateUsagePlanKeyRequest, CancellationToken)

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

Public Method CreateVpcLink(CreateVpcLinkRequest)

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.

Public Method CreateVpcLinkAsync(CreateVpcLinkRequest, CancellationToken)

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.

Public Method DeleteApiKey(DeleteApiKeyRequest)

Deletes the ApiKey resource.

Public Method DeleteApiKeyAsync(DeleteApiKeyRequest, CancellationToken)

Deletes the ApiKey resource.

Public Method DeleteAuthorizer(DeleteAuthorizerRequest)

Deletes an existing Authorizer resource.

Public Method DeleteAuthorizerAsync(DeleteAuthorizerRequest, CancellationToken)

Deletes an existing Authorizer resource.

Public Method DeleteBasePathMapping(DeleteBasePathMappingRequest)

Deletes the BasePathMapping resource.

Public Method DeleteBasePathMappingAsync(DeleteBasePathMappingRequest, CancellationToken)

Deletes the BasePathMapping resource.

Public Method DeleteClientCertificate(DeleteClientCertificateRequest)

Deletes the ClientCertificate resource.

Public Method DeleteClientCertificateAsync(DeleteClientCertificateRequest, CancellationToken)

Deletes the ClientCertificate resource.

Public Method DeleteDeployment(DeleteDeploymentRequest)

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

Public Method DeleteDeploymentAsync(DeleteDeploymentRequest, CancellationToken)

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

Public Method DeleteDocumentationPart(DeleteDocumentationPartRequest)

Deletes a documentation part

Public Method DeleteDocumentationPartAsync(DeleteDocumentationPartRequest, CancellationToken)

Deletes a documentation part

Public Method DeleteDocumentationVersion(DeleteDocumentationVersionRequest)

Deletes a documentation version.

Public Method DeleteDocumentationVersionAsync(DeleteDocumentationVersionRequest, CancellationToken)

Deletes a documentation version.

Public Method DeleteDomainName(DeleteDomainNameRequest)

Deletes the DomainName resource.

Public Method DeleteDomainNameAsync(DeleteDomainNameRequest, CancellationToken)

Deletes the DomainName resource.

Public Method DeleteGatewayResponse(DeleteGatewayResponseRequest)

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

Public Method DeleteGatewayResponseAsync(DeleteGatewayResponseRequest, CancellationToken)

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

Public Method DeleteIntegration(DeleteIntegrationRequest)

Represents a delete integration.

Public Method DeleteIntegrationAsync(DeleteIntegrationRequest, CancellationToken)

Represents a delete integration.

Public Method DeleteIntegrationResponse(DeleteIntegrationResponseRequest)

Represents a delete integration response.

Public Method DeleteIntegrationResponseAsync(DeleteIntegrationResponseRequest, CancellationToken)

Represents a delete integration response.

Public Method DeleteMethod(DeleteMethodRequest)

Deletes an existing Method resource.

Public Method DeleteMethodAsync(DeleteMethodRequest, CancellationToken)

Deletes an existing Method resource.

Public Method DeleteMethodResponse(DeleteMethodResponseRequest)

Deletes an existing MethodResponse resource.

Public Method DeleteMethodResponseAsync(DeleteMethodResponseRequest, CancellationToken)

Deletes an existing MethodResponse resource.

Public Method DeleteModel(DeleteModelRequest)

Deletes a model.

Public Method DeleteModelAsync(DeleteModelRequest, CancellationToken)

Deletes a model.

Public Method DeleteRequestValidator(DeleteRequestValidatorRequest)

Deletes a RequestValidator of a given RestApi.

Public Method DeleteRequestValidatorAsync(DeleteRequestValidatorRequest, CancellationToken)

Deletes a RequestValidator of a given RestApi.

Public Method DeleteResource(DeleteResourceRequest)

Deletes a Resource resource.

Public Method DeleteResourceAsync(DeleteResourceRequest, CancellationToken)

Deletes a Resource resource.

Public Method DeleteRestApi(DeleteRestApiRequest)

Deletes the specified API.

Public Method DeleteRestApiAsync(DeleteRestApiRequest, CancellationToken)

Deletes the specified API.

Public Method DeleteStage(DeleteStageRequest)

Deletes a Stage resource.

Public Method DeleteStageAsync(DeleteStageRequest, CancellationToken)

Deletes a Stage resource.

Public Method DeleteUsagePlan(DeleteUsagePlanRequest)

Deletes a usage plan of a given plan Id.

Public Method DeleteUsagePlanAsync(DeleteUsagePlanRequest, CancellationToken)

Deletes a usage plan of a given plan Id.

Public Method DeleteUsagePlanKey(DeleteUsagePlanKeyRequest)

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

Public Method DeleteUsagePlanKeyAsync(DeleteUsagePlanKeyRequest, CancellationToken)

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

Public Method DeleteVpcLink(DeleteVpcLinkRequest)

Deletes an existing VpcLink of a specified identifier.

Public Method DeleteVpcLinkAsync(DeleteVpcLinkRequest, CancellationToken)

Deletes an existing VpcLink of a specified identifier.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method FlushStageAuthorizersCache(FlushStageAuthorizersCacheRequest)

Flushes all authorizer cache entries on a stage.

Public Method FlushStageAuthorizersCacheAsync(FlushStageAuthorizersCacheRequest, CancellationToken)

Flushes all authorizer cache entries on a stage.

Public Method FlushStageCache(FlushStageCacheRequest)

Flushes a stage's cache.

Public Method FlushStageCacheAsync(FlushStageCacheRequest, CancellationToken)

Flushes a stage's cache.

Public Method GenerateClientCertificate(GenerateClientCertificateRequest)

Generates a ClientCertificate resource.

Public Method GenerateClientCertificateAsync(GenerateClientCertificateRequest, CancellationToken)

Generates a ClientCertificate resource.

Public Method GetAccount(GetAccountRequest)

Gets information about the current Account resource.

Public Method GetAccountAsync(GetAccountRequest, CancellationToken)

Gets information about the current Account resource.

Public Method GetApiKey(GetApiKeyRequest)

Gets information about the current ApiKey resource.

Public Method GetApiKeyAsync(GetApiKeyRequest, CancellationToken)

Gets information about the current ApiKey resource.

Public Method GetApiKeys(GetApiKeysRequest)

Gets information about the current ApiKeys resource.

Public Method GetApiKeysAsync(GetApiKeysRequest, CancellationToken)

Gets information about the current ApiKeys resource.

Public Method GetAuthorizer(GetAuthorizerRequest)

Describe an existing Authorizer resource.

Public Method GetAuthorizerAsync(GetAuthorizerRequest, CancellationToken)

Describe an existing Authorizer resource.

Public Method GetAuthorizers(GetAuthorizersRequest)

Describe an existing Authorizers resource.

Public Method GetAuthorizersAsync(GetAuthorizersRequest, CancellationToken)

Describe an existing Authorizers resource.

Public Method GetBasePathMapping(GetBasePathMappingRequest)

Describe a BasePathMapping resource.

Public Method GetBasePathMappingAsync(GetBasePathMappingRequest, CancellationToken)

Describe a BasePathMapping resource.

Public Method GetBasePathMappings(GetBasePathMappingsRequest)

Represents a collection of BasePathMapping resources.

Public Method GetBasePathMappingsAsync(GetBasePathMappingsRequest, CancellationToken)

Represents a collection of BasePathMapping resources.

Public Method GetClientCertificate(GetClientCertificateRequest)

Gets information about the current ClientCertificate resource.

Public Method GetClientCertificateAsync(GetClientCertificateRequest, CancellationToken)

Gets information about the current ClientCertificate resource.

Public Method GetClientCertificates(GetClientCertificatesRequest)

Gets a collection of ClientCertificate resources.

Public Method GetClientCertificatesAsync(GetClientCertificatesRequest, CancellationToken)

Gets a collection of ClientCertificate resources.

Public Method GetDeployment(GetDeploymentRequest)

Gets information about a Deployment resource.

Public Method GetDeploymentAsync(GetDeploymentRequest, CancellationToken)

Gets information about a Deployment resource.

Public Method GetDeployments(GetDeploymentsRequest)

Gets information about a Deployments collection.

Public Method GetDeploymentsAsync(GetDeploymentsRequest, CancellationToken)

Gets information about a Deployments collection.

Public Method GetDocumentationPart(GetDocumentationPartRequest)

Gets a documentation part.

Public Method GetDocumentationPartAsync(GetDocumentationPartRequest, CancellationToken)

Gets a documentation part.

Public Method GetDocumentationParts(GetDocumentationPartsRequest)

Gets documentation parts.

Public Method GetDocumentationPartsAsync(GetDocumentationPartsRequest, CancellationToken)

Gets documentation parts.

Public Method GetDocumentationVersion(GetDocumentationVersionRequest)

Gets a documentation version.

Public Method GetDocumentationVersionAsync(GetDocumentationVersionRequest, CancellationToken)

Gets a documentation version.

Public Method GetDocumentationVersions(GetDocumentationVersionsRequest)

Gets documentation versions.

Public Method GetDocumentationVersionsAsync(GetDocumentationVersionsRequest, CancellationToken)

Gets documentation versions.

Public Method GetDomainName(GetDomainNameRequest)

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

Public Method GetDomainNameAsync(GetDomainNameRequest, CancellationToken)

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

Public Method GetDomainNames(GetDomainNamesRequest)

Represents a collection of DomainName resources.

Public Method GetDomainNamesAsync(GetDomainNamesRequest, CancellationToken)

Represents a collection of DomainName resources.

Public Method GetExport(GetExportRequest)

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

Public Method GetExportAsync(GetExportRequest, CancellationToken)

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

Public Method GetGatewayResponse(GetGatewayResponseRequest)

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

Public Method GetGatewayResponseAsync(GetGatewayResponseRequest, CancellationToken)

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

Public Method GetGatewayResponses(GetGatewayResponsesRequest)

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.

Public Method GetGatewayResponsesAsync(GetGatewayResponsesRequest, CancellationToken)

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.

Public Method GetIntegration(GetIntegrationRequest)

Get the integration settings.

Public Method GetIntegrationAsync(GetIntegrationRequest, CancellationToken)

Get the integration settings.

Public Method GetIntegrationResponse(GetIntegrationResponseRequest)

Represents a get integration response.

Public Method GetIntegrationResponseAsync(GetIntegrationResponseRequest, CancellationToken)

Represents a get integration response.

Public Method GetMethod(GetMethodRequest)

Describe an existing Method resource.

Public Method GetMethodAsync(GetMethodRequest, CancellationToken)

Describe an existing Method resource.

Public Method GetMethodResponse(GetMethodResponseRequest)

Describes a MethodResponse resource.

Public Method GetMethodResponseAsync(GetMethodResponseRequest, CancellationToken)

Describes a MethodResponse resource.

Public Method GetModel(GetModelRequest)

Describes an existing model defined for a RestApi resource.

Public Method GetModelAsync(GetModelRequest, CancellationToken)

Describes an existing model defined for a RestApi resource.

Public Method GetModels(GetModelsRequest)

Describes existing Models defined for a RestApi resource.

Public Method GetModelsAsync(GetModelsRequest, CancellationToken)

Describes existing Models defined for a RestApi resource.

Public Method GetModelTemplate(GetModelTemplateRequest)

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

Public Method GetModelTemplateAsync(GetModelTemplateRequest, CancellationToken)

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

Public Method GetRequestValidator(GetRequestValidatorRequest)

Gets a RequestValidator of a given RestApi.

Public Method GetRequestValidatorAsync(GetRequestValidatorRequest, CancellationToken)

Gets a RequestValidator of a given RestApi.

Public Method GetRequestValidators(GetRequestValidatorsRequest)

Gets the RequestValidators collection of a given RestApi.

Public Method GetRequestValidatorsAsync(GetRequestValidatorsRequest, CancellationToken)

Gets the RequestValidators collection of a given RestApi.

Public Method GetResource(GetResourceRequest)

Lists information about a resource.

Public Method GetResourceAsync(GetResourceRequest, CancellationToken)

Lists information about a resource.

Public Method GetResources(GetResourcesRequest)

Lists information about a collection of Resource resources.

Public Method GetResourcesAsync(GetResourcesRequest, CancellationToken)

Lists information about a collection of Resource resources.

Public Method GetRestApi(GetRestApiRequest)

Lists the RestApi resource in the collection.

Public Method GetRestApiAsync(GetRestApiRequest, CancellationToken)

Lists the RestApi resource in the collection.

Public Method GetRestApis(GetRestApisRequest)

Lists the RestApis resources for your collection.

Public Method GetRestApisAsync(GetRestApisRequest, CancellationToken)

Lists the RestApis resources for your collection.

Public Method GetSdk(GetSdkRequest)

Generates a client SDK for a RestApi and Stage.

Public Method GetSdkAsync(GetSdkRequest, CancellationToken)

Generates a client SDK for a RestApi and Stage.

Public Method GetSdkType(GetSdkTypeRequest)

Gets an SDK type.

Public Method GetSdkTypeAsync(GetSdkTypeRequest, CancellationToken)

Gets an SDK type.

Public Method GetSdkTypes(GetSdkTypesRequest)

Gets SDK types

Public Method GetSdkTypesAsync(GetSdkTypesRequest, CancellationToken)

Gets SDK types

Public Method GetStage(GetStageRequest)

Gets information about a Stage resource.

Public Method GetStageAsync(GetStageRequest, CancellationToken)

Gets information about a Stage resource.

Public Method GetStages(GetStagesRequest)

Gets information about one or more Stage resources.

Public Method GetStagesAsync(GetStagesRequest, CancellationToken)

Gets information about one or more Stage resources.

Public Method GetTags(GetTagsRequest)

Gets the Tags collection for a given resource.

Public Method GetTagsAsync(GetTagsRequest, CancellationToken)

Gets the Tags collection for a given resource.

Public Method GetUsage(GetUsageRequest)

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

Public Method GetUsageAsync(GetUsageRequest, CancellationToken)

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

Public Method GetUsagePlan(GetUsagePlanRequest)

Gets a usage plan of a given plan identifier.

Public Method GetUsagePlanAsync(GetUsagePlanRequest, CancellationToken)

Gets a usage plan of a given plan identifier.

Public Method GetUsagePlanKey(GetUsagePlanKeyRequest)

Gets a usage plan key of a given key identifier.

Public Method GetUsagePlanKeyAsync(GetUsagePlanKeyRequest, CancellationToken)

Gets a usage plan key of a given key identifier.

Public Method GetUsagePlanKeys(GetUsagePlanKeysRequest)

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

Public Method GetUsagePlanKeysAsync(GetUsagePlanKeysRequest, CancellationToken)

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

Public Method GetUsagePlans(GetUsagePlansRequest)

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

Public Method GetUsagePlansAsync(GetUsagePlansRequest, CancellationToken)

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

Public Method GetVpcLink(GetVpcLinkRequest)

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

Public Method GetVpcLinkAsync(GetVpcLinkRequest, CancellationToken)

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

Public Method GetVpcLinks(GetVpcLinksRequest)

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

Public Method GetVpcLinksAsync(GetVpcLinksRequest, CancellationToken)

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

Public Method ImportApiKeys(ImportApiKeysRequest)

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

Public Method ImportApiKeysAsync(ImportApiKeysRequest, CancellationToken)

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

Public Method ImportDocumentationParts(ImportDocumentationPartsRequest)

Imports documentation parts

Public Method ImportDocumentationPartsAsync(ImportDocumentationPartsRequest, CancellationToken)

Imports documentation parts

Public Method ImportRestApi(ImportRestApiRequest)

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

Public Method ImportRestApiAsync(ImportRestApiRequest, CancellationToken)

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

Public Method PutGatewayResponse(PutGatewayResponseRequest)

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

Public Method PutGatewayResponseAsync(PutGatewayResponseRequest, CancellationToken)

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

Public Method PutIntegration(PutIntegrationRequest)

Sets up a method's integration.

Public Method PutIntegrationAsync(PutIntegrationRequest, CancellationToken)

Sets up a method's integration.

Public Method PutIntegrationResponse(PutIntegrationResponseRequest)

Represents a put integration.

Public Method PutIntegrationResponseAsync(PutIntegrationResponseRequest, CancellationToken)

Represents a put integration.

Public Method PutMethod(PutMethodRequest)

Add a method to an existing Resource resource.

Public Method PutMethodAsync(PutMethodRequest, CancellationToken)

Add a method to an existing Resource resource.

Public Method PutMethodResponse(PutMethodResponseRequest)

Adds a MethodResponse to an existing Method resource.

Public Method PutMethodResponseAsync(PutMethodResponseRequest, CancellationToken)

Adds a MethodResponse to an existing Method resource.

Public Method PutRestApi(PutRestApiRequest)

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.

Public Method PutRestApiAsync(PutRestApiRequest, CancellationToken)

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.

Public Method TagResource(TagResourceRequest)

Adds or updates a tag on a given resource.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Adds or updates a tag on a given resource.

Public Method TestInvokeAuthorizer(TestInvokeAuthorizerRequest)

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

Public Method TestInvokeAuthorizerAsync(TestInvokeAuthorizerRequest, CancellationToken)

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

Public Method TestInvokeMethod(TestInvokeMethodRequest)

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

Public Method TestInvokeMethodAsync(TestInvokeMethodRequest, CancellationToken)

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

Public Method UntagResource(UntagResourceRequest)

Removes a tag from a given resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes a tag from a given resource.

Public Method UpdateAccount(UpdateAccountRequest)

Changes information about the current Account resource.

Public Method UpdateAccountAsync(UpdateAccountRequest, CancellationToken)

Changes information about the current Account resource.

Public Method UpdateApiKey(UpdateApiKeyRequest)

Changes information about an ApiKey resource.

Public Method UpdateApiKeyAsync(UpdateApiKeyRequest, CancellationToken)

Changes information about an ApiKey resource.

Public Method UpdateAuthorizer(UpdateAuthorizerRequest)

Updates an existing Authorizer resource.

Public Method UpdateAuthorizerAsync(UpdateAuthorizerRequest, CancellationToken)

Updates an existing Authorizer resource.

Public Method UpdateBasePathMapping(UpdateBasePathMappingRequest)

Changes information about the BasePathMapping resource.

Public Method UpdateBasePathMappingAsync(UpdateBasePathMappingRequest, CancellationToken)

Changes information about the BasePathMapping resource.

Public Method UpdateClientCertificate(UpdateClientCertificateRequest)

Changes information about an ClientCertificate resource.

Public Method UpdateClientCertificateAsync(UpdateClientCertificateRequest, CancellationToken)

Changes information about an ClientCertificate resource.

Public Method UpdateDeployment(UpdateDeploymentRequest)

Changes information about a Deployment resource.

Public Method UpdateDeploymentAsync(UpdateDeploymentRequest, CancellationToken)

Changes information about a Deployment resource.

Public Method UpdateDocumentationPart(UpdateDocumentationPartRequest)

Updates a documentation part.

Public Method UpdateDocumentationPartAsync(UpdateDocumentationPartRequest, CancellationToken)

Updates a documentation part.

Public Method UpdateDocumentationVersion(UpdateDocumentationVersionRequest)

Updates a documentation version.

Public Method UpdateDocumentationVersionAsync(UpdateDocumentationVersionRequest, CancellationToken)

Updates a documentation version.

Public Method UpdateDomainName(UpdateDomainNameRequest)

Changes information about the DomainName resource.

Public Method UpdateDomainNameAsync(UpdateDomainNameRequest, CancellationToken)

Changes information about the DomainName resource.

Public Method UpdateGatewayResponse(UpdateGatewayResponseRequest)

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

Public Method UpdateGatewayResponseAsync(UpdateGatewayResponseRequest, CancellationToken)

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

Public Method UpdateIntegration(UpdateIntegrationRequest)

Represents an update integration.

Public Method UpdateIntegrationAsync(UpdateIntegrationRequest, CancellationToken)

Represents an update integration.

Public Method UpdateIntegrationResponse(UpdateIntegrationResponseRequest)

Represents an update integration response.

Public Method UpdateIntegrationResponseAsync(UpdateIntegrationResponseRequest, CancellationToken)

Represents an update integration response.

Public Method UpdateMethod(UpdateMethodRequest)

Updates an existing Method resource.

Public Method UpdateMethodAsync(UpdateMethodRequest, CancellationToken)

Updates an existing Method resource.

Public Method UpdateMethodResponse(UpdateMethodResponseRequest)

Updates an existing MethodResponse resource.

Public Method UpdateMethodResponseAsync(UpdateMethodResponseRequest, CancellationToken)

Updates an existing MethodResponse resource.

Public Method UpdateModel(UpdateModelRequest)

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

Public Method UpdateModelAsync(UpdateModelRequest, CancellationToken)

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

Public Method UpdateRequestValidator(UpdateRequestValidatorRequest)

Updates a RequestValidator of a given RestApi.

Public Method UpdateRequestValidatorAsync(UpdateRequestValidatorRequest, CancellationToken)

Updates a RequestValidator of a given RestApi.

Public Method UpdateResource(UpdateResourceRequest)

Changes information about a Resource resource.

Public Method UpdateResourceAsync(UpdateResourceRequest, CancellationToken)

Changes information about a Resource resource.

Public Method UpdateRestApi(UpdateRestApiRequest)

Changes information about the specified API.

Public Method UpdateRestApiAsync(UpdateRestApiRequest, CancellationToken)

Changes information about the specified API.

Public Method UpdateStage(UpdateStageRequest)

Changes information about a Stage resource.

Public Method UpdateStageAsync(UpdateStageRequest, CancellationToken)

Changes information about a Stage resource.

Public Method UpdateUsage(UpdateUsageRequest)

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

Public Method UpdateUsageAsync(UpdateUsageRequest, CancellationToken)

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

Public Method UpdateUsagePlan(UpdateUsagePlanRequest)

Updates a usage plan of a given plan Id.

Public Method UpdateUsagePlanAsync(UpdateUsagePlanRequest, CancellationToken)

Updates a usage plan of a given plan Id.

Public Method UpdateVpcLink(UpdateVpcLinkRequest)

Updates an existing VpcLink of a specified identifier.

Public Method UpdateVpcLinkAsync(UpdateVpcLinkRequest, CancellationToken)

Updates an existing VpcLink of a specified identifier.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5