Welcome to the Amazon SQS API Reference.
-Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel -between applications or microservices. Amazon SQS moves data between distributed application -components and helps you decouple these components.
-For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer -Guide. +
Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
+For information on the permissions you need to use this API, see +Identity and +access management in the Amazon SQS Developer Guide.
-You can use Amazon Web Services SDKs to access -Amazon SQS using your favorite programming language. The SDKs perform tasks such as the -following automatically:
+You can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
Cryptographically sign your service requests
@@ -74,8 +71,7 @@ following automatically: diff --git a/clients/client-sqs/package.json b/clients/client-sqs/package.json index 07075578051c5..b3b75a806e822 100644 --- a/clients/client-sqs/package.json +++ b/clients/client-sqs/package.json @@ -55,6 +55,7 @@ "@aws-sdk/util-user-agent-browser": "*", "@aws-sdk/util-user-agent-node": "*", "@aws-sdk/util-utf8": "*", + "fast-xml-parser": "4.1.2", "tslib": "^2.5.0" }, "devDependencies": { diff --git a/clients/client-sqs/src/SQS.ts b/clients/client-sqs/src/SQS.ts index 329bd80d22aa9..4b3214fb994a9 100644 --- a/clients/client-sqs/src/SQS.ts +++ b/clients/client-sqs/src/SQS.ts @@ -371,15 +371,12 @@ export interface SQS { /** * @public *Welcome to the Amazon SQS API Reference.
- *Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel - * between applications or microservices. Amazon SQS moves data between distributed application - * components and helps you decouple these components.
- *For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer - * Guide. + *
Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
+ *For information on the permissions you need to use this API, see + * Identity and + * access management in the Amazon SQS Developer Guide. *
- *You can use Amazon Web Services SDKs to access - * Amazon SQS using your favorite programming language. The SDKs perform tasks such as the - * following automatically:
+ *You can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
*Cryptographically sign your service requests
@@ -435,8 +432,7 @@ export interface SQS { *Welcome to the Amazon SQS API Reference.
- *Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel - * between applications or microservices. Amazon SQS moves data between distributed application - * components and helps you decouple these components.
- *For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer - * Guide. + *
Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
+ *For information on the permissions you need to use this API, see + * Identity and + * access management in the Amazon SQS Developer Guide. *
- *You can use Amazon Web Services SDKs to access - * Amazon SQS using your favorite programming language. The SDKs perform tasks such as the - * following automatically:
+ *You can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
*Cryptographically sign your service requests
@@ -372,8 +369,7 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {} *Adds a permission to a queue for a specific principal. This allows sharing - * access to the queue.
- *When you create a queue, you have full control access rights for the queue. Only you, - * the owner of the queue, can grant or deny permissions to the queue. For more information - * about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS - * Developer Guide.
+ *Adds a permission to a queue for a specific + * principal. + * This allows sharing access to the queue.
+ *When you create a queue, you have full control access rights for the queue. + * Only you, the owner of the queue, can grant or deny permissions to the queue. + * For more information about these permissions, see + * Allow + * Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
*
* AddPermission generates a policy for you. You can use
- *
+ *
* SetQueueAttributes
- * to upload your
- * policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in
- * the Amazon SQS Developer Guide.
An Amazon SQS policy can have a maximum of seven actions per statement.
+ *An Amazon SQS policy can have a maximum of 7 actions.
*To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Amazon SQS AddPermission does not support adding a non-account
- * principal.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
+ * &AttributeName.1=first
+ *
+ * &AttributeName.2=second
+ *
Cross-account permissions don't apply to this action. For more information, * see Grant - * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
+ * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. *The accountId is invalid.
When the request to a queue is not HTTPS and SigV4.
- * * @throws {@link OverLimit} (client fault) *The specified action violates a limit. For example, ReceiveMessage
- * returns this error if the maximum number of in flight messages is reached and
+ * returns this error if the maximum number of inflight messages is reached and
* AddPermission returns this error if the maximum number of permissions
* for the queue is reached.
The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts b/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts index 66ac714c0c8da..9aa4c51b80d1f 100644 --- a/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts +++ b/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts @@ -14,10 +14,7 @@ import { } from "@aws-sdk/types"; import { ChangeMessageVisibilityBatchRequest, ChangeMessageVisibilityBatchResult } from "../models/models_0"; -import { - de_ChangeMessageVisibilityBatchCommand, - se_ChangeMessageVisibilityBatchCommand, -} from "../protocols/Aws_json1_0"; +import { de_ChangeMessageVisibilityBatchCommand, se_ChangeMessageVisibilityBatchCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -37,17 +34,21 @@ export interface ChangeMessageVisibilityBatchCommandOutput /** * @public - *Changes the visibility timeout of multiple messages. This is a batch version of
- * Changes the visibility timeout of multiple messages. This is a batch version of
- * ChangeMessageVisibility. The result of the action
- * on each message is reported individually in the response. You can send up to 10
- *
+ * requests with each
+ * ChangeMessageVisibility. The result of the action on each message is reported individually in the response.
+ * You can send up to 10
* ChangeMessageVisibility
- * requests with each
- * ChangeMessageVisibilityBatch action.ChangeMessageVisibilityBatch action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
+ * &AttributeName.1=first
+ *
+ * &AttributeName.2=second
+ *
The batch request doesn't contain any entries.
* * @throws {@link InvalidBatchEntryId} (client fault) - *The Id of a batch entry in a batch request doesn't abide by the
- * specification.
The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *The Id of a batch entry in a batch request doesn't abide by the specification.
The batch request contains more entries than permissible.
* - * @throws {@link UnsupportedOperation} (client fault) - *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts b/clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts index b8cbd9a2aa30a..3537696537652 100644 --- a/clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts +++ b/clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts @@ -14,7 +14,7 @@ import { } from "@aws-sdk/types"; import { ChangeMessageVisibilityRequest } from "../models/models_0"; -import { de_ChangeMessageVisibilityCommand, se_ChangeMessageVisibilityCommand } from "../protocols/Aws_json1_0"; +import { de_ChangeMessageVisibilityCommand, se_ChangeMessageVisibilityCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -34,15 +34,12 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer { * @public *Changes the visibility timeout of a specified message in a queue to a new value. The * default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The - * maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer - * Guide.
- *For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed
- * since you received the message, and you send a ChangeMessageVisibility call with
- * VisibilityTimeout set to 10 seconds, the 10 seconds begin to count from
- * the time that you make the ChangeMessageVisibility call. Thus, any attempt
- * to change the visibility timeout or to delete that message 10 seconds after you
- * initially change the visibility timeout (a total of 25 seconds) might result in an
- * error.
For example, you have a message with a visibility timeout of 5 minutes. After 3
+ * minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You
+ * can continue to call ChangeMessageVisibility to extend the visibility
+ * timeout to the maximum allowed time. If you try to extend the visibility timeout beyond
+ * the maximum, your request is rejected.
An Amazon SQS message has three basic states:
*A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. - * A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages.
- *Limits that apply to in flight messages are unrelated to the unlimited number of stored messages.
- *For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). + * A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.
+ *Limits that apply to inflight messages are unrelated to the unlimited number of stored messages.
+ *For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue).
* If you reach this limit, Amazon SQS returns the OverLimit error message.
* To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.
* To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 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.
+ *For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
*If you attempt to set the VisibilityTimeout to a value greater than
- * the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically
- * recalculate and increase the timeout to the maximum remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message
- * the timeout value is applied immediately but isn't saved in memory for that message.
- * If you don't delete a message after it is received, the visibility timeout for the
- * message reverts to the original timeout value (not to the value you set using the
- * ChangeMessageVisibility action) the next time the message is
- * received.
If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout
+ * for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.
The specified message isn't in flight.
* - * @throws {@link QueueDoesNotExist} (client fault) - *The specified queue doesn't exist.
- * * @throws {@link ReceiptHandleIsInvalid} (client fault) *The specified receipt handle isn't valid.
* - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/CreateQueueCommand.ts b/clients/client-sqs/src/commands/CreateQueueCommand.ts index 1d2cb94a92d6a..644183216b00f 100644 --- a/clients/client-sqs/src/commands/CreateQueueCommand.ts +++ b/clients/client-sqs/src/commands/CreateQueueCommand.ts @@ -14,7 +14,7 @@ import { } from "@aws-sdk/types"; import { CreateQueueRequest, CreateQueueResult } from "../models/models_0"; -import { de_CreateQueueCommand, se_CreateQueueCommand } from "../protocols/Aws_json1_0"; +import { de_CreateQueueCommand, se_CreateQueueCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -46,43 +46,42 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB * *If you don't provide a value for an attribute, the queue is created with the - * default value for the attribute.
+ *If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
*If you delete a queue, you must wait at least 60 seconds before creating a - * queue with the same name.
+ *If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
*To successfully create a new queue, you must provide a queue name that adheres to the - * limits - * related to queues and is unique within the scope of your queues.
+ *To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.
*After you create a queue, you must wait at least one second after the queue is * created to be able to use the queue.
*To get the queue URL, use the
* GetQueueUrl
- * action.
- *
+ * action.
* GetQueueUrl
- * requires only the
- * QueueName parameter. be aware of existing queue names:
QueueName parameter.
+ * be aware of existing queue names:
* If you provide the name of an existing queue along with the exact names and
- * values of all the queue's attributes, CreateQueue returns the queue
- * URL for the existing queue.
If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an
- * existing queue, CreateQueue returns an error.
If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
+ * &AttributeName.1=first
+ *
+ * &AttributeName.2=second
+ *
Cross-account permissions don't apply to this action. For more information, * see Grant - * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
+ * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. *The accountId is invalid.
The specified attribute doesn't exist.
- * - * @throws {@link InvalidAttributeValue} (client fault) - *A queue attribute value is invalid.
- * - * @throws {@link InvalidSecurity} (client fault) - *When the request to a queue is not HTTPS and SigV4.
- * * @throws {@link QueueDeletedRecently} (client fault) *You must wait 60 seconds after deleting a queue before you can create another queue * with the same name.
@@ -133,28 +120,6 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB *A queue with this name already exists. Amazon SQS returns this error only if the request * includes attributes whose values differ from those of the existing queue.
* - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts b/clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts index da72c9b600371..f2742a78fdef1 100644 --- a/clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts +++ b/clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts @@ -14,7 +14,7 @@ import { } from "@aws-sdk/types"; import { DeleteMessageBatchRequest, DeleteMessageBatchResult } from "../models/models_0"; -import { de_DeleteMessageBatchCommand, se_DeleteMessageBatchCommand } from "../protocols/Aws_json1_0"; +import { de_DeleteMessageBatchCommand, se_DeleteMessageBatchCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -32,13 +32,18 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul /** * @public - *Deletes up to ten messages from the specified queue. This is a batch version of
- *
- * DeleteMessage. The result of the action on each
- * message is reported individually in the response.
Deletes up to ten messages from the specified queue. This is a batch version of
+ * DeleteMessage. The result of the action on each message is reported individually in the response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
+ * &AttributeName.1=first
+ *
+ * &AttributeName.2=second
+ *
The batch request doesn't contain any entries.
* * @throws {@link InvalidBatchEntryId} (client fault) - *The Id of a batch entry in a batch request doesn't abide by the
- * specification.
The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *The Id of a batch entry in a batch request doesn't abide by the specification.
The batch request contains more entries than permissible.
* - * @throws {@link UnsupportedOperation} (client fault) - *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/DeleteMessageCommand.ts b/clients/client-sqs/src/commands/DeleteMessageCommand.ts index 941307e167281..7998bc8fc7910 100644 --- a/clients/client-sqs/src/commands/DeleteMessageCommand.ts +++ b/clients/client-sqs/src/commands/DeleteMessageCommand.ts @@ -14,7 +14,7 @@ import { } from "@aws-sdk/types"; import { DeleteMessageRequest } from "../models/models_0"; -import { de_DeleteMessageCommand, se_DeleteMessageCommand } from "../protocols/Aws_json1_0"; +import { de_DeleteMessageCommand, se_DeleteMessageCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -44,7 +44,7 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {} * once, theReceiptHandle is different each time you receive a message.
* When you use the DeleteMessage action, you must provide the most
* recently received ReceiptHandle for the message (otherwise, the request
- * succeeds, but the message will not be deleted).
+ * succeeds, but the message might not be deleted).
* For standard queues, it is possible to receive a message even after you * delete it. This might happen on rare occasions if one of the servers which stores a * copy of the message is unavailable when you send the request to delete the message. @@ -77,37 +77,9 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {} * @throws {@link InvalidIdFormat} (client fault) *
The specified receipt handle isn't valid for the current version.
* - * @throws {@link InvalidSecurity} (client fault) - *When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link QueueDoesNotExist} (client fault) - *The specified queue doesn't exist.
- * * @throws {@link ReceiptHandleIsInvalid} (client fault) *The specified receipt handle isn't valid.
* - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/DeleteQueueCommand.ts b/clients/client-sqs/src/commands/DeleteQueueCommand.ts index 0cd21e13897f5..c76a0a7ddb190 100644 --- a/clients/client-sqs/src/commands/DeleteQueueCommand.ts +++ b/clients/client-sqs/src/commands/DeleteQueueCommand.ts @@ -14,7 +14,7 @@ import { } from "@aws-sdk/types"; import { DeleteQueueRequest } from "../models/models_0"; -import { de_DeleteQueueCommand, se_DeleteQueueCommand } from "../protocols/Aws_json1_0"; +import { de_DeleteQueueCommand, se_DeleteQueueCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -32,25 +32,20 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {} /** * @public - *Deletes the queue specified by the QueueUrl, regardless of the queue's
- * contents.
Deletes the queue specified by the QueueUrl, regardless of the queue's contents.
Be careful with the DeleteQueue action: When you delete a queue, any
- * messages in the queue are no longer available.
Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.
+ *
When you delete a queue, the deletion process takes up to 60 seconds. Requests you
- * send involving that queue during the 60 seconds might succeed. For example, a
- * When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a
+ * When you delete a queue, you must wait at least 60 seconds before creating a queue
- * with the same name.
+ * request might succeed, but after 60 seconds the queue and the message you sent no longer exist.
* SendMessage
- * request might succeed, but after 60
- * seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
*Cross-account permissions don't apply to this action. For more information, * see Grant - * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
- *The delete operation uses the HTTP GET verb.
The accountId is invalid.
When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link QueueDoesNotExist} (client fault) - *The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/GetQueueAttributesCommand.ts b/clients/client-sqs/src/commands/GetQueueAttributesCommand.ts index 05829506b96ac..b7c396d31cf29 100644 --- a/clients/client-sqs/src/commands/GetQueueAttributesCommand.ts +++ b/clients/client-sqs/src/commands/GetQueueAttributesCommand.ts @@ -14,7 +14,7 @@ import { } from "@aws-sdk/types"; import { GetQueueAttributesRequest, GetQueueAttributesResult } from "../models/models_0"; -import { de_GetQueueAttributesCommand, se_GetQueueAttributesCommand } from "../protocols/Aws_json1_0"; +import { de_GetQueueAttributesCommand, se_GetQueueAttributesCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -67,34 +67,6 @@ export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResul * @throws {@link InvalidAttributeName} (client fault) *The specified attribute doesn't exist.
* - * @throws {@link InvalidSecurity} (client fault) - *When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link QueueDoesNotExist} (client fault) - *The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/GetQueueUrlCommand.ts b/clients/client-sqs/src/commands/GetQueueUrlCommand.ts index a337345bf4f28..9b5a4e4277a3c 100644 --- a/clients/client-sqs/src/commands/GetQueueUrlCommand.ts +++ b/clients/client-sqs/src/commands/GetQueueUrlCommand.ts @@ -14,7 +14,7 @@ import { } from "@aws-sdk/types"; import { GetQueueUrlRequest, GetQueueUrlResult } from "../models/models_0"; -import { de_GetQueueUrlCommand, se_GetQueueUrlCommand } from "../protocols/Aws_json1_0"; +import { de_GetQueueUrlCommand, se_GetQueueUrlCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -33,14 +33,11 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB /** * @public *Returns the URL of an existing Amazon SQS queue.
- *To access a queue that belongs to another AWS account, use the
- * To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the
- * queue's owner. The queue's owner must grant you permission to access the queue. For more
- * information about shared queue access, see
+ * or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
+ * QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue.
+ * For more information about shared queue access, see
* AddPermission
- *
- * or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS
- * Developer Guide.
The accountId is invalid.
When the request to a queue is not HTTPS and SigV4.
- * * @throws {@link QueueDoesNotExist} (client fault) *The specified queue doesn't exist.
* - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/ListDeadLetterSourceQueuesCommand.ts b/clients/client-sqs/src/commands/ListDeadLetterSourceQueuesCommand.ts index 390021297db1a..c291627bbaf4f 100644 --- a/clients/client-sqs/src/commands/ListDeadLetterSourceQueuesCommand.ts +++ b/clients/client-sqs/src/commands/ListDeadLetterSourceQueuesCommand.ts @@ -14,7 +14,7 @@ import { } from "@aws-sdk/types"; import { ListDeadLetterSourceQueuesRequest, ListDeadLetterSourceQueuesResult } from "../models/models_0"; -import { de_ListDeadLetterSourceQueuesCommand, se_ListDeadLetterSourceQueuesCommand } from "../protocols/Aws_json1_0"; +import { de_ListDeadLetterSourceQueuesCommand, se_ListDeadLetterSourceQueuesCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -32,17 +32,16 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS /** * @public - *Returns a list of your queues that have the RedrivePolicy queue attribute
- * configured with a dead-letter queue.
The ListDeadLetterSourceQueues methods supports pagination. Set
- * parameter MaxResults in the request to specify the maximum number of
- * results to be returned in the response. If you do not set MaxResults, the
- * response includes a maximum of 1,000 results. If you set MaxResults and
- * there are additional results to display, the response includes a value for
- * NextToken. Use NextToken as a parameter in your next
- * 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 - * Guide.
+ *Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.
The ListDeadLetterSourceQueues methods supports
+ * pagination. Set parameter MaxResults in the request to specify the maximum number of
+ * results to be returned in the response. If you do not set MaxResults,
+ * the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to
+ * display, the response includes a value for NextToken. Use
+ * NextToken as a parameter in your next 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 Guide.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -71,37 +70,9 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS * @see {@link ListDeadLetterSourceQueuesCommandOutput} for command's `response` shape. * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * - * @throws {@link InvalidAddress} (client fault) - *The accountId is invalid.
When the request to a queue is not HTTPS and SigV4.
- * * @throws {@link QueueDoesNotExist} (client fault) *The specified queue doesn't exist.
* - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/ListQueueTagsCommand.ts b/clients/client-sqs/src/commands/ListQueueTagsCommand.ts index cb8ca0daeffb6..3cd18e2e7c45d 100644 --- a/clients/client-sqs/src/commands/ListQueueTagsCommand.ts +++ b/clients/client-sqs/src/commands/ListQueueTagsCommand.ts @@ -14,7 +14,7 @@ import { } from "@aws-sdk/types"; import { ListQueueTagsRequest, ListQueueTagsResult } from "../models/models_0"; -import { de_ListQueueTagsCommand, se_ListQueueTagsCommand } from "../protocols/Aws_json1_0"; +import { de_ListQueueTagsCommand, se_ListQueueTagsCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -32,13 +32,12 @@ export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __Metad /** * @public - *List all cost allocation tags added to the specified Amazon SQS queue.
- * For an overview, see Tagging
+ * List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging
* Your Amazon SQS Queues in the Amazon SQS Developer Guide. Cross-account permissions don't apply to this action. For more information,
* see Grant
- * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
The accountId is invalid.
When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link QueueDoesNotExist} (client fault) - *The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/ListQueuesCommand.ts b/clients/client-sqs/src/commands/ListQueuesCommand.ts index d39ccf98efdfd..9b6ad04b53ab2 100644 --- a/clients/client-sqs/src/commands/ListQueuesCommand.ts +++ b/clients/client-sqs/src/commands/ListQueuesCommand.ts @@ -14,7 +14,7 @@ import { } from "@aws-sdk/types"; import { ListQueuesRequest, ListQueuesResult } from "../models/models_0"; -import { de_ListQueuesCommand, se_ListQueuesCommand } from "../protocols/Aws_json1_0"; +import { de_ListQueuesCommand, se_ListQueuesCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -32,21 +32,19 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea /** * @public - *Returns a list of your queues in the current region. The response includes a maximum
- * of 1,000 results. If you specify a value for the optional QueueNamePrefix
- * parameter, only queues with a name that begins with the specified value are
- * returned.
The listQueues methods supports pagination. Set parameter
- * MaxResults in the request to specify the maximum number of results to
- * be returned in the response. If you do not set MaxResults, the response
- * includes a maximum of 1,000 results. If you set MaxResults and there are
- * additional results to display, the response includes a value for NextToken.
- * Use NextToken as a parameter in your next request to
- * listQueues to receive the next page of results.
Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional
+ * QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.
The listQueues methods supports
+ * pagination. Set parameter MaxResults in the request to specify the maximum number of
+ * results to be returned in the response. If you do not set MaxResults,
+ * the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to
+ * display, the response includes a value for NextToken. Use
+ * NextToken as a parameter in your next request to
+ * listQueues to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, * see Grant - * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
+ * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. *The accountId is invalid.
When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/PurgeQueueCommand.ts b/clients/client-sqs/src/commands/PurgeQueueCommand.ts index 5c16583d30c3b..5b61a272d8d7d 100644 --- a/clients/client-sqs/src/commands/PurgeQueueCommand.ts +++ b/clients/client-sqs/src/commands/PurgeQueueCommand.ts @@ -14,7 +14,7 @@ import { } from "@aws-sdk/types"; import { PurgeQueueRequest } from "../models/models_0"; -import { de_PurgeQueueCommand, se_PurgeQueueCommand } from "../protocols/Aws_json1_0"; +import { de_PurgeQueueCommand, se_PurgeQueueCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -37,14 +37,14 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {} *When you use the PurgeQueue action, you can't retrieve any messages
* deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for 60 - * seconds regardless of your queue's size.
+ *The message deletion process takes up to 60 seconds. We recommend waiting for + * 60 seconds regardless of your queue's size.
*Messages sent to the queue before you call
* PurgeQueue might be received but are deleted within the next
* minute.
Messages sent to the queue after you call PurgeQueue
- * might be deleted while the queue is being purged.
Messages sent to the queue after you call
+ * PurgeQueue might be deleted while the queue is being purged.
The accountId is invalid.
When the request to a queue is not HTTPS and SigV4.
- * * @throws {@link PurgeQueueInProgress} (client fault) - *Indicates that the specified queue previously received a PurgeQueue
- * request within the last 60 seconds (the time it can take to delete the messages in the
- * queue).
Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).
The specified queue doesn't exist.
* - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/ReceiveMessageCommand.ts b/clients/client-sqs/src/commands/ReceiveMessageCommand.ts index 374b463375e28..4e45575560faf 100644 --- a/clients/client-sqs/src/commands/ReceiveMessageCommand.ts +++ b/clients/client-sqs/src/commands/ReceiveMessageCommand.ts @@ -15,7 +15,7 @@ import { } from "@aws-sdk/types"; import { ReceiveMessageRequest, ReceiveMessageResult } from "../models/models_0"; -import { de_ReceiveMessageCommand, se_ReceiveMessageCommand } from "../protocols/Aws_json1_0"; +import { de_ReceiveMessageCommand, se_ReceiveMessageCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -33,17 +33,13 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met /** * @public - *Retrieves one or more messages (up to 10), from the specified queue. Using the
- * WaitTimeSeconds parameter enables long-poll support. For more
- * information, see Amazon SQS
- * Long Polling in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled
- * on a ReceiveMessage call. Thus, only the messages on the sampled machines
- * are returned. If the number of messages in the queue is small (fewer than 1,000), you
- * most likely get fewer messages than you requested per ReceiveMessage call.
- * If the number of messages in the queue is extremely small, you might not receive any
- * messages in a particular ReceiveMessage response. If this happens, repeat
- * the request.
Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support.
+ * For more information, see Amazon SQS Long Polling in the Amazon SQS Developer Guide.
+ *
Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned.
+ * If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small,
+ * you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.
+ *
For each message returned, the response includes the following:
*An MD5 digest of the message body. For information about MD5, see RFC1321.
*The MessageId you received when you sent the message to the
- * queue.
The MessageId you received when you sent the message to the queue.
The receipt handle.
@@ -66,17 +61,11 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met *An MD5 digest of the message attributes.
*The receipt handle is the identifier you must provide when deleting the message. For - * more information, see Queue and Message Identifiers in the Amazon SQS Developer - * Guide.
- *You can provide the VisibilityTimeout parameter in your request. The
- * parameter is applied to the messages that Amazon SQS returns in the response. If you don't
- * include the parameter, the overall visibility timeout for the queue is used for the
- * returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer
- * Guide.
A message that isn't deleted or a message whose visibility isn't extended before the - * visibility timeout expires counts as a failed receive. Depending on the configuration of - * the queue, the message might be sent to the dead-letter queue.
+ *The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue + * and Message Identifiers in the Amazon SQS Developer Guide.
+ *You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue
+ * is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.
*In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
*When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link KmsAccessDenied} (client fault) - *The caller doesn't have the required KMS access.
- * - * @throws {@link KmsDisabled} (client fault) - *The request was denied due to request throttling.
- * - * @throws {@link KmsInvalidKeyUsage} (client fault) - *The request was rejected for one of the following reasons:
- *The KeyUsage value of the KMS key is incompatible with the API - * operation.
- *The encryption algorithm or signing algorithm specified for the operation is - * incompatible with the type of key material in the KMS key (KeySpec).
- *The request was rejected because the state of the specified resource is not valid for - * this request.
- * - * @throws {@link KmsNotFound} (client fault) - *The request was rejected because the specified entity or resource could not be found. - *
- * - * @throws {@link KmsOptInRequired} (client fault) - *The request was rejected because the specified key policy isn't syntactically or - * semantically correct.
- * - * @throws {@link KmsThrottled} (client fault) - *Amazon Web Services KMS throttles requests for the following conditions.
- * * @throws {@link OverLimit} (client fault) *The specified action violates a limit. For example, ReceiveMessage
- * returns this error if the maximum number of in flight messages is reached and
+ * returns this error if the maximum number of inflight messages is reached and
* AddPermission returns this error if the maximum number of permissions
* for the queue is reached.
The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/RemovePermissionCommand.ts b/clients/client-sqs/src/commands/RemovePermissionCommand.ts index db6fdc68c478d..db897440f8d8a 100644 --- a/clients/client-sqs/src/commands/RemovePermissionCommand.ts +++ b/clients/client-sqs/src/commands/RemovePermissionCommand.ts @@ -14,7 +14,7 @@ import { } from "@aws-sdk/types"; import { RemovePermissionRequest } from "../models/models_0"; -import { de_RemovePermissionCommand, se_RemovePermissionCommand } from "../protocols/Aws_json1_0"; +import { de_RemovePermissionCommand, se_RemovePermissionCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -32,8 +32,7 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {} /** * @public - *Revokes any permissions in the queue policy that matches the specified
- * Label parameter.
Revokes any permissions in the queue policy that matches the specified Label parameter.
Cross-account permissions don't apply to this action. For more information, * see Grant - * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
+ * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. *To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
The accountId is invalid.
When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link QueueDoesNotExist} (client fault) - *The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/SendMessageBatchCommand.ts b/clients/client-sqs/src/commands/SendMessageBatchCommand.ts index 892b5e0e0682a..5b661ad1cbdcd 100644 --- a/clients/client-sqs/src/commands/SendMessageBatchCommand.ts +++ b/clients/client-sqs/src/commands/SendMessageBatchCommand.ts @@ -15,7 +15,7 @@ import { } from "@aws-sdk/types"; import { SendMessageBatchRequest, SendMessageBatchResult } from "../models/models_0"; -import { de_SendMessageBatchCommand, se_SendMessageBatchCommand } from "../protocols/Aws_json1_0"; +import { de_SendMessageBatchCommand, se_SendMessageBatchCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -33,16 +33,10 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _ /** * @public - *You can use SendMessageBatch to send up to 10 messages to the specified
- * queue by assigning either identical or different values to each message (or by not
- * assigning values at all). This is a batch version of
- * SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued
- * in the order they are sent.
The result of sending each message is reported individually in the response.
- * Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
The maximum allowed individual message size and the maximum total payload size (the - * sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144 - * bytes).
+ *Delivers up to ten messages to the specified queue. This is a batch version of
+ * SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
*A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
*@@ -50,8 +44,14 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _ *
*Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
*If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses
- * the default value for the queue.
If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
+ * &AttributeName.1=first
+ *
+ * &AttributeName.2=second
+ *
The batch request doesn't contain any entries.
* * @throws {@link InvalidBatchEntryId} (client fault) - *The Id of a batch entry in a batch request doesn't abide by the
- * specification.
When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link KmsAccessDenied} (client fault) - *The caller doesn't have the required KMS access.
- * - * @throws {@link KmsDisabled} (client fault) - *The request was denied due to request throttling.
- * - * @throws {@link KmsInvalidKeyUsage} (client fault) - *The request was rejected for one of the following reasons:
- *The KeyUsage value of the KMS key is incompatible with the API - * operation.
- *The encryption algorithm or signing algorithm specified for the operation is - * incompatible with the type of key material in the KMS key (KeySpec).
- *The request was rejected because the state of the specified resource is not valid for - * this request.
- * - * @throws {@link KmsNotFound} (client fault) - *The request was rejected because the specified entity or resource could not be found. - *
- * - * @throws {@link KmsOptInRequired} (client fault) - *The request was rejected because the specified key policy isn't syntactically or - * semantically correct.
- * - * @throws {@link KmsThrottled} (client fault) - *Amazon Web Services KMS throttles requests for the following conditions.
- * - * @throws {@link QueueDoesNotExist} (client fault) - *The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *The Id of a batch entry in a batch request doesn't abide by the specification.
The batch request contains more entries than permissible.
diff --git a/clients/client-sqs/src/commands/SendMessageCommand.ts b/clients/client-sqs/src/commands/SendMessageCommand.ts index 3f93b34b05352..b5390df7536c9 100644 --- a/clients/client-sqs/src/commands/SendMessageCommand.ts +++ b/clients/client-sqs/src/commands/SendMessageCommand.ts @@ -15,7 +15,7 @@ import { } from "@aws-sdk/types"; import { SendMessageRequest, SendMessageResult } from "../models/models_0"; -import { de_SendMessageCommand, se_SendMessageCommand } from "../protocols/Aws_json1_0"; +import { de_SendMessageCommand, se_SendMessageCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -101,65 +101,6 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB * @throws {@link InvalidMessageContents} (client fault) *The message contains characters outside the allowed set.
* - * @throws {@link InvalidSecurity} (client fault) - *When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link KmsAccessDenied} (client fault) - *The caller doesn't have the required KMS access.
- * - * @throws {@link KmsDisabled} (client fault) - *The request was denied due to request throttling.
- * - * @throws {@link KmsInvalidKeyUsage} (client fault) - *The request was rejected for one of the following reasons:
- *The KeyUsage value of the KMS key is incompatible with the API - * operation.
- *The encryption algorithm or signing algorithm specified for the operation is - * incompatible with the type of key material in the KMS key (KeySpec).
- *The request was rejected because the state of the specified resource is not valid for - * this request.
- * - * @throws {@link KmsNotFound} (client fault) - *The request was rejected because the specified entity or resource could not be found. - *
- * - * @throws {@link KmsOptInRequired} (client fault) - *The request was rejected because the specified key policy isn't syntactically or - * semantically correct.
- * - * @throws {@link KmsThrottled} (client fault) - *Amazon Web Services KMS throttles requests for the following conditions.
- * - * @throws {@link QueueDoesNotExist} (client fault) - *The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
* diff --git a/clients/client-sqs/src/commands/SetQueueAttributesCommand.ts b/clients/client-sqs/src/commands/SetQueueAttributesCommand.ts index e3908da35b7b1..1760af2964df1 100644 --- a/clients/client-sqs/src/commands/SetQueueAttributesCommand.ts +++ b/clients/client-sqs/src/commands/SetQueueAttributesCommand.ts @@ -14,7 +14,7 @@ import { } from "@aws-sdk/types"; import { SetQueueAttributesRequest } from "../models/models_0"; -import { de_SetQueueAttributesCommand, se_SetQueueAttributesCommand } from "../protocols/Aws_json1_0"; +import { de_SetQueueAttributesCommand, se_SetQueueAttributesCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -32,12 +32,8 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {} /** * @public - *Sets the value of one or more queue attributes. When you change a queue's attributes,
- * the change can take up to 60 seconds for most of the attributes to propagate throughout
- * the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can
- * take up to 15 minutes and will impact existing messages in the queue potentially causing
- * them to be expired and deleted if the MessageRetentionPeriod is reduced
- * below the age of existing messages.
Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system.
+ * Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.
Cross-account permissions don't apply to this action. For more information, * see Grant - * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
+ * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. *To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
The accountId is invalid.
The specified attribute doesn't exist.
* - * @throws {@link InvalidAttributeValue} (client fault) - *A queue attribute value is invalid.
- * - * @throws {@link InvalidSecurity} (client fault) - *When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link OverLimit} (client fault) - *The specified action violates a limit. For example, ReceiveMessage
- * returns this error if the maximum number of in flight messages is reached and
- * AddPermission returns this error if the maximum number of permissions
- * for the queue is reached.
The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/TagQueueCommand.ts b/clients/client-sqs/src/commands/TagQueueCommand.ts index c462eadb5234f..27f4f83968064 100644 --- a/clients/client-sqs/src/commands/TagQueueCommand.ts +++ b/clients/client-sqs/src/commands/TagQueueCommand.ts @@ -14,7 +14,7 @@ import { } from "@aws-sdk/types"; import { TagQueueRequest } from "../models/models_0"; -import { de_TagQueueCommand, se_TagQueueCommand } from "../protocols/Aws_json1_0"; +import { de_TagQueueCommand, se_TagQueueCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -55,7 +55,7 @@ export interface TagQueueCommandOutput extends __MetadataBearer {} *Cross-account permissions don't apply to this action. For more information, * see Grant - * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
+ * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. *The accountId is invalid.
When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link QueueDoesNotExist} (client fault) - *The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/commands/UntagQueueCommand.ts b/clients/client-sqs/src/commands/UntagQueueCommand.ts index c76784a8db6a8..d4c815dce8416 100644 --- a/clients/client-sqs/src/commands/UntagQueueCommand.ts +++ b/clients/client-sqs/src/commands/UntagQueueCommand.ts @@ -14,7 +14,7 @@ import { } from "@aws-sdk/types"; import { UntagQueueRequest } from "../models/models_0"; -import { de_UntagQueueCommand, se_UntagQueueCommand } from "../protocols/Aws_json1_0"; +import { de_UntagQueueCommand, se_UntagQueueCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -37,7 +37,7 @@ export interface UntagQueueCommandOutput extends __MetadataBearer {} *Cross-account permissions don't apply to this action. For more information, * see Grant - * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
+ * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide. *The accountId is invalid.
When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link QueueDoesNotExist} (client fault) - *The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- * * @throws {@link SQSServiceException} *Base exception class for all service exceptions from SQS service.
* diff --git a/clients/client-sqs/src/models/models_0.ts b/clients/client-sqs/src/models/models_0.ts index dd627c0f94980..6a89dc3188e4e 100644 --- a/clients/client-sqs/src/models/models_0.ts +++ b/clients/client-sqs/src/models/models_0.ts @@ -15,10 +15,7 @@ export interface AddPermissionRequest { QueueUrl: string | undefined; /** - *The unique identification of the permission you're setting (for example,
- * AliceSendMessage). Maximum 80 characters. Allowed characters include
- * alphanumeric characters, hyphens (-), and underscores
- * (_).
The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).
The action the client wants to allow for the specified principal. Valid values: the
- * name of any action or *.
For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service - * Resource in the Amazon SQS Developer Guide.
- *Specifying SendMessage, DeleteMessage, or
- * ChangeMessageVisibility for ActionName.n also grants
- * permissions for the corresponding batch versions of those actions:
- * SendMessageBatch, DeleteMessageBatch, and
- * ChangeMessageVisibilityBatch.
The action the client wants to allow for the specified principal. Valid values: the name of any action or *.
For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource + * in the Amazon SQS Developer Guide.
+ *Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch,
+ * DeleteMessageBatch, and ChangeMessageVisibilityBatch.
The accountId is invalid.
When the request to a queue is not HTTPS and SigV4.
- */ -export class InvalidSecurity extends __BaseException { - readonly name: "InvalidSecurity" = "InvalidSecurity"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe specified action violates a limit. For example, ReceiveMessage
- * returns this error if the maximum number of in flight messages is reached and
+ * returns this error if the maximum number of inflight messages is reached and
* AddPermission returns this error if the maximum number of permissions
* for the queue is reached.
The specified queue doesn't exist.
- */ -export class QueueDoesNotExist extends __BaseException { - readonly name: "QueueDoesNotExist" = "QueueDoesNotExist"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe request was denied due to request throttling.
- *The rate of requests per second exceeds the AWS KMS request quota for an - * account and Region.
- *A burst or sustained high rate of requests to change the state of the same KMS - * key. This condition is often known as a "hot key."
- *Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store - * might be throttled at a lower-than-expected rate when the Amazon Web Services - * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is - * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
- *Error code 400. Unsupported operation.
- */ -export class UnsupportedOperation extends __BaseException { - readonly name: "UnsupportedOperation" = "UnsupportedOperation"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe receipt handle associated with the message whose visibility timeout is changed.
- * This parameter is returned by the The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the
+ * action.
* ReceiveMessage
- *
- * action.
The new value for the message's visibility timeout (in seconds). Values range:
- * 0 to 43200. Maximum: 12 hours.
The new value for the message's visibility timeout (in seconds). Values range: 0 to 43200. Maximum: 12 hours.
Encloses a receipt handle and an entry id for each message in
* ChangeMessageVisibilityBatch.
*
All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this:
+ * &ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2
+ *
+ * &ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle
+ *
+ * &ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45
+ *
An identifier for this particular receipt handle used to communicate the - * result.
+ *An identifier for this particular receipt handle used to communicate the result.
*The 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 (_).
@@ -308,8 +193,7 @@ export interface ChangeMessageVisibilityBatchRequest { QueueUrl: string | undefined; /** - *A list of receipt handles of the messages for which the visibility timeout must be - * changed.
+ *A list of receipt handles of the messages for which the visibility timeout must be changed.
*/ Entries: ChangeMessageVisibilityBatchRequestEntry[] | undefined; } @@ -358,18 +242,15 @@ export interface ChangeMessageVisibilityBatchResultEntry { * @public *For each message in the batch, the response contains a
* ChangeMessageVisibilityBatchResultEntry
- * tag if the message
- * succeeds or a
+ * tag if the message succeeds or a
* BatchResultErrorEntry
- * tag if the message
- * fails.
A list of
* ChangeMessageVisibilityBatchResultEntry
- *
- * items.
The Id of a batch entry in a batch request doesn't abide by the
- * specification.
The Id of a batch entry in a batch request doesn't abide by the specification.
A queue name can have up to 80 characters.
*Valid values: alphanumeric characters, hyphens (-), and
- * underscores (_).
Valid values: alphanumeric characters, hyphens (-), and underscores (_).
A FIFO queue name must end with the .fifo suffix.
A map of attributes with their corresponding values.
- *The following lists the names, descriptions, and values of the special request
- * parameters that the CreateQueue action uses:
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging + * Your Amazon SQS Queues in the Amazon SQS Developer Guide.
+ *When you use queue tags, keep the following guidelines in mind:
*
- * DelaySeconds – The length of time, in seconds, for which the
- * delivery of all messages in the queue is delayed. Valid values: An integer from
- * 0 to 900 seconds (15 minutes). Default: 0.
Adding more than 50 tags to a queue isn't recommended.
*Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
+ *Tags are case-sensitive.
+ *A new tag with a key identical to that of an existing tag overwrites the existing tag.
+ *For a full list of tag restrictions, see + * Quotas related to queues + * in the Amazon SQS Developer Guide.
+ *To be able to tag a queue on creation, you must have the
+ * sqs:CreateQueue and sqs:TagQueue permissions.
Cross-account permissions don't apply to this action. For more information, + * see Grant + * cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
+ *A map of attributes with their corresponding values.
+ *The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:
- * MaximumMessageSize – The limit of how many bytes a message
- * can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
- * (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
+ *
*
- * MessageRetentionPeriod – The length of time, in seconds, for
- * which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1
- * minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you
- * change a queue's attributes, the change can take up to 60 seconds for most of
- * the attributes to propagate throughout the Amazon SQS system. Changes made to the
- * MessageRetentionPeriod attribute can take up to 15 minutes and
- * will impact existing messages in the queue potentially causing them to be
- * expired and deleted if the MessageRetentionPeriod is reduced below
- * the age of existing messages.
MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
+ *
*
- * Policy – The queue's policy. A valid Amazon Web Services policy. For more
- * information about policy structure, see Overview of Amazon Web Services IAM
- * Policies in the IAM User Guide.
MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).
+ *
*
- * ReceiveMessageWaitTimeSeconds – The length of time, in
- * seconds, for which a
- * ReceiveMessage
- * action waits
- * for a message to arrive. Valid values: An integer from 0 to 20 (seconds).
- * Default: 0.
Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Amazon IAM User Guide.
+ *
*
- * VisibilityTimeout – The visibility timeout for the queue, in
- * seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
- * more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer
- * Guide.
ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a
+ * ReceiveMessage
+ * action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
+ *
* The following attributes apply only to dead-letter queues: - *
- *
* RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality
- * of the source queue as a JSON object. The parameters are as follows:
- * deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to
- * which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
*
- * maxReceiveCount – The number of times a message is delivered to the source queue before being
- * moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount
- * for a queue, Amazon SQS moves the message to the dead-letter-queue.
maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.
+ * When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
+ *
- * RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter
- * queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
- * redrivePermission – The permission type that defines which source queues can
- * specify the current queue as the dead-letter queue. Valid values are:
- * allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can
- * specify this queue as the dead-letter queue.
- * denyAll – No source queues can specify this queue as the dead-letter
- * queue.
- * byQueue – Only queues specified by the sourceQueueArns parameter can specify
- * this queue as the dead-letter queue.
- * sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify
- * this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
- * redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs.
- * To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter
- * to allowAll.
VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see
+ * Visibility Timeout in the Amazon SQS Developer Guide.
* The dead-letter queue of a - * FIFO queue must also be a FIFO queue. Similarly, the dead-letter - * queue of a standard queue must also be a standard queue.
- *The following attributes apply only to server-side-encryption:
*
- * KmsMasterKeyId – The ID of an Amazon Web Services managed customer master
- * 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
- * always alias/aws/sqs, the alias of a custom CMK can, for example,
- * be alias/MyAlias
- * . For more examples, see
- * KeyId in the Key Management Service API
- * Reference.
KmsMasterKeyId – The ID of an Amazon Web Services managed customer master 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 always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias
+ * .
+ * For more examples, see KeyId in the Key Management Service API Reference.
+ *
*
- * KmsDataKeyReusePeriodSeconds – The length of time, in
- * seconds, for which Amazon SQS can reuse a data key to
- * encrypt or decrypt messages before calling KMS again. An integer
- * representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
- * hours). Default: 300 (5 minutes). A shorter time period provides better security
- * but results in more calls to KMS which might incur charges after Free Tier. For
- * more information, see How Does the Data Key Reuse Period Work?
- *
KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt
+ * or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security
+ * but results in more calls to KMS which might incur charges after Free Tier. For more information, see
+ * How Does the Data Key Reuse Period Work?.
+ *
*
- * SqsManagedSseEnabled – Enables server-side queue encryption
- * using SQS owned encryption keys. Only one server-side encryption option is
- * supported per queue (for example, SSE-KMS or SSE-SQS).
SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
* The following attributes apply only to FIFO (first-in-first-out) - * queues:
+ *The following attributes apply only to FIFO (first-in-first-out) queues:
*
- * FifoQueue – Designates a queue as FIFO. Valid values are
- * true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You
- * can provide this attribute only during queue creation. You can't change it for
- * an existing queue. When you set this attribute, you must also provide the
- * MessageGroupId for your messages explicitly.
For more information, see FIFO queue logic in the Amazon SQS Developer - * Guide.
+ *FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.
+ * You can provide this attribute only during queue creation. You can't change it for an existing queue.
+ * When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.
+ * For more information, see + * FIFO queue logic + * in the Amazon SQS Developer Guide.
*
- * ContentBasedDeduplication – Enables content-based
- * deduplication. Valid values are true and false. For
- * more information, see Exactly-once processing in the Amazon SQS Developer
- * Guide. Note the following:
ContentBasedDeduplication – Enables content-based deduplication. Valid values are true and false. For more information, see Exactly-once processing in the
+ * Amazon SQS Developer Guide. Note the following:
+ *
* Every message must have a unique
- * MessageDeduplicationId.
Every message must have a unique MessageDeduplicationId.
You may provide a MessageDeduplicationId
- * explicitly.
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a
- * MessageDeduplicationId and you enable
- * ContentBasedDeduplication for your queue, Amazon SQS
- * uses a SHA-256 hash to generate the
- * MessageDeduplicationId using the body of the
- * message (but not the attributes of the message).
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue,
+ * Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
+ *
If you don't provide a MessageDeduplicationId and
- * the queue doesn't have ContentBasedDeduplication
- * set, the action fails with an error.
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,
+ * the action fails with an error.
If the queue has ContentBasedDeduplication set,
- * your MessageDeduplicationId overrides the generated
- * one.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages
- * with identical content sent within the deduplication interval are
- * treated as duplicates and only one copy of the message is
- * delivered.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
+ * and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
- * enabled and then another message with a
- * MessageDeduplicationId that is the same as the one
- * generated for the first MessageDeduplicationId, the two
- * messages are treated as duplicates and only one copy of the message is
- * delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same
+ * as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
+ *
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging - * Your Amazon SQS Queues in the Amazon SQS Developer Guide.
- *When you use queue tags, keep the following guidelines in mind:
- *Adding more than 50 tags to a queue isn't recommended.
- *Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
- *Tags are case-sensitive.
- *A new tag with a key identical to that of an existing tag overwrites the existing tag.
- *For a full list of tag restrictions, see - * Quotas related to queues - * in the Amazon SQS Developer Guide.
- *To be able to tag a queue on creation, you must have the
- * sqs:CreateQueue and sqs:TagQueue permissions.
Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
- *The specified attribute doesn't exist.
- */ -export class InvalidAttributeName extends __BaseException { - readonly name: "InvalidAttributeName" = "InvalidAttributeName"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeA queue attribute value is invalid.
- */ -export class InvalidAttributeValue extends __BaseException { - readonly name: "InvalidAttributeValue" = "InvalidAttributeValue"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeYou must wait 60 seconds after deleting a queue before you can create another queue @@ -887,8 +644,6 @@ export interface DeleteMessageRequest { /** * @public - * @deprecated - * *
The specified receipt handle isn't valid for the current version.
*/ export class InvalidIdFormat extends __BaseException { @@ -913,8 +668,7 @@ export class InvalidIdFormat extends __BaseException { */ export interface DeleteMessageBatchRequestEntry { /** - *An identifier for this particular receipt handle. This is used to communicate the - * result.
+ *An identifier for this particular receipt handle. This is used to communicate the result.
*The 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 (_).
@@ -960,13 +714,11 @@ export interface DeleteMessageBatchResultEntry { /** * @public - *For each message in the batch, the response contains a For each message in the batch, the response contains a
+ * tag if the message can't be deleted.
* DeleteMessageBatchResultEntry
- * tag if the message is deleted
- * or a
+ * tag if the message is deleted or a
* BatchResultErrorEntry
- * tag if the message can't be
- * deleted.
A list of attributes for which to retrieve information.
- *The AttributeNames parameter is optional, but if you don't specify values
- * for this parameter, the request returns empty results.
The AttributeName.N parameter is optional, but if you don't specify values 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.
*The following attributes are supported:
*The ApproximateNumberOfMessagesDelayed,
- * ApproximateNumberOfMessagesNotVisible, and
- * ApproximateNumberOfMessages metrics may not achieve consistency
- * until at least 1 minute after the producers stop sending messages. This period is
- * required for the queue metadata to reach eventual consistency.
The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible,
+ * and ApproximateNumberOfMessagesVisible metrics may not achieve consistency
+ * until at least 1 minute after the producers stop sending messages. This period is required for
+ * the queue metadata to reach eventual consistency.
- * ApproximateNumberOfMessages – Returns the approximate
- * number of messages available for retrieval from the queue.
ApproximateNumberOfMessages – Returns the approximate number of
+ * messages available for retrieval from the queue.
*
- * ApproximateNumberOfMessagesDelayed – Returns the
- * approximate number of messages in the queue that are delayed and not available
- * for reading immediately. This can happen when the queue is configured as a delay
- * queue or when a message has been sent with a delay parameter.
ApproximateNumberOfMessagesDelayed – Returns the approximate number
+ * of messages in the queue that are delayed and not available for reading
+ * immediately. This can happen when the queue is configured as a delay queue or
+ * when a message has been sent with a delay parameter.
*
- * ApproximateNumberOfMessagesNotVisible – Returns the
- * approximate number of messages that are in flight. Messages are considered to be
+ * ApproximateNumberOfMessagesNotVisible – Returns the approximate
+ * number of messages that are in flight. Messages are considered to be
* in flight if they have been sent to a client but have
- * not yet been deleted or have not yet reached the end of their visibility window.
- *
- * CreatedTimestamp – Returns the time when the queue was
- * created in seconds (epoch
- * time).
CreatedTimestamp – Returns the time when the queue was created in
+ * seconds (epoch
+ * time).
* @@ -1060,24 +810,19 @@ export interface GetQueueAttributesRequest { *
- * LastModifiedTimestamp – Returns the time when the queue
- * was last changed in seconds (epoch time).
LastModifiedTimestamp – Returns the time when the queue was last
+ * changed in seconds (epoch
+ * time).
*
- * MaximumMessageSize – Returns the limit of how many bytes a
- * message can contain before Amazon SQS rejects it.
MaximumMessageSize – Returns the limit of how many bytes a message
+ * can contain before Amazon SQS rejects it.
*
- * MessageRetentionPeriod – Returns the length of time, in
- * seconds, for which Amazon SQS retains a message. When you change a queue's
- * attributes, the change can take up to 60 seconds for most of the attributes to
- * propagate throughout the Amazon SQS system. Changes made to the
- * MessageRetentionPeriod attribute can take up to 15 minutes and
- * will impact existing messages in the queue potentially causing them to be
- * expired and deleted if the MessageRetentionPeriod is reduced below
- * the age of existing messages.
MessageRetentionPeriod – Returns the length of time, in seconds,
+ * for which Amazon SQS retains a message.
* @@ -1090,119 +835,64 @@ export interface GetQueueAttributesRequest { *
- * ReceiveMessageWaitTimeSeconds – Returns the length of
- * time, in seconds, for which the ReceiveMessage action waits for a
- * message to arrive.
ReceiveMessageWaitTimeSeconds – Returns the length of time, in
+ * seconds, for which the ReceiveMessage action waits for a message to
+ * arrive.
*
- * VisibilityTimeout – Returns the visibility timeout for the
- * queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer
- * Guide.
The following attributes apply only to dead-letter queues: - *
- *
* RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality
- * of the source queue as a JSON object. The parameters are as follows:
- * deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to
- * which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
*
- * maxReceiveCount – The number of times a message is delivered to the source queue before being
- * moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount
- * for a queue, Amazon SQS moves the message to the dead-letter-queue.
maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.
+ * When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
- * RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter
- * queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
- * redrivePermission – The permission type that defines which source queues can
- * specify the current queue as the dead-letter queue. Valid values are:
- * allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can
- * specify this queue as the dead-letter queue.
- * denyAll – No source queues can specify this queue as the dead-letter
- * queue.
- * byQueue – Only queues specified by the sourceQueueArns parameter can specify
- * this queue as the dead-letter queue.
- * sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify
- * this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
- * redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs.
- * To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter
- * to allowAll.
VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
+ *
* The dead-letter queue of a - * FIFO queue must also be a FIFO queue. Similarly, the dead-letter - * queue of a standard queue must also be a standard queue.
- *The following attributes apply only to server-side-encryption:
*
- * KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer
- * master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
+ *
*
- * KmsDataKeyReusePeriodSeconds – Returns the length of time,
- * in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt
- * messages before calling KMS again. For more information, see
- * How Does the Data Key Reuse Period Work?.
KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again.
+ * For more information, see How Does the Data Key Reuse Period Work?.
+ *
*
- * SqsManagedSseEnabled – Returns information about whether the
- * queue is using SSE-SQS encryption using SQS owned encryption keys. Only one
- * server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
SqsManagedSseEnabled – Returns information about whether the queue is using SSE-SQS encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
* The following attributes apply only to FIFO (first-in-first-out) - * queues:
+ *The following attributes apply only to FIFO (first-in-first-out) queues:
*
- * FifoQueue – Returns information about whether the queue is
- * FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer
- * Guide.
FifoQueue – Returns information about whether the queue is FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer Guide.
* To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
- * ContentBasedDeduplication – Returns whether content-based
- * deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer
- * Guide.
ContentBasedDeduplication – Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.
+ *
* The following attributes apply only to
@@ -1250,15 +940,33 @@ export interface GetQueueAttributesResult {
Attributes?: Record The specified attribute doesn't exist. The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values:
- * alphanumeric characters, hyphens ( The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens ( Queue URLs and names are case-sensitive. For more information, see Interpreting Responses in the Amazon SQS Developer
- * Guide. For more information, see Interpreting Responses in the Amazon SQS Developer Guide. The specified queue doesn't exist. Maximum number of results to include in the response. Value range is 1 to 1000. You
- * must set Maximum number of results to include in the response. Value range is 1 to 1000.
+ * You must set A list of source queue URLs that have the A list of source queue URLs that have the Pagination token to include in the next request. Token value is Pagination token to include in the next request. Token value is A string to use for filtering the list results. Only those queues whose name begins
- * with the specified string are returned. A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue URLs and names are case-sensitive. Maximum number of results to include in the response. Value range is 1 to 1000. You
- * must set Maximum number of results to include in the response. Value range is 1 to 1000.
+ * You must set A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in
- * the request. Pagination token to include in the next request. Token value is Pagination token to include in the next request. Token value is A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in the request. Indicates that the specified queue previously received a Indicates that the specified queue previously received a The URL of the queue from which the The URL of the queue from which the Queue URLs and names are case-sensitive. The caller doesn't have the required KMS access. The request was denied due to request throttling. The request was rejected for one of the following reasons: The KeyUsage value of the KMS key is incompatible with the API
- * operation. The encryption algorithm or signing algorithm specified for the operation is
- * incompatible with the type of key material in the KMS key (KeySpec). The request was rejected because the state of the specified resource is not valid for
- * this request. The request was rejected because the specified entity or resource could not be found.
- * The request was rejected because the specified key policy isn't syntactically or
- * semantically correct. Amazon Web Services KMS throttles requests for the following conditions. A list of attributes that need to be returned along with each message. These
- * attributes include: A list of attributes that need to be returned along with each message. These attributes
+ * include:
@@ -1597,19 +1161,16 @@ export interface ReceiveMessageRequest {
*
- * -), and underscores
- * (_).-), and underscores (_).MaxResults to receive a value for NextToken in the
- * response.MaxResults to receive a value for NextToken in the response.RedrivePolicy queue attribute
- * configured with a dead-letter queue.RedrivePolicy queue attribute configured with a dead-letter queue.null if
- * there are no additional results to request, or if you did not set
- * MaxResults in the request.null if there are no additional
+ * results to request, or if you did not set MaxResults in the request.MaxResults to receive a value for NextToken in the
- * response.MaxResults to receive a value for NextToken in the response.null if there are no additional
+ * results to request, or if you did not set MaxResults in the request.null if
- * there are no additional results to request, or if you did not set
- * MaxResults in the request.PurgeQueue
- * request within the last 60 seconds (the time it can take to delete the messages in the
- * queue).PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).PurgeQueue action deletes
- * messages.PurgeQueue action deletes messages.
- *
- */
-export class KmsInvalidKeyUsage extends __BaseException {
- readonly name: "KmsInvalidKeyUsage" = "KmsInvalidKeyUsage";
- readonly $fault: "client" = "client";
- /**
- * @internal
- */
- constructor(opts: __ExceptionOptionType
*
ApproximateFirstReceiveTimestamp – Returns the time the
- * message was first received from the queue (epoch time in
- * milliseconds).ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds).
- * ApproximateReceiveCount – Returns the number of times a
- * message has been received across all queues but not deleted.
ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted.
*
- * AWSTraceHeader – Returns the X-Ray trace
- * header string.
AWSTraceHeader – Returns the X-Ray trace header string.
+ *
* @@ -1617,26 +1178,20 @@ export interface ReceiveMessageRequest { *
*For a user, returns the user ID, for example
- * ABCDEFGHI1JKLMNOPQ23R.
For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
For an IAM role, returns the IAM role ID, for example
- * ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
- * SentTimestamp – Returns the time the message was sent to the
- * queue (epoch time in
- * milliseconds).
SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds).
*
- * SqsManagedSseEnabled – Enables server-side queue encryption
- * using SQS owned encryption keys. Only one server-side encryption option is
- * supported per queue (for example, SSE-KMS or SSE-SQS).
SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
* @@ -1648,17 +1203,15 @@ export interface ReceiveMessageRequest { *
- * MessageGroupId – Returns the value provided by the
- * producer that calls the
+ * MessageGroupId – Returns the value provided by the producer that
+ * calls the
* SendMessage
- * action.
- * Messages with the same MessageGroupId are returned in
- * sequence.
MessageGroupId are returned in sequence.
*
- * SequenceNumber – Returns the value provided by
- * Amazon SQS.
SequenceNumber – Returns the value provided by Amazon SQS.
* The name of the message attribute, where N is the index.
*The name can contain alphanumeric characters and the underscore
- * (_), hyphen (-), and period
- * (.).
The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).
The name is case-sensitive and must be unique among all attribute names for - * the message.
+ *The name is case-sensitive and must be unique among all attribute names for the message.
*The name must not start with AWS-reserved prefixes such as AWS.
- * or Amazon. (or any casing variants).
The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).
The name must not start or end with a period (.), and it should
- * not have periods in succession (..).
The name must not start or end with a period (.), and it should not have periods in succession (..).
The name can be up to 256 characters long.
*When using ReceiveMessage, you can send a list of attribute names to
- * receive, or you can return all of the attributes by specifying All or
- * .* in your request. You can also use all message attributes starting
- * with a prefix, for example bar.*.
When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request.
+ * You can also use all message attributes starting with a prefix, for example bar.*.
The maximum number of messages to return. Amazon SQS never returns more messages than this - * value (however, fewer messages might be returned). Valid values: 1 to 10. Default: - * 1.
+ *The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.
*/ MaxNumberOfMessages?: number; /** - *The duration (in seconds) that the received messages are hidden from subsequent
- * retrieve requests after being retrieved by a ReceiveMessage request.
The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
The duration (in seconds) for which the call waits for a message to arrive in the
- * queue before returning. If a message is available, the call returns sooner than
- * WaitTimeSeconds. If no messages are available and the wait time
- * expires, the call returns successfully with an empty list of messages.
The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds.
+ * If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
To avoid HTTP errors, ensure that the HTTP response timeout for
- * ReceiveMessage requests is longer than the
- * WaitTimeSeconds parameter. For example, with the Java SDK, you can
- * set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage
+ * requests is longer than the WaitTimeSeconds parameter. For example,
+ * with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
This parameter applies only to FIFO (first-in-first-out) queues.
- *The token used for deduplication of ReceiveMessage calls. If a networking
- * issue occurs after a ReceiveMessage action, and instead of a response you
- * receive a generic error, it is possible to retry the same action with an identical
- * ReceiveRequestAttemptId to retrieve the same set of messages, even if
- * their visibility timeout has not yet expired.
The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error,
+ * it is possible to retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId only for 5 minutes after a
- * ReceiveMessage action.
You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
When you set FifoQueue, a caller of the
- * ReceiveMessage action can provide a
- * ReceiveRequestAttemptId explicitly.
When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
If a caller of the ReceiveMessage action doesn't provide a
- * ReceiveRequestAttemptId, Amazon SQS generates a
- * ReceiveRequestAttemptId.
If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.
It is possible to retry the ReceiveMessage action with the same
- * ReceiveRequestAttemptId if none of the messages have been
- * modified (deleted or had their visibility changes).
It is possible to retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same
- * ReceiveRequestAttemptId return the same messages and receipt
- * handles. If a retry occurs within the deduplication interval, it resets the
- * visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer
- * Guide.
During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval,
+ * it resets the visibility timeout. For more information, see
+ * Visibility Timeout
+ * in the Amazon SQS Developer Guide.
If a caller of the ReceiveMessage action still processes
* messages when the visibility timeout expires and messages become visible,
@@ -1762,30 +1291,23 @@ export interface ReceiveMessageRequest {
* and therefore process duplicates. Also, if a consumer whose message
* processing time is longer than the visibility timeout tries to delete the
* processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe - * threshold before the visibility timeout expires and extend the visibility - * timeout as necessary.
+ *To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
*While messages with a particular MessageGroupId are invisible, no
- * more messages belonging to the same MessageGroupId are returned
- * until the visibility timeout expires. You can still receive messages with
- * another MessageGroupId as long as it is also visible.
While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive
+ * messages with another MessageGroupId as long as it is also visible.
If a caller of ReceiveMessage can't track the
- * ReceiveRequestAttemptId, no retries work until the original
- * visibility timeout expires. As a result, delays might occur but the messages in
- * the queue remain in a strict order.
If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but
+ * the messages in the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId is 128 characters.
- * ReceiveRequestAttemptId can contain alphanumeric characters
- * (a-z, A-Z, 0-9) and punctuation
- * (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~).
For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS
- * Developer Guide.
The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and
+ * punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~).
For best practices of using ReceiveRequestAttemptId, see
+ * Using the ReceiveRequestAttemptId Request Parameter
+ * in the Amazon SQS Developer Guide.
The user-specified message attribute value. For string data types, the
- * The user-specified message attribute value. For string data types, the
- * Value attribute has the same restrictions on the content as the message
- * body. For more information, see
+ * Value attribute has the same restrictions on the content as the message body. For more information, see
* SendMessage.
* Name, type, value and the message body must not
- * be empty or null. All parts of the message attribute, including Name,
- * Type, and Value, are part of the message size restriction
- * (256 KiB or 262,144 bytes).Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KB or 262,144 bytes).
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable - * Characters.
+ *Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
*/ StringValue?: string; /** - *Binary type attributes can store any binary data, such as compressed data, encrypted - * data, or images.
+ *Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
*/ BinaryValue?: Uint8Array; @@ -1847,11 +1362,8 @@ export interface MessageAttributeValue { BinaryListValues?: Uint8Array[]; /** - *Amazon SQS supports the following logical data types: String,
- * Number, and Binary. For the Number data type,
- * you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer - * Guide.
+ *Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
*/ DataType: string | undefined; } @@ -1862,15 +1374,12 @@ export interface MessageAttributeValue { */ export interface Message { /** - *A unique identifier for the message. A MessageIdis considered unique
- * across all Amazon Web Services accounts for an extended period of time.
A unique identifier for the message. A MessageIdis considered unique 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 - * is returned every time you receive a message. When deleting a message, you provide the - * last received receipt handle to delete the message.
+ *An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
*/ ReceiptHandle?: string; @@ -1887,8 +1396,8 @@ export interface Message { /** *A map of the attributes requested in
* ReceiveMessage
- * to
- * their respective values. Supported attributes:
@@ -1927,9 +1436,8 @@ export interface Message { *
- * ApproximateFirstReceiveTimestamp and SentTimestamp are each
- * returned as an integer representing the epoch time in
- * milliseconds.
ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the
+ * epoch time in milliseconds.
*/
Attributes?: RecordThe identification of the permission to remove. This is the label added using the
- * The identification of the permission to remove. This is the label added using the The user-specified message system attribute value. For string data types, the
- * The user-specified message system attribute value. For string data types, the
- * Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable
- * Characters. Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters. Binary type attributes can store any binary data, such as compressed data, encrypted
- * data, or images. Binary type attributes can store any binary data, such as compressed data, encrypted data, or images. Amazon SQS supports the following logical data types: You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer
- * Guide. Amazon SQS supports the following logical data types: You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide. The message to send. The minimum size is one character. The maximum size is 256
- * KiB. The message to send. The minimum size is one character. The maximum size is 256 KB. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
@@ -2081,10 +1579,10 @@ export interface SendMessageRequest {
MessageBody: string | undefined;
/**
- * The length of time, in seconds, for which to delay a specific message. Valid values:
- * 0 to 900. Maximum: 15 minutes. Messages with a positive
+ * The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive When you set This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of sent messages. If a message with a particular
- * The token used for deduplication of sent messages. If a message with a particular Every message must have a unique You may provide a You may provide a If you aren't able to provide a If you aren't able to provide a If you don't provide a If you don't provide a If the queue has If the queue has When When If you send one message with If you send one message with The If a message is sent successfully but the acknowledgement is lost and the message
- * is resent with the same If a message is sent successfully but the acknowledgement is lost and the message is resent with the same
+ * Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted. The maximum length of For best practices of using The maximum length of For best practices of using
+ *
* AddPermission
* action.Value attribute has the same restrictions on the content as the message
- * body. For more information, see
+ * Value attribute has the same restrictions on the content as the message body. For more information, see
* SendMessage.
* Name, type, value and the message body must not
- * be empty or null.Name, type, value and the message body must not be empty or null.String,
- * Number, and Binary. For the Number data type,
- * you must use StringValue.String, Number, and Binary. For the Number data type, you must use StringValue.DelaySeconds value
- * become available for processing after the delay period is finished. If you don't specify
- * a value, the default value for the queue applies. DelaySeconds value become available for processing after the delay period is finished.
+ * If you don't specify a value, the default value for the queue applies.
+ * FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.MessageDeduplicationId is sent successfully, any messages sent with the
- * same MessageDeduplicationId are accepted successfully but aren't delivered
- * during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer
- * Guide.MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId
+ * are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see
+ * Exactly-once processing in the Amazon SQS Developer Guide.
*
* MessageDeduplicationId,
*
* MessageDeduplicationId
- * explicitly.MessageDeduplicationId explicitly.MessageDeduplicationId
- * and you enable ContentBasedDeduplication for your queue,
- * Amazon SQS uses a SHA-256 hash to generate the
- * MessageDeduplicationId using the body of the message
- * (but not the attributes of the message). MessageDeduplicationId and you enable ContentBasedDeduplication for your queue,
+ * Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
+ * MessageDeduplicationId and the
- * queue doesn't have ContentBasedDeduplication set, the
- * action fails with an error.MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,
+ * the action fails with an error.ContentBasedDeduplication set, your
- * MessageDeduplicationId overrides the generated
- * one.ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.ContentBasedDeduplication is in effect, messages with
- * identical content sent within the deduplication interval are treated as
- * duplicates and only one copy of the message is delivered.ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
+ * and only one copy of the message is delivered.ContentBasedDeduplication enabled
- * and then another message with a MessageDeduplicationId that is the
- * same as the one generated for the first MessageDeduplicationId, the
- * two messages are treated as duplicates and only one copy of the message is
- * delivered. ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same
+ * as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
+ * MessageDeduplicationId is available to the consumer of the
* message (this can be useful for troubleshooting delivery issues).MessageDeduplicationId after the deduplication
- * interval, Amazon SQS can't detect duplicate messages.MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.MessageDeduplicationId is 128 characters.
- * MessageDeduplicationId can contain alphanumeric characters
- * (a-z, A-Z, 0-9) and punctuation
- * (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~).MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer
- * Guide.MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and
+ * punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~).MessageDeduplicationId, see
+ * Using the MessageDeduplicationId Property
+ * in the Amazon SQS Developer Guide.
You must associate a non-empty MessageGroupId with a message. If
- * you don't provide a MessageGroupId, the action fails.
You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
- * ReceiveMessage might return messages with multiple
- * MessageGroupId values. For each MessageGroupId,
- * the messages are sorted by time sent. The caller can't specify a
- * MessageGroupId.
ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't
+ * specify a MessageGroupId.
* The length of MessageGroupId is 128 characters. Valid values:
- * alphanumeric characters and punctuation
- * (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~).
For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer
- * Guide.
The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~).
For best practices of using MessageGroupId, see
+ * Using the MessageGroupId Property
+ * in the Amazon SQS Developer Guide.
- * MessageGroupId is required for FIFO queues. You can't use it for
- * Standard queues.
MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
* An attribute containing the MessageId of the message sent to the queue.
- * For more information, see Queue and Message Identifiers in the Amazon SQS Developer
- * Guide.
An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers
+ * in the Amazon SQS Developer Guide.
+ *
This parameter applies only to FIFO (first-in-first-out) queues.
*The large, non-consecutive number that Amazon SQS assigns to each message.
- *The length of SequenceNumber is 128 bits. SequenceNumber
- * continues to increase for a particular MessageGroupId.
The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.
Error code 400. Unsupported operation.
+ */ +export class UnsupportedOperation extends __BaseException { + readonly name: "UnsupportedOperation" = "UnsupportedOperation"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe length of all the messages put together is more than the limit.
@@ -2293,10 +1792,9 @@ export interface SendMessageBatchRequestEntry { MessageBody: string | undefined; /** - *The length of time, in seconds, for which a specific message is delayed. Valid values:
- * 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value
- * become available for processing after the delay period is finished. If you don't specify
- * a value, the default value for the queue is applied.
The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished.
+ * If you don't specify 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.
This parameter applies only to FIFO (first-in-first-out) queues.
- *The token used for deduplication of messages within a 5-minute minimum deduplication
- * interval. If a message with a particular MessageDeduplicationId is sent
- * successfully, subsequent messages with the same MessageDeduplicationId are
- * accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer
- * Guide.
The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular
+ * MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are
+ * accepted successfully but aren't delivered. For more information, see
+ * Exactly-once processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId
- * explicitly.
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId
- * and you enable ContentBasedDeduplication for your queue,
- * Amazon SQS uses a SHA-256 hash to generate the
- * MessageDeduplicationId using the body of the message
- * (but not the attributes of the message).
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue,
+ * Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
+ *
If you don't provide a MessageDeduplicationId and the
- * queue doesn't have ContentBasedDeduplication set, the
- * action fails with an error.
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,
+ * the action fails with an error.
If the queue has ContentBasedDeduplication set, your
- * MessageDeduplicationId overrides the generated
- * one.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with
- * identical content sent within the deduplication interval are treated as
- * duplicates and only one copy of the message is delivered.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
+ * and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled
- * and then another message with a MessageDeduplicationId that is the
- * same as the one generated for the first MessageDeduplicationId, the
- * two messages are treated as duplicates and only one copy of the message is
- * delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same
+ * as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
+ *
The MessageDeduplicationId is available to the consumer of the
* message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message
- * is resent with the same MessageDeduplicationId after the deduplication
- * interval, Amazon SQS can't detect duplicate messages.
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same
+ * MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
*The length of MessageDeduplicationId is 128 characters.
- * MessageDeduplicationId can contain alphanumeric characters
- * (a-z, A-Z, 0-9) and punctuation
- * (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~).
For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer
- * Guide.
The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and
+ * punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~).
For best practices of using MessageDeduplicationId, see
+ * Using the MessageDeduplicationId Property
+ * in the Amazon SQS Developer Guide.
You must associate a non-empty MessageGroupId with a message. If
- * you don't provide a MessageGroupId, the action fails.
You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
- * ReceiveMessage might return messages with multiple
- * MessageGroupId values. For each MessageGroupId,
- * the messages are sorted by time sent. The caller can't specify a
- * MessageGroupId.
ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't
+ * specify a MessageGroupId.
* The length of MessageGroupId is 128 characters. Valid values:
- * alphanumeric characters and punctuation
- * (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~).
For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer
- * Guide.
The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~).
For best practices of using MessageGroupId, see
+ * Using the MessageGroupId Property
+ * in the Amazon SQS Developer Guide.
- * MessageGroupId is required for FIFO queues. You can't use it for
- * Standard queues.
MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
* This parameter applies only to FIFO (first-in-first-out) queues.
*The large, non-consecutive number that Amazon SQS assigns to each message.
- *The length of SequenceNumber is 128 bits. As SequenceNumber
- * continues to increase for a particular MessageGroupId.
The length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId.
For each message in the batch, the response contains a
* SendMessageBatchResultEntry
- * tag if the message succeeds or a
- *
+ * tag if the message succeeds or a
* BatchResultErrorEntry
- * tag if the message
- * fails.
A list of
* BatchResultErrorEntry
- * items with error
- * details about each message that can't be enqueued.
A map of attributes to set.
- *The following lists the names, descriptions, and values of the special request
- * parameters that the SetQueueAttributes action uses:
The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:
- * DelaySeconds – The length of time, in seconds, for which the
- * delivery of all messages in the queue is delayed. Valid values: An integer from
- * 0 to 900 (15 minutes). Default: 0.
DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.
+ *
*
- * MaximumMessageSize – The limit of how many bytes a message
- * can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
- * (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
+ *
*
- * MessageRetentionPeriod – The length of time, in seconds, for
- * which Amazon SQS retains a message. Valid values: An integer representing seconds,
- * from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you
- * change a queue's attributes, the change can take up to 60 seconds for most of
- * the attributes to propagate throughout the Amazon SQS system. Changes made to the
- * MessageRetentionPeriod attribute can take up to 15 minutes and
- * will impact existing messages in the queue potentially causing them to be
- * expired and deleted if the MessageRetentionPeriod is reduced below
- * the age of existing messages.
MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
+ *
*
- * Policy – The queue's policy. A valid Amazon Web Services policy. For more
- * information about policy structure, see Overview of Amazon Web Services IAM
- * Policies in the Identity and Access Management User
- * Guide.
Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies
+ * in the Identity and Access Management User Guide.
+ *
*
- * ReceiveMessageWaitTimeSeconds – The length of time, in
- * seconds, for which a
+ * ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a
* ReceiveMessage
- * action waits
- * for a message to arrive. Valid values: An integer from 0 to 20 (seconds).
- * Default: 0.
- * VisibilityTimeout – The visibility timeout for the queue, in
- * seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For
- * more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer
- * Guide.
The following attributes apply only to dead-letter queues: - *
- *
* RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality
- * of the source queue as a JSON object. The parameters are as follows:
- * deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to
- * which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
*
- * maxReceiveCount – The number of times a message is delivered to the source queue before being
- * moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount
- * for a queue, Amazon SQS moves the message to the dead-letter-queue.
maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.
+ * When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
* The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
+ *
- * RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter
- * queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
- * redrivePermission – The permission type that defines which source queues can
- * specify the current queue as the dead-letter queue. Valid values are:
- * allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can
- * specify this queue as the dead-letter queue.
- * denyAll – No source queues can specify this queue as the dead-letter
- * queue.
- * byQueue – Only queues specified by the sourceQueueArns parameter can specify
- * this queue as the dead-letter queue.
- * sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify
- * this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the
- * redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs.
- * To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter
- * to allowAll.
VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout,
+ * see Visibility Timeout in the Amazon SQS Developer Guide.
* The dead-letter queue of a - * FIFO queue must also be a FIFO queue. Similarly, the dead-letter - * queue of a standard queue must also be a standard queue.
- *The following attributes apply only to server-side-encryption:
*
- * KmsMasterKeyId – The ID of an Amazon Web Services managed customer master
- * 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
- * always alias/aws/sqs, the alias of a custom CMK can, for example,
- * be alias/MyAlias
- * . For more examples, see
- * KeyId in the Key Management Service API
- * Reference.
KmsMasterKeyId – The ID of an Amazon Web Services managed customer master 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 always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias
+ * .
+ * For more examples, see KeyId in the Key Management Service API Reference.
+ *
*
- * KmsDataKeyReusePeriodSeconds – The length of time, in
- * seconds, for which Amazon SQS can reuse a data key to
- * encrypt or decrypt messages before calling KMS again. An integer
- * representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
- * hours). Default: 300 (5 minutes). A shorter time period provides better security
- * but results in more calls to KMS which might incur charges after Free Tier. For
- * more information, see How Does the Data Key Reuse Period Work?.
KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt
+ * or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security
+ * but results in more calls to KMS which might incur charges after Free Tier. For more information, see
+ * How Does the Data Key Reuse Period Work?.
+ *
*
- * SqsManagedSseEnabled – Enables server-side queue encryption
- * using SQS owned encryption keys. Only one server-side encryption option is
- * supported per queue (for example, SSE-KMS or SSE-SQS).
SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
* The following attribute applies only to FIFO (first-in-first-out) - * queues:
+ *The following attribute applies only to FIFO (first-in-first-out) queues:
*
- * ContentBasedDeduplication – Enables content-based
- * deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer
- * Guide. Note the following:
ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the
+ * Amazon SQS Developer Guide. Note the following:
+ *
* Every message must have a unique
- * MessageDeduplicationId.
Every message must have a unique MessageDeduplicationId.
You may provide a MessageDeduplicationId
- * explicitly.
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a
- * MessageDeduplicationId and you enable
- * ContentBasedDeduplication for your queue, Amazon SQS
- * uses a SHA-256 hash to generate the
- * MessageDeduplicationId using the body of the
- * message (but not the attributes of the message).
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue,
+ * Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
+ *
If you don't provide a MessageDeduplicationId and
- * the queue doesn't have ContentBasedDeduplication
- * set, the action fails with an error.
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,
+ * the action fails with an error.
If the queue has ContentBasedDeduplication set,
- * your MessageDeduplicationId overrides the generated
- * one.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages
- * with identical content sent within the deduplication interval are
- * treated as duplicates and only one copy of the message is
- * delivered.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates
+ * and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
- * enabled and then another message with a
- * MessageDeduplicationId that is the same as the one
- * generated for the first MessageDeduplicationId, the two
- * messages are treated as duplicates and only one copy of the message is
- * delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same
+ * as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
+ *
Adds a permission to a queue for a specific \n principal.\n This allows sharing access to the queue.
\nWhen you create a queue, you have full control access rights for the queue.\n Only you, the owner of the queue, can grant or deny permissions to the queue.\n For more information about these permissions, see\n Allow \n Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
\n\n AddPermission generates a policy for you. You can use \n \n SetQueueAttributes\n to\n upload your policy. For more information, see\n Using Custom Policies with the Amazon SQS Access Policy Language in\n the Amazon SQS Developer Guide.
An Amazon SQS policy can have a maximum of 7 actions.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name 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, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).
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 name of any action or *.
For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource \n in the Amazon SQS Developer Guide.
\nSpecifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch,\n DeleteMessageBatch, and ChangeMessageVisibilityBatch.
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 between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
\nFor information on the permissions you need to use this API, see\n Identity and\n access management in the Amazon SQS Developer Guide.\n
\nYou can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
\nCryptographically sign your service requests
\nRetry requests
\nHandle error responses
\n\n Additional information\n
\n\n Amazon SQS Developer Guide\n
\n\n Making API Requests\n
\n\n Amazon Web Services General Reference\n
\nWelcome 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" + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } + ] } + ] }, - "com.amazonaws.sqs#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.sqs#BoxedInteger": { - "type": "integer" - }, - "com.amazonaws.sqs#ChangeMessageVisibility": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#ChangeMessageVisibilityRequest" + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.af-south-1.amazonaws.com" + } + }, + "params": { + "Region": "af-south-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "output": { - "target": "smithy.api#Unit" + { + "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-east-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "errors": [ - { - "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 20,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": "A list of receipt handles of the messages for which the visibility timeout must be\n changed.
", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "ChangeMessageVisibilityBatchRequestEntry" - } - } + { + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-northeast-3.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-3", + "UseFIPS": false, + "UseDualStack": false + } }, - "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.
" - } - } + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "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": {} - } - } + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } }, - "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 get the queue URL, use the \n GetQueueUrl\n action.\n \n GetQueueUrl\n requires only the\n QueueName parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and\n values of all the queue's attributes, CreateQueue returns the queue\n URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an\n existing queue, CreateQueue returns an error.
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 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
\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.
" - } - } + { + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.eu-south-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-south-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "Returns the QueueUrl attribute of the created queue.
Deletes the specified message from the specified queue. To select the message to\n delete, use the ReceiptHandle of the message (not the\n MessageId which you receive when you send the message). Amazon SQS can\n delete a message from a queue even if a visibility timeout setting causes the message to\n be locked by another consumer. Amazon SQS automatically deletes messages left in a queue\n longer than the retention period configured for the queue.
The ReceiptHandle is associated with a specific\n instance of receiving a message. If you receive a message more than\n once, the ReceiptHandle is different each time you receive a message.\n When you use the DeleteMessage action, you must provide the most\n recently received ReceiptHandle for the message (otherwise, the request\n succeeds, but the message will 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": "A list of receipt handles for the messages to be deleted.
", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "DeleteMessageBatchRequestEntry" - } - } + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "", - "smithy.api#input": {} - } - }, - "com.amazonaws.sqs#DeleteMessageBatchRequestEntry": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An identifier for this particular receipt handle. This is used to communicate the\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": {} - } - } + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "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": {} - } - } + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } }, - "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": {} - } - } + { + "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": true, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "", - "smithy.api#input": {} - } - }, - "com.amazonaws.sqs#DeleteQueue": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#DeleteQueueRequest" + { + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "output": { - "target": "smithy.api#Unit" + { + "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-west-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "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": {} - } - } + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "", - "smithy.api#input": {} - } - }, - "com.amazonaws.sqs#EmptyBatchRequest": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } + { + "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": true, + "UseDualStack": false + } }, - "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" + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } }, - "output": { - "target": "com.amazonaws.sqs#GetQueueAttributesResult" + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "errors": [ - { - "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" - } - } + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "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" - } - } + { + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.cn-northwest-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-northwest-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "A list of returned queue attributes.
" - } - }, - "com.amazonaws.sqs#GetQueueUrl": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#GetQueueUrlRequest" + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } }, - "output": { - "target": "com.amazonaws.sqs#GetQueueUrlResult" + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "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 the URL of an existing Amazon SQS queue.
\nTo access a queue that belongs to another AWS account, use the\n QueueOwnerAWSAccountId parameter to specify the account ID of the\n queue's owner. The queue's owner must grant you permission to access the queue. For more\n information about shared queue access, see \n AddPermission\n \n or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS\n Developer Guide.
The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values:\n alphanumeric characters, hyphens (-), and underscores\n (_).
Queue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "QueueOwnerAWSAccountId": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID of the account that created the queue.
" - } - } + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "traits": { - "smithy.api#documentation": "", - "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.
" - } - } + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "For more information, see Interpreting Responses in the Amazon SQS Developer\n Guide.
" - } - }, - "com.amazonaws.sqs#InvalidAddress": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidAddress", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "The accountId is invalid.
The specified attribute doesn't exist.
", - "smithy.api#error": "client" - } - }, - "com.amazonaws.sqs#InvalidAttributeValue": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "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" - } + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "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" - } + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "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" - } + { + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs.us-iso-west-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-west-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidSecurity", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "When the request to a queue is not HTTPS and SigV4.
", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.sqs#KmsAccessDenied": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } }, - "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" - } + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "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" - } + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "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" - } + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } }, - "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" - } + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://sqs-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "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" - } + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "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" + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } }, - "output": { - "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesResult" + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } }, - "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.
" - } - }, - "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" - } - } - } - }, - "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 that you sent in\n the request.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "QueueUrl" - } - }, - "NextToken": { - "target": "com.amazonaws.sqs#Token", - "traits": { - "smithy.api#documentation": "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.
" - } - }, - "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 (256 KiB or 262,144 bytes).
The specified message isn't in flight.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.sqs#MessageSystemAttributeMap": { - "type": "map", - "key": { - "target": "com.amazonaws.sqs#MessageSystemAttributeName", - "traits": { - "smithy.api#xmlName": "Name" - } - }, - "value": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#xmlName": "Value" - } - } - }, - "com.amazonaws.sqs#MessageSystemAttributeName": { - "type": "enum", - "members": { - "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" - } - } - } - }, - "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 the messages in a queue specified by the QueueURL\n parameter.
When you use the PurgeQueue action, you can't retrieve any messages\n deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for 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": "The specified queue doesn't exist.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.sqs#QueueNameExists": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, - "traits": { - "aws.protocols#awsQueryError": { - "code": "QueueAlreadyExists", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "A queue with this name already exists. Amazon SQS returns this error only if the request\n includes attributes whose values differ from those of the existing queue.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.sqs#QueueUrlList": { - "type": "list", - "member": { - "target": "com.amazonaws.sqs#String" - } - }, - "com.amazonaws.sqs#ReceiptHandleIsInvalid": { - "type": "structure", - "members": { - "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#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. Thus, only the messages on the sampled machines\n are returned. If the number of messages in the queue is small (fewer than 1,000), you\n most likely get fewer messages than you requested per ReceiveMessage call.\n If the number of messages in the queue is extremely small, you might not receive any\n messages in a particular ReceiveMessage response. If this happens, repeat\n 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. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
A message that isn't deleted or a message whose visibility isn't extended before the\n visibility timeout expires counts as a failed receive. Depending on the configuration of\n the queue, the message might be sent to the dead-letter queue.
\nIn the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nThe URL of the Amazon SQS queue from which messages are received.
\nQueue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "AttributeNames": { - "target": "com.amazonaws.sqs#AttributeNameList", - "traits": { - "smithy.api#documentation": "A list of attributes that need to be returned along with each message. These\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 Messages with the same MessageGroupId are returned in\n sequence.
\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.
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 returns successfully with an empty list of messages.
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.
If a caller of the ReceiveMessage action doesn't provide a\n ReceiveRequestAttemptId, Amazon SQS generates a\n ReceiveRequestAttemptId.
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, no\n more messages belonging to the same MessageGroupId are returned\n until the visibility timeout expires. You can still receive messages with\n another MessageGroupId as long as it is also 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.
A list of messages.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Message" - } - } - }, - "traits": { - "smithy.api#documentation": "A list of received messages.
" - } - }, - "com.amazonaws.sqs#RemovePermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#RemovePermissionRequest" - }, - "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.
\nThe rate of requests per second exceeds the AWS KMS request quota for an\n account and Region.
\nA burst or sustained high rate of requests to change the state of the same KMS\n key. This condition is often known as a \"hot key.\"
\nRequests for operations on KMS keys in a Amazon Web Services CloudHSM key store\n might be throttled at a lower-than-expected rate when the Amazon Web Services\n CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is\n processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
\nDelivers a message to the specified queue.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\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 256 KiB (262,144\n bytes).
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nIf you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses\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.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId with a message. If\n you don't provide a MessageGroupId, the action fails.
\n ReceiveMessage might return messages with multiple\n MessageGroupId values. For each MessageGroupId,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId.
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.
\n MessageGroupId is required for FIFO queues. You can't use it for\n Standard queues.
Contains the details of a single Amazon SQS message along with an Id.
A list of \n SendMessageBatchResultEntry\n items.
A list of \n BatchResultErrorEntry\n items with error\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 256\n KiB.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\n 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.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId with a message. If\n you don't provide a MessageGroupId, the action fails.
\n ReceiveMessage might return messages with multiple\n MessageGroupId values. For each MessageGroupId,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId.
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.
\n MessageGroupId is required for FIFO queues. You can't use it for\n Standard queues.
An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" - } - }, - "MD5OfMessageAttributes": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" - } - }, - "MD5OfMessageSystemAttributes": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message system attribute string. You can use this \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. When you change a queue's attributes,\n the change can take up to 60 seconds for most of the attributes to propagate throughout\n the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can\n take up to 15 minutes and will impact existing messages in the queue potentially causing\n them to be expired and deleted if the MessageRetentionPeriod is reduced\n below the age of existing 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 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
\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#String": { - "type": "string" - }, - "com.amazonaws.sqs#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#xmlName": "StringListValue" - } - } - }, - "com.amazonaws.sqs#TagKey": { - "type": "string" - }, - "com.amazonaws.sqs#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.sqs#TagKey" - } - }, - "com.amazonaws.sqs#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.sqs#TagKey", - "traits": { - "smithy.api#xmlName": "Key" - } - }, - "value": { - "target": "com.amazonaws.sqs#TagValue", - "traits": { - "smithy.api#xmlName": "Value" - } - } - }, - "com.amazonaws.sqs#TagQueue": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#TagQueueRequest" - }, - "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": "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.
", - "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" + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } }, - "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" - } - } + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } }, - "traits": { - "smithy.api#input": {} + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.sqs#AttributeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#QueueAttributeName" + } + }, + "com.amazonaws.sqs#BatchEntryIdsNotDistinct": { + "type": "structure", + "members": {}, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.BatchEntryIdsNotDistinct", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "Two 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#ChangeMessageVisibility": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#MessageNotInflight" + }, + { + "target": "com.amazonaws.sqs#ReceiptHandleIsInvalid" + } + ], + "traits": { + "smithy.api#documentation": "Changes the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
\nFor example, you have a message with a visibility timeout of 5 minutes. After 3\n minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You\n can continue to call ChangeMessageVisibility to extend the visibility\n timeout to the maximum allowed time. If you try to extend the visibility timeout beyond\n the maximum, your request is rejected.
An Amazon SQS message has three basic states:
\nSent to a queue by a producer.
\nReceived from the queue by a consumer.
\nDeleted from the queue.
\nA message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages.\n A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.
\nLimits that apply to inflight messages are unrelated to the unlimited number of stored messages.
\nFor most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). \n If you reach this limit, Amazon SQS returns the OverLimit error message.\n To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.\n To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
\nIf you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout \n for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.
Changes the visibility timeout of multiple messages. This is a batch version of \n ChangeMessageVisibility. The result of the action on each message is reported individually in the response. \n You can send up to 10 \n ChangeMessageVisibility\n requests with each ChangeMessageVisibilityBatch action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
The URL of the Amazon SQS queue whose messages' visibility is changed.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "Entries": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntryList", + "traits": { + "smithy.api#documentation": "A list of receipt handles of the messages for which the visibility timeout must be changed.
", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "ChangeMessageVisibilityBatchRequestEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "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 result.
\nThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nA receipt handle.
", + "smithy.api#required": {} + } + }, + "VisibilityTimeout": { + "target": "com.amazonaws.sqs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The new value (in seconds) for the message's visibility timeout.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Encloses a receipt handle and an entry id for each message in \n ChangeMessageVisibilityBatch.\n
All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this:
\n &ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2\n
\n &ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle\n
\n &ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45\n
A list of \n ChangeMessageVisibilityBatchResultEntry\n items.
A list of \n BatchResultErrorEntry\n items.
For each message in the batch, the response contains a \n ChangeMessageVisibilityBatchResultEntry\n tag if the message succeeds or a \n BatchResultErrorEntry\n tag if the message fails.
Represents a message whose visibility timeout has been changed successfully.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Encloses the Id of an entry in \n ChangeMessageVisibilityBatch.\n
The URL of the Amazon SQS queue whose message's visibility is changed.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "ReceiptHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the \n ReceiveMessage\n action.
The new value for the message's visibility timeout (in seconds). Values range: 0 to 43200. Maximum: 12 hours.
Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:
\nIf you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon SQS Developer Guide.
\nIf you don't provide a value for an attribute, the queue is created with the default value for the attribute.
\nIf you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
\nTo successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.
\nAfter you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.
\nTo get the queue URL, use the \n GetQueueUrl\n action. \n GetQueueUrl\n requires only the QueueName parameter.\n be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name 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 underscores (_).
A FIFO queue name must end with the .fifo suffix.
Queue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.sqs#TagMap", + "traits": { + "smithy.api#documentation": "Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \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 user name in the Amazon SQS Developer Guide.
\nA map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:
\n DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.\n
\n MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).\n
\n MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).\n
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Amazon IAM User Guide.\n
\n ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a \n ReceiveMessage\n action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.\n
\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.\n When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
\n\n VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see \n Visibility Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n While the alias of the Amazon Web Services managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias\n .\n For more examples, see KeyId in the Key Management Service API Reference.\n
\n KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt \n or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security \n but results in more calls to KMS which might incur charges after Free Tier. For more information, see \n How Does the Data Key Reuse Period Work?.\n
\n SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out) queues:
\n\n FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. \n You can provide this attribute only during queue creation. You can't change it for an existing queue. \n When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.
For more information, see \n FIFO queue logic \n in the Amazon SQS Developer Guide.
\n\n ContentBasedDeduplication – Enables content-based deduplication. Valid values are true and false. For more information, see Exactly-once processing in the \n Amazon SQS Developer Guide. Note the following:\n
Every message must have a unique MessageDeduplicationId.
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
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" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#CreateQueueResult": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The URL of the created Amazon SQS queue.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Returns the QueueUrl attribute of the created queue.
Deletes the specified message from the specified queue. To select the message to\n delete, use the ReceiptHandle of the message (not the\n MessageId which you receive when you send the message). Amazon SQS can\n delete a message from a queue even if a visibility timeout setting causes the message to\n be locked by another consumer. Amazon SQS automatically deletes messages left in a queue\n longer than the retention period configured for the queue.
The ReceiptHandle is associated with a specific\n instance of receiving a message. If you receive a message more than\n once, the ReceiptHandle is different each time you receive a message.\n When you use the DeleteMessage action, you must provide the most\n recently received ReceiptHandle for the message (otherwise, the request\n succeeds, but the message might not be deleted).
For standard queues, it is possible to receive a message even after you\n delete it. This might happen on rare occasions if one of the servers which stores a\n copy of the message is unavailable when you send the request to delete the message.\n The copy remains on the server and might be returned to you during a subsequent\n receive request. You should ensure that your application is idempotent, so that\n receiving a message more than once does not cause issues.
\nDeletes up to ten messages from the specified queue. This is a batch version of \n DeleteMessage. The result of the action on each message is reported individually in the response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
The URL of the Amazon SQS queue from which messages are deleted.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "Entries": { + "target": "com.amazonaws.sqs#DeleteMessageBatchRequestEntryList", + "traits": { + "smithy.api#documentation": "A list of receipt handles for the messages to be deleted.
", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "DeleteMessageBatchRequestEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#DeleteMessageBatchRequestEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "An identifier for this particular receipt handle. This is used to communicate the result.
\nThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nA receipt handle.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Encloses a receipt handle and an identifier for it.
" + } + }, + "com.amazonaws.sqs#DeleteMessageBatchRequestEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#DeleteMessageBatchRequestEntry" + } + }, + "com.amazonaws.sqs#DeleteMessageBatchResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.sqs#DeleteMessageBatchResultEntryList", + "traits": { + "smithy.api#documentation": "A list of \n DeleteMessageBatchResultEntry\n items.
A list of \n BatchResultErrorEntry\n items.
For each message in the batch, the response contains a \n DeleteMessageBatchResultEntry\n tag if the message is deleted or a \n BatchResultErrorEntry\n tag if the message can't be deleted.
Represents a successfully deleted message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Encloses the Id of an entry in \n DeleteMessageBatch.\n
The URL of the Amazon SQS queue from which messages are deleted.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "ReceiptHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The receipt handle associated with the message to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#DeleteQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#DeleteQueueRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Deletes the queue specified by the QueueUrl, regardless of the queue's contents.
Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.\n
When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a \n \n SendMessage\n request might succeed, but after 60 seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nThe URL of the Amazon SQS queue to delete.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#EmptyBatchRequest": { + "type": "structure", + "members": {}, + "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#GetQueueAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#GetQueueAttributesRequest" + }, + "output": { + "target": "com.amazonaws.sqs#GetQueueAttributesResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAttributeName" + } + ], + "traits": { + "smithy.api#documentation": "Gets attributes for the specified queue.
\nTo determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
The URL of the Amazon SQS queue whose attribute information is retrieved.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "AttributeNames": { + "target": "com.amazonaws.sqs#AttributeNameList", + "traits": { + "smithy.api#documentation": "A list of attributes for which to retrieve information.
\nThe AttributeName.N parameter is optional, but if you don't specify values for this parameter,\n 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, ApproximateNumberOfMessagesNotVisible, \n and ApproximateNumberOfMessagesVisible metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is required for \n the queue metadata to reach eventual consistency.
\n All – Returns all values.
\n ApproximateNumberOfMessages – Returns the approximate number of\n messages available for retrieval from the queue.
\n ApproximateNumberOfMessagesDelayed – Returns the approximate number\n of messages in the queue that are delayed and not available for reading\n immediately. This can happen when the queue is configured as a delay queue or\n when a message has been sent with a delay parameter.
\n ApproximateNumberOfMessagesNotVisible – Returns the approximate\n number of messages that are in flight. Messages are considered to be\n in flight if they have been sent to a client but have\n not yet been deleted or have not yet reached the end of their visibility window.
\n CreatedTimestamp – Returns the time when the queue was created in\n seconds (epoch\n time).
\n DelaySeconds – Returns the default delay on the queue in\n seconds.
\n LastModifiedTimestamp – Returns the time when the queue was last\n changed in seconds (epoch\n time).
\n MaximumMessageSize – Returns the limit of how many bytes a message\n can contain before Amazon SQS rejects it.
\n MessageRetentionPeriod – Returns the length of time, in seconds,\n for which Amazon SQS retains a message.
\n Policy – Returns the policy of the queue.
\n QueueArn – Returns the Amazon resource name (ARN) of the\n queue.
\n ReceiveMessageWaitTimeSeconds – Returns the length of time, in\n seconds, for which the ReceiveMessage action waits for a message to\n arrive.
\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.\n When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.\n
The following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n
\n KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again.\n For more information, see How Does the Data Key Reuse Period Work?.\n
\n SqsManagedSseEnabled – Returns information about whether the queue is using SSE-SQS encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out) queues:
\n\n FifoQueue – Returns information about whether the queue is FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer Guide.
To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
\n ContentBasedDeduplication – Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.\n
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.
" + } + }, + "com.amazonaws.sqs#GetQueueUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#GetQueueUrlRequest" + }, + "output": { + "target": "com.amazonaws.sqs#GetQueueUrlResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + } + ], + "traits": { + "smithy.api#documentation": "Returns the URL of an existing Amazon SQS queue.
\nTo access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. \n For more information about shared queue access, see \n AddPermission\n or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.\n
The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_).
Queue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "QueueOwnerAWSAccountId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the account that created the queue.
" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "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 Guide.
" + } + }, + "com.amazonaws.sqs#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.sqs#InvalidAttributeName": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The specified attribute doesn't exist.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#InvalidBatchEntryId": { + "type": "structure", + "members": {}, + "traits": { + "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 specification.
The specified receipt handle isn't valid for the current version.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#InvalidMessageContents": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The message contains characters outside the allowed set.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#ListDeadLetterSourceQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.
The ListDeadLetterSourceQueues methods supports\n pagination. Set parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults,\n the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to\n display, the response includes a value for NextToken. Use\n NextToken as a parameter in your next request to\n ListDeadLetterSourceQueues to receive the next page of results.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "queueUrls", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sqs#ListDeadLetterSourceQueuesRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The URL of a dead-letter queue.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.sqs#Token", + "traits": { + "smithy.api#documentation": "Pagination token to request the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sqs#BoxedInteger", + "traits": { + "smithy.api#documentation": "Maximum number of results to include in the response. Value range is 1 to 1000. \n You must set MaxResults to receive a value for NextToken in the response.
A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.
Pagination token to include in the next request. Token value is null if there are no additional\n results to request, or if you did not set MaxResults in the request.
A list of your dead letter source queues.
" + } + }, + "com.amazonaws.sqs#ListQueueTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListQueueTagsRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ListQueueTagsResult" + }, + "traits": { + "smithy.api#documentation": "List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging \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 user name 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" + } + } + } + }, + "com.amazonaws.sqs#ListQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListQueuesRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ListQueuesResult" + }, + "traits": { + "smithy.api#documentation": "Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional \n QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.
The listQueues methods supports\n pagination. Set parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults,\n the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to\n display, the response includes a value for NextToken. Use\n NextToken as a parameter in your next request to\n listQueues to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nA string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.
\nQueue URLs and names are case-sensitive.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sqs#Token", + "traits": { + "smithy.api#documentation": "Pagination token to request the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sqs#BoxedInteger", + "traits": { + "smithy.api#documentation": "Maximum number of results to include in the response. Value range is 1 to 1000. \n You must set MaxResults to receive a value for NextToken in the response.
Pagination token to include in the next request. Token value is null if there are no additional\n results to request, or if you did not set MaxResults in the request.
A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in the request.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "QueueUrl" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of your queues.
" + } + }, + "com.amazonaws.sqs#Message": { + "type": "structure", + "members": { + "MessageId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services accounts for an extended period of time.
An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
" + } + }, + "MD5OfBody": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message body string.
" + } + }, + "Body": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The message's contents (not URL-encoded).
" + } + }, + "Attributes": { + "target": "com.amazonaws.sqs#MessageSystemAttributeMap", + "traits": { + "smithy.api#documentation": "A map of the attributes requested in \n ReceiveMessage\n to their respective values. \n Supported attributes:
\n ApproximateReceiveCount\n
\n ApproximateFirstReceiveTimestamp\n
\n MessageDeduplicationId\n
\n MessageGroupId\n
\n SenderId\n
\n SentTimestamp\n
\n SequenceNumber\n
\n ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the \n epoch time in milliseconds.
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" + } + }, + "MessageAttributes": { + "target": "com.amazonaws.sqs#MessageBodyAttributeMap", + "traits": { + "smithy.api#documentation": "Each message attribute consists of a Name, Type, \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 Characters.
" + } + }, + "BinaryValue": { + "target": "com.amazonaws.sqs#Binary", + "traits": { + "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
" + } + }, + "StringListValues": { + "target": "com.amazonaws.sqs#StringList", + "traits": { + "smithy.api#documentation": "Not implemented. Reserved for future use.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "StringListValue" + } + }, + "BinaryListValues": { + "target": "com.amazonaws.sqs#BinaryList", + "traits": { + "smithy.api#documentation": "Not implemented. Reserved for future use.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "BinaryListValue" + } + }, + "DataType": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The user-specified message attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see \n SendMessage.\n
\n Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KB or 262,144 bytes).
The specified message isn't in flight.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#MessageSystemAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sqs#MessageSystemAttributeName", + "traits": { + "smithy.api#xmlName": "Name" + } + }, + "value": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sqs#MessageSystemAttributeName": { + "type": "enum", + "members": { + "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" + } + } + } + }, + "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 Characters.
" + } + }, + "BinaryValue": { + "target": "com.amazonaws.sqs#Binary", + "traits": { + "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
" + } + }, + "StringListValues": { + "target": "com.amazonaws.sqs#StringList", + "traits": { + "smithy.api#documentation": "Not implemented. Reserved for future use.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "StringListValue" + } + }, + "BinaryListValues": { + "target": "com.amazonaws.sqs#BinaryList", + "traits": { + "smithy.api#documentation": "Not implemented. Reserved for future use.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "BinaryListValue" + } + }, + "DataType": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The user-specified message system attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see \n SendMessage.\n
\n Name, type, value and the message body must not be empty or null.
The specified action violates a limit. For example, ReceiveMessage\n returns this error if the maximum number of inflight messages is reached and\n AddPermission returns this error if the maximum number of permissions\n for the queue is reached.
Deletes the messages in a queue specified by the QueueURL\n parameter.
When you use the PurgeQueue action, you can't retrieve any messages\n deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for\n 60 seconds regardless of your queue's size.
\nMessages sent to the queue before you call\n PurgeQueue might be received but are deleted within the next\n minute.
Messages sent to the queue after you call\n PurgeQueue might be deleted while the queue is being purged.
Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).
The URL of the queue from which the PurgeQueue action deletes messages.
Queue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "", + "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": {}, + "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": {}, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.NonExistentQueue", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The specified queue doesn't exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#QueueNameExists": { + "type": "structure", + "members": {}, + "traits": { + "aws.protocols#awsQueryError": { + "code": "QueueAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "A queue with this name already exists. Amazon SQS returns this error only if the request\n includes attributes whose values differ from those of the existing queue.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#QueueUrlList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#String" + } + }, + "com.amazonaws.sqs#ReceiptHandleIsInvalid": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The specified receipt handle isn't valid.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#ReceiveMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ReceiveMessageRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ReceiveMessageResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#OverLimit" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. \n For more information, see Amazon SQS Long Polling in the Amazon SQS Developer Guide.\n
Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. \n If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, \n you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.\n
For each message returned, the response includes the following:
\nThe message body.
\nAn MD5 digest of the message body. For information about MD5, see RFC1321.
\nThe MessageId you received when you sent the message to the queue.
The receipt handle.
\nThe message attributes.
\nAn MD5 digest of the message attributes.
\nThe receipt handle is the identifier you must provide when deleting the message. For more information, see Queue \n and Message Identifiers in the Amazon SQS Developer Guide.
\nYou can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue \n is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.
\nIn the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nThe URL of the Amazon SQS queue from which messages are received.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "AttributeNames": { + "target": "com.amazonaws.sqs#AttributeNameList", + "traits": { + "smithy.api#documentation": "A list of attributes that need to be returned along with each message. These attributes\n include:
\n\n All – Returns all values.
\n ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds).
\n ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted.
\n AWSTraceHeader – Returns the X-Ray trace header string.\n
\n SenderId\n
For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
\n SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds).
\n SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. 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 producer that\n calls the \n SendMessage\n action. Messages with the\n same MessageGroupId are returned in sequence.
\n SequenceNumber – Returns the value provided by Amazon SQS.
The name of the message attribute, where N is the index.
\nThe name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).
The name is case-sensitive and must be unique among all attribute names for the message.
\nThe name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).
The name must not start or end with a period (.), and it should not have periods in succession (..).
The name can be up to 256 characters long.
\nWhen using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. \n You can also use all message attributes starting with a prefix, for example bar.*.
The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.
" + } + }, + "VisibilityTimeout": { + "target": "com.amazonaws.sqs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds.\n If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage\n requests is longer than the WaitTimeSeconds parameter. For example,\n with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, \n it is possible to retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.
It is possible to retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, \n it resets the visibility timeout. For more information, see\n Visibility Timeout\n in the Amazon SQS Developer Guide.
If a caller of the ReceiveMessage action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
\nWhile messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive\n messages with another MessageGroupId as long as it is also visible.
If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but\n the messages in the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using ReceiveRequestAttemptId, see\n Using the ReceiveRequestAttemptId Request Parameter\n in the Amazon SQS Developer Guide.
A list of messages.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Message" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of received messages.
" + } + }, + "com.amazonaws.sqs#RemovePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#RemovePermissionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Revokes any permissions in the queue policy that matches the specified Label parameter.
Only the owner of a queue can remove permissions from it.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name 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 AddPermission\n action.
Delivers a message to the specified queue.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nDelivers up to ten messages to the specified queue. This is a batch version of \n SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nIf you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
The URL of the Amazon SQS queue to which batched messages are sent.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "Entries": { + "target": "com.amazonaws.sqs#SendMessageBatchRequestEntryList", + "traits": { + "smithy.api#documentation": "A list of \n SendMessageBatchRequestEntry\n items.
An identifier for a message in this batch used to communicate the result.
\nThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nThe body of the message.
", + "smithy.api#required": {} + } + }, + "DelaySeconds": { + "target": "com.amazonaws.sqs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished.\n If you don't specify a value, the default value for the queue is applied.\n
When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
Each message attribute consists of a Name, Type, \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 interval. If a message with a particular \n MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are \n accepted successfully but aren't delivered. For more information, see \n Exactly-once processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same \n MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
\nThe length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see\n Using the MessageDeduplicationId Property\n in the Amazon SQS Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
\n ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't \n specify a MessageGroupId.
The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see\n Using the MessageGroupId Property\n in the Amazon SQS Developer Guide.
\n MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
Contains the details of a single Amazon SQS message along with an Id.
A list of \n SendMessageBatchResultEntry\n items.
A list of \n BatchResultErrorEntry\n items with error details about each message that can't be enqueued.
For each message in the batch, the response contains a \n SendMessageBatchResultEntry\n tag if the message succeeds or a \n BatchResultErrorEntry\n tag if the message fails.
An identifier for the message in this batch.
", + "smithy.api#required": {} + } + }, + "MessageId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "An identifier for the message.
", + "smithy.api#required": {} + } + }, + "MD5OfMessageBody": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
", + "smithy.api#required": {} + } + }, + "MD5OfMessageAttributes": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" + } + }, + "MD5OfMessageSystemAttributes": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message system attribute string. You can use this \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 continues to increase for a particular MessageGroupId.
Encloses a MessageId for a successfully-enqueued message in a \n SendMessageBatch.\n
The URL of the Amazon SQS queue to which a message is sent.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "MessageBody": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The message to send. The minimum size is one character. The maximum size is 256 KB.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\n\n The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished.\n If you don't specify a value, the default value for the queue applies.\n
When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
Each message attribute consists of a Name, Type, \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 MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId \n are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see \n Exactly-once processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same \n MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
\nThe maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see\n Using the MessageDeduplicationId Property\n in the Amazon SQS Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
\n ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't \n specify a MessageGroupId.
The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see\n Using the MessageGroupId Property\n in the Amazon SQS Developer Guide.
\n MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" + } + }, + "MD5OfMessageAttributes": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" + } + }, + "MD5OfMessageSystemAttributes": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message system attribute string. You can use this \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. For more information, see Queue and Message Identifiers\n in the Amazon SQS Developer Guide.\n
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe large, non-consecutive number that Amazon SQS assigns to each message.
\nThe length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.
The MD5OfMessageBody and MessageId elements.
Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. \n Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name 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 parameters that the SetQueueAttributes action uses:
\n DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.\n
\n MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).\n
\n MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).\n
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies \n in the Identity and Access Management User Guide.\n
\n ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a \n ReceiveMessage\n action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.\n
\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.\n When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
\n\n VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout,\n see Visibility Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias\n .\n For more examples, see KeyId in the Key Management Service API Reference.\n
\n KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt \n or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security \n but results in more calls to KMS which might incur charges after Free Tier. For more information, see \n How Does the Data Key Reuse Period Work?.\n
\n SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
The following attribute applies only to FIFO (first-in-first-out) queues:
\n\n ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the \n Amazon SQS Developer Guide. Note the following:\n
Every message must have a unique MessageDeduplicationId.
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
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#String": { + "type": "string" + }, + "com.amazonaws.sqs#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#xmlName": "StringListValue" + } + } + }, + "com.amazonaws.sqs#TagKey": { + "type": "string" + }, + "com.amazonaws.sqs#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#TagKey" + } + }, + "com.amazonaws.sqs#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sqs#TagKey", + "traits": { + "smithy.api#xmlName": "Key" + } + }, + "value": { + "target": "com.amazonaws.sqs#TagValue", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sqs#TagQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#TagQueueRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "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.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name 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": {}, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.TooManyEntriesInBatchRequest", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The batch request contains more entries than permissible.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#UnsupportedOperation": { + "type": "structure", + "members": {}, + "traits": { + "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" + }, + "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 user name 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": {} + } } + } }