@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface MqClient extends SdkClient
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static MqClientBuilder |
builder()
Create a builder that can be used to configure and create a
MqClient. |
static MqClient |
create()
Create a
MqClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateBrokerResponse |
createBroker(Consumer<CreateBrokerRequest.Builder> createBrokerRequest)
Creates a broker.
|
default CreateBrokerResponse |
createBroker(CreateBrokerRequest createBrokerRequest)
Creates a broker.
|
default CreateConfigurationResponse |
createConfiguration(Consumer<CreateConfigurationRequest.Builder> createConfigurationRequest)
Creates a new configuration for the specified configuration name.
|
default CreateConfigurationResponse |
createConfiguration(CreateConfigurationRequest createConfigurationRequest)
Creates a new configuration for the specified configuration name.
|
default CreateTagsResponse |
createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)
Add a tag to a resource.
|
default CreateTagsResponse |
createTags(CreateTagsRequest createTagsRequest)
Add a tag to a resource.
|
default CreateUserResponse |
createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates an ActiveMQ user.
|
default CreateUserResponse |
createUser(CreateUserRequest createUserRequest)
Creates an ActiveMQ user.
|
default DeleteBrokerResponse |
deleteBroker(Consumer<DeleteBrokerRequest.Builder> deleteBrokerRequest)
Deletes a broker.
|
default DeleteBrokerResponse |
deleteBroker(DeleteBrokerRequest deleteBrokerRequest)
Deletes a broker.
|
default DeleteTagsResponse |
deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
Removes a tag from a resource.
|
default DeleteTagsResponse |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Removes a tag from a resource.
|
default DeleteUserResponse |
deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest)
Deletes an ActiveMQ user.
|
default DeleteUserResponse |
deleteUser(DeleteUserRequest deleteUserRequest)
Deletes an ActiveMQ user.
|
default DescribeBrokerResponse |
describeBroker(Consumer<DescribeBrokerRequest.Builder> describeBrokerRequest)
Returns information about the specified broker.
|
default DescribeBrokerResponse |
describeBroker(DescribeBrokerRequest describeBrokerRequest)
Returns information about the specified broker.
|
default DescribeBrokerEngineTypesResponse |
describeBrokerEngineTypes(Consumer<DescribeBrokerEngineTypesRequest.Builder> describeBrokerEngineTypesRequest)
Describe available engine types and versions.
|
default DescribeBrokerEngineTypesResponse |
describeBrokerEngineTypes(DescribeBrokerEngineTypesRequest describeBrokerEngineTypesRequest)
Describe available engine types and versions.
|
default DescribeBrokerInstanceOptionsResponse |
describeBrokerInstanceOptions(Consumer<DescribeBrokerInstanceOptionsRequest.Builder> describeBrokerInstanceOptionsRequest)
Describe available broker instance options.
|
default DescribeBrokerInstanceOptionsResponse |
describeBrokerInstanceOptions(DescribeBrokerInstanceOptionsRequest describeBrokerInstanceOptionsRequest)
Describe available broker instance options.
|
default DescribeConfigurationResponse |
describeConfiguration(Consumer<DescribeConfigurationRequest.Builder> describeConfigurationRequest)
Returns information about the specified configuration.
|
default DescribeConfigurationResponse |
describeConfiguration(DescribeConfigurationRequest describeConfigurationRequest)
Returns information about the specified configuration.
|
default DescribeConfigurationRevisionResponse |
describeConfigurationRevision(Consumer<DescribeConfigurationRevisionRequest.Builder> describeConfigurationRevisionRequest)
Returns the specified configuration revision for the specified configuration.
|
default DescribeConfigurationRevisionResponse |
describeConfigurationRevision(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest)
Returns the specified configuration revision for the specified configuration.
|
default DescribeUserResponse |
describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest)
Returns information about an ActiveMQ user.
|
default DescribeUserResponse |
describeUser(DescribeUserRequest describeUserRequest)
Returns information about an ActiveMQ user.
|
default ListBrokersResponse |
listBrokers()
Returns a list of all brokers.
|
default ListBrokersResponse |
listBrokers(Consumer<ListBrokersRequest.Builder> listBrokersRequest)
Returns a list of all brokers.
|
default ListBrokersResponse |
listBrokers(ListBrokersRequest listBrokersRequest)
Returns a list of all brokers.
|
default ListBrokersIterable |
listBrokersPaginator()
Returns a list of all brokers.
|
default ListBrokersIterable |
listBrokersPaginator(Consumer<ListBrokersRequest.Builder> listBrokersRequest)
Returns a list of all brokers.
|
default ListBrokersIterable |
listBrokersPaginator(ListBrokersRequest listBrokersRequest)
Returns a list of all brokers.
|
default ListConfigurationRevisionsResponse |
listConfigurationRevisions(Consumer<ListConfigurationRevisionsRequest.Builder> listConfigurationRevisionsRequest)
Returns a list of all revisions for the specified configuration.
|
default ListConfigurationRevisionsResponse |
listConfigurationRevisions(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest)
Returns a list of all revisions for the specified configuration.
|
default ListConfigurationsResponse |
listConfigurations()
Returns a list of all configurations.
|
default ListConfigurationsResponse |
listConfigurations(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest)
Returns a list of all configurations.
|
default ListConfigurationsResponse |
listConfigurations(ListConfigurationsRequest listConfigurationsRequest)
Returns a list of all configurations.
|
default ListTagsResponse |
listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Lists tags for a resource.
|
default ListTagsResponse |
listTags(ListTagsRequest listTagsRequest)
Lists tags for a resource.
|
default ListUsersResponse |
listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Returns a list of all ActiveMQ users.
|
default ListUsersResponse |
listUsers(ListUsersRequest listUsersRequest)
Returns a list of all ActiveMQ users.
|
default RebootBrokerResponse |
rebootBroker(Consumer<RebootBrokerRequest.Builder> rebootBrokerRequest)
Reboots a broker.
|
default RebootBrokerResponse |
rebootBroker(RebootBrokerRequest rebootBrokerRequest)
Reboots a broker.
|
static ServiceMetadata |
serviceMetadata() |
default UpdateBrokerResponse |
updateBroker(Consumer<UpdateBrokerRequest.Builder> updateBrokerRequest)
Adds a pending configuration change to a broker.
|
default UpdateBrokerResponse |
updateBroker(UpdateBrokerRequest updateBrokerRequest)
Adds a pending configuration change to a broker.
|
default UpdateConfigurationResponse |
updateConfiguration(Consumer<UpdateConfigurationRequest.Builder> updateConfigurationRequest)
Updates the specified configuration.
|
default UpdateConfigurationResponse |
updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest)
Updates the specified configuration.
|
default UpdateUserResponse |
updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
Updates the information for an ActiveMQ user.
|
default UpdateUserResponse |
updateUser(UpdateUserRequest updateUserRequest)
Updates the information for an ActiveMQ user.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static MqClient create()
MqClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static MqClientBuilder builder()
MqClient.default CreateBrokerResponse createBroker(CreateBrokerRequest createBrokerRequest) throws BadRequestException, UnauthorizedException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Creates a broker. Note: This API is asynchronous.
To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.
ec2:CreateNetworkInterface
This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.
ec2:CreateNetworkInterfacePermission
This permission is required to attach the ENI to the broker instance.
ec2:DeleteNetworkInterface
ec2:DeleteNetworkInterfacePermission
ec2:DetachNetworkInterface
ec2:DescribeInternetGateways
ec2:DescribeNetworkInterfaces
ec2:DescribeNetworkInterfacePermissions
ec2:DescribeRouteTables
ec2:DescribeSecurityGroups
ec2:DescribeSubnets
ec2:DescribeVpcs
For more information, see Create an IAM User and Get Your AWS Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.
createBrokerRequest - Creates a broker using the specified properties.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.AwsServiceExceptiondefault CreateBrokerResponse createBroker(Consumer<CreateBrokerRequest.Builder> createBrokerRequest) throws BadRequestException, UnauthorizedException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Creates a broker. Note: This API is asynchronous.
To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2 permissions in your IAM policy.
ec2:CreateNetworkInterface
This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your account.
ec2:CreateNetworkInterfacePermission
This permission is required to attach the ENI to the broker instance.
ec2:DeleteNetworkInterface
ec2:DeleteNetworkInterfacePermission
ec2:DetachNetworkInterface
ec2:DescribeInternetGateways
ec2:DescribeNetworkInterfaces
ec2:DescribeNetworkInterfacePermissions
ec2:DescribeRouteTables
ec2:DescribeSecurityGroups
ec2:DescribeSubnets
ec2:DescribeVpcs
For more information, see Create an IAM User and Get Your AWS 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()
createBrokerRequest - A Consumer that will call methods on CreateBrokerRequest.Builder to create a request.
Creates a broker using the specified properties.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.AwsServiceExceptiondefault CreateConfigurationResponse createConfiguration(CreateConfigurationRequest createConfigurationRequest) throws BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
createConfigurationRequest - Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration
(the engine type and version).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.AwsServiceExceptiondefault CreateConfigurationResponse createConfiguration(Consumer<CreateConfigurationRequest.Builder> createConfigurationRequest) throws BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).
This is a convenience which creates an instance of the CreateConfigurationRequest.Builder avoiding the
need to create one manually via CreateConfigurationRequest.builder()
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).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.AwsServiceExceptiondefault CreateTagsResponse createTags(CreateTagsRequest createTagsRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Add a tag to a resource.
createTagsRequest - A map of the key-value pairs for the resource tag.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.AwsServiceExceptiondefault CreateTagsResponse createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Add a tag to a resource.
This is a convenience which creates an instance of the CreateTagsRequest.Builder avoiding the need to
create one manually via CreateTagsRequest.builder()
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.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.AwsServiceExceptiondefault CreateUserResponse createUser(CreateUserRequest createUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Creates an ActiveMQ user.
createUserRequest - Creates a new ActiveMQ user.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.AwsServiceExceptiondefault CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Creates an ActiveMQ user.
This is a convenience which creates an instance of the CreateUserRequest.Builder avoiding the need to
create one manually via CreateUserRequest.builder()
createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.
Creates a new ActiveMQ user.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.AwsServiceExceptiondefault DeleteBrokerResponse deleteBroker(DeleteBrokerRequest deleteBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Deletes a broker. Note: This API is asynchronous.
deleteBrokerRequest - 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.AwsServiceExceptiondefault DeleteBrokerResponse deleteBroker(Consumer<DeleteBrokerRequest.Builder> deleteBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Deletes a broker. Note: This API is asynchronous.
This is a convenience which creates an instance of the DeleteBrokerRequest.Builder avoiding the need to
create one manually via DeleteBrokerRequest.builder()
deleteBrokerRequest - A Consumer that will call methods on DeleteBrokerRequest.Builder to create a request.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.AwsServiceExceptiondefault DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Removes a tag from a resource.
deleteTagsRequest - 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.AwsServiceExceptiondefault DeleteTagsResponse deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Removes a tag from a resource.
This is a convenience which creates an instance of the DeleteTagsRequest.Builder avoiding the need to
create one manually via DeleteTagsRequest.builder()
deleteTagsRequest - A Consumer that will call methods on DeleteTagsRequest.Builder to create a request.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.AwsServiceExceptiondefault DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Deletes an ActiveMQ user.
deleteUserRequest - 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.AwsServiceExceptiondefault DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Deletes an ActiveMQ user.
This is a convenience which creates an instance of the DeleteUserRequest.Builder avoiding the need to
create one manually via DeleteUserRequest.builder()
deleteUserRequest - A Consumer that will call methods on DeleteUserRequest.Builder to create a request.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.AwsServiceExceptiondefault DescribeBrokerResponse describeBroker(DescribeBrokerRequest describeBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns information about the specified broker.
describeBrokerRequest - 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.AwsServiceExceptiondefault DescribeBrokerResponse describeBroker(Consumer<DescribeBrokerRequest.Builder> describeBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns information about the specified broker.
This is a convenience which creates an instance of the DescribeBrokerRequest.Builder avoiding the need to
create one manually via DescribeBrokerRequest.builder()
describeBrokerRequest - A Consumer that will call methods on DescribeBrokerRequest.Builder to create a request.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.AwsServiceExceptiondefault DescribeBrokerEngineTypesResponse describeBrokerEngineTypes(DescribeBrokerEngineTypesRequest describeBrokerEngineTypesRequest) throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Describe available engine types and versions.
describeBrokerEngineTypesRequest - 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.AwsServiceExceptiondefault DescribeBrokerEngineTypesResponse describeBrokerEngineTypes(Consumer<DescribeBrokerEngineTypesRequest.Builder> describeBrokerEngineTypesRequest) throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Describe available engine types and versions.
This is a convenience which creates an instance of the DescribeBrokerEngineTypesRequest.Builder avoiding
the need to create one manually via DescribeBrokerEngineTypesRequest.builder()
describeBrokerEngineTypesRequest - A Consumer that will call methods on DescribeBrokerEngineTypesRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeBrokerInstanceOptionsResponse describeBrokerInstanceOptions(DescribeBrokerInstanceOptionsRequest describeBrokerInstanceOptionsRequest) throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Describe available broker instance options.
describeBrokerInstanceOptionsRequest - 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.AwsServiceExceptiondefault DescribeBrokerInstanceOptionsResponse describeBrokerInstanceOptions(Consumer<DescribeBrokerInstanceOptionsRequest.Builder> describeBrokerInstanceOptionsRequest) throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Describe available broker instance options.
This is a convenience which creates an instance of the DescribeBrokerInstanceOptionsRequest.Builder
avoiding the need to create one manually via DescribeBrokerInstanceOptionsRequest.builder()
describeBrokerInstanceOptionsRequest - A Consumer that will call methods on DescribeBrokerInstanceOptionsRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeConfigurationResponse describeConfiguration(DescribeConfigurationRequest describeConfigurationRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns information about the specified configuration.
describeConfigurationRequest - 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.AwsServiceExceptiondefault DescribeConfigurationResponse describeConfiguration(Consumer<DescribeConfigurationRequest.Builder> describeConfigurationRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns information about the specified configuration.
This is a convenience which creates an instance of the DescribeConfigurationRequest.Builder avoiding the
need to create one manually via DescribeConfigurationRequest.builder()
describeConfigurationRequest - A Consumer that will call methods on DescribeConfigurationRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeConfigurationRevisionResponse describeConfigurationRevision(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns the specified configuration revision for the specified configuration.
describeConfigurationRevisionRequest - 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.AwsServiceExceptiondefault DescribeConfigurationRevisionResponse describeConfigurationRevision(Consumer<DescribeConfigurationRevisionRequest.Builder> describeConfigurationRevisionRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns the specified configuration revision for the specified configuration.
This is a convenience which creates an instance of the DescribeConfigurationRevisionRequest.Builder
avoiding the need to create one manually via DescribeConfigurationRevisionRequest.builder()
describeConfigurationRevisionRequest - A Consumer that will call methods on DescribeConfigurationRevisionRequest.Builder to
create a request.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.AwsServiceExceptiondefault DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns information about an ActiveMQ user.
describeUserRequest - 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.AwsServiceExceptiondefault DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns information about an ActiveMQ user.
This is a convenience which creates an instance of the DescribeUserRequest.Builder avoiding the need to
create one manually via DescribeUserRequest.builder()
describeUserRequest - A Consumer that will call methods on DescribeUserRequest.Builder to create a request.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.AwsServiceExceptiondefault ListBrokersResponse listBrokers() throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns a list of all brokers.
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.AwsServiceExceptionlistBrokers(ListBrokersRequest),
AWS API
Documentationdefault ListBrokersResponse listBrokers(ListBrokersRequest listBrokersRequest) throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns a list of all brokers.
listBrokersRequest - 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.AwsServiceExceptiondefault ListBrokersResponse listBrokers(Consumer<ListBrokersRequest.Builder> listBrokersRequest) throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns a list of all brokers.
This is a convenience which creates an instance of the ListBrokersRequest.Builder avoiding the need to
create one manually via ListBrokersRequest.builder()
listBrokersRequest - A Consumer that will call methods on ListBrokersRequest.Builder to create a request.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.AwsServiceExceptiondefault ListBrokersIterable listBrokersPaginator() throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns a list of all brokers.
This is a variant of listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
for (software.amazon.awssdk.services.mq.model.ListBrokersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest) operation.
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.AwsServiceExceptionlistBrokersPaginator(ListBrokersRequest),
AWS API
Documentationdefault ListBrokersIterable listBrokersPaginator(ListBrokersRequest listBrokersRequest) throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns a list of all brokers.
This is a variant of listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
for (software.amazon.awssdk.services.mq.model.ListBrokersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest) operation.
listBrokersRequest - 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.AwsServiceExceptiondefault ListBrokersIterable listBrokersPaginator(Consumer<ListBrokersRequest.Builder> listBrokersRequest) throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns a list of all brokers.
This is a variant of listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
for (software.amazon.awssdk.services.mq.model.ListBrokersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.mq.paginators.ListBrokersIterable responses = client.listBrokersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest) operation.
This is a convenience which creates an instance of the ListBrokersRequest.Builder avoiding the need to
create one manually via ListBrokersRequest.builder()
listBrokersRequest - A Consumer that will call methods on ListBrokersRequest.Builder to create a request.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.AwsServiceExceptiondefault ListConfigurationRevisionsResponse listConfigurationRevisions(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns a list of all revisions for the specified configuration.
listConfigurationRevisionsRequest - 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.AwsServiceExceptiondefault ListConfigurationRevisionsResponse listConfigurationRevisions(Consumer<ListConfigurationRevisionsRequest.Builder> listConfigurationRevisionsRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns a list of all revisions for the specified configuration.
This is a convenience which creates an instance of the ListConfigurationRevisionsRequest.Builder avoiding
the need to create one manually via ListConfigurationRevisionsRequest.builder()
listConfigurationRevisionsRequest - A Consumer that will call methods on ListConfigurationRevisionsRequest.Builder to create a
request.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.AwsServiceExceptiondefault ListConfigurationsResponse listConfigurations() throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns a list of all configurations.
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.AwsServiceExceptionlistConfigurations(ListConfigurationsRequest),
AWS API
Documentationdefault ListConfigurationsResponse listConfigurations(ListConfigurationsRequest listConfigurationsRequest) throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns a list of all configurations.
listConfigurationsRequest - 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.AwsServiceExceptiondefault ListConfigurationsResponse listConfigurations(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest) throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns a list of all configurations.
This is a convenience which creates an instance of the ListConfigurationsRequest.Builder avoiding the
need to create one manually via ListConfigurationsRequest.builder()
listConfigurationsRequest - A Consumer that will call methods on ListConfigurationsRequest.Builder to create a
request.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.AwsServiceExceptiondefault ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Lists tags for a resource.
listTagsRequest - 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.AwsServiceExceptiondefault ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Lists tags for a resource.
This is a convenience which creates an instance of the ListTagsRequest.Builder avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request.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.AwsServiceExceptiondefault ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns a list of all ActiveMQ users.
listUsersRequest - 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.AwsServiceExceptiondefault ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Returns a list of all ActiveMQ users.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.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.AwsServiceExceptiondefault RebootBrokerResponse rebootBroker(RebootBrokerRequest rebootBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Reboots a broker. Note: This API is asynchronous.
rebootBrokerRequest - 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.AwsServiceExceptiondefault RebootBrokerResponse rebootBroker(Consumer<RebootBrokerRequest.Builder> rebootBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Reboots a broker. Note: This API is asynchronous.
This is a convenience which creates an instance of the RebootBrokerRequest.Builder avoiding the need to
create one manually via RebootBrokerRequest.builder()
rebootBrokerRequest - A Consumer that will call methods on RebootBrokerRequest.Builder to create a request.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.AwsServiceExceptiondefault UpdateBrokerResponse updateBroker(UpdateBrokerRequest updateBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Adds a pending configuration change to a broker.
updateBrokerRequest - Updates the broker using the specified properties.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.AwsServiceExceptiondefault UpdateBrokerResponse updateBroker(Consumer<UpdateBrokerRequest.Builder> updateBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Adds a pending configuration change to a broker.
This is a convenience which creates an instance of the UpdateBrokerRequest.Builder avoiding the need to
create one manually via UpdateBrokerRequest.builder()
updateBrokerRequest - A Consumer that will call methods on UpdateBrokerRequest.Builder to create a request.
Updates the broker using the specified properties.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.AwsServiceExceptiondefault UpdateConfigurationResponse updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Updates the specified configuration.
updateConfigurationRequest - Updates the specified configuration.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.AwsServiceExceptiondefault UpdateConfigurationResponse updateConfiguration(Consumer<UpdateConfigurationRequest.Builder> updateConfigurationRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Updates the specified configuration.
This is a convenience which creates an instance of the UpdateConfigurationRequest.Builder avoiding the
need to create one manually via UpdateConfigurationRequest.builder()
updateConfigurationRequest - A Consumer that will call methods on UpdateConfigurationRequest.Builder to create a
request. Updates the specified configuration.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.AwsServiceExceptiondefault UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Updates the information for an ActiveMQ user.
updateUserRequest - Updates the information for an ActiveMQ user.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.AwsServiceExceptiondefault UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
Updates the information for an ActiveMQ user.
This is a convenience which creates an instance of the UpdateUserRequest.Builder avoiding the need to
create one manually via UpdateUserRequest.builder()
updateUserRequest - A Consumer that will call methods on UpdateUserRequest.Builder to create a request.
Updates the information for an ActiveMQ user.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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2022. All rights reserved.