AmazonMQ (AWS SDK for Java

All Known Subinterfaces:

AmazonMQAsync

All Known Implementing Classes:

AbstractAmazonMQ, AbstractAmazonMQAsync, AmazonMQAsyncClient, AmazonMQClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonMQ
```
Interface for accessing AmazonMQ.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonMQ instead.

Amazon MQ is a managed message broker service for Apache ActiveMQ 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 and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateBrokerResult`	`createBroker(CreateBrokerRequest createBrokerRequest)` Creates a broker.
`CreateConfigurationResult`	`createConfiguration(CreateConfigurationRequest createConfigurationRequest)` Creates a new configuration for the specified configuration name.
`CreateTagsResult`	`createTags(CreateTagsRequest createTagsRequest)` Add a tag to a resource.
`CreateUserResult`	`createUser(CreateUserRequest createUserRequest)` Creates an ActiveMQ user.
`DeleteBrokerResult`	`deleteBroker(DeleteBrokerRequest deleteBrokerRequest)` Deletes a broker.
`DeleteTagsResult`	`deleteTags(DeleteTagsRequest deleteTagsRequest)` Removes a tag from a resource.
`DeleteUserResult`	`deleteUser(DeleteUserRequest deleteUserRequest)` Deletes an ActiveMQ user.
`DescribeBrokerResult`	`describeBroker(DescribeBrokerRequest describeBrokerRequest)` Returns information about the specified broker.
`DescribeBrokerEngineTypesResult`	`describeBrokerEngineTypes(DescribeBrokerEngineTypesRequest describeBrokerEngineTypesRequest)` Describe available engine types and versions.
`DescribeBrokerInstanceOptionsResult`	`describeBrokerInstanceOptions(DescribeBrokerInstanceOptionsRequest describeBrokerInstanceOptionsRequest)` Describe available broker instance options.
`DescribeConfigurationResult`	`describeConfiguration(DescribeConfigurationRequest describeConfigurationRequest)` Returns information about the specified configuration.
`DescribeConfigurationRevisionResult`	`describeConfigurationRevision(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest)` Returns the specified configuration revision for the specified configuration.
`DescribeUserResult`	`describeUser(DescribeUserRequest describeUserRequest)` Returns information about an ActiveMQ user.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListBrokersResult`	`listBrokers(ListBrokersRequest listBrokersRequest)` Returns a list of all brokers.
`ListConfigurationRevisionsResult`	`listConfigurationRevisions(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest)` Returns a list of all revisions for the specified configuration.
`ListConfigurationsResult`	`listConfigurations(ListConfigurationsRequest listConfigurationsRequest)` Returns a list of all configurations.
`ListTagsResult`	`listTags(ListTagsRequest listTagsRequest)` Lists tags for a resource.
`ListUsersResult`	`listUsers(ListUsersRequest listUsersRequest)` Returns a list of all ActiveMQ users.
`RebootBrokerResult`	`rebootBroker(RebootBrokerRequest rebootBrokerRequest)` Reboots a broker.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateBrokerResult`	`updateBroker(UpdateBrokerRequest updateBrokerRequest)` Adds a pending configuration change to a broker.
`UpdateConfigurationResult`	`updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest)` Updates the specified configuration.
`UpdateUserResult`	`updateUser(UpdateUserRequest updateUserRequest)` Updates the information for an ActiveMQ user.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - createBroker
```
CreateBrokerResult createBroker(CreateBrokerRequest createBrokerRequest)
```
    Creates a broker. Note: This API is asynchronous.
    
    Parameters:
    
    createBrokerRequest - Creates a broker using the specified properties.
    
    Returns:
    
    Result of the CreateBroker operation returned by the service.
    
    Throws:
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    UnauthorizedException - HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ConflictException - HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - createConfiguration
```
CreateConfigurationResult createConfiguration(CreateConfigurationRequest createConfigurationRequest)
```
    Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
    
    Parameters:
    
    createConfigurationRequest - Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
    
    Returns:
    
    Result of the CreateConfiguration operation returned by the service.
    
    Throws:
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ConflictException - HTTP Status Code 409: Conflict. This configuration name already exists. Retry your request with another configuration name.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your input and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - createTags
```
CreateTagsResult createTags(CreateTagsRequest createTagsRequest)
```
    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.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - createUser
```
CreateUserResult createUser(CreateUserRequest createUserRequest)
```
    Creates an ActiveMQ user.
    
    Parameters:
    
    createUserRequest - Creates a new ActiveMQ user.
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ConflictException - HTTP Status Code 409: Conflict. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - deleteBroker
```
DeleteBrokerResult deleteBroker(DeleteBrokerRequest deleteBrokerRequest)
```
    Deletes a broker. Note: This API is asynchronous.
    
    Parameters:
    
    deleteBrokerRequest -
    
    Returns:
    
    Result of the DeleteBroker operation returned by the service.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - deleteTags
```
DeleteTagsResult deleteTags(DeleteTagsRequest deleteTagsRequest)
```
    Removes a tag from a resource.
    
    Parameters:
    
    deleteTagsRequest -
    
    Returns:
    
    Result of the DeleteTags operation returned by the service.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
DeleteUserResult deleteUser(DeleteUserRequest deleteUserRequest)
```
    Deletes an ActiveMQ user.
    
    Parameters:
    
    deleteUserRequest -
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeBroker
```
DescribeBrokerResult describeBroker(DescribeBrokerRequest describeBrokerRequest)
```
    Returns information about the specified broker.
    
    Parameters:
    
    describeBrokerRequest -
    
    Returns:
    
    Result of the DescribeBroker operation returned by the service.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeBrokerEngineTypes
```
DescribeBrokerEngineTypesResult describeBrokerEngineTypes(DescribeBrokerEngineTypesRequest describeBrokerEngineTypesRequest)
```
    Describe available engine types and versions.
    
    Parameters:
    
    describeBrokerEngineTypesRequest -
    
    Returns:
    
    Result of the DescribeBrokerEngineTypes operation returned by the service.
    
    Throws:
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeBrokerInstanceOptions
```
DescribeBrokerInstanceOptionsResult describeBrokerInstanceOptions(DescribeBrokerInstanceOptionsRequest describeBrokerInstanceOptionsRequest)
```
    Describe available broker instance options.
    
    Parameters:
    
    describeBrokerInstanceOptionsRequest -
    
    Returns:
    
    Result of the DescribeBrokerInstanceOptions operation returned by the service.
    
    Throws:
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeConfiguration
```
DescribeConfigurationResult describeConfiguration(DescribeConfigurationRequest describeConfigurationRequest)
```
    Returns information about the specified configuration.
    
    Parameters:
    
    describeConfigurationRequest -
    
    Returns:
    
    Result of the DescribeConfiguration operation returned by the service.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeConfigurationRevision
```
DescribeConfigurationRevisionResult describeConfigurationRevision(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest)
```
    Returns the specified configuration revision for the specified configuration.
    
    Parameters:
    
    describeConfigurationRevisionRequest -
    
    Returns:
    
    Result of the DescribeConfigurationRevision operation returned by the service.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - describeUser
```
DescribeUserResult describeUser(DescribeUserRequest describeUserRequest)
```
    Returns information about an ActiveMQ user.
    
    Parameters:
    
    describeUserRequest -
    
    Returns:
    
    Result of the DescribeUser operation returned by the service.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - listBrokers
```
ListBrokersResult listBrokers(ListBrokersRequest listBrokersRequest)
```
    Returns a list of all brokers.
    
    Parameters:
    
    listBrokersRequest -
    
    Returns:
    
    Result of the ListBrokers operation returned by the service.
    
    Throws:
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - listConfigurationRevisions
```
ListConfigurationRevisionsResult listConfigurationRevisions(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest)
```
    Returns a list of all revisions for the specified configuration.
    
    Parameters:
    
    listConfigurationRevisionsRequest -
    
    Returns:
    
    Result of the ListConfigurationRevisions operation returned by the service.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - listConfigurations
```
ListConfigurationsResult listConfigurations(ListConfigurationsRequest listConfigurationsRequest)
```
    Returns a list of all configurations.
    
    Parameters:
    
    listConfigurationsRequest -
    
    Returns:
    
    Result of the ListConfigurations operation returned by the service.
    
    Throws:
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - listTags
```
ListTagsResult listTags(ListTagsRequest listTagsRequest)
```
    Lists tags for a resource.
    
    Parameters:
    
    listTagsRequest -
    
    Returns:
    
    Result of the ListTags operation returned by the service.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
ListUsersResult listUsers(ListUsersRequest listUsersRequest)
```
    Returns a list of all ActiveMQ users.
    
    Parameters:
    
    listUsersRequest -
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - rebootBroker
```
RebootBrokerResult rebootBroker(RebootBrokerRequest rebootBrokerRequest)
```
    Reboots a broker. Note: This API is asynchronous.
    
    Parameters:
    
    rebootBrokerRequest -
    
    Returns:
    
    Result of the RebootBroker operation returned by the service.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - updateBroker
```
UpdateBrokerResult updateBroker(UpdateBrokerRequest updateBrokerRequest)
```
    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.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ConflictException - HTTP Status Code 409: Conflict. Concurrent broker update detected. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - updateConfiguration
```
UpdateConfigurationResult updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest)
```
    Updates the specified configuration.
    
    Parameters:
    
    updateConfigurationRequest - Updates the specified configuration.
    
    Returns:
    
    Result of the UpdateConfiguration operation returned by the service.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ConflictException - HTTP Status Code 409: Conflict. Concurrent update to configuration. Retry to create a new revision.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your input and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
UpdateUserResult updateUser(UpdateUserRequest updateUserRequest)
```
    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.
    
    Throws:
    
    NotFoundException - HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
    
    BadRequestException - HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
    
    InternalServerErrorException - HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
    
    ConflictException - HTTP Status Code 409: Conflict. Retrying your request might resolve the issue.
    
    ForbiddenException - HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AmazonMQ

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

createBroker

createConfiguration

createTags

createUser

deleteBroker

deleteTags

deleteUser

describeBroker

describeBrokerEngineTypes

describeBrokerInstanceOptions

describeConfiguration

describeConfigurationRevision

describeUser

listBrokers

listConfigurationRevisions

listConfigurations

listTags

listUsers

rebootBroker

updateBroker

updateConfiguration

updateUser

shutdown

getCachedResponseMetadata