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.

Implementation for accessing APIGateway Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. Amazon API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.APIGateway.AmazonAPIGatewayClient

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

Syntax

C#
public class AmazonAPIGatewayClient : AmazonServiceClient
         IAmazonAPIGateway, IAmazonService, IDisposable

The AmazonAPIGatewayClient type exposes the following members

Constructors

NameDescription
Public Method AmazonAPIGatewayClient()

Constructs AmazonAPIGatewayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAPIGatewayClient(RegionEndpoint)

Constructs AmazonAPIGatewayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAPIGatewayClient(AmazonAPIGatewayConfig)

Constructs AmazonAPIGatewayClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAPIGatewayClient(AWSCredentials)

Constructs AmazonAPIGatewayClient with AWS Credentials

Public Method AmazonAPIGatewayClient(AWSCredentials, RegionEndpoint)

Constructs AmazonAPIGatewayClient with AWS Credentials

Public Method AmazonAPIGatewayClient(AWSCredentials, AmazonAPIGatewayConfig)

Constructs AmazonAPIGatewayClient with AWS Credentials and an AmazonAPIGatewayClient Configuration object.

Public Method AmazonAPIGatewayClient(string, string)

Constructs AmazonAPIGatewayClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAPIGatewayClient(string, string, RegionEndpoint)

Constructs AmazonAPIGatewayClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAPIGatewayClient(string, string, AmazonAPIGatewayConfig)

Constructs AmazonAPIGatewayClient with AWS Access Key ID, AWS Secret Key and an AmazonAPIGatewayClient Configuration object.

Public Method AmazonAPIGatewayClient(string, string, string)

Constructs AmazonAPIGatewayClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAPIGatewayClient(string, string, string, RegionEndpoint)

Constructs AmazonAPIGatewayClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAPIGatewayClient(string, string, string, AmazonAPIGatewayConfig)

Constructs AmazonAPIGatewayClient with AWS Access Key ID, AWS Secret Key and an AmazonAPIGatewayClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

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)

Initiates the asynchronous execution of the CreateApiKey operation.

Public Method CreateAuthorizer(CreateAuthorizerRequest)

Adds a new Authorizer resource to an existing RestApi resource.

Public Method CreateAuthorizerAsync(CreateAuthorizerRequest, CancellationToken)

Initiates the asynchronous execution of the CreateAuthorizer operation.

Public Method CreateBasePathMapping(CreateBasePathMappingRequest)

Creates a new BasePathMapping resource.

Public Method CreateBasePathMappingAsync(CreateBasePathMappingRequest, CancellationToken)

Initiates the asynchronous execution of the CreateBasePathMapping operation.

Public Method CreateDeployment(CreateDeploymentRequest)

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

Public Method CreateDeploymentAsync(CreateDeploymentRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDeployment operation.

Public Method CreateDocumentationPart(CreateDocumentationPartRequest)

Public Method CreateDocumentationPartAsync(CreateDocumentationPartRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDocumentationPart operation.

Public Method CreateDocumentationVersion(CreateDocumentationVersionRequest)

Public Method CreateDocumentationVersionAsync(CreateDocumentationVersionRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDocumentationVersion operation.

Public Method CreateDomainName(CreateDomainNameRequest)

Creates a new domain name.

Public Method CreateDomainNameAsync(CreateDomainNameRequest, CancellationToken)

Initiates the asynchronous execution of the CreateDomainName operation.

Public Method CreateModel(CreateModelRequest)

Adds a new Model resource to an existing RestApi resource.

Public Method CreateModelAsync(CreateModelRequest, CancellationToken)

Initiates the asynchronous execution of the CreateModel operation.

Public Method CreateRequestValidator(CreateRequestValidatorRequest)

Creates a ReqeustValidator of a given RestApi.

Public Method CreateRequestValidatorAsync(CreateRequestValidatorRequest, CancellationToken)

Initiates the asynchronous execution of the CreateRequestValidator operation.

Public Method CreateResource(CreateResourceRequest)

Creates a Resource resource.

Public Method CreateResourceAsync(CreateResourceRequest, CancellationToken)

Initiates the asynchronous execution of the CreateResource operation.

Public Method CreateRestApi(CreateRestApiRequest)

Creates a new RestApi resource.

Public Method CreateRestApiAsync(CreateRestApiRequest, CancellationToken)

Initiates the asynchronous execution of the CreateRestApi operation.

Public Method CreateStage(CreateStageRequest)

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

Public Method CreateStageAsync(CreateStageRequest, CancellationToken)

Initiates the asynchronous execution of the CreateStage operation.

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)

Initiates the asynchronous execution of the CreateUsagePlan operation.

Public Method CreateUsagePlanKey(CreateUsagePlanKeyRequest)

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

Public Method CreateUsagePlanKeyAsync(CreateUsagePlanKeyRequest, CancellationToken)

Initiates the asynchronous execution of the CreateUsagePlanKey operation.

Public Method DeleteApiKey(DeleteApiKeyRequest)

Deletes the ApiKey resource.

Public Method DeleteApiKeyAsync(DeleteApiKeyRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteApiKey operation.

Public Method DeleteAuthorizer(DeleteAuthorizerRequest)

Deletes an existing Authorizer resource.

Public Method DeleteAuthorizerAsync(DeleteAuthorizerRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteAuthorizer operation.

Public Method DeleteBasePathMapping(DeleteBasePathMappingRequest)

Deletes the BasePathMapping resource.

Public Method DeleteBasePathMappingAsync(DeleteBasePathMappingRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteBasePathMapping operation.

Public Method DeleteClientCertificate(DeleteClientCertificateRequest)

Deletes the ClientCertificate resource.

Public Method DeleteClientCertificateAsync(DeleteClientCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteClientCertificate operation.

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)

Initiates the asynchronous execution of the DeleteDeployment operation.

Public Method DeleteDocumentationPart(DeleteDocumentationPartRequest)

Public Method DeleteDocumentationPartAsync(DeleteDocumentationPartRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDocumentationPart operation.

Public Method DeleteDocumentationVersion(DeleteDocumentationVersionRequest)

Public Method DeleteDocumentationVersionAsync(DeleteDocumentationVersionRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDocumentationVersion operation.

Public Method DeleteDomainName(DeleteDomainNameRequest)

Deletes the DomainName resource.

Public Method DeleteDomainNameAsync(DeleteDomainNameRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDomainName operation.

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)

Initiates the asynchronous execution of the DeleteGatewayResponse operation.

Public Method DeleteIntegration(DeleteIntegrationRequest)

Represents a delete integration.

Public Method DeleteIntegrationAsync(DeleteIntegrationRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteIntegration operation.

Public Method DeleteIntegrationResponse(DeleteIntegrationResponseRequest)

Represents a delete integration response.

Public Method DeleteIntegrationResponseAsync(DeleteIntegrationResponseRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteIntegrationResponse operation.

Public Method DeleteMethod(DeleteMethodRequest)

Deletes an existing Method resource.

Public Method DeleteMethodAsync(DeleteMethodRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteMethod operation.

Public Method DeleteMethodResponse(DeleteMethodResponseRequest)

Deletes an existing MethodResponse resource.

Public Method DeleteMethodResponseAsync(DeleteMethodResponseRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteMethodResponse operation.

Public Method DeleteModel(DeleteModelRequest)

Deletes a model.

Public Method DeleteModelAsync(DeleteModelRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteModel operation.

Public Method DeleteRequestValidator(DeleteRequestValidatorRequest)

Deletes a RequestValidator of a given RestApi.

Public Method DeleteRequestValidatorAsync(DeleteRequestValidatorRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteRequestValidator operation.

Public Method DeleteResource(DeleteResourceRequest)

Deletes a Resource resource.

Public Method DeleteResourceAsync(DeleteResourceRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteResource operation.

Public Method DeleteRestApi(DeleteRestApiRequest)

Deletes the specified API.

Public Method DeleteRestApiAsync(DeleteRestApiRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteRestApi operation.

Public Method DeleteStage(DeleteStageRequest)

Deletes a Stage resource.

Public Method DeleteStageAsync(DeleteStageRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteStage operation.

Public Method DeleteUsagePlan(DeleteUsagePlanRequest)

Deletes a usage plan of a given plan Id.

Public Method DeleteUsagePlanAsync(DeleteUsagePlanRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteUsagePlan operation.

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)

Initiates the asynchronous execution of the DeleteUsagePlanKey operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method FlushStageAuthorizersCache(FlushStageAuthorizersCacheRequest)

Flushes all authorizer cache entries on a stage.

Public Method FlushStageAuthorizersCacheAsync(FlushStageAuthorizersCacheRequest, CancellationToken)

Initiates the asynchronous execution of the FlushStageAuthorizersCache operation.

Public Method FlushStageCache(FlushStageCacheRequest)

Flushes a stage's cache.

Public Method FlushStageCacheAsync(FlushStageCacheRequest, CancellationToken)

Initiates the asynchronous execution of the FlushStageCache operation.

Public Method GenerateClientCertificate(GenerateClientCertificateRequest)

Generates a ClientCertificate resource.

Public Method GenerateClientCertificateAsync(GenerateClientCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the GenerateClientCertificate operation.

Public Method GetAccount(GetAccountRequest)

Gets information about the current Account resource.

Public Method GetAccountAsync(GetAccountRequest, CancellationToken)

Initiates the asynchronous execution of the GetAccount operation.

Public Method GetApiKey(GetApiKeyRequest)

Gets information about the current ApiKey resource.

Public Method GetApiKeyAsync(GetApiKeyRequest, CancellationToken)

Initiates the asynchronous execution of the GetApiKey operation.

Public Method GetApiKeys(GetApiKeysRequest)

Gets information about the current ApiKeys resource.

Public Method GetApiKeysAsync(GetApiKeysRequest, CancellationToken)

Initiates the asynchronous execution of the GetApiKeys operation.

Public Method GetAuthorizer(GetAuthorizerRequest)

Describe an existing Authorizer resource.

Public Method GetAuthorizerAsync(GetAuthorizerRequest, CancellationToken)

Initiates the asynchronous execution of the GetAuthorizer operation.

Public Method GetAuthorizers(GetAuthorizersRequest)

Describe an existing Authorizers resource.

Public Method GetAuthorizersAsync(GetAuthorizersRequest, CancellationToken)

Initiates the asynchronous execution of the GetAuthorizers operation.

Public Method GetBasePathMapping(GetBasePathMappingRequest)

Describe a BasePathMapping resource.

Public Method GetBasePathMappingAsync(GetBasePathMappingRequest, CancellationToken)

Initiates the asynchronous execution of the GetBasePathMapping operation.

Public Method GetBasePathMappings(GetBasePathMappingsRequest)

Represents a collection of BasePathMapping resources.

Public Method GetBasePathMappingsAsync(GetBasePathMappingsRequest, CancellationToken)

Initiates the asynchronous execution of the GetBasePathMappings operation.

Public Method GetClientCertificate(GetClientCertificateRequest)

Gets information about the current ClientCertificate resource.

Public Method GetClientCertificateAsync(GetClientCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the GetClientCertificate operation.

Public Method GetClientCertificates(GetClientCertificatesRequest)

Gets a collection of ClientCertificate resources.

Public Method GetClientCertificatesAsync(GetClientCertificatesRequest, CancellationToken)

Initiates the asynchronous execution of the GetClientCertificates operation.

Public Method GetDeployment(GetDeploymentRequest)

Gets information about a Deployment resource.

Public Method GetDeploymentAsync(GetDeploymentRequest, CancellationToken)

Initiates the asynchronous execution of the GetDeployment operation.

Public Method GetDeployments(GetDeploymentsRequest)

Gets information about a Deployments collection.

Public Method GetDeploymentsAsync(GetDeploymentsRequest, CancellationToken)

Initiates the asynchronous execution of the GetDeployments operation.

Public Method GetDocumentationPart(GetDocumentationPartRequest)

Public Method GetDocumentationPartAsync(GetDocumentationPartRequest, CancellationToken)

Initiates the asynchronous execution of the GetDocumentationPart operation.

Public Method GetDocumentationParts(GetDocumentationPartsRequest)

Public Method GetDocumentationPartsAsync(GetDocumentationPartsRequest, CancellationToken)

Initiates the asynchronous execution of the GetDocumentationParts operation.

Public Method GetDocumentationVersion(GetDocumentationVersionRequest)

Public Method GetDocumentationVersionAsync(GetDocumentationVersionRequest, CancellationToken)

Initiates the asynchronous execution of the GetDocumentationVersion operation.

Public Method GetDocumentationVersions(GetDocumentationVersionsRequest)

Public Method GetDocumentationVersionsAsync(GetDocumentationVersionsRequest, CancellationToken)

Initiates the asynchronous execution of the GetDocumentationVersions operation.

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)

Initiates the asynchronous execution of the GetDomainName operation.

Public Method GetDomainNames(GetDomainNamesRequest)

Represents a collection of DomainName resources.

Public Method GetDomainNamesAsync(GetDomainNamesRequest, CancellationToken)

Initiates the asynchronous execution of the GetDomainNames operation.

Public Method GetExport(GetExportRequest)

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

Public Method GetExportAsync(GetExportRequest, CancellationToken)

Initiates the asynchronous execution of the GetExport operation.

Public Method GetGatewayResponse(GetGatewayResponseRequest)

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

Public Method GetGatewayResponseAsync(GetGatewayResponseRequest, CancellationToken)

Initiates the asynchronous execution of the GetGatewayResponse operation.

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 Amazon API Gateway-generated default GatewayResponses collection for the supported response types.

Public Method GetGatewayResponsesAsync(GetGatewayResponsesRequest, CancellationToken)

Initiates the asynchronous execution of the GetGatewayResponses operation.

Public Method GetIntegration(GetIntegrationRequest)

Represents a get integration.

Public Method GetIntegrationAsync(GetIntegrationRequest, CancellationToken)

Initiates the asynchronous execution of the GetIntegration operation.

Public Method GetIntegrationResponse(GetIntegrationResponseRequest)

Represents a get integration response.

Public Method GetIntegrationResponseAsync(GetIntegrationResponseRequest, CancellationToken)

Initiates the asynchronous execution of the GetIntegrationResponse operation.

Public Method GetMethod(GetMethodRequest)

Describe an existing Method resource.

Public Method GetMethodAsync(GetMethodRequest, CancellationToken)

Initiates the asynchronous execution of the GetMethod operation.

Public Method GetMethodResponse(GetMethodResponseRequest)

Describes a MethodResponse resource.

Public Method GetMethodResponseAsync(GetMethodResponseRequest, CancellationToken)

Initiates the asynchronous execution of the GetMethodResponse operation.

Public Method GetModel(GetModelRequest)

Describes an existing model defined for a RestApi resource.

Public Method GetModelAsync(GetModelRequest, CancellationToken)

Initiates the asynchronous execution of the GetModel operation.

Public Method GetModels(GetModelsRequest)

Describes existing Models defined for a RestApi resource.

Public Method GetModelsAsync(GetModelsRequest, CancellationToken)

Initiates the asynchronous execution of the GetModels operation.

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)

Initiates the asynchronous execution of the GetModelTemplate operation.

Public Method GetRequestValidator(GetRequestValidatorRequest)

Gets a RequestValidator of a given RestApi.

Public Method GetRequestValidatorAsync(GetRequestValidatorRequest, CancellationToken)

Initiates the asynchronous execution of the GetRequestValidator operation.

Public Method GetRequestValidators(GetRequestValidatorsRequest)

Gets the RequestValidators collection of a given RestApi.

Public Method GetRequestValidatorsAsync(GetRequestValidatorsRequest, CancellationToken)

Initiates the asynchronous execution of the GetRequestValidators operation.

Public Method GetResource(GetResourceRequest)

Lists information about a resource.

Public Method GetResourceAsync(GetResourceRequest, CancellationToken)

Initiates the asynchronous execution of the GetResource operation.

Public Method GetResources(GetResourcesRequest)

Lists information about a collection of Resource resources.

Public Method GetResourcesAsync(GetResourcesRequest, CancellationToken)

Initiates the asynchronous execution of the GetResources operation.

Public Method GetRestApi(GetRestApiRequest)

Lists the RestApi resource in the collection.

Public Method GetRestApiAsync(GetRestApiRequest, CancellationToken)

Initiates the asynchronous execution of the GetRestApi operation.

Public Method GetRestApis(GetRestApisRequest)

Lists the RestApis resources for your collection.

Public Method GetRestApisAsync(GetRestApisRequest, CancellationToken)

Initiates the asynchronous execution of the GetRestApis operation.

Public Method GetSdk(GetSdkRequest)

Generates a client SDK for a RestApi and Stage.

Public Method GetSdkAsync(GetSdkRequest, CancellationToken)

Initiates the asynchronous execution of the GetSdk operation.

Public Method GetSdkType(GetSdkTypeRequest)

Public Method GetSdkTypeAsync(GetSdkTypeRequest, CancellationToken)

Initiates the asynchronous execution of the GetSdkType operation.

Public Method GetSdkTypes(GetSdkTypesRequest)

Public Method GetSdkTypesAsync(GetSdkTypesRequest, CancellationToken)

Initiates the asynchronous execution of the GetSdkTypes operation.

Public Method GetStage(GetStageRequest)

Gets information about a Stage resource.

Public Method GetStageAsync(GetStageRequest, CancellationToken)

Initiates the asynchronous execution of the GetStage operation.

Public Method GetStages(GetStagesRequest)

Gets information about one or more Stage resources.

Public Method GetStagesAsync(GetStagesRequest, CancellationToken)

Initiates the asynchronous execution of the GetStages operation.

Public Method GetUsage(GetUsageRequest)

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

Public Method GetUsageAsync(GetUsageRequest, CancellationToken)

Initiates the asynchronous execution of the GetUsage operation.

Public Method GetUsagePlan(GetUsagePlanRequest)

Gets a usage plan of a given plan identifier.

Public Method GetUsagePlanAsync(GetUsagePlanRequest, CancellationToken)

Initiates the asynchronous execution of the GetUsagePlan operation.

Public Method GetUsagePlanKey(GetUsagePlanKeyRequest)

Gets a usage plan key of a given key identifier.

Public Method GetUsagePlanKeyAsync(GetUsagePlanKeyRequest, CancellationToken)

Initiates the asynchronous execution of the GetUsagePlanKey operation.

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)

Initiates the asynchronous execution of the GetUsagePlanKeys operation.

Public Method GetUsagePlans(GetUsagePlansRequest)

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

Public Method GetUsagePlansAsync(GetUsagePlansRequest, CancellationToken)

Initiates the asynchronous execution of the GetUsagePlans operation.

Public Method ImportApiKeys(ImportApiKeysRequest)

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

Public Method ImportApiKeysAsync(ImportApiKeysRequest, CancellationToken)

Initiates the asynchronous execution of the ImportApiKeys operation.

Public Method ImportDocumentationParts(ImportDocumentationPartsRequest)

Public Method ImportDocumentationPartsAsync(ImportDocumentationPartsRequest, CancellationToken)

Initiates the asynchronous execution of the ImportDocumentationParts operation.

Public Method ImportRestApi(ImportRestApiRequest)

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

Public Method ImportRestApiAsync(ImportRestApiRequest, CancellationToken)

Initiates the asynchronous execution of the ImportRestApi operation.

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)

Initiates the asynchronous execution of the PutGatewayResponse operation.

Public Method PutIntegration(PutIntegrationRequest)

Sets up a method's integration.

Public Method PutIntegrationAsync(PutIntegrationRequest, CancellationToken)

Initiates the asynchronous execution of the PutIntegration operation.

Public Method PutIntegrationResponse(PutIntegrationResponseRequest)

Represents a put integration.

Public Method PutIntegrationResponseAsync(PutIntegrationResponseRequest, CancellationToken)

Initiates the asynchronous execution of the PutIntegrationResponse operation.

Public Method PutMethod(PutMethodRequest)

Add a method to an existing Resource resource.

Public Method PutMethodAsync(PutMethodRequest, CancellationToken)

Initiates the asynchronous execution of the PutMethod operation.

Public Method PutMethodResponse(PutMethodResponseRequest)

Adds a MethodResponse to an existing Method resource.

Public Method PutMethodResponseAsync(PutMethodResponseRequest, CancellationToken)

Initiates the asynchronous execution of the PutMethodResponse operation.

Public Method PutRestApi(PutRestApiRequest)

A feature of the Amazon 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)

Initiates the asynchronous execution of the PutRestApi operation.

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)

Initiates the asynchronous execution of the TestInvokeAuthorizer operation.

Public Method TestInvokeMethod(TestInvokeMethodRequest)

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

Public Method TestInvokeMethodAsync(TestInvokeMethodRequest, CancellationToken)

Initiates the asynchronous execution of the TestInvokeMethod operation.

Public Method UpdateAccount(UpdateAccountRequest)

Changes information about the current Account resource.

Public Method UpdateAccountAsync(UpdateAccountRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateAccount operation.

Public Method UpdateApiKey(UpdateApiKeyRequest)

Changes information about an ApiKey resource.

Public Method UpdateApiKeyAsync(UpdateApiKeyRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateApiKey operation.

Public Method UpdateAuthorizer(UpdateAuthorizerRequest)

Updates an existing Authorizer resource.

Public Method UpdateAuthorizerAsync(UpdateAuthorizerRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateAuthorizer operation.

Public Method UpdateBasePathMapping(UpdateBasePathMappingRequest)

Changes information about the BasePathMapping resource.

Public Method UpdateBasePathMappingAsync(UpdateBasePathMappingRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateBasePathMapping operation.

Public Method UpdateClientCertificate(UpdateClientCertificateRequest)

Changes information about an ClientCertificate resource.

Public Method UpdateClientCertificateAsync(UpdateClientCertificateRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateClientCertificate operation.

Public Method UpdateDeployment(UpdateDeploymentRequest)

Changes information about a Deployment resource.

Public Method UpdateDeploymentAsync(UpdateDeploymentRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDeployment operation.

Public Method UpdateDocumentationPart(UpdateDocumentationPartRequest)

Public Method UpdateDocumentationPartAsync(UpdateDocumentationPartRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDocumentationPart operation.

Public Method UpdateDocumentationVersion(UpdateDocumentationVersionRequest)

Public Method UpdateDocumentationVersionAsync(UpdateDocumentationVersionRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDocumentationVersion operation.

Public Method UpdateDomainName(UpdateDomainNameRequest)

Changes information about the DomainName resource.

Public Method UpdateDomainNameAsync(UpdateDomainNameRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateDomainName operation.

Public Method UpdateGatewayResponse(UpdateGatewayResponseRequest)

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

Public Method UpdateGatewayResponseAsync(UpdateGatewayResponseRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateGatewayResponse operation.

Public Method UpdateIntegration(UpdateIntegrationRequest)

Represents an update integration.

Public Method UpdateIntegrationAsync(UpdateIntegrationRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateIntegration operation.

Public Method UpdateIntegrationResponse(UpdateIntegrationResponseRequest)

Represents an update integration response.

Public Method UpdateIntegrationResponseAsync(UpdateIntegrationResponseRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateIntegrationResponse operation.

Public Method UpdateMethod(UpdateMethodRequest)

Updates an existing Method resource.

Public Method UpdateMethodAsync(UpdateMethodRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateMethod operation.

Public Method UpdateMethodResponse(UpdateMethodResponseRequest)

Updates an existing MethodResponse resource.

Public Method UpdateMethodResponseAsync(UpdateMethodResponseRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateMethodResponse operation.

Public Method UpdateModel(UpdateModelRequest)

Changes information about a model.

Public Method UpdateModelAsync(UpdateModelRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateModel operation.

Public Method UpdateRequestValidator(UpdateRequestValidatorRequest)

Updates a RequestValidator of a given RestApi.

Public Method UpdateRequestValidatorAsync(UpdateRequestValidatorRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateRequestValidator operation.

Public Method UpdateResource(UpdateResourceRequest)

Changes information about a Resource resource.

Public Method UpdateResourceAsync(UpdateResourceRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateResource operation.

Public Method UpdateRestApi(UpdateRestApiRequest)

Changes information about the specified API.

Public Method UpdateRestApiAsync(UpdateRestApiRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateRestApi operation.

Public Method UpdateStage(UpdateStageRequest)

Changes information about a Stage resource.

Public Method UpdateStageAsync(UpdateStageRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateStage operation.

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)

Initiates the asynchronous execution of the UpdateUsage operation.

Public Method UpdateUsagePlan(UpdateUsagePlanRequest)

Updates a usage plan of a given plan Id.

Public Method UpdateUsagePlanAsync(UpdateUsagePlanRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateUsagePlan operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms