software.amazon.awssdk.services.sqs.SqsClient Maven / Gradle / Ivy
/*
* Copyright 2014-2019 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.sqs;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.sqs.model.AddPermissionRequest;
import software.amazon.awssdk.services.sqs.model.AddPermissionResponse;
import software.amazon.awssdk.services.sqs.model.BatchEntryIdsNotDistinctException;
import software.amazon.awssdk.services.sqs.model.BatchRequestTooLongException;
import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchRequest;
import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityBatchResponse;
import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityRequest;
import software.amazon.awssdk.services.sqs.model.ChangeMessageVisibilityResponse;
import software.amazon.awssdk.services.sqs.model.CreateQueueRequest;
import software.amazon.awssdk.services.sqs.model.CreateQueueResponse;
import software.amazon.awssdk.services.sqs.model.DeleteMessageBatchRequest;
import software.amazon.awssdk.services.sqs.model.DeleteMessageBatchResponse;
import software.amazon.awssdk.services.sqs.model.DeleteMessageRequest;
import software.amazon.awssdk.services.sqs.model.DeleteMessageResponse;
import software.amazon.awssdk.services.sqs.model.DeleteQueueRequest;
import software.amazon.awssdk.services.sqs.model.DeleteQueueResponse;
import software.amazon.awssdk.services.sqs.model.EmptyBatchRequestException;
import software.amazon.awssdk.services.sqs.model.GetQueueAttributesRequest;
import software.amazon.awssdk.services.sqs.model.GetQueueAttributesResponse;
import software.amazon.awssdk.services.sqs.model.GetQueueUrlRequest;
import software.amazon.awssdk.services.sqs.model.GetQueueUrlResponse;
import software.amazon.awssdk.services.sqs.model.InvalidAttributeNameException;
import software.amazon.awssdk.services.sqs.model.InvalidBatchEntryIdException;
import software.amazon.awssdk.services.sqs.model.InvalidIdFormatException;
import software.amazon.awssdk.services.sqs.model.InvalidMessageContentsException;
import software.amazon.awssdk.services.sqs.model.ListDeadLetterSourceQueuesRequest;
import software.amazon.awssdk.services.sqs.model.ListDeadLetterSourceQueuesResponse;
import software.amazon.awssdk.services.sqs.model.ListQueueTagsRequest;
import software.amazon.awssdk.services.sqs.model.ListQueueTagsResponse;
import software.amazon.awssdk.services.sqs.model.ListQueuesRequest;
import software.amazon.awssdk.services.sqs.model.ListQueuesResponse;
import software.amazon.awssdk.services.sqs.model.MessageNotInflightException;
import software.amazon.awssdk.services.sqs.model.OverLimitException;
import software.amazon.awssdk.services.sqs.model.PurgeQueueInProgressException;
import software.amazon.awssdk.services.sqs.model.PurgeQueueRequest;
import software.amazon.awssdk.services.sqs.model.PurgeQueueResponse;
import software.amazon.awssdk.services.sqs.model.QueueDeletedRecentlyException;
import software.amazon.awssdk.services.sqs.model.QueueDoesNotExistException;
import software.amazon.awssdk.services.sqs.model.QueueNameExistsException;
import software.amazon.awssdk.services.sqs.model.ReceiptHandleIsInvalidException;
import software.amazon.awssdk.services.sqs.model.ReceiveMessageRequest;
import software.amazon.awssdk.services.sqs.model.ReceiveMessageResponse;
import software.amazon.awssdk.services.sqs.model.RemovePermissionRequest;
import software.amazon.awssdk.services.sqs.model.RemovePermissionResponse;
import software.amazon.awssdk.services.sqs.model.SendMessageBatchRequest;
import software.amazon.awssdk.services.sqs.model.SendMessageBatchResponse;
import software.amazon.awssdk.services.sqs.model.SendMessageRequest;
import software.amazon.awssdk.services.sqs.model.SendMessageResponse;
import software.amazon.awssdk.services.sqs.model.SetQueueAttributesRequest;
import software.amazon.awssdk.services.sqs.model.SetQueueAttributesResponse;
import software.amazon.awssdk.services.sqs.model.SqsException;
import software.amazon.awssdk.services.sqs.model.TagQueueRequest;
import software.amazon.awssdk.services.sqs.model.TagQueueResponse;
import software.amazon.awssdk.services.sqs.model.TooManyEntriesInBatchRequestException;
import software.amazon.awssdk.services.sqs.model.UntagQueueRequest;
import software.amazon.awssdk.services.sqs.model.UntagQueueResponse;
/**
* Service client for accessing Amazon SQS. This can be created using the static {@link #builder()} method.
*
*
* Welcome to the Amazon Simple Queue Service API Reference.
*
*
* Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue for storing messages as they
* travel between applications or microservices. Amazon SQS moves data between distributed application components and
* helps you decouple these components.
*
*
* You can use AWS SDKs to access Amazon SQS using your favorite
* programming language. The SDKs perform tasks such as the following automatically:
*
*
* -
*
* Cryptographically sign your service requests
*
*
* -
*
* Retry requests
*
*
* -
*
* Handle error responses
*
*
*
*
* Additional Information
*
*
* -
*
*
* -
*
* Amazon Simple Queue Service Developer Guide
*
*
* -
*
*
* -
*
*
* -
*
*
*
*
* -
*
*
* -
*
* Amazon Web Services General Reference
*
*
* -
*
*
*
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public interface SqsClient extends SdkClient {
String SERVICE_NAME = "sqs";
/**
* Create a {@link SqsClient} 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 SqsClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link SqsClient}.
*/
static SqsClientBuilder builder() {
return new DefaultSqsClientBuilder();
}
/**
*
* Adds a permission to a queue for a specific principal. This allows sharing access
* to the queue.
*
*
* When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can
* grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* -
*
* AddPermission generates a policy for you. You can use SetQueueAttributes to
* upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon Simple Queue Service
* Developer Guide.
*
*
* -
*
* An Amazon SQS policy can have a maximum of 7 actions.
*
*
* -
*
* To remove the ability to change queue permissions, you must deny permission to the AddPermission,
* RemovePermission, and SetQueueAttributes actions in your IAM policy.
*
*
*
*
*
* Some actions take lists of parameters. These lists are specified using the param.n notation. Values
* of n are integers starting from 1. For example, a parameter list with two elements looks like this:
*
*
* &Attribute.1=first
*
*
* &Attribute.2=second
*
*
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* @param addPermissionRequest
* @return Result of the AddPermission operation returned by the service.
* @throws OverLimitException
* The specified action violates a limit. For example, ReceiveMessage returns this error if the
* maximum number of inflight messages is reached and AddPermission returns this error if the
* maximum number of permissions for the queue is reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.AddPermission
* @see AWS API
* Documentation
*/
default AddPermissionResponse addPermission(AddPermissionRequest addPermissionRequest) throws OverLimitException,
AwsServiceException, SdkClientException, SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Adds a permission to a queue for a specific principal. This allows sharing access
* to the queue.
*
*
* When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can
* grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* -
*
* AddPermission generates a policy for you. You can use SetQueueAttributes to
* upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon Simple Queue Service
* Developer Guide.
*
*
* -
*
* An Amazon SQS policy can have a maximum of 7 actions.
*
*
* -
*
* To remove the ability to change queue permissions, you must deny permission to the AddPermission,
* RemovePermission, and SetQueueAttributes actions in your IAM policy.
*
*
*
*
*
* Some actions take lists of parameters. These lists are specified using the param.n notation. Values
* of n are integers starting from 1. For example, a parameter list with two elements looks like this:
*
*
* &Attribute.1=first
*
*
* &Attribute.2=second
*
*
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* This is a convenience which creates an instance of the {@link AddPermissionRequest.Builder} avoiding the need to
* create one manually via {@link AddPermissionRequest#builder()}
*
*
* @param addPermissionRequest
* A {@link Consumer} that will call methods on {@link AddPermissionRequest.Builder} to create a request.
* @return Result of the AddPermission operation returned by the service.
* @throws OverLimitException
* The specified action violates a limit. For example, ReceiveMessage returns this error if the
* maximum number of inflight messages is reached and AddPermission returns this error if the
* maximum number of permissions for the queue is reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.AddPermission
* @see AWS API
* Documentation
*/
default AddPermissionResponse addPermission(Consumer addPermissionRequest)
throws OverLimitException, AwsServiceException, SdkClientException, SqsException {
return addPermission(AddPermissionRequest.builder().applyMutation(addPermissionRequest).build());
}
/**
*
* Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout
* for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see
* Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
*
*
* For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call
* ChangeMessageVisibility with a timeout of 10 minutes. You can continue to call
* ChangeMessageVisibility to extend the visibility timeout to the maximum allowed time. If you try to
* extend the visibility timeout beyond the maximum, your request is rejected.
*
*
* An Amazon SQS message has three basic states:
*
*
* -
*
* Sent to a queue by a producer.
*
*
* -
*
* Received from the queue by a consumer.
*
*
* -
*
* Deleted from the queue.
*
*
*
*
* A message is considered to be stored after it is sent to a queue by a producer, but not yet received from
* the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A
* message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted
* from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.
*
*
* Limits that apply to inflight messages are unrelated to the unlimited number of stored messages.
*
*
* For most standard queues (depending on queue traffic and message backlog), there can be a maximum of
* approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the
* queue). If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching
* the limit, you should delete messages from the queue after they're processed. You can also increase the number of
* queues you use to process your messages. To request a limit increase, file a support request.
*
*
* For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not
* yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
*
*
*
* If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon
* SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum
* remaining time.
*
*
* Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied
* immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the
* visibility timeout for the message reverts to the original timeout value (not to the value you set using the
* ChangeMessageVisibility action) the next time the message is received.
*
*
*
* @param changeMessageVisibilityRequest
* @return Result of the ChangeMessageVisibility operation returned by the service.
* @throws MessageNotInflightException
* The specified message isn't in flight.
* @throws ReceiptHandleIsInvalidException
* The specified receipt handle isn't valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.ChangeMessageVisibility
* @see AWS
* API Documentation
*/
default ChangeMessageVisibilityResponse changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest)
throws MessageNotInflightException, ReceiptHandleIsInvalidException, AwsServiceException, SdkClientException,
SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout
* for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see
* Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
*
*
* For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call
* ChangeMessageVisibility with a timeout of 10 minutes. You can continue to call
* ChangeMessageVisibility to extend the visibility timeout to the maximum allowed time. If you try to
* extend the visibility timeout beyond the maximum, your request is rejected.
*
*
* An Amazon SQS message has three basic states:
*
*
* -
*
* Sent to a queue by a producer.
*
*
* -
*
* Received from the queue by a consumer.
*
*
* -
*
* Deleted from the queue.
*
*
*
*
* A message is considered to be stored after it is sent to a queue by a producer, but not yet received from
* the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A
* message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted
* from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.
*
*
* Limits that apply to inflight messages are unrelated to the unlimited number of stored messages.
*
*
* For most standard queues (depending on queue traffic and message backlog), there can be a maximum of
* approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the
* queue). If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching
* the limit, you should delete messages from the queue after they're processed. You can also increase the number of
* queues you use to process your messages. To request a limit increase, file a support request.
*
*
* For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not
* yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
*
*
*
* If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon
* SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum
* remaining time.
*
*
* Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied
* immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the
* visibility timeout for the message reverts to the original timeout value (not to the value you set using the
* ChangeMessageVisibility action) the next time the message is received.
*
*
*
* This is a convenience which creates an instance of the {@link ChangeMessageVisibilityRequest.Builder} avoiding
* the need to create one manually via {@link ChangeMessageVisibilityRequest#builder()}
*
*
* @param changeMessageVisibilityRequest
* A {@link Consumer} that will call methods on {@link ChangeMessageVisibilityRequest.Builder} to create a
* request.
* @return Result of the ChangeMessageVisibility operation returned by the service.
* @throws MessageNotInflightException
* The specified message isn't in flight.
* @throws ReceiptHandleIsInvalidException
* The specified receipt handle isn't valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.ChangeMessageVisibility
* @see AWS
* API Documentation
*/
default ChangeMessageVisibilityResponse changeMessageVisibility(
Consumer changeMessageVisibilityRequest) throws MessageNotInflightException,
ReceiptHandleIsInvalidException, AwsServiceException, SdkClientException, SqsException {
return changeMessageVisibility(ChangeMessageVisibilityRequest.builder().applyMutation(changeMessageVisibilityRequest)
.build());
}
/**
*
* Changes the visibility timeout of multiple messages. This is a batch version of
* ChangeMessageVisibility. The result of the action on each message is reported individually
* in the response. You can send up to 10 ChangeMessageVisibility requests with each
* ChangeMessageVisibilityBatch action.
*
*
*
* Because the batch request can result in a combination of successful and unsuccessful actions, you should check
* for batch errors even when the call returns an HTTP status code of 200.
*
*
*
* Some actions take lists of parameters. These lists are specified using the param.n notation. Values
* of n are integers starting from 1. For example, a parameter list with two elements looks like this:
*
*
* &Attribute.1=first
*
*
* &Attribute.2=second
*
*
* @param changeMessageVisibilityBatchRequest
* @return Result of the ChangeMessageVisibilityBatch operation returned by the service.
* @throws TooManyEntriesInBatchRequestException
* The batch request contains more entries than permissible.
* @throws EmptyBatchRequestException
* The batch request doesn't contain any entries.
* @throws BatchEntryIdsNotDistinctException
* Two or more batch entries in the request have the same Id.
* @throws InvalidBatchEntryIdException
* The Id of a batch entry in a batch request doesn't abide by the specification.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.ChangeMessageVisibilityBatch
* @see AWS API Documentation
*/
default ChangeMessageVisibilityBatchResponse changeMessageVisibilityBatch(
ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest)
throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException,
InvalidBatchEntryIdException, AwsServiceException, SdkClientException, SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Changes the visibility timeout of multiple messages. This is a batch version of
* ChangeMessageVisibility. The result of the action on each message is reported individually
* in the response. You can send up to 10 ChangeMessageVisibility requests with each
* ChangeMessageVisibilityBatch action.
*
*
*
* Because the batch request can result in a combination of successful and unsuccessful actions, you should check
* for batch errors even when the call returns an HTTP status code of 200.
*
*
*
* Some actions take lists of parameters. These lists are specified using the param.n notation. Values
* of n are integers starting from 1. For example, a parameter list with two elements looks like this:
*
*
* &Attribute.1=first
*
*
* &Attribute.2=second
*
*
*
* This is a convenience which creates an instance of the {@link ChangeMessageVisibilityBatchRequest.Builder}
* avoiding the need to create one manually via {@link ChangeMessageVisibilityBatchRequest#builder()}
*
*
* @param changeMessageVisibilityBatchRequest
* A {@link Consumer} that will call methods on {@link ChangeMessageVisibilityBatchRequest.Builder} to create
* a request.
* @return Result of the ChangeMessageVisibilityBatch operation returned by the service.
* @throws TooManyEntriesInBatchRequestException
* The batch request contains more entries than permissible.
* @throws EmptyBatchRequestException
* The batch request doesn't contain any entries.
* @throws BatchEntryIdsNotDistinctException
* Two or more batch entries in the request have the same Id.
* @throws InvalidBatchEntryIdException
* The Id of a batch entry in a batch request doesn't abide by the specification.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.ChangeMessageVisibilityBatch
* @see AWS API Documentation
*/
default ChangeMessageVisibilityBatchResponse changeMessageVisibilityBatch(
Consumer changeMessageVisibilityBatchRequest)
throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException,
InvalidBatchEntryIdException, AwsServiceException, SdkClientException, SqsException {
return changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest.builder()
.applyMutation(changeMessageVisibilityBatchRequest).build());
}
/**
*
* Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following
* caveats in mind:
*
*
* -
*
* If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.
*
*
*
* You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO
* queue. You must either create a new FIFO queue for your application or delete your existing standard queue and
* recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
*
*
* -
*
* If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
*
*
*
*
* To successfully create a new queue, you must provide a queue name that adheres to the limits
* related to queues and is unique within the scope of your queues.
*
*
* To get the queue URL, use the GetQueueUrl action. GetQueueUrl
* requires only the QueueName parameter. be aware of existing queue names:
*
*
* -
*
* If you provide the name of an existing queue along with the exact names and values of all the queue's attributes,
* CreateQueue returns the queue URL for the existing queue.
*
*
* -
*
* If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue
* returns an error.
*
*
*
*
* Some actions take lists of parameters. These lists are specified using the param.n notation. Values
* of n are integers starting from 1. For example, a parameter list with two elements looks like this:
*
*
* &Attribute.1=first
*
*
* &Attribute.2=second
*
*
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* @param createQueueRequest
* @return Result of the CreateQueue operation returned by the service.
* @throws QueueDeletedRecentlyException
* You must wait 60 seconds after deleting a queue before you can create another queue with the same name.
* @throws QueueNameExistsException
* A queue with this name already exists. Amazon SQS returns this error only if the request includes
* attributes whose values differ from those of the existing queue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.CreateQueue
* @see AWS API
* Documentation
*/
default CreateQueueResponse createQueue(CreateQueueRequest createQueueRequest) throws QueueDeletedRecentlyException,
QueueNameExistsException, AwsServiceException, SdkClientException, SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following
* caveats in mind:
*
*
* -
*
* If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.
*
*
*
* You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO
* queue. You must either create a new FIFO queue for your application or delete your existing standard queue and
* recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon Simple Queue Service Developer Guide.
*
*
* -
*
* If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
*
*
* -
*
* If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
*
*
*
*
* To successfully create a new queue, you must provide a queue name that adheres to the limits
* related to queues and is unique within the scope of your queues.
*
*
* To get the queue URL, use the GetQueueUrl action. GetQueueUrl
* requires only the QueueName parameter. be aware of existing queue names:
*
*
* -
*
* If you provide the name of an existing queue along with the exact names and values of all the queue's attributes,
* CreateQueue returns the queue URL for the existing queue.
*
*
* -
*
* If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue
* returns an error.
*
*
*
*
* Some actions take lists of parameters. These lists are specified using the param.n notation. Values
* of n are integers starting from 1. For example, a parameter list with two elements looks like this:
*
*
* &Attribute.1=first
*
*
* &Attribute.2=second
*
*
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* This is a convenience which creates an instance of the {@link CreateQueueRequest.Builder} avoiding the need to
* create one manually via {@link CreateQueueRequest#builder()}
*
*
* @param createQueueRequest
* A {@link Consumer} that will call methods on {@link CreateQueueRequest.Builder} to create a request.
* @return Result of the CreateQueue operation returned by the service.
* @throws QueueDeletedRecentlyException
* You must wait 60 seconds after deleting a queue before you can create another queue with the same name.
* @throws QueueNameExistsException
* A queue with this name already exists. Amazon SQS returns this error only if the request includes
* attributes whose values differ from those of the existing queue.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.CreateQueue
* @see AWS API
* Documentation
*/
default CreateQueueResponse createQueue(Consumer createQueueRequest)
throws QueueDeletedRecentlyException, QueueNameExistsException, AwsServiceException, SdkClientException, SqsException {
return createQueue(CreateQueueRequest.builder().applyMutation(createQueueRequest).build());
}
/**
*
* Deletes the specified message from the specified queue. To select the message to delete, use the
* ReceiptHandle of the message (not the MessageId which you receive when you send
* the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the
* message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than
* the retention period configured for the queue.
*
*
*
* The ReceiptHandle is associated with a specific instance of receiving a message. If you
* receive a message more than once, the ReceiptHandle is different each time you receive a message.
* When you use the DeleteMessage action, you must provide the most recently received
* ReceiptHandle for the message (otherwise, the request succeeds, but the message might not be
* deleted).
*
*
* For standard queues, it is possible to receive a message even after you delete it. This might happen on rare
* occasions if one of the servers which stores a copy of the message is unavailable when you send the request to
* delete the message. The copy remains on the server and might be returned to you during a subsequent receive
* request. You should ensure that your application is idempotent, so that receiving a message more than once does
* not cause issues.
*
*
*
* @param deleteMessageRequest
* @return Result of the DeleteMessage operation returned by the service.
* @throws InvalidIdFormatException
* The specified receipt handle isn't valid for the current version.
* @throws ReceiptHandleIsInvalidException
* The specified receipt handle isn't valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.DeleteMessage
* @see AWS API
* Documentation
*/
default DeleteMessageResponse deleteMessage(DeleteMessageRequest deleteMessageRequest) throws InvalidIdFormatException,
ReceiptHandleIsInvalidException, AwsServiceException, SdkClientException, SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified message from the specified queue. To select the message to delete, use the
* ReceiptHandle of the message (not the MessageId which you receive when you send
* the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the
* message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than
* the retention period configured for the queue.
*
*
*
* The ReceiptHandle is associated with a specific instance of receiving a message. If you
* receive a message more than once, the ReceiptHandle is different each time you receive a message.
* When you use the DeleteMessage action, you must provide the most recently received
* ReceiptHandle for the message (otherwise, the request succeeds, but the message might not be
* deleted).
*
*
* For standard queues, it is possible to receive a message even after you delete it. This might happen on rare
* occasions if one of the servers which stores a copy of the message is unavailable when you send the request to
* delete the message. The copy remains on the server and might be returned to you during a subsequent receive
* request. You should ensure that your application is idempotent, so that receiving a message more than once does
* not cause issues.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteMessageRequest.Builder} avoiding the need to
* create one manually via {@link DeleteMessageRequest#builder()}
*
*
* @param deleteMessageRequest
* A {@link Consumer} that will call methods on {@link DeleteMessageRequest.Builder} to create a request.
* @return Result of the DeleteMessage operation returned by the service.
* @throws InvalidIdFormatException
* The specified receipt handle isn't valid for the current version.
* @throws ReceiptHandleIsInvalidException
* The specified receipt handle isn't valid.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.DeleteMessage
* @see AWS API
* Documentation
*/
default DeleteMessageResponse deleteMessage(Consumer deleteMessageRequest)
throws InvalidIdFormatException, ReceiptHandleIsInvalidException, AwsServiceException, SdkClientException,
SqsException {
return deleteMessage(DeleteMessageRequest.builder().applyMutation(deleteMessageRequest).build());
}
/**
*
* Deletes up to ten messages from the specified queue. This is a batch version of
* DeleteMessage. The result of the action on each message is reported individually in the
* response.
*
*
*
* Because the batch request can result in a combination of successful and unsuccessful actions, you should check
* for batch errors even when the call returns an HTTP status code of 200.
*
*
*
* Some actions take lists of parameters. These lists are specified using the param.n notation. Values
* of n are integers starting from 1. For example, a parameter list with two elements looks like this:
*
*
* &Attribute.1=first
*
*
* &Attribute.2=second
*
*
* @param deleteMessageBatchRequest
* @return Result of the DeleteMessageBatch operation returned by the service.
* @throws TooManyEntriesInBatchRequestException
* The batch request contains more entries than permissible.
* @throws EmptyBatchRequestException
* The batch request doesn't contain any entries.
* @throws BatchEntryIdsNotDistinctException
* Two or more batch entries in the request have the same Id.
* @throws InvalidBatchEntryIdException
* The Id of a batch entry in a batch request doesn't abide by the specification.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.DeleteMessageBatch
* @see AWS API
* Documentation
*/
default DeleteMessageBatchResponse deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest)
throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException,
InvalidBatchEntryIdException, AwsServiceException, SdkClientException, SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes up to ten messages from the specified queue. This is a batch version of
* DeleteMessage. The result of the action on each message is reported individually in the
* response.
*
*
*
* Because the batch request can result in a combination of successful and unsuccessful actions, you should check
* for batch errors even when the call returns an HTTP status code of 200.
*
*
*
* Some actions take lists of parameters. These lists are specified using the param.n notation. Values
* of n are integers starting from 1. For example, a parameter list with two elements looks like this:
*
*
* &Attribute.1=first
*
*
* &Attribute.2=second
*
*
*
* This is a convenience which creates an instance of the {@link DeleteMessageBatchRequest.Builder} avoiding the
* need to create one manually via {@link DeleteMessageBatchRequest#builder()}
*
*
* @param deleteMessageBatchRequest
* A {@link Consumer} that will call methods on {@link DeleteMessageBatchRequest.Builder} to create a
* request.
* @return Result of the DeleteMessageBatch operation returned by the service.
* @throws TooManyEntriesInBatchRequestException
* The batch request contains more entries than permissible.
* @throws EmptyBatchRequestException
* The batch request doesn't contain any entries.
* @throws BatchEntryIdsNotDistinctException
* Two or more batch entries in the request have the same Id.
* @throws InvalidBatchEntryIdException
* The Id of a batch entry in a batch request doesn't abide by the specification.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.DeleteMessageBatch
* @see AWS API
* Documentation
*/
default DeleteMessageBatchResponse deleteMessageBatch(Consumer deleteMessageBatchRequest)
throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException,
InvalidBatchEntryIdException, AwsServiceException, SdkClientException, SqsException {
return deleteMessageBatch(DeleteMessageBatchRequest.builder().applyMutation(deleteMessageBatchRequest).build());
}
/**
*
* Deletes the queue specified by the QueueUrl, regardless of the queue's contents. If the specified
* queue doesn't exist, Amazon SQS returns a successful response.
*
*
*
* Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no
* longer available.
*
*
*
* When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue
* during the 60 seconds might succeed. For example, a SendMessage request might succeed, but
* after 60 seconds the queue and the message you sent no longer exist.
*
*
* When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
*
*
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* @param deleteQueueRequest
* @return Result of the DeleteQueue operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.DeleteQueue
* @see AWS API
* Documentation
*/
default DeleteQueueResponse deleteQueue(DeleteQueueRequest deleteQueueRequest) throws AwsServiceException,
SdkClientException, SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the queue specified by the QueueUrl, regardless of the queue's contents. If the specified
* queue doesn't exist, Amazon SQS returns a successful response.
*
*
*
* Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no
* longer available.
*
*
*
* When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue
* during the 60 seconds might succeed. For example, a SendMessage request might succeed, but
* after 60 seconds the queue and the message you sent no longer exist.
*
*
* When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
*
*
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteQueueRequest.Builder} avoiding the need to
* create one manually via {@link DeleteQueueRequest#builder()}
*
*
* @param deleteQueueRequest
* A {@link Consumer} that will call methods on {@link DeleteQueueRequest.Builder} to create a request.
* @return Result of the DeleteQueue operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.DeleteQueue
* @see AWS API
* Documentation
*/
default DeleteQueueResponse deleteQueue(Consumer deleteQueueRequest) throws AwsServiceException,
SdkClientException, SqsException {
return deleteQueue(DeleteQueueRequest.builder().applyMutation(deleteQueueRequest).build());
}
/**
*
* Gets attributes for the specified queue.
*
*
*
* To determine whether a queue is FIFO, you
* can check whether QueueName ends with the .fifo suffix.
*
*
*
* Some actions take lists of parameters. These lists are specified using the param.n notation. Values
* of n are integers starting from 1. For example, a parameter list with two elements looks like this:
*
*
* &Attribute.1=first
*
*
* &Attribute.2=second
*
*
* @param getQueueAttributesRequest
* @return Result of the GetQueueAttributes operation returned by the service.
* @throws InvalidAttributeNameException
* The specified attribute doesn't exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.GetQueueAttributes
* @see AWS API
* Documentation
*/
default GetQueueAttributesResponse getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest)
throws InvalidAttributeNameException, AwsServiceException, SdkClientException, SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Gets attributes for the specified queue.
*
*
*
* To determine whether a queue is FIFO, you
* can check whether QueueName ends with the .fifo suffix.
*
*
*
* Some actions take lists of parameters. These lists are specified using the param.n notation. Values
* of n are integers starting from 1. For example, a parameter list with two elements looks like this:
*
*
* &Attribute.1=first
*
*
* &Attribute.2=second
*
*
*
* This is a convenience which creates an instance of the {@link GetQueueAttributesRequest.Builder} avoiding the
* need to create one manually via {@link GetQueueAttributesRequest#builder()}
*
*
* @param getQueueAttributesRequest
* A {@link Consumer} that will call methods on {@link GetQueueAttributesRequest.Builder} to create a
* request.
* @return Result of the GetQueueAttributes operation returned by the service.
* @throws InvalidAttributeNameException
* The specified attribute doesn't exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.GetQueueAttributes
* @see AWS API
* Documentation
*/
default GetQueueAttributesResponse getQueueAttributes(Consumer getQueueAttributesRequest)
throws InvalidAttributeNameException, AwsServiceException, SdkClientException, SqsException {
return getQueueAttributes(GetQueueAttributesRequest.builder().applyMutation(getQueueAttributesRequest).build());
}
/**
*
* Returns the URL of an existing Amazon SQS queue.
*
*
* To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to
* specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For
* more information about shared queue access, see AddPermission or see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer
* Guide.
*
*
* @param getQueueUrlRequest
* @return Result of the GetQueueUrl operation returned by the service.
* @throws QueueDoesNotExistException
* The specified queue doesn't exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.GetQueueUrl
* @see AWS API
* Documentation
*/
default GetQueueUrlResponse getQueueUrl(GetQueueUrlRequest getQueueUrlRequest) throws QueueDoesNotExistException,
AwsServiceException, SdkClientException, SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the URL of an existing Amazon SQS queue.
*
*
* To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to
* specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For
* more information about shared queue access, see AddPermission or see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* This is a convenience which creates an instance of the {@link GetQueueUrlRequest.Builder} avoiding the need to
* create one manually via {@link GetQueueUrlRequest#builder()}
*
*
* @param getQueueUrlRequest
* A {@link Consumer} that will call methods on {@link GetQueueUrlRequest.Builder} to create a request.
* @return Result of the GetQueueUrl operation returned by the service.
* @throws QueueDoesNotExistException
* The specified queue doesn't exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.GetQueueUrl
* @see AWS API
* Documentation
*/
default GetQueueUrlResponse getQueueUrl(Consumer getQueueUrlRequest)
throws QueueDoesNotExistException, AwsServiceException, SdkClientException, SqsException {
return getQueueUrl(GetQueueUrlRequest.builder().applyMutation(getQueueUrlRequest).build());
}
/**
*
* Returns a list of your queues that have the RedrivePolicy queue attribute configured with a
* dead-letter queue.
*
*
* For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
*
*
* @param listDeadLetterSourceQueuesRequest
* @return Result of the ListDeadLetterSourceQueues operation returned by the service.
* @throws QueueDoesNotExistException
* The specified queue doesn't exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.ListDeadLetterSourceQueues
* @see AWS
* API Documentation
*/
default ListDeadLetterSourceQueuesResponse listDeadLetterSourceQueues(
ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest) throws QueueDoesNotExistException,
AwsServiceException, SdkClientException, SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of your queues that have the RedrivePolicy queue attribute configured with a
* dead-letter queue.
*
*
* For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link ListDeadLetterSourceQueuesRequest.Builder} avoiding
* the need to create one manually via {@link ListDeadLetterSourceQueuesRequest#builder()}
*
*
* @param listDeadLetterSourceQueuesRequest
* A {@link Consumer} that will call methods on {@link ListDeadLetterSourceQueuesRequest.Builder} to create a
* request.
* @return Result of the ListDeadLetterSourceQueues operation returned by the service.
* @throws QueueDoesNotExistException
* The specified queue doesn't exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.ListDeadLetterSourceQueues
* @see AWS
* API Documentation
*/
default ListDeadLetterSourceQueuesResponse listDeadLetterSourceQueues(
Consumer listDeadLetterSourceQueuesRequest)
throws QueueDoesNotExistException, AwsServiceException, SdkClientException, SqsException {
return listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest.builder()
.applyMutation(listDeadLetterSourceQueuesRequest).build());
}
/**
*
* List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging
* Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
*
*
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* @param listQueueTagsRequest
* @return Result of the ListQueueTags operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.ListQueueTags
* @see AWS API
* Documentation
*/
default ListQueueTagsResponse listQueueTags(ListQueueTagsRequest listQueueTagsRequest) throws AwsServiceException,
SdkClientException, SqsException {
throw new UnsupportedOperationException();
}
/**
*
* List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging
* Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
*
*
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* This is a convenience which creates an instance of the {@link ListQueueTagsRequest.Builder} avoiding the need to
* create one manually via {@link ListQueueTagsRequest#builder()}
*
*
* @param listQueueTagsRequest
* A {@link Consumer} that will call methods on {@link ListQueueTagsRequest.Builder} to create a request.
* @return Result of the ListQueueTags operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.ListQueueTags
* @see AWS API
* Documentation
*/
default ListQueueTagsResponse listQueueTags(Consumer listQueueTagsRequest)
throws AwsServiceException, SdkClientException, SqsException {
return listQueueTags(ListQueueTagsRequest.builder().applyMutation(listQueueTagsRequest).build());
}
/**
*
* Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value
* for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified
* value are returned.
*
*
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* @return Result of the ListQueues operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.ListQueues
* @see #listQueues(ListQueuesRequest)
* @see AWS API
* Documentation
*/
default ListQueuesResponse listQueues() throws AwsServiceException, SdkClientException, SqsException {
return listQueues(ListQueuesRequest.builder().build());
}
/**
*
* Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value
* for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified
* value are returned.
*
*
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* @param listQueuesRequest
* @return Result of the ListQueues operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.ListQueues
* @see AWS API
* Documentation
*/
default ListQueuesResponse listQueues(ListQueuesRequest listQueuesRequest) throws AwsServiceException, SdkClientException,
SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value
* for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified
* value are returned.
*
*
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* This is a convenience which creates an instance of the {@link ListQueuesRequest.Builder} avoiding the need to
* create one manually via {@link ListQueuesRequest#builder()}
*
*
* @param listQueuesRequest
* A {@link Consumer} that will call methods on {@link ListQueuesRequest.Builder} to create a request.
* @return Result of the ListQueues operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.ListQueues
* @see AWS API
* Documentation
*/
default ListQueuesResponse listQueues(Consumer listQueuesRequest) throws AwsServiceException,
SdkClientException, SqsException {
return listQueues(ListQueuesRequest.builder().applyMutation(listQueuesRequest).build());
}
/**
*
* Deletes the messages in a queue specified by the QueueURL parameter.
*
*
*
* When you use the PurgeQueue action, you can't retrieve any messages deleted from a queue.
*
*
* The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your
* queue's size.
*
*
*
* Messages sent to the queue before you call PurgeQueue might be received but are deleted
* within the next minute.
*
*
* Messages sent to the queue after you call PurgeQueue might be deleted while the queue is
* being purged.
*
*
* @param purgeQueueRequest
* @return Result of the PurgeQueue operation returned by the service.
* @throws QueueDoesNotExistException
* The specified queue doesn't exist.
* @throws PurgeQueueInProgressException
* Indicates that the specified queue previously received a PurgeQueue request within the last
* 60 seconds (the time it can take to delete the messages in the queue).
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.PurgeQueue
* @see AWS API
* Documentation
*/
default PurgeQueueResponse purgeQueue(PurgeQueueRequest purgeQueueRequest) throws QueueDoesNotExistException,
PurgeQueueInProgressException, AwsServiceException, SdkClientException, SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the messages in a queue specified by the QueueURL parameter.
*
*
*
* When you use the PurgeQueue action, you can't retrieve any messages deleted from a queue.
*
*
* The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your
* queue's size.
*
*
*
* Messages sent to the queue before you call PurgeQueue might be received but are deleted
* within the next minute.
*
*
* Messages sent to the queue after you call PurgeQueue might be deleted while the queue is
* being purged.
*
*
*
* This is a convenience which creates an instance of the {@link PurgeQueueRequest.Builder} avoiding the need to
* create one manually via {@link PurgeQueueRequest#builder()}
*
*
* @param purgeQueueRequest
* A {@link Consumer} that will call methods on {@link PurgeQueueRequest.Builder} to create a request.
* @return Result of the PurgeQueue operation returned by the service.
* @throws QueueDoesNotExistException
* The specified queue doesn't exist.
* @throws PurgeQueueInProgressException
* Indicates that the specified queue previously received a PurgeQueue request within the last
* 60 seconds (the time it can take to delete the messages in the queue).
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.PurgeQueue
* @see AWS API
* Documentation
*/
default PurgeQueueResponse purgeQueue(Consumer purgeQueueRequest)
throws QueueDoesNotExistException, PurgeQueueInProgressException, AwsServiceException, SdkClientException,
SqsException {
return purgeQueue(PurgeQueueRequest.builder().applyMutation(purgeQueueRequest).build());
}
/**
*
* Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds
* parameter enables long-poll support. For more information, see Amazon
* SQS Long Polling in the Amazon Simple Queue Service Developer Guide.
*
*
* Short poll is the default behavior where a weighted random set of machines is sampled on a
* ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of
* messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per
* ReceiveMessage call. If the number of messages in the queue is extremely small, you might not
* receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.
*
*
* For each message returned, the response includes the following:
*
*
* -
*
* The message body.
*
*
* -
*
* An MD5 digest of the message body. For information about MD5, see RFC1321.
*
*
* -
*
* The MessageId you received when you sent the message to the queue.
*
*
* -
*
* The receipt handle.
*
*
* -
*
* The message attributes.
*
*
* -
*
* An MD5 digest of the message attributes.
*
*
*
*
* The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon Simple Queue Service Developer Guide.
*
*
* You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the
* messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility
* timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
*
*
* A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires
* counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the
* dead-letter queue.
*
*
*
* In the future, new attributes might be added. If you write code that calls this action, we recommend that you
* structure your code so that it can handle new attributes gracefully.
*
*
*
* @param receiveMessageRequest
* @return Result of the ReceiveMessage operation returned by the service.
* @throws OverLimitException
* The specified action violates a limit. For example, ReceiveMessage returns this error if the
* maximum number of inflight messages is reached and AddPermission returns this error if the
* maximum number of permissions for the queue is reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.ReceiveMessage
* @see AWS API
* Documentation
*/
default ReceiveMessageResponse receiveMessage(ReceiveMessageRequest receiveMessageRequest) throws OverLimitException,
AwsServiceException, SdkClientException, SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds
* parameter enables long-poll support. For more information, see Amazon
* SQS Long Polling in the Amazon Simple Queue Service Developer Guide.
*
*
* Short poll is the default behavior where a weighted random set of machines is sampled on a
* ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of
* messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per
* ReceiveMessage call. If the number of messages in the queue is extremely small, you might not
* receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.
*
*
* For each message returned, the response includes the following:
*
*
* -
*
* The message body.
*
*
* -
*
* An MD5 digest of the message body. For information about MD5, see RFC1321.
*
*
* -
*
* The MessageId you received when you sent the message to the queue.
*
*
* -
*
* The receipt handle.
*
*
* -
*
* The message attributes.
*
*
* -
*
* An MD5 digest of the message attributes.
*
*
*
*
* The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon Simple Queue Service Developer Guide.
*
*
* You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the
* messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility
* timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
*
*
* A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires
* counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the
* dead-letter queue.
*
*
*
* In the future, new attributes might be added. If you write code that calls this action, we recommend that you
* structure your code so that it can handle new attributes gracefully.
*
*
*
* This is a convenience which creates an instance of the {@link ReceiveMessageRequest.Builder} avoiding the need to
* create one manually via {@link ReceiveMessageRequest#builder()}
*
*
* @param receiveMessageRequest
* A {@link Consumer} that will call methods on {@link ReceiveMessageRequest.Builder} to create a request.
* @return Result of the ReceiveMessage operation returned by the service.
* @throws OverLimitException
* The specified action violates a limit. For example, ReceiveMessage returns this error if the
* maximum number of inflight messages is reached and AddPermission returns this error if the
* maximum number of permissions for the queue is reached.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.ReceiveMessage
* @see AWS API
* Documentation
*/
default ReceiveMessageResponse receiveMessage(Consumer receiveMessageRequest)
throws OverLimitException, AwsServiceException, SdkClientException, SqsException {
return receiveMessage(ReceiveMessageRequest.builder().applyMutation(receiveMessageRequest).build());
}
/**
*
* Revokes any permissions in the queue policy that matches the specified Label parameter.
*
*
*
* -
*
* Only the owner of a queue can remove permissions from it.
*
*
* -
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
* -
*
* To remove the ability to change queue permissions, you must deny permission to the AddPermission,
* RemovePermission, and SetQueueAttributes actions in your IAM policy.
*
*
*
*
*
* @param removePermissionRequest
* @return Result of the RemovePermission operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.RemovePermission
* @see AWS API
* Documentation
*/
default RemovePermissionResponse removePermission(RemovePermissionRequest removePermissionRequest)
throws AwsServiceException, SdkClientException, SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Revokes any permissions in the queue policy that matches the specified Label parameter.
*
*
*
* -
*
* Only the owner of a queue can remove permissions from it.
*
*
* -
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
* -
*
* To remove the ability to change queue permissions, you must deny permission to the AddPermission,
* RemovePermission, and SetQueueAttributes actions in your IAM policy.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link RemovePermissionRequest.Builder} avoiding the need
* to create one manually via {@link RemovePermissionRequest#builder()}
*
*
* @param removePermissionRequest
* A {@link Consumer} that will call methods on {@link RemovePermissionRequest.Builder} to create a request.
* @return Result of the RemovePermission operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.RemovePermission
* @see AWS API
* Documentation
*/
default RemovePermissionResponse removePermission(Consumer removePermissionRequest)
throws AwsServiceException, SdkClientException, SqsException {
return removePermission(RemovePermissionRequest.builder().applyMutation(removePermissionRequest).build());
}
/**
*
* Delivers a message to the specified queue.
*
*
*
* A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
*
*
* #x9 | #xA | #xD | #x20 to #xD7FF |
* #xE000 to #xFFFD | #x10000 to #x10FFFF
*
*
* Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
*
*
*
* @param sendMessageRequest
* @return Result of the SendMessage operation returned by the service.
* @throws InvalidMessageContentsException
* The message contains characters outside the allowed set.
* @throws UnsupportedOperationException
* Error code 400. Unsupported operation.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.SendMessage
* @see AWS API
* Documentation
*/
default SendMessageResponse sendMessage(SendMessageRequest sendMessageRequest) throws InvalidMessageContentsException,
software.amazon.awssdk.services.sqs.model.UnsupportedOperationException, AwsServiceException, SdkClientException,
SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Delivers a message to the specified queue.
*
*
*
* A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
*
*
* #x9 | #xA | #xD | #x20 to #xD7FF |
* #xE000 to #xFFFD | #x10000 to #x10FFFF
*
*
* Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
*
*
*
* This is a convenience which creates an instance of the {@link SendMessageRequest.Builder} avoiding the need to
* create one manually via {@link SendMessageRequest#builder()}
*
*
* @param sendMessageRequest
* A {@link Consumer} that will call methods on {@link SendMessageRequest.Builder} to create a request.
* @return Result of the SendMessage operation returned by the service.
* @throws InvalidMessageContentsException
* The message contains characters outside the allowed set.
* @throws UnsupportedOperationException
* Error code 400. Unsupported operation.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.SendMessage
* @see AWS API
* Documentation
*/
default SendMessageResponse sendMessage(Consumer sendMessageRequest)
throws InvalidMessageContentsException, software.amazon.awssdk.services.sqs.model.UnsupportedOperationException,
AwsServiceException, SdkClientException, SqsException {
return sendMessage(SendMessageRequest.builder().applyMutation(sendMessageRequest).build());
}
/**
*
* Delivers up to ten messages to the specified queue. This is a batch version of SendMessage.
* For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
*
*
* The result of sending each message is reported individually in the response. Because the batch request can result
* in a combination of successful and unsuccessful actions, you should check for batch errors even when the call
* returns an HTTP status code of 200.
*
*
* The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths
* of all of the batched messages) are both 256 KB (262,144 bytes).
*
*
*
* A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
*
*
* #x9 | #xA | #xD | #x20 to #xD7FF |
* #xE000 to #xFFFD | #x10000 to #x10FFFF
*
*
* Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
*
*
*
* If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for
* the queue.
*
*
* Some actions take lists of parameters. These lists are specified using the param.n notation. Values
* of n are integers starting from 1. For example, a parameter list with two elements looks like this:
*
*
* &Attribute.1=first
*
*
* &Attribute.2=second
*
*
* @param sendMessageBatchRequest
* @return Result of the SendMessageBatch operation returned by the service.
* @throws TooManyEntriesInBatchRequestException
* The batch request contains more entries than permissible.
* @throws EmptyBatchRequestException
* The batch request doesn't contain any entries.
* @throws BatchEntryIdsNotDistinctException
* Two or more batch entries in the request have the same Id.
* @throws BatchRequestTooLongException
* The length of all the messages put together is more than the limit.
* @throws InvalidBatchEntryIdException
* The Id of a batch entry in a batch request doesn't abide by the specification.
* @throws UnsupportedOperationException
* Error code 400. Unsupported operation.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.SendMessageBatch
* @see AWS API
* Documentation
*/
default SendMessageBatchResponse sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest)
throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException,
BatchRequestTooLongException, InvalidBatchEntryIdException,
software.amazon.awssdk.services.sqs.model.UnsupportedOperationException, AwsServiceException, SdkClientException,
SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Delivers up to ten messages to the specified queue. This is a batch version of SendMessage.
* For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
*
*
* The result of sending each message is reported individually in the response. Because the batch request can result
* in a combination of successful and unsuccessful actions, you should check for batch errors even when the call
* returns an HTTP status code of 200.
*
*
* The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths
* of all of the batched messages) are both 256 KB (262,144 bytes).
*
*
*
* A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
*
*
* #x9 | #xA | #xD | #x20 to #xD7FF |
* #xE000 to #xFFFD | #x10000 to #x10FFFF
*
*
* Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
*
*
*
* If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for
* the queue.
*
*
* Some actions take lists of parameters. These lists are specified using the param.n notation. Values
* of n are integers starting from 1. For example, a parameter list with two elements looks like this:
*
*
* &Attribute.1=first
*
*
* &Attribute.2=second
*
*
*
* This is a convenience which creates an instance of the {@link SendMessageBatchRequest.Builder} avoiding the need
* to create one manually via {@link SendMessageBatchRequest#builder()}
*
*
* @param sendMessageBatchRequest
* A {@link Consumer} that will call methods on {@link SendMessageBatchRequest.Builder} to create a request.
* @return Result of the SendMessageBatch operation returned by the service.
* @throws TooManyEntriesInBatchRequestException
* The batch request contains more entries than permissible.
* @throws EmptyBatchRequestException
* The batch request doesn't contain any entries.
* @throws BatchEntryIdsNotDistinctException
* Two or more batch entries in the request have the same Id.
* @throws BatchRequestTooLongException
* The length of all the messages put together is more than the limit.
* @throws InvalidBatchEntryIdException
* The Id of a batch entry in a batch request doesn't abide by the specification.
* @throws UnsupportedOperationException
* Error code 400. Unsupported operation.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.SendMessageBatch
* @see AWS API
* Documentation
*/
default SendMessageBatchResponse sendMessageBatch(Consumer sendMessageBatchRequest)
throws TooManyEntriesInBatchRequestException, EmptyBatchRequestException, BatchEntryIdsNotDistinctException,
BatchRequestTooLongException, InvalidBatchEntryIdException,
software.amazon.awssdk.services.sqs.model.UnsupportedOperationException, AwsServiceException, SdkClientException,
SqsException {
return sendMessageBatch(SendMessageBatchRequest.builder().applyMutation(sendMessageBatchRequest).build());
}
/**
*
* Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to
* 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the
* MessageRetentionPeriod attribute can take up to 15 minutes.
*
*
*
* -
*
* In the future, new attributes might be added. If you write code that calls this action, we recommend that you
* structure your code so that it can handle new attributes gracefully.
*
*
* -
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
* -
*
* To remove the ability to change queue permissions, you must deny permission to the AddPermission,
* RemovePermission, and SetQueueAttributes actions in your IAM policy.
*
*
*
*
*
* @param setQueueAttributesRequest
* @return Result of the SetQueueAttributes operation returned by the service.
* @throws InvalidAttributeNameException
* The specified attribute doesn't exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.SetQueueAttributes
* @see AWS API
* Documentation
*/
default SetQueueAttributesResponse setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest)
throws InvalidAttributeNameException, AwsServiceException, SdkClientException, SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to
* 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the
* MessageRetentionPeriod attribute can take up to 15 minutes.
*
*
*
* -
*
* In the future, new attributes might be added. If you write code that calls this action, we recommend that you
* structure your code so that it can handle new attributes gracefully.
*
*
* -
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
* -
*
* To remove the ability to change queue permissions, you must deny permission to the AddPermission,
* RemovePermission, and SetQueueAttributes actions in your IAM policy.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link SetQueueAttributesRequest.Builder} avoiding the
* need to create one manually via {@link SetQueueAttributesRequest#builder()}
*
*
* @param setQueueAttributesRequest
* A {@link Consumer} that will call methods on {@link SetQueueAttributesRequest.Builder} to create a
* request.
* @return Result of the SetQueueAttributes operation returned by the service.
* @throws InvalidAttributeNameException
* The specified attribute doesn't exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.SetQueueAttributes
* @see AWS API
* Documentation
*/
default SetQueueAttributesResponse setQueueAttributes(Consumer setQueueAttributesRequest)
throws InvalidAttributeNameException, AwsServiceException, SdkClientException, SqsException {
return setQueueAttributes(SetQueueAttributesRequest.builder().applyMutation(setQueueAttributesRequest).build());
}
/**
*
* Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging
* Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
*
*
* When you use queue tags, keep the following guidelines in mind:
*
*
* -
*
* Adding more than 50 tags to a queue isn't recommended.
*
*
* -
*
* Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
*
*
* -
*
* Tags are case-sensitive.
*
*
* -
*
* A new tag with a key identical to that of an existing tag overwrites the existing tag.
*
*
* -
*
* Tagging actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support
* request.
*
*
*
*
* For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
*
*
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* @param tagQueueRequest
* @return Result of the TagQueue operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.TagQueue
* @see AWS API
* Documentation
*/
default TagQueueResponse tagQueue(TagQueueRequest tagQueueRequest) throws AwsServiceException, SdkClientException,
SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging
* Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
*
*
* When you use queue tags, keep the following guidelines in mind:
*
*
* -
*
* Adding more than 50 tags to a queue isn't recommended.
*
*
* -
*
* Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
*
*
* -
*
* Tags are case-sensitive.
*
*
* -
*
* A new tag with a key identical to that of an existing tag overwrites the existing tag.
*
*
* -
*
* Tagging actions are limited to 5 TPS per AWS account. If your application requires a higher throughput, file a technical support
* request.
*
*
*
*
* For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
*
*
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* This is a convenience which creates an instance of the {@link TagQueueRequest.Builder} avoiding the need to
* create one manually via {@link TagQueueRequest#builder()}
*
*
* @param tagQueueRequest
* A {@link Consumer} that will call methods on {@link TagQueueRequest.Builder} to create a request.
* @return Result of the TagQueue operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.TagQueue
* @see AWS API
* Documentation
*/
default TagQueueResponse tagQueue(Consumer tagQueueRequest) throws AwsServiceException,
SdkClientException, SqsException {
return tagQueue(TagQueueRequest.builder().applyMutation(tagQueueRequest).build());
}
/**
*
* Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging
* Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
*
*
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* @param untagQueueRequest
* @return Result of the UntagQueue operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.UntagQueue
* @see AWS API
* Documentation
*/
default UntagQueueResponse untagQueue(UntagQueueRequest untagQueueRequest) throws AwsServiceException, SdkClientException,
SqsException {
throw new UnsupportedOperationException();
}
/**
*
* Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging
* Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
*
*
*
* Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* This is a convenience which creates an instance of the {@link UntagQueueRequest.Builder} avoiding the need to
* create one manually via {@link UntagQueueRequest#builder()}
*
*
* @param untagQueueRequest
* A {@link Consumer} that will call methods on {@link UntagQueueRequest.Builder} to create a request.
* @return Result of the UntagQueue operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws SqsException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample SqsClient.UntagQueue
* @see AWS API
* Documentation
*/
default UntagQueueResponse untagQueue(Consumer untagQueueRequest) throws AwsServiceException,
SdkClientException, SqsException {
return untagQueue(UntagQueueRequest.builder().applyMutation(untagQueueRequest).build());
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of("sqs");
}
}