Interface ApiGatewayManagementApiClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aApiGatewayManagementApiClient
.create()
Create aApiGatewayManagementApiClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
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.
- See Also:
-
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 viaDeleteConnectionRequest.builder()
- Parameters:
deleteConnectionRequest
- AConsumer
that will call methods onDeleteConnectionRequest.Builder
to create a request.- Returns:
- Result of the DeleteConnection operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaGetConnectionRequest.builder()
- Parameters:
getConnectionRequest
- AConsumer
that will call methods onGetConnectionRequest.Builder
to create a request.- Returns:
- Result of the GetConnection operation returned by the service.
- See Also:
-
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.
- See Also:
-
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 viaPostToConnectionRequest.builder()
- Parameters:
postToConnectionRequest
- AConsumer
that will call methods onPostToConnectionRequest.Builder
to create a request.- Returns:
- Result of the PostToConnection operation returned by the service.
- See Also:
-
create
Create aApiGatewayManagementApiClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aApiGatewayManagementApiClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-