JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
  • Detail:
  • Field |
  • Constr |
  • Method
com.amazonaws.services.mq

Class AmazonMQClient

  • All Implemented Interfaces:
    AmazonMQ
    Direct Known Subclasses:
    AmazonMQAsyncClient 

    @ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonMQClient
extends AmazonWebServiceClient
implements AmazonMQ
    Client for accessing AmazonMQ. All service calls made using this client are blocking, and will not return until the service call completes.

    Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

    • Method Detail

      • createBroker

        public CreateBrokerResult createBroker(CreateBrokerRequest request)

        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.

        Specified by:
        createBroker in interface AmazonMQ
        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

        public CreateConfigurationResult createConfiguration(CreateConfigurationRequest request)

        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:
        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 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

      • createTags

        public CreateTagsResult createTags(CreateTagsRequest request)

        Add a tag to a resource.

        Specified by:
        createTags in interface AmazonMQ
        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

        public CreateUserResult createUser(CreateUserRequest request)

        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.

        Specified by:
        createUser in interface AmazonMQ
        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. 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

      • deleteBroker

        public DeleteBrokerResult deleteBroker(DeleteBrokerRequest request)

        Deletes a broker. Note: This API is asynchronous.

        Specified by:
        deleteBroker in interface AmazonMQ
        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

        public DeleteTagsResult deleteTags(DeleteTagsRequest request)

        Removes a tag from a resource.

        Specified by:
        deleteTags in interface AmazonMQ
        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

        public DeleteUserResult deleteUser(DeleteUserRequest request)

        Deletes an ActiveMQ user.

        Specified by:
        deleteUser in interface AmazonMQ
        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

        public DescribeBrokerResult describeBroker(DescribeBrokerRequest request)

        Returns information about the specified broker.

        Specified by:
        describeBroker in interface AmazonMQ
        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

      • describeUser

        public DescribeUserResult describeUser(DescribeUserRequest request)

        Returns information about an ActiveMQ user.

        Specified by:
        describeUser in interface AmazonMQ
        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

      • listTags

        public ListTagsResult listTags(ListTagsRequest request)

        Lists tags for a resource.

        Specified by:
        listTags in interface AmazonMQ
        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

        public ListUsersResult listUsers(ListUsersRequest request)

        Returns a list of all ActiveMQ users.

        Specified by:
        listUsers in interface AmazonMQ
        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

      • promote

        public PromoteResult promote(PromoteRequest request)

        Promotes a data replication replica broker to the primary broker role.

        Specified by:
        promote in interface AmazonMQ
        Parameters:
        promoteRequest - Promotes a data replication replica broker to the primary broker role.
        Returns:
        Result of the Promote 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

        public RebootBrokerResult rebootBroker(RebootBrokerRequest request)

        Reboots a broker. Note: This API is asynchronous.

        Specified by:
        rebootBroker in interface AmazonMQ
        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

        public UpdateBrokerResult updateBroker(UpdateBrokerRequest request)

        Adds a pending configuration change to a broker.

        Specified by:
        updateBroker in interface AmazonMQ
        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. 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

      • updateConfiguration

        public UpdateConfigurationResult updateConfiguration(UpdateConfigurationRequest request)

        Updates the specified configuration.

        Specified by:
        updateConfiguration in interface AmazonMQ
        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. 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

      • updateUser

        public UpdateUserResult updateUser(UpdateUserRequest request)

        Updates the information for an ActiveMQ user.

        Specified by:
        updateUser in interface AmazonMQ
        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. 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

      • getCachedResponseMetadata

        public 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 the 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.

      • shutdown

        public void shutdown()
        Description copied from class: AmazonWebServiceClient
        Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
        Specified by:
        shutdown in interface AmazonMQ
        Overrides:
        shutdown in class AmazonWebServiceClient
Skip navigation links
  • Detail:
  • Field |
  • Constr |
  • Method

AltStyle によって変換されたページ (->オリジナル) /