software.amazon.awssdk.services.mq.MqAsyncClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mq Show documentation
Show all versions of mq Show documentation
The AWS Java SDK for AmazonMQ module holds the client classes that are used for communicating
with AmazonMQ Service
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.mq;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.mq.model.CreateBrokerRequest;
import software.amazon.awssdk.services.mq.model.CreateBrokerResponse;
import software.amazon.awssdk.services.mq.model.CreateConfigurationRequest;
import software.amazon.awssdk.services.mq.model.CreateConfigurationResponse;
import software.amazon.awssdk.services.mq.model.CreateTagsRequest;
import software.amazon.awssdk.services.mq.model.CreateTagsResponse;
import software.amazon.awssdk.services.mq.model.CreateUserRequest;
import software.amazon.awssdk.services.mq.model.CreateUserResponse;
import software.amazon.awssdk.services.mq.model.DeleteBrokerRequest;
import software.amazon.awssdk.services.mq.model.DeleteBrokerResponse;
import software.amazon.awssdk.services.mq.model.DeleteTagsRequest;
import software.amazon.awssdk.services.mq.model.DeleteTagsResponse;
import software.amazon.awssdk.services.mq.model.DeleteUserRequest;
import software.amazon.awssdk.services.mq.model.DeleteUserResponse;
import software.amazon.awssdk.services.mq.model.DescribeBrokerEngineTypesRequest;
import software.amazon.awssdk.services.mq.model.DescribeBrokerEngineTypesResponse;
import software.amazon.awssdk.services.mq.model.DescribeBrokerInstanceOptionsRequest;
import software.amazon.awssdk.services.mq.model.DescribeBrokerInstanceOptionsResponse;
import software.amazon.awssdk.services.mq.model.DescribeBrokerRequest;
import software.amazon.awssdk.services.mq.model.DescribeBrokerResponse;
import software.amazon.awssdk.services.mq.model.DescribeConfigurationRequest;
import software.amazon.awssdk.services.mq.model.DescribeConfigurationResponse;
import software.amazon.awssdk.services.mq.model.DescribeConfigurationRevisionRequest;
import software.amazon.awssdk.services.mq.model.DescribeConfigurationRevisionResponse;
import software.amazon.awssdk.services.mq.model.DescribeUserRequest;
import software.amazon.awssdk.services.mq.model.DescribeUserResponse;
import software.amazon.awssdk.services.mq.model.ListBrokersRequest;
import software.amazon.awssdk.services.mq.model.ListBrokersResponse;
import software.amazon.awssdk.services.mq.model.ListConfigurationRevisionsRequest;
import software.amazon.awssdk.services.mq.model.ListConfigurationRevisionsResponse;
import software.amazon.awssdk.services.mq.model.ListConfigurationsRequest;
import software.amazon.awssdk.services.mq.model.ListConfigurationsResponse;
import software.amazon.awssdk.services.mq.model.ListTagsRequest;
import software.amazon.awssdk.services.mq.model.ListTagsResponse;
import software.amazon.awssdk.services.mq.model.ListUsersRequest;
import software.amazon.awssdk.services.mq.model.ListUsersResponse;
import software.amazon.awssdk.services.mq.model.PromoteRequest;
import software.amazon.awssdk.services.mq.model.PromoteResponse;
import software.amazon.awssdk.services.mq.model.RebootBrokerRequest;
import software.amazon.awssdk.services.mq.model.RebootBrokerResponse;
import software.amazon.awssdk.services.mq.model.UpdateBrokerRequest;
import software.amazon.awssdk.services.mq.model.UpdateBrokerResponse;
import software.amazon.awssdk.services.mq.model.UpdateConfigurationRequest;
import software.amazon.awssdk.services.mq.model.UpdateConfigurationResponse;
import software.amazon.awssdk.services.mq.model.UpdateUserRequest;
import software.amazon.awssdk.services.mq.model.UpdateUserResponse;
import software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher;
/**
* Service client for accessing AmazonMQ asynchronously. This can be created using the static {@link #builder()}
* method.The asynchronous client performs non-blocking I/O when configured with any {@code SdkAsyncHttpClient}
* supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
* some cases such as credentials retrieval and endpoint discovery as part of the async API call.
*
*
* 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.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface MqAsyncClient extends AwsClient {
String SERVICE_NAME = "mq";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "mq";
/**
*
* Creates a broker. Note: This API is asynchronous.
*
*
* To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2
* permissions in your IAM policy.
*
*
* -
*
* ec2:CreateNetworkInterface
*
*
* This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your
* account.
*
*
* -
*
* ec2:CreateNetworkInterfacePermission
*
*
* This permission is required to attach the ENI to the broker instance.
*
*
* -
*
* ec2:DeleteNetworkInterface
*
*
* -
*
* ec2:DeleteNetworkInterfacePermission
*
*
* -
*
* ec2:DetachNetworkInterface
*
*
* -
*
* ec2:DescribeInternetGateways
*
*
* -
*
* ec2:DescribeNetworkInterfaces
*
*
* -
*
* ec2:DescribeNetworkInterfacePermissions
*
*
* -
*
* ec2:DescribeRouteTables
*
*
* -
*
* ec2:DescribeSecurityGroups
*
*
* -
*
* ec2:DescribeSubnets
*
*
* -
*
* ec2:DescribeVpcs
*
*
*
*
* For more information, see Create an IAM User and Get Your Amazon Web Services Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.
*
*
* @param createBrokerRequest
* Creates a broker using the specified properties.
* @return A Java Future containing the result of the CreateBroker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.CreateBroker
* @see AWS API
* Documentation
*/
default CompletableFuture createBroker(CreateBrokerRequest createBrokerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a broker. Note: This API is asynchronous.
*
*
* To create a broker, you must either use the AmazonMQFullAccess IAM policy or include the following EC2
* permissions in your IAM policy.
*
*
* -
*
* ec2:CreateNetworkInterface
*
*
* This permission is required to allow Amazon MQ to create an elastic network interface (ENI) on behalf of your
* account.
*
*
* -
*
* ec2:CreateNetworkInterfacePermission
*
*
* This permission is required to attach the ENI to the broker instance.
*
*
* -
*
* ec2:DeleteNetworkInterface
*
*
* -
*
* ec2:DeleteNetworkInterfacePermission
*
*
* -
*
* ec2:DetachNetworkInterface
*
*
* -
*
* ec2:DescribeInternetGateways
*
*
* -
*
* ec2:DescribeNetworkInterfaces
*
*
* -
*
* ec2:DescribeNetworkInterfacePermissions
*
*
* -
*
* ec2:DescribeRouteTables
*
*
* -
*
* ec2:DescribeSecurityGroups
*
*
* -
*
* ec2:DescribeSubnets
*
*
* -
*
* ec2:DescribeVpcs
*
*
*
*
* For more information, see Create an IAM User and Get Your Amazon Web Services Credentials and Never Modify or Delete the Amazon MQ Elastic Network Interface in the Amazon MQ Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link CreateBrokerRequest.Builder} avoiding the need to
* create one manually via {@link CreateBrokerRequest#builder()}
*
*
* @param createBrokerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.CreateBrokerRequest.Builder} to create a request. Creates
* a broker using the specified properties.
* @return A Java Future containing the result of the CreateBroker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.CreateBroker
* @see AWS API
* Documentation
*/
default CompletableFuture createBroker(Consumer createBrokerRequest) {
return createBroker(CreateBrokerRequest.builder().applyMutation(createBrokerRequest).build());
}
/**
*
* Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the
* engine type and version).
*
*
* @param createConfigurationRequest
* Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration
* (the engine type and version).
* @return A Java Future containing the result of the CreateConfiguration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.CreateConfiguration
* @see AWS API
* Documentation
*/
default CompletableFuture createConfiguration(
CreateConfigurationRequest createConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateConfigurationRequest.Builder} avoiding the
* need to create one manually via {@link CreateConfigurationRequest#builder()}
*
*
* @param createConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.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).
* @return A Java Future containing the result of the CreateConfiguration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.CreateConfiguration
* @see AWS API
* Documentation
*/
default CompletableFuture createConfiguration(
Consumer createConfigurationRequest) {
return createConfiguration(CreateConfigurationRequest.builder().applyMutation(createConfigurationRequest).build());
}
/**
*
* Add a tag to a resource.
*
*
* @param createTagsRequest
* A map of the key-value pairs for the resource tag.
* @return A Java Future containing the result of the CreateTags operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.CreateTags
* @see AWS API
* Documentation
*/
default CompletableFuture createTags(CreateTagsRequest createTagsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Add a tag to a resource.
*
*
*
* This is a convenience which creates an instance of the {@link CreateTagsRequest.Builder} avoiding the need to
* create one manually via {@link CreateTagsRequest#builder()}
*
*
* @param createTagsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.CreateTagsRequest.Builder} to create a request. A map of
* the key-value pairs for the resource tag.
* @return A Java Future containing the result of the CreateTags operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.CreateTags
* @see AWS API
* Documentation
*/
default CompletableFuture createTags(Consumer createTagsRequest) {
return createTags(CreateTagsRequest.builder().applyMutation(createTagsRequest).build());
}
/**
*
* Creates an ActiveMQ user.
*
*
*
* Do not add personally identifiable information (PII) or other confidential or sensitive information in broker
* usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs.
* Broker usernames are not intended to be used for private or sensitive data.
*
*
*
* @param createUserRequest
* Creates a new ActiveMQ user.
* @return A Java Future containing the result of the CreateUser operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.CreateUser
* @see AWS API
* Documentation
*/
default CompletableFuture createUser(CreateUserRequest createUserRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates an ActiveMQ user.
*
*
*
* Do not add personally identifiable information (PII) or other confidential or sensitive information in broker
* usernames. Broker usernames are accessible to other Amazon Web Services services, including CloudWatch Logs.
* Broker usernames are not intended to be used for private or sensitive data.
*
*
*
* This is a convenience which creates an instance of the {@link CreateUserRequest.Builder} avoiding the need to
* create one manually via {@link CreateUserRequest#builder()}
*
*
* @param createUserRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.CreateUserRequest.Builder} to create a request. Creates a
* new ActiveMQ user.
* @return A Java Future containing the result of the CreateUser operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.CreateUser
* @see AWS API
* Documentation
*/
default CompletableFuture createUser(Consumer createUserRequest) {
return createUser(CreateUserRequest.builder().applyMutation(createUserRequest).build());
}
/**
*
* Deletes a broker. Note: This API is asynchronous.
*
*
* @param deleteBrokerRequest
* @return A Java Future containing the result of the DeleteBroker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DeleteBroker
* @see AWS API
* Documentation
*/
default CompletableFuture deleteBroker(DeleteBrokerRequest deleteBrokerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a broker. Note: This API is asynchronous.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBrokerRequest.Builder} avoiding the need to
* create one manually via {@link DeleteBrokerRequest#builder()}
*
*
* @param deleteBrokerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.DeleteBrokerRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteBroker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DeleteBroker
* @see AWS API
* Documentation
*/
default CompletableFuture deleteBroker(Consumer deleteBrokerRequest) {
return deleteBroker(DeleteBrokerRequest.builder().applyMutation(deleteBrokerRequest).build());
}
/**
*
* Removes a tag from a resource.
*
*
* @param deleteTagsRequest
* @return A Java Future containing the result of the DeleteTags operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DeleteTags
* @see AWS API
* Documentation
*/
default CompletableFuture deleteTags(DeleteTagsRequest deleteTagsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Removes a tag from a resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteTagsRequest.Builder} avoiding the need to
* create one manually via {@link DeleteTagsRequest#builder()}
*
*
* @param deleteTagsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.DeleteTagsRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteTags operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DeleteTags
* @see AWS API
* Documentation
*/
default CompletableFuture deleteTags(Consumer deleteTagsRequest) {
return deleteTags(DeleteTagsRequest.builder().applyMutation(deleteTagsRequest).build());
}
/**
*
* Deletes an ActiveMQ user.
*
*
* @param deleteUserRequest
* @return A Java Future containing the result of the DeleteUser operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DeleteUser
* @see AWS API
* Documentation
*/
default CompletableFuture deleteUser(DeleteUserRequest deleteUserRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an ActiveMQ user.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteUserRequest.Builder} avoiding the need to
* create one manually via {@link DeleteUserRequest#builder()}
*
*
* @param deleteUserRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.DeleteUserRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteUser operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DeleteUser
* @see AWS API
* Documentation
*/
default CompletableFuture deleteUser(Consumer deleteUserRequest) {
return deleteUser(DeleteUserRequest.builder().applyMutation(deleteUserRequest).build());
}
/**
*
* Returns information about the specified broker.
*
*
* @param describeBrokerRequest
* @return A Java Future containing the result of the DescribeBroker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DescribeBroker
* @see AWS API
* Documentation
*/
default CompletableFuture describeBroker(DescribeBrokerRequest describeBrokerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about the specified broker.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeBrokerRequest.Builder} avoiding the need to
* create one manually via {@link DescribeBrokerRequest#builder()}
*
*
* @param describeBrokerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.DescribeBrokerRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeBroker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DescribeBroker
* @see AWS API
* Documentation
*/
default CompletableFuture describeBroker(Consumer describeBrokerRequest) {
return describeBroker(DescribeBrokerRequest.builder().applyMutation(describeBrokerRequest).build());
}
/**
*
* Describe available engine types and versions.
*
*
* @param describeBrokerEngineTypesRequest
* @return A Java Future containing the result of the DescribeBrokerEngineTypes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DescribeBrokerEngineTypes
* @see AWS
* API Documentation
*/
default CompletableFuture describeBrokerEngineTypes(
DescribeBrokerEngineTypesRequest describeBrokerEngineTypesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describe available engine types and versions.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeBrokerEngineTypesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeBrokerEngineTypesRequest#builder()}
*
*
* @param describeBrokerEngineTypesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.DescribeBrokerEngineTypesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeBrokerEngineTypes operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DescribeBrokerEngineTypes
* @see AWS
* API Documentation
*/
default CompletableFuture describeBrokerEngineTypes(
Consumer describeBrokerEngineTypesRequest) {
return describeBrokerEngineTypes(DescribeBrokerEngineTypesRequest.builder()
.applyMutation(describeBrokerEngineTypesRequest).build());
}
/**
*
* Describe available broker instance options.
*
*
* @param describeBrokerInstanceOptionsRequest
* @return A Java Future containing the result of the DescribeBrokerInstanceOptions operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DescribeBrokerInstanceOptions
* @see AWS API Documentation
*/
default CompletableFuture describeBrokerInstanceOptions(
DescribeBrokerInstanceOptionsRequest describeBrokerInstanceOptionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Describe available broker instance options.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeBrokerInstanceOptionsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeBrokerInstanceOptionsRequest#builder()}
*
*
* @param describeBrokerInstanceOptionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.DescribeBrokerInstanceOptionsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeBrokerInstanceOptions operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DescribeBrokerInstanceOptions
* @see AWS API Documentation
*/
default CompletableFuture describeBrokerInstanceOptions(
Consumer describeBrokerInstanceOptionsRequest) {
return describeBrokerInstanceOptions(DescribeBrokerInstanceOptionsRequest.builder()
.applyMutation(describeBrokerInstanceOptionsRequest).build());
}
/**
*
* Returns information about the specified configuration.
*
*
* @param describeConfigurationRequest
* @return A Java Future containing the result of the DescribeConfiguration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DescribeConfiguration
* @see AWS API
* Documentation
*/
default CompletableFuture describeConfiguration(
DescribeConfigurationRequest describeConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about the specified configuration.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeConfigurationRequest.Builder} avoiding the
* need to create one manually via {@link DescribeConfigurationRequest#builder()}
*
*
* @param describeConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.DescribeConfigurationRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeConfiguration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DescribeConfiguration
* @see AWS API
* Documentation
*/
default CompletableFuture describeConfiguration(
Consumer describeConfigurationRequest) {
return describeConfiguration(DescribeConfigurationRequest.builder().applyMutation(describeConfigurationRequest).build());
}
/**
*
* Returns the specified configuration revision for the specified configuration.
*
*
* @param describeConfigurationRevisionRequest
* @return A Java Future containing the result of the DescribeConfigurationRevision operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DescribeConfigurationRevision
* @see AWS API Documentation
*/
default CompletableFuture describeConfigurationRevision(
DescribeConfigurationRevisionRequest describeConfigurationRevisionRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the specified configuration revision for the specified configuration.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeConfigurationRevisionRequest.Builder}
* avoiding the need to create one manually via {@link DescribeConfigurationRevisionRequest#builder()}
*
*
* @param describeConfigurationRevisionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.DescribeConfigurationRevisionRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeConfigurationRevision operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DescribeConfigurationRevision
* @see AWS API Documentation
*/
default CompletableFuture describeConfigurationRevision(
Consumer describeConfigurationRevisionRequest) {
return describeConfigurationRevision(DescribeConfigurationRevisionRequest.builder()
.applyMutation(describeConfigurationRevisionRequest).build());
}
/**
*
* Returns information about an ActiveMQ user.
*
*
* @param describeUserRequest
* @return A Java Future containing the result of the DescribeUser operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DescribeUser
* @see AWS API
* Documentation
*/
default CompletableFuture describeUser(DescribeUserRequest describeUserRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about an ActiveMQ user.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeUserRequest.Builder} avoiding the need to
* create one manually via {@link DescribeUserRequest#builder()}
*
*
* @param describeUserRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.DescribeUserRequest.Builder} to create a request.
* @return A Java Future containing the result of the DescribeUser operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.DescribeUser
* @see AWS API
* Documentation
*/
default CompletableFuture describeUser(Consumer describeUserRequest) {
return describeUser(DescribeUserRequest.builder().applyMutation(describeUserRequest).build());
}
/**
*
* Returns a list of all brokers.
*
*
* @param listBrokersRequest
* @return A Java Future containing the result of the ListBrokers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.ListBrokers
* @see AWS API
* Documentation
*/
default CompletableFuture listBrokers(ListBrokersRequest listBrokersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of all brokers.
*
*
*
* This is a convenience which creates an instance of the {@link ListBrokersRequest.Builder} avoiding the need to
* create one manually via {@link ListBrokersRequest#builder()}
*
*
* @param listBrokersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.ListBrokersRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListBrokers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.ListBrokers
* @see AWS API
* Documentation
*/
default CompletableFuture listBrokers(Consumer listBrokersRequest) {
return listBrokers(ListBrokersRequest.builder().applyMutation(listBrokersRequest).build());
}
/**
*
* Returns a list of all brokers.
*
*
* @return A Java Future containing the result of the ListBrokers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.ListBrokers
* @see AWS API
* Documentation
*/
default CompletableFuture listBrokers() {
return listBrokers(ListBrokersRequest.builder().build());
}
/**
*
* This is a variant of {@link #listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mq.model.ListBrokersResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.ListBrokers
* @see AWS API
* Documentation
*/
default ListBrokersPublisher listBrokersPaginator() {
return listBrokersPaginator(ListBrokersRequest.builder().build());
}
/**
*
* This is a variant of {@link #listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mq.model.ListBrokersResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest)} operation.
*
*
* @param listBrokersRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.ListBrokers
* @see AWS API
* Documentation
*/
default ListBrokersPublisher listBrokersPaginator(ListBrokersRequest listBrokersRequest) {
return new ListBrokersPublisher(this, listBrokersRequest);
}
/**
*
* This is a variant of {@link #listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.mq.paginators.ListBrokersPublisher publisher = client.listBrokersPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.mq.model.ListBrokersResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxResults won't limit the number of results you get with the
* paginator. It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listBrokers(software.amazon.awssdk.services.mq.model.ListBrokersRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListBrokersRequest.Builder} avoiding the need to
* create one manually via {@link ListBrokersRequest#builder()}
*
*
* @param listBrokersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.ListBrokersRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.ListBrokers
* @see AWS API
* Documentation
*/
default ListBrokersPublisher listBrokersPaginator(Consumer listBrokersRequest) {
return listBrokersPaginator(ListBrokersRequest.builder().applyMutation(listBrokersRequest).build());
}
/**
*
* Returns a list of all revisions for the specified configuration.
*
*
* @param listConfigurationRevisionsRequest
* @return A Java Future containing the result of the ListConfigurationRevisions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.ListConfigurationRevisions
* @see AWS
* API Documentation
*/
default CompletableFuture listConfigurationRevisions(
ListConfigurationRevisionsRequest listConfigurationRevisionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of all revisions for the specified configuration.
*
*
*
* This is a convenience which creates an instance of the {@link ListConfigurationRevisionsRequest.Builder} avoiding
* the need to create one manually via {@link ListConfigurationRevisionsRequest#builder()}
*
*
* @param listConfigurationRevisionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.ListConfigurationRevisionsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListConfigurationRevisions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.ListConfigurationRevisions
* @see AWS
* API Documentation
*/
default CompletableFuture listConfigurationRevisions(
Consumer listConfigurationRevisionsRequest) {
return listConfigurationRevisions(ListConfigurationRevisionsRequest.builder()
.applyMutation(listConfigurationRevisionsRequest).build());
}
/**
*
* Returns a list of all configurations.
*
*
* @param listConfigurationsRequest
* @return A Java Future containing the result of the ListConfigurations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.ListConfigurations
* @see AWS API
* Documentation
*/
default CompletableFuture listConfigurations(ListConfigurationsRequest listConfigurationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of all configurations.
*
*
*
* This is a convenience which creates an instance of the {@link ListConfigurationsRequest.Builder} avoiding the
* need to create one manually via {@link ListConfigurationsRequest#builder()}
*
*
* @param listConfigurationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.ListConfigurationsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListConfigurations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.ListConfigurations
* @see AWS API
* Documentation
*/
default CompletableFuture listConfigurations(
Consumer listConfigurationsRequest) {
return listConfigurations(ListConfigurationsRequest.builder().applyMutation(listConfigurationsRequest).build());
}
/**
*
* Returns a list of all configurations.
*
*
* @return A Java Future containing the result of the ListConfigurations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.ListConfigurations
* @see AWS API
* Documentation
*/
default CompletableFuture listConfigurations() {
return listConfigurations(ListConfigurationsRequest.builder().build());
}
/**
*
* Lists tags for a resource.
*
*
* @param listTagsRequest
* @return A Java Future containing the result of the ListTags operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.ListTags
* @see AWS API
* Documentation
*/
default CompletableFuture listTags(ListTagsRequest listTagsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists tags for a resource.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsRequest.Builder} avoiding the need to
* create one manually via {@link ListTagsRequest#builder()}
*
*
* @param listTagsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.ListTagsRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListTags operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.ListTags
* @see AWS API
* Documentation
*/
default CompletableFuture listTags(Consumer listTagsRequest) {
return listTags(ListTagsRequest.builder().applyMutation(listTagsRequest).build());
}
/**
*
* Returns a list of all ActiveMQ users.
*
*
* @param listUsersRequest
* @return A Java Future containing the result of the ListUsers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.ListUsers
* @see AWS API
* Documentation
*/
default CompletableFuture listUsers(ListUsersRequest listUsersRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of all ActiveMQ users.
*
*
*
* This is a convenience which creates an instance of the {@link ListUsersRequest.Builder} avoiding the need to
* create one manually via {@link ListUsersRequest#builder()}
*
*
* @param listUsersRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.ListUsersRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListUsers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.ListUsers
* @see AWS API
* Documentation
*/
default CompletableFuture listUsers(Consumer listUsersRequest) {
return listUsers(ListUsersRequest.builder().applyMutation(listUsersRequest).build());
}
/**
*
* Promotes a data replication replica broker to the primary broker role.
*
*
* @param promoteRequest
* Promotes a data replication replica broker to the primary broker role.
* @return A Java Future containing the result of the Promote operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.Promote
* @see AWS API
* Documentation
*/
default CompletableFuture promote(PromoteRequest promoteRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Promotes a data replication replica broker to the primary broker role.
*
*
*
* This is a convenience which creates an instance of the {@link PromoteRequest.Builder} avoiding the need to create
* one manually via {@link PromoteRequest#builder()}
*
*
* @param promoteRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.PromoteRequest.Builder} to create a request. Promotes a
* data replication replica broker to the primary broker role.
* @return A Java Future containing the result of the Promote operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.Promote
* @see AWS API
* Documentation
*/
default CompletableFuture promote(Consumer promoteRequest) {
return promote(PromoteRequest.builder().applyMutation(promoteRequest).build());
}
/**
*
* Reboots a broker. Note: This API is asynchronous.
*
*
* @param rebootBrokerRequest
* @return A Java Future containing the result of the RebootBroker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.RebootBroker
* @see AWS API
* Documentation
*/
default CompletableFuture rebootBroker(RebootBrokerRequest rebootBrokerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Reboots a broker. Note: This API is asynchronous.
*
*
*
* This is a convenience which creates an instance of the {@link RebootBrokerRequest.Builder} avoiding the need to
* create one manually via {@link RebootBrokerRequest#builder()}
*
*
* @param rebootBrokerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.RebootBrokerRequest.Builder} to create a request.
* @return A Java Future containing the result of the RebootBroker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.RebootBroker
* @see AWS API
* Documentation
*/
default CompletableFuture rebootBroker(Consumer rebootBrokerRequest) {
return rebootBroker(RebootBrokerRequest.builder().applyMutation(rebootBrokerRequest).build());
}
/**
*
* Adds a pending configuration change to a broker.
*
*
* @param updateBrokerRequest
* Updates the broker using the specified properties.
* @return A Java Future containing the result of the UpdateBroker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.UpdateBroker
* @see AWS API
* Documentation
*/
default CompletableFuture updateBroker(UpdateBrokerRequest updateBrokerRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Adds a pending configuration change to a broker.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateBrokerRequest.Builder} avoiding the need to
* create one manually via {@link UpdateBrokerRequest#builder()}
*
*
* @param updateBrokerRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.UpdateBrokerRequest.Builder} to create a request. Updates
* the broker using the specified properties.
* @return A Java Future containing the result of the UpdateBroker operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.UpdateBroker
* @see AWS API
* Documentation
*/
default CompletableFuture updateBroker(Consumer updateBrokerRequest) {
return updateBroker(UpdateBrokerRequest.builder().applyMutation(updateBrokerRequest).build());
}
/**
*
* Updates the specified configuration.
*
*
* @param updateConfigurationRequest
* Updates the specified configuration.
* @return A Java Future containing the result of the UpdateConfiguration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.UpdateConfiguration
* @see AWS API
* Documentation
*/
default CompletableFuture updateConfiguration(
UpdateConfigurationRequest updateConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the specified configuration.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateConfigurationRequest.Builder} avoiding the
* need to create one manually via {@link UpdateConfigurationRequest#builder()}
*
*
* @param updateConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.UpdateConfigurationRequest.Builder} to create a request.
* Updates the specified configuration.
* @return A Java Future containing the result of the UpdateConfiguration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.UpdateConfiguration
* @see AWS API
* Documentation
*/
default CompletableFuture updateConfiguration(
Consumer updateConfigurationRequest) {
return updateConfiguration(UpdateConfigurationRequest.builder().applyMutation(updateConfigurationRequest).build());
}
/**
*
* Updates the information for an ActiveMQ user.
*
*
* @param updateUserRequest
* Updates the information for an ActiveMQ user.
* @return A Java Future containing the result of the UpdateUser operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.UpdateUser
* @see AWS API
* Documentation
*/
default CompletableFuture updateUser(UpdateUserRequest updateUserRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the information for an ActiveMQ user.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateUserRequest.Builder} avoiding the need to
* create one manually via {@link UpdateUserRequest#builder()}
*
*
* @param updateUserRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.mq.model.UpdateUserRequest.Builder} to create a request. Updates
* the information for an ActiveMQ user.
* @return A Java Future containing the result of the UpdateUser operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - 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.
*
* @sample MqAsyncClient.UpdateUser
* @see AWS API
* Documentation
*/
default CompletableFuture updateUser(Consumer updateUserRequest) {
return updateUser(UpdateUserRequest.builder().applyMutation(updateUserRequest).build());
}
@Override
default MqServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
/**
* Create a {@link MqAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static MqAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link MqAsyncClient}.
*/
static MqAsyncClientBuilder builder() {
return new DefaultMqAsyncClientBuilder();
}
}