com.amazonaws.services.apigatewaymanagementapi

Class AmazonApiGatewayManagementApiClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.apigatewaymanagementapi.AmazonApiGatewayManagementApiClient

All Implemented Interfaces:

AmazonApiGatewayManagementApi

Direct Known Subclasses:

AmazonApiGatewayManagementApiAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonApiGatewayManagementApiClient
extends AmazonWebServiceClient
implements AmazonApiGatewayManagementApi

Client for accessing AmazonApiGatewayManagementApi. All service calls made using this client are blocking, and will not return until the service call completes.

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 class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonApiGatewayManagementApiClientBuilder	builder()
DeleteConnectionResult	deleteConnection(DeleteConnectionRequest request) 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 request) Get information about the connection with the provided id.
PostToConnectionResult	postToConnection(PostToConnectionRequest request) Sends the provided data to the specified connection.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonApiGatewayManagementApiClientBuilder builder()

deleteConnection

public DeleteConnectionResult deleteConnection(DeleteConnectionRequest request)

Delete the connection with the provided id.

Specified by:

deleteConnection in interface AmazonApiGatewayManagementApi

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

public GetConnectionResult getConnection(GetConnectionRequest request)

Get information about the connection with the provided id.

Specified by:

getConnection in interface AmazonApiGatewayManagementApi

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

public PostToConnectionResult postToConnection(PostToConnectionRequest request)

Sends the provided data to the specified connection.

Specified by:

postToConnection in interface AmazonApiGatewayManagementApi

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonApiGatewayManagementApi

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonApiGatewayManagementApi

Overrides:

shutdown in class AmazonWebServiceClient