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 ApiGatewayV2 Amazon API Gateway V2

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.ApiGatewayV2.AmazonApiGatewayV2Client

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

Syntax

C#
public class AmazonApiGatewayV2Client : AmazonServiceClient
         IAmazonApiGatewayV2, IAmazonService, IDisposable

The AmazonApiGatewayV2Client type exposes the following members

Constructors

NameDescription
Public Method AmazonApiGatewayV2Client()

Constructs AmazonApiGatewayV2Client 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 AmazonApiGatewayV2Client(RegionEndpoint)

Constructs AmazonApiGatewayV2Client 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 AmazonApiGatewayV2Client(AmazonApiGatewayV2Config)

Constructs AmazonApiGatewayV2Client 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 AmazonApiGatewayV2Client(AWSCredentials)

Constructs AmazonApiGatewayV2Client with AWS Credentials

Public Method AmazonApiGatewayV2Client(AWSCredentials, RegionEndpoint)

Constructs AmazonApiGatewayV2Client with AWS Credentials

Public Method AmazonApiGatewayV2Client(AWSCredentials, AmazonApiGatewayV2Config)

Constructs AmazonApiGatewayV2Client with AWS Credentials and an AmazonApiGatewayV2Client Configuration object.

Public Method AmazonApiGatewayV2Client(string, string)

Constructs AmazonApiGatewayV2Client with AWS Access Key ID and AWS Secret Key

Public Method AmazonApiGatewayV2Client(string, string, RegionEndpoint)

Constructs AmazonApiGatewayV2Client with AWS Access Key ID and AWS Secret Key

Public Method AmazonApiGatewayV2Client(string, string, AmazonApiGatewayV2Config)

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

Public Method AmazonApiGatewayV2Client(string, string, string)

Constructs AmazonApiGatewayV2Client with AWS Access Key ID and AWS Secret Key

Public Method AmazonApiGatewayV2Client(string, string, string, RegionEndpoint)

Constructs AmazonApiGatewayV2Client with AWS Access Key ID and AWS Secret Key

Public Method AmazonApiGatewayV2Client(string, string, string, AmazonApiGatewayV2Config)

Constructs AmazonApiGatewayV2Client with AWS Access Key ID, AWS Secret Key and an AmazonApiGatewayV2Client 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 CreateApi(CreateApiRequest)

Creates an Api resource.

Public Method CreateApiAsync(CreateApiRequest, CancellationToken)

Creates an Api resource.

Public Method CreateApiMapping(CreateApiMappingRequest)

Creates an API mapping.

Public Method CreateApiMappingAsync(CreateApiMappingRequest, CancellationToken)

Creates an API mapping.

Public Method CreateAuthorizer(CreateAuthorizerRequest)

Creates an Authorizer for an API.

Public Method CreateAuthorizerAsync(CreateAuthorizerRequest, CancellationToken)

Creates an Authorizer for an API.

Public Method CreateDeployment(CreateDeploymentRequest)

Creates a Deployment for an API.

Public Method CreateDeploymentAsync(CreateDeploymentRequest, CancellationToken)

Creates a Deployment for an API.

Public Method CreateDomainName(CreateDomainNameRequest)

Creates a domain name.

Public Method CreateDomainNameAsync(CreateDomainNameRequest, CancellationToken)

Creates a domain name.

Public Method CreateIntegration(CreateIntegrationRequest)

Creates an Integration.

Public Method CreateIntegrationAsync(CreateIntegrationRequest, CancellationToken)

Creates an Integration.

Public Method CreateIntegrationResponse(CreateIntegrationResponseRequest)

Creates an IntegrationResponses.

Public Method CreateIntegrationResponseAsync(CreateIntegrationResponseRequest, CancellationToken)

Creates an IntegrationResponses.

Public Method CreateModel(CreateModelRequest)

Creates a Model for an API.

Public Method CreateModelAsync(CreateModelRequest, CancellationToken)

Creates a Model for an API.

Public Method CreateRoute(CreateRouteRequest)

Creates a Route for an API.

Public Method CreateRouteAsync(CreateRouteRequest, CancellationToken)

Creates a Route for an API.

Public Method CreateRouteResponse(CreateRouteResponseRequest)

Creates a RouteResponse for a Route.

Public Method CreateRouteResponseAsync(CreateRouteResponseRequest, CancellationToken)

Creates a RouteResponse for a Route.

Public Method CreateStage(CreateStageRequest)

Creates a Stage for an API.

Public Method CreateStageAsync(CreateStageRequest, CancellationToken)

Creates a Stage for an API.

Public Method CreateVpcLink(CreateVpcLinkRequest)

Creates a VPC link.

Public Method CreateVpcLinkAsync(CreateVpcLinkRequest, CancellationToken)

Creates a VPC link.

Public Method DeleteAccessLogSettings(DeleteAccessLogSettingsRequest)

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

Public Method DeleteAccessLogSettingsAsync(DeleteAccessLogSettingsRequest, CancellationToken)

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

Public Method DeleteApi(DeleteApiRequest)

Deletes an Api resource.

Public Method DeleteApiAsync(DeleteApiRequest, CancellationToken)

Deletes an Api resource.

Public Method DeleteApiMapping(DeleteApiMappingRequest)

Deletes an API mapping.

Public Method DeleteApiMappingAsync(DeleteApiMappingRequest, CancellationToken)

Deletes an API mapping.

Public Method DeleteAuthorizer(DeleteAuthorizerRequest)

Deletes an Authorizer.

Public Method DeleteAuthorizerAsync(DeleteAuthorizerRequest, CancellationToken)

Deletes an Authorizer.

Public Method DeleteCorsConfiguration(DeleteCorsConfigurationRequest)

Deletes a CORS configuration.

Public Method DeleteCorsConfigurationAsync(DeleteCorsConfigurationRequest, CancellationToken)

Deletes a CORS configuration.

Public Method DeleteDeployment(DeleteDeploymentRequest)

Deletes a Deployment.

Public Method DeleteDeploymentAsync(DeleteDeploymentRequest, CancellationToken)

Deletes a Deployment.

Public Method DeleteDomainName(DeleteDomainNameRequest)

Deletes a domain name.

Public Method DeleteDomainNameAsync(DeleteDomainNameRequest, CancellationToken)

Deletes a domain name.

Public Method DeleteIntegration(DeleteIntegrationRequest)

Deletes an Integration.

Public Method DeleteIntegrationAsync(DeleteIntegrationRequest, CancellationToken)

Deletes an Integration.

Public Method DeleteIntegrationResponse(DeleteIntegrationResponseRequest)

Deletes an IntegrationResponses.

Public Method DeleteIntegrationResponseAsync(DeleteIntegrationResponseRequest, CancellationToken)

Deletes an IntegrationResponses.

Public Method DeleteModel(DeleteModelRequest)

Deletes a Model.

Public Method DeleteModelAsync(DeleteModelRequest, CancellationToken)

Deletes a Model.

Public Method DeleteRoute(DeleteRouteRequest)

Deletes a Route.

Public Method DeleteRouteAsync(DeleteRouteRequest, CancellationToken)

Deletes a Route.

Public Method DeleteRouteRequestParameter(DeleteRouteRequestParameterRequest)

Deletes a route request parameter.

Public Method DeleteRouteRequestParameterAsync(DeleteRouteRequestParameterRequest, CancellationToken)

Deletes a route request parameter.

Public Method DeleteRouteResponse(DeleteRouteResponseRequest)

Deletes a RouteResponse.

Public Method DeleteRouteResponseAsync(DeleteRouteResponseRequest, CancellationToken)

Deletes a RouteResponse.

Public Method DeleteRouteSettings(DeleteRouteSettingsRequest)

Deletes the RouteSettings for a stage.

Public Method DeleteRouteSettingsAsync(DeleteRouteSettingsRequest, CancellationToken)

Deletes the RouteSettings for a stage.

Public Method DeleteStage(DeleteStageRequest)

Deletes a Stage.

Public Method DeleteStageAsync(DeleteStageRequest, CancellationToken)

Deletes a Stage.

Public Method DeleteVpcLink(DeleteVpcLinkRequest)

Deletes a VPC link.

Public Method DeleteVpcLinkAsync(DeleteVpcLinkRequest, CancellationToken)

Deletes a VPC link.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetApi(GetApiRequest)

Gets an Api resource.

Public Method GetApiAsync(GetApiRequest, CancellationToken)

Gets an Api resource.

Public Method GetApiMapping(GetApiMappingRequest)

Gets an API mapping.

Public Method GetApiMappingAsync(GetApiMappingRequest, CancellationToken)

Gets an API mapping.

Public Method GetApiMappings(GetApiMappingsRequest)

Gets API mappings.

Public Method GetApiMappingsAsync(GetApiMappingsRequest, CancellationToken)

Gets API mappings.

Public Method GetApis(GetApisRequest)

Gets a collection of Api resources.

Public Method GetApisAsync(GetApisRequest, CancellationToken)

Gets a collection of Api resources.

Public Method GetAuthorizer(GetAuthorizerRequest)

Gets an Authorizer.

Public Method GetAuthorizerAsync(GetAuthorizerRequest, CancellationToken)

Gets an Authorizer.

Public Method GetAuthorizers(GetAuthorizersRequest)

Gets the Authorizers for an API.

Public Method GetAuthorizersAsync(GetAuthorizersRequest, CancellationToken)

Gets the Authorizers for an API.

Public Method GetDeployment(GetDeploymentRequest)

Gets a Deployment.

Public Method GetDeploymentAsync(GetDeploymentRequest, CancellationToken)

Gets a Deployment.

Public Method GetDeployments(GetDeploymentsRequest)

Gets the Deployments for an API.

Public Method GetDeploymentsAsync(GetDeploymentsRequest, CancellationToken)

Gets the Deployments for an API.

Public Method GetDomainName(GetDomainNameRequest)

Gets a domain name.

Public Method GetDomainNameAsync(GetDomainNameRequest, CancellationToken)

Gets a domain name.

Public Method GetDomainNames(GetDomainNamesRequest)

Gets the domain names for an AWS account.

Public Method GetDomainNamesAsync(GetDomainNamesRequest, CancellationToken)

Gets the domain names for an AWS account.

Public Method GetIntegration(GetIntegrationRequest)

Gets an Integration.

Public Method GetIntegrationAsync(GetIntegrationRequest, CancellationToken)

Gets an Integration.

Public Method GetIntegrationResponse(GetIntegrationResponseRequest)

Gets an IntegrationResponses.

Public Method GetIntegrationResponseAsync(GetIntegrationResponseRequest, CancellationToken)

Gets an IntegrationResponses.

Public Method GetIntegrationResponses(GetIntegrationResponsesRequest)

Gets the IntegrationResponses for an Integration.

Public Method GetIntegrationResponsesAsync(GetIntegrationResponsesRequest, CancellationToken)

Gets the IntegrationResponses for an Integration.

Public Method GetIntegrations(GetIntegrationsRequest)

Gets the Integrations for an API.

Public Method GetIntegrationsAsync(GetIntegrationsRequest, CancellationToken)

Gets the Integrations for an API.

Public Method GetModel(GetModelRequest)

Gets a Model.

Public Method GetModelAsync(GetModelRequest, CancellationToken)

Gets a Model.

Public Method GetModels(GetModelsRequest)

Gets the Models for an API.

Public Method GetModelsAsync(GetModelsRequest, CancellationToken)

Gets the Models for an API.

Public Method GetModelTemplate(GetModelTemplateRequest)

Gets a model template.

Public Method GetModelTemplateAsync(GetModelTemplateRequest, CancellationToken)

Gets a model template.

Public Method GetRoute(GetRouteRequest)

Gets a Route.

Public Method GetRouteAsync(GetRouteRequest, CancellationToken)

Gets a Route.

Public Method GetRouteResponse(GetRouteResponseRequest)

Gets a RouteResponse.

Public Method GetRouteResponseAsync(GetRouteResponseRequest, CancellationToken)

Gets a RouteResponse.

Public Method GetRouteResponses(GetRouteResponsesRequest)

Gets the RouteResponses for a Route.

Public Method GetRouteResponsesAsync(GetRouteResponsesRequest, CancellationToken)

Gets the RouteResponses for a Route.

Public Method GetRoutes(GetRoutesRequest)

Gets the Routes for an API.

Public Method GetRoutesAsync(GetRoutesRequest, CancellationToken)

Gets the Routes for an API.

Public Method GetStage(GetStageRequest)

Gets a Stage.

Public Method GetStageAsync(GetStageRequest, CancellationToken)

Gets a Stage.

Public Method GetStages(GetStagesRequest)

Gets the Stages for an API.

Public Method GetStagesAsync(GetStagesRequest, CancellationToken)

Gets the Stages for an API.

Public Method GetTags(GetTagsRequest)

Gets a collection of Tag resources.

Public Method GetTagsAsync(GetTagsRequest, CancellationToken)

Gets a collection of Tag resources.

Public Method GetVpcLink(GetVpcLinkRequest)

Gets a VPC link.

Public Method GetVpcLinkAsync(GetVpcLinkRequest, CancellationToken)

Gets a VPC link.

Public Method GetVpcLinks(GetVpcLinksRequest)

Gets a collection of VPC links.

Public Method GetVpcLinksAsync(GetVpcLinksRequest, CancellationToken)

Gets a collection of VPC links.

Public Method ImportApi(ImportApiRequest)

Imports an API.

Public Method ImportApiAsync(ImportApiRequest, CancellationToken)

Imports an API.

Public Method ReimportApi(ReimportApiRequest)

Puts an Api resource.

Public Method ReimportApiAsync(ReimportApiRequest, CancellationToken)

Puts an Api resource.

Public Method TagResource(TagResourceRequest)

Creates a new Tag resource to represent a tag.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Creates a new Tag resource to represent a tag.

Public Method UntagResource(UntagResourceRequest)

Deletes a Tag.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Deletes a Tag.

Public Method UpdateApi(UpdateApiRequest)

Updates an Api resource.

Public Method UpdateApiAsync(UpdateApiRequest, CancellationToken)

Updates an Api resource.

Public Method UpdateApiMapping(UpdateApiMappingRequest)

The API mapping.

Public Method UpdateApiMappingAsync(UpdateApiMappingRequest, CancellationToken)

The API mapping.

Public Method UpdateAuthorizer(UpdateAuthorizerRequest)

Updates an Authorizer.

Public Method UpdateAuthorizerAsync(UpdateAuthorizerRequest, CancellationToken)

Updates an Authorizer.

Public Method UpdateDeployment(UpdateDeploymentRequest)

Updates a Deployment.

Public Method UpdateDeploymentAsync(UpdateDeploymentRequest, CancellationToken)

Updates a Deployment.

Public Method UpdateDomainName(UpdateDomainNameRequest)

Updates a domain name.

Public Method UpdateDomainNameAsync(UpdateDomainNameRequest, CancellationToken)

Updates a domain name.

Public Method UpdateIntegration(UpdateIntegrationRequest)

Updates an Integration.

Public Method UpdateIntegrationAsync(UpdateIntegrationRequest, CancellationToken)

Updates an Integration.

Public Method UpdateIntegrationResponse(UpdateIntegrationResponseRequest)

Updates an IntegrationResponses.

Public Method UpdateIntegrationResponseAsync(UpdateIntegrationResponseRequest, CancellationToken)

Updates an IntegrationResponses.

Public Method UpdateModel(UpdateModelRequest)

Updates a Model.

Public Method UpdateModelAsync(UpdateModelRequest, CancellationToken)

Updates a Model.

Public Method UpdateRoute(UpdateRouteRequest)

Updates a Route.

Public Method UpdateRouteAsync(UpdateRouteRequest, CancellationToken)

Updates a Route.

Public Method UpdateRouteResponse(UpdateRouteResponseRequest)

Updates a RouteResponse.

Public Method UpdateRouteResponseAsync(UpdateRouteResponseRequest, CancellationToken)

Updates a RouteResponse.

Public Method UpdateStage(UpdateStageRequest)

Updates a Stage.

Public Method UpdateStageAsync(UpdateStageRequest, CancellationToken)

Updates a Stage.

Public Method UpdateVpcLink(UpdateVpcLinkRequest)

Updates a VPC link.

Public Method UpdateVpcLinkAsync(UpdateVpcLinkRequest, CancellationToken)

Updates a VPC link.

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