@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonMQAsyncClient extends AmazonMQClient implements AmazonMQAsync
AsyncHandler
can be used to receive notification when
an asynchronous operation completes.
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
builder, createBroker, createConfiguration, createTags, createUser, deleteBroker, deleteTags, deleteUser, describeBroker, describeBrokerEngineTypes, describeBrokerInstanceOptions, describeConfiguration, describeConfigurationRevision, describeUser, getCachedResponseMetadata, listBrokers, listConfigurationRevisions, listConfigurations, listTags, listUsers, promote, rebootBroker, updateBroker, updateConfiguration, updateUser
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createBroker, createConfiguration, createTags, createUser, deleteBroker, deleteTags, deleteUser, describeBroker, describeBrokerEngineTypes, describeBrokerInstanceOptions, describeConfiguration, describeConfigurationRevision, describeUser, getCachedResponseMetadata, listBrokers, listConfigurationRevisions, listConfigurations, listTags, listUsers, promote, rebootBroker, updateBroker, updateConfiguration, updateUser
public static AmazonMQAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateBrokerResult> createBrokerAsync(CreateBrokerRequest request)
AmazonMQAsync
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.
createBrokerAsync
in interface AmazonMQAsync
request
- Creates a broker using the specified properties.public Future<CreateBrokerResult> createBrokerAsync(CreateBrokerRequest request, AsyncHandler<CreateBrokerRequest,CreateBrokerResult> asyncHandler)
AmazonMQAsync
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.
createBrokerAsync
in interface AmazonMQAsync
request
- Creates a broker using the specified properties.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateConfigurationResult> createConfigurationAsync(CreateConfigurationRequest request)
AmazonMQAsync
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
createConfigurationAsync
in interface AmazonMQAsync
request
- Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration
(the engine type and version).public Future<CreateConfigurationResult> createConfigurationAsync(CreateConfigurationRequest request, AsyncHandler<CreateConfigurationRequest,CreateConfigurationResult> asyncHandler)
AmazonMQAsync
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
createConfigurationAsync
in interface AmazonMQAsync
request
- Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration
(the engine type and version).asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateTagsResult> createTagsAsync(CreateTagsRequest request)
AmazonMQAsync
Add a tag to a resource.
createTagsAsync
in interface AmazonMQAsync
request
- A map of the key-value pairs for the resource tag.public Future<CreateTagsResult> createTagsAsync(CreateTagsRequest request, AsyncHandler<CreateTagsRequest,CreateTagsResult> asyncHandler)
AmazonMQAsync
Add a tag to a resource.
createTagsAsync
in interface AmazonMQAsync
request
- A map of the key-value pairs for the resource tag.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateUserResult> createUserAsync(CreateUserRequest request)
AmazonMQAsync
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.
createUserAsync
in interface AmazonMQAsync
request
- Creates a new ActiveMQ user.public Future<CreateUserResult> createUserAsync(CreateUserRequest request, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
AmazonMQAsync
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.
createUserAsync
in interface AmazonMQAsync
request
- Creates a new ActiveMQ user.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteBrokerResult> deleteBrokerAsync(DeleteBrokerRequest request)
AmazonMQAsync
Deletes a broker. Note: This API is asynchronous.
deleteBrokerAsync
in interface AmazonMQAsync
public Future<DeleteBrokerResult> deleteBrokerAsync(DeleteBrokerRequest request, AsyncHandler<DeleteBrokerRequest,DeleteBrokerResult> asyncHandler)
AmazonMQAsync
Deletes a broker. Note: This API is asynchronous.
deleteBrokerAsync
in interface AmazonMQAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTagsResult> deleteTagsAsync(DeleteTagsRequest request)
AmazonMQAsync
Removes a tag from a resource.
deleteTagsAsync
in interface AmazonMQAsync
public Future<DeleteTagsResult> deleteTagsAsync(DeleteTagsRequest request, AsyncHandler<DeleteTagsRequest,DeleteTagsResult> asyncHandler)
AmazonMQAsync
Removes a tag from a resource.
deleteTagsAsync
in interface AmazonMQAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request)
AmazonMQAsync
Deletes an ActiveMQ user.
deleteUserAsync
in interface AmazonMQAsync
public Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest request, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
AmazonMQAsync
Deletes an ActiveMQ user.
deleteUserAsync
in interface AmazonMQAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeBrokerResult> describeBrokerAsync(DescribeBrokerRequest request)
AmazonMQAsync
Returns information about the specified broker.
describeBrokerAsync
in interface AmazonMQAsync
public Future<DescribeBrokerResult> describeBrokerAsync(DescribeBrokerRequest request, AsyncHandler<DescribeBrokerRequest,DescribeBrokerResult> asyncHandler)
AmazonMQAsync
Returns information about the specified broker.
describeBrokerAsync
in interface AmazonMQAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeBrokerEngineTypesResult> describeBrokerEngineTypesAsync(DescribeBrokerEngineTypesRequest request)
AmazonMQAsync
Describe available engine types and versions.
describeBrokerEngineTypesAsync
in interface AmazonMQAsync
public Future<DescribeBrokerEngineTypesResult> describeBrokerEngineTypesAsync(DescribeBrokerEngineTypesRequest request, AsyncHandler<DescribeBrokerEngineTypesRequest,DescribeBrokerEngineTypesResult> asyncHandler)
AmazonMQAsync
Describe available engine types and versions.
describeBrokerEngineTypesAsync
in interface AmazonMQAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeBrokerInstanceOptionsResult> describeBrokerInstanceOptionsAsync(DescribeBrokerInstanceOptionsRequest request)
AmazonMQAsync
Describe available broker instance options.
describeBrokerInstanceOptionsAsync
in interface AmazonMQAsync
public Future<DescribeBrokerInstanceOptionsResult> describeBrokerInstanceOptionsAsync(DescribeBrokerInstanceOptionsRequest request, AsyncHandler<DescribeBrokerInstanceOptionsRequest,DescribeBrokerInstanceOptionsResult> asyncHandler)
AmazonMQAsync
Describe available broker instance options.
describeBrokerInstanceOptionsAsync
in interface AmazonMQAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeConfigurationResult> describeConfigurationAsync(DescribeConfigurationRequest request)
AmazonMQAsync
Returns information about the specified configuration.
describeConfigurationAsync
in interface AmazonMQAsync
public Future<DescribeConfigurationResult> describeConfigurationAsync(DescribeConfigurationRequest request, AsyncHandler<DescribeConfigurationRequest,DescribeConfigurationResult> asyncHandler)
AmazonMQAsync
Returns information about the specified configuration.
describeConfigurationAsync
in interface AmazonMQAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeConfigurationRevisionResult> describeConfigurationRevisionAsync(DescribeConfigurationRevisionRequest request)
AmazonMQAsync
Returns the specified configuration revision for the specified configuration.
describeConfigurationRevisionAsync
in interface AmazonMQAsync
public Future<DescribeConfigurationRevisionResult> describeConfigurationRevisionAsync(DescribeConfigurationRevisionRequest request, AsyncHandler<DescribeConfigurationRevisionRequest,DescribeConfigurationRevisionResult> asyncHandler)
AmazonMQAsync
Returns the specified configuration revision for the specified configuration.
describeConfigurationRevisionAsync
in interface AmazonMQAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request)
AmazonMQAsync
Returns information about an ActiveMQ user.
describeUserAsync
in interface AmazonMQAsync
public Future<DescribeUserResult> describeUserAsync(DescribeUserRequest request, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
AmazonMQAsync
Returns information about an ActiveMQ user.
describeUserAsync
in interface AmazonMQAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListBrokersResult> listBrokersAsync(ListBrokersRequest request)
AmazonMQAsync
Returns a list of all brokers.
listBrokersAsync
in interface AmazonMQAsync
public Future<ListBrokersResult> listBrokersAsync(ListBrokersRequest request, AsyncHandler<ListBrokersRequest,ListBrokersResult> asyncHandler)
AmazonMQAsync
Returns a list of all brokers.
listBrokersAsync
in interface AmazonMQAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListConfigurationRevisionsResult> listConfigurationRevisionsAsync(ListConfigurationRevisionsRequest request)
AmazonMQAsync
Returns a list of all revisions for the specified configuration.
listConfigurationRevisionsAsync
in interface AmazonMQAsync
public Future<ListConfigurationRevisionsResult> listConfigurationRevisionsAsync(ListConfigurationRevisionsRequest request, AsyncHandler<ListConfigurationRevisionsRequest,ListConfigurationRevisionsResult> asyncHandler)
AmazonMQAsync
Returns a list of all revisions for the specified configuration.
listConfigurationRevisionsAsync
in interface AmazonMQAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListConfigurationsResult> listConfigurationsAsync(ListConfigurationsRequest request)
AmazonMQAsync
Returns a list of all configurations.
listConfigurationsAsync
in interface AmazonMQAsync
public Future<ListConfigurationsResult> listConfigurationsAsync(ListConfigurationsRequest request, AsyncHandler<ListConfigurationsRequest,ListConfigurationsResult> asyncHandler)
AmazonMQAsync
Returns a list of all configurations.
listConfigurationsAsync
in interface AmazonMQAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsResult> listTagsAsync(ListTagsRequest request)
AmazonMQAsync
Lists tags for a resource.
listTagsAsync
in interface AmazonMQAsync
public Future<ListTagsResult> listTagsAsync(ListTagsRequest request, AsyncHandler<ListTagsRequest,ListTagsResult> asyncHandler)
AmazonMQAsync
Lists tags for a resource.
listTagsAsync
in interface AmazonMQAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListUsersResult> listUsersAsync(ListUsersRequest request)
AmazonMQAsync
Returns a list of all ActiveMQ users.
listUsersAsync
in interface AmazonMQAsync
public Future<ListUsersResult> listUsersAsync(ListUsersRequest request, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
AmazonMQAsync
Returns a list of all ActiveMQ users.
listUsersAsync
in interface AmazonMQAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PromoteResult> promoteAsync(PromoteRequest request)
AmazonMQAsync
Promotes a data replication replica broker to the primary broker role.
promoteAsync
in interface AmazonMQAsync
request
- Promotes a data replication replica broker to the primary broker role.public Future<PromoteResult> promoteAsync(PromoteRequest request, AsyncHandler<PromoteRequest,PromoteResult> asyncHandler)
AmazonMQAsync
Promotes a data replication replica broker to the primary broker role.
promoteAsync
in interface AmazonMQAsync
request
- Promotes a data replication replica broker to the primary broker role.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RebootBrokerResult> rebootBrokerAsync(RebootBrokerRequest request)
AmazonMQAsync
Reboots a broker. Note: This API is asynchronous.
rebootBrokerAsync
in interface AmazonMQAsync
public Future<RebootBrokerResult> rebootBrokerAsync(RebootBrokerRequest request, AsyncHandler<RebootBrokerRequest,RebootBrokerResult> asyncHandler)
AmazonMQAsync
Reboots a broker. Note: This API is asynchronous.
rebootBrokerAsync
in interface AmazonMQAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateBrokerResult> updateBrokerAsync(UpdateBrokerRequest request)
AmazonMQAsync
Adds a pending configuration change to a broker.
updateBrokerAsync
in interface AmazonMQAsync
request
- Updates the broker using the specified properties.public Future<UpdateBrokerResult> updateBrokerAsync(UpdateBrokerRequest request, AsyncHandler<UpdateBrokerRequest,UpdateBrokerResult> asyncHandler)
AmazonMQAsync
Adds a pending configuration change to a broker.
updateBrokerAsync
in interface AmazonMQAsync
request
- Updates the broker using the specified properties.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateConfigurationResult> updateConfigurationAsync(UpdateConfigurationRequest request)
AmazonMQAsync
Updates the specified configuration.
updateConfigurationAsync
in interface AmazonMQAsync
request
- Updates the specified configuration.public Future<UpdateConfigurationResult> updateConfigurationAsync(UpdateConfigurationRequest request, AsyncHandler<UpdateConfigurationRequest,UpdateConfigurationResult> asyncHandler)
AmazonMQAsync
Updates the specified configuration.
updateConfigurationAsync
in interface AmazonMQAsync
request
- Updates the specified configuration.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request)
AmazonMQAsync
Updates the information for an ActiveMQ user.
updateUserAsync
in interface AmazonMQAsync
request
- Updates the information for an ActiveMQ user.public Future<UpdateUserResult> updateUserAsync(UpdateUserRequest request, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
AmazonMQAsync
Updates the information for an ActiveMQ user.
updateUserAsync
in interface AmazonMQAsync
request
- Updates the information for an ActiveMQ user.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonMQ
shutdown
in class AmazonMQClient