com.amazonaws.services.sqs.AmazonSQS Maven / Gradle / Ivy
/*
* Copyright 2013-2018 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 com.amazonaws.services.sqs;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.sqs.model.*;
/**
* Interface for accessing Amazon SQS.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.sqs.AbstractAmazonSQS} instead.
*
*
*
* 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.
*
*
*
* Standard
* queues are available in all regions. FIFO queues are
* available in the US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland) regions.
*
*
*
* 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("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonSQS {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "sqs";
/**
* Overrides the default endpoint for this client ("https://sqs.us-east-1.amazonaws.com"). Callers can use this
* method to control which AWS region they want to work with.
*
* Callers can pass in just the endpoint (ex: "sqs.us-east-1.amazonaws.com") or a full URL, including the protocol
* (ex: "https://sqs.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from
* this client's {@link ClientConfiguration} will be used, which by default is HTTPS.
*
* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available
* endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection-
* choose-endpoint
*
* This method is not threadsafe. An endpoint should be configured when the client is created and before any
* service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in
* transit or retrying.
*
* @param endpoint
* The endpoint (ex: "sqs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
* "https://sqs.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
* with.
* @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* An alternative to {@link AmazonSQS#setEndpoint(String)}, sets the regional endpoint for this client's service
* calls. Callers can use this method to control which AWS region they want to work with.
*
* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
* {@link ClientConfiguration} supplied at construction.
*
* This method is not threadsafe. A region should be configured when the client is created and before any service
* requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit
* or retrying.
*
* @param region
* The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)}
* for accessing a given region. Must not be null and must be a region where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
*
* 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 writes an Amazon-SQS-generated policy. If you want to write your own policy, use
* SetQueueAttributes to upload your policy. For more information about writing your own
* policy, 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.
*
*
*
* 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 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.
* @sample AmazonSQS.AddPermission
* @see AWS API
* Documentation
*/
AddPermissionResult addPermission(AddPermissionRequest addPermissionRequest);
/**
* Simplified method form for invoking the AddPermission operation.
*
* @see #addPermission(AddPermissionRequest)
*/
AddPermissionResult addPermission(String queueUrl, String label, java.util.List aWSAccountIds, java.util.List actions);
/**
*
* Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout
* value 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 a maximum of 12 hours. If you try to
* extend the visibility timeout beyond 12 hours, your request is rejected.
*
*
* A message is considered to be in flight after it's received from a queue by a consumer, but not yet
* deleted from the queue.
*
*
* For standard queues, there can be a maximum of 120,000 inflight messages per 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.
*
*
* For FIFO queues, there can be a maximum of 20,000 inflight messages per 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.
* @sample AmazonSQS.ChangeMessageVisibility
* @see AWS
* API Documentation
*/
ChangeMessageVisibilityResult changeMessageVisibility(ChangeMessageVisibilityRequest changeMessageVisibilityRequest);
/**
* Simplified method form for invoking the ChangeMessageVisibility operation.
*
* @see #changeMessageVisibility(ChangeMessageVisibilityRequest)
*/
ChangeMessageVisibilityResult changeMessageVisibility(String queueUrl, String receiptHandle, Integer visibilityTimeout);
/**
*
* 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.
* @sample AmazonSQS.ChangeMessageVisibilityBatch
* @see AWS API Documentation
*/
ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest changeMessageVisibilityBatchRequest);
/**
* Simplified method form for invoking the ChangeMessageVisibilityBatch operation.
*
* @see #changeMessageVisibilityBatch(ChangeMessageVisibilityBatchRequest)
*/
ChangeMessageVisibilityBatchResult changeMessageVisibilityBatch(String queueUrl, java.util.List entries);
/**
*
* 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 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.
* @sample AmazonSQS.CreateQueue
* @see AWS API
* Documentation
*/
CreateQueueResult createQueue(CreateQueueRequest createQueueRequest);
/**
* Simplified method form for invoking the CreateQueue operation.
*
* @see #createQueue(CreateQueueRequest)
*/
CreateQueueResult createQueue(String queueName);
/**
*
* 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.
* @sample AmazonSQS.DeleteMessage
* @see AWS API
* Documentation
*/
DeleteMessageResult deleteMessage(DeleteMessageRequest deleteMessageRequest);
/**
* Simplified method form for invoking the DeleteMessage operation.
*
* @see #deleteMessage(DeleteMessageRequest)
*/
DeleteMessageResult deleteMessage(String queueUrl, String receiptHandle);
/**
*
* 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.
* @sample AmazonSQS.DeleteMessageBatch
* @see AWS API
* Documentation
*/
DeleteMessageBatchResult deleteMessageBatch(DeleteMessageBatchRequest deleteMessageBatchRequest);
/**
* Simplified method form for invoking the DeleteMessageBatch operation.
*
* @see #deleteMessageBatch(DeleteMessageBatchRequest)
*/
DeleteMessageBatchResult deleteMessageBatch(String queueUrl, java.util.List entries);
/**
*
* 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 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.
* @sample AmazonSQS.DeleteQueue
* @see AWS API
* Documentation
*/
DeleteQueueResult deleteQueue(DeleteQueueRequest deleteQueueRequest);
/**
* Simplified method form for invoking the DeleteQueue operation.
*
* @see #deleteQueue(DeleteQueueRequest)
*/
DeleteQueueResult deleteQueue(String queueUrl);
/**
*
* 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.
* @sample AmazonSQS.GetQueueAttributes
* @see AWS API
* Documentation
*/
GetQueueAttributesResult getQueueAttributes(GetQueueAttributesRequest getQueueAttributesRequest);
/**
* Simplified method form for invoking the GetQueueAttributes operation.
*
* @see #getQueueAttributes(GetQueueAttributesRequest)
*/
GetQueueAttributesResult getQueueAttributes(String queueUrl, java.util.List attributeNames);
/**
*
* 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.
* @sample AmazonSQS.GetQueueUrl
* @see AWS API
* Documentation
*/
GetQueueUrlResult getQueueUrl(GetQueueUrlRequest getQueueUrlRequest);
/**
* Simplified method form for invoking the GetQueueUrl operation.
*
* @see #getQueueUrl(GetQueueUrlRequest)
*/
GetQueueUrlResult getQueueUrl(String queueName);
/**
*
* 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.
* @sample AmazonSQS.ListDeadLetterSourceQueues
* @see AWS
* API Documentation
*/
ListDeadLetterSourceQueuesResult listDeadLetterSourceQueues(ListDeadLetterSourceQueuesRequest listDeadLetterSourceQueuesRequest);
/**
*
* 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.
*
*
* 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 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.
* @sample AmazonSQS.ListQueueTags
* @see AWS API
* Documentation
*/
ListQueueTagsResult listQueueTags(ListQueueTagsRequest listQueueTagsRequest);
/**
* Simplified method form for invoking the ListQueueTags operation.
*
* @see #listQueueTags(ListQueueTagsRequest)
*/
ListQueueTagsResult listQueueTags(String queueUrl);
/**
*
* 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 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.
* @sample AmazonSQS.ListQueues
* @see AWS API
* Documentation
*/
ListQueuesResult listQueues(ListQueuesRequest listQueuesRequest);
/**
* Simplified method form for invoking the ListQueues operation.
*
* @see #listQueues(ListQueuesRequest)
*/
ListQueuesResult listQueues();
/**
* Simplified method form for invoking the ListQueues operation.
*
* @see #listQueues(ListQueuesRequest)
*/
ListQueuesResult listQueues(String queueNamePrefix);
/**
*
* 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).
* @sample AmazonSQS.PurgeQueue
* @see AWS API
* Documentation
*/
PurgeQueueResult purgeQueue(PurgeQueueRequest purgeQueueRequest);
/**
*
* 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.
* @sample AmazonSQS.ReceiveMessage
* @see AWS API
* Documentation
*/
ReceiveMessageResult receiveMessage(ReceiveMessageRequest receiveMessageRequest);
/**
* Simplified method form for invoking the ReceiveMessage operation.
*
* @see #receiveMessage(ReceiveMessageRequest)
*/
ReceiveMessageResult receiveMessage(String queueUrl);
/**
*
* 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 see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* @param removePermissionRequest
* @return Result of the RemovePermission operation returned by the service.
* @sample AmazonSQS.RemovePermission
* @see AWS API
* Documentation
*/
RemovePermissionResult removePermission(RemovePermissionRequest removePermissionRequest);
/**
* Simplified method form for invoking the RemovePermission operation.
*
* @see #removePermission(RemovePermissionRequest)
*/
RemovePermissionResult removePermission(String queueUrl, String label);
/**
*
* 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.
* @sample AmazonSQS.SendMessage
* @see AWS API
* Documentation
*/
SendMessageResult sendMessage(SendMessageRequest sendMessageRequest);
/**
* Simplified method form for invoking the SendMessage operation.
*
* @see #sendMessage(SendMessageRequest)
*/
SendMessageResult sendMessage(String queueUrl, String messageBody);
/**
*
* 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.
* @sample AmazonSQS.SendMessageBatch
* @see AWS API
* Documentation
*/
SendMessageBatchResult sendMessageBatch(SendMessageBatchRequest sendMessageBatchRequest);
/**
* Simplified method form for invoking the SendMessageBatch operation.
*
* @see #sendMessageBatch(SendMessageBatchRequest)
*/
SendMessageBatchResult sendMessageBatch(String queueUrl, java.util.List entries);
/**
*
* 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 see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer
* Guide.
*
*
*
* @param setQueueAttributesRequest
* @return Result of the SetQueueAttributes operation returned by the service.
* @throws InvalidAttributeNameException
* The specified attribute doesn't exist.
* @sample AmazonSQS.SetQueueAttributes
* @see AWS API
* Documentation
*/
SetQueueAttributesResult setQueueAttributes(SetQueueAttributesRequest setQueueAttributesRequest);
/**
* Simplified method form for invoking the SetQueueAttributes operation.
*
* @see #setQueueAttributes(SetQueueAttributesRequest)
*/
SetQueueAttributesResult setQueueAttributes(String queueUrl, java.util.Map attributes);
/**
*
* 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 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.
* @sample AmazonSQS.TagQueue
* @see AWS API
* Documentation
*/
TagQueueResult tagQueue(TagQueueRequest tagQueueRequest);
/**
* Simplified method form for invoking the TagQueue operation.
*
* @see #tagQueue(TagQueueRequest)
*/
TagQueueResult tagQueue(String queueUrl, java.util.Map tags);
/**
*
* 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.
*
*
* 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 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.
* @sample AmazonSQS.UntagQueue
* @see AWS API
* Documentation
*/
UntagQueueResult untagQueue(UntagQueueRequest untagQueueRequest);
/**
* Simplified method form for invoking the UntagQueue operation.
*
* @see #untagQueue(UntagQueueRequest)
*/
UntagQueueResult untagQueue(String queueUrl, java.util.List tagKeys);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}