Package software.amazon.awssdk.services.mq

Interface MqClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface MqClient
extends AwsClient

Service client for accessing AmazonMQ. This can be created using the static builder() method.

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

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static MqClientBuilder	builder()	Create a builder that can be used to configure and create a MqClient.
static MqClient	create()	Create a MqClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateBrokerResponse	createBroker(Consumer<CreateBrokerRequest.Builder> createBrokerRequest)	Creates a broker.
default CreateBrokerResponse	createBroker(CreateBrokerRequest createBrokerRequest)	Creates a broker.
default CreateConfigurationResponse	createConfiguration(Consumer<CreateConfigurationRequest.Builder> createConfigurationRequest)	Creates a new configuration for the specified configuration name.
default CreateConfigurationResponse	createConfiguration(CreateConfigurationRequest createConfigurationRequest)	Creates a new configuration for the specified configuration name.
default CreateTagsResponse	createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)	Add a tag to a resource.
default CreateTagsResponse	createTags(CreateTagsRequest createTagsRequest)	Add a tag to a resource.
default CreateUserResponse	createUser(Consumer<CreateUserRequest.Builder> createUserRequest)	Creates an ActiveMQ user.
default CreateUserResponse	createUser(CreateUserRequest createUserRequest)	Creates an ActiveMQ user.
default DeleteBrokerResponse	deleteBroker(Consumer<DeleteBrokerRequest.Builder> deleteBrokerRequest)	Deletes a broker.
default DeleteBrokerResponse	deleteBroker(DeleteBrokerRequest deleteBrokerRequest)	Deletes a broker.
default DeleteTagsResponse	deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)	Removes a tag from a resource.
default DeleteTagsResponse	deleteTags(DeleteTagsRequest deleteTagsRequest)	Removes a tag from a resource.
default DeleteUserResponse	deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)	Deletes an ActiveMQ user.
default DeleteUserResponse	deleteUser(DeleteUserRequest deleteUserRequest)	Deletes an ActiveMQ user.
default DescribeBrokerResponse	describeBroker(Consumer<DescribeBrokerRequest.Builder> describeBrokerRequest)	Returns information about the specified broker.
default DescribeBrokerResponse	describeBroker(DescribeBrokerRequest describeBrokerRequest)	Returns information about the specified broker.
default DescribeBrokerEngineTypesResponse	describeBrokerEngineTypes(Consumer<DescribeBrokerEngineTypesRequest.Builder> describeBrokerEngineTypesRequest)	Describe available engine types and versions.
default DescribeBrokerEngineTypesResponse	describeBrokerEngineTypes(DescribeBrokerEngineTypesRequest describeBrokerEngineTypesRequest)	Describe available engine types and versions.
default DescribeBrokerInstanceOptionsResponse	describeBrokerInstanceOptions(Consumer<DescribeBrokerInstanceOptionsRequest.Builder> describeBrokerInstanceOptionsRequest)	Describe available broker instance options.
default DescribeBrokerInstanceOptionsResponse	describeBrokerInstanceOptions(DescribeBrokerInstanceOptionsRequest describeBrokerInstanceOptionsRequest)	Describe available broker instance options.
default DescribeConfigurationResponse	describeConfiguration(Consumer<DescribeConfigurationRequest.Builder> describeConfigurationRequest)	Returns information about the specified configuration.
default DescribeConfigurationResponse	describeConfiguration(DescribeConfigurationRequest describeConfigurationRequest)	Returns information about the specified configuration.
default DescribeConfigurationRevisionResponse	describeConfigurationRevision(Consumer<DescribeConfigurationRevisionRequest.Builder> describeConfigurationRevisionRequest)	Returns the specified configuration revision for the specified configuration.
default DescribeConfigurationRevisionResponse	describeConfigurationRevision(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest)	Returns the specified configuration revision for the specified configuration.
default DescribeUserResponse	describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)	Returns information about an ActiveMQ user.
default DescribeUserResponse	describeUser(DescribeUserRequest describeUserRequest)	Returns information about an ActiveMQ user.
default ListBrokersResponse	listBrokers()	Returns a list of all brokers.
default ListBrokersResponse	listBrokers(Consumer<ListBrokersRequest.Builder> listBrokersRequest)	Returns a list of all brokers.
default ListBrokersResponse	listBrokers(ListBrokersRequest listBrokersRequest)	Returns a list of all brokers.
default ListBrokersIterable	listBrokersPaginator()	This is a variant of listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest) operation.
default ListBrokersIterable	listBrokersPaginator(Consumer<ListBrokersRequest.Builder> listBrokersRequest)	This is a variant of listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest) operation.
default ListBrokersIterable	listBrokersPaginator(ListBrokersRequest listBrokersRequest)	This is a variant of listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest) operation.
default ListConfigurationRevisionsResponse	listConfigurationRevisions(Consumer<ListConfigurationRevisionsRequest.Builder> listConfigurationRevisionsRequest)	Returns a list of all revisions for the specified configuration.
default ListConfigurationRevisionsResponse	listConfigurationRevisions(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest)	Returns a list of all revisions for the specified configuration.
default ListConfigurationsResponse	listConfigurations()	Returns a list of all configurations.
default ListConfigurationsResponse	listConfigurations(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest)	Returns a list of all configurations.
default ListConfigurationsResponse	listConfigurations(ListConfigurationsRequest listConfigurationsRequest)	Returns a list of all configurations.
default ListTagsResponse	listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)	Lists tags for a resource.
default ListTagsResponse	listTags(ListTagsRequest listTagsRequest)	Lists tags for a resource.
default ListUsersResponse	listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)	Returns a list of all ActiveMQ users.
default ListUsersResponse	listUsers(ListUsersRequest listUsersRequest)	Returns a list of all ActiveMQ users.
default PromoteResponse	promote(Consumer<PromoteRequest.Builder> promoteRequest)	Promotes a data replication replica broker to the primary broker role.
default PromoteResponse	promote(PromoteRequest promoteRequest)	Promotes a data replication replica broker to the primary broker role.
default RebootBrokerResponse	rebootBroker(Consumer<RebootBrokerRequest.Builder> rebootBrokerRequest)	Reboots a broker.
default RebootBrokerResponse	rebootBroker(RebootBrokerRequest rebootBrokerRequest)	Reboots a broker.
default MqServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default UpdateBrokerResponse	updateBroker(Consumer<UpdateBrokerRequest.Builder> updateBrokerRequest)	Adds a pending configuration change to a broker.
default UpdateBrokerResponse	updateBroker(UpdateBrokerRequest updateBrokerRequest)	Adds a pending configuration change to a broker.
default UpdateConfigurationResponse	updateConfiguration(Consumer<UpdateConfigurationRequest.Builder> updateConfigurationRequest)	Updates the specified configuration.
default UpdateConfigurationResponse	updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest)	Updates the specified configuration.
default UpdateUserResponse	updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)	Updates the information for an ActiveMQ user.
default 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

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createBroker

default CreateBrokerResponse createBroker(CreateBrokerRequest createBrokerRequest)
                                   throws BadRequestException,
UnauthorizedException,
InternalServerErrorException,
ConflictException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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:

Result of the CreateBroker operation returned by the service.

See Also:

• AWS API Documentation

createBroker

default CreateBrokerResponse createBroker(Consumer<CreateBrokerRequest.Builder> createBrokerRequest)
                                   throws BadRequestException,
UnauthorizedException,
InternalServerErrorException,
ConflictException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via CreateBrokerRequest.builder()

Parameters:

createBrokerRequest - A Consumer that will call methods on CreateBrokerRequest.Builder to create a request. Creates a broker using the specified properties.

Returns:

Result of the CreateBroker operation returned by the service.

See Also:

• AWS API Documentation

createConfiguration

default CreateConfigurationResponse createConfiguration(CreateConfigurationRequest createConfigurationRequest)
                                                 throws BadRequestException,
InternalServerErrorException,
ConflictException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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:

Result of the CreateConfiguration operation returned by the service.

See Also:

• AWS API Documentation

createConfiguration

default CreateConfigurationResponse createConfiguration(Consumer<CreateConfigurationRequest.Builder> createConfigurationRequest)
                                                 throws BadRequestException,
InternalServerErrorException,
ConflictException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via CreateConfigurationRequest.builder()

Parameters:

createConfigurationRequest - A Consumer that will call methods on CreateConfigurationRequest.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:

Result of the CreateConfiguration operation returned by the service.

See Also:

• AWS API Documentation

createTags

default CreateTagsResponse createTags(CreateTagsRequest createTagsRequest)
                               throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Add a tag to a resource.

Parameters:

createTagsRequest - A map of the key-value pairs for the resource tag.

Returns:

Result of the CreateTags operation returned by the service.

See Also:

• AWS API Documentation

createTags

default CreateTagsResponse createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)
                               throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via CreateTagsRequest.builder()

Parameters:

createTagsRequest - A Consumer that will call methods on CreateTagsRequest.Builder to create a request. A map of the key-value pairs for the resource tag.

Returns:

Result of the CreateTags operation returned by the service.

See Also:

• AWS API Documentation

createUser

default CreateUserResponse createUser(CreateUserRequest createUserRequest)
                               throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ConflictException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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:

Result of the CreateUser operation returned by the service.

See Also:

• AWS API Documentation

createUser

default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
                               throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ConflictException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via CreateUserRequest.builder()

Parameters:

createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request. Creates a new ActiveMQ user.

Returns:

Result of the CreateUser operation returned by the service.

See Also:

• AWS API Documentation

deleteBroker

default DeleteBrokerResponse deleteBroker(DeleteBrokerRequest deleteBrokerRequest)
                                   throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Deletes a broker. Note: This API is asynchronous.

Parameters:

deleteBrokerRequest -

Returns:

Result of the DeleteBroker operation returned by the service.

See Also:

• AWS API Documentation

deleteBroker

default DeleteBrokerResponse deleteBroker(Consumer<DeleteBrokerRequest.Builder> deleteBrokerRequest)
                                   throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via DeleteBrokerRequest.builder()

Parameters:

deleteBrokerRequest - A Consumer that will call methods on DeleteBrokerRequest.Builder to create a request.

Returns:

Result of the DeleteBroker operation returned by the service.

See Also:

• AWS API Documentation

deleteTags

default DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest)
                               throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Removes a tag from a resource.

Parameters:

deleteTagsRequest -

Returns:

Result of the DeleteTags operation returned by the service.

See Also:

• AWS API Documentation

deleteTags

default DeleteTagsResponse deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
                               throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via DeleteTagsRequest.builder()

Parameters:

deleteTagsRequest - A Consumer that will call methods on DeleteTagsRequest.Builder to create a request.

Returns:

Result of the DeleteTags operation returned by the service.

See Also:

• AWS API Documentation

deleteUser

default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest)
                               throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Deletes an ActiveMQ user.

Parameters:

deleteUserRequest -

Returns:

Result of the DeleteUser operation returned by the service.

See Also:

• AWS API Documentation

deleteUser

default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
                               throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Deletes an ActiveMQ user.

This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to create one manually via DeleteUserRequest.builder()

Parameters:

deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.

Returns:

Result of the DeleteUser operation returned by the service.

See Also:

• AWS API Documentation

describeBroker

default DescribeBrokerResponse describeBroker(DescribeBrokerRequest describeBrokerRequest)
                                       throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Returns information about the specified broker.

Parameters:

describeBrokerRequest -

Returns:

Result of the DescribeBroker operation returned by the service.

See Also:

• AWS API Documentation

describeBroker

default DescribeBrokerResponse describeBroker(Consumer<DescribeBrokerRequest.Builder> describeBrokerRequest)
                                       throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via DescribeBrokerRequest.builder()

Parameters:

describeBrokerRequest - A Consumer that will call methods on DescribeBrokerRequest.Builder to create a request.

Returns:

Result of the DescribeBroker operation returned by the service.

See Also:

• AWS API Documentation

describeBrokerEngineTypes

default DescribeBrokerEngineTypesResponse describeBrokerEngineTypes(DescribeBrokerEngineTypesRequest describeBrokerEngineTypesRequest)
                                                             throws BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Describe available engine types and versions.

Parameters:

describeBrokerEngineTypesRequest -

Returns:

Result of the DescribeBrokerEngineTypes operation returned by the service.

See Also:

• AWS API Documentation

describeBrokerEngineTypes

default DescribeBrokerEngineTypesResponse describeBrokerEngineTypes(Consumer<DescribeBrokerEngineTypesRequest.Builder> describeBrokerEngineTypesRequest)
                                                             throws BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via DescribeBrokerEngineTypesRequest.builder()

Parameters:

describeBrokerEngineTypesRequest - A Consumer that will call methods on DescribeBrokerEngineTypesRequest.Builder to create a request.

Returns:

Result of the DescribeBrokerEngineTypes operation returned by the service.

See Also:

• AWS API Documentation

describeBrokerInstanceOptions

default DescribeBrokerInstanceOptionsResponse describeBrokerInstanceOptions(DescribeBrokerInstanceOptionsRequest describeBrokerInstanceOptionsRequest)
                                                                     throws BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Describe available broker instance options.

Parameters:

describeBrokerInstanceOptionsRequest -

Returns:

Result of the DescribeBrokerInstanceOptions operation returned by the service.

See Also:

• AWS API Documentation

describeBrokerInstanceOptions

default DescribeBrokerInstanceOptionsResponse describeBrokerInstanceOptions(Consumer<DescribeBrokerInstanceOptionsRequest.Builder> describeBrokerInstanceOptionsRequest)
                                                                     throws BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Describe available broker instance options.

This is a convenience which creates an instance of the DescribeBrokerInstanceOptionsRequest.Builder avoiding the need to create one manually via DescribeBrokerInstanceOptionsRequest.builder()

Parameters:

describeBrokerInstanceOptionsRequest - A Consumer that will call methods on DescribeBrokerInstanceOptionsRequest.Builder to create a request.

Returns:

Result of the DescribeBrokerInstanceOptions operation returned by the service.

See Also:

• AWS API Documentation

describeConfiguration

default DescribeConfigurationResponse describeConfiguration(DescribeConfigurationRequest describeConfigurationRequest)
                                                     throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Returns information about the specified configuration.

Parameters:

describeConfigurationRequest -

Returns:

Result of the DescribeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeConfiguration

default DescribeConfigurationResponse describeConfiguration(Consumer<DescribeConfigurationRequest.Builder> describeConfigurationRequest)
                                                     throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via DescribeConfigurationRequest.builder()

Parameters:

describeConfigurationRequest - A Consumer that will call methods on DescribeConfigurationRequest.Builder to create a request.

Returns:

Result of the DescribeConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeConfigurationRevision

default DescribeConfigurationRevisionResponse describeConfigurationRevision(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest)
                                                                     throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Returns the specified configuration revision for the specified configuration.

Parameters:

describeConfigurationRevisionRequest -

Returns:

Result of the DescribeConfigurationRevision operation returned by the service.

See Also:

• AWS API Documentation

describeConfigurationRevision

default DescribeConfigurationRevisionResponse describeConfigurationRevision(Consumer<DescribeConfigurationRevisionRequest.Builder> describeConfigurationRevisionRequest)
                                                                     throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via DescribeConfigurationRevisionRequest.builder()

Parameters:

describeConfigurationRevisionRequest - A Consumer that will call methods on DescribeConfigurationRevisionRequest.Builder to create a request.

Returns:

Result of the DescribeConfigurationRevision operation returned by the service.

See Also:

• AWS API Documentation

describeUser

default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest)
                                   throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Returns information about an ActiveMQ user.

Parameters:

describeUserRequest -

Returns:

Result of the DescribeUser operation returned by the service.

See Also:

• AWS API Documentation

describeUser

default DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
                                   throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via DescribeUserRequest.builder()

Parameters:

describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.

Returns:

Result of the DescribeUser operation returned by the service.

See Also:

• AWS API Documentation

listBrokers

default ListBrokersResponse listBrokers(ListBrokersRequest listBrokersRequest)
                                 throws BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Returns a list of all brokers.

Parameters:

listBrokersRequest -

Returns:

Result of the ListBrokers operation returned by the service.

See Also:

• AWS API Documentation

listBrokers

default ListBrokersResponse listBrokers(Consumer<ListBrokersRequest.Builder> listBrokersRequest)
                                 throws BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via ListBrokersRequest.builder()

Parameters:

listBrokersRequest - A Consumer that will call methods on ListBrokersRequest.Builder to create a request.

Returns:

Result of the ListBrokers operation returned by the service.

See Also:

• AWS API Documentation

listBrokers

default ListBrokersResponse listBrokers()
                                 throws BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Returns a list of all brokers.

Returns:

Result of the ListBrokers operation returned by the service.

See Also:

• listBrokers(ListBrokersRequest)
• AWS API Documentation

listBrokersPaginator

default ListBrokersIterable listBrokersPaginator()
                                          throws BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

This is a variant of listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
     for (software.amazon.awssdk.services.mq.model.ListBrokersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• listBrokersPaginator(ListBrokersRequest)
• AWS API Documentation

listBrokersPaginator

default ListBrokersIterable listBrokersPaginator(ListBrokersRequest listBrokersRequest)
                                          throws BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

This is a variant of listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
     for (software.amazon.awssdk.services.mq.model.ListBrokersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listBrokersPaginator

default ListBrokersIterable listBrokersPaginator(Consumer<ListBrokersRequest.Builder> listBrokersRequest)
                                          throws BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

This is a variant of listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
     for (software.amazon.awssdk.services.mq.model.ListBrokersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

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 via ListBrokersRequest.builder()

Parameters:

listBrokersRequest - A Consumer that will call methods on ListBrokersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listConfigurationRevisions

default ListConfigurationRevisionsResponse listConfigurationRevisions(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest)
                                                               throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Returns a list of all revisions for the specified configuration.

Parameters:

listConfigurationRevisionsRequest -

Returns:

Result of the ListConfigurationRevisions operation returned by the service.

See Also:

• AWS API Documentation

listConfigurationRevisions

default ListConfigurationRevisionsResponse listConfigurationRevisions(Consumer<ListConfigurationRevisionsRequest.Builder> listConfigurationRevisionsRequest)
                                                               throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via ListConfigurationRevisionsRequest.builder()

Parameters:

listConfigurationRevisionsRequest - A Consumer that will call methods on ListConfigurationRevisionsRequest.Builder to create a request.

Returns:

Result of the ListConfigurationRevisions operation returned by the service.

See Also:

• AWS API Documentation

listConfigurations

default ListConfigurationsResponse listConfigurations(ListConfigurationsRequest listConfigurationsRequest)
                                               throws BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Returns a list of all configurations.

Parameters:

listConfigurationsRequest -

Returns:

Result of the ListConfigurations operation returned by the service.

See Also:

• AWS API Documentation

listConfigurations

default ListConfigurationsResponse listConfigurations(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest)
                                               throws BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via ListConfigurationsRequest.builder()

Parameters:

listConfigurationsRequest - A Consumer that will call methods on ListConfigurationsRequest.Builder to create a request.

Returns:

Result of the ListConfigurations operation returned by the service.

See Also:

• AWS API Documentation

listConfigurations

default ListConfigurationsResponse listConfigurations()
                                               throws BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Returns a list of all configurations.

Returns:

Result of the ListConfigurations operation returned by the service.

See Also:

• listConfigurations(ListConfigurationsRequest)
• AWS API Documentation

listTags

default ListTagsResponse listTags(ListTagsRequest listTagsRequest)
                           throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Lists tags for a resource.

Parameters:

listTagsRequest -

Returns:

Result of the ListTags operation returned by the service.

See Also:

• AWS API Documentation

listTags

default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
                           throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Lists tags for a resource.

This is a convenience which creates an instance of the ListTagsRequest.Builder avoiding the need to create one manually via ListTagsRequest.builder()

Parameters:

listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request.

Returns:

Result of the ListTags operation returned by the service.

See Also:

• AWS API Documentation

listUsers

default ListUsersResponse listUsers(ListUsersRequest listUsersRequest)
                             throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Returns a list of all ActiveMQ users.

Parameters:

listUsersRequest -

Returns:

Result of the ListUsers operation returned by the service.

See Also:

• AWS API Documentation

listUsers

default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
                             throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via ListUsersRequest.builder()

Parameters:

listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.

Returns:

Result of the ListUsers operation returned by the service.

See Also:

• AWS API Documentation

promote

default PromoteResponse promote(PromoteRequest promoteRequest)
                         throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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:

Result of the Promote operation returned by the service.

See Also:

• AWS API Documentation

promote

default PromoteResponse promote(Consumer<PromoteRequest.Builder> promoteRequest)
                         throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via PromoteRequest.builder()

Parameters:

promoteRequest - A Consumer that will call methods on PromoteRequest.Builder to create a request. Promotes a data replication replica broker to the primary broker role.

Returns:

Result of the Promote operation returned by the service.

See Also:

• AWS API Documentation

rebootBroker

default RebootBrokerResponse rebootBroker(RebootBrokerRequest rebootBrokerRequest)
                                   throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Reboots a broker. Note: This API is asynchronous.

Parameters:

rebootBrokerRequest -

Returns:

Result of the RebootBroker operation returned by the service.

See Also:

• AWS API Documentation

rebootBroker

default RebootBrokerResponse rebootBroker(Consumer<RebootBrokerRequest.Builder> rebootBrokerRequest)
                                   throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via RebootBrokerRequest.builder()

Parameters:

rebootBrokerRequest - A Consumer that will call methods on RebootBrokerRequest.Builder to create a request.

Returns:

Result of the RebootBroker operation returned by the service.

See Also:

• AWS API Documentation

updateBroker

default UpdateBrokerResponse updateBroker(UpdateBrokerRequest updateBrokerRequest)
                                   throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ConflictException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Adds a pending configuration change to a broker.

Parameters:

updateBrokerRequest - Updates the broker using the specified properties.

Returns:

Result of the UpdateBroker operation returned by the service.

See Also:

• AWS API Documentation

updateBroker

default UpdateBrokerResponse updateBroker(Consumer<UpdateBrokerRequest.Builder> updateBrokerRequest)
                                   throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ConflictException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via UpdateBrokerRequest.builder()

Parameters:

updateBrokerRequest - A Consumer that will call methods on UpdateBrokerRequest.Builder to create a request. Updates the broker using the specified properties.

Returns:

Result of the UpdateBroker operation returned by the service.

See Also:

• AWS API Documentation

updateConfiguration

default UpdateConfigurationResponse updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest)
                                                 throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ConflictException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Updates the specified configuration.

Parameters:

updateConfigurationRequest - Updates the specified configuration.

Returns:

Result of the UpdateConfiguration operation returned by the service.

See Also:

• AWS API Documentation

updateConfiguration

default UpdateConfigurationResponse updateConfiguration(Consumer<UpdateConfigurationRequest.Builder> updateConfigurationRequest)
                                                 throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ConflictException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Updates the specified configuration.

This is a convenience which creates an instance of the UpdateConfigurationRequest.Builder avoiding the need to create one manually via UpdateConfigurationRequest.builder()

Parameters:

updateConfigurationRequest - A Consumer that will call methods on UpdateConfigurationRequest.Builder to create a request. Updates the specified configuration.

Returns:

Result of the UpdateConfiguration operation returned by the service.

See Also:

• AWS API Documentation

updateUser

default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest)
                               throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ConflictException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

Updates the information for an ActiveMQ user.

Parameters:

updateUserRequest - Updates the information for an ActiveMQ user.

Returns:

Result of the UpdateUser operation returned by the service.

See Also:

• AWS API Documentation

updateUser

default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
                               throws NotFoundException,
BadRequestException,
InternalServerErrorException,
ConflictException,
ForbiddenException,
AwsServiceException,
SdkClientException,
MqException

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 via UpdateUserRequest.builder()

Parameters:

updateUserRequest - A Consumer that will call methods on UpdateUserRequest.Builder to create a request. Updates the information for an ActiveMQ user.

Returns:

Result of the UpdateUser operation returned by the service.

See Also:

• AWS API Documentation

create

static MqClient create()

Create a MqClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static MqClientBuilder builder()

Create a builder that can be used to configure and create a MqClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default MqServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration