From b3f5a9d536b2b92c9e0a6856b90dfaed0d3b7db1 Mon Sep 17 00:00:00 2001
From: awstools 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 Handle error responses
Additional information
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 Cryptographically sign your service requests Retry requests Retry requests Handle error responses Handle error responses
+ *
* Additional information
*
- * Amazon SQS Product Page
- *
+ * Amazon SQS Product Page
+ *
+ *
* Amazon SQS Developer Guide
*
* Making API Requests
@@ -421,19 +423,20 @@ export interface SQS {
*
+ *
+ *
* Amazon Web Services General Reference
* 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 Cryptographically sign your service requests Retry requests Retry requests Handle error responses Handle error responses
+ *
* Additional information
*
- * Amazon SQS Product Page
- *
+ * Amazon SQS Product Page
+ *
+ *
* Amazon SQS Developer Guide
*
* Making API Requests
@@ -358,19 +360,20 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {}
*
+ *
+ *
* Amazon Web Services General Reference
* 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.
+ *
*
-
+ *
*
- *
- *
+ *
*
+ *
*
*
+ *
*
diff --git a/clients/client-sqs/src/SQSClient.ts b/clients/client-sqs/src/SQSClient.ts
index d1c64cde3a64..95b4ce2edd4c 100644
--- a/clients/client-sqs/src/SQSClient.ts
+++ b/clients/client-sqs/src/SQSClient.ts
@@ -308,38 +308,40 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {}
/**
* @public
*
+ *
*
- *
- *
+ *
*
+ *
*
*
+ *
*
diff --git a/clients/client-sqs/src/commands/AddPermissionCommand.ts b/clients/client-sqs/src/commands/AddPermissionCommand.ts
index 6466b84688d8..af69398b0268 100644
--- a/clients/client-sqs/src/commands/AddPermissionCommand.ts
+++ b/clients/client-sqs/src/commands/AddPermissionCommand.ts
@@ -14,7 +14,7 @@ import {
} from "@aws-sdk/types";
import { AddPermissionRequest } from "../models/models_0";
-import { de_AddPermissionCommand, se_AddPermissionCommand } from "../protocols/Aws_query";
+import { de_AddPermissionCommand, se_AddPermissionCommand } from "../protocols/Aws_json1_0";
import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
/**
@@ -32,45 +32,39 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {}
/**
* @public
- *
*
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 7 actions.
+ *An Amazon SQS policy can have a maximum of seven actions per statement.
*To remove the ability to change queue permissions, you must deny permission to the AddPermission
, RemovePermission
, and SetQueueAttributes
actions in your IAM policy.
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 user name in the Amazon SQS Developer Guide.
+ * 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 OverLimit} (client fault) *The specified action violates a limit. For example, ReceiveMessage
- * returns this error if the maximum number of inflight messages is reached and
+ * 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/ChangeMessageVisibilityBatchCommand.ts b/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts index 9aa4c51b80d1..66ac714c0c8d 100644 --- a/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts +++ b/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts @@ -14,7 +14,10 @@ import { } from "@aws-sdk/types"; import { ChangeMessageVisibilityBatchRequest, ChangeMessageVisibilityBatchResult } from "../models/models_0"; -import { de_ChangeMessageVisibilityBatchCommand, se_ChangeMessageVisibilityBatchCommand } from "../protocols/Aws_query"; +import { + de_ChangeMessageVisibilityBatchCommand, + se_ChangeMessageVisibilityBatchCommand, +} from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -34,21 +37,17 @@ 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 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 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 4c86d0c05186..b8cbd9a2aa30 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_query"; +import { de_ChangeMessageVisibilityCommand, se_ChangeMessageVisibilityCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -34,13 +34,16 @@ 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, 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:
+ * 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.
An Amazon SQS message has three basic states:
*Sent to a queue by a producer.
@@ -53,18 +56,23 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer { *A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. - * A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.
- *Limits that apply to inflight messages are unrelated to the unlimited number of stored messages.
- *For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). + * 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).
* If you reach this limit, Amazon SQS returns the OverLimit
error message.
* To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.
* To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
- * + *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.
*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 b95f4573a36b..1d2cb94a92d6 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_query"; +import { de_CreateQueueCommand, se_CreateQueueCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -36,53 +36,53 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB * the request. Keep the following in mind: *If you don't specify the FifoQueue
attribute, Amazon SQS creates a standard queue.
If you don't specify the FifoQueue
attribute, Amazon SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert * an existing standard queue into a FIFO queue. You must either create a new * FIFO queue for your application or delete your existing standard queue and * recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the * Amazon SQS Developer Guide.
- *If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
+ *If you 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 user name in the Amazon SQS Developer Guide.
+ * cross-account permissions to a role and a username 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.
@@ -121,6 +133,28 @@ 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 f2742a78fdef..da72c9b60037 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_query"; +import { de_DeleteMessageBatchCommand, se_DeleteMessageBatchCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -32,18 +32,13 @@ 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 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 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 7998bc8fc791..941307e16728 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_query"; +import { de_DeleteMessageCommand, se_DeleteMessageCommand } from "../protocols/Aws_json1_0"; 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 might not be deleted).
+ * succeeds, but the message will 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,9 +77,37 @@ 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 c76a0a7ddb19..0cd21e13897f 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_query"; +import { de_DeleteQueueCommand, se_DeleteQueueCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -32,20 +32,25 @@ 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 user name in the Amazon SQS Developer Guide.
+ * 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 ea3a50314fdc..05829506b96a 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_query"; +import { de_GetQueueAttributesCommand, se_GetQueueAttributesCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -45,7 +45,7 @@ export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResul * const input = { // GetQueueAttributesRequest * QueueUrl: "STRING_VALUE", // required * AttributeNames: [ // AttributeNameList - * "STRING_VALUE", + * "All" || "Policy" || "VisibilityTimeout" || "MaximumMessageSize" || "MessageRetentionPeriod" || "ApproximateNumberOfMessages" || "ApproximateNumberOfMessagesNotVisible" || "CreatedTimestamp" || "LastModifiedTimestamp" || "QueueArn" || "ApproximateNumberOfMessagesDelayed" || "DelaySeconds" || "ReceiveMessageWaitTimeSeconds" || "RedrivePolicy" || "FifoQueue" || "ContentBasedDeduplication" || "KmsMasterKeyId" || "KmsDataKeyReusePeriodSeconds" || "DeduplicationScope" || "FifoThroughputLimit" || "RedriveAllowPolicy" || "SqsManagedSseEnabled", * ], * }; * const command = new GetQueueAttributesCommand(input); @@ -67,6 +67,34 @@ 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 9b5a4e4277a3..a337345bf4f2 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_query"; +import { de_GetQueueUrlCommand, se_GetQueueUrlCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -33,11 +33,14 @@ 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 9c32d137a5c0..390021297db1 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_query"; +import { de_ListDeadLetterSourceQueuesCommand, se_ListDeadLetterSourceQueuesCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -32,17 +32,17 @@ 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,9 +71,37 @@ 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 7cc6a03eb18e..cb8ca0daeffb 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_query"; +import { de_ListQueueTagsCommand, se_ListQueueTagsCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -32,13 +32,14 @@ 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 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/ListQueuesCommand.ts b/clients/client-sqs/src/commands/ListQueuesCommand.ts index 9b6ad04b53ab..d39ccf98efdf 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_query"; +import { de_ListQueuesCommand, se_ListQueuesCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -32,19 +32,21 @@ 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 user name in the Amazon SQS Developer Guide.
+ * 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 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 17c6127052e5..5c16583d30c3 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_query"; +import { de_PurgeQueueCommand, se_PurgeQueueCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -34,18 +34,17 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {} * @public *Deletes the messages in a queue specified by the QueueURL
* parameter.
When you use the PurgeQueue
action, you can't retrieve any messages
* deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for - * 60 seconds regardless of your queue's size.
+ *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 + *
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 35cf357265a0..374b463375e2 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_query"; +import { de_ReceiveMessageCommand, se_ReceiveMessageCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -33,13 +33,17 @@ 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.
@@ -61,11 +66,17 @@ 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 inflight messages is reached and
+ * 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/RemovePermissionCommand.ts b/clients/client-sqs/src/commands/RemovePermissionCommand.ts index ac9f2402194d..db6fdc68c478 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_query"; +import { de_RemovePermissionCommand, se_RemovePermissionCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -32,20 +32,21 @@ 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.
Only the owner of a queue can remove permissions from it.
- *Cross-account permissions don't apply to this action. For more information, * see Grant - * cross-account permissions to a role and a user name in the Amazon 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 01fc1c8029cb..892b5e0e0682 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_query"; +import { de_SendMessageBatchCommand, se_SendMessageBatchCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -33,25 +33,25 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _ /** * @public - *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).
+ *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).
*A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
- *+ *
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
+ *
* #x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
*
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
+ *Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
*If you don't specify the DelaySeconds
parameter for an entry, Amazon SQS uses the default value for the queue.
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
- * &AttributeName.1=first
- *
- * &AttributeName.2=second
- *
If you don't specify the DelaySeconds
parameter for an entry, Amazon SQS uses
+ * the default value for the queue.
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 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 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 5c2f6d710e39..3f93b34b0535 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_query"; +import { de_SendMessageCommand, se_SendMessageCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -35,11 +35,11 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB * @public *Delivers a message to the specified queue.
*A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
- *+ *
A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
+ *
* #x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
*
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
+ *Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
*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 843b26e2bcb8..e3908da35b7b 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_query"; +import { de_SetQueueAttributesCommand, se_SetQueueAttributesCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -32,21 +32,25 @@ 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.
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.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
- *Cross-account permissions don't apply to this action. For more information, * see Grant - * cross-account permissions to a role and a user name in the Amazon 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 b5a12194b288..c462eadb5234 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_query"; +import { de_TagQueueCommand, se_TagQueueCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -34,7 +34,6 @@ export interface TagQueueCommandOutput extends __MetadataBearer {} * @public *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:
*For a full list of tag restrictions, see * Quotas related to 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 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 6b3c07e59bd6..c76784a8db6a 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_query"; +import { de_UntagQueueCommand, se_UntagQueueCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -34,11 +34,11 @@ export interface UntagQueueCommandOutput extends __MetadataBearer {} * @public *Remove cost allocation tags from 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 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/endpoint/ruleset.ts b/clients/client-sqs/src/endpoint/ruleset.ts index f539c08406de..2d10c14a451d 100644 --- a/clients/client-sqs/src/endpoint/ruleset.ts +++ b/clients/client-sqs/src/endpoint/ruleset.ts @@ -10,23 +10,23 @@ const s="required", t="fn", u="argv", v="ref"; -const a="PartitionResult", +const a="isSet", b="tree", c="error", d="endpoint", -e="getAttr", -f={[s]:false,"type":"String"}, -g={[s]:true,"default":false,"type":"Boolean"}, -h={[v]:"Endpoint"}, -i={[t]:"booleanEquals",[u]:[{[v]:"UseFIPS"},true]}, -j={[t]:"booleanEquals",[u]:[{[v]:"UseDualStack"},true]}, -k={}, -l={[t]:"booleanEquals",[u]:[true,{[t]:e,[u]:[{[v]:a},"supportsFIPS"]}]}, -m={[v]:a}, -n={[t]:"booleanEquals",[u]:[true,{[t]:e,[u]:[m,"supportsDualStack"]}]}, -o={"url":"https://sqs.{Region}.{PartitionResult#dnsSuffix}","properties":{},"headers":{}}, -p=[h], -q=[i], -r=[j]; -const _data={version:"1.0",parameters:{Region:f,UseDualStack:g,UseFIPS:g,Endpoint:f},rules:[{conditions:[{[t]:"aws.partition",[u]:[{[v]:"Region"}],assign:a}],type:b,rules:[{conditions:[{[t]:"isSet",[u]:p},{[t]:"parseURL",[u]:p,assign:"url"}],type:b,rules:[{conditions:q,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:r,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:h,properties:k,headers:k},type:d}]}]},{conditions:[i,j],type:b,rules:[{conditions:[l,n],type:b,rules:[{endpoint:{url:"https://sqs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:q,type:b,rules:[{conditions:[l],type:b,rules:[{type:b,rules:[{conditions:[{[t]:"stringEquals",[u]:["aws-us-gov",{[t]:e,[u]:[m,"name"]}]}],endpoint:o,type:d},{endpoint:{url:"https://sqs-fips.{Region}.{PartitionResult#dnsSuffix}",properties:k,headers:k},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:r,type:b,rules:[{conditions:[n],type:b,rules:[{endpoint:{url:"https://sqs.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:k,headers:k},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:o,type:d}]}]}; +e="PartitionResult", +f="getAttr", +g={[s]:false,"type":"String"}, +h={[s]:true,"default":false,"type":"Boolean"}, +i={[v]:"Endpoint"}, +j={[t]:"booleanEquals",[u]:[{[v]:"UseFIPS"},true]}, +k={[t]:"booleanEquals",[u]:[{[v]:"UseDualStack"},true]}, +l={}, +m={[t]:"booleanEquals",[u]:[true,{[t]:f,[u]:[{[v]:e},"supportsFIPS"]}]}, +n={[v]:e}, +o={[t]:"booleanEquals",[u]:[true,{[t]:f,[u]:[n,"supportsDualStack"]}]}, +p=[j], +q=[k], +r=[{[v]:"Region"}]; +const _data={version:"1.0",parameters:{Region:g,UseDualStack:h,UseFIPS:h,Endpoint:g},rules:[{conditions:[{[t]:a,[u]:[i]}],type:b,rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:i,properties:l,headers:l},type:d}]}]},{type:b,rules:[{conditions:[{[t]:a,[u]:r}],type:b,rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:e}],type:b,rules:[{conditions:[j,k],type:b,rules:[{conditions:[m,o],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://sqs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:p,type:b,rules:[{conditions:[m],type:b,rules:[{type:b,rules:[{conditions:[{[t]:"stringEquals",[u]:["aws-us-gov",{[t]:f,[u]:[n,"name"]}]}],endpoint:{url:"https://sqs.{Region}.amazonaws.com",properties:l,headers:l},type:d},{endpoint:{url:"https://sqs-fips.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:q,type:b,rules:[{conditions:[o],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://sqs.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{endpoint:{url:"https://sqs.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]}; export const ruleSet: RuleSetObject = _data; diff --git a/clients/client-sqs/src/models/models_0.ts b/clients/client-sqs/src/models/models_0.ts index 64f4a0d70256..dd627c0f9498 100644 --- a/clients/client-sqs/src/models/models_0.ts +++ b/clients/client-sqs/src/models/models_0.ts @@ -15,7 +15,10 @@ 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 inflight messages is reached and
+ * 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.
+ */ +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 Id
s 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 (_).
@@ -193,7 +308,8 @@ 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; } @@ -242,15 +358,18 @@ 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.
The name of the new queue. The following limits apply to this name:
*A queue name can have up to 80 characters.
+ *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 FIFO queue name must end with the .fifo
suffix.
Queue URLs and names are case-sensitive.
*/ QueueName: string | undefined; - /** - *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 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:
The following lists the names, descriptions, and values of the special request
+ * parameters that the CreateQueue
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 seconds (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 seconds (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) 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) 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 from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).
- *
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.
*
- * 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.
- *
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.
*
- * 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. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues
- * in the Amazon SQS Developer Guide.
- * 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.
- * 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. Default: 10. 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.
- *
- * 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.
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
.
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 (e.g. 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 (for example, 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.
The following attributes apply only to * high throughput * for FIFO queues:
@@ -569,6 +742,37 @@ export interface CreateQueueRequest { * in the Amazon SQS Developer Guide. */ Attributes?: RecordAdd 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 @@ -643,6 +887,8 @@ export interface DeleteMessageRequest { /** * @public + * @deprecated + * *
The specified receipt handle isn't valid for the current version.
*/ export class InvalidIdFormat extends __BaseException { @@ -667,7 +913,8 @@ 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 Id
s 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 (_).
@@ -713,11 +960,13 @@ 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 AttributeName.N
parameter is optional, but if you don't specify values for this parameter,
- * the request returns empty results.
The AttributeNames
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 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.
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.
- * 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).
* @@ -809,19 +1060,24 @@ 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.
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.
* @@ -834,71 +1090,121 @@ 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. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues
- * in the Amazon SQS Developer Guide.
- * 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.
- * 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. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
+ * for a queue, Amazon SQS moves the message to the dead-letter-queue.
- * VisibilityTimeout
– Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.
- *
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
.
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 (e.g. 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 (for example, 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 * high throughput * for FIFO queues:
@@ -944,33 +1250,15 @@ export interface GetQueueAttributesResult { Attributes?: RecordThe specified attribute doesn't exist.
- */ -export class InvalidAttributeName extends __BaseException { - readonly name: "InvalidAttributeName" = "InvalidAttributeName"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-
), and underscores (_
).
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.
*/ QueueName: string | undefined; @@ -983,7 +1271,8 @@ export interface GetQueueUrlRequest { /** * @public - *For more information, see Interpreting Responses in the Amazon SQS Developer Guide.
+ *For more information, see Interpreting Responses in the Amazon SQS Developer + * Guide.
*/ export interface GetQueueUrlResult { /** @@ -992,26 +1281,6 @@ export interface GetQueueUrlResult { QueueUrl?: string; } -/** - * @public - *The specified queue doesn't exist.
- */ -export class QueueDoesNotExist extends __BaseException { - readonly name: "QueueDoesNotExist" = "QueueDoesNotExist"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeMaximum number of results to include in the response. Value range is 1 to 1000.
- * You must set MaxResults
to receive a value for NextToken
in the response.
Maximum number of results to include in the response. Value range is 1 to 1000. 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.
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
- * results to request, or if you did not set MaxResults
in the request.
Pagination token to include in the next request. Token value is null
if
+ * there are no additional results to request, or if you did not set
+ * MaxResults
in the request.
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.
*/ QueueNamePrefix?: string; @@ -1069,8 +1342,9 @@ export interface ListQueuesRequest { NextToken?: string; /** - *Maximum number of results to include in the response. Value range is 1 to 1000.
- * You must set MaxResults
to receive a value for NextToken
in the response.
Maximum number of results to include in the response. Value range is 1 to 1000. 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
- * 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.
*/ - NextToken?: string; + QueueUrls?: string[]; /** - *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 null
if
+ * there are no additional results to request, or if you did not set
+ * MaxResults
in the request.
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 URL of the queue from which the PurgeQueue
action deletes messages.
The URL of the queue from which the PurgeQueue
action deletes
+ * messages.
Queue URLs and names are case-sensitive.
*/ QueueUrl: string | undefined; } +/** + * @public + *The caller doesn't have the required KMS access.
+ */ +export class KmsAccessDenied extends __BaseException { + readonly name: "KmsAccessDenied" = "KmsAccessDenied"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request was denied due to request throttling.
+ */ +export class KmsDisabled extends __BaseException { + readonly name: "KmsDisabled" = "KmsDisabled"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe 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.
+ */ +export class KmsInvalidState extends __BaseException { + readonly name: "KmsInvalidState" = "KmsInvalidState"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request was rejected because the specified entity or resource could not be found. + *
+ */ +export class KmsNotFound extends __BaseException { + readonly name: "KmsNotFound" = "KmsNotFound"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request was rejected because the specified key policy isn't syntactically or + * semantically correct.
+ */ +export class KmsOptInRequired extends __BaseException { + readonly name: "KmsOptInRequired" = "KmsOptInRequired"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeAmazon Web Services KMS throttles requests for the following conditions.
+ */ +export class KmsThrottled extends __BaseException { + readonly name: "KmsThrottled" = "KmsThrottled"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeA 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:
*@@ -1165,16 +1597,19 @@ export interface ReceiveMessageRequest { *
- * 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.
* @@ -1182,20 +1617,26 @@ export interface ReceiveMessageRequest { *
*For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R
.
For a user, returns the 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 (e.g. 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 (for example, SSE-KMS or SSE-SQS).
@@ -1207,15 +1648,17 @@ 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,
* another worker consuming from the same queue can receive the same messages
* 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 KB 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 KiB 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; @@ -1360,8 +1847,11 @@ 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; } @@ -1372,12 +1862,15 @@ export interface MessageAttributeValue { */ export interface Message { /** - *A unique identifier for the message. A MessageId
is considered unique across all Amazon Web Services accounts for an extended period of time.
A unique identifier for the message. A MessageId
is 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; @@ -1394,8 +1887,8 @@ export interface Message { /** *A map of the attributes requested in
* ReceiveMessage
- *
to their respective values.
- * Supported attributes:
@@ -1434,8 +1927,9 @@ 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 KB. The message to send. The minimum size is one character. The maximum size is 256
+ * KiB. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
+ * A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
* Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
- * 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 Currently, the only supported message system attribute is The size of a message system attribute doesn't count towards the total size of a message. 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 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
+ */
+export type MessageSystemAttributeNameForSends =
+ (typeof MessageSystemAttributeNameForSends)[keyof typeof MessageSystemAttributeNameForSends];
+
+/**
+ * @public
+ *
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
.#x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
* 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.AWSTraceHeader
.
* Its type must be String
and its value must be a correctly formatted
* X-Ray trace header string.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
,
*
* 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.
@@ -1781,9 +2293,10 @@ 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.
Currently, the only supported message system attribute is AWSTraceHeader
.
* Its type must be String
and its value must be a correctly formatted
* X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
- *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
,
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).
- *
+ * 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.
- * 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
+ *
action waits
+ * for a message to arrive. Valid values: An integer from 0 to 20 (seconds).
+ * Default: 0. 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. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues
- * in the Amazon SQS Developer Guide.
- * 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.
- * 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. Default: 10. 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.
- *
- * 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.
+ * 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
.
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 (e.g. 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 (for example, 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.
The following attributes apply only to * high throughput * for FIFO queues:
diff --git a/clients/client-sqs/src/protocols/Aws_json1_0.ts b/clients/client-sqs/src/protocols/Aws_json1_0.ts new file mode 100644 index 000000000000..df29aa3bac16 --- /dev/null +++ b/clients/client-sqs/src/protocols/Aws_json1_0.ts @@ -0,0 +1,2472 @@ +// smithy-typescript generated code +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { + _json, + decorateServiceException as __decorateServiceException, + expectString as __expectString, + take, + withBaseException, +} from "@aws-sdk/smithy-client"; +import { + Endpoint as __Endpoint, + HeaderBag as __HeaderBag, + ResponseMetadata as __ResponseMetadata, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { AddPermissionCommandInput, AddPermissionCommandOutput } from "../commands/AddPermissionCommand"; +import { + ChangeMessageVisibilityBatchCommandInput, + ChangeMessageVisibilityBatchCommandOutput, +} from "../commands/ChangeMessageVisibilityBatchCommand"; +import { + ChangeMessageVisibilityCommandInput, + ChangeMessageVisibilityCommandOutput, +} from "../commands/ChangeMessageVisibilityCommand"; +import { CreateQueueCommandInput, CreateQueueCommandOutput } from "../commands/CreateQueueCommand"; +import { DeleteMessageBatchCommandInput, DeleteMessageBatchCommandOutput } from "../commands/DeleteMessageBatchCommand"; +import { DeleteMessageCommandInput, DeleteMessageCommandOutput } from "../commands/DeleteMessageCommand"; +import { DeleteQueueCommandInput, DeleteQueueCommandOutput } from "../commands/DeleteQueueCommand"; +import { GetQueueAttributesCommandInput, GetQueueAttributesCommandOutput } from "../commands/GetQueueAttributesCommand"; +import { GetQueueUrlCommandInput, GetQueueUrlCommandOutput } from "../commands/GetQueueUrlCommand"; +import { + ListDeadLetterSourceQueuesCommandInput, + ListDeadLetterSourceQueuesCommandOutput, +} from "../commands/ListDeadLetterSourceQueuesCommand"; +import { ListQueuesCommandInput, ListQueuesCommandOutput } from "../commands/ListQueuesCommand"; +import { ListQueueTagsCommandInput, ListQueueTagsCommandOutput } from "../commands/ListQueueTagsCommand"; +import { PurgeQueueCommandInput, PurgeQueueCommandOutput } from "../commands/PurgeQueueCommand"; +import { ReceiveMessageCommandInput, ReceiveMessageCommandOutput } from "../commands/ReceiveMessageCommand"; +import { RemovePermissionCommandInput, RemovePermissionCommandOutput } from "../commands/RemovePermissionCommand"; +import { SendMessageBatchCommandInput, SendMessageBatchCommandOutput } from "../commands/SendMessageBatchCommand"; +import { SendMessageCommandInput, SendMessageCommandOutput } from "../commands/SendMessageCommand"; +import { SetQueueAttributesCommandInput, SetQueueAttributesCommandOutput } from "../commands/SetQueueAttributesCommand"; +import { TagQueueCommandInput, TagQueueCommandOutput } from "../commands/TagQueueCommand"; +import { UntagQueueCommandInput, UntagQueueCommandOutput } from "../commands/UntagQueueCommand"; +import { + AddPermissionRequest, + BatchEntryIdsNotDistinct, + BatchRequestTooLong, + ChangeMessageVisibilityBatchRequest, + ChangeMessageVisibilityBatchRequestEntry, + ChangeMessageVisibilityRequest, + CreateQueueRequest, + DeleteMessageBatchRequest, + DeleteMessageBatchRequestEntry, + DeleteMessageRequest, + DeleteQueueRequest, + EmptyBatchRequest, + GetQueueAttributesRequest, + GetQueueUrlRequest, + InvalidAddress, + InvalidAttributeName, + InvalidAttributeValue, + InvalidBatchEntryId, + InvalidIdFormat, + InvalidMessageContents, + InvalidSecurity, + KmsAccessDenied, + KmsDisabled, + KmsInvalidKeyUsage, + KmsInvalidState, + KmsNotFound, + KmsOptInRequired, + KmsThrottled, + ListDeadLetterSourceQueuesRequest, + ListQueuesRequest, + ListQueueTagsRequest, + Message, + MessageAttributeValue, + MessageNotInflight, + MessageSystemAttributeNameForSends, + MessageSystemAttributeValue, + OverLimit, + PurgeQueueInProgress, + PurgeQueueRequest, + QueueAttributeName, + QueueDeletedRecently, + QueueDoesNotExist, + QueueNameExists, + ReceiptHandleIsInvalid, + ReceiveMessageRequest, + ReceiveMessageResult, + RemovePermissionRequest, + RequestThrottled, + SendMessageBatchRequest, + SendMessageBatchRequestEntry, + SendMessageRequest, + SetQueueAttributesRequest, + TagQueueRequest, + TooManyEntriesInBatchRequest, + UnsupportedOperation, + UntagQueueRequest, +} from "../models/models_0"; +import { SQSServiceException as __BaseException } from "../models/SQSServiceException"; + +/** + * serializeAws_json1_0AddPermissionCommand + */ +export const se_AddPermissionCommand = async ( + input: AddPermissionCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("AddPermission"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0ChangeMessageVisibilityCommand + */ +export const se_ChangeMessageVisibilityCommand = async ( + input: ChangeMessageVisibilityCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("ChangeMessageVisibility"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0ChangeMessageVisibilityBatchCommand + */ +export const se_ChangeMessageVisibilityBatchCommand = async ( + input: ChangeMessageVisibilityBatchCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("ChangeMessageVisibilityBatch"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0CreateQueueCommand + */ +export const se_CreateQueueCommand = async ( + input: CreateQueueCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("CreateQueue"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0DeleteMessageCommand + */ +export const se_DeleteMessageCommand = async ( + input: DeleteMessageCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("DeleteMessage"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0DeleteMessageBatchCommand + */ +export const se_DeleteMessageBatchCommand = async ( + input: DeleteMessageBatchCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("DeleteMessageBatch"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0DeleteQueueCommand + */ +export const se_DeleteQueueCommand = async ( + input: DeleteQueueCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("DeleteQueue"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0GetQueueAttributesCommand + */ +export const se_GetQueueAttributesCommand = async ( + input: GetQueueAttributesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("GetQueueAttributes"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0GetQueueUrlCommand + */ +export const se_GetQueueUrlCommand = async ( + input: GetQueueUrlCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("GetQueueUrl"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0ListDeadLetterSourceQueuesCommand + */ +export const se_ListDeadLetterSourceQueuesCommand = async ( + input: ListDeadLetterSourceQueuesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("ListDeadLetterSourceQueues"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0ListQueuesCommand + */ +export const se_ListQueuesCommand = async ( + input: ListQueuesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("ListQueues"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0ListQueueTagsCommand + */ +export const se_ListQueueTagsCommand = async ( + input: ListQueueTagsCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("ListQueueTags"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0PurgeQueueCommand + */ +export const se_PurgeQueueCommand = async ( + input: PurgeQueueCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("PurgeQueue"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0ReceiveMessageCommand + */ +export const se_ReceiveMessageCommand = async ( + input: ReceiveMessageCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("ReceiveMessage"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0RemovePermissionCommand + */ +export const se_RemovePermissionCommand = async ( + input: RemovePermissionCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("RemovePermission"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0SendMessageCommand + */ +export const se_SendMessageCommand = async ( + input: SendMessageCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("SendMessage"); + let body: any; + body = JSON.stringify(se_SendMessageRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0SendMessageBatchCommand + */ +export const se_SendMessageBatchCommand = async ( + input: SendMessageBatchCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("SendMessageBatch"); + let body: any; + body = JSON.stringify(se_SendMessageBatchRequest(input, context)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0SetQueueAttributesCommand + */ +export const se_SetQueueAttributesCommand = async ( + input: SetQueueAttributesCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("SetQueueAttributes"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0TagQueueCommand + */ +export const se_TagQueueCommand = async ( + input: TagQueueCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("TagQueue"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * serializeAws_json1_0UntagQueueCommand + */ +export const se_UntagQueueCommand = async ( + input: UntagQueueCommandInput, + context: __SerdeContext +): Promise<__HttpRequest> => { + const headers: __HeaderBag = sharedHeaders("UntagQueue"); + let body: any; + body = JSON.stringify(_json(input)); + return buildHttpRpcRequest(context, headers, "/", undefined, body); +}; + +/** + * deserializeAws_json1_0AddPermissionCommand + */ +export const de_AddPermissionCommand = async ( + output: __HttpResponse, + context: __SerdeContext +): Promise