@Generated(value="software.amazon.awssdk:codegen") public interface ApiGatewayManagementApiClient extends SdkClient
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and 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.
|
static ServiceMetadata |
serviceMetadata() |
serviceName
close
static final String SERVICE_NAME
static ApiGatewayManagementApiClient create()
ApiGatewayManagementApiClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ApiGatewayManagementApiClientBuilder builder()
ApiGatewayManagementApiClient
.default DeleteConnectionResponse deleteConnection(DeleteConnectionRequest deleteConnectionRequest) throws GoneException, LimitExceededException, ForbiddenException, AwsServiceException, SdkClientException, ApiGatewayManagementApiException
Delete the connection with the provided id.
deleteConnectionRequest
- 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
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()
deleteConnectionRequest
- A Consumer
that will call methods on DeleteConnectionRequest.Builder
to create a request.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
default GetConnectionResponse getConnection(GetConnectionRequest getConnectionRequest) throws GoneException, LimitExceededException, ForbiddenException, AwsServiceException, SdkClientException, ApiGatewayManagementApiException
Get information about the connection with the provided id.
getConnectionRequest
- 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
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()
getConnectionRequest
- A Consumer
that will call methods on GetConnectionRequest.Builder
to create a request.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
default PostToConnectionResponse postToConnection(PostToConnectionRequest postToConnectionRequest) throws GoneException, LimitExceededException, PayloadTooLargeException, ForbiddenException, AwsServiceException, SdkClientException, ApiGatewayManagementApiException
Sends the provided data to the specified connection.
postToConnectionRequest
- 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
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()
postToConnectionRequest
- A Consumer
that will call methods on PostToConnectionRequest.Builder
to create a request.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
static ServiceMetadata serviceMetadata()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.