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 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

Amazon.ApiGatewayManagementApi.IAmazonApiGatewayManagementApi

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

Syntax

C#
public interface IAmazonApiGatewayManagementApi
         IAmazonService, IDisposable

The IAmazonApiGatewayManagementApi type exposes the following members

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 DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

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

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.

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