Adds a permission to a queue for a specific \n principal.\n This allows sharing access to the queue.
\nWhen you create a queue, you have full control access rights for the queue.\n Only you, the owner of the queue, can grant or deny permissions to the queue.\n For more information about these permissions, see\n Allow \n Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.
\n\n AddPermission generates a policy for you. You can use \n \n SetQueueAttributes\n to\n upload your policy. For more information, see\n Using Custom Policies with the Amazon SQS Access Policy Language in\n the Amazon Simple Queue Service Developer Guide.
An Amazon SQS policy can have a maximum of 7 actions.
\nTo 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:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
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.
\nThe URL of the Amazon SQS queue to which permissions are added.
\nQueue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "Label": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).
The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS\n account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AWSAccountId" } }, "Actions": { "target": "com.amazonaws.sqs#ActionNameList", "traits": { "smithy.api#documentation": "The action the client wants to allow for the specified principal. Valid values: the name of any action or *.
For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource \n in the Amazon Simple Queue Service Developer Guide.
\nSpecifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch,\n DeleteMessageBatch, and ChangeMessageVisibilityBatch.
Welcome to the Amazon Simple Queue Service API Reference.
\nAmazon 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.
\nFor information on the permissions you need to use this API, see\n Identity and\n access management in the Amazon Simple Queue Service Developer Guide.\n
\nYou can use AWS SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
\nCryptographically sign your service requests
\nRetry requests
\nHandle error responses
\n\n Additional information\n
\n\n Amazon Simple Queue Service Developer Guide\n
\n\n Making API Requests\n
\n\n Amazon Web Services General Reference\n
\nTwo or more batch entries in the request have the same Id.
The length of all the messages put together is more than the limit.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#BatchResultErrorEntry": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The Id of an entry in a batch request.
Specifies whether the error happened due to the caller of the batch API action.
", "smithy.api#required": {} } }, "Code": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "An error code representing why the action failed on this entry.
", "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "A message explaining why the action failed on this entry.
" } } }, "traits": { "smithy.api#documentation": "Gives a detailed description of the result of an action on each entry in the\n request.
" } }, "com.amazonaws.sqs#BatchResultErrorEntryList": { "type": "list", "member": { "target": "com.amazonaws.sqs#BatchResultErrorEntry" } }, "com.amazonaws.sqs#Binary": { "type": "blob" }, "com.amazonaws.sqs#BinaryList": { "type": "list", "member": { "target": "com.amazonaws.sqs#Binary", "traits": { "smithy.api#xmlName": "BinaryListValue" } } }, "com.amazonaws.sqs#Boolean": { "type": "boolean" }, "com.amazonaws.sqs#BoxedInteger": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.sqs#ChangeMessageVisibility": { "type": "operation", "input": { "target": "com.amazonaws.sqs#ChangeMessageVisibilityRequest" }, "errors": [ { "target": "com.amazonaws.sqs#MessageNotInflight" }, { "target": "com.amazonaws.sqs#ReceiptHandleIsInvalid" } ], "traits": { "smithy.api#documentation": "Changes the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
\nFor example, you have a message with a visibility timeout of 5 minutes. After 3\n minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You\n can continue to call ChangeMessageVisibility to extend the visibility\n timeout to the maximum allowed time. If you try to extend the visibility timeout beyond\n the maximum, your request is rejected.
An Amazon SQS message has three basic states:
\nSent to a queue by a producer.
\nReceived from the queue by a consumer.
\nDeleted from the queue.
\nA 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.\n 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.
\nLimits that apply to inflight messages are unrelated to the unlimited number of stored messages.
\nFor 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). \n If you reach this limit, Amazon SQS returns the OverLimit error message.\n 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.\n 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.
\n\nIf 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 \n 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.
Changes the visibility timeout of multiple messages. This is a batch version of \n ChangeMessageVisibility. The result of the action on each message is reported individually in the response. \n You can send up to 10 \n ChangeMessageVisibility\n 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:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
The URL of the Amazon SQS queue whose messages' visibility is changed.
\nQueue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "Entries": { "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntryList", "traits": { "smithy.api#documentation": "A list of receipt handles of the messages for which the visibility timeout must be changed.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "ChangeMessageVisibilityBatchRequestEntry" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntry": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "An identifier for this particular receipt handle used to communicate the result.
\nThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nA receipt handle.
", "smithy.api#required": {} } }, "VisibilityTimeout": { "target": "com.amazonaws.sqs#Integer", "traits": { "smithy.api#documentation": "The new value (in seconds) for the message's visibility timeout.
" } } }, "traits": { "smithy.api#documentation": "Encloses a receipt handle and an entry id for each message in \n ChangeMessageVisibilityBatch.\n
All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this:
\n &ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2\n
\n &ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle\n
\n &ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45\n
A list of \n ChangeMessageVisibilityBatchResultEntry\n items.
A list of \n BatchResultErrorEntry\n items.
For each message in the batch, the response contains a \n ChangeMessageVisibilityBatchResultEntry\n tag if the message succeeds or a \n BatchResultErrorEntry\n tag if the message fails.
Represents a message whose visibility timeout has been changed successfully.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Encloses the Id of an entry in \n ChangeMessageVisibilityBatch.\n
The URL of the Amazon SQS queue whose message's visibility is changed.
\nQueue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "ReceiptHandle": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the \n ReceiveMessage\n action.
The new value for the message's visibility timeout (in seconds). Values range: 0 to 43200. Maximum: 12 hours.
Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:
\nIf 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\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon Simple Queue Service Developer Guide.
\nIf you don't provide a value for an attribute, the queue is created with the default value for the attribute.
\nIf you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
\nTo 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.
\nAfter you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.
\nTo get the queue URL, use the \n GetQueueUrl\n action. \n GetQueueUrl\n requires only the QueueName parameter.\n 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:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
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.
\nThe name of the new queue. The following limits apply to this name:
\nA queue name can have up to 80 characters.
\nValid values: alphanumeric characters, hyphens (-), and underscores (_).
A FIFO queue name must end with the .fifo suffix.
Queue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.sqs#TagMap", "traits": { "smithy.api#documentation": "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.
\n \nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the existing tag.
\nFor a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
\nTo be able to tag a queue on creation, you must have the\n sqs:CreateQueue and sqs:TagQueue permissions.
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.
\nA map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:
\n DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.\n
\n MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).\n
\n MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).\n
\n Policy – The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.\n
\n ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a \n ReceiveMessage\n action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.\n
\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon Simple Queue Service Developer Guide.
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.\n When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
\n\n VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see \n Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
The following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias\n .\n For more examples, see KeyId in the AWS Key Management Service API Reference.\n
\n KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt \n or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security \n but results in more calls to KMS which might incur charges after Free Tier. For more information, see \n How Does the Data Key Reuse Period Work?.\n
The following attributes apply only to FIFO (first-in-first-out) queues:
\n\n FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. \n You can provide this attribute only during queue creation. You can't change it for an existing queue. \n When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.
For more information, see \n FIFO Queue Logic \n in the Amazon Simple Queue Service Developer Guide.
\n\n ContentBasedDeduplication – Enables content-based deduplication. Valid values are true and false. For more information, see Exactly-Once Processing in the \n Amazon Simple Queue Service Developer Guide. Note the following:\n
Every message must have a unique MessageDeduplicationId.
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
\n Preview: High throughput for FIFO queues\n
\n\n High throughput for Amazon SQS FIFO queues is in preview release and is subject to change. \n This feature provides a high number of transactions per second (TPS) for messages in FIFO queues. For information on throughput quotas, \n see Quotas related to messages \n in the Amazon Simple Queue Service Developer Guide.
\nThis preview includes two new attributes:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, standard throughput is in effect and deduplication occurs as specified.
\nThis preview is available in the following AWS Regions:
\nUS East (Ohio); us-east-2
\nUS East (N. Virginia); us-east-1
\nUS West (Oregon); us-west-2
\nEurope (Ireland); eu-west-1
\nFor more information about high throughput for FIFO queues, \n see Preview: \n High throughput for FIFO queues in the Amazon Simple Queue Service Developer Guide.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.sqs#CreateQueueResult": { "type": "structure", "members": { "QueueUrl": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The URL of the created Amazon SQS queue.
" } } }, "traits": { "smithy.api#documentation": "Returns the QueueUrl attribute of the created queue.
Deletes the specified message from the specified queue. To select the message to\n delete, use the ReceiptHandle of the message (not the\n MessageId which you receive when you send the message). Amazon SQS can\n delete a message from a queue even if a visibility timeout setting causes the message to\n be locked by another consumer. Amazon SQS automatically deletes messages left in a queue\n longer than the retention period configured for the queue.
The ReceiptHandle is associated with a specific\n instance of receiving a message. If you receive a message more than\n once, the ReceiptHandle is different each time you receive a message.\n When you use the DeleteMessage action, you must provide the most\n recently received ReceiptHandle for the message (otherwise, the request\n succeeds, but the message might not be deleted).
For standard queues, it is possible to receive a message even after you\n delete it. This might happen on rare occasions if one of the servers which stores a\n copy of the message is unavailable when you send the request to delete the message.\n The copy remains on the server and might be returned to you during a subsequent\n receive request. You should ensure that your application is idempotent, so that\n receiving a message more than once does not cause issues.
\nDeletes up to ten messages from the specified queue. This is a batch version of \n 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:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
The URL of the Amazon SQS queue from which messages are deleted.
\nQueue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "Entries": { "target": "com.amazonaws.sqs#DeleteMessageBatchRequestEntryList", "traits": { "smithy.api#documentation": "A list of receipt handles for the messages to be deleted.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "DeleteMessageBatchRequestEntry" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.sqs#DeleteMessageBatchRequestEntry": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "An identifier for this particular receipt handle. This is used to communicate the result.
\nThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nA receipt handle.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Encloses a receipt handle and an identifier for it.
" } }, "com.amazonaws.sqs#DeleteMessageBatchRequestEntryList": { "type": "list", "member": { "target": "com.amazonaws.sqs#DeleteMessageBatchRequestEntry" } }, "com.amazonaws.sqs#DeleteMessageBatchResult": { "type": "structure", "members": { "Successful": { "target": "com.amazonaws.sqs#DeleteMessageBatchResultEntryList", "traits": { "smithy.api#documentation": "A list of \n DeleteMessageBatchResultEntry\n items.
A list of \n BatchResultErrorEntry\n items.
For each message in the batch, the response contains a \n DeleteMessageBatchResultEntry\n tag if the message is deleted or a \n BatchResultErrorEntry\n tag if the message can't be deleted.
Represents a successfully deleted message.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Encloses the Id of an entry in \n DeleteMessageBatch.\n
The URL of the Amazon SQS queue from which messages are deleted.
\nQueue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "ReceiptHandle": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The receipt handle associated with the message to delete.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.sqs#DeleteQueue": { "type": "operation", "input": { "target": "com.amazonaws.sqs#DeleteQueueRequest" }, "traits": { "smithy.api#documentation": "Deletes the queue specified by the QueueUrl, regardless of the queue's contents.
Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.\n
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 \n \n SendMessage\n 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.
\nCross-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.
\nThe URL of the Amazon SQS queue to delete.
\nQueue URLs and names are case-sensitive.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.sqs#EmptyBatchRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The batch request doesn't contain any entries.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#GetQueueAttributes": { "type": "operation", "input": { "target": "com.amazonaws.sqs#GetQueueAttributesRequest" }, "output": { "target": "com.amazonaws.sqs#GetQueueAttributesResult" }, "errors": [ { "target": "com.amazonaws.sqs#InvalidAttributeName" } ], "traits": { "smithy.api#documentation": "Gets attributes for the specified queue.
\nTo determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
The URL of the Amazon SQS queue whose attribute information is retrieved.
\nQueue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "AttributeNames": { "target": "com.amazonaws.sqs#AttributeNameList", "traits": { "smithy.api#documentation": "A list of attributes for which to retrieve information.
\nIn 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.
\nThe following attributes are supported:
\nThe ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, \n and ApproximateNumberOfMessagesVisible metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is required for \n the queue metadata to reach eventual consistency.
\n All – Returns all values.
\n ApproximateNumberOfMessages – Returns the approximate number of\n messages available for retrieval from the queue.
\n ApproximateNumberOfMessagesDelayed – Returns the approximate number\n of messages in the queue that are delayed and not available for reading\n immediately. This can happen when the queue is configured as a delay queue or\n when a message has been sent with a delay parameter.
\n ApproximateNumberOfMessagesNotVisible – Returns the approximate\n number of messages that are in flight. Messages are considered to be\n in flight if they have been sent to a client but have\n not yet been deleted or have not yet reached the end of their visibility window.
\n CreatedTimestamp – Returns the time when the queue was created in\n seconds (epoch\n time).
\n DelaySeconds – Returns the default delay on the queue in\n seconds.
\n LastModifiedTimestamp – Returns the time when the queue was last\n changed in seconds (epoch\n time).
\n MaximumMessageSize – Returns the limit of how many bytes a message\n can contain before Amazon SQS rejects it.
\n MessageRetentionPeriod – Returns the length of time, in seconds,\n for which Amazon SQS retains a message.
\n Policy – Returns the policy of the queue.
\n QueueArn – Returns the Amazon resource name (ARN) of the\n queue.
\n ReceiveMessageWaitTimeSeconds – Returns the length of time, in\n seconds, for which the ReceiveMessage action waits for a message to\n arrive.
\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon Simple Queue Service Developer Guide.
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.\n When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.\n
The following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n
\n KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again.\n For more information, see How Does the Data Key Reuse Period Work?.\n
The following attributes apply only to FIFO (first-in-first-out) queues:
\n\n FifoQueue – Returns information about whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
\n ContentBasedDeduplication – Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.\n
\n Preview: High throughput for FIFO queues\n
\n\n High throughput for Amazon SQS FIFO queues is in preview release and is subject to change. \n This feature provides a high number of transactions per second (TPS) for messages in FIFO queues. For information on throughput quotas, \n see Quotas related to messages \n in the Amazon Simple Queue Service Developer Guide.
\nThis preview includes two new attributes:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, standard throughput is in effect and deduplication occurs as specified.
\nThis preview is available in the following AWS Regions:
\nUS East (Ohio); us-east-2
\nUS East (N. Virginia); us-east-1
\nUS West (Oregon); us-west-2
\nEurope (Ireland); eu-west-1
\nFor more information about high throughput for FIFO queues, \n see Preview: \n High throughput for FIFO queues in the Amazon Simple Queue Service Developer Guide.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AttributeName" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.sqs#GetQueueAttributesResult": { "type": "structure", "members": { "Attributes": { "target": "com.amazonaws.sqs#QueueAttributeMap", "traits": { "smithy.api#documentation": "A map of attributes to their respective values.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" } } }, "traits": { "smithy.api#documentation": "A list of returned queue attributes.
" } }, "com.amazonaws.sqs#GetQueueUrl": { "type": "operation", "input": { "target": "com.amazonaws.sqs#GetQueueUrlRequest" }, "output": { "target": "com.amazonaws.sqs#GetQueueUrlResult" }, "errors": [ { "target": "com.amazonaws.sqs#QueueDoesNotExist" } ], "traits": { "smithy.api#documentation": "Returns the URL of an existing Amazon SQS queue.
\nTo 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. \n For more information about shared queue access, see \n AddPermission\n or see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.\n
The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_).
Queue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "QueueOwnerAWSAccountId": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The AWS account ID of the account that created the queue.
" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.sqs#GetQueueUrlResult": { "type": "structure", "members": { "QueueUrl": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The URL of the queue.
" } } }, "traits": { "smithy.api#documentation": "For more information, see Interpreting Responses in the Amazon Simple Queue Service Developer Guide.
" } }, "com.amazonaws.sqs#Integer": { "type": "integer" }, "com.amazonaws.sqs#InvalidAttributeName": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The specified attribute doesn't exist.
", "smithy.api#error": "client" } }, "com.amazonaws.sqs#InvalidBatchEntryId": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The Id of a batch entry in a batch request doesn't abide by the specification.
The specified receipt handle isn't valid for the current version.
", "smithy.api#error": "client" } }, "com.amazonaws.sqs#InvalidMessageContents": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The message contains characters outside the allowed set.
", "smithy.api#error": "client" } }, "com.amazonaws.sqs#ListDeadLetterSourceQueues": { "type": "operation", "input": { "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesRequest" }, "output": { "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesResult" }, "errors": [ { "target": "com.amazonaws.sqs#QueueDoesNotExist" } ], "traits": { "smithy.api#documentation": "Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.
The ListDeadLetterSourceQueues methods supports\n pagination. Set parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults,\n the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to\n display, the response includes a value for NextToken. Use\n NextToken as a parameter in your next request to\n ListDeadLetterSourceQueues to receive the next page of results.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon Simple Queue Service Developer Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "queueUrls", "pageSize": "MaxResults" } } }, "com.amazonaws.sqs#ListDeadLetterSourceQueuesRequest": { "type": "structure", "members": { "QueueUrl": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The URL of a dead-letter queue.
\nQueue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.sqs#Token", "traits": { "smithy.api#documentation": "Pagination token to request the next set of results.
" } }, "MaxResults": { "target": "com.amazonaws.sqs#BoxedInteger", "traits": { "smithy.api#documentation": "Maximum number of results to include in the response. Value range is 1 to 1000. \n You must set MaxResults to receive a value for NextToken in the response.
A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.
Pagination token to include in the next request. Token value is null if there are no additional\n results to request, or if you did not set MaxResults in the request.
A list of your dead letter source queues.
" } }, "com.amazonaws.sqs#ListQueueTags": { "type": "operation", "input": { "target": "com.amazonaws.sqs#ListQueueTagsRequest" }, "output": { "target": "com.amazonaws.sqs#ListQueueTagsResult" }, "traits": { "smithy.api#documentation": "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.
\nCross-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.
\nThe URL of the queue.
", "smithy.api#required": {} } } } }, "com.amazonaws.sqs#ListQueueTagsResult": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.sqs#TagMap", "traits": { "smithy.api#documentation": "The list of all tags added to the specified queue.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Tag" } } } }, "com.amazonaws.sqs#ListQueues": { "type": "operation", "input": { "target": "com.amazonaws.sqs#ListQueuesRequest" }, "output": { "target": "com.amazonaws.sqs#ListQueuesResult" }, "traits": { "smithy.api#documentation": "Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional \n QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.
The listQueues methods supports\n pagination. Set parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults,\n the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to\n display, the response includes a value for NextToken. Use\n NextToken as a parameter in your next request to\n listQueues to receive the next page of results.
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.
\nA string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.
\nQueue URLs and names are case-sensitive.
" } }, "NextToken": { "target": "com.amazonaws.sqs#Token", "traits": { "smithy.api#documentation": "Pagination token to request the next set of results.
" } }, "MaxResults": { "target": "com.amazonaws.sqs#BoxedInteger", "traits": { "smithy.api#documentation": "Maximum number of results to include in the response. Value range is 1 to 1000. \n You must set MaxResults to receive a value for NextToken in the response.
Pagination token to include in the next request. Token value is null if there are no additional\n results to request, or if you did not set MaxResults in the request.
A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in the request.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "QueueUrl" } } }, "traits": { "smithy.api#documentation": "A list of your queues.
" } }, "com.amazonaws.sqs#Message": { "type": "structure", "members": { "MessageId": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an extended period of time.
An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
" } }, "MD5OfBody": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message body string.
" } }, "Body": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The message's contents (not URL-encoded).
" } }, "Attributes": { "target": "com.amazonaws.sqs#MessageSystemAttributeMap", "traits": { "smithy.api#documentation": "A map of the attributes requested in \n ReceiveMessage\n to their respective values. \n Supported attributes:
\n ApproximateReceiveCount\n
\n ApproximateFirstReceiveTimestamp\n
\n MessageDeduplicationId\n
\n MessageGroupId\n
\n SenderId\n
\n SentTimestamp\n
\n SequenceNumber\n
\n ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the \n epoch time in milliseconds.
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" } }, "MessageAttributes": { "target": "com.amazonaws.sqs#MessageBodyAttributeMap", "traits": { "smithy.api#documentation": "Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.
An Amazon SQS message.
" } }, "com.amazonaws.sqs#MessageAttributeName": { "type": "string" }, "com.amazonaws.sqs#MessageAttributeNameList": { "type": "list", "member": { "target": "com.amazonaws.sqs#MessageAttributeName" } }, "com.amazonaws.sqs#MessageAttributeValue": { "type": "structure", "members": { "StringValue": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
" } }, "BinaryValue": { "target": "com.amazonaws.sqs#Binary", "traits": { "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
" } }, "StringListValues": { "target": "com.amazonaws.sqs#StringList", "traits": { "smithy.api#documentation": "Not implemented. Reserved for future use.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "StringListValue" } }, "BinaryListValues": { "target": "com.amazonaws.sqs#BinaryList", "traits": { "smithy.api#documentation": "Not implemented. Reserved for future use.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "BinaryListValue" } }, "DataType": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The user-specified message attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see \n SendMessage.\n
\n Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KB or 262,144 bytes).
The specified message isn't in flight.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#MessageSystemAttributeMap": { "type": "map", "key": { "target": "com.amazonaws.sqs#MessageSystemAttributeName", "traits": { "smithy.api#xmlName": "Name" } }, "value": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#xmlName": "Value" } } }, "com.amazonaws.sqs#MessageSystemAttributeName": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SenderId", "name": "SenderId" }, { "value": "SentTimestamp", "name": "SentTimestamp" }, { "value": "ApproximateReceiveCount", "name": "ApproximateReceiveCount" }, { "value": "ApproximateFirstReceiveTimestamp", "name": "ApproximateFirstReceiveTimestamp" }, { "value": "SequenceNumber", "name": "SequenceNumber" }, { "value": "MessageDeduplicationId", "name": "MessageDeduplicationId" }, { "value": "MessageGroupId", "name": "MessageGroupId" }, { "value": "AWSTraceHeader", "name": "AWSTraceHeader" } ] } }, "com.amazonaws.sqs#MessageSystemAttributeNameForSends": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "AWSTraceHeader", "name": "AWSTraceHeader" } ] } }, "com.amazonaws.sqs#MessageSystemAttributeValue": { "type": "structure", "members": { "StringValue": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
" } }, "BinaryValue": { "target": "com.amazonaws.sqs#Binary", "traits": { "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
" } }, "StringListValues": { "target": "com.amazonaws.sqs#StringList", "traits": { "smithy.api#documentation": "Not implemented. Reserved for future use.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "StringListValue" } }, "BinaryListValues": { "target": "com.amazonaws.sqs#BinaryList", "traits": { "smithy.api#documentation": "Not implemented. Reserved for future use.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "BinaryListValue" } }, "DataType": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The user-specified message system attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see \n SendMessage.\n
\n Name, type, value and the message body must not be empty or null.
The specified action violates a limit. For example, ReceiveMessage\n returns this error if the maximum number of inflight messages is reached and\n AddPermission returns this error if the maximum number of permissions\n for the queue is reached.
Deletes the messages in a queue specified by the QueueURL\n parameter.
When you use the PurgeQueue action, you can't retrieve any messages\n deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for\n 60 seconds regardless of your queue's size.
\nMessages sent to the queue before you call\n PurgeQueue might be received but are deleted within the next\n minute.
Messages sent to the queue after you call\n PurgeQueue might be deleted while the queue is being purged.
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).
The URL of the queue from which the PurgeQueue action deletes messages.
Queue URLs and names are case-sensitive.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.sqs#QueueAttributeMap": { "type": "map", "key": { "target": "com.amazonaws.sqs#QueueAttributeName", "traits": { "smithy.api#xmlName": "Name" } }, "value": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#xmlName": "Value" } } }, "com.amazonaws.sqs#QueueAttributeName": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "All", "name": "All" }, { "value": "Policy", "name": "Policy" }, { "value": "VisibilityTimeout", "name": "VisibilityTimeout" }, { "value": "MaximumMessageSize", "name": "MaximumMessageSize" }, { "value": "MessageRetentionPeriod", "name": "MessageRetentionPeriod" }, { "value": "ApproximateNumberOfMessages", "name": "ApproximateNumberOfMessages" }, { "value": "ApproximateNumberOfMessagesNotVisible", "name": "ApproximateNumberOfMessagesNotVisible" }, { "value": "CreatedTimestamp", "name": "CreatedTimestamp" }, { "value": "LastModifiedTimestamp", "name": "LastModifiedTimestamp" }, { "value": "QueueArn", "name": "QueueArn" }, { "value": "ApproximateNumberOfMessagesDelayed", "name": "ApproximateNumberOfMessagesDelayed" }, { "value": "DelaySeconds", "name": "DelaySeconds" }, { "value": "ReceiveMessageWaitTimeSeconds", "name": "ReceiveMessageWaitTimeSeconds" }, { "value": "RedrivePolicy", "name": "RedrivePolicy" }, { "value": "FifoQueue", "name": "FifoQueue" }, { "value": "ContentBasedDeduplication", "name": "ContentBasedDeduplication" }, { "value": "KmsMasterKeyId", "name": "KmsMasterKeyId" }, { "value": "KmsDataKeyReusePeriodSeconds", "name": "KmsDataKeyReusePeriodSeconds" }, { "value": "DeduplicationScope", "name": "DeduplicationScope" }, { "value": "FifoThroughputLimit", "name": "FifoThroughputLimit" } ] } }, "com.amazonaws.sqs#QueueDeletedRecently": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "You must wait 60 seconds after deleting a queue before you can create another queue\n with the same name.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#QueueDoesNotExist": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The specified queue doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#QueueNameExists": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "A queue with this name already exists. Amazon SQS returns this error only if the request\n includes attributes whose values differ from those of the existing queue.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#QueueUrlList": { "type": "list", "member": { "target": "com.amazonaws.sqs#String" } }, "com.amazonaws.sqs#ReceiptHandleIsInvalid": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The specified receipt handle isn't valid.
", "smithy.api#error": "client" } }, "com.amazonaws.sqs#ReceiveMessage": { "type": "operation", "input": { "target": "com.amazonaws.sqs#ReceiveMessageRequest" }, "output": { "target": "com.amazonaws.sqs#ReceiveMessageResult" }, "errors": [ { "target": "com.amazonaws.sqs#OverLimit" } ], "traits": { "smithy.api#documentation": "Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. \n For more information, see Amazon SQS Long Polling in the Amazon Simple Queue Service Developer Guide.\n
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. \n 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, \n you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.\n
For each message returned, the response includes the following:
\nThe message body.
\nAn MD5 digest of the message body. For information about MD5, see RFC1321.
\nThe MessageId you received when you sent the message to the queue.
The receipt handle.
\nThe message attributes.
\nAn MD5 digest of the message attributes.
\nThe receipt handle is the identifier you must provide when deleting the message. For more information, see Queue \n and Message Identifiers in the Amazon Simple Queue Service Developer Guide.
\nYou 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 \n 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.
\nIn 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.
\nThe URL of the Amazon SQS queue from which messages are received.
\nQueue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "AttributeNames": { "target": "com.amazonaws.sqs#AttributeNameList", "traits": { "smithy.api#documentation": "A list of attributes that need to be returned along with each message. These attributes\n include:
\n\n All – Returns all values.
\n ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds).
\n ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted.
\n AWSTraceHeader – Returns the AWS X-Ray trace header string.\n
\n SenderId\n
For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
\n SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds).
\n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.
\n MessageGroupId – Returns the value provided by the producer that\n calls the \n SendMessage\n action. Messages with the\n same MessageGroupId are returned in sequence.
\n SequenceNumber – Returns the value provided by Amazon SQS.
The name of the message attribute, where N is the index.
\nThe name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).
The name is case-sensitive and must be unique among all attribute names for the message.
\nThe name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).
The name must not start or end with a period (.), and it should not have periods in succession (..).
The name can be up to 256 characters long.
\nWhen using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. \n You can also use all message attributes starting with a prefix, for example bar.*.
The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.
" } }, "VisibilityTimeout": { "target": "com.amazonaws.sqs#Integer", "traits": { "smithy.api#documentation": "The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds.\n If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage\n requests is longer than the WaitTimeSeconds parameter. For example,\n with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, \n it is possible to retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.
It is possible to retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, \n it resets the visibility timeout. For more information, see\n Visibility Timeout\n in the Amazon Simple Queue Service Developer Guide.
If a caller of the ReceiveMessage action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
\nWhile messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive\n messages with another MessageGroupId as long as it is also visible.
If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but\n the messages in the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using ReceiveRequestAttemptId, see\n Using the ReceiveRequestAttemptId Request Parameter\n in the Amazon Simple Queue Service Developer Guide.
A list of messages.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Message" } } }, "traits": { "smithy.api#documentation": "A list of received messages.
" } }, "com.amazonaws.sqs#RemovePermission": { "type": "operation", "input": { "target": "com.amazonaws.sqs#RemovePermissionRequest" }, "traits": { "smithy.api#documentation": "Revokes any permissions in the queue policy that matches the specified Label parameter.
Only the owner of a queue can remove permissions from it.
\nCross-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.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
The URL of the Amazon SQS queue from which permissions are removed.
\nQueue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "Label": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The identification of the permission to remove. This is the label added using the \n AddPermission\n action.
Delivers a message to the specified queue.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nDelivers up to ten messages to the specified queue. This is a batch version of \n 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).
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nIf 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:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
The URL of the Amazon SQS queue to which batched messages are sent.
\nQueue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "Entries": { "target": "com.amazonaws.sqs#SendMessageBatchRequestEntryList", "traits": { "smithy.api#documentation": "A list of \n SendMessageBatchRequestEntry\n items.
An identifier for a message in this batch used to communicate the result.
\nThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nThe body of the message.
", "smithy.api#required": {} } }, "DelaySeconds": { "target": "com.amazonaws.sqs#Integer", "traits": { "smithy.api#documentation": "The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished.\n If you don't specify a value, the default value for the queue is applied.\n
When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.
The message system attribute to send Each message system attribute consists of a Name, Type, and Value.
Currently, the only supported message system attribute is AWSTraceHeader.\n Its type must be String and its value must be a correctly formatted\n AWS X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
\nThis parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular \n MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are \n accepted successfully but aren't delivered. For more information, see \n Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same \n MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
\nThe length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see\n Using the MessageDeduplicationId Property\n in the Amazon Simple Queue Service Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
\n ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't \n specify a MessageGroupId.
The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see\n Using the MessageGroupId Property\n in the Amazon Simple Queue Service Developer Guide.
\n MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
Contains the details of a single Amazon SQS message along with an Id.
A list of \n SendMessageBatchResultEntry\n items.
A list of \n BatchResultErrorEntry\n items with error details about each message that can't be enqueued.
For each message in the batch, the response contains a \n SendMessageBatchResultEntry\n tag if the message succeeds or a \n BatchResultErrorEntry\n tag if the message fails.
An identifier for the message in this batch.
", "smithy.api#required": {} } }, "MessageId": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "An identifier for the message.
", "smithy.api#required": {} } }, "MD5OfMessageBody": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
", "smithy.api#required": {} } }, "MD5OfMessageAttributes": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" } }, "MD5OfMessageSystemAttributes": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" } }, "SequenceNumber": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "This parameter applies only to FIFO (first-in-first-out) queues.
\nThe large, non-consecutive number that Amazon SQS assigns to each message.
\nThe length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId.
Encloses a MessageId for a successfully-enqueued message in a \n SendMessageBatch.\n
The URL of the Amazon SQS queue to which a message is sent.
\nQueue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "MessageBody": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The message to send. The minimum size is one character. The maximum size is 256 KB.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\n\n The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished.\n If you don't specify a value, the default value for the queue applies.\n
When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.
The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.
Currently, the only supported message system attribute is AWSTraceHeader.\n Its type must be String and its value must be a correctly formatted\n AWS X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
\nThis parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId \n are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see \n Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same \n MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
\nThe maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see\n Using the MessageDeduplicationId Property\n in the Amazon Simple Queue Service Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
\n ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't \n specify a MessageGroupId.
The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see\n Using the MessageGroupId Property\n in the Amazon Simple Queue Service Developer Guide.
\n MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" } }, "MD5OfMessageAttributes": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" } }, "MD5OfMessageSystemAttributes": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.
" } }, "MessageId": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers\n in the Amazon Simple Queue Service Developer Guide.\n
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe large, non-consecutive number that Amazon SQS assigns to each message.
\nThe length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.
The MD5OfMessageBody and MessageId elements.
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. \n 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.
\nCross-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.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
The URL of the Amazon SQS queue whose attributes are set.
\nQueue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "Attributes": { "target": "com.amazonaws.sqs#QueueAttributeMap", "traits": { "smithy.api#documentation": "A map of attributes to set.
\nThe following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:
\n DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.\n
\n MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).\n
\n MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).\n
\n Policy – The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies \n in the Amazon IAM User Guide.\n
\n ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a \n ReceiveMessage\n action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.\n
\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon Simple Queue Service Developer Guide.
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.\n When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
\n\n VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout,\n see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.
The following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias\n .\n For more examples, see KeyId in the AWS Key Management Service API Reference.\n
\n KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt \n or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security \n but results in more calls to KMS which might incur charges after Free Tier. For more information, see \n How Does the Data Key Reuse Period Work?.\n
The following attribute applies only to FIFO (first-in-first-out) queues:
\n\n ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-Once Processing in the \n Amazon Simple Queue Service Developer Guide. Note the following:\n
Every message must have a unique MessageDeduplicationId.
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
\n Preview: High throughput for FIFO queues\n
\n\n High throughput for Amazon SQS FIFO queues is in preview release and is subject to change. \n This feature provides a high number of transactions per second (TPS) for messages in FIFO queues. For information on throughput quotas, \n see Quotas related to messages \n in the Amazon Simple Queue Service Developer Guide.
\nThis preview includes two new attributes:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, standard throughput is in effect and deduplication occurs as specified.
\nThis preview is available in the following AWS Regions:
\nUS East (Ohio); us-east-2
\nUS East (N. Virginia); us-east-1
\nUS West (Oregon); us-west-2
\nEurope (Ireland); eu-west-1
\nFor more information about high throughput for FIFO queues, \n see Preview: \n High throughput for FIFO queues in the Amazon Simple Queue Service Developer Guide.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" } } }, "traits": { "smithy.api#documentation": "" } }, "com.amazonaws.sqs#String": { "type": "string" }, "com.amazonaws.sqs#StringList": { "type": "list", "member": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#xmlName": "StringListValue" } } }, "com.amazonaws.sqs#TagKey": { "type": "string" }, "com.amazonaws.sqs#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.sqs#TagKey" } }, "com.amazonaws.sqs#TagMap": { "type": "map", "key": { "target": "com.amazonaws.sqs#TagKey", "traits": { "smithy.api#xmlName": "Key" } }, "value": { "target": "com.amazonaws.sqs#TagValue", "traits": { "smithy.api#xmlName": "Value" } } }, "com.amazonaws.sqs#TagQueue": { "type": "operation", "input": { "target": "com.amazonaws.sqs#TagQueueRequest" }, "traits": { "smithy.api#documentation": "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.
\n \nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the existing tag.
\nFor a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
\nCross-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.
\nThe URL of the queue.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.sqs#TagMap", "traits": { "smithy.api#documentation": "The list of tags to be added to the specified queue.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Tag" } } } }, "com.amazonaws.sqs#TagValue": { "type": "string" }, "com.amazonaws.sqs#Token": { "type": "string" }, "com.amazonaws.sqs#TooManyEntriesInBatchRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "The batch request contains more entries than permissible.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#UnsupportedOperation": { "type": "structure", "members": {}, "traits": { "smithy.api#documentation": "Error code 400. Unsupported operation.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#UntagQueue": { "type": "operation", "input": { "target": "com.amazonaws.sqs#UntagQueueRequest" }, "traits": { "smithy.api#documentation": "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.
\nCross-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.
\nThe URL of the queue.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.sqs#TagKeyList", "traits": { "smithy.api#documentation": "The list of tags to be removed from the specified queue.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "TagKey" } } } } } }