Package software.amazon.awssdk.services.mq

Interface MqAsyncClient

  • All Superinterfaces:
    AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
    @Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface MqAsyncClient
extends AwsClient
    Service client for accessing AmazonMQ asynchronously. 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.

    • Method Detail

      • createBroker

        default CompletableFuture<CreateBrokerResponse> createBroker​(CreateBrokerRequest createBrokerRequest)

        Creates a broker. Note: This API is asynchronous.

        To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.

        • ec2:CreateNetworkInterface

          This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.

        • ec2:CreateNetworkInterfacePermission

          This permission is required to attach the ENI to the broker instance.

        • ec2:DeleteNetworkInterface

        • ec2:DeleteNetworkInterfacePermission

        • ec2:DetachNetworkInterface

        • ec2:DescribeInternetGateways

        • ec2:DescribeNetworkInterfaces

        • ec2:DescribeNetworkInterfacePermissions

        • ec2:DescribeRouteTables

        • ec2:DescribeSecurityGroups

        • ec2:DescribeSubnets

        • ec2:DescribeVpcs

        For more information, see Create an IAM User and Get Your Amazon Web Services Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.

        Parameters:
        createBrokerRequest - Creates a broker using the specified properties.
        Returns:
        A Java Future containing the result of the CreateBroker operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createBroker

        default CompletableFuture<CreateBrokerResponse> createBroker​(Consumer<CreateBrokerRequest.Builder> createBrokerRequest)

        Creates a broker. Note: This API is asynchronous.

        To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.

        • ec2:CreateNetworkInterface

          This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.

        • ec2:CreateNetworkInterfacePermission

          This permission is required to attach the ENI to the broker instance.

        • ec2:DeleteNetworkInterface

        • ec2:DeleteNetworkInterfacePermission

        • ec2:DetachNetworkInterface

        • ec2:DescribeInternetGateways

        • ec2:DescribeNetworkInterfaces

        • ec2:DescribeNetworkInterfacePermissions

        • ec2:DescribeRouteTables

        • ec2:DescribeSecurityGroups

        • ec2:DescribeSubnets

        • ec2:DescribeVpcs

        For more information, see Create an IAM User and Get Your Amazon Web Services Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.


        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:
        A Java Future containing the result of the CreateBroker operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createConfiguration

        default CompletableFuture<CreateConfigurationResponse> 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:
        A Java Future containing the result of the CreateConfiguration operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createConfiguration

        default CompletableFuture<CreateConfigurationResponse> createConfiguration​(Consumer<CreateConfigurationRequest.Builder> createConfigurationRequest)

        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:
        A Java Future containing the result of the CreateConfiguration operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createTags

        default CompletableFuture<CreateTagsResponse> createTags​(CreateTagsRequest createTagsRequest)

        Add a tag to a resource.

        Parameters:
        createTagsRequest - A map of the key-value pairs for the resource tag.
        Returns:
        A Java Future containing the result of the CreateTags operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createTags

        default CompletableFuture<CreateTagsResponse> createTags​(Consumer<CreateTagsRequest.Builder> createTagsRequest)

        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:
        A Java Future containing the result of the CreateTags operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createUser

        default CompletableFuture<CreateUserResponse> createUser​(CreateUserRequest createUserRequest)

        Creates an ActiveMQ user.

        Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.

        Parameters:
        createUserRequest - Creates a new ActiveMQ user.
        Returns:
        A Java Future containing the result of the CreateUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createUser

        default CompletableFuture<CreateUserResponse> createUser​(Consumer<CreateUserRequest.Builder> createUserRequest)

        Creates an ActiveMQ user.

        Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs. Broker usernames are not intended to be used for private or sensitive data.


        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:
        A Java Future containing the result of the CreateUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteBroker

        default CompletableFuture<DeleteBrokerResponse> deleteBroker​(DeleteBrokerRequest deleteBrokerRequest)

        Deletes a broker. Note: This API is asynchronous.

        Parameters:
        deleteBrokerRequest -
        Returns:
        A Java Future containing the result of the DeleteBroker operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteBroker

        default CompletableFuture<DeleteBrokerResponse> deleteBroker​(Consumer<DeleteBrokerRequest.Builder> deleteBrokerRequest)

        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:
        A Java Future containing the result of the DeleteBroker operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteTags

        default CompletableFuture<DeleteTagsResponse> deleteTags​(DeleteTagsRequest deleteTagsRequest)

        Removes a tag from a resource.

        Parameters:
        deleteTagsRequest -
        Returns:
        A Java Future containing the result of the DeleteTags operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteTags

        default CompletableFuture<DeleteTagsResponse> deleteTags​(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)

        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:
        A Java Future containing the result of the DeleteTags operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteUser

        default CompletableFuture<DeleteUserResponse> deleteUser​(DeleteUserRequest deleteUserRequest)

        Deletes an ActiveMQ user.

        Parameters:
        deleteUserRequest -
        Returns:
        A Java Future containing the result of the DeleteUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteUser

        default CompletableFuture<DeleteUserResponse> deleteUser​(Consumer<DeleteUserRequest.Builder> deleteUserRequest)

        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:
        A Java Future containing the result of the DeleteUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeBroker

        default CompletableFuture<DescribeBrokerResponse> describeBroker​(DescribeBrokerRequest describeBrokerRequest)

        Returns information about the specified broker.

        Parameters:
        describeBrokerRequest -
        Returns:
        A Java Future containing the result of the DescribeBroker operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeBroker

        default CompletableFuture<DescribeBrokerResponse> describeBroker​(Consumer<DescribeBrokerRequest.Builder> describeBrokerRequest)

        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:
        A Java Future containing the result of the DescribeBroker operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeBrokerEngineTypes

        default CompletableFuture<DescribeBrokerEngineTypesResponse> describeBrokerEngineTypes​(DescribeBrokerEngineTypesRequest describeBrokerEngineTypesRequest)

        Describe available engine types and versions.

        Parameters:
        describeBrokerEngineTypesRequest -
        Returns:
        A Java Future containing the result of the DescribeBrokerEngineTypes operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeBrokerEngineTypes

        default CompletableFuture<DescribeBrokerEngineTypesResponse> describeBrokerEngineTypes​(Consumer<DescribeBrokerEngineTypesRequest.Builder> describeBrokerEngineTypesRequest)

        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:
        A Java Future containing the result of the DescribeBrokerEngineTypes operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeBrokerInstanceOptions

        default CompletableFuture<DescribeBrokerInstanceOptionsResponse> describeBrokerInstanceOptions​(DescribeBrokerInstanceOptionsRequest describeBrokerInstanceOptionsRequest)

        Describe available broker instance options.

        Parameters:
        describeBrokerInstanceOptionsRequest -
        Returns:
        A Java Future containing the result of the DescribeBrokerInstanceOptions operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeBrokerInstanceOptions

        default CompletableFuture<DescribeBrokerInstanceOptionsResponse> describeBrokerInstanceOptions​(Consumer<DescribeBrokerInstanceOptionsRequest.Builder> describeBrokerInstanceOptionsRequest)

        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:
        A Java Future containing the result of the DescribeBrokerInstanceOptions operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeConfiguration

        default CompletableFuture<DescribeConfigurationResponse> describeConfiguration​(DescribeConfigurationRequest describeConfigurationRequest)

        Returns information about the specified configuration.

        Parameters:
        describeConfigurationRequest -
        Returns:
        A Java Future containing the result of the DescribeConfiguration operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeConfiguration

        default CompletableFuture<DescribeConfigurationResponse> describeConfiguration​(Consumer<DescribeConfigurationRequest.Builder> describeConfigurationRequest)

        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:
        A Java Future containing the result of the DescribeConfiguration operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeConfigurationRevision

        default CompletableFuture<DescribeConfigurationRevisionResponse> describeConfigurationRevision​(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest)

        Returns the specified configuration revision for the specified configuration.

        Parameters:
        describeConfigurationRevisionRequest -
        Returns:
        A Java Future containing the result of the DescribeConfigurationRevision operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeConfigurationRevision

        default CompletableFuture<DescribeConfigurationRevisionResponse> describeConfigurationRevision​(Consumer<DescribeConfigurationRevisionRequest.Builder> describeConfigurationRevisionRequest)

        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:
        A Java Future containing the result of the DescribeConfigurationRevision operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeUser

        default CompletableFuture<DescribeUserResponse> describeUser​(DescribeUserRequest describeUserRequest)

        Returns information about an ActiveMQ user.

        Parameters:
        describeUserRequest -
        Returns:
        A Java Future containing the result of the DescribeUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeUser

        default CompletableFuture<DescribeUserResponse> describeUser​(Consumer<DescribeUserRequest.Builder> describeUserRequest)

        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:
        A Java Future containing the result of the DescribeUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listBrokers

        default CompletableFuture<ListBrokersResponse> listBrokers​(ListBrokersRequest listBrokersRequest)

        Returns a list of all brokers.

        Parameters:
        listBrokersRequest -
        Returns:
        A Java Future containing the result of the ListBrokers operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listBrokers

        default CompletableFuture<ListBrokersResponse> listBrokers​(Consumer<ListBrokersRequest.Builder> listBrokersRequest)

        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:
        A Java Future containing the result of the ListBrokers operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listBrokers

        default CompletableFuture<ListBrokersResponse> listBrokers()

        Returns a list of all brokers.

        Returns:
        A Java Future containing the result of the ListBrokers operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listBrokersPaginator

        default ListBrokersPublisher listBrokersPaginator()

        This is a variant of listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mq.model.ListBrokersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mq.model.ListBrokersResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        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 publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listBrokersPaginator

        default ListBrokersPublisher listBrokersPaginator​(ListBrokersRequest listBrokersRequest)

        This is a variant of listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mq.model.ListBrokersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mq.model.ListBrokersResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        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 publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listBrokersPaginator

        default ListBrokersPublisher listBrokersPaginator​(Consumer<ListBrokersRequest.Builder> listBrokersRequest)

        This is a variant of listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

        When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

        The following are few ways to use the response class:

        1) Using the subscribe helper method 
         
 software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.mq.model.ListBrokersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.mq.model.ListBrokersResponse response) { //... };
 });
        As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

        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 publisher that can be subscribed to request a stream of response pages.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listConfigurationRevisions

        default CompletableFuture<ListConfigurationRevisionsResponse> listConfigurationRevisions​(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest)

        Returns a list of all revisions for the specified configuration.

        Parameters:
        listConfigurationRevisionsRequest -
        Returns:
        A Java Future containing the result of the ListConfigurationRevisions operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listConfigurationRevisions

        default CompletableFuture<ListConfigurationRevisionsResponse> listConfigurationRevisions​(Consumer<ListConfigurationRevisionsRequest.Builder> listConfigurationRevisionsRequest)

        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:
        A Java Future containing the result of the ListConfigurationRevisions operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listConfigurations

        default CompletableFuture<ListConfigurationsResponse> listConfigurations​(ListConfigurationsRequest listConfigurationsRequest)

        Returns a list of all configurations.

        Parameters:
        listConfigurationsRequest -
        Returns:
        A Java Future containing the result of the ListConfigurations operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listConfigurations

        default CompletableFuture<ListConfigurationsResponse> listConfigurations​(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest)

        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:
        A Java Future containing the result of the ListConfigurations operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listConfigurations

        default CompletableFuture<ListConfigurationsResponse> listConfigurations()

        Returns a list of all configurations.

        Returns:
        A Java Future containing the result of the ListConfigurations operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listTags

        default CompletableFuture<ListTagsResponse> listTags​(ListTagsRequest listTagsRequest)

        Lists tags for a resource.

        Parameters:
        listTagsRequest -
        Returns:
        A Java Future containing the result of the ListTags operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listTags

        default CompletableFuture<ListTagsResponse> listTags​(Consumer<ListTagsRequest.Builder> listTagsRequest)

        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:
        A Java Future containing the result of the ListTags operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listUsers

        default CompletableFuture<ListUsersResponse> listUsers​(ListUsersRequest listUsersRequest)

        Returns a list of all ActiveMQ users.

        Parameters:
        listUsersRequest -
        Returns:
        A Java Future containing the result of the ListUsers operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listUsers

        default CompletableFuture<ListUsersResponse> listUsers​(Consumer<ListUsersRequest.Builder> listUsersRequest)

        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:
        A Java Future containing the result of the ListUsers operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • promote

        default CompletableFuture<PromoteResponse> promote​(PromoteRequest promoteRequest)

        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:
        A Java Future containing the result of the Promote operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • promote

        default CompletableFuture<PromoteResponse> promote​(Consumer<PromoteRequest.Builder> promoteRequest)

        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:
        A Java Future containing the result of the Promote operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • rebootBroker

        default CompletableFuture<RebootBrokerResponse> rebootBroker​(RebootBrokerRequest rebootBrokerRequest)

        Reboots a broker. Note: This API is asynchronous.

        Parameters:
        rebootBrokerRequest -
        Returns:
        A Java Future containing the result of the RebootBroker operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • rebootBroker

        default CompletableFuture<RebootBrokerResponse> rebootBroker​(Consumer<RebootBrokerRequest.Builder> rebootBrokerRequest)

        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:
        A Java Future containing the result of the RebootBroker operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateBroker

        default CompletableFuture<UpdateBrokerResponse> updateBroker​(UpdateBrokerRequest updateBrokerRequest)

        Adds a pending configuration change to a broker.

        Parameters:
        updateBrokerRequest - Updates the broker using the specified properties.
        Returns:
        A Java Future containing the result of the UpdateBroker operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateBroker

        default CompletableFuture<UpdateBrokerResponse> updateBroker​(Consumer<UpdateBrokerRequest.Builder> updateBrokerRequest)

        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:
        A Java Future containing the result of the UpdateBroker operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateConfiguration

        default CompletableFuture<UpdateConfigurationResponse> updateConfiguration​(UpdateConfigurationRequest updateConfigurationRequest)

        Updates the specified configuration.

        Parameters:
        updateConfigurationRequest - Updates the specified configuration.
        Returns:
        A Java Future containing the result of the UpdateConfiguration operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateConfiguration

        default CompletableFuture<UpdateConfigurationResponse> updateConfiguration​(Consumer<UpdateConfigurationRequest.Builder> updateConfigurationRequest)

        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:
        A Java Future containing the result of the UpdateConfiguration operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateUser

        default CompletableFuture<UpdateUserResponse> updateUser​(UpdateUserRequest updateUserRequest)

        Updates the information for an ActiveMQ user.

        Parameters:
        updateUserRequest - Updates the information for an ActiveMQ user.
        Returns:
        A Java Future containing the result of the UpdateUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateUser

        default CompletableFuture<UpdateUserResponse> updateUser​(Consumer<UpdateUserRequest.Builder> updateUserRequest)

        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:
        A Java Future containing the result of the UpdateUser operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • 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.
        • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        • MqException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation