@Generated(value="software.amazon.awssdk:codegen") public interface MqClient extends SdkClient
builder()
method.
Amazon MQ is a managed message broker service for Apache ActiveMQ that makes it easy to set up and operate message
brokers in the cloud. A message broker allows software applications and components to communicate using various
programming languages, operating systems, and formal messaging protocols.Modifier and Type | Field and Description |
---|---|
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 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 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 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 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 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.
|
serviceName
close
static final String SERVICE_NAME
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
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.AwsServiceException
default CreateBrokerResponse createBroker(Consumer<CreateBrokerRequest.Builder> createBrokerRequest) throws BadRequestException, UnauthorizedException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default CreateConfigurationResponse createConfiguration(CreateConfigurationRequest createConfigurationRequest) throws BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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 configuration name already exists. Retry your request with another
configuration name.ForbiddenException
- HTTP Status Code 403: Access forbidden. Correct your input and then retry your request.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.AwsServiceException
default CreateConfigurationResponse createConfiguration(Consumer<CreateConfigurationRequest.Builder> createConfigurationRequest) throws BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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 configuration name already exists. Retry your request with another
configuration name.ForbiddenException
- HTTP Status Code 403: Access forbidden. Correct your input and then retry your request.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.AwsServiceException
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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. 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.AwsServiceException
default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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. 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.AwsServiceException
default DeleteBrokerResponse deleteBroker(DeleteBrokerRequest deleteBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default DeleteBrokerResponse deleteBroker(Consumer<DeleteBrokerRequest.Builder> deleteBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default DeleteUserResponse deleteUser(DeleteUserRequest deleteUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default DeleteUserResponse deleteUser(Consumer<DeleteUserRequest.Builder> deleteUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default DescribeBrokerResponse describeBroker(DescribeBrokerRequest describeBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default DescribeBrokerResponse describeBroker(Consumer<DescribeBrokerRequest.Builder> describeBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default DescribeConfigurationResponse describeConfiguration(DescribeConfigurationRequest describeConfigurationRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default DescribeConfigurationResponse describeConfiguration(Consumer<DescribeConfigurationRequest.Builder> describeConfigurationRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default DescribeConfigurationRevisionResponse describeConfigurationRevision(DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default DescribeConfigurationRevisionResponse describeConfigurationRevision(Consumer<DescribeConfigurationRevisionRequest.Builder> describeConfigurationRevisionRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default DescribeUserResponse describeUser(DescribeUserRequest describeUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default DescribeUserResponse describeUser(Consumer<DescribeUserRequest.Builder> describeUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default ListBrokersResponse listBrokers() throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
listBrokers(ListBrokersRequest)
,
AWS API
Documentationdefault ListBrokersResponse listBrokers(ListBrokersRequest listBrokersRequest) throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default ListBrokersResponse listBrokers(Consumer<ListBrokersRequest.Builder> listBrokersRequest) throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default ListConfigurationRevisionsResponse listConfigurationRevisions(ListConfigurationRevisionsRequest listConfigurationRevisionsRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default ListConfigurationRevisionsResponse listConfigurationRevisions(Consumer<ListConfigurationRevisionsRequest.Builder> listConfigurationRevisionsRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default ListConfigurationsResponse listConfigurations() throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
listConfigurations(ListConfigurationsRequest)
,
AWS API
Documentationdefault ListConfigurationsResponse listConfigurations(ListConfigurationsRequest listConfigurationsRequest) throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default ListConfigurationsResponse listConfigurations(Consumer<ListConfigurationsRequest.Builder> listConfigurationsRequest) throws BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default RebootBrokerResponse rebootBroker(RebootBrokerRequest rebootBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default RebootBrokerResponse rebootBroker(Consumer<RebootBrokerRequest.Builder> rebootBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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.AwsServiceException
default UpdateBrokerResponse updateBroker(UpdateBrokerRequest updateBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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. Concurrent broker update detected. Retrying your request might resolve
the issue.ForbiddenException
- HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.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.AwsServiceException
default UpdateBrokerResponse updateBroker(Consumer<UpdateBrokerRequest.Builder> updateBrokerRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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. Concurrent broker update detected. Retrying your request might resolve
the issue.ForbiddenException
- HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.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.AwsServiceException
default UpdateConfigurationResponse updateConfiguration(UpdateConfigurationRequest updateConfigurationRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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. Concurrent update to configuration. Retry to create a new revision.ForbiddenException
- HTTP Status Code 403: Access forbidden. Correct your input and then retry your request.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.AwsServiceException
default UpdateConfigurationResponse updateConfiguration(Consumer<UpdateConfigurationRequest.Builder> updateConfigurationRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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. Concurrent update to configuration. Retry to create a new revision.ForbiddenException
- HTTP Status Code 403: Access forbidden. Correct your input and then retry your request.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.AwsServiceException
default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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. 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.AwsServiceException
default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws NotFoundException, BadRequestException, InternalServerErrorException, ConflictException, ForbiddenException, AwsServiceException, SdkClientException, MqException
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. 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.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.