AbstractAmazonMQ (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mq.AbstractAmazonMQ

All Implemented Interfaces:

AmazonMQ

Direct Known Subclasses:

AbstractAmazonMQAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonMQ
extends Object
implements AmazonMQ
```
Abstract implementation of AmazonMQ. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.mq.AmazonMQ
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateBrokerResult`	`createBroker(CreateBrokerRequest request)` Creates a broker.
`CreateConfigurationResult`	`createConfiguration(CreateConfigurationRequest request)` Creates a new configuration for the specified configuration name.
`CreateTagsResult`	`createTags(CreateTagsRequest request)` Add a tag to a resource.
`CreateUserResult`	`createUser(CreateUserRequest request)` Creates an ActiveMQ user.
`DeleteBrokerResult`	`deleteBroker(DeleteBrokerRequest request)` Deletes a broker.
`DeleteTagsResult`	`deleteTags(DeleteTagsRequest request)` Removes a tag from a resource.
`DeleteUserResult`	`deleteUser(DeleteUserRequest request)` Deletes an ActiveMQ user.
`DescribeBrokerResult`	`describeBroker(DescribeBrokerRequest request)` Returns information about the specified broker.
`DescribeBrokerEngineTypesResult`	`describeBrokerEngineTypes(DescribeBrokerEngineTypesRequest request)` Describe available engine types and versions.
`DescribeBrokerInstanceOptionsResult`	`describeBrokerInstanceOptions(DescribeBrokerInstanceOptionsRequest request)` Describe available broker instance options.
`DescribeConfigurationResult`	`describeConfiguration(DescribeConfigurationRequest request)` Returns information about the specified configuration.
`DescribeConfigurationRevisionResult`	`describeConfigurationRevision(DescribeConfigurationRevisionRequest request)` Returns the specified configuration revision for the specified configuration.
`DescribeUserResult`	`describeUser(DescribeUserRequest request)` 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 request)` Returns a list of all brokers.
`ListConfigurationRevisionsResult`	`listConfigurationRevisions(ListConfigurationRevisionsRequest request)` Returns a list of all revisions for the specified configuration.
`ListConfigurationsResult`	`listConfigurations(ListConfigurationsRequest request)` Returns a list of all configurations.
`ListTagsResult`	`listTags(ListTagsRequest request)` Lists tags for a resource.
`ListUsersResult`	`listUsers(ListUsersRequest request)` Returns a list of all ActiveMQ users.
`RebootBrokerResult`	`rebootBroker(RebootBrokerRequest request)` Reboots a broker.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`UpdateBrokerResult`	`updateBroker(UpdateBrokerRequest request)` Adds a pending configuration change to a broker.
`UpdateConfigurationResult`	`updateConfiguration(UpdateConfigurationRequest request)` Updates the specified configuration.
`UpdateUserResult`	`updateUser(UpdateUserRequest request)` Updates the information for an ActiveMQ user.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createBroker
```
public CreateBrokerResult createBroker(CreateBrokerRequest request)
```
    Description copied from interface: AmazonMQ
    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 AWS Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.
    Specified by:
    
    createBroker in interface AmazonMQ
    
    Parameters:
    
    request - Creates a broker using the specified properties.
    
    Returns:
    
    Result of the CreateBroker operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createConfiguration
```
public CreateConfigurationResult createConfiguration(CreateConfigurationRequest request)
```
    Description copied from interface: AmazonMQ
    
    Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
    
    Specified by:
    
    createConfiguration in interface AmazonMQ
    
    Parameters:
    
    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
```
public CreateTagsResult createTags(CreateTagsRequest request)
```
    Description copied from interface: AmazonMQ
    
    Add a tag to a resource.
    
    Specified by:
    
    createTags in interface AmazonMQ
    
    Parameters:
    
    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
```
public CreateUserResult createUser(CreateUserRequest request)
```
    Description copied from interface: AmazonMQ
    
    Creates an ActiveMQ user.
    
    Specified by:
    
    createUser in interface AmazonMQ
    
    Parameters:
    
    request - Creates a new ActiveMQ user.
    
    Returns:
    
    Result of the CreateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteBroker
```
public DeleteBrokerResult deleteBroker(DeleteBrokerRequest request)
```
    Description copied from interface: AmazonMQ
    
    Deletes a broker. Note: This API is asynchronous.
    
    Specified by:
    
    deleteBroker in interface AmazonMQ
    
    Returns:
    
    Result of the DeleteBroker operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTags
```
public DeleteTagsResult deleteTags(DeleteTagsRequest request)
```
    Description copied from interface: AmazonMQ
    
    Removes a tag from a resource.
    
    Specified by:
    
    deleteTags in interface AmazonMQ
    
    Returns:
    
    Result of the DeleteTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteUser
```
public DeleteUserResult deleteUser(DeleteUserRequest request)
```
    Description copied from interface: AmazonMQ
    
    Deletes an ActiveMQ user.
    
    Specified by:
    
    deleteUser in interface AmazonMQ
    
    Returns:
    
    Result of the DeleteUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeBroker
```
public DescribeBrokerResult describeBroker(DescribeBrokerRequest request)
```
    Description copied from interface: AmazonMQ
    
    Returns information about the specified broker.
    
    Specified by:
    
    describeBroker in interface AmazonMQ
    
    Returns:
    
    Result of the DescribeBroker operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeBrokerEngineTypes
```
public DescribeBrokerEngineTypesResult describeBrokerEngineTypes(DescribeBrokerEngineTypesRequest request)
```
    Description copied from interface: AmazonMQ
    
    Describe available engine types and versions.
    
    Specified by:
    
    describeBrokerEngineTypes in interface AmazonMQ
    
    Returns:
    
    Result of the DescribeBrokerEngineTypes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeBrokerInstanceOptions
```
public DescribeBrokerInstanceOptionsResult describeBrokerInstanceOptions(DescribeBrokerInstanceOptionsRequest request)
```
    Description copied from interface: AmazonMQ
    
    Describe available broker instance options.
    
    Specified by:
    
    describeBrokerInstanceOptions in interface AmazonMQ
    
    Returns:
    
    Result of the DescribeBrokerInstanceOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeConfiguration
```
public DescribeConfigurationResult describeConfiguration(DescribeConfigurationRequest request)
```
    Description copied from interface: AmazonMQ
    
    Returns information about the specified configuration.
    
    Specified by:
    
    describeConfiguration in interface AmazonMQ
    
    Returns:
    
    Result of the DescribeConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeConfigurationRevision
```
public DescribeConfigurationRevisionResult describeConfigurationRevision(DescribeConfigurationRevisionRequest request)
```
    Description copied from interface: AmazonMQ
    
    Returns the specified configuration revision for the specified configuration.
    
    Specified by:
    
    describeConfigurationRevision in interface AmazonMQ
    
    Returns:
    
    Result of the DescribeConfigurationRevision operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeUser
```
public DescribeUserResult describeUser(DescribeUserRequest request)
```
    Description copied from interface: AmazonMQ
    
    Returns information about an ActiveMQ user.
    
    Specified by:
    
    describeUser in interface AmazonMQ
    
    Returns:
    
    Result of the DescribeUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listBrokers
```
public ListBrokersResult listBrokers(ListBrokersRequest request)
```
    Description copied from interface: AmazonMQ
    
    Returns a list of all brokers.
    
    Specified by:
    
    listBrokers in interface AmazonMQ
    
    Returns:
    
    Result of the ListBrokers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listConfigurationRevisions
```
public ListConfigurationRevisionsResult listConfigurationRevisions(ListConfigurationRevisionsRequest request)
```
    Description copied from interface: AmazonMQ
    
    Returns a list of all revisions for the specified configuration.
    
    Specified by:
    
    listConfigurationRevisions in interface AmazonMQ
    
    Returns:
    
    Result of the ListConfigurationRevisions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listConfigurations
```
public ListConfigurationsResult listConfigurations(ListConfigurationsRequest request)
```
    Description copied from interface: AmazonMQ
    
    Returns a list of all configurations.
    
    Specified by:
    
    listConfigurations in interface AmazonMQ
    
    Returns:
    
    Result of the ListConfigurations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTags
```
public ListTagsResult listTags(ListTagsRequest request)
```
    Description copied from interface: AmazonMQ
    
    Lists tags for a resource.
    
    Specified by:
    
    listTags in interface AmazonMQ
    
    Returns:
    
    Result of the ListTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listUsers
```
public ListUsersResult listUsers(ListUsersRequest request)
```
    Description copied from interface: AmazonMQ
    
    Returns a list of all ActiveMQ users.
    
    Specified by:
    
    listUsers in interface AmazonMQ
    
    Returns:
    
    Result of the ListUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - rebootBroker
```
public RebootBrokerResult rebootBroker(RebootBrokerRequest request)
```
    Description copied from interface: AmazonMQ
    
    Reboots a broker. Note: This API is asynchronous.
    
    Specified by:
    
    rebootBroker in interface AmazonMQ
    
    Returns:
    
    Result of the RebootBroker operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateBroker
```
public UpdateBrokerResult updateBroker(UpdateBrokerRequest request)
```
    Description copied from interface: AmazonMQ
    
    Adds a pending configuration change to a broker.
    
    Specified by:
    
    updateBroker in interface AmazonMQ
    
    Parameters:
    
    request - Updates the broker using the specified properties.
    
    Returns:
    
    Result of the UpdateBroker operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateConfiguration
```
public UpdateConfigurationResult updateConfiguration(UpdateConfigurationRequest request)
```
    Description copied from interface: AmazonMQ
    
    Updates the specified configuration.
    
    Specified by:
    
    updateConfiguration in interface AmazonMQ
    
    Parameters:
    
    request - Updates the specified configuration.
    
    Returns:
    
    Result of the UpdateConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateUser
```
public UpdateUserResult updateUser(UpdateUserRequest request)
```
    Description copied from interface: AmazonMQ
    
    Updates the information for an ActiveMQ user.
    
    Specified by:
    
    updateUser in interface AmazonMQ
    
    Parameters:
    
    request - Updates the information for an ActiveMQ user.
    
    Returns:
    
    Result of the UpdateUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonMQ
    
    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.
    
    Specified by:
    
    shutdown in interface AmazonMQ
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonMQ
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonMQ
    
    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?

Class AbstractAmazonMQ

Field Summary

Fields inherited from interface com.amazonaws.services.mq.AmazonMQ

Method Summary

Methods inherited from class java.lang.Object

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