All Known Subinterfaces:

AmazonApiGatewayManagementApiAsync

All Known Implementing Classes:

AbstractAmazonApiGatewayManagementApi, AbstractAmazonApiGatewayManagementApiAsync, AmazonApiGatewayManagementApiAsyncClient, AmazonApiGatewayManagementApiClient

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

• Field Summary

  Fields

  Modifier and Type	Field and Description
  static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  DeleteConnectionResult	deleteConnection (DeleteConnectionRequest deleteConnectionRequest) Delete the connection with the provided id.
  ResponseMetadata	getCachedResponseMetadata (AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
  GetConnectionResult	getConnection (GetConnectionRequest getConnectionRequest) Get information about the connection with the provided id.
  PostToConnectionResult	postToConnection (PostToConnectionRequest postToConnectionRequest) Sends the provided data to the specified connection.
  void	shutdown () Shuts down this client object, releasing any resources that might be held open.

• Field Detail

  • ENDPOINT_PREFIX

    static final String ENDPOINT_PREFIX

    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

    See Also:

    RegionUtils.getRegionsForService(String), Constant Field Values

• Method Detail

  • deleteConnection

    DeleteConnectionResult deleteConnection(DeleteConnectionRequest deleteConnectionRequest)

    Delete the connection with the provided id.

    Parameters:

    deleteConnectionRequest -

    Returns:

    Result of the DeleteConnection operation returned by the service.

    Throws:

    GoneException - The connection with the provided id no longer exists.

    LimitExceededException - The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.

    ForbiddenException - The caller is not authorized to invoke this operation.

    See Also:

    AWS API Documentation

  • getConnection

    GetConnectionResult getConnection(GetConnectionRequest getConnectionRequest)

    Get information about the connection with the provided id.

    Parameters:

    getConnectionRequest -

    Returns:

    Result of the GetConnection operation returned by the service.

    Throws:

    GoneException - The connection with the provided id no longer exists.

    LimitExceededException - The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.

    ForbiddenException - The caller is not authorized to invoke this operation.

    See Also:

    AWS API Documentation

  • postToConnection

    PostToConnectionResult postToConnection(PostToConnectionRequest postToConnectionRequest)

    Sends the provided data to the specified connection.

    Parameters:

    postToConnectionRequest -

    Returns:

    Result of the PostToConnection operation returned by the service.

    Throws:

    GoneException - The connection with the provided id no longer exists.

    LimitExceededException - The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.

    PayloadTooLargeException - The data has exceeded the maximum size allowed.

    ForbiddenException - The caller is not authorized to invoke this operation.

    See Also:

    AWS API Documentation

  • shutdown

    void shutdown()

    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

  • getCachedResponseMetadata

    ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

    Parameters:

    request - The originally executed request.

    Returns:

    The response metadata for the specified request, or null if none is available.