Package software.amazon.awssdk.services.apigatewaymanagementapi

Interface ApiGatewayManagementApiClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface ApiGatewayManagementApiClient
extends AwsClient

Service client for accessing AmazonApiGatewayManagementApi. This can be created using the static builder() method.

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

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static ApiGatewayManagementApiClientBuilder	builder()	Create a builder that can be used to configure and create a ApiGatewayManagementApiClient.
static ApiGatewayManagementApiClient	create()	Create a ApiGatewayManagementApiClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DeleteConnectionResponse	deleteConnection(Consumer<DeleteConnectionRequest.Builder> deleteConnectionRequest)	Delete the connection with the provided id.
default DeleteConnectionResponse	deleteConnection(DeleteConnectionRequest deleteConnectionRequest)	Delete the connection with the provided id.
default GetConnectionResponse	getConnection(Consumer<GetConnectionRequest.Builder> getConnectionRequest)	Get information about the connection with the provided id.
default GetConnectionResponse	getConnection(GetConnectionRequest getConnectionRequest)	Get information about the connection with the provided id.
default PostToConnectionResponse	postToConnection(Consumer<PostToConnectionRequest.Builder> postToConnectionRequest)	Sends the provided data to the specified connection.
default PostToConnectionResponse	postToConnection(PostToConnectionRequest postToConnectionRequest)	Sends the provided data to the specified connection.
default ApiGatewayManagementApiServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

deleteConnection

default DeleteConnectionResponse deleteConnection(DeleteConnectionRequest deleteConnectionRequest)
                                           throws GoneException,
                                                  LimitExceededException,
                                                  ForbiddenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ApiGatewayManagementApiException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ApiGatewayManagementApiException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteConnection

default DeleteConnectionResponse deleteConnection(Consumer<DeleteConnectionRequest.Builder> deleteConnectionRequest)
                                           throws GoneException,
                                                  LimitExceededException,
                                                  ForbiddenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ApiGatewayManagementApiException

Delete the connection with the provided id.

This is a convenience which creates an instance of the DeleteConnectionRequest.Builder avoiding the need to create one manually via DeleteConnectionRequest.builder()

Parameters:

deleteConnectionRequest - A Consumer that will call methods on DeleteConnectionRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ApiGatewayManagementApiException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getConnection

default GetConnectionResponse getConnection(GetConnectionRequest getConnectionRequest)
                                     throws GoneException,
                                            LimitExceededException,
                                            ForbiddenException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ApiGatewayManagementApiException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ApiGatewayManagementApiException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getConnection

default GetConnectionResponse getConnection(Consumer<GetConnectionRequest.Builder> getConnectionRequest)
                                     throws GoneException,
                                            LimitExceededException,
                                            ForbiddenException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ApiGatewayManagementApiException

Get information about the connection with the provided id.

This is a convenience which creates an instance of the GetConnectionRequest.Builder avoiding the need to create one manually via GetConnectionRequest.builder()

Parameters:

getConnectionRequest - A Consumer that will call methods on GetConnectionRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ApiGatewayManagementApiException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

postToConnection

default PostToConnectionResponse postToConnection(PostToConnectionRequest postToConnectionRequest)
                                           throws GoneException,
                                                  LimitExceededException,
                                                  PayloadTooLargeException,
                                                  ForbiddenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ApiGatewayManagementApiException

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ApiGatewayManagementApiException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

postToConnection

default PostToConnectionResponse postToConnection(Consumer<PostToConnectionRequest.Builder> postToConnectionRequest)
                                           throws GoneException,
                                                  LimitExceededException,
                                                  PayloadTooLargeException,
                                                  ForbiddenException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  ApiGatewayManagementApiException

Sends the provided data to the specified connection.

This is a convenience which creates an instance of the PostToConnectionRequest.Builder avoiding the need to create one manually via PostToConnectionRequest.builder()

Parameters:

postToConnectionRequest - A Consumer that will call methods on PostToConnectionRequest.Builder to create a request.

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.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

ApiGatewayManagementApiException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

create

static ApiGatewayManagementApiClient create()

Create a ApiGatewayManagementApiClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ApiGatewayManagementApiClientBuilder builder()

Create a builder that can be used to configure and create a ApiGatewayManagementApiClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ApiGatewayManagementApiServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient