@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonMQAsync extends AmazonMQ
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonMQAsync
instead.
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.
ENDPOINT_PREFIX
createBroker, createConfiguration, createTags, createUser, deleteBroker, deleteTags, deleteUser, describeBroker, describeBrokerEngineTypes, describeBrokerInstanceOptions, describeConfiguration, describeConfigurationRevision, describeUser, getCachedResponseMetadata, listBrokers, listConfigurationRevisions, listConfigurations, listTags, listUsers, promote, rebootBroker, shutdown, updateBroker, updateConfiguration, updateUser
Future<CreateBrokerResult> createBrokerAsync(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.
createBrokerRequest
- Creates a broker using the specified properties.Future<CreateBrokerResult> createBrokerAsync(CreateBrokerRequest createBrokerRequest, AsyncHandler<CreateBrokerRequest,CreateBrokerResult> asyncHandler)
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.
createBrokerRequest
- 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.Future<CreateConfigurationResult> createConfigurationAsync(CreateConfigurationRequest createConfigurationRequest)
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
createConfigurationRequest
- Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration
(the engine type and version).Future<CreateConfigurationResult> createConfigurationAsync(CreateConfigurationRequest createConfigurationRequest, AsyncHandler<CreateConfigurationRequest,CreateConfigurationResult> asyncHandler)
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
createConfigurationRequest
- 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.Future<CreateTagsResult> createTagsAsync(CreateTagsRequest createTagsRequest)
Add a tag to a resource.
createTagsRequest
- A map of the key-value pairs for the resource tag.Future<CreateTagsResult> createTagsAsync(CreateTagsRequest createTagsRequest, AsyncHandler<CreateTagsRequest,CreateTagsResult> asyncHandler)
Add a tag to a resource.
createTagsRequest
- 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.Future<CreateUserResult> createUserAsync(CreateUserRequest 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.
createUserRequest
- Creates a new ActiveMQ user.Future<CreateUserResult> createUserAsync(CreateUserRequest createUserRequest, AsyncHandler<CreateUserRequest,CreateUserResult> asyncHandler)
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.
createUserRequest
- 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.Future<DeleteBrokerResult> deleteBrokerAsync(DeleteBrokerRequest deleteBrokerRequest)
Deletes a broker. Note: This API is asynchronous.
deleteBrokerRequest
- Future<DeleteBrokerResult> deleteBrokerAsync(DeleteBrokerRequest deleteBrokerRequest, AsyncHandler<DeleteBrokerRequest,DeleteBrokerResult> asyncHandler)
Deletes a broker. Note: This API is asynchronous.
deleteBrokerRequest
- 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.Future<DeleteTagsResult> deleteTagsAsync(DeleteTagsRequest deleteTagsRequest)
Removes a tag from a resource.
deleteTagsRequest
- Future<DeleteTagsResult> deleteTagsAsync(DeleteTagsRequest deleteTagsRequest, AsyncHandler<DeleteTagsRequest,DeleteTagsResult> asyncHandler)
Removes a tag from a resource.
deleteTagsRequest
- 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.Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest)
Deletes an ActiveMQ user.
deleteUserRequest
- Future<DeleteUserResult> deleteUserAsync(DeleteUserRequest deleteUserRequest, AsyncHandler<DeleteUserRequest,DeleteUserResult> asyncHandler)
Deletes an ActiveMQ user.
deleteUserRequest
- 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.Future<DescribeBrokerResult> describeBrokerAsync(DescribeBrokerRequest describeBrokerRequest)
Returns information about the specified broker.
describeBrokerRequest
- Future<DescribeBrokerResult> describeBrokerAsync(DescribeBrokerRequest describeBrokerRequest, AsyncHandler<DescribeBrokerRequest,DescribeBrokerResult> asyncHandler)
Returns information about the specified broker.
describeBrokerRequest
- 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.Future<DescribeBrokerEngineTypesResult> describeBrokerEngineTypesAsync(DescribeBrokerEngineTypesRequest describeBrokerEngineTypesRequest)
Describe available engine types and versions.
describeBrokerEngineTypesRequest
- Future<DescribeBrokerEngineTypesResult> describeBrokerEngineTypesAsync(DescribeBrokerEngineTypesRequest describeBrokerEngineTypesRequest, AsyncHandler<DescribeBrokerEngineTypesRequest,DescribeBrokerEngineTypesResult> asyncHandler)
Describe available engine types and versions.
describeBrokerEngineTypesRequest
- 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.Future<DescribeBrokerInstanceOptionsResult> describeBrokerInstanceOptionsAsync(DescribeBrokerInstanceOptionsRequest describeBrokerInstanceOptionsRequest)
Describe available broker instance options.
describeBrokerInstanceOptionsRequest
- Future<DescribeBrokerInstanceOptionsResult> describeBrokerInstanceOptionsAsync(DescribeBrokerInstanceOptionsRequest describeBrokerInstanceOptionsRequest, AsyncHandler<DescribeBrokerInstanceOptionsRequest,DescribeBrokerInstanceOptionsResult> asyncHandler)
Describe available broker instance options.
describeBrokerInstanceOptionsRequest
- 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.Future<DescribeConfigurationResult> describeConfigurationAsync(DescribeConfigurationRequest describeConfigurationRequest)
Returns information about the specified configuration.
describeConfigurationRequest
- Future<DescribeConfigurationResult> describeConfigurationAsync(DescribeConfigurationRequest describeConfigurationRequest, AsyncHandler<DescribeConfigurationRequest,DescribeConfigurationResult> asyncHandler)
Returns information about the specified configuration.
describeConfigurationRequest
- 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.Future<DescribeConfigurationRevisionResult> describeConfigurationRevisionAsync(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest)
Returns the specified configuration revision for the specified configuration.
describeConfigurationRevisionRequest
- Future<DescribeConfigurationRevisionResult> describeConfigurationRevisionAsync(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest, AsyncHandler<DescribeConfigurationRevisionRequest,DescribeConfigurationRevisionResult> asyncHandler)
Returns the specified configuration revision for the specified configuration.
describeConfigurationRevisionRequest
- 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.Future<DescribeUserResult> describeUserAsync(DescribeUserRequest describeUserRequest)
Returns information about an ActiveMQ user.
describeUserRequest
- Future<DescribeUserResult> describeUserAsync(DescribeUserRequest describeUserRequest, AsyncHandler<DescribeUserRequest,DescribeUserResult> asyncHandler)
Returns information about an ActiveMQ user.
describeUserRequest
- 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.Future<ListBrokersResult> listBrokersAsync(ListBrokersRequest listBrokersRequest)
Returns a list of all brokers.
listBrokersRequest
- Future<ListBrokersResult> listBrokersAsync(ListBrokersRequest listBrokersRequest, AsyncHandler<ListBrokersRequest,ListBrokersResult> asyncHandler)
Returns a list of all brokers.
listBrokersRequest
- 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.Future<ListConfigurationRevisionsResult> listConfigurationRevisionsAsync(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest)
Returns a list of all revisions for the specified configuration.
listConfigurationRevisionsRequest
- Future<ListConfigurationRevisionsResult> listConfigurationRevisionsAsync(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest, AsyncHandler<ListConfigurationRevisionsRequest,ListConfigurationRevisionsResult> asyncHandler)
Returns a list of all revisions for the specified configuration.
listConfigurationRevisionsRequest
- 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.Future<ListConfigurationsResult> listConfigurationsAsync(ListConfigurationsRequest listConfigurationsRequest)
Returns a list of all configurations.
listConfigurationsRequest
- Future<ListConfigurationsResult> listConfigurationsAsync(ListConfigurationsRequest listConfigurationsRequest, AsyncHandler<ListConfigurationsRequest,ListConfigurationsResult> asyncHandler)
Returns a list of all configurations.
listConfigurationsRequest
- 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.Future<ListTagsResult> listTagsAsync(ListTagsRequest listTagsRequest)
Lists tags for a resource.
listTagsRequest
- Future<ListTagsResult> listTagsAsync(ListTagsRequest listTagsRequest, AsyncHandler<ListTagsRequest,ListTagsResult> asyncHandler)
Lists tags for a resource.
listTagsRequest
- 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.Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest)
Returns a list of all ActiveMQ users.
listUsersRequest
- Future<ListUsersResult> listUsersAsync(ListUsersRequest listUsersRequest, AsyncHandler<ListUsersRequest,ListUsersResult> asyncHandler)
Returns a list of all ActiveMQ users.
listUsersRequest
- 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.Future<PromoteResult> promoteAsync(PromoteRequest promoteRequest)
Promotes a data replication replica broker to the primary broker role.
promoteRequest
- Promotes a data replication replica broker to the primary broker role.Future<PromoteResult> promoteAsync(PromoteRequest promoteRequest, AsyncHandler<PromoteRequest,PromoteResult> asyncHandler)
Promotes a data replication replica broker to the primary broker role.
promoteRequest
- 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.Future<RebootBrokerResult> rebootBrokerAsync(RebootBrokerRequest rebootBrokerRequest)
Reboots a broker. Note: This API is asynchronous.
rebootBrokerRequest
- Future<RebootBrokerResult> rebootBrokerAsync(RebootBrokerRequest rebootBrokerRequest, AsyncHandler<RebootBrokerRequest,RebootBrokerResult> asyncHandler)
Reboots a broker. Note: This API is asynchronous.
rebootBrokerRequest
- 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.Future<UpdateBrokerResult> updateBrokerAsync(UpdateBrokerRequest updateBrokerRequest)
Adds a pending configuration change to a broker.
updateBrokerRequest
- Updates the broker using the specified properties.Future<UpdateBrokerResult> updateBrokerAsync(UpdateBrokerRequest updateBrokerRequest, AsyncHandler<UpdateBrokerRequest,UpdateBrokerResult> asyncHandler)
Adds a pending configuration change to a broker.
updateBrokerRequest
- 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.Future<UpdateConfigurationResult> updateConfigurationAsync(UpdateConfigurationRequest updateConfigurationRequest)
Updates the specified configuration.
updateConfigurationRequest
- Updates the specified configuration.Future<UpdateConfigurationResult> updateConfigurationAsync(UpdateConfigurationRequest updateConfigurationRequest, AsyncHandler<UpdateConfigurationRequest,UpdateConfigurationResult> asyncHandler)
Updates the specified configuration.
updateConfigurationRequest
- 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.Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest)
Updates the information for an ActiveMQ user.
updateUserRequest
- Updates the information for an ActiveMQ user.Future<UpdateUserResult> updateUserAsync(UpdateUserRequest updateUserRequest, AsyncHandler<UpdateUserRequest,UpdateUserResult> asyncHandler)
Updates the information for an ActiveMQ user.
updateUserRequest
- 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.