Interface MqAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic MqAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aMqAsyncClient
.static MqAsyncClient
create()
Create aMqAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateBrokerResponse> createBroker
(Consumer<CreateBrokerRequest.Builder> createBrokerRequest) Creates a broker.default CompletableFuture
<CreateBrokerResponse> createBroker
(CreateBrokerRequest createBrokerRequest) Creates a broker.createConfiguration
(Consumer<CreateConfigurationRequest.Builder> createConfigurationRequest) Creates a new configuration for the specified configuration name.createConfiguration
(CreateConfigurationRequest createConfigurationRequest) Creates a new configuration for the specified configuration name.default CompletableFuture
<CreateTagsResponse> createTags
(Consumer<CreateTagsRequest.Builder> createTagsRequest) Add a tag to a resource.default CompletableFuture
<CreateTagsResponse> createTags
(CreateTagsRequest createTagsRequest) Add a tag to a resource.default CompletableFuture
<CreateUserResponse> createUser
(Consumer<CreateUserRequest.Builder> createUserRequest) Creates an ActiveMQ user.default CompletableFuture
<CreateUserResponse> createUser
(CreateUserRequest createUserRequest) Creates an ActiveMQ user.default CompletableFuture
<DeleteBrokerResponse> deleteBroker
(Consumer<DeleteBrokerRequest.Builder> deleteBrokerRequest) Deletes a broker.default CompletableFuture
<DeleteBrokerResponse> deleteBroker
(DeleteBrokerRequest deleteBrokerRequest) Deletes a broker.default CompletableFuture
<DeleteTagsResponse> deleteTags
(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) Removes a tag from a resource.default CompletableFuture
<DeleteTagsResponse> deleteTags
(DeleteTagsRequest deleteTagsRequest) Removes a tag from a resource.default CompletableFuture
<DeleteUserResponse> deleteUser
(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes an ActiveMQ user.default CompletableFuture
<DeleteUserResponse> deleteUser
(DeleteUserRequest deleteUserRequest) Deletes an ActiveMQ user.default CompletableFuture
<DescribeBrokerResponse> describeBroker
(Consumer<DescribeBrokerRequest.Builder> describeBrokerRequest) Returns information about the specified broker.default CompletableFuture
<DescribeBrokerResponse> describeBroker
(DescribeBrokerRequest describeBrokerRequest) Returns information about the specified broker.describeBrokerEngineTypes
(Consumer<DescribeBrokerEngineTypesRequest.Builder> describeBrokerEngineTypesRequest) Describe available engine types and versions.describeBrokerEngineTypes
(DescribeBrokerEngineTypesRequest describeBrokerEngineTypesRequest) Describe available engine types and versions.describeBrokerInstanceOptions
(Consumer<DescribeBrokerInstanceOptionsRequest.Builder> describeBrokerInstanceOptionsRequest) Describe available broker instance options.describeBrokerInstanceOptions
(DescribeBrokerInstanceOptionsRequest describeBrokerInstanceOptionsRequest) Describe available broker instance options.describeConfiguration
(Consumer<DescribeConfigurationRequest.Builder> describeConfigurationRequest) Returns information about the specified configuration.describeConfiguration
(DescribeConfigurationRequest describeConfigurationRequest) Returns information about the specified configuration.describeConfigurationRevision
(Consumer<DescribeConfigurationRevisionRequest.Builder> describeConfigurationRevisionRequest) Returns the specified configuration revision for the specified configuration.describeConfigurationRevision
(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest) Returns the specified configuration revision for the specified configuration.default CompletableFuture
<DescribeUserResponse> describeUser
(Consumer<DescribeUserRequest.Builder> describeUserRequest) Returns information about an ActiveMQ user.default CompletableFuture
<DescribeUserResponse> describeUser
(DescribeUserRequest describeUserRequest) Returns information about an ActiveMQ user.default CompletableFuture
<ListBrokersResponse> Returns a list of all brokers.default CompletableFuture
<ListBrokersResponse> listBrokers
(Consumer<ListBrokersRequest.Builder> listBrokersRequest) Returns a list of all brokers.default CompletableFuture
<ListBrokersResponse> listBrokers
(ListBrokersRequest listBrokersRequest) Returns a list of all brokers.default ListBrokersPublisher
This is a variant oflistBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest)
operation.default ListBrokersPublisher
listBrokersPaginator
(Consumer<ListBrokersRequest.Builder> listBrokersRequest) This is a variant oflistBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest)
operation.default ListBrokersPublisher
listBrokersPaginator
(ListBrokersRequest listBrokersRequest) This is a variant oflistBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest)
operation.listConfigurationRevisions
(Consumer<ListConfigurationRevisionsRequest.Builder> listConfigurationRevisionsRequest) Returns a list of all revisions for the specified configuration.listConfigurationRevisions
(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest) Returns a list of all revisions for the specified configuration.Returns a list of all configurations.listConfigurations
(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest) Returns a list of all configurations.listConfigurations
(ListConfigurationsRequest listConfigurationsRequest) Returns a list of all configurations.default CompletableFuture
<ListTagsResponse> listTags
(Consumer<ListTagsRequest.Builder> listTagsRequest) Lists tags for a resource.default CompletableFuture
<ListTagsResponse> listTags
(ListTagsRequest listTagsRequest) Lists tags for a resource.default CompletableFuture
<ListUsersResponse> listUsers
(Consumer<ListUsersRequest.Builder> listUsersRequest) Returns a list of all ActiveMQ users.default CompletableFuture
<ListUsersResponse> listUsers
(ListUsersRequest listUsersRequest) Returns a list of all ActiveMQ users.default CompletableFuture
<PromoteResponse> promote
(Consumer<PromoteRequest.Builder> promoteRequest) Promotes a data replication replica broker to the primary broker role.default CompletableFuture
<PromoteResponse> promote
(PromoteRequest promoteRequest) Promotes a data replication replica broker to the primary broker role.default CompletableFuture
<RebootBrokerResponse> rebootBroker
(Consumer<RebootBrokerRequest.Builder> rebootBrokerRequest) Reboots a broker.default CompletableFuture
<RebootBrokerResponse> rebootBroker
(RebootBrokerRequest rebootBrokerRequest) Reboots a broker.default MqServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<UpdateBrokerResponse> updateBroker
(Consumer<UpdateBrokerRequest.Builder> updateBrokerRequest) Adds a pending configuration change to a broker.default CompletableFuture
<UpdateBrokerResponse> updateBroker
(UpdateBrokerRequest updateBrokerRequest) Adds a pending configuration change to a broker.updateConfiguration
(Consumer<UpdateConfigurationRequest.Builder> updateConfigurationRequest) Updates the specified configuration.updateConfiguration
(UpdateConfigurationRequest updateConfigurationRequest) Updates the specified configuration.default CompletableFuture
<UpdateUserResponse> updateUser
(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates the information for an ActiveMQ user.default CompletableFuture
<UpdateUserResponse> updateUser
(UpdateUserRequest updateUserRequest) Updates the information for an ActiveMQ user.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
-
createBroker
default CompletableFuture<CreateBrokerResponse> createBroker(CreateBrokerRequest createBrokerRequest) Creates a broker. Note: This API is asynchronous.
To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.
-
ec2:CreateNetworkInterface
This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.
-
ec2:CreateNetworkInterfacePermission
This permission is required to attach the ENI to the broker instance.
-
ec2:DeleteNetworkInterface
-
ec2:DeleteNetworkInterfacePermission
-
ec2:DetachNetworkInterface
-
ec2:DescribeInternetGateways
-
ec2:DescribeNetworkInterfaces
-
ec2:DescribeNetworkInterfacePermissions
-
ec2:DescribeRouteTables
-
ec2:DescribeSecurityGroups
-
ec2:DescribeSubnets
-
ec2:DescribeVpcs
For more information, see Create an IAM User and Get Your Amazon Web Services Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.
- Parameters:
createBrokerRequest
- Creates a broker using the specified properties.- Returns:
- A Java Future containing the result of the CreateBroker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- UnauthorizedException HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ConflictException HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createBroker
default CompletableFuture<CreateBrokerResponse> createBroker(Consumer<CreateBrokerRequest.Builder> createBrokerRequest) Creates a broker. Note: This API is asynchronous.
To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.
-
ec2:CreateNetworkInterface
This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.
-
ec2:CreateNetworkInterfacePermission
This permission is required to attach the ENI to the broker instance.
-
ec2:DeleteNetworkInterface
-
ec2:DeleteNetworkInterfacePermission
-
ec2:DetachNetworkInterface
-
ec2:DescribeInternetGateways
-
ec2:DescribeNetworkInterfaces
-
ec2:DescribeNetworkInterfacePermissions
-
ec2:DescribeRouteTables
-
ec2:DescribeSecurityGroups
-
ec2:DescribeSubnets
-
ec2:DescribeVpcs
For more information, see Create an IAM User and Get Your Amazon Web Services Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.
This is a convenience which creates an instance of the
CreateBrokerRequest.Builder
avoiding the need to create one manually viaCreateBrokerRequest.builder()
- Parameters:
createBrokerRequest
- AConsumer
that will call methods onCreateBrokerRequest.Builder
to create a request. Creates a broker using the specified properties.- Returns:
- A Java Future containing the result of the CreateBroker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- UnauthorizedException HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ConflictException HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
createConfiguration
default CompletableFuture<CreateConfigurationResponse> createConfiguration(CreateConfigurationRequest createConfigurationRequest) Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
- Parameters:
createConfigurationRequest
- Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).- Returns:
- A Java Future containing the result of the CreateConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ConflictException HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConfiguration
default CompletableFuture<CreateConfigurationResponse> createConfiguration(Consumer<CreateConfigurationRequest.Builder> createConfigurationRequest) Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
This is a convenience which creates an instance of the
CreateConfigurationRequest.Builder
avoiding the need to create one manually viaCreateConfigurationRequest.builder()
- Parameters:
createConfigurationRequest
- AConsumer
that will call methods onCreateConfigurationRequest.Builder
to create a request. Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).- Returns:
- A Java Future containing the result of the CreateConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ConflictException HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTags
Add a tag to a resource.
- Parameters:
createTagsRequest
- A map of the key-value pairs for the resource tag.- Returns:
- A Java Future containing the result of the CreateTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createTags
default CompletableFuture<CreateTagsResponse> createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest) Add a tag to a resource.
This is a convenience which creates an instance of the
CreateTagsRequest.Builder
avoiding the need to create one manually viaCreateTagsRequest.builder()
- Parameters:
createTagsRequest
- AConsumer
that will call methods onCreateTagsRequest.Builder
to create a request. A map of the key-value pairs for the resource tag.- Returns:
- A Java Future containing the result of the CreateTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUser
Creates an ActiveMQ user.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.
- Parameters:
createUserRequest
- Creates a new ActiveMQ user.- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ConflictException HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUser
default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest) Creates an ActiveMQ user.
Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.
This is a convenience which creates an instance of the
CreateUserRequest.Builder
avoiding the need to create one manually viaCreateUserRequest.builder()
- Parameters:
createUserRequest
- AConsumer
that will call methods onCreateUserRequest.Builder
to create a request. Creates a new ActiveMQ user.- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ConflictException HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBroker
default CompletableFuture<DeleteBrokerResponse> deleteBroker(DeleteBrokerRequest deleteBrokerRequest) Deletes a broker. Note: This API is asynchronous.
- Parameters:
deleteBrokerRequest
-- Returns:
- A Java Future containing the result of the DeleteBroker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBroker
default CompletableFuture<DeleteBrokerResponse> deleteBroker(Consumer<DeleteBrokerRequest.Builder> deleteBrokerRequest) Deletes a broker. Note: This API is asynchronous.
This is a convenience which creates an instance of the
DeleteBrokerRequest.Builder
avoiding the need to create one manually viaDeleteBrokerRequest.builder()
- Parameters:
deleteBrokerRequest
- AConsumer
that will call methods onDeleteBrokerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteBroker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTags
Removes a tag from a resource.
- Parameters:
deleteTagsRequest
-- Returns:
- A Java Future containing the result of the DeleteTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTags
default CompletableFuture<DeleteTagsResponse> deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) Removes a tag from a resource.
This is a convenience which creates an instance of the
DeleteTagsRequest.Builder
avoiding the need to create one manually viaDeleteTagsRequest.builder()
- Parameters:
deleteTagsRequest
- AConsumer
that will call methods onDeleteTagsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUser
Deletes an ActiveMQ user.
- Parameters:
deleteUserRequest
-- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteUser
default CompletableFuture<DeleteUserResponse> deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) Deletes an ActiveMQ user.
This is a convenience which creates an instance of the
DeleteUserRequest.Builder
avoiding the need to create one manually viaDeleteUserRequest.builder()
- Parameters:
deleteUserRequest
- AConsumer
that will call methods onDeleteUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBroker
default CompletableFuture<DescribeBrokerResponse> describeBroker(DescribeBrokerRequest describeBrokerRequest) Returns information about the specified broker.
- Parameters:
describeBrokerRequest
-- Returns:
- A Java Future containing the result of the DescribeBroker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBroker
default CompletableFuture<DescribeBrokerResponse> describeBroker(Consumer<DescribeBrokerRequest.Builder> describeBrokerRequest) Returns information about the specified broker.
This is a convenience which creates an instance of the
DescribeBrokerRequest.Builder
avoiding the need to create one manually viaDescribeBrokerRequest.builder()
- Parameters:
describeBrokerRequest
- AConsumer
that will call methods onDescribeBrokerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeBroker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBrokerEngineTypes
default CompletableFuture<DescribeBrokerEngineTypesResponse> describeBrokerEngineTypes(DescribeBrokerEngineTypesRequest describeBrokerEngineTypesRequest) Describe available engine types and versions.
- Parameters:
describeBrokerEngineTypesRequest
-- Returns:
- A Java Future containing the result of the DescribeBrokerEngineTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBrokerEngineTypes
default CompletableFuture<DescribeBrokerEngineTypesResponse> describeBrokerEngineTypes(Consumer<DescribeBrokerEngineTypesRequest.Builder> describeBrokerEngineTypesRequest) Describe available engine types and versions.
This is a convenience which creates an instance of the
DescribeBrokerEngineTypesRequest.Builder
avoiding the need to create one manually viaDescribeBrokerEngineTypesRequest.builder()
- Parameters:
describeBrokerEngineTypesRequest
- AConsumer
that will call methods onDescribeBrokerEngineTypesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeBrokerEngineTypes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBrokerInstanceOptions
default CompletableFuture<DescribeBrokerInstanceOptionsResponse> describeBrokerInstanceOptions(DescribeBrokerInstanceOptionsRequest describeBrokerInstanceOptionsRequest) Describe available broker instance options.
- Parameters:
describeBrokerInstanceOptionsRequest
-- Returns:
- A Java Future containing the result of the DescribeBrokerInstanceOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBrokerInstanceOptions
default CompletableFuture<DescribeBrokerInstanceOptionsResponse> describeBrokerInstanceOptions(Consumer<DescribeBrokerInstanceOptionsRequest.Builder> describeBrokerInstanceOptionsRequest) Describe available broker instance options.
This is a convenience which creates an instance of the
DescribeBrokerInstanceOptionsRequest.Builder
avoiding the need to create one manually viaDescribeBrokerInstanceOptionsRequest.builder()
- Parameters:
describeBrokerInstanceOptionsRequest
- AConsumer
that will call methods onDescribeBrokerInstanceOptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeBrokerInstanceOptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfiguration
default CompletableFuture<DescribeConfigurationResponse> describeConfiguration(DescribeConfigurationRequest describeConfigurationRequest) Returns information about the specified configuration.
- Parameters:
describeConfigurationRequest
-- Returns:
- A Java Future containing the result of the DescribeConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfiguration
default CompletableFuture<DescribeConfigurationResponse> describeConfiguration(Consumer<DescribeConfigurationRequest.Builder> describeConfigurationRequest) Returns information about the specified configuration.
This is a convenience which creates an instance of the
DescribeConfigurationRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationRequest.builder()
- Parameters:
describeConfigurationRequest
- AConsumer
that will call methods onDescribeConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationRevision
default CompletableFuture<DescribeConfigurationRevisionResponse> describeConfigurationRevision(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest) Returns the specified configuration revision for the specified configuration.
- Parameters:
describeConfigurationRevisionRequest
-- Returns:
- A Java Future containing the result of the DescribeConfigurationRevision operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationRevision
default CompletableFuture<DescribeConfigurationRevisionResponse> describeConfigurationRevision(Consumer<DescribeConfigurationRevisionRequest.Builder> describeConfigurationRevisionRequest) Returns the specified configuration revision for the specified configuration.
This is a convenience which creates an instance of the
DescribeConfigurationRevisionRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationRevisionRequest.builder()
- Parameters:
describeConfigurationRevisionRequest
- AConsumer
that will call methods onDescribeConfigurationRevisionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeConfigurationRevision operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUser
default CompletableFuture<DescribeUserResponse> describeUser(DescribeUserRequest describeUserRequest) Returns information about an ActiveMQ user.
- Parameters:
describeUserRequest
-- Returns:
- A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeUser
default CompletableFuture<DescribeUserResponse> describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) Returns information about an ActiveMQ user.
This is a convenience which creates an instance of the
DescribeUserRequest.Builder
avoiding the need to create one manually viaDescribeUserRequest.builder()
- Parameters:
describeUserRequest
- AConsumer
that will call methods onDescribeUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBrokers
Returns a list of all brokers.
- Parameters:
listBrokersRequest
-- Returns:
- A Java Future containing the result of the ListBrokers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBrokers
default CompletableFuture<ListBrokersResponse> listBrokers(Consumer<ListBrokersRequest.Builder> listBrokersRequest) Returns a list of all brokers.
This is a convenience which creates an instance of the
ListBrokersRequest.Builder
avoiding the need to create one manually viaListBrokersRequest.builder()
- Parameters:
listBrokersRequest
- AConsumer
that will call methods onListBrokersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListBrokers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBrokers
Returns a list of all brokers.
- Returns:
- A Java Future containing the result of the ListBrokers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBrokersPaginator
This is a variant of
listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mq.model.ListBrokersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mq.model.ListBrokersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBrokersPaginator
This is a variant of
listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mq.model.ListBrokersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mq.model.ListBrokersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest)
operation.- Parameters:
listBrokersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listBrokersPaginator
default ListBrokersPublisher listBrokersPaginator(Consumer<ListBrokersRequest.Builder> listBrokersRequest) This is a variant of
listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mq.model.ListBrokersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.mq.model.ListBrokersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest)
operation.
This is a convenience which creates an instance of the
ListBrokersRequest.Builder
avoiding the need to create one manually viaListBrokersRequest.builder()
- Parameters:
listBrokersRequest
- AConsumer
that will call methods onListBrokersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurationRevisions
default CompletableFuture<ListConfigurationRevisionsResponse> listConfigurationRevisions(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest) Returns a list of all revisions for the specified configuration.
- Parameters:
listConfigurationRevisionsRequest
-- Returns:
- A Java Future containing the result of the ListConfigurationRevisions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurationRevisions
default CompletableFuture<ListConfigurationRevisionsResponse> listConfigurationRevisions(Consumer<ListConfigurationRevisionsRequest.Builder> listConfigurationRevisionsRequest) Returns a list of all revisions for the specified configuration.
This is a convenience which creates an instance of the
ListConfigurationRevisionsRequest.Builder
avoiding the need to create one manually viaListConfigurationRevisionsRequest.builder()
- Parameters:
listConfigurationRevisionsRequest
- AConsumer
that will call methods onListConfigurationRevisionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListConfigurationRevisions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurations
default CompletableFuture<ListConfigurationsResponse> listConfigurations(ListConfigurationsRequest listConfigurationsRequest) Returns a list of all configurations.
- Parameters:
listConfigurationsRequest
-- Returns:
- A Java Future containing the result of the ListConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurations
default CompletableFuture<ListConfigurationsResponse> listConfigurations(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest) Returns a list of all configurations.
This is a convenience which creates an instance of the
ListConfigurationsRequest.Builder
avoiding the need to create one manually viaListConfigurationsRequest.builder()
- Parameters:
listConfigurationsRequest
- AConsumer
that will call methods onListConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigurations
Returns a list of all configurations.
- Returns:
- A Java Future containing the result of the ListConfigurations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTags
Lists tags for a resource.
- Parameters:
listTagsRequest
-- Returns:
- A Java Future containing the result of the ListTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTags
default CompletableFuture<ListTagsResponse> listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) Lists tags for a resource.
This is a convenience which creates an instance of the
ListTagsRequest.Builder
avoiding the need to create one manually viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsers
Returns a list of all ActiveMQ users.
- Parameters:
listUsersRequest
-- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsers
default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) Returns a list of all ActiveMQ users.
This is a convenience which creates an instance of the
ListUsersRequest.Builder
avoiding the need to create one manually viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
promote
Promotes a data replication replica broker to the primary broker role.
- Parameters:
promoteRequest
- Promotes a data replication replica broker to the primary broker role.- Returns:
- A Java Future containing the result of the Promote operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
promote
Promotes a data replication replica broker to the primary broker role.
This is a convenience which creates an instance of the
PromoteRequest.Builder
avoiding the need to create one manually viaPromoteRequest.builder()
- Parameters:
promoteRequest
- AConsumer
that will call methods onPromoteRequest.Builder
to create a request. Promotes a data replication replica broker to the primary broker role.- Returns:
- A Java Future containing the result of the Promote operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
rebootBroker
default CompletableFuture<RebootBrokerResponse> rebootBroker(RebootBrokerRequest rebootBrokerRequest) Reboots a broker. Note: This API is asynchronous.
- Parameters:
rebootBrokerRequest
-- Returns:
- A Java Future containing the result of the RebootBroker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
rebootBroker
default CompletableFuture<RebootBrokerResponse> rebootBroker(Consumer<RebootBrokerRequest.Builder> rebootBrokerRequest) Reboots a broker. Note: This API is asynchronous.
This is a convenience which creates an instance of the
RebootBrokerRequest.Builder
avoiding the need to create one manually viaRebootBrokerRequest.builder()
- Parameters:
rebootBrokerRequest
- AConsumer
that will call methods onRebootBrokerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RebootBroker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBroker
default CompletableFuture<UpdateBrokerResponse> updateBroker(UpdateBrokerRequest updateBrokerRequest) Adds a pending configuration change to a broker.
- Parameters:
updateBrokerRequest
- Updates the broker using the specified properties.- Returns:
- A Java Future containing the result of the UpdateBroker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ConflictException HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateBroker
default CompletableFuture<UpdateBrokerResponse> updateBroker(Consumer<UpdateBrokerRequest.Builder> updateBrokerRequest) Adds a pending configuration change to a broker.
This is a convenience which creates an instance of the
UpdateBrokerRequest.Builder
avoiding the need to create one manually viaUpdateBrokerRequest.builder()
- Parameters:
updateBrokerRequest
- AConsumer
that will call methods onUpdateBrokerRequest.Builder
to create a request. Updates the broker using the specified properties.- Returns:
- A Java Future containing the result of the UpdateBroker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ConflictException HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfiguration
default CompletableFuture<UpdateConfigurationResponse> updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest) Updates the specified configuration.
- Parameters:
updateConfigurationRequest
- Updates the specified configuration.- Returns:
- A Java Future containing the result of the UpdateConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ConflictException HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfiguration
default CompletableFuture<UpdateConfigurationResponse> updateConfiguration(Consumer<UpdateConfigurationRequest.Builder> updateConfigurationRequest) Updates the specified configuration.
This is a convenience which creates an instance of the
UpdateConfigurationRequest.Builder
avoiding the need to create one manually viaUpdateConfigurationRequest.builder()
- Parameters:
updateConfigurationRequest
- AConsumer
that will call methods onUpdateConfigurationRequest.Builder
to create a request. Updates the specified configuration.- Returns:
- A Java Future containing the result of the UpdateConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ConflictException HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateUser
Updates the information for an ActiveMQ user.
- Parameters:
updateUserRequest
- Updates the information for an ActiveMQ user.- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ConflictException HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateUser
default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) Updates the information for an ActiveMQ user.
This is a convenience which creates an instance of the
UpdateUserRequest.Builder
avoiding the need to create one manually viaUpdateUserRequest.builder()
- Parameters:
updateUserRequest
- AConsumer
that will call methods onUpdateUserRequest.Builder
to create a request. Updates the information for an ActiveMQ user.- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NotFoundException HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
- BadRequestException HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
- InternalServerErrorException HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
- ConflictException HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
- ForbiddenException HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
- 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.
- MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
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
-
create
Create aMqAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aMqAsyncClient
.
-