com.amazonaws.services.apigatewaymanagementapi

Interface AmazonApiGatewayManagementApiAsync

All Superinterfaces:

AmazonApiGatewayManagementApi

All Known Implementing Classes:

AbstractAmazonApiGatewayManagementApiAsync, AmazonApiGatewayManagementApiAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonApiGatewayManagementApiAsync
extends AmazonApiGatewayManagementApi

Interface for accessing AmazonApiGatewayManagementApi asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonApiGatewayManagementApiAsync instead.

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.

Field Summary

Fields inherited from interface com.amazonaws.services.apigatewaymanagementapi.AmazonApiGatewayManagementApi

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<DeleteConnectionResult>	deleteConnectionAsync(DeleteConnectionRequest deleteConnectionRequest) Delete the connection with the provided id.
Future<DeleteConnectionResult>	deleteConnectionAsync(DeleteConnectionRequest deleteConnectionRequest, AsyncHandler<DeleteConnectionRequest,DeleteConnectionResult> asyncHandler) Delete the connection with the provided id.
Future<GetConnectionResult>	getConnectionAsync(GetConnectionRequest getConnectionRequest) Get information about the connection with the provided id.
Future<GetConnectionResult>	getConnectionAsync(GetConnectionRequest getConnectionRequest, AsyncHandler<GetConnectionRequest,GetConnectionResult> asyncHandler) Get information about the connection with the provided id.
Future<PostToConnectionResult>	postToConnectionAsync(PostToConnectionRequest postToConnectionRequest) Sends the provided data to the specified connection.
Future<PostToConnectionResult>	postToConnectionAsync(PostToConnectionRequest postToConnectionRequest, AsyncHandler<PostToConnectionRequest,PostToConnectionResult> asyncHandler) Sends the provided data to the specified connection.

Methods inherited from interface com.amazonaws.services.apigatewaymanagementapi.AmazonApiGatewayManagementApi

deleteConnection, getCachedResponseMetadata, getConnection, postToConnection, shutdown

Method Detail

deleteConnectionAsync

Future<DeleteConnectionResult> deleteConnectionAsync(DeleteConnectionRequest deleteConnectionRequest)

Delete the connection with the provided id.

Parameters:

deleteConnectionRequest -

Returns:

A Java Future containing the result of the DeleteConnection operation returned by the service.

See Also:

AWS API Documentation

deleteConnectionAsync

Future<DeleteConnectionResult> deleteConnectionAsync(DeleteConnectionRequest deleteConnectionRequest,
                                                     AsyncHandler<DeleteConnectionRequest,DeleteConnectionResult> asyncHandler)

Delete the connection with the provided id.

Parameters:

deleteConnectionRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteConnection operation returned by the service.

See Also:

AWS API Documentation

getConnectionAsync

Future<GetConnectionResult> getConnectionAsync(GetConnectionRequest getConnectionRequest)

Get information about the connection with the provided id.

Parameters:

getConnectionRequest -

Returns:

A Java Future containing the result of the GetConnection operation returned by the service.

See Also:

AWS API Documentation

getConnectionAsync

Future<GetConnectionResult> getConnectionAsync(GetConnectionRequest getConnectionRequest,
                                               AsyncHandler<GetConnectionRequest,GetConnectionResult> asyncHandler)

Get information about the connection with the provided id.

Parameters:

getConnectionRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetConnection operation returned by the service.

See Also:

AWS API Documentation

postToConnectionAsync

Future<PostToConnectionResult> postToConnectionAsync(PostToConnectionRequest postToConnectionRequest)

Sends the provided data to the specified connection.

Parameters:

postToConnectionRequest -

Returns:

A Java Future containing the result of the PostToConnection operation returned by the service.

See Also:

AWS API Documentation

postToConnectionAsync

Future<PostToConnectionResult> postToConnectionAsync(PostToConnectionRequest postToConnectionRequest,
                                                     AsyncHandler<PostToConnectionRequest,PostToConnectionResult> asyncHandler)

Sends the provided data to the specified connection.

Parameters:

postToConnectionRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the PostToConnection operation returned by the service.

See Also:

AWS API Documentation