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 ApiGatewayManagementApi The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.ApiGatewayManagementApi.AmazonApiGatewayManagementApiClient

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

Syntax

C#
public class AmazonApiGatewayManagementApiClient : AmazonServiceClient
         IAmazonApiGatewayManagementApi, IAmazonService, IDisposable

The AmazonApiGatewayManagementApiClient type exposes the following members

Constructors

NameDescription
Public Method AmazonApiGatewayManagementApiClient()

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

Constructs AmazonApiGatewayManagementApiClient 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 AmazonApiGatewayManagementApiClient(AmazonApiGatewayManagementApiConfig)

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

Constructs AmazonApiGatewayManagementApiClient with AWS Credentials

Public Method AmazonApiGatewayManagementApiClient(AWSCredentials, RegionEndpoint)

Constructs AmazonApiGatewayManagementApiClient with AWS Credentials

Public Method AmazonApiGatewayManagementApiClient(AWSCredentials, AmazonApiGatewayManagementApiConfig)

Constructs AmazonApiGatewayManagementApiClient with AWS Credentials and an AmazonApiGatewayManagementApiClient Configuration object.

Public Method AmazonApiGatewayManagementApiClient(string, string)

Constructs AmazonApiGatewayManagementApiClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonApiGatewayManagementApiClient(string, string, RegionEndpoint)

Constructs AmazonApiGatewayManagementApiClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonApiGatewayManagementApiClient(string, string, AmazonApiGatewayManagementApiConfig)

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

Public Method AmazonApiGatewayManagementApiClient(string, string, string)

Constructs AmazonApiGatewayManagementApiClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonApiGatewayManagementApiClient(string, string, string, RegionEndpoint)

Constructs AmazonApiGatewayManagementApiClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonApiGatewayManagementApiClient(string, string, string, AmazonApiGatewayManagementApiConfig)

Constructs AmazonApiGatewayManagementApiClient with AWS Access Key ID, AWS Secret Key and an AmazonApiGatewayManagementApiClient 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 DeleteConnection(DeleteConnectionRequest)

Delete the connection with the provided id.

Public Method DeleteConnectionAsync(DeleteConnectionRequest, CancellationToken)

Delete the connection with the provided id.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetConnection(GetConnectionRequest)

Get information about the connection with the provided id.

Public Method GetConnectionAsync(GetConnectionRequest, CancellationToken)

Get information about the connection with the provided id.

Public Method PostToConnection(PostToConnectionRequest)

Sends the provided data to the specified connection.

Public Method PostToConnectionAsync(PostToConnectionRequest, CancellationToken)

Sends the provided data to the specified connection.

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: 2.0, 1.3

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

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