Adds a permission to a queue for a specific principal. This allows sharing\n access to the queue.
\nWhen you create a queue, you have full control access rights for the queue. Only you,\n the owner of the queue, can grant or deny permissions to the queue. For more information\n about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS\n Developer Guide.
\n\n AddPermission generates a policy for you. You can use\n \n SetQueueAttributes\n to upload your\n policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in\n the Amazon SQS Developer Guide.
An Amazon SQS policy can have a maximum of seven actions per statement.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Amazon SQS AddPermission does not support adding a non-account\n principal.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS 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,\n AliceSendMessage). Maximum 80 characters. Allowed characters include\n alphanumeric characters, hyphens (-), and underscores\n (_).
The Amazon Web Services account numbers of the principals who are to receive\n permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer\n 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\n name of any action or *.
For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service\n Resource in the Amazon SQS Developer Guide.
\nSpecifying SendMessage, DeleteMessage, or\n ChangeMessageVisibility for ActionName.n also grants\n permissions for the corresponding batch versions of those actions:\n SendMessageBatch, DeleteMessageBatch, and\n ChangeMessageVisibilityBatch.
Welcome to the Amazon SQS API Reference.
\nAmazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel\n between applications or microservices. Amazon SQS moves data between distributed application\n components and helps you decouple these components.
\nFor information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer\n Guide.\n
\nYou can use Amazon Web Services SDKs to access\n Amazon SQS using your favorite programming language. The SDKs perform tasks such as the\n following automatically:
\nCryptographically sign your service requests
\nRetry requests
\nHandle error responses
\n\n Additional information\n
\n\n Amazon SQS 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", "traits": { "smithy.api#default": false } }, "com.amazonaws.sqs#BoxedInteger": { "type": "integer" }, "com.amazonaws.sqs#CancelMessageMoveTask": { "type": "operation", "input": { "target": "com.amazonaws.sqs#CancelMessageMoveTaskRequest" }, "output": { "target": "com.amazonaws.sqs#CancelMessageMoveTaskResult" }, "errors": [ { "target": "com.amazonaws.sqs#InvalidAddress" }, { "target": "com.amazonaws.sqs#InvalidSecurity" }, { "target": "com.amazonaws.sqs#RequestThrottled" }, { "target": "com.amazonaws.sqs#ResourceNotFoundException" }, { "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { "smithy.api#documentation": "Cancels a specified message movement task. A message movement can only be cancelled\n when the current status is RUNNING. Cancelling a message movement task does not revert\n the messages that have already been moved. It can only stop the messages that have not\n been moved yet.
\nThis action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.
\nOnly one active message movement task is supported per queue at any given\n time.
\nAn identifier associated with a message movement task.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sqs#CancelMessageMoveTaskResult": { "type": "structure", "members": { "ApproximateNumberOfMessagesMoved": { "target": "com.amazonaws.sqs#Long", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The approximate number of messages already moved to the destination queue.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sqs#ChangeMessageVisibility": { "type": "operation", "input": { "target": "com.amazonaws.sqs#ChangeMessageVisibilityRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.sqs#InvalidAddress" }, { "target": "com.amazonaws.sqs#InvalidSecurity" }, { "target": "com.amazonaws.sqs#MessageNotInflight" }, { "target": "com.amazonaws.sqs#QueueDoesNotExist" }, { "target": "com.amazonaws.sqs#ReceiptHandleIsInvalid" }, { "target": "com.amazonaws.sqs#RequestThrottled" }, { "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "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 SQS Developer\n Guide.
\nFor example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed\n since you received the message, and you send a ChangeMessageVisibility call with\n VisibilityTimeout set to 10 seconds, the 10 seconds begin to count from\n the time that you make the ChangeMessageVisibility call. Thus, any attempt\n to change the visibility timeout or to delete that message 10 seconds after you\n initially change the visibility timeout (a total of 25 seconds) might result in an\n error.
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 in flight messages.
\nLimits that apply to in flight 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 in flight 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 120,000 in flight 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.
\nIf you attempt to set the VisibilityTimeout to a value greater than\n the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically\n recalculate and increase the timeout to the maximum remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message\n the timeout value is applied immediately but isn't saved in memory for that message.\n If you don't delete a message after it is received, the visibility timeout for the\n message reverts to the original timeout value (not to the value you set using the\n ChangeMessageVisibility action) the next time the message is\n received.
Changes the visibility timeout of multiple messages. This is a batch version of\n \n ChangeMessageVisibility. The result of the action\n on each message is reported individually in the response. You can send up to 10\n \n ChangeMessageVisibility\n requests with each\n 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.
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": "Lists the receipt handles of the messages for which the visibility timeout must be\n changed.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "ChangeMessageVisibilityBatchRequestEntry" } } }, "traits": { "smithy.api#documentation": "", "smithy.api#input": {} } }, "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\n 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#NullableInteger", "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
A list of \n ChangeMessageVisibilityBatchResultEntry\n \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\n succeeds or a \n BatchResultErrorEntry\n tag if the message\n 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.\n This parameter is returned by the \n ReceiveMessage\n \n action.
The new value for the message's visibility timeout (in seconds). Values range:\n 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 SQS Developer Guide.
\nIf you don't provide a value for an attribute, the queue is created with the\n default value for the attribute.
\nIf you delete a queue, you must wait at least 60 seconds before creating a\n queue with the same name.
\nTo successfully create a new queue, you must provide a queue name that adheres to the\n limits\n 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 retrieve the URL of a queue, use the \n GetQueueUrl\n action. This action only requires the \n QueueName\n parameter.
When creating queues, keep the following points in mind:
\nIf you specify the name of an existing queue and provide the exact same names\n and values for all its attributes, the \n CreateQueue\n action will return the URL of the\n existing queue instead of creating a new one.
If you attempt to create a queue with a name that already exists but with\n different attribute names or values, the CreateQueue action will\n return an error. This ensures that existing queues are not inadvertently\n altered.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS 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\n underscores (_).
A FIFO queue name must end with the .fifo suffix.
Queue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "Attributes": { "target": "com.amazonaws.sqs#QueueAttributeMap", "traits": { "smithy.api#documentation": "A map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the CreateQueue action uses:
\n DelaySeconds – The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 seconds (15 minutes). Default: 0.
\n MaximumMessageSize – The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) to 1,048,576 bytes (1 MiB). Default: 1,048,576 bytes (1 MiB).
\n MessageRetentionPeriod – The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1\n minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the IAM User Guide.
\n ReceiveMessageWaitTimeSeconds – The length of time, in\n seconds, for which a \n ReceiveMessage\n action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.
\n VisibilityTimeout – The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n 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 \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll – No source queues can specify this queue as the dead-letter\n queue.
\n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is\n always alias/aws/sqs, the alias of a custom CMK can, for example,\n be alias/MyAlias\n . For more examples, see\n KeyId in the Key Management Service API\n Reference.
\n KmsDataKeyReusePeriodSeconds – The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n 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\n more information, see How Does the Data Key Reuse Period Work?\n
\n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out)\n queues:
\n\n FifoQueue – Designates a queue as FIFO. Valid values are\n true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You\n can provide this attribute only during queue creation. You can't change it for\n an existing queue. When you set this attribute, you must also provide the\n MessageGroupId for your messages explicitly.
For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.
\n\n ContentBasedDeduplication – Enables content-based\n deduplication. Valid values are true and false. For\n more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:
Every message must have a unique\n MessageDeduplicationId.
You may provide a MessageDeduplicationId\n explicitly.
If you aren't able to provide a\n MessageDeduplicationId and you enable\n ContentBasedDeduplication for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the\n message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and\n the queue doesn't have ContentBasedDeduplication\n set, the action fails with an error.
If the queue has ContentBasedDeduplication set,\n your MessageDeduplicationId overrides the generated\n one.
When ContentBasedDeduplication is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.
If you send one message with ContentBasedDeduplication\n enabled and then another message with a\n MessageDeduplicationId that is the same as the one\n generated for the first MessageDeduplicationId, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\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, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" } }, "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 \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\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 \nQuotas related to queues \nin the Amazon SQS 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, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nThe 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.
Each time you receive a message, meaning when a consumer retrieves a message from\n the queue, it comes with a unique ReceiptHandle. If you receive the\n same message more than once, you will get a different ReceiptHandle\n each time. When you want to delete a message using the DeleteMessage\n action, you must use the ReceiptHandle from the most recent time you\n received the message. If you use an old ReceiptHandle, the request will\n succeed, 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 \n DeleteMessage. The result of the action on each\n 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 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": "Lists the receipt handles for the messages to be deleted.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "DeleteMessageBatchRequestEntry" } } }, "traits": { "smithy.api#documentation": "", "smithy.api#input": {} } }, "com.amazonaws.sqs#DeleteMessageBatchRequestEntry": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The identifier for this particular receipt handle. This is used to communicate the\n 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\n or a \n BatchResultErrorEntry\n tag if the message can't be\n 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": "", "smithy.api#input": {} } }, "com.amazonaws.sqs#DeleteQueue": { "type": "operation", "input": { "target": "com.amazonaws.sqs#DeleteQueueRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.sqs#InvalidAddress" }, { "target": "com.amazonaws.sqs#InvalidSecurity" }, { "target": "com.amazonaws.sqs#QueueDoesNotExist" }, { "target": "com.amazonaws.sqs#RequestThrottled" }, { "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { "smithy.api#documentation": "Deletes the queue specified by the QueueUrl, regardless of the queue's\n contents.
Be careful with the DeleteQueue action: When you delete a queue, any\n messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you\n send involving that queue during the 60 seconds might succeed. For example, a\n \n SendMessage\n request might succeed, but after 60\n 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\n with the same name.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nThe delete operation uses the HTTP GET verb.
The URL of the Amazon SQS queue to delete.
\nQueue URLs and names are case-sensitive.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "", "smithy.api#input": {} } }, "com.amazonaws.sqs#EmptyBatchRequest": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "AWS.SimpleQueueService.EmptyBatchRequest", "httpResponseCode": 400 }, "smithy.api#documentation": "The batch request doesn't contain any entries.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#ExceptionMessage": { "type": "string" }, "com.amazonaws.sqs#GetQueueAttributes": { "type": "operation", "input": { "target": "com.amazonaws.sqs#GetQueueAttributesRequest" }, "output": { "target": "com.amazonaws.sqs#GetQueueAttributesResult" }, "errors": [ { "target": "com.amazonaws.sqs#InvalidAddress" }, { "target": "com.amazonaws.sqs#InvalidAttributeName" }, { "target": "com.amazonaws.sqs#InvalidSecurity" }, { "target": "com.amazonaws.sqs#QueueDoesNotExist" }, { "target": "com.amazonaws.sqs#RequestThrottled" }, { "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "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.
\nThe AttributeNames parameter is optional, but if you don't specify values\n for this parameter, the request returns empty results.
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.
\nThe following attributes are supported:
\nThe ApproximateNumberOfMessagesDelayed,\n ApproximateNumberOfMessagesNotVisible, and\n ApproximateNumberOfMessages metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is\n required for the queue metadata to reach eventual consistency.
\n All – Returns all values.
\n ApproximateNumberOfMessages – Returns the approximate\n number of messages available for retrieval from the queue.
\n ApproximateNumberOfMessagesDelayed – Returns the\n approximate number of messages in the queue that are delayed and not available\n for reading immediately. This can happen when the queue is configured as a delay\n queue or when a message has been sent with a delay parameter.
\n ApproximateNumberOfMessagesNotVisible – Returns the\n approximate 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
\n CreatedTimestamp – Returns the time when the queue was\n created in seconds (epoch\n time).
\n DelaySeconds – Returns the default delay on the queue in\n seconds.
\n LastModifiedTimestamp – Returns the time when the queue\n was last changed in seconds (epoch time).
\n MaximumMessageSize – Returns the limit of how many bytes a\n message can contain before Amazon SQS rejects it.
\n MessageRetentionPeriod – Returns the length of time, in\n seconds, for which Amazon SQS retains a message. When you change a queue's\n attributes, the change can take up to 60 seconds for most of the attributes to\n propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.
\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\n time, in seconds, for which the ReceiveMessage action waits for a\n message to arrive.
\n VisibilityTimeout – Returns the visibility timeout for the\n queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n 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 \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll – No source queues can specify this queue as the dead-letter\n queue.
\n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer\n master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
\n KmsDataKeyReusePeriodSeconds – Returns the length of time,\n in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt\n messages before calling KMS again. For more information, see\n How Does the Data Key Reuse Period Work?.
\n SqsManagedSseEnabled – Returns information about whether the\n queue is using SSE-SQS encryption using SQS owned encryption keys. Only one\n server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out)\n queues:
\n\n FifoQueue – Returns information about whether the queue is\n FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.
To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
\n ContentBasedDeduplication – Returns whether content-based\n deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\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, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AttributeName" } } }, "traits": { "smithy.api#documentation": "", "smithy.api#input": {} } }, "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.
", "smithy.api#output": {} } }, "com.amazonaws.sqs#GetQueueUrl": { "type": "operation", "input": { "target": "com.amazonaws.sqs#GetQueueUrlRequest" }, "output": { "target": "com.amazonaws.sqs#GetQueueUrlResult" }, "errors": [ { "target": "com.amazonaws.sqs#InvalidAddress" }, { "target": "com.amazonaws.sqs#InvalidSecurity" }, { "target": "com.amazonaws.sqs#QueueDoesNotExist" }, { "target": "com.amazonaws.sqs#RequestThrottled" }, { "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { "smithy.api#documentation": "The GetQueueUrl API returns the URL of an existing Amazon SQS queue. This is\n useful when you know the queue's name but need to retrieve its URL for further\n operations.
To access a queue owned by another Amazon Web Services account, use the\n QueueOwnerAWSAccountId parameter to specify the account ID of the\n queue's owner. Note that the queue owner must grant you the necessary permissions to\n access the queue. For more information about accessing shared queues, see the\n \n AddPermission\n API or Allow developers to write messages to a shared queue in the Amazon SQS\n Developer Guide.
(Required) The name of the queue for which you want to fetch the URL. The name can be\n up to 80 characters long and can include alphanumeric characters, hyphens (-), and\n underscores (_). Queue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "QueueOwnerAWSAccountId": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "(Optional) The Amazon Web Services account ID of the account that created the queue. This is only\n required when you are attempting to access a queue owned by another\n Amazon Web Services account.
" } } }, "traits": { "smithy.api#documentation": "Retrieves the URL of an existing queue based on its name and, optionally, the Amazon Web Services\n account ID.
", "smithy.api#input": {} } }, "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 SQS Developer\n Guide.
", "smithy.api#output": {} } }, "com.amazonaws.sqs#InvalidAddress": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidAddress", "httpResponseCode": 404 }, "smithy.api#documentation": "The specified ID is invalid.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.sqs#InvalidAttributeName": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The specified attribute doesn't exist.
", "smithy.api#error": "client" } }, "com.amazonaws.sqs#InvalidAttributeValue": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "A queue attribute value is invalid.
", "smithy.api#error": "client" } }, "com.amazonaws.sqs#InvalidBatchEntryId": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "AWS.SimpleQueueService.InvalidBatchEntryId", "httpResponseCode": 400 }, "smithy.api#documentation": "The Id of a batch entry in a batch request doesn't abide by the\n specification.
The specified receipt handle isn't valid for the current version.
", "smithy.api#error": "client" } }, "com.amazonaws.sqs#InvalidMessageContents": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "smithy.api#documentation": "The message contains characters outside the allowed set.
", "smithy.api#error": "client" } }, "com.amazonaws.sqs#InvalidSecurity": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "InvalidSecurity", "httpResponseCode": 403 }, "smithy.api#documentation": "The request was not made over HTTPS or did not use SigV4 for signing.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.sqs#KmsAccessDenied": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "KMS.AccessDeniedException", "httpResponseCode": 400 }, "smithy.api#documentation": "The caller doesn't have the required KMS access.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#KmsDisabled": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "KMS.DisabledException", "httpResponseCode": 400 }, "smithy.api#documentation": "The request was denied due to request throttling.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#KmsInvalidKeyUsage": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "KMS.InvalidKeyUsageException", "httpResponseCode": 400 }, "smithy.api#documentation": "The request was rejected for one of the following reasons:
\nThe KeyUsage value of the KMS key is incompatible with the API\n operation.
\nThe encryption algorithm or signing algorithm specified for the operation is\n incompatible with the type of key material in the KMS key (KeySpec).
\nThe request was rejected because the state of the specified resource is not valid for\n this request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#KmsNotFound": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "KMS.NotFoundException", "httpResponseCode": 400 }, "smithy.api#documentation": "The request was rejected because the specified entity or resource could not be found.\n
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#KmsOptInRequired": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "KMS.OptInRequired", "httpResponseCode": 403 }, "smithy.api#documentation": "The request was rejected because the specified key policy isn't syntactically or\n semantically correct.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.sqs#KmsThrottled": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "KMS.ThrottlingException", "httpResponseCode": 400 }, "smithy.api#documentation": "Amazon Web Services KMS throttles requests for the following conditions.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#ListDeadLetterSourceQueues": { "type": "operation", "input": { "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesRequest" }, "output": { "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesResult" }, "errors": [ { "target": "com.amazonaws.sqs#InvalidAddress" }, { "target": "com.amazonaws.sqs#InvalidSecurity" }, { "target": "com.amazonaws.sqs#QueueDoesNotExist" }, { "target": "com.amazonaws.sqs#RequestThrottled" }, { "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { "smithy.api#documentation": "Returns a list of your queues that have the RedrivePolicy queue attribute\n configured with a dead-letter queue.
The ListDeadLetterSourceQueues methods supports pagination. Set\n 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, the\n response includes a maximum of 1,000 results. If you set MaxResults and\n there are additional results to display, the response includes a value for\n NextToken. Use NextToken as a parameter in your next\n request to ListDeadLetterSourceQueues to receive the next page of results.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer\n 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. You\n must set MaxResults to receive a value for NextToken in the\n response.
A list of source queue URLs that have the RedrivePolicy queue attribute\n configured with a dead-letter queue.
Pagination token to include in the next request. Token value is null if\n there are no additional results to request, or if you did not set\n MaxResults in the request.
A list of your dead letter source queues.
", "smithy.api#output": {} } }, "com.amazonaws.sqs#ListMessageMoveTasks": { "type": "operation", "input": { "target": "com.amazonaws.sqs#ListMessageMoveTasksRequest" }, "output": { "target": "com.amazonaws.sqs#ListMessageMoveTasksResult" }, "errors": [ { "target": "com.amazonaws.sqs#InvalidAddress" }, { "target": "com.amazonaws.sqs#InvalidSecurity" }, { "target": "com.amazonaws.sqs#RequestThrottled" }, { "target": "com.amazonaws.sqs#ResourceNotFoundException" }, { "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { "smithy.api#documentation": "Gets the most recent message movement tasks (up to 10) under a specific source\n queue.
\nThis action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.
\nOnly one active message movement task is supported per queue at any given\n time.
\nThe ARN of the queue whose message movement tasks are to be listed.
", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.sqs#NullableInteger", "traits": { "smithy.api#documentation": "The maximum number of results to include in the response. The default is 1, which\n provides the most recent message movement task. The upper limit is 10.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sqs#ListMessageMoveTasksResult": { "type": "structure", "members": { "Results": { "target": "com.amazonaws.sqs#ListMessageMoveTasksResultEntryList", "traits": { "smithy.api#documentation": "A list of message movement tasks and their attributes.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "ListMessageMoveTasksResultEntry" } } }, "traits": { "smithy.api#output": {}, "smithy.api#xmlName": "ListMessageMoveTasksResult" } }, "com.amazonaws.sqs#ListMessageMoveTasksResultEntry": { "type": "structure", "members": { "TaskHandle": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "An identifier associated with a message movement task. When this field is returned in\n the response of the ListMessageMoveTasks action, it is only populated for\n tasks that are in RUNNING status.
The status of the message movement task. Possible values are: RUNNING, COMPLETED,\n CANCELLING, CANCELLED, and FAILED.
" } }, "SourceArn": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The ARN of the queue that contains the messages to be moved to another queue.
" } }, "DestinationArn": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The ARN of the destination queue if it has been specified in the\n StartMessageMoveTask request. If a DestinationArn has not\n been specified in the StartMessageMoveTask request, this field value will\n be NULL.
The number of messages to be moved per second (the message movement rate), if it has\n been specified in the StartMessageMoveTask request. If a\n MaxNumberOfMessagesPerSecond has not been specified in the\n StartMessageMoveTask request, this field value will be NULL.
The approximate number of messages already moved to the destination queue.
" } }, "ApproximateNumberOfMessagesToMove": { "target": "com.amazonaws.sqs#NullableLong", "traits": { "smithy.api#documentation": "The number of messages to be moved from the source queue. This number is obtained at\n the time of starting the message movement task and is only included after the message\n movement task is selected to start.
" } }, "FailureReason": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The task failure reason (only included if the task status is FAILED).
" } }, "StartedTimestamp": { "target": "com.amazonaws.sqs#Long", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The timestamp of starting the message movement task.
" } } }, "traits": { "smithy.api#documentation": "Contains the details of a message movement task.
" } }, "com.amazonaws.sqs#ListMessageMoveTasksResultEntryList": { "type": "list", "member": { "target": "com.amazonaws.sqs#ListMessageMoveTasksResultEntry" } }, "com.amazonaws.sqs#ListQueueTags": { "type": "operation", "input": { "target": "com.amazonaws.sqs#ListQueueTagsRequest" }, "output": { "target": "com.amazonaws.sqs#ListQueueTagsResult" }, "errors": [ { "target": "com.amazonaws.sqs#InvalidAddress" }, { "target": "com.amazonaws.sqs#InvalidSecurity" }, { "target": "com.amazonaws.sqs#QueueDoesNotExist" }, { "target": "com.amazonaws.sqs#RequestThrottled" }, { "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { "smithy.api#documentation": "List all cost allocation tags added to the specified Amazon SQS queue.\n For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nThe URL of the queue.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "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" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.sqs#ListQueues": { "type": "operation", "input": { "target": "com.amazonaws.sqs#ListQueuesRequest" }, "output": { "target": "com.amazonaws.sqs#ListQueuesResult" }, "errors": [ { "target": "com.amazonaws.sqs#InvalidAddress" }, { "target": "com.amazonaws.sqs#InvalidSecurity" }, { "target": "com.amazonaws.sqs#RequestThrottled" }, { "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { "smithy.api#documentation": "Returns a list of your queues in the current region. The response includes a maximum\n of 1,000 results. If you specify a value for the optional QueueNamePrefix\n parameter, only queues with a name that begins with the specified value are\n returned.
The listQueues methods supports pagination. Set parameter\n MaxResults in the request to specify the maximum number of results to\n be returned in the response. If you do not set MaxResults, the response\n includes a maximum of 1,000 results. If you set MaxResults and there are\n additional results to display, the response includes a value for NextToken.\n Use 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, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nA string to use for filtering the list results. Only those queues whose name begins\n 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. You\n must set MaxResults to receive a value for NextToken in the\n response.
A list of queue URLs, up to 1,000 entries, or the value of MaxResults\n that you sent in the request.
Pagination token to include in the next request. Token value is null if\n there are no additional results to request, or if you did not set\n MaxResults in the request.
A list of your queues.
", "smithy.api#output": {} } }, "com.amazonaws.sqs#Long": { "type": "long", "traits": { "smithy.api#default": 0 } }, "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\n across all Amazon Web Services accounts for an extended period of time.
An identifier associated with the act of receiving the message. A new receipt handle\n is returned every time you receive a message. When deleting a message, you provide the\n 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\n their respective values. 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\n returned as an integer representing the epoch time in\n 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, \nand Value. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS 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\n Characters.
" } }, "BinaryValue": { "target": "com.amazonaws.sqs#Binary", "traits": { "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted\n 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,\n Number, and Binary. For the Number data type,\n you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The user-specified message attribute value. For string data types, the\n Value attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.\n
\n Name, type, value and the message body must not\n be empty or null. All parts of the message attribute, including Name,\n Type, and Value, are part of the message size restriction\n (1 MiB or 1,048,576 bytes).
The specified message isn't in flight.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#MessageSystemAttributeList": { "type": "list", "member": { "target": "com.amazonaws.sqs#MessageSystemAttributeName" } }, "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": "enum", "members": { "All": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "All" } }, "SenderId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SenderId" } }, "SentTimestamp": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SentTimestamp" } }, "ApproximateReceiveCount": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ApproximateReceiveCount" } }, "ApproximateFirstReceiveTimestamp": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ApproximateFirstReceiveTimestamp" } }, "SequenceNumber": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SequenceNumber" } }, "MessageDeduplicationId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MessageDeduplicationId" } }, "MessageGroupId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MessageGroupId" } }, "AWSTraceHeader": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWSTraceHeader" } }, "DeadLetterQueueSourceArn": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeadLetterQueueSourceArn" } } } }, "com.amazonaws.sqs#MessageSystemAttributeNameForSends": { "type": "enum", "members": { "AWSTraceHeader": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "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\n Characters.
" } }, "BinaryValue": { "target": "com.amazonaws.sqs#Binary", "traits": { "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted\n 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,\n Number, and Binary. For the Number data type,\n you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The user-specified message system attribute value. For string data types, the\n Value attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.\n
\n Name, type, value and the message body must not\n be empty or null.
The specified action violates a limit. For example, ReceiveMessage\n returns this error if the maximum number of in flight messages is reached and\n AddPermission returns this error if the maximum number of permissions\n for the queue is reached.
Deletes available messages in a queue (including in-flight messages) specified by the\n QueueURL 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 60\n 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 PurgeQueue\n might be deleted while the queue is being purged.
Indicates that the specified queue previously received a PurgeQueue\n request within the last 60 seconds (the time it can take to delete the messages in the\n queue).
The URL of the queue from which the PurgeQueue action deletes\n messages.
Queue URLs and names are case-sensitive.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "", "smithy.api#input": {} } }, "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": "enum", "members": { "All": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "All" } }, "Policy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Policy" } }, "VisibilityTimeout": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "VisibilityTimeout" } }, "MaximumMessageSize": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MaximumMessageSize" } }, "MessageRetentionPeriod": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MessageRetentionPeriod" } }, "ApproximateNumberOfMessages": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ApproximateNumberOfMessages" } }, "ApproximateNumberOfMessagesNotVisible": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ApproximateNumberOfMessagesNotVisible" } }, "CreatedTimestamp": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CreatedTimestamp" } }, "LastModifiedTimestamp": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LastModifiedTimestamp" } }, "QueueArn": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QueueArn" } }, "ApproximateNumberOfMessagesDelayed": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ApproximateNumberOfMessagesDelayed" } }, "DelaySeconds": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DelaySeconds" } }, "ReceiveMessageWaitTimeSeconds": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ReceiveMessageWaitTimeSeconds" } }, "RedrivePolicy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RedrivePolicy" } }, "FifoQueue": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FifoQueue" } }, "ContentBasedDeduplication": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ContentBasedDeduplication" } }, "KmsMasterKeyId": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KmsMasterKeyId" } }, "KmsDataKeyReusePeriodSeconds": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "KmsDataKeyReusePeriodSeconds" } }, "DeduplicationScope": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DeduplicationScope" } }, "FifoThroughputLimit": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FifoThroughputLimit" } }, "RedriveAllowPolicy": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RedriveAllowPolicy" } }, "SqsManagedSseEnabled": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SqsManagedSseEnabled" } } } }, "com.amazonaws.sqs#QueueDeletedRecently": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "AWS.SimpleQueueService.QueueDeletedRecently", "httpResponseCode": 400 }, "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": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "AWS.SimpleQueueService.NonExistentQueue", "httpResponseCode": 400 }, "smithy.api#documentation": "Ensure that the QueueUrl is correct and that the queue has not been\n deleted.
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": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "ReceiptHandleIsInvalid", "httpResponseCode": 404 }, "smithy.api#documentation": "The specified receipt handle isn't valid.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.sqs#ReceiveMessage": { "type": "operation", "input": { "target": "com.amazonaws.sqs#ReceiveMessageRequest" }, "output": { "target": "com.amazonaws.sqs#ReceiveMessageResult" }, "errors": [ { "target": "com.amazonaws.sqs#InvalidAddress" }, { "target": "com.amazonaws.sqs#InvalidSecurity" }, { "target": "com.amazonaws.sqs#KmsAccessDenied" }, { "target": "com.amazonaws.sqs#KmsDisabled" }, { "target": "com.amazonaws.sqs#KmsInvalidKeyUsage" }, { "target": "com.amazonaws.sqs#KmsInvalidState" }, { "target": "com.amazonaws.sqs#KmsNotFound" }, { "target": "com.amazonaws.sqs#KmsOptInRequired" }, { "target": "com.amazonaws.sqs#KmsThrottled" }, { "target": "com.amazonaws.sqs#OverLimit" }, { "target": "com.amazonaws.sqs#QueueDoesNotExist" }, { "target": "com.amazonaws.sqs#RequestThrottled" }, { "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { "smithy.api#documentation": "Retrieves one or more messages (up to 10), from the specified queue. Using the\n WaitTimeSeconds parameter enables long-poll support. For more\n information, see Amazon SQS\n Long Polling in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled\n on a ReceiveMessage call. Therefore, only the messages on the sampled\n machines are returned. If the number of messages in the queue is small (fewer than\n 1,000), you most likely get fewer messages than you requested per\n ReceiveMessage call. If the number of messages in the queue is\n extremely small, you might not receive any messages in a particular\n ReceiveMessage response. If this happens, repeat the request.
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\n 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\n more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.
\nYou can provide the VisibilityTimeout parameter in your request. The\n parameter is applied to the messages that Amazon SQS returns in the response. If you don't\n include the parameter, the overall visibility timeout for the queue is used for the\n returned messages. The default visibility timeout for a queue is 30 seconds.
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.
\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#deprecated": { "message": "AttributeNames has been replaced by MessageSystemAttributeNames" }, "smithy.api#documentation": "This parameter has been discontinued but will be supported for backward\n compatibility. To provide attribute names, you are encouraged to use\n MessageSystemAttributeNames.
A list of attributes that need to be returned along with each message. These\n attributes include:
\n\n All – Returns all values.
\n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).
\n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.
\n AWSTraceHeader – Returns the X-Ray trace\n header string.
\n SenderId\n
For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.
For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
\n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).
\n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
\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\n producer that calls the \n SendMessage\n action.\n
\n SequenceNumber – Returns the value provided by\n Amazon SQS.
A list of attributes that need to be returned along with each message. These\n attributes include:
\n\n All – Returns all values.
\n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).
\n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.
\n AWSTraceHeader – Returns the X-Ray trace\n header string.
\n SenderId\n
For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.
For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
\n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).
\n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
\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\n producer that calls the \n SendMessage\n action.
\n SequenceNumber – Returns the value provided by\n Amazon SQS.
The name of the message attribute, where N is the index.
\nThe name can contain alphanumeric characters and the underscore\n (_), hyphen (-), and period\n (.).
The name is case-sensitive and must be unique among all attribute names for\n the message.
\nThe name must not start with AWS-reserved prefixes such as AWS.\n or Amazon. (or any casing variants).
The name must not start or end with a period (.), and it should\n 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\n receive, or you can return all of the attributes by specifying All or\n .* in your request. You can also use all message attributes starting\n with a prefix, for example bar.*.
The maximum number of messages to return. Amazon SQS never returns more messages than this\n value (however, fewer messages might be returned). Valid values: 1 to 10. Default:\n 1.
" } }, "VisibilityTimeout": { "target": "com.amazonaws.sqs#NullableInteger", "traits": { "smithy.api#documentation": "The duration (in seconds) that the received messages are hidden from subsequent\n retrieve requests after being retrieved by a ReceiveMessage request. If not\n specified, the default visibility timeout for the queue is used, which is 30\n seconds.
Understanding VisibilityTimeout:
When a message is received from a queue, it becomes temporarily invisible to\n other consumers for the duration of the visibility timeout. This prevents\n multiple consumers from processing the same message simultaneously. If the\n message is not deleted or its visibility timeout is not extended before the\n timeout expires, it becomes visible again and can be retrieved by other\n consumers.
\nSetting an appropriate visibility timeout is crucial. If it's too short, the\n message might become visible again before processing is complete, leading to\n duplicate processing. If it's too long, it delays the reprocessing of messages\n if the initial processing fails.
\nYou can adjust the visibility timeout using the\n --visibility-timeout parameter in the\n receive-message command to match the processing time required\n by your application.
A message that isn't deleted or a message whose visibility isn't extended\n before the visibility timeout expires counts as a failed receive. Depending on\n the configuration of the queue, the message might be sent to the dead-letter\n queue.
\nFor more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
" } }, "WaitTimeSeconds": { "target": "com.amazonaws.sqs#NullableInteger", "traits": { "smithy.api#documentation": "The duration (in seconds) for which the call waits for a message to arrive in the\n queue before returning. If a message is available, the call returns sooner than\n WaitTimeSeconds. If no messages are available and the wait time\n expires, the call does not return a message list. If you are using the Java SDK, it\n returns a ReceiveMessageResponse object, which has a empty list instead of\n a Null object.
To avoid HTTP errors, ensure that the HTTP response timeout for\n ReceiveMessage requests is longer than the\n WaitTimeSeconds parameter. For example, with the Java SDK, you can\n 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\n issue occurs after a ReceiveMessage action, and instead of a response you\n receive a generic error, it is possible to retry the same action with an identical\n ReceiveRequestAttemptId to retrieve the same set of messages, even if\n their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId only for 5 minutes after a\n ReceiveMessage action.
When you set FifoQueue, a caller of the\n ReceiveMessage action can provide a\n ReceiveRequestAttemptId explicitly.
It is possible to retry the ReceiveMessage action with the same\n ReceiveRequestAttemptId if none of the messages have been\n modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same\n ReceiveRequestAttemptId return the same messages and receipt\n handles. If a retry occurs within the deduplication interval, it resets the\n visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer\n 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\n threshold before the visibility timeout expires and extend the visibility\n timeout as necessary.
\nWhile messages with a particular MessageGroupId are invisible, \n no more messages belonging to the same MessageGroupId are returned \n until the visibility timeout expires. You can still receive messages \n with another MessageGroupId from your FIFO queue as long as they are visible.
If a caller of ReceiveMessage can't track the\n ReceiveRequestAttemptId, no retries work until the original\n visibility timeout expires. As a result, delays might occur but the messages in\n the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId is 128 characters.\n ReceiveRequestAttemptId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS\n Developer Guide.
Retrieves one or more messages from a specified queue.
", "smithy.api#input": {} } }, "com.amazonaws.sqs#ReceiveMessageResult": { "type": "structure", "members": { "Messages": { "target": "com.amazonaws.sqs#MessageList", "traits": { "smithy.api#documentation": "A list of messages.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Message" } } }, "traits": { "smithy.api#documentation": "A list of received messages.
", "smithy.api#output": {} } }, "com.amazonaws.sqs#RemovePermission": { "type": "operation", "input": { "target": "com.amazonaws.sqs#RemovePermissionRequest" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.sqs#InvalidAddress" }, { "target": "com.amazonaws.sqs#InvalidSecurity" }, { "target": "com.amazonaws.sqs#QueueDoesNotExist" }, { "target": "com.amazonaws.sqs#RequestThrottled" }, { "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { "smithy.api#documentation": "Revokes any permissions in the queue policy that matches the specified\n 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, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS 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 \n AddPermission\n action.
The request was denied due to request throttling.
\nExceeds the permitted request rate for the queue or for the recipient of the\n request.
\nEnsure that the request rate is within the Amazon SQS limits for\n sending messages. For more information, see Amazon SQS quotas in the Amazon SQS\n Developer Guide.
\nOne or more specified resources don't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.sqs#SendMessage": { "type": "operation", "input": { "target": "com.amazonaws.sqs#SendMessageRequest" }, "output": { "target": "com.amazonaws.sqs#SendMessageResult" }, "errors": [ { "target": "com.amazonaws.sqs#InvalidAddress" }, { "target": "com.amazonaws.sqs#InvalidMessageContents" }, { "target": "com.amazonaws.sqs#InvalidSecurity" }, { "target": "com.amazonaws.sqs#KmsAccessDenied" }, { "target": "com.amazonaws.sqs#KmsDisabled" }, { "target": "com.amazonaws.sqs#KmsInvalidKeyUsage" }, { "target": "com.amazonaws.sqs#KmsInvalidState" }, { "target": "com.amazonaws.sqs#KmsNotFound" }, { "target": "com.amazonaws.sqs#KmsOptInRequired" }, { "target": "com.amazonaws.sqs#KmsThrottled" }, { "target": "com.amazonaws.sqs#QueueDoesNotExist" }, { "target": "com.amazonaws.sqs#RequestThrottled" }, { "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { "smithy.api#documentation": "Delivers a message to the specified queue.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.
\nYou can use SendMessageBatch to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.
The result of sending each message is reported individually in the response.\n 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\n sum of the individual lengths of all of the batched messages) are both 1 MiB \n 1,048,576 bytes.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.
\nIf you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses\n the default value for the queue.
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#NullableInteger", "traits": { "smithy.api#documentation": "The length of time, in seconds, for which a specific message is delayed. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue is applied.
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, \nand Value. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS 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 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\n interval. If a message with a particular MessageDeduplicationId is sent\n successfully, subsequent messages with the same MessageDeduplicationId are\n accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId\n explicitly.
If you aren't able to provide a MessageDeduplicationId\n and you enable ContentBasedDeduplication for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the\n queue doesn't have ContentBasedDeduplication set, the\n action fails with an error.
If the queue has ContentBasedDeduplication set, your\n MessageDeduplicationId overrides the generated\n one.
When ContentBasedDeduplication is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled\n and then another message with a MessageDeduplicationId that is the\n same as the one generated for the first MessageDeduplicationId, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.
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\n is resent with the same MessageDeduplicationId after the deduplication\n 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.\n MessageDeduplicationId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.
\n MessageGroupId is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues. \n In FIFO queues, MessageGroupId organizes messages into distinct groups. \n Messages within the same message group are always processed one at a time, in strict order, \n ensuring that no two messages from the same group are processed simultaneously. \n In standard queues, using MessageGroupId enables fair queues. \n It is used to identify the tenant a message belongs to, \n helping maintain consistent message dwell time across all tenants during noisy neighbor events. \n Unlike FIFO queues, messages with the same MessageGroupId can be processed in parallel, \n maintaining the high throughput of standard queues.
\n FIFO queues:\n MessageGroupId acts as the tag \n that specifies that a message belongs to a specific message group. \n Messages that belong to the same message group are processed in a FIFO manner \n (however, messages in different message groups might be processed out of order). \n To interleave multiple ordered streams within a single queue, use MessageGroupId values \n (for example, session data for multiple users). \n In this scenario, multiple consumers can process the queue, \n but the session data of each user is processed in a FIFO fashion.
If you do not provide a MessageGroupId when sending a message to a FIFO queue, the action fails.
\n ReceiveMessage might return messages with multiple MessageGroupId values. \n For each MessageGroupId, the messages are sorted by time sent.
\n Standard queues:Use MessageGroupId in standard queues to enable fair queues. \n The MessageGroupId identifies the tenant a message belongs to. \n A tenant can be any entity that shares a queue with others, such as your customer, a client application, \n or a request type. When one tenant sends a disproportionately large volume of messages \n or has messages that require longer processing time, fair queues ensure other tenants' \n messages maintain low dwell time. This preserves quality of service for all tenants while \n maintaining the scalability and throughput of standard queues. \n We recommend that you include a MessageGroupId in all messages when using fair queues.
The length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.
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\n 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 \n BatchResultErrorEntry\n tag if the message\n 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 \nattribute 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\n 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 \n 1 MiB or 1,048,576 bytes
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed. For more information, see the W3C specification for characters.
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
If a message contains characters outside the allowed set, Amazon SQS rejects the message and returns an InvalidMessageContents error. Ensure that your message body includes only valid characters to avoid this exception.
\n The length of time, in seconds, for which to delay a specific message. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue applies.
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, \nand Value. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS 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 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\n MessageDeduplicationId is sent successfully, any messages sent with the\n same MessageDeduplicationId are accepted successfully but aren't delivered\n during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId\n explicitly.
If you aren't able to provide a MessageDeduplicationId\n and you enable ContentBasedDeduplication for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the\n queue doesn't have ContentBasedDeduplication set, the\n action fails with an error.
If the queue has ContentBasedDeduplication set, your\n MessageDeduplicationId overrides the generated\n one.
When ContentBasedDeduplication is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled\n and then another message with a MessageDeduplicationId that is the\n same as the one generated for the first MessageDeduplicationId, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.
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\n is resent with the same MessageDeduplicationId after the deduplication\n 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.\n MessageDeduplicationId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.
\n MessageGroupId is an attribute used in Amazon SQS FIFO (First-In-First-Out) and standard queues. \n In FIFO queues, MessageGroupId organizes messages into distinct groups. \n Messages within the same message group are always processed one at a time, in strict order, \n ensuring that no two messages from the same group are processed simultaneously. \n In standard queues, using MessageGroupId enables fair queues. \n It is used to identify the tenant a message belongs to, \n helping maintain consistent message dwell time across all tenants during noisy neighbor events. \n Unlike FIFO queues, messages with the same MessageGroupId can be processed in parallel, \n maintaining the high throughput of standard queues.
\n FIFO queues:\n MessageGroupId acts as the tag \n that specifies that a message belongs to a specific message group. \n Messages that belong to the same message group are processed in a FIFO manner \n (however, messages in different message groups might be processed out of order). \n To interleave multiple ordered streams within a single queue, use MessageGroupId values \n (for example, session data for multiple users). \n In this scenario, multiple consumers can process the queue, \n but the session data of each user is processed in a FIFO fashion.
If you do not provide a MessageGroupId when sending a message to a FIFO queue, the action fails.
\n ReceiveMessage might return messages with multiple MessageGroupId values. \n For each MessageGroupId, the messages are sorted by time sent.
\n Standard queues:Use MessageGroupId in standard queues to enable fair queues. \n The MessageGroupId identifies the tenant a message belongs to. \n A tenant can be any entity that shares a queue with others, such as your customer, a client application, \n or a request type. When one tenant sends a disproportionately large volume of messages \n or has messages that require longer processing time, fair queues ensure other tenants' \n messages maintain low dwell time. This preserves quality of service for all tenants while \n maintaining the scalability and throughput of standard queues. \n We recommend that you include a MessageGroupId in all messages when using fair queues.
The length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.
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 \nattribute 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.\n For more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.
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\n continues to increase for a particular MessageGroupId.
The MD5OfMessageBody and MessageId elements.
Sets the value of one or more queue attributes, like a policy. When you change a\n queue's attributes, the change can take up to 60 seconds for most of the attributes to\n propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and will\n impact existing messages in the queue potentially causing them to be expired and deleted\n if the MessageRetentionPeriod is reduced below the age of existing\n messages.
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, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS 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\n parameters that the SetQueueAttributes action uses:
\n DelaySeconds – The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 (15 minutes). Default: 0.
\n MaximumMessageSize – The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) up to 1,048,576 bytes (1 MiB). Default: 1,048,576 bytes (1 MiB).
\n MessageRetentionPeriod – The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer representing seconds,\n from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the Identity and Access Management User\n Guide.
\n ReceiveMessageWaitTimeSeconds – The length of time, in\n seconds, for which a \n ReceiveMessage\n action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.
\n VisibilityTimeout – The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n 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 \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll – No source queues can specify this queue as the dead-letter\n queue.
\n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is\n always alias/aws/sqs, the alias of a custom CMK can, for example,\n be alias/MyAlias\n . For more examples, see\n KeyId in the Key Management Service API\n Reference.
\n KmsDataKeyReusePeriodSeconds – The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n 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\n more information, see How Does the Data Key Reuse Period Work?.
\n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
The following attribute applies only to FIFO (first-in-first-out)\n queues:
\n\n ContentBasedDeduplication – Enables content-based\n deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:
Every message must have a unique\n MessageDeduplicationId.
You may provide a MessageDeduplicationId\n explicitly.
If you aren't able to provide a\n MessageDeduplicationId and you enable\n ContentBasedDeduplication for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the\n message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and\n the queue doesn't have ContentBasedDeduplication\n set, the action fails with an error.
If the queue has ContentBasedDeduplication set,\n your MessageDeduplicationId overrides the generated\n one.
When ContentBasedDeduplication is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.
If you send one message with ContentBasedDeduplication\n enabled and then another message with a\n MessageDeduplicationId that is the same as the one\n generated for the first MessageDeduplicationId, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\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, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" } } }, "traits": { "smithy.api#documentation": "", "smithy.api#input": {} } }, "com.amazonaws.sqs#StartMessageMoveTask": { "type": "operation", "input": { "target": "com.amazonaws.sqs#StartMessageMoveTaskRequest" }, "output": { "target": "com.amazonaws.sqs#StartMessageMoveTaskResult" }, "errors": [ { "target": "com.amazonaws.sqs#InvalidAddress" }, { "target": "com.amazonaws.sqs#InvalidSecurity" }, { "target": "com.amazonaws.sqs#RequestThrottled" }, { "target": "com.amazonaws.sqs#ResourceNotFoundException" }, { "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { "smithy.api#documentation": "Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue.
\nThis action is currently limited to supporting message redrive from queues\n that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS\n queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are\n currently not supported.
\nIn dead-letter queues redrive context, the\n StartMessageMoveTask the source queue is the DLQ, while the\n destination queue can be the original source queue (from which the messages\n were driven to the dead-letter-queue), or a custom destination queue.
Only one active message movement task is supported per queue at any given\n time.
\nThe ARN of the queue that contains the messages to be moved to another queue.\n Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues\n are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are\n not currently supported.
", "smithy.api#required": {} } }, "DestinationArn": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "The ARN of the queue that receives the moved messages. You can use this field to\n specify the destination queue where you would like to redrive messages. If this field is\n left blank, the messages will be redriven back to their respective original source\n queues.
" } }, "MaxNumberOfMessagesPerSecond": { "target": "com.amazonaws.sqs#NullableInteger", "traits": { "smithy.api#documentation": "The number of messages to be moved per second (the message movement rate). You can use\n this field to define a fixed message movement rate. The maximum value for messages per\n second is 500. If this field is left blank, the system will optimize the rate based on\n the queue message backlog size, which may vary throughout the duration of the message\n movement task.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sqs#StartMessageMoveTaskResult": { "type": "structure", "members": { "TaskHandle": { "target": "com.amazonaws.sqs#String", "traits": { "smithy.api#documentation": "An identifier associated with a message movement task. You can use this identifier to\n cancel a specified message movement task using the CancelMessageMoveTask\n action.
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\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 \nQuotas related to queues \nin the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS 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" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.sqs#TagValue": { "type": "string" }, "com.amazonaws.sqs#Token": { "type": "string" }, "com.amazonaws.sqs#TooManyEntriesInBatchRequest": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "AWS.SimpleQueueService.TooManyEntriesInBatchRequest", "httpResponseCode": 400 }, "smithy.api#documentation": "The batch request contains more entries than permissible. For Amazon SQS, the\n maximum number of entries you can include in a single SendMessageBatch, DeleteMessageBatch, or ChangeMessageVisibilityBatch request is 10.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.sqs#UnsupportedOperation": { "type": "structure", "members": { "message": { "target": "com.amazonaws.sqs#ExceptionMessage" } }, "traits": { "aws.protocols#awsQueryError": { "code": "AWS.SimpleQueueService.UnsupportedOperation", "httpResponseCode": 400 }, "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" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.sqs#InvalidAddress" }, { "target": "com.amazonaws.sqs#InvalidSecurity" }, { "target": "com.amazonaws.sqs#QueueDoesNotExist" }, { "target": "com.amazonaws.sqs#RequestThrottled" }, { "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { "smithy.api#documentation": "Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS 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" } } }, "traits": { "smithy.api#input": {} } } } }