From f101561a07cb8ca904c5e8d5e7d89ffd1ca82865 Mon Sep 17 00:00:00 2001
From: George Fu Adds a permission to a queue for a specific principal. This allows sharing\n access to the queue. When you create a queue, you have full control access rights for the queue. Only you,\n the owner of the queue, can grant or deny permissions to the queue. For more information\n about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS\n Developer Guide. \n 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 Amazon SQS Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide. The URL of the Amazon SQS queue to which permissions are added. Queue URLs and names are case-sensitive. The unique identification of the permission you're setting (for example,\n The Amazon Web Services account numbers of the principals who are to receive\n permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer\n Guide. The action the client wants to allow for the specified principal. Valid values: the\n name of any action or For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service\n Resource in the Amazon SQS Developer Guide. Specifying Welcome to the Amazon SQS API Reference. Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel\n between applications or microservices. Amazon SQS moves data between distributed application\n components and helps you decouple these components. For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer\n Guide.\n You can use Amazon Web Services SDKs to access\n Amazon SQS using your favorite programming language. The SDKs perform tasks such as the\n following automatically: Cryptographically sign your service requests Retry requests Handle error responses \n Additional information\n \n Amazon SQS Developer Guide\n \n Making API Requests\n \n Amazon Web Services General Reference\n Adds a permission to a queue for a specific principal. This allows sharing\n access to the queue. When you create a queue, you have full control access rights for the queue. Only you,\n the owner of the queue, can grant or deny permissions to the queue. For more information\n about these permissions, see Allow Developers to Write Messages to a Shared Queue in the\n Amazon SQS Developer Guide. \n An Amazon SQS policy can have a maximum of seven actions per\n statement. To remove the ability to change queue permissions, you must deny\n permission to the Amazon SQS Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide. The URL of the Amazon SQS queue to which permissions are added. Queue URLs and names are case-sensitive. The unique identification of the permission you're setting (for example,\n The Amazon Web\n Services account numbers of the principals who are to receive\n permission. For information about locating the Amazon Web Services\n account identification, see Your Amazon Web\n Services Identifiers in the Amazon SQS Developer\n Guide. The action the client wants to allow for the specified principal. Valid values: the\n name of any action or For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service\n Resource in the Amazon SQS Developer Guide. Specifying Welcome to the Amazon SQS API Reference. Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they\n travel between applications or microservices. Amazon SQS moves data between distributed\n 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\n Guide.\n You can use Amazon Web Services\n SDKs to access Amazon SQS using your favorite programming language. The SDKs\n perform tasks such as the following automatically: Cryptographically sign your service requests Retry requests Handle error responses \n Additional information\n \n Amazon SQS Developer Guide\n \n Making API Requests\n \n Amazon Web Services General Reference\n Two or more batch entries in the request have the same The length of all the messages put together is more than the limit. The Specifies whether the error happened due to the caller of the batch API action. An error code representing why the action failed on this entry. A message explaining why the action failed on this entry. Gives a detailed description of the result of an action on each entry in the\n request. Cancels a specified message movement task. A message movement can only be cancelled\n when the current status is RUNNING. Cancelling a message movement task does not revert\n the messages that have already been moved. It can only stop the messages that have not\n been moved yet. This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue. Currently, only standard queues are supported. Only one active message movement task is supported per queue at any given\n time. An identifier associated with a message movement task. The approximate number of messages already moved to the destination queue. Two or more batch entries in the request have the same Changes the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide. For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed\n since you received the message, and you send a ChangeMessageVisibility call with\n An Amazon SQS message has three basic states: Sent to a queue by a producer. Received from the queue by a consumer. Deleted from the queue. 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.\n A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages. 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). \n If you reach this limit, Amazon SQS returns the 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 Unlike with a queue, when you change the visibility timeout for a specific message\n the timeout value is applied immediately but isn't saved in memory for that message.\n If you don't delete a message after it is received, the visibility timeout for the\n message reverts to the original timeout value (not to the value you set using the\n Changes the visibility timeout of multiple messages. This is a batch version of\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of The URL of the Amazon SQS queue whose messages' visibility is changed. Queue URLs and names are case-sensitive. Lists the receipt handles of the messages for which the visibility timeout must be\n changed. An identifier for this particular receipt handle used to communicate the\n result. The This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_). A receipt handle. The new value (in seconds) for the message's visibility timeout. The length of all the messages put together is more than the limit. Encloses a receipt handle and an entry ID for each message in A list of A list of For each message in the batch, the response contains a The Specifies whether the error happened due to the caller of the batch API action. An error code representing why the action failed on this entry. A message explaining why the action failed on this entry. Represents a message whose visibility timeout has been changed successfully. Gives a detailed description of the result of an action on each entry in the\n request. Encloses the The URL of the Amazon SQS queue whose message's visibility is changed. Queue URLs and names are case-sensitive. The receipt handle associated with the message, whose visibility timeout is changed.\n This parameter is returned by the The new value for the message's visibility timeout (in seconds). Values range:\n Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind: If you don't specify the You can't change the queue type after you create it and you can't convert\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon SQS Developer Guide. If you don't provide a value for an attribute, the queue is created with the\n default value for the attribute. If you delete a queue, you must wait at least 60 seconds before creating a\n queue with the same name. To successfully create a new queue, you must provide a queue name that adheres to the\n limits\n related to queues and is unique within the scope of your queues. After you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue. To get the queue URL, use the If you provide the name of an existing queue along with the exact names and\n values of all the queue's attributes, If the queue name, attribute names, or attribute values don't match an\n existing queue, Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide. The name of the new queue. The following limits apply to this name: A queue name can have up to 80 characters. Valid values: alphanumeric characters, hyphens ( A FIFO queue name must end with the Queue URLs and names are case-sensitive. Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide. 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 \nQuotas related to queues \nin the Amazon SQS Developer Guide. To be able to tag a queue on creation, you must have the\n Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request\n parameters that the \n \n \n \n \n \n The following attributes apply only to dead-letter queues:\n \n \n \n \n \n \n \n \n \n The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue. The following attributes apply only to server-side-encryption: \n \n \n The following attributes apply only to FIFO (first-in-first-out)\n queues: \n For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide. \n Every message must have a unique\n You may provide a If you aren't able to provide a\n If you don't provide a If the queue has When If you send one message with The following attributes apply only to \nhigh throughput\nfor FIFO queues: \n \n To enable high throughput for FIFO queues, do the following: Set Set If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified. For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide. The URL of the created Amazon SQS queue. Returns the Deletes the specified message from the specified queue. To select the message to\n delete, use the The For standard queues, it is possible to receive a message even after you\n delete it. This might happen on rare occasions if one of the servers which stores a\n copy of the message is unavailable when you send the request to delete the message.\n The copy remains on the server and might be returned to you during a subsequent\n receive request. You should ensure that your application is idempotent, so that\n receiving a message more than once does not cause issues. Deletes up to ten messages from the specified queue. This is a batch version of\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive. Lists the receipt handles for the messages to be deleted. The identifier for this particular receipt handle. This is used to communicate the\n result. The This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_). A receipt handle. Cancels a specified message movement task. A message movement can only be cancelled\n when the current status is RUNNING. Cancelling a message movement task does not revert\n the messages that have already been moved. It can only stop the messages that have not\n been moved yet. This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue. Currently, only standard queues are supported. Only one active message movement task is supported per queue at any given\n time. Encloses a receipt handle and an identifier for it. A list of A list of For each message in the batch, the response contains a An identifier associated with a message movement task. Represents a successfully deleted message. Encloses the The approximate number of messages already moved to the destination queue. The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive. The receipt handle associated with the message to delete. Changes the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide. For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed\n since you received the message, and you send a ChangeMessageVisibility call with\n An Amazon SQS message has three basic states: Sent to a queue by a producer. Received from the queue by a consumer. Deleted from the queue. A message is considered to be stored after it is sent to a queue\n by a producer, but not yet received from the queue by a consumer (that is, between\n states 1 and 2). There is no limit to the number of stored messages. A message is\n considered to be in flight after it is received from a queue by a\n consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is\n a limit to the number of in flight messages. Limits that apply to in flight messages are unrelated to the\n unlimited number of stored messages. For most standard queues (depending on queue traffic and message backlog), there can\n be a maximum of approximately 120,000 in flight messages (received from a queue by a\n consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS\n returns the For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a\n queue by a consumer, but not yet deleted from the queue). If you reach this limit,\n Amazon SQS returns no error messages. If you attempt to set the Unlike with a queue, when you change the visibility timeout for a specific message\n the timeout value is applied immediately but isn't saved in memory for that message.\n If you don't delete a message after it is received, the visibility timeout for the\n message reverts to the original timeout value (not to the value you set using the\n Deletes the queue specified by the Be careful with the When you delete a queue, the deletion process takes up to 60 seconds. Requests you\n send involving that queue during the 60 seconds might succeed. For example, a\n When you delete a queue, you must wait at least 60 seconds before creating a queue\n with the same name. Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide. The delete operation uses the HTTP The URL of the Amazon SQS queue to delete. Queue URLs and names are case-sensitive. Changes the visibility timeout of multiple messages. This is a batch version of\n Because the batch request can result in a combination of successful and\n unsuccessful actions, you should check for batch errors even when the call returns\n an HTTP status code of The batch request doesn't contain any entries. Gets attributes for the specified queue. To determine whether a queue is FIFO, you can check whether The URL of the Amazon SQS queue whose messages' visibility is changed. Queue URLs and names are case-sensitive. Lists the receipt handles of the messages for which the visibility timeout must be\n changed. The URL of the Amazon SQS queue whose attribute information is retrieved. Queue URLs and names are case-sensitive. An identifier for this particular receipt handle used to communicate the\n result. The This identifier can have up to 80 characters. The following characters are\n accepted: alphanumeric characters, hyphens(-), and underscores (_). A receipt handle. The new value (in seconds) for the message's visibility timeout. A list of attributes for which to retrieve information. The 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 \n \n \n \n \n \n \n \n \n \n \n \n \n The following attributes apply only to dead-letter queues:\n \n \n \n \n \n \n \n \n \n The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue. The following attributes apply only to server-side-encryption: \n \n \n The following attributes apply only to FIFO (first-in-first-out)\n queues: \n To determine whether a queue is FIFO, you can check whether \n The following attributes apply only to \nhigh throughput\nfor FIFO queues: \n \n To enable high throughput for FIFO queues, do the following: Set Set If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified. For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide. Encloses a receipt handle and an entry ID for each message in A map of attributes to their respective values. A list of returned queue attributes. Returns the URL of an existing Amazon SQS queue. To access a queue that belongs to another AWS account, use the\n The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values:\n alphanumeric characters, hyphens ( Queue URLs and names are case-sensitive. A list of A list of The Amazon Web Services account ID of the account that created the queue. For each message in the batch, the response contains a Represents a message whose visibility timeout has been changed successfully. The URL of the queue. Encloses the For more information, see Interpreting Responses in the Amazon SQS Developer\n Guide. The specified attribute doesn't exist. The The specified receipt handle isn't valid for the current version. The message contains characters outside the allowed set. Returns a list of your queues that have the The For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer\n Guide. The URL of a dead-letter queue. Queue URLs and names are case-sensitive. The URL of the Amazon SQS queue whose message's visibility is changed. Queue URLs and names are case-sensitive. The receipt handle associated with the message, whose visibility timeout is changed.\n This parameter is returned by the The new value for the message's visibility timeout (in seconds). Values range:\n Pagination token to request the next set of results. Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set Creates a new standard or FIFO queue. You can pass one or more attributes in the\n request. Keep the following in mind: If you don't specify the You can't change the queue type after you create it and you can't convert\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon SQS Developer Guide. If you don't provide a value for an attribute, the queue is created with the\n default value for the attribute. If you delete a queue, you must wait at least 60 seconds before creating a\n queue with the same name. To successfully create a new queue, you must provide a queue name that adheres to the\n limits\n related to queues and is unique within the scope of your queues. After you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue. To get the queue URL, use the If you provide the name of an existing queue along with the exact names and\n values of all the queue's attributes, If the queue name, attribute names, or attribute values don't match an\n existing queue, Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide. The name of the new queue. The following limits apply to this name: A queue name can have up to 80 characters. Valid values: alphanumeric characters, hyphens ( A FIFO queue name must end with the Queue URLs and names are case-sensitive. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request\n parameters that the \n \n \n \n \n \n The following attributes apply only to dead-letter queues:\n \n \n \n \n \n \n \n \n \n The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the\n dead-letter queue of a standard queue must also be a standard queue. The following attributes apply only to server-side-encryption: \n \n \n The following attributes apply only to FIFO\n (first-in-first-out) queues: \n For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide. \n Every message must have a unique\n You may provide a If you aren't able to provide a\n If you don't provide a If the queue has When If you send one message with The following attributes apply only to high\n throughput for FIFO queues: \n \n To enable high throughput for FIFO queues, do the following: Set Set If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified. For information on throughput quotas, see Quotas\n related to messages in the Amazon SQS Developer\n Guide. Add cost allocation tags to the specified Amazon SQS queue. For an overview, see\n Tagging\n Your Amazon SQS Queues in the Amazon SQS Developer\n 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\n strings. Tags are case-sensitive. A new tag with a key identical to that of an existing tag overwrites the\n existing tag. For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer\n Guide. To be able to tag a queue on creation, you must have the\n Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide. A list of source queue URLs that have the The URL of the created Amazon SQS queue. Pagination token to include in the next request. Token value is Returns the A list of your dead letter source queues. Gets the most recent message movement tasks (up to 10) under a specific source\n queue. This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue. Currently, only standard queues are supported. Only one active message movement task is supported per queue at any given\n time. The ARN of the queue whose message movement tasks are to be listed. Deletes the specified message from the specified queue. To select the message to\n delete, use the The For standard queues, it is possible to receive a message even after you delete it.\n This might happen on rare occasions if one of the servers which stores a copy of the\n message is unavailable when you send the request to delete the message. The copy\n remains on the server and might be returned to you during a subsequent receive\n request. You should ensure that your application is idempotent, so that receiving a\n message more than once does not cause issues. The maximum number of results to include in the response. The default is 1, which\n provides the most recent message movement task. The upper limit is 10. Deletes up to ten messages from the specified queue. This is a batch version of\n Because the batch request can result in a combination of successful and\n unsuccessful actions, you should check for batch errors even when the call returns\n an HTTP status code of The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive. Lists the receipt handles for the messages to be deleted. A list of message movement tasks and their attributes. The identifier for this particular receipt handle. This is used to communicate the\n result. The This identifier can have up to 80 characters. The following characters are\n accepted: alphanumeric characters, hyphens(-), and underscores (_). A receipt handle. An identifier associated with a message movement task. When this field is returned in\n the response of the Encloses a receipt handle and an identifier for it. The status of the message movement task. Possible values are: RUNNING, COMPLETED,\n CANCELLING, CANCELLED, and FAILED. A list of A list of The ARN of the queue that contains the messages to be moved to another queue. For each message in the batch, the response contains a Represents a successfully deleted message. The ARN of the destination queue if it has been specified in the\n Encloses the The number of messages to be moved per second (the message movement rate), if it has\n been specified in the The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive. The receipt handle associated with the message to delete. The approximate number of messages already moved to the destination queue. The number of messages to be moved from the source queue. This number is obtained at\n the time of starting the message movement task. Deletes the queue specified by the Be careful with the When you delete a queue, the deletion process takes up to 60 seconds. Requests you\n send involving that queue during the 60 seconds might succeed. For example, a\n When you delete a queue, you must wait at least 60 seconds before creating a queue\n with the same name. Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide. The delete operation uses the HTTP The URL of the Amazon SQS queue to delete. Queue URLs and names are case-sensitive. The task failure reason (only included if the task status is FAILED). The timestamp of starting the message movement task. The batch request doesn't contain any entries. Contains the details of a message movement task. List all cost allocation tags added to the specified Amazon SQS queue.\n For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide. Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide. The URL of the queue. Gets attributes for the specified queue. To determine whether a queue is FIFO, you can check whether The URL of the Amazon SQS queue whose attribute information is retrieved. Queue URLs and names are case-sensitive. A list of attributes for which to retrieve information. The In the future, new attributes might be added. If you write code that calls this\n action, we recommend that you structure your code so that it can handle new\n attributes gracefully. The following attributes are supported: The \n \n \n \n \n \n \n \n \n \n \n \n \n The following attributes apply only to dead-letter queues:\n \n \n \n \n \n \n \n \n \n The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the\n dead-letter queue of a standard queue must also be a standard queue. The following attributes apply only to server-side-encryption: \n \n \n The following attributes apply only to FIFO\n (first-in-first-out) queues: \n To determine whether a queue is FIFO, you can check whether \n The following attributes apply only to high\n throughput for FIFO queues: \n \n To enable high throughput for FIFO queues, do the following: Set Set If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified. For information on throughput quotas, see Quotas\n related to messages in the Amazon SQS Developer\n Guide. The list of all tags added to the specified queue. Returns a list of your queues in the current region. The response includes a maximum\n of 1,000 results. If you specify a value for the optional The Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide. A string to use for filtering the list results. Only those queues whose name begins\n with the specified string are returned. Queue URLs and names are case-sensitive. Pagination token to request the next set of results. A map of attributes to their respective values. Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set A list of returned queue attributes. Pagination token to include in the next request. Token value is A list of queue URLs, up to 1,000 entries, or the value of Returns the URL of an existing Amazon SQS queue. To access a queue that belongs to another AWS account, use the\n A list of your queues. A unique identifier for the message. A An identifier associated with the act of receiving the message. A new receipt handle\n is returned every time you receive a message. When deleting a message, you provide the\n last received receipt handle to delete the message. An MD5 digest of the non-URL-encoded message body string. The message's contents (not URL-encoded). A map of the attributes requested in \n \n \n \n \n \n \n \n An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values:\n alphanumeric characters, hyphens ( Queue URLs and names are case-sensitive. The Amazon Web\n Services account ID of the account that created the queue. Each message attribute consists of a An Amazon SQS message. Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters. Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images. Not implemented. Reserved for future use. Not implemented. Reserved for future use. The URL of the queue. 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\n Guide. For more information, see Interpreting Responses in the Amazon SQS Developer\n Guide. The user-specified message attribute value. For string data types, the\n \n The specified message isn't in flight. The The specified attribute doesn't exist. A queue attribute value is invalid. The The specified receipt handle isn't valid for the current version. The message contains characters outside the allowed set. When the request to a queue is not HTTPS and SigV4. The caller doesn't have the required KMS access. The request was denied due to request throttling. Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters. The request was rejected for one of the following reasons: The KeyUsage value of the KMS key is incompatible with the API\n operation. The encryption algorithm or signing algorithm specified for the operation is\n incompatible with the type of key material in the KMS key (KeySpec). Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images. The request was rejected because the state of the specified resource is not valid for\n this request. Not implemented. Reserved for future use. The request was rejected because the specified entity or resource could not be found.\n Not implemented. Reserved for future use. The request was rejected because the specified key policy isn't syntactically or\n semantically correct. 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\n Guide. Amazon Web Services KMS throttles requests for the following conditions. The user-specified message system attribute value. For string data types, the\n \n The specified action violates a limit. For example, Deletes available messages in a queue (including in-flight messages) specified by the\n When you use the The message deletion process takes up to 60 seconds. We recommend waiting for 60\n seconds regardless of your queue's size. Messages sent to the queue before you call\n Messages sent to the queue after you call Indicates that the specified queue previously received a The URL of the queue from which the Queue URLs and names are case-sensitive. Returns a list of your queues that have the The For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer\n Guide. The URL of a dead-letter queue. Queue URLs and names are case-sensitive. Pagination token to request the next set of results. Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set A list of source queue URLs that have the Pagination token to include in the next request. Token value is A list of your dead letter source queues. Gets the most recent message movement tasks (up to 10) under a specific source\n queue. This action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue. Currently, only standard queues are supported. Only one active message movement task is supported per queue at any given\n time. The ARN of the queue whose message movement tasks are to be listed. The maximum number of results to include in the response. The default is 1, which\n provides the most recent message movement task. The upper limit is 10. A list of message movement tasks and their attributes. An identifier associated with a message movement task. When this field is returned in\n the response of the The status of the message movement task. Possible values are: RUNNING, COMPLETED,\n CANCELLING, CANCELLED, and FAILED. The ARN of the queue that contains the messages to be moved to another queue. The ARN of the destination queue if it has been specified in the\n The number of messages to be moved per second (the message movement rate), if it has\n been specified in the The approximate number of messages already moved to the destination queue. The number of messages to be moved from the source queue. This number is obtained at\n the time of starting the message movement task. The task failure reason (only included if the task status is FAILED). The timestamp of starting the message movement task. Contains the details of a message movement task. List all cost allocation tags added to the specified Amazon SQS queue. For an\n overview, see Tagging\n Your Amazon SQS Queues in the Amazon SQS Developer\n Guide. Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide. The URL of the queue. The list of all tags added to the specified queue. Returns a list of your queues in the current region. The response includes a maximum\n of 1,000 results. If you specify a value for the optional The Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide. A string to use for filtering the list results. Only those queues whose name begins\n with the specified string are returned. Queue URLs and names are case-sensitive. Pagination token to request the next set of results. Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set A list of queue URLs, up to 1,000 entries, or the value of Pagination token to include in the next request. Token value is A list of your queues. A unique identifier for the message. A An identifier associated with the act of receiving the message. A new receipt handle\n is returned every time you receive a message. When deleting a message, you provide the\n last received receipt handle to delete the message. An MD5 digest of the non-URL-encoded message body string. The message's contents (not URL-encoded). A map of the attributes requested in \n \n \n \n \n \n \n \n An MD5 digest of the non-URL-encoded message attribute string. You can use this\n attribute to verify that Amazon SQS received the message correctly. Amazon SQS\n URL-decodes the message before creating the MD5 digest. For information about MD5, see\n RFC1321. Each message attribute consists of a An Amazon SQS message. Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters. Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images. Not implemented. Reserved for future use. Not implemented. Reserved for future use. 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\n Guide. The user-specified message attribute value. For string data types, the\n \n The specified message isn't in flight. You must wait 60 seconds after deleting a queue before you can create another queue\n with the same name. The specified queue doesn't exist. A queue with this name already exists. Amazon SQS returns this error only if the request\n includes attributes whose values differ from those of the existing queue. The specified receipt handle isn't valid. Retrieves one or more messages (up to 10), from the specified queue. Using the\n Short poll is the default behavior where a weighted random set of machines is sampled\n on a For each message returned, the response includes the following: The message body. An MD5 digest of the message body. For information about MD5, see RFC1321. The The receipt handle. The message attributes. An MD5 digest of the message attributes. The receipt handle is the identifier you must provide when deleting the message. For\n more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide. You can provide the A message that isn't deleted or a message whose visibility isn't extended before the\n visibility timeout expires counts as a failed receive. Depending on the configuration of\n the queue, the message might be sent to the dead-letter queue. 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 URL of the Amazon SQS queue from which messages are received. Queue URLs and names are case-sensitive. A list of attributes that need to be returned along with each message. These\n attributes include: \n \n \n \n \n For a user, returns the user ID, for example\n For an IAM role, returns the IAM role ID, for example\n \n \n \n \n \n Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters. Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images. Not implemented. Reserved for future use. Not implemented. Reserved for future use. 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\n Guide. The name of the message attribute, where N is the index. The name can contain alphanumeric characters and the underscore\n ( The name is case-sensitive and must be unique among all attribute names for\n the message. The name must not start with AWS-reserved prefixes such as The name must not start or end with a period ( The name can be up to 256 characters long. When using The user-specified message system attribute value. For string data types, the\n \n The maximum number of messages to return. Amazon SQS never returns more messages than this\n value (however, fewer messages might be returned). Valid values: 1 to 10. Default:\n 1. The specified action violates a limit. For example, The duration (in seconds) that the received messages are hidden from subsequent\n retrieve requests after being retrieved by a Deletes available messages in a queue (including in-flight messages) specified by the\n When you use the The message deletion process takes up to 60 seconds. We recommend waiting for 60\n seconds regardless of your queue's size. Messages sent to the queue before you call\n Messages sent to the queue after you call The duration (in seconds) for which the call waits for a message to arrive in the\n queue before returning. If a message is available, the call returns sooner than\n To avoid HTTP errors, ensure that the HTTP response timeout for\n Indicates that the specified queue previously received a The URL of the queue from which the Queue URLs and names are case-sensitive. This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of You can use When you set If a caller of the It is possible to retry the During a visibility timeout, subsequent calls with the same\n If a caller of the To mitigate this effect, ensure that your application observes a safe\n threshold before the visibility timeout expires and extend the visibility\n timeout as necessary. While messages with a particular If a caller of The maximum length of For best practices of using A list of messages. A list of received messages. Revokes any permissions in the queue policy that matches the specified\n Only the owner of a queue can remove permissions from it. Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide. To remove the ability to change queue permissions, you must deny permission to the The URL of the Amazon SQS queue from which permissions are removed. Queue URLs and names are case-sensitive. You must wait 60 seconds after deleting a queue before you can create another queue\n with the same name. The identification of the permission to remove. This is the label added using the\n The specified queue doesn't exist. One or more specified resources don't exist. Delivers a message to the specified queue. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: \n Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. You can use The result of sending each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144\n bytes). A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: \n 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 The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs and names are case-sensitive. A list of An identifier for a message in this batch used to communicate the result. The This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_). A queue with this name already exists. Amazon SQS returns this error only if the\n request includes attributes whose values differ from those of the existing queue. The body of the message. The length of time, in seconds, for which a specific message is delayed. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive When you set The specified receipt handle isn't valid. Each message attribute consists of a Retrieves one or more messages (up to 10), from the specified queue. Using the\n Short poll is the default behavior where a weighted random set of machines is sampled\n on a For each message returned, the response includes the following: The message body. An MD5 digest of the message body. For information about MD5, see RFC1321. The The receipt handle. The message attributes. An MD5 digest of the message attributes. The receipt handle is the identifier you must provide when deleting the message. For\n more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide. You can provide the A message that isn't deleted or a message whose visibility isn't extended before the\n visibility timeout expires counts as a failed receive. Depending on the configuration of\n the queue, the message might be sent to the dead-letter queue. In the future, new attributes might be added. If you write code that calls this\n action, we recommend that you structure your code so that it can handle new\n attributes gracefully. The URL of the Amazon SQS queue from which messages are received. Queue URLs and names are case-sensitive. A list of attributes that need to be returned along with each message. These\n attributes include: \n \n \n \n \n For a user, returns the user ID, for example\n For an IAM role, returns the IAM role ID, for example\n \n \n \n \n \n The name of the message attribute, where N is the index. The name can contain alphanumeric characters and the underscore\n ( The name is case-sensitive and must be unique among all attribute names for\n the message. The name must not start with AWS-reserved prefixes such as The name must not start or end with a period ( The name can be up to 256 characters long. When using The maximum number of messages to return. Amazon SQS never returns more messages than\n this value (however, fewer messages might be returned). Valid values: 1 to 10. Default:\n 1. The duration (in seconds) that the received messages are hidden from subsequent\n retrieve requests after being retrieved by a The duration (in seconds) for which the call waits for a message to arrive in the\n queue before returning. If a message is available, the call returns sooner than\n To avoid HTTP errors, ensure that the HTTP response timeout for\n This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of You can use When you set If a caller of the It is possible to retry the During a visibility timeout, subsequent calls with the same\n If a caller of the To mitigate this effect, ensure that your application observes a safe\n threshold before the visibility timeout expires and extend the visibility\n timeout as necessary. While messages with a particular If a caller of The maximum length of For best practices of using The message system attribute to send Each message system attribute consists of a 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. A list of messages. This parameter applies only to FIFO (first-in-first-out) queues. The token used for deduplication of messages within a 5-minute minimum deduplication\n interval. If a message with a particular Every message must have a unique You may provide a If you aren't able to provide a If you don't provide a If the queue has When If you send one message with The If a message is sent successfully but the acknowledgement is lost and the message\n 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 length of For best practices of using A list of received messages. This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use You must associate a non-empty \n The length of For best practices of using \n Revokes any permissions in the queue policy that matches the specified\n Only the owner of a queue can remove permissions from it. Cross-account permissions don't apply to this action. For more\n information, see Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide. To remove the ability to change queue permissions, you must deny\n permission to the Contains the details of a single Amazon SQS message along with an A list of A list of For each message in the batch, the response contains a The URL of the Amazon SQS queue from which permissions are removed. Queue URLs and names are case-sensitive. The identification of the permission to remove. This is the label added using the\n An identifier for the message in this batch. An identifier for the message. The request was denied due to request throttling. The rate of requests per second exceeds the Amazon Web Services KMS request quota for an\n account and Region. A burst or sustained high rate of requests to change the state of the same KMS\n key. This condition is often known as a \"hot key.\" Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store\n might be throttled at a lower-than-expected rate when the Amazon Web Services\n CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is\n processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store. An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. One or more specified resources don't exist. An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. Delivers a message to the specified queue. A message can include only XML, JSON, and unformatted text. The following Unicode\n characters are allowed: \n Any characters not included in this list will be rejected. For more information,\n see the W3C specification for\n characters. An MD5 digest of the non-URL-encoded message system attribute string. You can use this \nattribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. You can use The result of sending each message is reported individually in the response. Because\n the batch request can result in a combination of successful and unsuccessful actions,\n you should check for batch errors even when the call returns an HTTP status code of\n The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144\n bytes). A message can include only XML, JSON, and unformatted text. The following Unicode\n characters are allowed: \n Any characters not included in this list will be rejected. For more information,\n see the W3C specification for\n characters. If you don't specify the The URL of the Amazon SQS queue to which batched messages are sent. Queue URLs and names are case-sensitive. A list of 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 Encloses a An identifier for a message in this batch used to communicate the result. The This identifier can have up to 80 characters. The following characters are\n accepted: alphanumeric characters, hyphens(-), and underscores (_). The body of the message. The length of time, in seconds, for which a specific message is delayed. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive When you set Each message attribute consists of a The message system attribute to send Each message system attribute consists of a\n Currently, the only supported message system attribute is\n The size of a message system attribute doesn't count towards the total\n 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\n interval. If a message with a particular Every message must have a unique You may provide a If you aren't able to provide a If you don't provide a If the queue has When If you send one message with The If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same Amazon SQS continues to keep track of the message deduplication ID even after the\n message is received and deleted. The length of For best practices of using This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however, messages\n in different message groups might be processed out of order). To interleave multiple\n ordered streams within a single queue, use You must associate a non-empty \n The length of For best practices of using \n The URL of the Amazon SQS queue to which a message is sent. Queue URLs and names are case-sensitive. Contains the details of a single Amazon SQS message along with an\n The message to send. The minimum size is one character. The maximum size is 256\n KiB. A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed: \n Any characters not included in this list will be rejected. For more information, see the W3C specification for characters. A list of A list of The length of time, in seconds, for which to delay a specific message. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive When you set For each message in the batch, the response contains a An identifier for the message in this batch. An identifier for the message. An MD5 digest of the non-URL-encoded message body string. You can use this attribute\n to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the\n message before creating the MD5 digest. For information about MD5, see RFC1321. An MD5 digest of the non-URL-encoded message attribute string. You can use this\n attribute to verify that Amazon SQS received the message correctly. Amazon SQS\n URL-decodes the message before creating the MD5 digest. For information about MD5, see\n RFC1321. An MD5 digest of the non-URL-encoded message system attribute string. You can use this\n attribute to verify that Amazon SQS received the message correctly. Amazon SQS\n URL-decodes the message before creating the MD5 digest. For information about MD5, see\n RFC1321. 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 Each message attribute consists of a Encloses a The message system attribute to send. Each message system attribute consists of a 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. The URL of the Amazon SQS queue to which a message is sent. Queue URLs and names are case-sensitive. The message to send. The minimum size is one character. The maximum size is 256\n KiB. A message can include only XML, JSON, and unformatted text. The following Unicode\n characters are allowed: \n Any characters not included in this list will be rejected. For more information,\n see the W3C specification for\n characters. The length of time, in seconds, for which to delay a specific message. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive When you set Each message attribute consists of a The message system attribute to send. Each message system attribute consists of a\n Currently, the only supported message system attribute is\n The size of a message system attribute doesn't count towards the total\n 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\n Every message must have a unique You may provide a If you aren't able to provide a If you don't provide a If the queue has When If you send one message with The If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same Amazon SQS continues to keep track of the message deduplication ID even after the\n message is received and deleted. The maximum length of For best practices of using This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however, messages\n in different message groups might be processed out of order). To interleave multiple\n ordered streams within a single queue, use You must associate a non-empty \n The length of For best practices of using \n 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\n Every message must have a unique You may provide a If you aren't able to provide a If you don't provide a If the queue has When If you send one message with The If a message is sent successfully but the acknowledgement is lost and the message\n 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 An MD5 digest of the non-URL-encoded message body string. You can use this attribute\n to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the\n message before creating the MD5 digest. For information about MD5, see RFC1321. An MD5 digest of the non-URL-encoded message attribute string. You can use this\n attribute to verify that Amazon SQS received the message correctly. Amazon SQS\n URL-decodes the message before creating the MD5 digest. For information about MD5, see\n RFC1321. An MD5 digest of the non-URL-encoded message system attribute string. You can use this\n attribute to verify that Amazon SQS received the message correctly. Amazon SQS\n URL-decodes the message before creating the MD5 digest. An attribute containing the 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 This parameter applies only to FIFO (first-in-first-out) queues. The tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use You must associate a non-empty \n The length of For best practices of using \n The An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. Sets the value of one or more queue attributes. When you change a queue's attributes,\n the change can take up to 60 seconds for most of the attributes to propagate throughout\n the Amazon SQS system. Changes made to the In the future, new attributes might be added. If you write code that calls\n this action, we recommend that you structure your code so that it can handle\n new attributes gracefully. Cross-account permissions don't apply to this action. For more\n information, see Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide. To remove the ability to change queue permissions, you must deny\n permission to the The URL of the Amazon SQS queue whose attributes are set. Queue URLs and names are case-sensitive. A map of attributes to set. The following lists the names, descriptions, and values of the special request\n parameters that the \n \n \n \n \n \n The following attributes apply only to dead-letter queues:\n \n \n \n \n \n \n \n \n \n The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the\n dead-letter queue of a standard queue must also be a standard queue. The following attributes apply only to server-side-encryption: \n \n \n The following attribute applies only to FIFO\n (first-in-first-out) queues: \n Every message must have a unique\n You may provide a If you aren't able to provide a\n If you don't provide a If the queue has When If you send one message with The following attributes apply only to high\n throughput for FIFO queues: \n \n To enable high throughput for FIFO queues, do the following: Set Set If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified. For information on throughput quotas, see Quotas\n related to messages in the Amazon SQS Developer\n Guide. An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. An MD5 digest of the non-URL-encoded message system attribute string. You can use this \nattribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue. This action is currently limited to supporting message redrive from queues\n that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS\n queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are\n currently not supported. In dead-letter queues redrive context, the\n Currently, only standard queues support redrive. FIFO queues don't support\n redrive. Only one active message movement task is supported per queue at any given\n time. The ARN of the queue that contains the messages to be moved to another queue.\n Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues\n are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are\n not currently supported. The ARN of the queue that receives the moved messages. You can use this field to\n specify the destination queue where you would like to redrive messages. If this field is\n left blank, the messages will be redriven back to their respective original source\n queues. The number of messages to be moved per second (the message movement rate). You can use\n this field to define a fixed message movement rate. The maximum value for messages per\n second is 500. If this field is left blank, the system will optimize the rate based on\n the queue message backlog size, which may vary throughout the duration of the message\n movement task. An attribute containing the An identifier associated with a message movement task. You can use this identifier to\n cancel a specified message movement task using the 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 The Sets the value of one or more queue attributes. When you change a queue's attributes,\n the change can take up to 60 seconds for most of the attributes to propagate throughout\n the Amazon SQS system. Changes made to the 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, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide. To remove the ability to change queue permissions, you must deny permission to the The URL of the Amazon SQS queue whose attributes are set. Queue URLs and names are case-sensitive. A map of attributes to set. The following lists the names, descriptions, and values of the special request\n parameters that the \n \n \n \n \n \n The following attributes apply only to dead-letter queues:\n \n \n \n \n \n \n \n \n \n The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue. The following attributes apply only to server-side-encryption: \n \n \n The following attribute applies only to FIFO (first-in-first-out)\n queues: \n Every message must have a unique\n You may provide a If you aren't able to provide a\n If you don't provide a If the queue has When If you send one message with The following attributes apply only to \nhigh throughput\nfor FIFO queues: \n \n To enable high throughput for FIFO queues, do the following: Set Set If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified. For information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide. Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue. This action is currently limited to supporting message redrive from queues\n that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS\n queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are\n currently not supported. In dead-letter queues redrive context, the\n Currently, only standard queues support redrive. FIFO queues don't support\n redrive. Only one active message movement task is supported per queue at any given\n time. The ARN of the queue that contains the messages to be moved to another queue.\n Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues\n are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are\n not currently supported. The ARN of the queue that receives the moved messages. You can use this field to\n specify the destination queue where you would like to redrive messages. If this field is\n left blank, the messages will be redriven back to their respective original source\n queues. The number of messages to be moved per second (the message movement rate). You can use\n this field to define a fixed message movement rate. The maximum value for messages per\n second is 500. If this field is left blank, the system will optimize the rate based on\n the queue message backlog size, which may vary throughout the duration of the message\n movement task. Add cost allocation tags to the specified Amazon SQS queue. For an overview, see\n Tagging\n Your Amazon SQS Queues in the Amazon SQS Developer\n 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\n strings. Tags are case-sensitive. A new tag with a key identical to that of an existing tag overwrites the\n existing tag. For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer\n Guide. Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide. The URL of the queue. The list of tags to be added to the specified queue. An identifier associated with a message movement task. You can use this identifier to\n cancel a specified message movement task using the Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide. 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 \nQuotas related to queues \nin the Amazon SQS Developer Guide. Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide. The URL of the queue. The batch request contains more entries than permissible. The list of tags to be added to the specified queue. Error code 400. Unsupported operation. The batch request contains more entries than permissible. Error code 400. Unsupported operation. Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide. Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide. The URL of the queue. Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see\n Tagging\n Your Amazon SQS Queues in the Amazon SQS Developer\n Guide. Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide. The URL of the queue. The list of tags to be removed from the specified queue. The list of tags to be removed from the specified queue. 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. 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\n
\n AddPermission
generates a policy for you. You can use\n \n SetQueueAttributes\n
to upload your\n policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in\n the Amazon SQS Developer Guide.AddPermission
, RemovePermission
, and SetQueueAttributes
actions in your IAM policy.AddPermission
does not support adding a non-account\n principal.AliceSendMessage
). Maximum 80 characters. Allowed characters include\n alphanumeric characters, hyphens (-
), and underscores\n (_
).*
.SendMessage
, DeleteMessage
, or\n ChangeMessageVisibility
for ActionName.n
also grants\n permissions for the corresponding batch versions of those actions:\n SendMessageBatch
, DeleteMessageBatch
, and\n ChangeMessageVisibilityBatch
.\n
\n \n
",
- "smithy.api#title": "Amazon Simple Queue Service",
- "smithy.api#xmlNamespace": {
- "uri": "http://queue.amazonaws.com/doc/2012-11-05/"
- },
- "smithy.rules#endpointRuleSet": {
- "version": "1.0",
- "parameters": {
- "Region": {
- "builtIn": "AWS::Region",
- "required": false,
- "documentation": "The AWS region used to dispatch the request.",
- "type": "String"
- },
- "UseDualStack": {
- "builtIn": "AWS::UseDualStack",
- "required": true,
- "default": false,
- "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.",
- "type": "Boolean"
- },
- "UseFIPS": {
- "builtIn": "AWS::UseFIPS",
- "required": true,
- "default": false,
- "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.",
- "type": "Boolean"
- },
- "Endpoint": {
- "builtIn": "SDK::Endpoint",
- "required": false,
- "documentation": "Override the endpoint used to send this request",
- "type": "String"
- }
- },
- "rules": [
- {
- "conditions": [
- {
- "fn": "isSet",
- "argv": [
- {
- "ref": "Endpoint"
- }
- ]
- }
- ],
- "rules": [
- {
- "conditions": [
- {
- "fn": "booleanEquals",
- "argv": [
- {
- "ref": "UseFIPS"
- },
- true
- ]
- }
- ],
- "error": "Invalid Configuration: FIPS and custom endpoint are not supported",
- "type": "error"
- },
- {
- "conditions": [
- {
- "fn": "booleanEquals",
- "argv": [
- {
- "ref": "UseDualStack"
- },
- true
- ]
- }
- ],
- "error": "Invalid Configuration: Dualstack and custom endpoint are not supported",
- "type": "error"
- },
- {
- "conditions": [],
- "endpoint": {
- "url": {
- "ref": "Endpoint"
- },
- "properties": {},
- "headers": {}
+ "com.amazonaws.sqs#AWSAccountIdList": {
+ "type": "list",
+ "member": {
+ "target": "com.amazonaws.sqs#String"
+ }
+ },
+ "com.amazonaws.sqs#ActionNameList": {
+ "type": "list",
+ "member": {
+ "target": "com.amazonaws.sqs#String"
+ }
+ },
+ "com.amazonaws.sqs#AddPermission": {
+ "type": "operation",
+ "input": {
+ "target": "com.amazonaws.sqs#AddPermissionRequest"
+ },
+ "output": {
+ "target": "smithy.api#Unit"
+ },
+ "errors": [
+ {
+ "target": "com.amazonaws.sqs#InvalidAddress"
+ },
+ {
+ "target": "com.amazonaws.sqs#InvalidSecurity"
+ },
+ {
+ "target": "com.amazonaws.sqs#OverLimit"
+ },
+ {
+ "target": "com.amazonaws.sqs#QueueDoesNotExist"
+ },
+ {
+ "target": "com.amazonaws.sqs#RequestThrottled"
+ },
+ {
+ "target": "com.amazonaws.sqs#UnsupportedOperation"
+ }
+ ],
+ "traits": {
+ "smithy.api#documentation": "\n
\n \n
\n \n
\n AddPermission
generates a policy for you. You can use\n \n SetQueueAttributes\n
to upload your\n policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy\n Language in the Amazon SQS Developer\n Guide.AddPermission
, RemovePermission
,\n and SetQueueAttributes
actions in your IAM policy.AddPermission
does not support adding a\n non-account principal.AliceSendMessage
). Maximum 80 characters. Allowed characters include\n alphanumeric characters, hyphens (-
), and underscores\n (_
).*
.SendMessage
, DeleteMessage
, or\n ChangeMessageVisibility
for ActionName.n
also grants\n permissions for the corresponding batch versions of those actions:\n SendMessageBatch
, DeleteMessageBatch
, and\n ChangeMessageVisibilityBatch
.\n
\n \n
",
+ "smithy.api#title": "Amazon Simple Queue Service",
+ "smithy.rules#endpointRuleSet": {
+ "version": "1.0",
+ "parameters": {
+ "Region": {
+ "builtIn": "AWS::Region",
+ "required": false,
+ "documentation": "The AWS region used to dispatch the request.",
+ "type": "String"
+ },
+ "UseDualStack": {
+ "builtIn": "AWS::UseDualStack",
+ "required": true,
+ "default": false,
+ "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.",
+ "type": "Boolean"
+ },
+ "UseFIPS": {
+ "builtIn": "AWS::UseFIPS",
+ "required": true,
+ "default": false,
+ "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.",
+ "type": "Boolean"
+ },
+ "Endpoint": {
+ "builtIn": "SDK::Endpoint",
+ "required": false,
+ "documentation": "Override the endpoint used to send this request",
+ "type": "String"
+ }
},
- "type": "endpoint"
- }
- ],
- "type": "tree"
- },
- {
- "conditions": [
- {
- "fn": "isSet",
- "argv": [
- {
- "ref": "Region"
- }
- ]
- }
- ],
- "rules": [
- {
- "conditions": [
- {
- "fn": "aws.partition",
- "argv": [
- {
- "ref": "Region"
- }
- ],
- "assign": "PartitionResult"
- }
- ],
"rules": [
- {
- "conditions": [
- {
- "fn": "booleanEquals",
- "argv": [
- {
- "ref": "UseFIPS"
- },
- true
- ]
- },
- {
- "fn": "booleanEquals",
- "argv": [
- {
- "ref": "UseDualStack"
- },
- true
- ]
- }
- ],
- "rules": [
- {
+ {
"conditions": [
- {
- "fn": "booleanEquals",
- "argv": [
- true,
- {
- "fn": "getAttr",
+ {
+ "fn": "isSet",
"argv": [
- {
- "ref": "PartitionResult"
- },
- "supportsFIPS"
+ {
+ "ref": "Endpoint"
+ }
]
- }
- ]
- },
- {
- "fn": "booleanEquals",
- "argv": [
- true,
- {
- "fn": "getAttr",
- "argv": [
- {
- "ref": "PartitionResult"
- },
- "supportsDualStack"
- ]
- }
- ]
- }
+ }
],
"rules": [
- {
- "conditions": [],
- "endpoint": {
- "url": "https://sqs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",
- "properties": {},
- "headers": {}
+ {
+ "conditions": [
+ {
+ "fn": "booleanEquals",
+ "argv": [
+ {
+ "ref": "UseFIPS"
+ },
+ true
+ ]
+ }
+ ],
+ "error": "Invalid Configuration: FIPS and custom endpoint are not supported",
+ "type": "error"
},
- "type": "endpoint"
- }
- ],
- "type": "tree"
- },
- {
- "conditions": [],
- "error": "FIPS and DualStack are enabled, but this partition does not support one or both",
- "type": "error"
- }
- ],
- "type": "tree"
- },
- {
- "conditions": [
- {
- "fn": "booleanEquals",
- "argv": [
- {
- "ref": "UseFIPS"
- },
- true
- ]
- }
- ],
- "rules": [
- {
- "conditions": [
- {
- "fn": "booleanEquals",
- "argv": [
- {
- "fn": "getAttr",
- "argv": [
- {
- "ref": "PartitionResult"
- },
- "supportsFIPS"
- ]
- },
- true
- ]
- }
- ],
- "rules": [
- {
- "conditions": [
- {
- "fn": "stringEquals",
- "argv": [
- {
- "fn": "getAttr",
- "argv": [
- {
- "ref": "PartitionResult"
- },
- "name"
- ]
- },
- "aws-us-gov"
- ]
- }
- ],
- "endpoint": {
- "url": "https://sqs.{Region}.amazonaws.com",
- "properties": {},
- "headers": {}
+ {
+ "conditions": [
+ {
+ "fn": "booleanEquals",
+ "argv": [
+ {
+ "ref": "UseDualStack"
+ },
+ true
+ ]
+ }
+ ],
+ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported",
+ "type": "error"
},
- "type": "endpoint"
- },
- {
- "conditions": [],
- "endpoint": {
- "url": "https://sqs-fips.{Region}.{PartitionResult#dnsSuffix}",
- "properties": {},
- "headers": {}
- },
- "type": "endpoint"
- }
+ {
+ "conditions": [],
+ "endpoint": {
+ "url": {
+ "ref": "Endpoint"
+ },
+ "properties": {},
+ "headers": {}
+ },
+ "type": "endpoint"
+ }
],
"type": "tree"
- },
- {
- "conditions": [],
- "error": "FIPS is enabled but this partition does not support FIPS",
- "type": "error"
- }
- ],
- "type": "tree"
- },
- {
- "conditions": [
- {
- "fn": "booleanEquals",
- "argv": [
- {
- "ref": "UseDualStack"
- },
- true
- ]
- }
- ],
- "rules": [
- {
+ },
+ {
"conditions": [
- {
- "fn": "booleanEquals",
- "argv": [
- true,
- {
- "fn": "getAttr",
+ {
+ "fn": "isSet",
"argv": [
- {
- "ref": "PartitionResult"
- },
- "supportsDualStack"
+ {
+ "ref": "Region"
+ }
]
- }
- ]
- }
+ }
],
"rules": [
- {
- "conditions": [],
- "endpoint": {
- "url": "https://sqs.{Region}.{PartitionResult#dualStackDnsSuffix}",
- "properties": {},
- "headers": {}
- },
- "type": "endpoint"
- }
+ {
+ "conditions": [
+ {
+ "fn": "aws.partition",
+ "argv": [
+ {
+ "ref": "Region"
+ }
+ ],
+ "assign": "PartitionResult"
+ }
+ ],
+ "rules": [
+ {
+ "conditions": [
+ {
+ "fn": "booleanEquals",
+ "argv": [
+ {
+ "ref": "UseFIPS"
+ },
+ true
+ ]
+ },
+ {
+ "fn": "booleanEquals",
+ "argv": [
+ {
+ "ref": "UseDualStack"
+ },
+ true
+ ]
+ }
+ ],
+ "rules": [
+ {
+ "conditions": [
+ {
+ "fn": "booleanEquals",
+ "argv": [
+ true,
+ {
+ "fn": "getAttr",
+ "argv": [
+ {
+ "ref": "PartitionResult"
+ },
+ "supportsFIPS"
+ ]
+ }
+ ]
+ },
+ {
+ "fn": "booleanEquals",
+ "argv": [
+ true,
+ {
+ "fn": "getAttr",
+ "argv": [
+ {
+ "ref": "PartitionResult"
+ },
+ "supportsDualStack"
+ ]
+ }
+ ]
+ }
+ ],
+ "rules": [
+ {
+ "conditions": [],
+ "endpoint": {
+ "url": "https://sqs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",
+ "properties": {},
+ "headers": {}
+ },
+ "type": "endpoint"
+ }
+ ],
+ "type": "tree"
+ },
+ {
+ "conditions": [],
+ "error": "FIPS and DualStack are enabled, but this partition does not support one or both",
+ "type": "error"
+ }
+ ],
+ "type": "tree"
+ },
+ {
+ "conditions": [
+ {
+ "fn": "booleanEquals",
+ "argv": [
+ {
+ "ref": "UseFIPS"
+ },
+ true
+ ]
+ }
+ ],
+ "rules": [
+ {
+ "conditions": [
+ {
+ "fn": "booleanEquals",
+ "argv": [
+ {
+ "fn": "getAttr",
+ "argv": [
+ {
+ "ref": "PartitionResult"
+ },
+ "supportsFIPS"
+ ]
+ },
+ true
+ ]
+ }
+ ],
+ "rules": [
+ {
+ "conditions": [
+ {
+ "fn": "stringEquals",
+ "argv": [
+ {
+ "fn": "getAttr",
+ "argv": [
+ {
+ "ref": "PartitionResult"
+ },
+ "name"
+ ]
+ },
+ "aws-us-gov"
+ ]
+ }
+ ],
+ "endpoint": {
+ "url": "https://sqs.{Region}.amazonaws.com",
+ "properties": {},
+ "headers": {}
+ },
+ "type": "endpoint"
+ },
+ {
+ "conditions": [],
+ "endpoint": {
+ "url": "https://sqs-fips.{Region}.{PartitionResult#dnsSuffix}",
+ "properties": {},
+ "headers": {}
+ },
+ "type": "endpoint"
+ }
+ ],
+ "type": "tree"
+ },
+ {
+ "conditions": [],
+ "error": "FIPS is enabled but this partition does not support FIPS",
+ "type": "error"
+ }
+ ],
+ "type": "tree"
+ },
+ {
+ "conditions": [
+ {
+ "fn": "booleanEquals",
+ "argv": [
+ {
+ "ref": "UseDualStack"
+ },
+ true
+ ]
+ }
+ ],
+ "rules": [
+ {
+ "conditions": [
+ {
+ "fn": "booleanEquals",
+ "argv": [
+ true,
+ {
+ "fn": "getAttr",
+ "argv": [
+ {
+ "ref": "PartitionResult"
+ },
+ "supportsDualStack"
+ ]
+ }
+ ]
+ }
+ ],
+ "rules": [
+ {
+ "conditions": [],
+ "endpoint": {
+ "url": "https://sqs.{Region}.{PartitionResult#dualStackDnsSuffix}",
+ "properties": {},
+ "headers": {}
+ },
+ "type": "endpoint"
+ }
+ ],
+ "type": "tree"
+ },
+ {
+ "conditions": [],
+ "error": "DualStack is enabled but this partition does not support DualStack",
+ "type": "error"
+ }
+ ],
+ "type": "tree"
+ },
+ {
+ "conditions": [],
+ "endpoint": {
+ "url": "https://sqs.{Region}.{PartitionResult#dnsSuffix}",
+ "properties": {},
+ "headers": {}
+ },
+ "type": "endpoint"
+ }
+ ],
+ "type": "tree"
+ }
],
"type": "tree"
- },
- {
+ },
+ {
"conditions": [],
- "error": "DualStack is enabled but this partition does not support DualStack",
+ "error": "Invalid Configuration: Missing Region",
"type": "error"
- }
- ],
- "type": "tree"
- },
- {
- "conditions": [],
- "endpoint": {
- "url": "https://sqs.{Region}.{PartitionResult#dnsSuffix}",
- "properties": {},
- "headers": {}
+ }
+ ]
+ },
+ "smithy.rules#endpointTests": {
+ "testCases": [
+ {
+ "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.af-south-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "af-south-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.ap-east-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "ap-east-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.ap-northeast-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "ap-northeast-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.ap-northeast-2.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "ap-northeast-2",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.ap-northeast-3.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "ap-northeast-3",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.ap-south-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "ap-south-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.ap-southeast-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "ap-southeast-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.ap-southeast-2.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "ap-southeast-2",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.ap-southeast-3.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "ap-southeast-3",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.ca-central-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "ca-central-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.eu-central-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "eu-central-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.eu-north-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "eu-north-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.eu-south-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "eu-south-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.eu-west-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "eu-west-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.eu-west-2.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "eu-west-2",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
},
- "type": "endpoint"
- }
+ {
+ "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.eu-west-3.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "eu-west-3",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.me-south-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "me-south-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.sa-east-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "sa-east-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.us-east-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "us-east-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs-fips.us-east-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "us-east-1",
+ "UseFIPS": true,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.us-east-2.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "us-east-2",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs-fips.us-east-2.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "us-east-2",
+ "UseFIPS": true,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.us-west-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "us-west-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs-fips.us-west-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "us-west-1",
+ "UseFIPS": true,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.us-west-2.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "us-west-2",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs-fips.us-west-2.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "us-west-2",
+ "UseFIPS": true,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs-fips.us-east-1.api.aws"
+ }
+ },
+ "params": {
+ "Region": "us-east-1",
+ "UseFIPS": true,
+ "UseDualStack": true
+ }
+ },
+ {
+ "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.us-east-1.api.aws"
+ }
+ },
+ "params": {
+ "Region": "us-east-1",
+ "UseFIPS": false,
+ "UseDualStack": true
+ }
+ },
+ {
+ "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.cn-north-1.amazonaws.com.cn"
+ }
+ },
+ "params": {
+ "Region": "cn-north-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.cn-northwest-1.amazonaws.com.cn"
+ }
+ },
+ "params": {
+ "Region": "cn-northwest-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs-fips.cn-north-1.api.amazonwebservices.com.cn"
+ }
+ },
+ "params": {
+ "Region": "cn-north-1",
+ "UseFIPS": true,
+ "UseDualStack": true
+ }
+ },
+ {
+ "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs-fips.cn-north-1.amazonaws.com.cn"
+ }
+ },
+ "params": {
+ "Region": "cn-north-1",
+ "UseFIPS": true,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.cn-north-1.api.amazonwebservices.com.cn"
+ }
+ },
+ "params": {
+ "Region": "cn-north-1",
+ "UseFIPS": false,
+ "UseDualStack": true
+ }
+ },
+ {
+ "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.us-gov-east-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "us-gov-east-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.us-gov-west-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "us-gov-west-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs-fips.us-gov-east-1.api.aws"
+ }
+ },
+ "params": {
+ "Region": "us-gov-east-1",
+ "UseFIPS": true,
+ "UseDualStack": true
+ }
+ },
+ {
+ "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.us-gov-east-1.amazonaws.com"
+ }
+ },
+ "params": {
+ "Region": "us-gov-east-1",
+ "UseFIPS": true,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.us-gov-east-1.api.aws"
+ }
+ },
+ "params": {
+ "Region": "us-gov-east-1",
+ "UseFIPS": false,
+ "UseDualStack": true
+ }
+ },
+ {
+ "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.us-iso-east-1.c2s.ic.gov"
+ }
+ },
+ "params": {
+ "Region": "us-iso-east-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.us-iso-west-1.c2s.ic.gov"
+ }
+ },
+ "params": {
+ "Region": "us-iso-west-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled",
+ "expect": {
+ "error": "FIPS and DualStack are enabled, but this partition does not support one or both"
+ },
+ "params": {
+ "Region": "us-iso-east-1",
+ "UseFIPS": true,
+ "UseDualStack": true
+ }
+ },
+ {
+ "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs-fips.us-iso-east-1.c2s.ic.gov"
+ }
+ },
+ "params": {
+ "Region": "us-iso-east-1",
+ "UseFIPS": true,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled",
+ "expect": {
+ "error": "DualStack is enabled but this partition does not support DualStack"
+ },
+ "params": {
+ "Region": "us-iso-east-1",
+ "UseFIPS": false,
+ "UseDualStack": true
+ }
+ },
+ {
+ "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs.us-isob-east-1.sc2s.sgov.gov"
+ }
+ },
+ "params": {
+ "Region": "us-isob-east-1",
+ "UseFIPS": false,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled",
+ "expect": {
+ "error": "FIPS and DualStack are enabled, but this partition does not support one or both"
+ },
+ "params": {
+ "Region": "us-isob-east-1",
+ "UseFIPS": true,
+ "UseDualStack": true
+ }
+ },
+ {
+ "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://sqs-fips.us-isob-east-1.sc2s.sgov.gov"
+ }
+ },
+ "params": {
+ "Region": "us-isob-east-1",
+ "UseFIPS": true,
+ "UseDualStack": false
+ }
+ },
+ {
+ "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled",
+ "expect": {
+ "error": "DualStack is enabled but this partition does not support DualStack"
+ },
+ "params": {
+ "Region": "us-isob-east-1",
+ "UseFIPS": false,
+ "UseDualStack": true
+ }
+ },
+ {
+ "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://example.com"
+ }
+ },
+ "params": {
+ "Region": "us-east-1",
+ "UseFIPS": false,
+ "UseDualStack": false,
+ "Endpoint": "https://example.com"
+ }
+ },
+ {
+ "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled",
+ "expect": {
+ "endpoint": {
+ "url": "https://example.com"
+ }
+ },
+ "params": {
+ "UseFIPS": false,
+ "UseDualStack": false,
+ "Endpoint": "https://example.com"
+ }
+ },
+ {
+ "documentation": "For custom endpoint with fips enabled and dualstack disabled",
+ "expect": {
+ "error": "Invalid Configuration: FIPS and custom endpoint are not supported"
+ },
+ "params": {
+ "Region": "us-east-1",
+ "UseFIPS": true,
+ "UseDualStack": false,
+ "Endpoint": "https://example.com"
+ }
+ },
+ {
+ "documentation": "For custom endpoint with fips disabled and dualstack enabled",
+ "expect": {
+ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported"
+ },
+ "params": {
+ "Region": "us-east-1",
+ "UseFIPS": false,
+ "UseDualStack": true,
+ "Endpoint": "https://example.com"
+ }
+ },
+ {
+ "documentation": "Missing region",
+ "expect": {
+ "error": "Invalid Configuration: Missing Region"
+ }
+ }
],
- "type": "tree"
- }
- ],
- "type": "tree"
- },
- {
- "conditions": [],
- "error": "Invalid Configuration: Missing Region",
- "type": "error"
- }
- ]
- },
- "smithy.rules#endpointTests": {
- "testCases": [
- {
- "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.af-south-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "af-south-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region ap-east-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.ap-east-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "ap-east-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.ap-northeast-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "ap-northeast-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.ap-northeast-2.amazonaws.com"
- }
- },
- "params": {
- "Region": "ap-northeast-2",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.ap-northeast-3.amazonaws.com"
- }
- },
- "params": {
- "Region": "ap-northeast-3",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.ap-south-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "ap-south-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.ap-southeast-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "ap-southeast-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.ap-southeast-2.amazonaws.com"
- }
- },
- "params": {
- "Region": "ap-southeast-2",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.ap-southeast-3.amazonaws.com"
- }
- },
- "params": {
- "Region": "ap-southeast-3",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.ca-central-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "ca-central-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.eu-central-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "eu-central-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.eu-north-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "eu-north-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.eu-south-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "eu-south-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.eu-west-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "eu-west-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.eu-west-2.amazonaws.com"
- }
- },
- "params": {
- "Region": "eu-west-2",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.eu-west-3.amazonaws.com"
- }
- },
- "params": {
- "Region": "eu-west-3",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.me-south-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "me-south-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.sa-east-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "sa-east-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.us-east-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "us-east-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs-fips.us-east-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "us-east-1",
- "UseFIPS": true,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.us-east-2.amazonaws.com"
- }
- },
- "params": {
- "Region": "us-east-2",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs-fips.us-east-2.amazonaws.com"
- }
- },
- "params": {
- "Region": "us-east-2",
- "UseFIPS": true,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.us-west-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "us-west-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs-fips.us-west-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "us-west-1",
- "UseFIPS": true,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.us-west-2.amazonaws.com"
- }
- },
- "params": {
- "Region": "us-west-2",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs-fips.us-west-2.amazonaws.com"
- }
- },
- "params": {
- "Region": "us-west-2",
- "UseFIPS": true,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs-fips.us-east-1.api.aws"
- }
- },
- "params": {
- "Region": "us-east-1",
- "UseFIPS": true,
- "UseDualStack": true
- }
- },
- {
- "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.us-east-1.api.aws"
- }
- },
- "params": {
- "Region": "us-east-1",
- "UseFIPS": false,
- "UseDualStack": true
- }
- },
- {
- "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.cn-north-1.amazonaws.com.cn"
- }
- },
- "params": {
- "Region": "cn-north-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.cn-northwest-1.amazonaws.com.cn"
- }
- },
- "params": {
- "Region": "cn-northwest-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs-fips.cn-north-1.api.amazonwebservices.com.cn"
- }
- },
- "params": {
- "Region": "cn-north-1",
- "UseFIPS": true,
- "UseDualStack": true
- }
- },
- {
- "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs-fips.cn-north-1.amazonaws.com.cn"
- }
- },
- "params": {
- "Region": "cn-north-1",
- "UseFIPS": true,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.cn-north-1.api.amazonwebservices.com.cn"
- }
- },
- "params": {
- "Region": "cn-north-1",
- "UseFIPS": false,
- "UseDualStack": true
- }
- },
- {
- "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.us-gov-east-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "us-gov-east-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.us-gov-west-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "us-gov-west-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs-fips.us-gov-east-1.api.aws"
- }
- },
- "params": {
- "Region": "us-gov-east-1",
- "UseFIPS": true,
- "UseDualStack": true
- }
- },
- {
- "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.us-gov-east-1.amazonaws.com"
- }
- },
- "params": {
- "Region": "us-gov-east-1",
- "UseFIPS": true,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.us-gov-east-1.api.aws"
- }
- },
- "params": {
- "Region": "us-gov-east-1",
- "UseFIPS": false,
- "UseDualStack": true
- }
- },
- {
- "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.us-iso-east-1.c2s.ic.gov"
- }
- },
- "params": {
- "Region": "us-iso-east-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.us-iso-west-1.c2s.ic.gov"
- }
- },
- "params": {
- "Region": "us-iso-west-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled",
- "expect": {
- "error": "FIPS and DualStack are enabled, but this partition does not support one or both"
- },
- "params": {
- "Region": "us-iso-east-1",
- "UseFIPS": true,
- "UseDualStack": true
- }
- },
- {
- "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs-fips.us-iso-east-1.c2s.ic.gov"
- }
- },
- "params": {
- "Region": "us-iso-east-1",
- "UseFIPS": true,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled",
- "expect": {
- "error": "DualStack is enabled but this partition does not support DualStack"
- },
- "params": {
- "Region": "us-iso-east-1",
- "UseFIPS": false,
- "UseDualStack": true
- }
- },
- {
- "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs.us-isob-east-1.sc2s.sgov.gov"
- }
- },
- "params": {
- "Region": "us-isob-east-1",
- "UseFIPS": false,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled",
- "expect": {
- "error": "FIPS and DualStack are enabled, but this partition does not support one or both"
- },
- "params": {
- "Region": "us-isob-east-1",
- "UseFIPS": true,
- "UseDualStack": true
- }
- },
- {
- "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled",
- "expect": {
- "endpoint": {
- "url": "https://sqs-fips.us-isob-east-1.sc2s.sgov.gov"
- }
- },
- "params": {
- "Region": "us-isob-east-1",
- "UseFIPS": true,
- "UseDualStack": false
- }
- },
- {
- "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled",
- "expect": {
- "error": "DualStack is enabled but this partition does not support DualStack"
- },
- "params": {
- "Region": "us-isob-east-1",
- "UseFIPS": false,
- "UseDualStack": true
- }
- },
- {
- "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled",
- "expect": {
- "endpoint": {
- "url": "https://example.com"
- }
- },
- "params": {
- "Region": "us-east-1",
- "UseFIPS": false,
- "UseDualStack": false,
- "Endpoint": "https://example.com"
- }
- },
- {
- "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled",
- "expect": {
- "endpoint": {
- "url": "https://example.com"
- }
- },
- "params": {
- "UseFIPS": false,
- "UseDualStack": false,
- "Endpoint": "https://example.com"
- }
- },
- {
- "documentation": "For custom endpoint with fips enabled and dualstack disabled",
- "expect": {
- "error": "Invalid Configuration: FIPS and custom endpoint are not supported"
- },
- "params": {
- "Region": "us-east-1",
- "UseFIPS": true,
- "UseDualStack": false,
- "Endpoint": "https://example.com"
- }
- },
- {
- "documentation": "For custom endpoint with fips disabled and dualstack enabled",
- "expect": {
- "error": "Invalid Configuration: Dualstack and custom endpoint are not supported"
- },
- "params": {
- "Region": "us-east-1",
- "UseFIPS": false,
- "UseDualStack": true,
- "Endpoint": "https://example.com"
- }
- },
- {
- "documentation": "Missing region",
- "expect": {
- "error": "Invalid Configuration: Missing Region"
- }
- }
- ],
- "version": "1.0"
- }
- }
- },
- "com.amazonaws.sqs#AttributeNameList": {
- "type": "list",
- "member": {
- "target": "com.amazonaws.sqs#QueueAttributeName"
- }
- },
- "com.amazonaws.sqs#BatchEntryIdsNotDistinct": {
- "type": "structure",
- "members": {},
- "traits": {
- "aws.protocols#awsQueryError": {
- "code": "AWS.SimpleQueueService.BatchEntryIdsNotDistinct",
- "httpResponseCode": 400
- },
- "smithy.api#documentation": "\n
\n \n
\n Id
.Id
of an entry in a batch request.\n
\n Id
.VisibilityTimeout
set to 10 seconds, the 10 seconds begin to count from\n the time that you make the ChangeMessageVisibility
call. Thus, any attempt\n to change the visibility timeout or to delete that message 10 seconds after you\n initially change the visibility timeout (a total of 25 seconds) might result in an\n error.\n
\n OverLimit
error message.\n To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.\n To request a limit increase, file a support request.VisibilityTimeout
to a value greater than\n the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically\n recalculate and increase the timeout to the maximum remaining time.ChangeMessageVisibility
action) the next time the message is\n received.\n ChangeMessageVisibility.
The result of the action\n on each message is reported individually in the response. You can send up to 10\n \n ChangeMessageVisibility\n
requests with each\n ChangeMessageVisibilityBatch
action.200
.Id
s of a batch request need to be unique within a request.\n ChangeMessageVisibilityBatch.
\n \n ChangeMessageVisibilityBatchResultEntry\n
\n items.\n BatchResultErrorEntry\n
items.\n ChangeMessageVisibilityBatchResultEntry\n
tag if the message\n succeeds or a \n BatchResultErrorEntry\n
tag if the message\n fails.Id
of an entry in a batch request.Id
of an entry in \n ChangeMessageVisibilityBatch.
\n \n ReceiveMessage\n
\n action.0
to 43200
. Maximum: 12 hours.\n
\n FifoQueue
attribute, Amazon SQS creates a standard queue.\n GetQueueUrl\n
action.\n \n GetQueueUrl\n
requires only the\n QueueName
parameter. be aware of existing queue names:\n
\n CreateQueue
returns the queue\n URL for the existing queue.CreateQueue
returns an error.\n
\n -
), and\n underscores (_
)..fifo
suffix.\n
\n sqs:CreateQueue
and sqs:TagQueue
permissions.CreateQueue
action uses:\n
\n DelaySeconds
– The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 seconds (15 minutes). Default: 0. MaximumMessageSize
– The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod
– The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1\n minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.Policy
– The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the IAM User Guide. ReceiveMessageWaitTimeSeconds
– The length of time, in\n seconds, for which a \n ReceiveMessage\n
action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0. VisibilityTimeout
– The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.\n
\n RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:\n
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount
is exceeded.maxReceiveCount
– The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
\n for a queue, Amazon SQS moves the message to the dead-letter-queue.RedriveAllowPolicy
– The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:\n
\n redrivePermission
– The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:\n
\n allowAll
– (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.denyAll
– No source queues can specify this queue as the dead-letter\n queue.byQueue
– Only queues specified by the sourceQueueArns
parameter can specify \n this queue as the dead-letter queue.sourceQueueArns
– The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission
parameter is set to byQueue
. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission
parameter\n to allowAll
.\n
\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is\n always alias/aws/sqs
, the alias of a custom CMK can, for example,\n be alias/MyAlias\n
. For more examples, see\n KeyId in the Key Management Service API\n Reference. KmsDataKeyReusePeriodSeconds
– The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?\n SqsManagedSseEnabled
– Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).\n
\n FifoQueue
– Designates a queue as FIFO. Valid values are\n true
and false
. If you don't specify the FifoQueue
attribute, Amazon SQS creates a standard queue. You\n can provide this attribute only during queue creation. You can't change it for\n an existing queue. When you set this attribute, you must also provide the\n MessageGroupId
for your messages explicitly.ContentBasedDeduplication
– Enables content-based\n deduplication. Valid values are true
and false
. For\n more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following: \n
\n MessageDeduplicationId
.\n
\n MessageDeduplicationId
\n explicitly.MessageDeduplicationId
and you enable\n ContentBasedDeduplication
for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the\n message (but not the attributes of the message). MessageDeduplicationId
and\n the queue doesn't have ContentBasedDeduplication
\n set, the action fails with an error.ContentBasedDeduplication
set,\n your MessageDeduplicationId
overrides the generated\n one.ContentBasedDeduplication
is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.ContentBasedDeduplication
\n enabled and then another message with a\n MessageDeduplicationId
that is the same as the one\n generated for the first MessageDeduplicationId
, the two\n messages are treated as duplicates and only one copy of the message is\n delivered. \n
\n DeduplicationScope
– Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup
and queue
.FifoThroughputLimit
– Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue
and perMessageGroupId
. \n The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.\n
\n DeduplicationScope
to messageGroup
.FifoThroughputLimit
to perMessageGroupId
.QueueUrl
attribute of the created queue.ReceiptHandle
of the message (not the\n MessageId
which you receive when you send the message). Amazon SQS can\n delete a message from a queue even if a visibility timeout setting causes the message to\n be locked by another consumer. Amazon SQS automatically deletes messages left in a queue\n longer than the retention period configured for the queue. ReceiptHandle
is associated with a specific\n instance of receiving a message. If you receive a message more than\n once, the ReceiptHandle
is different each time you receive a message.\n When you use the DeleteMessage
action, you must provide the most\n recently received ReceiptHandle
for the message (otherwise, the request\n succeeds, but the message will not be deleted).\n DeleteMessage.
The result of the action on each\n message is reported individually in the response.200
.Id
s of a batch request need to be unique within a request.\n
\n \n DeleteMessageBatchResultEntry\n
items.\n BatchResultErrorEntry\n
items.\n DeleteMessageBatchResultEntry\n
tag if the message is deleted\n or a \n BatchResultErrorEntry\n
tag if the message can't be\n deleted.Id
of an entry in \n DeleteMessageBatch.
\n VisibilityTimeout
set to 10 seconds, the 10 seconds begin to count from\n the time that you make the ChangeMessageVisibility
call. Thus, any attempt\n to change the visibility timeout or to delete that message 10 seconds after you\n initially change the visibility timeout (a total of 25 seconds) might result in an\n error.\n
\n OverLimit
error message. To avoid reaching the limit, you\n should delete messages from the queue after they're processed. You can also increase the\n number of queues you use to process your messages. To request a limit increase, file a support request.VisibilityTimeout
to a value greater than\n the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically\n recalculate and increase the timeout to the maximum remaining time.ChangeMessageVisibility
action) the next time the message is\n received.QueueUrl
, regardless of the queue's\n contents.DeleteQueue
action: When you delete a queue, any\n messages in the queue are no longer available. \n SendMessage\n
request might succeed, but after 60\n seconds the queue and the message you sent no longer exist.GET
verb.\n ChangeMessageVisibility.
The result of the action\n on each message is reported individually in the response. You can send up to 10\n \n ChangeMessageVisibility\n
requests with each\n ChangeMessageVisibilityBatch
action.200
.QueueName
ends with the .fifo
suffix.Id
s of a batch request need to be unique within a request.AttributeNames
parameter is optional, but if you don't specify values\n for this parameter, the request returns empty results.ApproximateNumberOfMessagesDelayed
,\n ApproximateNumberOfMessagesNotVisible
, and\n ApproximateNumberOfMessages
metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is\n required for the queue metadata to reach eventual consistency. \n
\n All
– Returns all values. ApproximateNumberOfMessages
– Returns the approximate\n number of messages available for retrieval from the queue.ApproximateNumberOfMessagesDelayed
– Returns the\n approximate number of messages in the queue that are delayed and not available\n for reading immediately. This can happen when the queue is configured as a delay\n queue or when a message has been sent with a delay parameter.ApproximateNumberOfMessagesNotVisible
– Returns the\n approximate number of messages that are in flight. Messages are considered to be\n in flight if they have been sent to a client but have\n not yet been deleted or have not yet reached the end of their visibility window.\n CreatedTimestamp
– Returns the time when the queue was\n created in seconds (epoch\n time).DelaySeconds
– Returns the default delay on the queue in\n seconds.LastModifiedTimestamp
– Returns the time when the queue\n was last changed in seconds (epoch time).MaximumMessageSize
– Returns the limit of how many bytes a\n message can contain before Amazon SQS rejects it.MessageRetentionPeriod
– Returns the length of time, in\n seconds, for which Amazon SQS retains a message. When you change a queue's\n attributes, the change can take up to 60 seconds for most of the attributes to\n propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.Policy
– Returns the policy of the queue.QueueArn
– Returns the Amazon resource name (ARN) of the\n queue.ReceiveMessageWaitTimeSeconds
– Returns the length of\n time, in seconds, for which the ReceiveMessage
action waits for a\n message to arrive. VisibilityTimeout
– Returns the visibility timeout for the\n queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide. \n
\n RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:\n
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount
is exceeded.maxReceiveCount
– The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
\n for a queue, Amazon SQS moves the message to the dead-letter-queue.RedriveAllowPolicy
– The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:\n
\n redrivePermission
– The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:\n
\n allowAll
– (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.denyAll
– No source queues can specify this queue as the dead-letter\n queue.byQueue
– Only queues specified by the sourceQueueArns
parameter can specify \n this queue as the dead-letter queue.sourceQueueArns
– The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission
parameter is set to byQueue
. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission
parameter\n to allowAll
.\n
\n KmsMasterKeyId
– Returns the ID of an Amazon Web Services managed customer\n master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. KmsDataKeyReusePeriodSeconds
– Returns the length of time,\n in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt\n messages before calling KMS again. For more information, see\n How Does the Data Key Reuse Period Work?. SqsManagedSseEnabled
– Returns information about whether the\n queue is using SSE-SQS encryption using SQS owned encryption keys. Only one\n server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).\n
\n FifoQueue
– Returns information about whether the queue is\n FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.QueueName
ends with the .fifo
suffix.ContentBasedDeduplication
– Returns whether content-based\n deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. \n
\n DeduplicationScope
– Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup
and queue
.FifoThroughputLimit
– Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue
and perMessageGroupId
. \n The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.\n
\n DeduplicationScope
to messageGroup
.FifoThroughputLimit
to perMessageGroupId
.\n ChangeMessageVisibilityBatch.
\n QueueOwnerAWSAccountId
parameter to specify the account ID of the\n queue's owner. The queue's owner must grant you permission to access the queue. For more\n information about shared queue access, see \n AddPermission\n
\n or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS\n Developer Guide. -
), and underscores\n (_
).\n ChangeMessageVisibilityBatchResultEntry\n
\n items.\n BatchResultErrorEntry\n
items.\n ChangeMessageVisibilityBatchResultEntry\n
tag if the message\n succeeds or a \n BatchResultErrorEntry\n
tag if the message\n fails.Id
of an entry in \n ChangeMessageVisibilityBatch.
\n Id
of a batch entry in a batch request doesn't abide by the\n specification.RedrivePolicy
queue attribute\n configured with a dead-letter queue.ListDeadLetterSourceQueues
methods supports pagination. Set\n parameter MaxResults
in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults
, the\n response includes a maximum of 1,000 results. If you set MaxResults
and\n there are additional results to display, the response includes a value for\n NextToken
. Use NextToken
as a parameter in your next\n request to ListDeadLetterSourceQueues
to receive the next page of results. \n ReceiveMessage\n
\n action.0
to 43200
. Maximum: 12 hours.MaxResults
to receive a value for NextToken
in the\n response.\n
\n FifoQueue
attribute, Amazon SQS creates\n a standard queue.\n GetQueueUrl\n
action.\n \n GetQueueUrl\n
requires only the\n QueueName
parameter. be aware of existing queue names:\n
\n CreateQueue
returns the queue\n URL for the existing queue.CreateQueue
returns an error.\n
\n -
), and\n underscores (_
)..fifo
suffix.CreateQueue
action uses:\n
\n DelaySeconds
– The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 seconds (15 minutes). Default: 0. MaximumMessageSize
– The limit of how many bytes a message can\n contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod
– The length of time, in seconds, for which\n Amazon SQS retains a message. Valid values: An integer from 60 seconds (1\n minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to\n the MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.Policy
– The queue's policy. A valid Amazon Web Services\n policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the IAM\n User Guide. ReceiveMessageWaitTimeSeconds
– The length of time, in seconds, for\n which a \n ReceiveMessage\n
action waits for a message\n to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. VisibilityTimeout
– The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.\n
\n RedrivePolicy
– The string that includes the parameters for the\n dead-letter queue functionality of the source queue as a JSON object. The\n parameters are as follows:\n
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of\n the dead-letter queue to which Amazon SQS moves messages after the value\n of maxReceiveCount
is exceeded.maxReceiveCount
– The number of times a message is\n delivered to the source queue before being moved to the dead-letter\n queue. Default: 10. When the ReceiveCount
for a message\n exceeds the maxReceiveCount
for a queue, Amazon SQS moves\n the message to the dead-letter-queue.RedriveAllowPolicy
– The string that includes the parameters for\n the permissions for the dead-letter queue redrive permission and which source\n queues can specify dead-letter queues as a JSON object. The parameters are as\n follows:\n
\n redrivePermission
– The permission type that defines\n which source queues can specify the current queue as the dead-letter\n queue. Valid values are:\n
\n allowAll
– (Default) Any source queues in this\n Amazon Web Services account in the same\n Region can specify this queue as the dead-letter queue.denyAll
– No source queues can specify this queue\n as the dead-letter queue.byQueue
– Only queues specified by the\n sourceQueueArns
parameter can specify this\n queue as the dead-letter queue.sourceQueueArns
– The Amazon Resource Names (ARN)s of the\n source queues that can specify this queue as the dead-letter queue and\n redrive messages. You can specify this parameter only when the\n redrivePermission
parameter is set to\n byQueue
. You can specify up to 10 source queue ARNs. To\n allow more than 10 source queues to specify dead-letter queues, set the\n redrivePermission
parameter to\n allowAll
.\n
\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer\n master key (CMK) for Amazon SQS or a custom CMK. For more information, see\n Key Terms. While the alias of the Amazon Web Services\n managed CMK for Amazon SQS is always alias/aws/sqs
, the alias of a\n custom CMK can, for example, be alias/MyAlias\n
.\n For more examples, see KeyId in the Key Management Service API\n Reference. KmsDataKeyReusePeriodSeconds
– The length of time, in seconds, for\n which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer representing\n seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default:\n 300 (5 minutes). A shorter time period provides better security but results in\n more calls to KMS which might incur charges after Free Tier. For more\n information, see How Does the Data Key Reuse Period Work?\n SqsManagedSseEnabled
– Enables server-side queue encryption using\n SQS owned encryption keys. Only one server-side encryption option is supported\n per queue (for example, SSE-KMS or SSE-SQS).\n
\n FifoQueue
– Designates a queue as FIFO. Valid values are\n true
and false
. If you don't specify the\n FifoQueue
attribute, Amazon SQS creates a standard queue. You\n can provide this attribute only during queue creation. You can't change it for\n an existing queue. When you set this attribute, you must also provide the\n MessageGroupId
for your messages explicitly.ContentBasedDeduplication
– Enables content-based deduplication.\n Valid values are true
and false
. For more information,\n see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following: \n
\n MessageDeduplicationId
.\n
\n MessageDeduplicationId
\n explicitly.MessageDeduplicationId
and you enable\n ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the\n message (but not the attributes of the message). MessageDeduplicationId
and\n the queue doesn't have ContentBasedDeduplication
\n set, the action fails with an error.ContentBasedDeduplication
set,\n your MessageDeduplicationId
overrides the generated\n one.ContentBasedDeduplication
is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.ContentBasedDeduplication
\n enabled and then another message with a\n MessageDeduplicationId
that is the same as the one\n generated for the first MessageDeduplicationId
, the two\n messages are treated as duplicates and only one copy of the message is\n delivered. \n
\n DeduplicationScope
– Specifies whether message deduplication\n occurs at the message group or queue level. Valid values are\n messageGroup
and queue
.FifoThroughputLimit
– Specifies whether the FIFO queue throughput\n quota applies to the entire queue or per message group. Valid values are\n perQueue
and perMessageGroupId
. The\n perMessageGroupId
value is allowed only when the value for\n DeduplicationScope
is messageGroup
.\n
\n DeduplicationScope
to messageGroup
.FifoThroughputLimit
to perMessageGroupId
.\n
\n sqs:CreateQueue
and sqs:TagQueue
permissions.RedrivePolicy
queue attribute\n configured with a dead-letter queue.null
if\n there are no additional results to request, or if you did not set\n MaxResults
in the request.QueueUrl
attribute of the created queue.\n
\n ReceiptHandle
of the message (not the\n MessageId
which you receive when you send the message). Amazon SQS can\n delete a message from a queue even if a visibility timeout setting causes the message to\n be locked by another consumer. Amazon SQS automatically deletes messages left in a queue\n longer than the retention period configured for the queue. ReceiptHandle
is associated with a specific\n instance of receiving a message. If you receive a message more than\n once, the ReceiptHandle
is different each time you receive a message.\n When you use the DeleteMessage
action, you must provide the most\n recently received ReceiptHandle
for the message (otherwise, the request\n succeeds, but the message will not be deleted).\n DeleteMessage.
The result of the action on each\n message is reported individually in the response.200
.Id
s of a batch request need to be unique within a request.ListMessageMoveTasks
action, it is only populated for\n tasks that are in RUNNING status.\n DeleteMessageBatchResultEntry\n
items.\n BatchResultErrorEntry\n
items.\n DeleteMessageBatchResultEntry\n
tag if the message is deleted\n or a \n BatchResultErrorEntry\n
tag if the message can't be\n deleted.StartMessageMoveTask
request. If a DestinationArn
has not\n been specified in the StartMessageMoveTask
request, this field value will\n be NULL.Id
of an entry in \n DeleteMessageBatch.
\n StartMessageMoveTask
request. If a\n MaxNumberOfMessagesPerSecond
has not been specified in the\n StartMessageMoveTask
request, this field value will be NULL.QueueUrl
, regardless of the queue's\n contents.DeleteQueue
action: When you delete a queue, any\n messages in the queue are no longer available. \n SendMessage\n
request might succeed, but after 60\n seconds the queue and the message you sent no longer exist.GET
verb.QueueName
ends with the\n .fifo
suffix.AttributeNames
parameter is optional, but if you don't specify values\n for this parameter, the request returns empty results.ApproximateNumberOfMessagesDelayed
,\n ApproximateNumberOfMessagesNotVisible
, and\n ApproximateNumberOfMessages
metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is\n required for the queue metadata to reach eventual consistency. \n
\n All
– Returns all values. ApproximateNumberOfMessages
– Returns the approximate number of\n messages available for retrieval from the queue.ApproximateNumberOfMessagesDelayed
– Returns the approximate\n number of messages in the queue that are delayed and not available for reading\n immediately. This can happen when the queue is configured as a delay queue or\n when a message has been sent with a delay parameter.ApproximateNumberOfMessagesNotVisible
– Returns the approximate\n number of messages that are in flight. Messages are considered to be\n in flight if they have been sent to a client but have\n not yet been deleted or have not yet reached the end of their visibility window.\n CreatedTimestamp
– Returns the time when the queue was created in\n seconds (epoch\n time).DelaySeconds
– Returns the default delay on the queue in\n seconds.LastModifiedTimestamp
– Returns the time when the queue was last\n changed in seconds (epoch\n time).MaximumMessageSize
– Returns the limit of how many bytes a\n message can contain before Amazon SQS rejects it.MessageRetentionPeriod
– Returns the length of time, in seconds,\n for which Amazon SQS retains a message. When you change a queue's attributes,\n the change can take up to 60 seconds for most of the attributes to propagate\n throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.Policy
– Returns the policy of the queue.QueueArn
– Returns the Amazon resource name (ARN) of the\n queue.ReceiveMessageWaitTimeSeconds
– Returns the length of time, in\n seconds, for which the ReceiveMessage
action waits for a message to\n arrive. VisibilityTimeout
– Returns the visibility timeout for the queue.\n For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide. \n
\n RedrivePolicy
– The string that includes the parameters for the\n dead-letter queue functionality of the source queue as a JSON object. The\n parameters are as follows:\n
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of\n the dead-letter queue to which Amazon SQS moves messages after the value\n of maxReceiveCount
is exceeded.maxReceiveCount
– The number of times a message is\n delivered to the source queue before being moved to the dead-letter\n queue. Default: 10. When the ReceiveCount
for a message\n exceeds the maxReceiveCount
for a queue, Amazon SQS moves\n the message to the dead-letter-queue.RedriveAllowPolicy
– The string that includes the parameters for\n the permissions for the dead-letter queue redrive permission and which source\n queues can specify dead-letter queues as a JSON object. The parameters are as\n follows:\n
\n redrivePermission
– The permission type that defines\n which source queues can specify the current queue as the dead-letter\n queue. Valid values are:\n
\n allowAll
– (Default) Any source queues in this\n Amazon Web Services account in the same\n Region can specify this queue as the dead-letter queue.denyAll
– No source queues can specify this queue\n as the dead-letter queue.byQueue
– Only queues specified by the\n sourceQueueArns
parameter can specify this\n queue as the dead-letter queue.sourceQueueArns
– The Amazon Resource Names (ARN)s of the\n source queues that can specify this queue as the dead-letter queue and\n redrive messages. You can specify this parameter only when the\n redrivePermission
parameter is set to\n byQueue
. You can specify up to 10 source queue ARNs. To\n allow more than 10 source queues to specify dead-letter queues, set the\n redrivePermission
parameter to\n allowAll
.\n
\n KmsMasterKeyId
– Returns the ID of an Amazon Web Services\n managed customer master key (CMK) for Amazon SQS or a custom CMK. For more\n information, see Key Terms. KmsDataKeyReusePeriodSeconds
– Returns the length of time, in\n seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt\n messages before calling KMS again. For more information, see How Does the Data Key Reuse Period Work?. SqsManagedSseEnabled
– Returns information about whether the queue\n is using SSE-SQS encryption using SQS owned encryption keys. Only one\n server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).\n
\n FifoQueue
– Returns information about whether the queue is FIFO.\n For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.QueueName
ends with\n the .fifo
suffix.ContentBasedDeduplication
– Returns whether content-based\n deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. \n
\n DeduplicationScope
– Specifies whether message deduplication\n occurs at the message group or queue level. Valid values are\n messageGroup
and queue
.FifoThroughputLimit
– Specifies whether the FIFO queue throughput\n quota applies to the entire queue or per message group. Valid values are\n perQueue
and perMessageGroupId
. The\n perMessageGroupId
value is allowed only when the value for\n DeduplicationScope
is messageGroup
.\n
\n DeduplicationScope
to messageGroup
.FifoThroughputLimit
to perMessageGroupId
.QueueNamePrefix
\n parameter, only queues with a name that begins with the specified value are\n returned.listQueues
methods supports pagination. Set parameter\n MaxResults
in the request to specify the maximum number of results to\n be returned in the response. If you do not set MaxResults
, the response\n includes a maximum of 1,000 results. If you set MaxResults
and there are\n additional results to display, the response includes a value for NextToken
.\n Use NextToken
as a parameter in your next request to\n listQueues
to receive the next page of results. MaxResults
to receive a value for NextToken
in the\n response.null
if\n there are no additional results to request, or if you did not set\n MaxResults
in the request.MaxResults
\n that you sent in the request.QueueOwnerAWSAccountId
parameter to specify the account ID of the\n queue's owner. The queue's owner must grant you permission to access the queue. For more\n information about shared queue access, see \n AddPermission\n
\n or see Allow Developers to Write Messages to a Shared Queue in the\n Amazon SQS Developer Guide. MessageId
is considered unique\n across all Amazon Web Services accounts for an extended period of time.\n ReceiveMessage\n
to\n their respective values. Supported attributes:\n
\n ApproximateReceiveCount
\n ApproximateFirstReceiveTimestamp
\n MessageDeduplicationId
\n MessageGroupId
\n SenderId
\n SentTimestamp
\n SequenceNumber
\n ApproximateFirstReceiveTimestamp
and SentTimestamp
are each\n returned as an integer representing the epoch time in\n milliseconds.-
), and underscores\n (_
).Name
, Type
, \nand Value
. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.String
,\n Number
, and Binary
. For the Number
data type,\n you must use StringValue
.Value
attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.
\n Name
, type
, value
and the message body must not\n be empty or null. All parts of the message attribute, including Name
,\n Type
, and Value
, are part of the message size restriction\n (256 KiB or 262,144 bytes).accountId
is invalid.Id
of a batch entry in a batch request doesn't abide by the\n specification.\n
",
+ "smithy.api#error": "client",
+ "smithy.api#httpError": 400
}
- },
- "BinaryValue": {
- "target": "com.amazonaws.sqs#Binary",
+ },
+ "com.amazonaws.sqs#KmsInvalidState": {
+ "type": "structure",
+ "members": {
+ "message": {
+ "target": "com.amazonaws.sqs#ExceptionMessage"
+ }
+ },
"traits": {
- "smithy.api#documentation": "String
,\n Number
, and Binary
. For the Number
data type,\n you must use StringValue
.Value
attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.
\n Name
, type
, value
and the message body must not\n be empty or null.ReceiveMessage
\n returns this error if the maximum number of in flight messages is reached and\n AddPermission
returns this error if the maximum number of permissions\n for the queue is reached.QueueURL
parameter.PurgeQueue
action, you can't retrieve any messages\n deleted from a queue.PurgeQueue
might be received but are deleted within the next\n minute.PurgeQueue
\n might be deleted while the queue is being purged.PurgeQueue
\n request within the last 60 seconds (the time it can take to delete the messages in the\n queue).PurgeQueue
action deletes\n messages.RedrivePolicy
queue attribute\n configured with a dead-letter queue.ListDeadLetterSourceQueues
methods supports pagination. Set\n parameter MaxResults
in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults
, the\n response includes a maximum of 1,000 results. If you set MaxResults
and\n there are additional results to display, the response includes a value for\n NextToken
. Use NextToken
as a parameter in your next\n request to ListDeadLetterSourceQueues
to receive the next page of results. MaxResults
to receive a value for NextToken
in the\n response.RedrivePolicy
queue attribute\n configured with a dead-letter queue.null
if\n there are no additional results to request, or if you did not set\n MaxResults
in the request.\n
\n ListMessageMoveTasks
action, it is only populated for\n tasks that are in RUNNING status.StartMessageMoveTask
request. If a DestinationArn
has not\n been specified in the StartMessageMoveTask
request, this field value will\n be NULL.StartMessageMoveTask
request. If a\n MaxNumberOfMessagesPerSecond
has not been specified in the\n StartMessageMoveTask
request, this field value will be NULL.QueueNamePrefix
\n parameter, only queues with a name that begins with the specified value are\n returned.listQueues
methods supports pagination. Set parameter\n MaxResults
in the request to specify the maximum number of results to\n be returned in the response. If you do not set MaxResults
, the response\n includes a maximum of 1,000 results. If you set MaxResults
and there are\n additional results to display, the response includes a value for NextToken
.\n Use NextToken
as a parameter in your next request to\n listQueues
to receive the next page of results. MaxResults
to receive a value for NextToken
in the\n response.MaxResults
\n that you sent in the request.null
if\n there are no additional results to request, or if you did not set\n MaxResults
in the request.MessageId
is considered unique\n across all Amazon Web Services accounts for an extended period of time.\n ReceiveMessage\n
to\n their respective values. Supported attributes:\n
\n ApproximateReceiveCount
\n ApproximateFirstReceiveTimestamp
\n MessageDeduplicationId
\n MessageGroupId
\n SenderId
\n SentTimestamp
\n SequenceNumber
\n ApproximateFirstReceiveTimestamp
and SentTimestamp
are each\n returned as an integer representing the epoch time in\n milliseconds.Name
, Type
, and\n Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer\n Guide.String
,\n Number
, and Binary
. For the Number
data type,\n you must use StringValue
.Value
attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.
\n Name
, type
, value
and the message body must not\n be empty or null. All parts of the message attribute, including Name
,\n Type
, and Value
, are part of the message size restriction\n (256 KiB or 262,144 bytes).WaitTimeSeconds
parameter enables long-poll support. For more\n information, see Amazon SQS\n Long Polling in the Amazon SQS Developer Guide. ReceiveMessage
call. Thus, only the messages on the sampled machines\n are returned. If the number of messages in the queue is small (fewer than 1,000), you\n most likely get fewer messages than you requested per ReceiveMessage
call.\n If the number of messages in the queue is extremely small, you might not receive any\n messages in a particular ReceiveMessage
response. If this happens, repeat\n the request. \n
\n MessageId
you received when you sent the message to the\n queue.VisibilityTimeout
parameter in your request. The\n parameter is applied to the messages that Amazon SQS returns in the response. If you don't\n include the parameter, the overall visibility timeout for the queue is used for the\n returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.\n
",
- "smithy.api#xmlFlattened": {},
- "smithy.api#xmlName": "AttributeName"
+ },
+ "com.amazonaws.sqs#MessageSystemAttributeNameForSends": {
+ "type": "enum",
+ "members": {
+ "AWSTraceHeader": {
+ "target": "smithy.api#Unit",
+ "traits": {
+ "smithy.api#enumValue": "AWSTraceHeader"
+ }
+ }
}
- },
- "MessageAttributeNames": {
- "target": "com.amazonaws.sqs#MessageAttributeNameList",
+ },
+ "com.amazonaws.sqs#MessageSystemAttributeValue": {
+ "type": "structure",
+ "members": {
+ "StringValue": {
+ "target": "com.amazonaws.sqs#String",
+ "traits": {
+ "smithy.api#documentation": "All
– Returns all values.ApproximateFirstReceiveTimestamp
– Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).ApproximateReceiveCount
– Returns the number of times a\n message has been received across all queues but not deleted.AWSTraceHeader
– Returns the X-Ray trace\n header string. SenderId
\n \n
\n ABCDEFGHI1JKLMNOPQ23R
.ABCDE1F2GH3I4JK5LMNOP:i-a123b456
.SentTimestamp
– Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).SqsManagedSseEnabled
– Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).MessageDeduplicationId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
\n action.MessageGroupId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
action.\n Messages with the same MessageGroupId
are returned in\n sequence.SequenceNumber
– Returns the value provided by\n Amazon SQS.String
,\n Number
, and Binary
. For the Number
data type,\n you must use StringValue
.\n
\n _
), hyphen (-
), and period\n (.
).AWS.
\n or Amazon.
(or any casing variants)..
), and it should\n not have periods in succession (..
).ReceiveMessage
, you can send a list of attribute names to\n receive, or you can return all of the attributes by specifying All
or\n .*
in your request. You can also use all message attributes starting\n with a prefix, for example bar.*
.Value
attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.
\n Name
, type
, value
and the message body must not\n be empty or null.ReceiveMessage
\n returns this error if the maximum number of in flight messages is reached and\n AddPermission
returns this error if the maximum number of permissions\n for the queue is reached.ReceiveMessage
request.QueueURL
parameter.PurgeQueue
action, you can't retrieve any messages\n deleted from a queue.PurgeQueue
might be received but are deleted within the next\n minute.PurgeQueue
\n might be deleted while the queue is being purged.WaitTimeSeconds
. If no messages are available and the wait time\n expires, the call returns successfully with an empty list of messages.ReceiveMessage
requests is longer than the\n WaitTimeSeconds
parameter. For example, with the Java SDK, you can\n set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients. PurgeQueue
\n request within the last 60 seconds (the time it can take to delete the messages in the\n queue).PurgeQueue
action deletes\n messages.ReceiveMessage
calls. If a networking\n issue occurs after a ReceiveMessage
action, and instead of a response you\n receive a generic error, it is possible to retry the same action with an identical\n ReceiveRequestAttemptId
to retrieve the same set of messages, even if\n their visibility timeout has not yet expired.\n
\n ReceiveRequestAttemptId
only for 5 minutes after a\n ReceiveMessage
action.FifoQueue
, a caller of the\n ReceiveMessage
action can provide a\n ReceiveRequestAttemptId
explicitly.ReceiveMessage
action doesn't provide a\n ReceiveRequestAttemptId
, Amazon SQS generates a\n ReceiveRequestAttemptId
.ReceiveMessage
action with the same\n ReceiveRequestAttemptId
if none of the messages have been\n modified (deleted or had their visibility changes).ReceiveRequestAttemptId
return the same messages and receipt\n handles. If a retry occurs within the deduplication interval, it resets the\n visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.ReceiveMessage
action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.MessageGroupId
are invisible, no\n more messages belonging to the same MessageGroupId
are returned\n until the visibility timeout expires. You can still receive messages with\n another MessageGroupId
as long as it is also visible.ReceiveMessage
can't track the\n ReceiveRequestAttemptId
, no retries work until the original\n visibility timeout expires. As a result, delays might occur but the messages in\n the queue remain in a strict order.ReceiveRequestAttemptId
is 128 characters.\n ReceiveRequestAttemptId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).ReceiveRequestAttemptId
, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS\n Developer Guide.Label
parameter.\n
\n AddPermission
, RemovePermission
, and SetQueueAttributes
actions in your IAM policy.\n AddPermission\n
action.#x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
\n SendMessageBatch
to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage.
For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.200
.#x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
\n DelaySeconds
parameter for an entry, Amazon SQS uses\n the default value for the queue.\n SendMessageBatchRequestEntry\n
items.Id
s of a batch request need to be unique within a request.DelaySeconds
value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue is applied. FifoQueue
, you can't set DelaySeconds
per message. You can set this parameter only on a queue level.Name
, Type
, \nand Value
. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.WaitTimeSeconds
parameter enables long-poll support. For more\n information, see Amazon\n SQS Long Polling in the Amazon SQS Developer Guide. ReceiveMessage
call. Thus, only the messages on the sampled machines\n are returned. If the number of messages in the queue is small (fewer than 1,000), you\n most likely get fewer messages than you requested per ReceiveMessage
call.\n If the number of messages in the queue is extremely small, you might not receive any\n messages in a particular ReceiveMessage
response. If this happens, repeat\n the request. \n
\n MessageId
you received when you sent the message to the\n queue.VisibilityTimeout
parameter in your request. The\n parameter is applied to the messages that Amazon SQS returns in the response. If you\n don't include the parameter, the overall visibility timeout for the queue is used for\n the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.\n
",
+ "smithy.api#xmlFlattened": {},
+ "smithy.api#xmlName": "AttributeName"
+ }
+ },
+ "MessageAttributeNames": {
+ "target": "com.amazonaws.sqs#MessageAttributeNameList",
+ "traits": {
+ "smithy.api#documentation": "All
– Returns all values.ApproximateFirstReceiveTimestamp
– Returns the time the message was\n first received from the queue (epoch time in\n milliseconds).ApproximateReceiveCount
– Returns the number of times a message has\n been received across all queues but not deleted.AWSTraceHeader
– Returns the X-Ray trace header\n string. SenderId
\n \n
\n ABCDEFGHI1JKLMNOPQ23R
.ABCDE1F2GH3I4JK5LMNOP:i-a123b456
.SentTimestamp
– Returns the time the message was sent to the queue\n (epoch time in\n milliseconds).SqsManagedSseEnabled
– Enables server-side queue encryption using\n SQS owned encryption keys. Only one server-side encryption option is supported\n per queue (for example, SSE-KMS or SSE-SQS).MessageDeduplicationId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
\n action.MessageGroupId
– Returns the value provided by the producer that\n calls the \n SendMessage\n
action. Messages with the\n same MessageGroupId
are returned in sequence.SequenceNumber
– Returns the value provided by Amazon SQS.\n
\n _
), hyphen (-
), and period\n (.
).AWS.
\n or Amazon.
(or any casing variants)..
), and it should\n not have periods in succession (..
).ReceiveMessage
, you can send a list of attribute names to\n receive, or you can return all of the attributes by specifying All
or\n .*
in your request. You can also use all message attributes starting\n with a prefix, for example bar.*
.ReceiveMessage
request.WaitTimeSeconds
. If no messages are available and the wait time\n expires, the call returns successfully with an empty list of messages.ReceiveMessage
requests is longer than the\n WaitTimeSeconds
parameter. For example, with the Java SDK, you can\n set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients. ReceiveMessage
calls. If a networking\n issue occurs after a ReceiveMessage
action, and instead of a response you\n receive a generic error, it is possible to retry the same action with an identical\n ReceiveRequestAttemptId
to retrieve the same set of messages, even if\n their visibility timeout has not yet expired.\n
\n ReceiveRequestAttemptId
only for 5 minutes after a\n ReceiveMessage
action.FifoQueue
, a caller of the\n ReceiveMessage
action can provide a\n ReceiveRequestAttemptId
explicitly.ReceiveMessage
action doesn't provide a\n ReceiveRequestAttemptId
, Amazon SQS generates a\n ReceiveRequestAttemptId
.ReceiveMessage
action with the same\n ReceiveRequestAttemptId
if none of the messages have been\n modified (deleted or had their visibility changes).ReceiveRequestAttemptId
return the same messages and receipt\n handles. If a retry occurs within the deduplication interval, it resets the\n visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.ReceiveMessage
action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.MessageGroupId
are invisible, no\n more messages belonging to the same MessageGroupId
are returned\n until the visibility timeout expires. You can still receive messages with\n another MessageGroupId
as long as it is also visible.ReceiveMessage
can't track the\n ReceiveRequestAttemptId
, no retries work until the original\n visibility timeout expires. As a result, delays might occur but the messages in\n the queue remain in a strict order.ReceiveRequestAttemptId
is 128 characters.\n ReceiveRequestAttemptId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).ReceiveRequestAttemptId
, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon\n SQS Developer Guide.Name
, Type
, and Value
.\n
\n AWSTraceHeader
.\n Its type must be String
and its value must be a correctly formatted\n X-Ray trace header string.MessageDeduplicationId
is sent\n successfully, subsequent messages with the same MessageDeduplicationId
are\n accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.\n
\n MessageDeduplicationId
,\n
\n MessageDeduplicationId
\n explicitly.MessageDeduplicationId
\n and you enable ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message\n (but not the attributes of the message). MessageDeduplicationId
and the\n queue doesn't have ContentBasedDeduplication
set, the\n action fails with an error.ContentBasedDeduplication
set, your\n MessageDeduplicationId
overrides the generated\n one.ContentBasedDeduplication
is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.ContentBasedDeduplication
enabled\n and then another message with a MessageDeduplicationId
that is the\n same as the one generated for the first MessageDeduplicationId
, the\n two messages are treated as duplicates and only one copy of the message is\n delivered. MessageDeduplicationId
is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).MessageDeduplicationId
after the deduplication\n interval, Amazon SQS can't detect duplicate messages.MessageDeduplicationId
is 128 characters.\n MessageDeduplicationId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.MessageGroupId
values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.\n
\n MessageGroupId
with a message. If\n you don't provide a MessageGroupId
, the action fails.ReceiveMessage
might return messages with multiple\n MessageGroupId
values. For each MessageGroupId
,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId
.MessageGroupId
is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.MessageGroupId
is required for FIFO queues. You can't use it for\n Standard queues.Label
parameter.\n
\n AddPermission
, RemovePermission
,\n and SetQueueAttributes
actions in your IAM policy.Id
.\n SendMessageBatchResultEntry\n
items.\n BatchResultErrorEntry\n
items with error\n details about each message that can't be enqueued.\n SendMessageBatchResultEntry\n
tag if the message succeeds or a\n \n BatchResultErrorEntry\n
tag if the message\n fails.\n AddPermission\n
action.\n
",
+ "smithy.api#error": "client",
+ "smithy.api#httpError": 403
}
- },
- "MD5OfMessageBody": {
- "target": "com.amazonaws.sqs#String",
+ },
+ "com.amazonaws.sqs#ResourceNotFoundException": {
+ "type": "structure",
+ "members": {
+ "message": {
+ "target": "com.amazonaws.sqs#ExceptionMessage"
+ }
+ },
"traits": {
- "smithy.api#documentation": "#x9
| #xA
| #xD
| #x20
to\n #xD7FF
| #xE000
to #xFFFD
|\n #x10000
to #x10FFFF
\n SendMessageBatch
to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage.
For a FIFO queue, multiple messages within a single batch are enqueued in\n the order they are sent.200
.#x9
| #xA
| #xD
| #x20
to\n #xD7FF
| #xE000
to #xFFFD
|\n #x10000
to #x10FFFF
\n DelaySeconds
parameter for an entry, Amazon SQS\n uses the default value for the queue.\n SendMessageBatchRequestEntry\n
items.SequenceNumber
is 128 bits. As SequenceNumber
\n continues to increase for a particular MessageGroupId
.MessageId
for a successfully-enqueued message in a \n SendMessageBatch.
\n Id
s of a batch request need to be unique within a request.DelaySeconds
value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue is applied. FifoQueue
, you can't set DelaySeconds
per\n message. You can set this parameter only on a queue level.Name
, Type
, and\n Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer\n Guide.Name
, Type
, and Value
.\n
\n AWSTraceHeader
. Its type must be String
and\n its value must be a correctly formatted X-Ray trace\n header string.MessageDeduplicationId
is sent\n successfully, subsequent messages with the same MessageDeduplicationId
are\n accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.\n
\n MessageDeduplicationId
,\n
\n MessageDeduplicationId
\n explicitly.MessageDeduplicationId
\n and you enable ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message\n (but not the attributes of the message). MessageDeduplicationId
and the\n queue doesn't have ContentBasedDeduplication
set, the\n action fails with an error.ContentBasedDeduplication
set, your\n MessageDeduplicationId
overrides the generated\n one.ContentBasedDeduplication
is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.ContentBasedDeduplication
enabled\n and then another message with a MessageDeduplicationId
that is the\n same as the one generated for the first MessageDeduplicationId
, the\n two messages are treated as duplicates and only one copy of the message is\n delivered. MessageDeduplicationId
is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).MessageDeduplicationId
after the deduplication\n interval, Amazon SQS can't detect duplicate messages.MessageDeduplicationId
is 128 characters.\n MessageDeduplicationId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS\n Developer Guide.MessageGroupId
values (for\n example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.\n
\n MessageGroupId
with a message. If\n you don't provide a MessageGroupId
, the action fails.ReceiveMessage
might return messages with multiple\n MessageGroupId
values. For each MessageGroupId
,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId
.MessageGroupId
is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.MessageGroupId
is required for FIFO queues. You can't use it for\n Standard queues.Id
.#x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
\n \n SendMessageBatchResultEntry\n
items.\n BatchResultErrorEntry\n
items with error\n details about each message that can't be enqueued.DelaySeconds
value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue applies. FifoQueue
, you can't set DelaySeconds
per message. You can set this parameter only on a queue level.\n SendMessageBatchResultEntry\n
tag if the message succeeds or a\n \n BatchResultErrorEntry\n
tag if the message\n fails.SequenceNumber
is 128 bits. As SequenceNumber
\n continues to increase for a particular MessageGroupId
.Name
, Type
, \nand Value
. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.MessageId
for a successfully-enqueued message in a \n SendMessageBatch.
\n Name
, Type
, and Value
.\n
\n AWSTraceHeader
.\n Its type must be String
and its value must be a correctly formatted\n X-Ray trace header string.#x9
| #xA
| #xD
| #x20
to\n #xD7FF
| #xE000
to #xFFFD
|\n #x10000
to #x10FFFF
\n DelaySeconds
value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue applies. FifoQueue
, you can't set DelaySeconds
per\n message. You can set this parameter only on a queue level.Name
, Type
, and\n Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer\n Guide.Name
, Type
, and Value
.\n
\n AWSTraceHeader
. Its type must be String
and\n its value must be a correctly formatted X-Ray trace\n header string.MessageDeduplicationId
is sent successfully, any messages sent with the\n same MessageDeduplicationId
are accepted successfully but aren't delivered\n during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.\n
\n MessageDeduplicationId
,\n
\n MessageDeduplicationId
\n explicitly.MessageDeduplicationId
\n and you enable ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message\n (but not the attributes of the message). MessageDeduplicationId
and the\n queue doesn't have ContentBasedDeduplication
set, the\n action fails with an error.ContentBasedDeduplication
set, your\n MessageDeduplicationId
overrides the generated\n one.ContentBasedDeduplication
is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.ContentBasedDeduplication
enabled\n and then another message with a MessageDeduplicationId
that is the\n same as the one generated for the first MessageDeduplicationId
, the\n two messages are treated as duplicates and only one copy of the message is\n delivered. MessageDeduplicationId
is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).MessageDeduplicationId
after the deduplication\n interval, Amazon SQS can't detect duplicate messages.MessageDeduplicationId
is 128 characters.\n MessageDeduplicationId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS\n Developer Guide.MessageGroupId
values (for\n example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.\n
\n MessageGroupId
with a message. If\n you don't provide a MessageGroupId
, the action fails.ReceiveMessage
might return messages with multiple\n MessageGroupId
values. For each MessageGroupId
,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId
.MessageGroupId
is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.MessageGroupId
is required for FIFO queues. You can't use it for\n Standard queues.MessageDeduplicationId
is sent successfully, any messages sent with the\n same MessageDeduplicationId
are accepted successfully but aren't delivered\n during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.\n
\n MessageDeduplicationId
,\n
\n MessageDeduplicationId
\n explicitly.MessageDeduplicationId
\n and you enable ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message\n (but not the attributes of the message). MessageDeduplicationId
and the\n queue doesn't have ContentBasedDeduplication
set, the\n action fails with an error.ContentBasedDeduplication
set, your\n MessageDeduplicationId
overrides the generated\n one.ContentBasedDeduplication
is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.ContentBasedDeduplication
enabled\n and then another message with a MessageDeduplicationId
that is the\n same as the one generated for the first MessageDeduplicationId
, the\n two messages are treated as duplicates and only one copy of the message is\n delivered. MessageDeduplicationId
is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).MessageDeduplicationId
after the deduplication\n interval, Amazon SQS can't detect duplicate messages.MessageDeduplicationId
is 128 characters.\n MessageDeduplicationId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.MessageId
of the message sent to the queue.\n For more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide. SequenceNumber
is 128 bits. SequenceNumber
\n continues to increase for a particular MessageGroupId
.MessageGroupId
values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.\n
\n MessageGroupId
with a message. If\n you don't provide a MessageGroupId
, the action fails.ReceiveMessage
might return messages with multiple\n MessageGroupId
values. For each MessageGroupId
,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId
.MessageGroupId
is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.MessageGroupId
is required for FIFO queues. You can't use it for\n Standard queues.MD5OfMessageBody
and MessageId
elements.MessageRetentionPeriod
attribute\n can take up to 15 minutes and will impact existing messages in the queue potentially\n causing them to be expired and deleted if the MessageRetentionPeriod
is\n reduced below the age of existing messages.\n
\n AddPermission
, RemovePermission
,\n and SetQueueAttributes
actions in your IAM policy.SetQueueAttributes
action uses:\n
\n DelaySeconds
– The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 (15 minutes). Default: 0. MaximumMessageSize
– The limit of how many bytes a message can\n contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod
– The length of time, in seconds, for which\n Amazon SQS retains a message. Valid values: An integer representing seconds,\n from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to\n the MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.Policy
– The queue's policy. A valid Amazon Web Services\n policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the\n Identity and Access Management User Guide.\n ReceiveMessageWaitTimeSeconds
– The length of time, in seconds, for\n which a \n ReceiveMessage\n
action waits for a message\n to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. VisibilityTimeout
– The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.\n
\n RedrivePolicy
– The string that includes the parameters for the\n dead-letter queue functionality of the source queue as a JSON object. The\n parameters are as follows:\n
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of\n the dead-letter queue to which Amazon SQS moves messages after the value\n of maxReceiveCount
is exceeded.maxReceiveCount
– The number of times a message is\n delivered to the source queue before being moved to the dead-letter\n queue. Default: 10. When the ReceiveCount
for a message\n exceeds the maxReceiveCount
for a queue, Amazon SQS moves\n the message to the dead-letter-queue.RedriveAllowPolicy
– The string that includes the parameters for\n the permissions for the dead-letter queue redrive permission and which source\n queues can specify dead-letter queues as a JSON object. The parameters are as\n follows:\n
\n redrivePermission
– The permission type that defines\n which source queues can specify the current queue as the dead-letter\n queue. Valid values are:\n
\n allowAll
– (Default) Any source queues in this\n Amazon Web Services account in the same\n Region can specify this queue as the dead-letter queue.denyAll
– No source queues can specify this queue\n as the dead-letter queue.byQueue
– Only queues specified by the\n sourceQueueArns
parameter can specify this\n queue as the dead-letter queue.sourceQueueArns
– The Amazon Resource Names (ARN)s of the\n source queues that can specify this queue as the dead-letter queue and\n redrive messages. You can specify this parameter only when the\n redrivePermission
parameter is set to\n byQueue
. You can specify up to 10 source queue ARNs. To\n allow more than 10 source queues to specify dead-letter queues, set the\n redrivePermission
parameter to\n allowAll
.\n
\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer\n master key (CMK) for Amazon SQS or a custom CMK. For more information, see\n Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is\n always alias/aws/sqs
, the alias of a custom CMK can, for example,\n be alias/MyAlias\n
. For more examples, see\n KeyId in the Key Management Service API\n Reference. KmsDataKeyReusePeriodSeconds
– The length of time, in seconds, for\n which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer representing\n seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default:\n 300 (5 minutes). A shorter time period provides better security but results in\n more calls to KMS which might incur charges after Free Tier. For more\n information, see How Does the Data Key Reuse Period Work?. SqsManagedSseEnabled
– Enables server-side queue encryption using\n SQS owned encryption keys. Only one server-side encryption option is supported\n per queue (for example, SSE-KMS or SSE-SQS).\n
\n ContentBasedDeduplication
– Enables content-based deduplication.\n For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following: \n
\n MessageDeduplicationId
.\n
\n MessageDeduplicationId
\n explicitly.MessageDeduplicationId
and you enable\n ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the\n message (but not the attributes of the message). MessageDeduplicationId
and\n the queue doesn't have ContentBasedDeduplication
\n set, the action fails with an error.ContentBasedDeduplication
set,\n your MessageDeduplicationId
overrides the generated\n one.ContentBasedDeduplication
is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.ContentBasedDeduplication
\n enabled and then another message with a\n MessageDeduplicationId
that is the same as the one\n generated for the first MessageDeduplicationId
, the two\n messages are treated as duplicates and only one copy of the message is\n delivered. \n
\n DeduplicationScope
– Specifies whether message deduplication\n occurs at the message group or queue level. Valid values are\n messageGroup
and queue
.FifoThroughputLimit
– Specifies whether the FIFO queue throughput\n quota applies to the entire queue or per message group. Valid values are\n perQueue
and perMessageGroupId
. The\n perMessageGroupId
value is allowed only when the value for\n DeduplicationScope
is messageGroup
.\n
\n DeduplicationScope
to messageGroup
.FifoThroughputLimit
to perMessageGroupId
.\n
\n StartMessageMoveTask
the source queue is the DLQ, while the\n destination queue can be the original source queue (from which the messages\n were driven to the dead-letter-queue), or a custom destination queue.MessageId
of the message sent to the queue.\n For more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide. CancelMessageMoveTask
\n action.SequenceNumber
is 128 bits. SequenceNumber
\n continues to increase for a particular MessageGroupId
.MD5OfMessageBody
and MessageId
elements.MessageRetentionPeriod
attribute can\n take up to 15 minutes and will impact existing messages in the queue potentially causing\n them to be expired and deleted if the MessageRetentionPeriod
is reduced\n below the age of existing messages.\n
\n AddPermission
, RemovePermission
, and SetQueueAttributes
actions in your IAM policy.SetQueueAttributes
action uses:\n
\n DelaySeconds
– The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 (15 minutes). Default: 0. MaximumMessageSize
– The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB). MessageRetentionPeriod
– The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer representing seconds,\n from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.Policy
– The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the Identity and Access Management User\n Guide. ReceiveMessageWaitTimeSeconds
– The length of time, in\n seconds, for which a \n ReceiveMessage\n
action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0. VisibilityTimeout
– The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.\n
\n RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:\n
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount
is exceeded.maxReceiveCount
– The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
\n for a queue, Amazon SQS moves the message to the dead-letter-queue.RedriveAllowPolicy
– The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:\n
\n redrivePermission
– The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:\n
\n allowAll
– (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.denyAll
– No source queues can specify this queue as the dead-letter\n queue.byQueue
– Only queues specified by the sourceQueueArns
parameter can specify \n this queue as the dead-letter queue.sourceQueueArns
– The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission
parameter is set to byQueue
. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission
parameter\n to allowAll
.\n
\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is\n always alias/aws/sqs
, the alias of a custom CMK can, for example,\n be alias/MyAlias\n
. For more examples, see\n KeyId in the Key Management Service API\n Reference. KmsDataKeyReusePeriodSeconds
– The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?. SqsManagedSseEnabled
– Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).\n
\n ContentBasedDeduplication
– Enables content-based\n deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following: \n
\n MessageDeduplicationId
.\n
\n MessageDeduplicationId
\n explicitly.MessageDeduplicationId
and you enable\n ContentBasedDeduplication
for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the\n message (but not the attributes of the message). MessageDeduplicationId
and\n the queue doesn't have ContentBasedDeduplication
\n set, the action fails with an error.ContentBasedDeduplication
set,\n your MessageDeduplicationId
overrides the generated\n one.ContentBasedDeduplication
is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.ContentBasedDeduplication
\n enabled and then another message with a\n MessageDeduplicationId
that is the same as the one\n generated for the first MessageDeduplicationId
, the two\n messages are treated as duplicates and only one copy of the message is\n delivered. \n
\n DeduplicationScope
– Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup
and queue
.FifoThroughputLimit
– Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue
and perMessageGroupId
. \n The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.\n
\n DeduplicationScope
to messageGroup
.FifoThroughputLimit
to perMessageGroupId
.\n
\n StartMessageMoveTask
the source queue is the DLQ, while the\n destination queue can be the original source queue (from which the messages\n were driven to the dead-letter-queue), or a custom destination queue.\n
\n CancelMessageMoveTask
\n action.\n
\n
-Amazon SQS in the Command Line Interface +Amazon SQS in the Command Line +Interface
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.
+ *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
@@ -493,7 +493,8 @@ export interface SQS { *- * Amazon SQS in the Command Line Interface + * Amazon SQS in the Command Line + * Interface * *
*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.
+ *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
@@ -391,7 +391,8 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {} *- * Amazon SQS in the Command Line Interface + * Amazon SQS in the Command Line + * Interface * *
*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.
+ * about these permissions, see Allow Developers to Write Messages to a Shared Queue in the + * Amazon SQS Developer Guide. *
* 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.
+ * policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy
+ * Language in the Amazon SQS Developer
+ * Guide.
* An Amazon SQS policy can have a maximum of seven actions per statement.
+ *An Amazon SQS policy can have a maximum of 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.
Amazon SQS AddPermission
does not support adding a
+ * non-account principal.
Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, see + * Grant cross-account permissions to a role and a username in the + * Amazon SQS Developer Guide.
*The accountId
is invalid.
When the request to a queue is not HTTPS and SigV4.
+ * * @throws {@link 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 Amazon Web Services 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/CancelMessageMoveTaskCommand.ts b/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts index f54d1420e169b..60bcb167db684 100644 --- a/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts +++ b/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { CancelMessageMoveTaskRequest, CancelMessageMoveTaskResult } from "../models/models_0"; -import { de_CancelMessageMoveTaskCommand, se_CancelMessageMoveTaskCommand } from "../protocols/Aws_query"; +import { de_CancelMessageMoveTaskCommand, se_CancelMessageMoveTaskCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -81,6 +81,31 @@ export interface CancelMessageMoveTaskCommandOutput extends CancelMessageMoveTas * @see {@link CancelMessageMoveTaskCommandOutput} 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 RequestThrottled} (client fault) + *The request was denied due to request throttling.
+ *The rate of requests per second exceeds the Amazon Web Services 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.
+ *One or more specified resources don't exist.
* diff --git a/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts b/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts index 554412f981518..80692a3bf288d 100644 --- a/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts +++ b/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts @@ -15,7 +15,10 @@ import { } from "@smithy/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"; /** @@ -48,7 +51,9 @@ export interface ChangeMessageVisibilityBatchCommandOutput * requests with each *ChangeMessageVisibilityBatch
action.
* Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200
.
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 batch request doesn't contain any entries.
* + * @throws {@link InvalidAddress} (client fault) + *The accountId
is invalid.
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 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 Amazon Web Services 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 be14f0c923564..6b5387bc4e4b6 100644 --- a/clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts +++ b/clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/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"; /** @@ -60,14 +60,23 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer { *Deleted from the queue.
* * - *A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. - * A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages.
- *Limits that apply to in flight messages are unrelated to the unlimited number of stored messages.
- *For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue).
- * If you reach this limit, Amazon SQS returns the OverLimit
error message.
- * To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.
- * To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
+ *A message is considered to be stored after it is sent to a queue + * by a producer, but not yet received from the queue by a consumer (that is, between + * states 1 and 2). There is no limit to the number of stored messages. A message is + * considered to be in flight after it is received from a queue by a + * consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is + * a limit to the number of in flight messages.
+ *Limits that apply to in flight messages are unrelated to the + * unlimited number of stored messages.
+ *For most standard queues (depending on queue traffic and message backlog), there can
+ * be a maximum of approximately 120,000 in flight messages (received from a queue by a
+ * consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS
+ * returns the OverLimit
error message. To avoid reaching the limit, you
+ * should delete messages from the queue after they're processed. You can also increase the
+ * number of queues you use to process your messages. To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a + * queue by a consumer, but not yet deleted from the queue). If you reach this limit, + * Amazon SQS returns no error messages.
*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
@@ -102,12 +111,43 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
* @see {@link ChangeMessageVisibilityCommandOutput} 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 MessageNotInflight} (client fault) *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 Amazon Web Services 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 db5b5019a5d66..f5f67442a7205 100644 --- a/clients/client-sqs/src/commands/CreateQueueCommand.ts +++ b/clients/client-sqs/src/commands/CreateQueueCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/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"; /** @@ -37,11 +37,12 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB /** * @public - *Creates a new standard or FIFO queue. You can pass one or more attributes in - * the request. Keep the following in mind:
+ *Creates a new standard or FIFO queue. You can pass one or more attributes in 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 @@ -85,9 +86,9 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB *
Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, see + * Grant cross-account permissions to a role and a username in the + * Amazon SQS Developer Guide.
*The accountId
is invalid.
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.
* * @throws {@link QueueNameExists} (client fault) - *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.
+ *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 Amazon Web Services 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 d8b5168f4ea77..7ab2e70faf2f6 100644 --- a/clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts +++ b/clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/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"; /** @@ -42,7 +42,9 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul * 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
.
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 batch request doesn't contain any entries.
* + * @throws {@link InvalidAddress} (client fault) + *The accountId
is invalid.
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 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 Amazon Web Services 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 e8e087a8c5c3a..0113931564cd3 100644 --- a/clients/client-sqs/src/commands/DeleteMessageCommand.ts +++ b/clients/client-sqs/src/commands/DeleteMessageCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/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"; /** @@ -50,12 +50,12 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {} * When you use theDeleteMessage
action, you must provide the most
* recently received ReceiptHandle
for the message (otherwise, the request
* 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. - * The copy remains on the server and might be returned to you during a subsequent - * receive request. You should ensure that your application is idempotent, so that - * receiving a message more than once does not cause issues.
+ *For standard queues, it is possible to receive a message even after you delete it. + * This might happen on rare occasions if one of the servers which stores a copy of the + * message is unavailable when you send the request to delete the message. The copy + * remains on the server and might be returned to you during a subsequent receive + * request. You should ensure that your application is idempotent, so that receiving a + * message more than once does not cause issues.
* * @example * Use a bare-bones client and the command you need to make an API call. @@ -79,12 +79,43 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {} * @see {@link DeleteMessageCommandOutput} for command's `response` shape. * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * + * @throws {@link InvalidAddress} (client fault) + *The accountId
is invalid.
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 Amazon Web Services 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 460c893aeeab0..57bcba925930d 100644 --- a/clients/client-sqs/src/commands/DeleteQueueCommand.ts +++ b/clients/client-sqs/src/commands/DeleteQueueCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/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"; /** @@ -52,9 +52,9 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {} *When you delete a queue, you must wait at least 60 seconds before creating a queue * with the same name.
*Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, see + * Grant cross-account permissions to a role and a username in the + * Amazon SQS Developer Guide.
*The delete operation uses the HTTP GET
verb.
The accountId
is invalid.
When the request to a queue is not HTTPS and SigV4.
+ * + * @throws {@link QueueDoesNotExist} (client fault) + *The specified queue doesn't exist.
+ * + * @throws {@link RequestThrottled} (client fault) + *The request was denied due to request throttling.
+ *The rate of requests per second exceeds the Amazon Web Services 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 cfc898af3634d..bd4a671697d57 100644 --- a/clients/client-sqs/src/commands/GetQueueAttributesCommand.ts +++ b/clients/client-sqs/src/commands/GetQueueAttributesCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/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"; /** @@ -39,7 +39,8 @@ export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResul * @public *Gets attributes for the specified queue.
*To determine whether a queue is FIFO, you can check whether QueueName
ends with the .fifo
suffix.
To determine whether a queue is FIFO, you can check whether QueueName
ends with the
+ * .fifo
suffix.
The accountId
is invalid.
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 Amazon Web Services 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 923cbac1c8de5..d52faa4771256 100644 --- a/clients/client-sqs/src/commands/GetQueueUrlCommand.ts +++ b/clients/client-sqs/src/commands/GetQueueUrlCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/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"; /** @@ -44,8 +44,8 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB * information about shared queue access, see
* AddPermission
*
- * or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS
- * Developer Guide.
+ * or see Allow Developers to Write Messages to a Shared Queue in the
+ * Amazon SQS Developer Guide.
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
@@ -70,9 +70,37 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB
* @see {@link GetQueueUrlCommandOutput} 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 Amazon Web Services 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 5921dab2e0a47..9af021df909ee 100644 --- a/clients/client-sqs/src/commands/ListDeadLetterSourceQueuesCommand.ts +++ b/clients/client-sqs/src/commands/ListDeadLetterSourceQueuesCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/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"; /** @@ -76,9 +76,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 Amazon Web Services 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/ListMessageMoveTasksCommand.ts b/clients/client-sqs/src/commands/ListMessageMoveTasksCommand.ts index 5bdbf1cc4d553..b480ead1d2de7 100644 --- a/clients/client-sqs/src/commands/ListMessageMoveTasksCommand.ts +++ b/clients/client-sqs/src/commands/ListMessageMoveTasksCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { ListMessageMoveTasksRequest, ListMessageMoveTasksResult } from "../models/models_0"; -import { de_ListMessageMoveTasksCommand, se_ListMessageMoveTasksCommand } from "../protocols/Aws_query"; +import { de_ListMessageMoveTasksCommand, se_ListMessageMoveTasksCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -72,7 +72,7 @@ export interface ListMessageMoveTasksCommandOutput extends ListMessageMoveTasksR * // Results: [ // ListMessageMoveTasksResultEntryList * // { // ListMessageMoveTasksResultEntry * // TaskHandle: "STRING_VALUE", - * // Status: "STRING_VALUE", + * // Status: "RUNNING" || "FAILED" || "CANCELLING" || "CANCELLED" || "COMPLETED", * // SourceArn: "STRING_VALUE", * // DestinationArn: "STRING_VALUE", * // MaxNumberOfMessagesPerSecond: Number("int"), @@ -92,6 +92,31 @@ export interface ListMessageMoveTasksCommandOutput extends ListMessageMoveTasksR * @see {@link ListMessageMoveTasksCommandOutput} 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 RequestThrottled} (client fault) + *The request was denied due to request throttling.
+ *The rate of requests per second exceeds the Amazon Web Services 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.
+ *One or more specified resources don't exist.
* diff --git a/clients/client-sqs/src/commands/ListQueueTagsCommand.ts b/clients/client-sqs/src/commands/ListQueueTagsCommand.ts index 771f6757bc2bb..442df30953c6c 100644 --- a/clients/client-sqs/src/commands/ListQueueTagsCommand.ts +++ b/clients/client-sqs/src/commands/ListQueueTagsCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/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"; /** @@ -37,13 +37,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 - * Your Amazon SQS Queues in the Amazon SQS Developer Guide.
+ *List all cost allocation tags added to the specified Amazon SQS queue. For an + * overview, see Tagging + * Your Amazon SQS Queues in the Amazon SQS Developer + * Guide.
*Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, see + * Grant cross-account permissions to a role and a username in the + * Amazon SQS Developer Guide.
*The accountId
is invalid.
When the request to a queue is not HTTPS and SigV4.
+ * + * @throws {@link QueueDoesNotExist} (client fault) + *The specified queue doesn't exist.
+ * + * @throws {@link RequestThrottled} (client fault) + *The request was denied due to request throttling.
+ *The rate of requests per second exceeds the Amazon Web Services 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 c0ce110a55eba..a7bae57c1ffa8 100644 --- a/clients/client-sqs/src/commands/ListQueuesCommand.ts +++ b/clients/client-sqs/src/commands/ListQueuesCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/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"; /** @@ -49,9 +49,9 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea * UseNextToken
as a parameter in your next request to
* listQueues
to receive the next page of results.
* Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, see + * Grant cross-account permissions to a role and a username in the + * Amazon SQS Developer Guide.
*The accountId
is invalid.
When the request to a queue is not HTTPS and SigV4.
+ * + * @throws {@link RequestThrottled} (client fault) + *The request was denied due to request throttling.
+ *The rate of requests per second exceeds the Amazon Web Services 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 a9fba13147c6c..e9a08bd26c19f 100644 --- a/clients/client-sqs/src/commands/PurgeQueueCommand.ts +++ b/clients/client-sqs/src/commands/PurgeQueueCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/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"; /** @@ -71,6 +71,12 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {} * @see {@link PurgeQueueCommandOutput} 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 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
@@ -79,6 +85,28 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {}
* @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 Amazon Web Services 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 46e5a979f50ce..f4281554c95ce 100644 --- a/clients/client-sqs/src/commands/ReceiveMessageCommand.ts +++ b/clients/client-sqs/src/commands/ReceiveMessageCommand.ts @@ -16,7 +16,7 @@ import { } from "@smithy/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"; /** @@ -40,8 +40,8 @@ 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
@@ -75,15 +75,17 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
* 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
+ * 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.
+ *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 accountId
is invalid.
When the request to a queue is not HTTPS and SigV4.
+ * + * @throws {@link KmsAccessDenied} (client fault) + *The caller doesn't have the required KMS access.
+ * + * @throws {@link KmsDisabled} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link KmsInvalidKeyUsage} (client fault) + *The request was rejected for one of the following reasons:
+ *The KeyUsage value of the KMS key is incompatible with the API + * operation.
+ *The encryption algorithm or signing algorithm specified for the operation is + * incompatible with the type of key material in the KMS key (KeySpec).
+ *The request was rejected because the state of the specified resource is not valid for + * this request.
+ * + * @throws {@link KmsNotFound} (client fault) + *The request was rejected because the specified entity or resource could not be found. + *
+ * + * @throws {@link KmsOptInRequired} (client fault) + *The request was rejected because the specified key policy isn't syntactically or + * semantically correct.
+ * + * @throws {@link KmsThrottled} (client fault) + *Amazon Web Services KMS throttles requests for the following conditions.
+ * * @throws {@link OverLimit} (client fault) *The specified action violates a limit. For example, ReceiveMessage
* returns this error if the maximum number of in flight messages is reached and
* 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 Amazon Web Services 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 822ff1e30e777..92a1a9cf8def4 100644 --- a/clients/client-sqs/src/commands/RemovePermissionCommand.ts +++ b/clients/client-sqs/src/commands/RemovePermissionCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/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"; /** @@ -45,12 +45,14 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {} *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 username in the Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more + * information, see Grant cross-account permissions to a role and a username in the + * Amazon SQS Developer Guide.
*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.
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 Amazon Web Services 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 2f9aeb3e5b3e8..e6a6946dd5a03 100644 --- a/clients/client-sqs/src/commands/SendMessageBatchCommand.ts +++ b/clients/client-sqs/src/commands/SendMessageBatchCommand.ts @@ -16,7 +16,7 @@ import { } from "@smithy/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"; /** @@ -41,22 +41,29 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _ *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 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
+ * #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.
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 InvalidAddress} (client fault) + *The accountId
is invalid.
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 Amazon Web Services 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 94401201b7546..0d74fc2256f95 100644 --- a/clients/client-sqs/src/commands/SendMessageCommand.ts +++ b/clients/client-sqs/src/commands/SendMessageCommand.ts @@ -16,7 +16,7 @@ import { } from "@smithy/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"; /** @@ -40,11 +40,16 @@ 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
+ * #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 accountId
is invalid.
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 Amazon Web Services 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 4d30bdc7a1fd6..aed92331e9338 100644 --- a/clients/client-sqs/src/commands/SetQueueAttributesCommand.ts +++ b/clients/client-sqs/src/commands/SetQueueAttributesCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/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"; /** @@ -39,22 +39,26 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {} * @public *Sets the value of one or more queue attributes. When you change a queue's attributes,
* the change can take up to 60 seconds for most of the attributes to propagate throughout
- * the Amazon SQS system. Changes made to the MessageRetentionPeriod
attribute can
- * take up to 15 minutes and will impact existing messages in the queue potentially causing
- * them to be expired and deleted if the MessageRetentionPeriod
is reduced
- * below the age of existing messages.
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.
+ *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 username in the Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more + * information, see Grant cross-account permissions to a role and a username in the + * Amazon SQS Developer Guide.
*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.
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 Amazon Web Services 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/StartMessageMoveTaskCommand.ts b/clients/client-sqs/src/commands/StartMessageMoveTaskCommand.ts index de5d1a8e0582c..e9489607a6cd1 100644 --- a/clients/client-sqs/src/commands/StartMessageMoveTaskCommand.ts +++ b/clients/client-sqs/src/commands/StartMessageMoveTaskCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { StartMessageMoveTaskRequest, StartMessageMoveTaskResult } from "../models/models_0"; -import { de_StartMessageMoveTaskCommand, se_StartMessageMoveTaskCommand } from "../protocols/Aws_query"; +import { de_StartMessageMoveTaskCommand, se_StartMessageMoveTaskCommand } from "../protocols/Aws_json1_0"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -88,6 +88,31 @@ export interface StartMessageMoveTaskCommandOutput extends StartMessageMoveTaskR * @see {@link StartMessageMoveTaskCommandOutput} 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 RequestThrottled} (client fault) + *The request was denied due to request throttling.
+ *The rate of requests per second exceeds the Amazon Web Services 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.
+ *One or more specified resources don't exist.
* diff --git a/clients/client-sqs/src/commands/TagQueueCommand.ts b/clients/client-sqs/src/commands/TagQueueCommand.ts index 505548e8f3746..9785c18f2f29d 100644 --- a/clients/client-sqs/src/commands/TagQueueCommand.ts +++ b/clients/client-sqs/src/commands/TagQueueCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/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"; /** @@ -37,30 +37,33 @@ 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.
+ *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 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.
+ *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.
+ *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 username in the Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, see + * Grant cross-account permissions to a role and a username in the + * Amazon SQS Developer Guide.
*The accountId
is invalid.
When the request to a queue is not HTTPS and SigV4.
+ * + * @throws {@link QueueDoesNotExist} (client fault) + *The specified queue doesn't exist.
+ * + * @throws {@link RequestThrottled} (client fault) + *The request was denied due to request throttling.
+ *The rate of requests per second exceeds the Amazon Web Services 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 93ee98bec1d19..f0113c4971915 100644 --- a/clients/client-sqs/src/commands/UntagQueueCommand.ts +++ b/clients/client-sqs/src/commands/UntagQueueCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/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"; /** @@ -37,12 +37,14 @@ 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.
+ *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 username in the Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, see + * Grant cross-account permissions to a role and a username in the + * Amazon SQS Developer Guide.
*The accountId
is invalid.
When the request to a queue is not HTTPS and SigV4.
+ * + * @throws {@link QueueDoesNotExist} (client fault) + *The specified queue doesn't exist.
+ * + * @throws {@link RequestThrottled} (client fault) + *The request was denied due to request throttling.
+ *The rate of requests per second exceeds the Amazon Web Services 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/index.ts b/clients/client-sqs/src/index.ts index db0ba7542efa5..2569a59d426fc 100644 --- a/clients/client-sqs/src/index.ts +++ b/clients/client-sqs/src/index.ts @@ -2,15 +2,15 @@ /* eslint-disable */ /** *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.
+ *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
@@ -55,7 +55,8 @@ *- * Amazon SQS in the Command Line Interface + * Amazon SQS in the Command Line + * Interface * *
*The Amazon Web Services account numbers of the principals who are to receive - * permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer - * Guide.
+ *The Amazon Web + * Services account numbers of the principals who are to receive + * permission. For information about locating the Amazon Web Services + * account identification, see Your Amazon Web + * Services Identifiers in the Amazon SQS Developer + * Guide.
*/ AWSAccountIds: string[] | undefined; @@ -47,6 +50,46 @@ export interface AddPermissionRequest { Actions: string[] | undefined; } +/** + * @public + *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
@@ -70,6 +113,82 @@ export class OverLimit extends __BaseException {
}
}
+/**
+ * @public
+ *
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 Amazon Web Services 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: __ExceptionOptionTypeError code 400. Unsupported operation.
- */ -export class UnsupportedOperation extends __BaseException { - readonly name: "UnsupportedOperation" = "UnsupportedOperation"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe 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 (_).
+ *This identifier can have up to 80 characters. The following characters are + * accepted: alphanumeric characters, hyphens(-), and underscores (_).
*Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging - * Your Amazon SQS Queues in the Amazon SQS Developer Guide.
- *When you use queue tags, keep the following guidelines in mind:
- *Adding more than 50 tags to a queue isn't recommended.
- *Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
- *Tags are case-sensitive.
- *A new tag with a key identical to that of an existing tag overwrites the existing tag.
- *For a full list of tag restrictions, see - * Quotas related to queues - * in the Amazon SQS Developer Guide.
- *To be able to tag a queue on creation, you must have the
- * sqs:CreateQueue
and sqs:TagQueue
permissions.
Cross-account permissions don't apply to this action. For more information, - * see Grant - * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
- *A map of attributes with their corresponding values.
@@ -511,36 +579,35 @@ export interface CreateQueueRequest { * *
- * MaximumMessageSize
– The limit of how many bytes a message
- * can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
+ * 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
+ * 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
+ * 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 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.
@@ -555,102 +622,115 @@ export interface CreateQueueRequest { *
- * RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality
- * of the source queue as a JSON object. The parameters are as follows:
RedrivePolicy
– The string that includes the parameters for the
+ * dead-letter queue functionality of the source queue as a JSON object. The
+ * parameters are as follows:
*
- * deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to
- * which Amazon SQS moves messages after the value of maxReceiveCount
is exceeded.
deadLetterTargetArn
– The Amazon Resource Name (ARN) of
+ * the dead-letter queue to which Amazon SQS moves messages after the value
+ * of maxReceiveCount
is exceeded.
*
- * maxReceiveCount
– The number of times a message is delivered to the source queue before being
- * moved to the dead-letter queue. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
- * for a queue, Amazon SQS moves the message to the dead-letter-queue.
maxReceiveCount
– The number of times a message is
+ * delivered to the source queue before being moved to the dead-letter
+ * queue. Default: 10. When the ReceiveCount
for a message
+ * exceeds the maxReceiveCount
for a queue, Amazon SQS moves
+ * the message to the dead-letter-queue.
*
- * RedriveAllowPolicy
– The string that includes the parameters for the permissions for the dead-letter
- * queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
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:
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.
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.
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.
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
.
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 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
+ * KmsMasterKeyId
– The ID of an Amazon Web Services managed customer
+ * master key (CMK) for Amazon SQS or a custom CMK. For more information, see
+ * Key Terms. While the alias of the Amazon Web Services
+ * managed CMK for Amazon SQS is always alias/aws/sqs
, the alias of a
+ * custom CMK can, for example, be alias/MyAlias
+ *
.
+ * For more examples, see KeyId in the Key Management Service API
* Reference.
- * KmsDataKeyReusePeriodSeconds
– The length of time, in
- * seconds, for which Amazon SQS can reuse a data key to
- * encrypt or decrypt messages before calling KMS again. An integer
- * representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
- * hours). Default: 300 (5 minutes). A shorter time period provides better security
- * but results in more calls to KMS which might incur charges after Free Tier. For
- * more information, see How Does the Data Key Reuse Period Work?
+ * KmsDataKeyReusePeriodSeconds
– The length of time, in seconds, for
+ * which Amazon SQS can reuse a data key to
+ * encrypt or decrypt messages before calling KMS again. An integer representing
+ * seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default:
+ * 300 (5 minutes). A shorter time period provides better security but results in
+ * more calls to KMS which might incur charges after Free Tier. For more
+ * information, see How Does the Data Key Reuse Period Work?
*
- * SqsManagedSseEnabled
– Enables server-side queue encryption
- * using SQS owned encryption keys. Only one server-side encryption option is
- * supported per queue (for example, SSE-KMS or SSE-SQS).
SqsManagedSseEnabled
– Enables server-side queue encryption using
+ * SQS owned encryption keys. Only one server-side encryption option is supported
+ * per queue (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
+ * 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.
- * ContentBasedDeduplication
– Enables content-based
- * deduplication. Valid values are true
and false
. For
- * more information, see Exactly-once processing in the Amazon SQS Developer
+ * 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:
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
+ * 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).
The following attributes apply only to - * high throughput - * for FIFO queues:
+ *The following attributes apply only to high + * throughput for FIFO queues:
*
- * DeduplicationScope
– Specifies whether message deduplication occurs at the
- * message group or queue level. Valid values are messageGroup
and queue
.
DeduplicationScope
– Specifies whether message deduplication
+ * occurs at the message group or queue level. Valid values are
+ * messageGroup
and queue
.
*
* FifoThroughputLimit
– Specifies whether the FIFO queue throughput
- * quota applies to the entire queue or per message group. Valid values are perQueue
and perMessageGroupId
.
- * The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.
perQueue
and perMessageGroupId
. The
+ * perMessageGroupId
value is allowed only when the value for
+ * DeduplicationScope
is messageGroup
.
* To enable high throughput for FIFO queues, do the following:
@@ -735,12 +817,47 @@ export interface CreateQueueRequest { *If you set these attributes to anything other than the values shown for enabling high - * throughput, normal throughput is in effect and deduplication occurs as specified.
- *For information on throughput quotas, - * see Quotas related to messages - * in the Amazon SQS Developer Guide.
+ * throughput, normal throughput is in effect and deduplication occurs as specified. + *For information on throughput quotas, see Quotas + * related to messages in the Amazon SQS Developer + * Guide.
*/ Attributes?: PartialAdd 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 @@ -778,8 +935,8 @@ export class QueueDeletedRecently extends __BaseException { /** * @public - *
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.
+ *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.
*/ export class QueueNameExists extends __BaseException { readonly name: "QueueNameExists" = "QueueNameExists"; @@ -818,6 +975,8 @@ export interface DeleteMessageRequest { /** * @public + * @deprecated + * *The specified receipt handle isn't valid for the current version.
*/ export class InvalidIdFormat extends __BaseException { @@ -847,7 +1006,8 @@ export interface DeleteMessageBatchRequestEntry { * 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 (_).
+ *This identifier can have up to 80 characters. The following characters are + * accepted: alphanumeric characters, hyphens(-), and underscores (_).
*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.
+ *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:
*
- * 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).
* @@ -999,8 +1161,9 @@ 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).
* @@ -1009,10 +1172,10 @@ export interface GetQueueAttributesRequest { *
- * 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
– 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
@@ -1029,14 +1192,14 @@ 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
+ * VisibilityTimeout
– Returns the visibility timeout for the queue.
+ * For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer
* Guide.
- * RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality
- * of the source queue as a JSON object. The parameters are as follows:
RedrivePolicy
– The string that includes the parameters for the
+ * dead-letter queue functionality of the source queue as a JSON object. The
+ * parameters are as follows:
*
- * deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to
- * which Amazon SQS moves messages after the value of maxReceiveCount
is exceeded.
deadLetterTargetArn
– The Amazon Resource Name (ARN) of
+ * the dead-letter queue to which Amazon SQS moves messages after the value
+ * of maxReceiveCount
is exceeded.
*
- * maxReceiveCount
– The number of times a message is delivered to the source queue before being
- * moved to the dead-letter queue. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
- * for a queue, Amazon SQS moves the message to the dead-letter-queue.
maxReceiveCount
– The number of times a message is
+ * delivered to the source queue before being moved to the dead-letter
+ * queue. Default: 10. When the ReceiveCount
for a message
+ * exceeds the maxReceiveCount
for a queue, Amazon SQS moves
+ * the message to the dead-letter-queue.
*
- * RedriveAllowPolicy
– The string that includes the parameters for the permissions for the dead-letter
- * queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
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:
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.
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.
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.
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
.
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 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
+ * 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
+ * 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.
To determine whether a queue is FIFO, you can check whether QueueName
ends with
+ * the .fifo
suffix.
The following attributes apply only to - * high throughput - * for FIFO queues:
+ *The following attributes apply only to high + * throughput for FIFO queues:
*
- * DeduplicationScope
– Specifies whether message deduplication occurs at the
- * message group or queue level. Valid values are messageGroup
and queue
.
DeduplicationScope
– Specifies whether message deduplication
+ * occurs at the message group or queue level. Valid values are
+ * messageGroup
and queue
.
*
* FifoThroughputLimit
– Specifies whether the FIFO queue throughput
- * quota applies to the entire queue or per message group. Valid values are perQueue
and perMessageGroupId
.
- * The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.
perQueue
and perMessageGroupId
. The
+ * perMessageGroupId
value is allowed only when the value for
+ * DeduplicationScope
is messageGroup
.
* To enable high throughput for FIFO queues, do the following:
@@ -1170,10 +1347,10 @@ export interface GetQueueAttributesRequest { * * *If you set these attributes to anything other than the values shown for enabling high - * throughput, normal throughput is in effect and deduplication occurs as specified.
- *For information on throughput quotas, - * see Quotas related to messages - * in the Amazon SQS Developer Guide.
+ * throughput, normal throughput is in effect and deduplication occurs as specified. + *For information on throughput quotas, see Quotas + * related to messages in the Amazon SQS Developer + * Guide.
*/ AttributeNames?: QueueAttributeName[]; } @@ -1190,26 +1367,6 @@ export interface GetQueueAttributesResult { Attributes?: PartialThe specified attribute doesn't exist.
- */ -export class InvalidAttributeName extends __BaseException { - readonly name: "InvalidAttributeName" = "InvalidAttributeName"; - readonly $fault: "client" = "client"; - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe Amazon Web Services account ID of the account that created the queue.
+ *The Amazon Web + * Services account ID of the account that created the queue.
*/ QueueOwnerAWSAccountId?: string; } @@ -1234,7 +1392,7 @@ export interface GetQueueUrlRequest { /** * @public *For more information, see Interpreting Responses in the Amazon SQS Developer - * Guide.
+ * Guide. */ export interface GetQueueUrlResult { /** @@ -1244,26 +1402,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: __ExceptionOptionTypeContains the details of a message movement task.
@@ -1348,7 +1503,7 @@ export interface ListMessageMoveTasksResultEntry { *The status of the message movement task. Possible values are: RUNNING, COMPLETED, * CANCELLING, CANCELLED, and FAILED.
*/ - Status?: string; + Status?: TaskStatus; /** * @public @@ -1446,18 +1601,18 @@ export interface ListQueuesRequest { export interface ListQueuesResult { /** * @public - *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.
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.
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: __ExceptionOptionType
- * ApproximateFirstReceiveTimestamp
– Returns the time the
- * message was first received from the queue (epoch time in
+ * 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.
* @@ -1572,15 +1880,15 @@ export interface ReceiveMessageRequest { *
- * SentTimestamp
– Returns the time the message was sent to the
- * queue (epoch time in
+ * SentTimestamp
– Returns the time the message was sent to the queue
+ * (epoch time in
* milliseconds).
- * SqsManagedSseEnabled
– Enables server-side queue encryption
- * using SQS owned encryption keys. Only one server-side encryption option is
- * supported per queue (for example, SSE-KMS or SSE-SQS).
SqsManagedSseEnabled
– Enables server-side queue encryption using
+ * SQS owned encryption keys. Only one server-side encryption option is supported
+ * per queue (for example, SSE-KMS or SSE-SQS).
* @@ -1592,17 +1900,15 @@ export interface ReceiveMessageRequest { *
- * MessageGroupId
– Returns the value provided by the
- * producer that calls the
+ *
MessageGroupId
– Returns the value provided by the producer that
+ * calls the
* SendMessage
- *
action.
- * Messages with the same MessageGroupId
are returned in
- * sequence.
MessageGroupId
are returned in sequence.
*
- * SequenceNumber
– Returns the value provided by
- * Amazon SQS.
SequenceNumber
– Returns the value provided by Amazon SQS.
* The 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: + *
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; @@ -1733,8 +2039,8 @@ export interface ReceiveMessageRequest { *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.
For best practices of using ReceiveRequestAttemptId
, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon
+ * SQS Developer Guide.
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.
+ * Guide. */ DataType: string | undefined; } @@ -1895,16 +2201,18 @@ export interface Message { /** * @public - *An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
+ *An MD5 digest of the non-URL-encoded message attribute string. You can use this + * attribute to verify that Amazon SQS received the message correctly. Amazon SQS + * URL-decodes the message before creating the MD5 digest. For information about MD5, see + * RFC1321.
*/ MD5OfMessageAttributes?: string; /** * @public - *Each message attribute consists of a Name
, Type
,
- * and Value
. For more information, see
- * Amazon SQS
- * message attributes in the Amazon SQS Developer Guide.
Each message attribute consists of a Name
, Type
, and
+ * Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer
+ * Guide.
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.
+ * Guide. */ DataType: string | undefined; } @@ -2043,11 +2351,16 @@ export interface SendMessageRequest { *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:
*
- * #x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
+ * #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.
*When you set FifoQueue
, you can't set DelaySeconds
per message. You can set this parameter only on a queue level.
When you set FifoQueue
, you can't set DelaySeconds
per
+ * message. You can set this parameter only on a queue level.
Each message attribute consists of a Name
, Type
,
- * and Value
. For more information, see
- * Amazon SQS
- * message attributes in the Amazon SQS Developer Guide.
Each message attribute consists of a Name
, Type
, and
+ * Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer
+ * Guide.
The message system attribute to send. Each message system attribute consists of a Name
, Type
, and Value
.
The message system attribute to send. Each message system attribute consists of a
+ * Name
, Type
, and Value
.
Currently, the only supported message system attribute is AWSTraceHeader
.
- * Its type must be String
and its value must be a correctly formatted
- * X-Ray trace header string.
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.
+ *The size of a message system attribute doesn't count towards the total + * size of a message.
*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.
+ * Guide.
* Every message must have a unique MessageDeduplicationId
,
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.
+ *Amazon SQS continues to keep track of the message deduplication ID even after the + * message is received and deleted.
* *The maximum 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.
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS
+ * Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
*The tag that specifies that a message belongs to a specific message group. Messages
- * that belong to the same message group are processed in a FIFO manner (however,
- * messages in different message groups might be processed out of order). To interleave
- * multiple ordered streams within a single queue, use MessageGroupId
values
- * (for example, session data for multiple users). In this scenario, multiple consumers can
+ * that belong to the same message group are processed in a FIFO manner (however, messages
+ * in different message groups might be processed out of order). To interleave multiple
+ * ordered streams within a single queue, use MessageGroupId
values (for
+ * example, session data for multiple users). In this scenario, multiple consumers can
* process the queue, but the session data of each user is processed in a FIFO
* fashion.
An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
+ *An MD5 digest of the non-URL-encoded message body string. You can use this attribute + * to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the + * message before creating the MD5 digest. For information about MD5, see RFC1321.
*/ MD5OfMessageBody?: string; /** * @public - *An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
+ *An MD5 digest of the non-URL-encoded message attribute string. You can use this + * attribute to verify that Amazon SQS received the message correctly. Amazon SQS + * URL-decodes the message before creating the MD5 digest. For information about MD5, see + * RFC1321.
*/ MD5OfMessageAttributes?: string; /** * @public *An MD5 digest of the non-URL-encoded message system attribute string. You can use this - * attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.
+ * attribute to verify that Amazon SQS received the message correctly. Amazon SQS + * URL-decodes the message before creating the MD5 digest. */ MD5OfMessageSystemAttributes?: string; @@ -2257,7 +2580,8 @@ export class BatchRequestTooLong extends __BaseException { /** * @public - *Contains the details of a single Amazon SQS message along with an Id
.
Contains the details of a single Amazon SQS message along with an
+ * Id
.
An identifier for a message in this batch 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 (_).
+ *This identifier can have up to 80 characters. The following characters are + * accepted: alphanumeric characters, hyphens(-), and underscores (_).
*When you set FifoQueue
, you can't set DelaySeconds
per message. You can set this parameter only on a queue level.
When you set FifoQueue
, you can't set DelaySeconds
per
+ * message. You can set this parameter only on a queue level.
Each message attribute consists of a Name
, Type
,
- * and Value
. For more information, see
- * Amazon SQS
- * message attributes in the Amazon SQS Developer Guide.
Each message attribute consists of a Name
, Type
, and
+ * Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer
+ * Guide.
The message system attribute to send Each message system attribute consists of a Name
, Type
, and Value
.
The message system attribute to send Each message system attribute consists of a
+ * Name
, Type
, and Value
.
Currently, the only supported message system attribute is AWSTraceHeader
.
- * Its type must be String
and its value must be a correctly formatted
- * X-Ray trace header string.
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.
+ *The size of a message system attribute doesn't count towards the total + * size of a message.
*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.
+ * Guide.
* Every message must have a unique MessageDeduplicationId
,
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.
+ *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.
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS
+ * Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
*The tag that specifies that a message belongs to a specific message group. Messages
- * that belong to the same message group are processed in a FIFO manner (however,
- * messages in different message groups might be processed out of order). To interleave
- * multiple ordered streams within a single queue, use MessageGroupId
values
- * (for example, session data for multiple users). In this scenario, multiple consumers can
+ * that belong to the same message group are processed in a FIFO manner (however, messages
+ * in different message groups might be processed out of order). To interleave multiple
+ * ordered streams within a single queue, use MessageGroupId
values (for
+ * example, session data for multiple users). In this scenario, multiple consumers can
* process the queue, but the session data of each user is processed in a FIFO
* fashion.
An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
+ *An MD5 digest of the non-URL-encoded message body string. You can use this attribute + * to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the + * message before creating the MD5 digest. For information about MD5, see RFC1321.
*/ MD5OfMessageBody: string | undefined; /** * @public - *An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
+ *An MD5 digest of the non-URL-encoded message attribute string. You can use this + * attribute to verify that Amazon SQS received the message correctly. Amazon SQS + * URL-decodes the message before creating the MD5 digest. For information about MD5, see + * RFC1321.
*/ MD5OfMessageAttributes?: string; /** * @public *An MD5 digest of the non-URL-encoded message system attribute string. You can use this - * attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
+ * attribute to verify that Amazon SQS received the message correctly. Amazon SQS + * URL-decodes the message before creating the MD5 digest. For information about MD5, see + * RFC1321. */ MD5OfMessageSystemAttributes?: string; @@ -2541,37 +2877,36 @@ export interface SetQueueAttributesRequest { *
- * MaximumMessageSize
– The limit of how many bytes a message
- * can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
+ * 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,
+ * 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
+ * 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
+ *
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.
@@ -2586,71 +2921,83 @@ export interface SetQueueAttributesRequest { *
- * RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality
- * of the source queue as a JSON object. The parameters are as follows:
RedrivePolicy
– The string that includes the parameters for the
+ * dead-letter queue functionality of the source queue as a JSON object. The
+ * parameters are as follows:
*
- * deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to
- * which Amazon SQS moves messages after the value of maxReceiveCount
is exceeded.
deadLetterTargetArn
– The Amazon Resource Name (ARN) of
+ * the dead-letter queue to which Amazon SQS moves messages after the value
+ * of maxReceiveCount
is exceeded.
*
- * maxReceiveCount
– The number of times a message is delivered to the source queue before being
- * moved to the dead-letter queue. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
- * for a queue, Amazon SQS moves the message to the dead-letter-queue.
maxReceiveCount
– The number of times a message is
+ * delivered to the source queue before being moved to the dead-letter
+ * queue. Default: 10. When the ReceiveCount
for a message
+ * exceeds the maxReceiveCount
for a queue, Amazon SQS moves
+ * the message to the dead-letter-queue.
*
- * RedriveAllowPolicy
– The string that includes the parameters for the permissions for the dead-letter
- * queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
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:
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.
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.
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.
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
.
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 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
+ * 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
@@ -2659,28 +3006,28 @@ export interface SetQueueAttributesRequest {
*
- * KmsDataKeyReusePeriodSeconds
– The length of time, in
- * seconds, for which Amazon SQS can reuse a data key to
- * encrypt or decrypt messages before calling KMS again. An integer
- * representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
- * hours). Default: 300 (5 minutes). A shorter time period provides better security
- * but results in more calls to KMS which might incur charges after Free Tier. For
- * more information, see How Does the Data Key Reuse Period Work?.
KmsDataKeyReusePeriodSeconds
– The length of time, in seconds, for
+ * which Amazon SQS can reuse a data key to
+ * encrypt or decrypt messages before calling KMS again. An integer representing
+ * seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default:
+ * 300 (5 minutes). A shorter time period provides better security but results in
+ * more calls to KMS which might incur charges after Free Tier. For more
+ * information, see How Does the Data Key Reuse Period Work?.
*
- * SqsManagedSseEnabled
– Enables server-side queue encryption
- * using SQS owned encryption keys. Only one server-side encryption option is
- * supported per queue (for example, SSE-KMS or SSE-SQS).
SqsManagedSseEnabled
– Enables server-side queue encryption using
+ * SQS owned encryption keys. Only one server-side encryption option is supported
+ * per queue (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
+ * ContentBasedDeduplication
– Enables content-based deduplication.
+ * For more information, see Exactly-once processing in the Amazon SQS Developer
* Guide. Note the following:
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
+ * 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).
The following attributes apply only to - * high throughput - * for FIFO queues:
+ *The following attributes apply only to high + * throughput for FIFO queues:
*
- * DeduplicationScope
– Specifies whether message deduplication occurs at the
- * message group or queue level. Valid values are messageGroup
and queue
.
DeduplicationScope
– Specifies whether message deduplication
+ * occurs at the message group or queue level. Valid values are
+ * messageGroup
and queue
.
*
* FifoThroughputLimit
– Specifies whether the FIFO queue throughput
- * quota applies to the entire queue or per message group. Valid values are perQueue
and perMessageGroupId
.
- * The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.
perQueue
and perMessageGroupId
. The
+ * perMessageGroupId
value is allowed only when the value for
+ * DeduplicationScope
is messageGroup
.
* To enable high throughput for FIFO queues, do the following:
@@ -2754,10 +3103,10 @@ export interface SetQueueAttributesRequest { *If you set these attributes to anything other than the values shown for enabling high - * throughput, normal throughput is in effect and deduplication occurs as specified.
- *For information on throughput quotas, - * see Quotas related to messages - * in the Amazon SQS Developer Guide.
+ * throughput, normal throughput is in effect and deduplication occurs as specified. + *For information on throughput quotas, see Quotas + * related to messages in the Amazon SQS Developer + * Guide.
*/ Attributes: PartialAdds a permission to a queue for a specific principal. This allows sharing\n access to the queue.
\nWhen you create a queue, you have full control access rights for the queue. Only you,\n the owner of the queue, can grant or deny permissions to the queue. For more information\n about these permissions, see Allow Developers to Write Messages to a Shared Queue in the\n Amazon SQS Developer Guide.
\n\n AddPermission
generates a policy for you. You can use\n \n SetQueueAttributes\n
to upload your\n policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy\n Language in the Amazon SQS Developer\n Guide.
An Amazon SQS policy can have a maximum of seven actions per\n statement.
\nTo remove the ability to change queue permissions, you must deny\n permission to the AddPermission
, RemovePermission
,\n and SetQueueAttributes
actions in your IAM policy.
Amazon SQS AddPermission
does not support adding a\n non-account principal.
Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nThe URL of the Amazon SQS queue to which permissions are added.
\nQueue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "Label": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The unique identification of the permission you're setting (for example,\n AliceSendMessage
). Maximum 80 characters. Allowed characters include\n alphanumeric characters, hyphens (-
), and underscores\n (_
).
The Amazon Web\n Services account numbers of the principals who are to receive\n permission. For information about locating the Amazon Web Services\n account identification, see Your Amazon Web\n Services Identifiers in the Amazon SQS Developer\n Guide.
", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "AWSAccountId" - } - }, - "Actions": { - "target": "com.amazonaws.sqs#ActionNameList", - "traits": { - "smithy.api#documentation": "The action the client wants to allow for the specified principal. Valid values: the\n name of any action or *
.
For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service\n Resource in the Amazon SQS Developer Guide.
\nSpecifying SendMessage
, DeleteMessage
, or\n ChangeMessageVisibility
for ActionName.n
also grants\n permissions for the corresponding batch versions of those actions:\n SendMessageBatch
, DeleteMessageBatch
, and\n ChangeMessageVisibilityBatch
.
Welcome to the Amazon SQS API Reference.
\nAmazon SQS is a reliable, highly-scalable hosted queue for storing messages as they\n travel between applications or microservices. Amazon SQS moves data between distributed\n application components and helps you decouple these components.
\nFor information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer\n Guide.\n
\nYou can use Amazon Web Services\n SDKs to access Amazon SQS using your favorite programming language. The SDKs\n perform tasks such as the following automatically:
\nCryptographically sign your service requests
\nRetry requests
\nHandle error responses
\n\n Additional information\n
\n\n Amazon SQS Developer Guide\n
\n\n Making API Requests\n
\n\n Amazon Web Services General Reference\n
\nAdds a permission to a queue for a specific principal. This allows sharing\n access to the queue.
\nWhen you create a queue, you have full control access rights for the queue. Only you,\n the owner of the queue, can grant or deny permissions to the queue. For more information\n about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS\n Developer Guide.
\n\n AddPermission
generates a policy for you. You can use\n \n SetQueueAttributes\n
to upload your\n policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in\n the Amazon SQS Developer Guide.
An Amazon SQS policy can have a maximum of seven actions per statement.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission
, RemovePermission
, and SetQueueAttributes
actions in your IAM policy.
Amazon SQS AddPermission
does not support adding a non-account\n principal.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nThe URL of the Amazon SQS queue to which permissions are added.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "Label": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The unique identification of the permission you're setting (for example,\n AliceSendMessage
). Maximum 80 characters. Allowed characters include\n alphanumeric characters, hyphens (-
), and underscores\n (_
).
The Amazon Web Services account numbers of the principals who are to receive\n permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer\n Guide.
", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AWSAccountId" + } + }, + "Actions": { + "target": "com.amazonaws.sqs#ActionNameList", + "traits": { + "smithy.api#documentation": "The action the client wants to allow for the specified principal. Valid values: the\n name of any action or *
.
For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service\n Resource in the Amazon SQS Developer Guide.
\nSpecifying SendMessage
, DeleteMessage
, or\n ChangeMessageVisibility
for ActionName.n
also grants\n permissions for the corresponding batch versions of those actions:\n SendMessageBatch
, DeleteMessageBatch
, and\n ChangeMessageVisibilityBatch
.
Welcome to the Amazon SQS API Reference.
\nAmazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel\n between applications or microservices. Amazon SQS moves data between distributed application\n components and helps you decouple these components.
\nFor information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer\n Guide.\n
\nYou can use Amazon Web Services SDKs to access\n Amazon SQS using your favorite programming language. The SDKs perform tasks such as the\n following automatically:
\nCryptographically sign your service requests
\nRetry requests
\nHandle error responses
\n\n Additional information\n
\n\n Amazon SQS Developer Guide\n
\n\n Making API Requests\n
\n\n Amazon Web Services General Reference\n
\nTwo or more batch entries in the request have the same Id
.
The length of all the messages put together is more than the limit.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#BatchResultErrorEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The Id
of an entry in a batch request.
Specifies whether the error happened due to the caller of the batch API action.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#BatchEntryIdsNotDistinct": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, + }, + "Code": { + "target": "com.amazonaws.sqs#String", "traits": { - "aws.protocols#awsQueryError": { - "code": "AWS.SimpleQueueService.BatchEntryIdsNotDistinct", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "Two or more batch entries in the request have the same Id
.
An error code representing why the action failed on this entry.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#BatchRequestTooLong": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, + }, + "Message": { + "target": "com.amazonaws.sqs#String", "traits": { - "aws.protocols#awsQueryError": { - "code": "AWS.SimpleQueueService.BatchRequestTooLong", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "The length of all the messages put together is more than the limit.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#documentation": "A message explaining why the action failed on this entry.
" } + } }, - "com.amazonaws.sqs#BatchResultErrorEntry": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The Id
of an entry in a batch request.
Specifies whether the error happened due to the caller of the batch API action.
", - "smithy.api#required": {} - } - }, - "Code": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An error code representing why the action failed on this entry.
", - "smithy.api#required": {} - } - }, - "Message": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "A message explaining why the action failed on this entry.
" - } - } - }, + "traits": { + "smithy.api#documentation": "Gives a detailed description of the result of an action on each entry in the\n request.
" + } + }, + "com.amazonaws.sqs#BatchResultErrorEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#BatchResultErrorEntry" + } + }, + "com.amazonaws.sqs#Binary": { + "type": "blob" + }, + "com.amazonaws.sqs#BinaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#Binary", + "traits": { + "smithy.api#xmlName": "BinaryListValue" + } + } + }, + "com.amazonaws.sqs#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.sqs#BoxedInteger": { + "type": "integer" + }, + "com.amazonaws.sqs#CancelMessageMoveTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#CancelMessageMoveTaskRequest" + }, + "output": { + "target": "com.amazonaws.sqs#CancelMessageMoveTaskResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "Cancels a specified message movement task. A message movement can only be cancelled\n when the current status is RUNNING. Cancelling a message movement task does not revert\n the messages that have already been moved. It can only stop the messages that have not\n been moved yet.
\nThis action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.
\nCurrently, only standard queues are supported.
\nOnly one active message movement task is supported per queue at any given\n time.
\nGives a detailed description of the result of an action on each entry in the\n request.
" + "smithy.api#documentation": "An identifier associated with a message movement task.
", + "smithy.api#required": {} } + } }, - "com.amazonaws.sqs#BatchResultErrorEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sqs#BatchResultErrorEntry" + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#CancelMessageMoveTaskResult": { + "type": "structure", + "members": { + "ApproximateNumberOfMessagesMoved": { + "target": "com.amazonaws.sqs#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The approximate number of messages already moved to the destination queue.
" } + } }, - "com.amazonaws.sqs#Binary": { - "type": "blob" - }, - "com.amazonaws.sqs#BinaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sqs#Binary", - "traits": { - "smithy.api#xmlName": "BinaryListValue" - } + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#ChangeMessageVisibility": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#MessageNotInflight" + }, + { + "target": "com.amazonaws.sqs#ReceiptHandleIsInvalid" + } + ], + "traits": { + "smithy.api#documentation": "Changes the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
\nFor example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed\n since you received the message, and you send a ChangeMessageVisibility call with\n VisibilityTimeout
set to 10 seconds, the 10 seconds begin to count from\n the time that you make the ChangeMessageVisibility
call. Thus, any attempt\n to change the visibility timeout or to delete that message 10 seconds after you\n initially change the visibility timeout (a total of 25 seconds) might result in an\n error.
An Amazon SQS message has three basic states:
\nSent to a queue by a producer.
\nReceived from the queue by a consumer.
\nDeleted from the queue.
\nA message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages.\n A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages.
\nLimits that apply to in flight messages are unrelated to the unlimited number of stored messages.
\nFor most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). \n If you reach this limit, Amazon SQS returns the OverLimit
error message.\n To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.\n To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
\nIf you attempt to set the VisibilityTimeout
to a value greater than\n the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically\n recalculate and increase the timeout to the maximum remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message\n the timeout value is applied immediately but isn't saved in memory for that message.\n If you don't delete a message after it is received, the visibility timeout for the\n message reverts to the original timeout value (not to the value you set using the\n ChangeMessageVisibility
action) the next time the message is\n received.
Changes the visibility timeout of multiple messages. This is a batch version of\n \n ChangeMessageVisibility.
The result of the action\n on each message is reported individually in the response. You can send up to 10\n \n ChangeMessageVisibility\n
requests with each\n ChangeMessageVisibilityBatch
action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200
.
The URL of the Amazon SQS queue whose messages' visibility is changed.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "Entries": { + "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntryList", + "traits": { + "smithy.api#documentation": "Lists the receipt handles of the messages for which the visibility timeout must be\n changed.
", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "ChangeMessageVisibilityBatchRequestEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "An identifier for this particular receipt handle used to communicate the\n result.
\nThe 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 (_).
\nA receipt handle.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#BoxedInteger": { - "type": "integer" - }, - "com.amazonaws.sqs#CancelMessageMoveTask": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#CancelMessageMoveTaskRequest" - }, - "output": { - "target": "com.amazonaws.sqs#CancelMessageMoveTaskResult" - }, - "errors": [ - { - "target": "com.amazonaws.sqs#InvalidAddress" - }, - { - "target": "com.amazonaws.sqs#InvalidSecurity" - }, - { - "target": "com.amazonaws.sqs#RequestThrottled" - }, - { - "target": "com.amazonaws.sqs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.sqs#UnsupportedOperation" - } - ], + }, + "VisibilityTimeout": { + "target": "com.amazonaws.sqs#Integer", "traits": { - "smithy.api#documentation": "Cancels a specified message movement task. A message movement can only be cancelled\n when the current status is RUNNING. Cancelling a message movement task does not revert\n the messages that have already been moved. It can only stop the messages that have not\n been moved yet.
\nThis action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.
\nCurrently, only standard queues are supported.
\nOnly one active message movement task is supported per queue at any given\n time.
\nThe new value (in seconds) for the message's visibility timeout.
" } + } }, - "com.amazonaws.sqs#CancelMessageMoveTaskRequest": { - "type": "structure", - "members": { - "TaskHandle": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An identifier associated with a message movement task.
", - "smithy.api#required": {} - } - } - }, + "traits": { + "smithy.api#documentation": "Encloses a receipt handle and an entry ID for each message in \n ChangeMessageVisibilityBatch.
\n
A list of \n ChangeMessageVisibilityBatchResultEntry\n
\n items.
A list of \n BatchResultErrorEntry\n
items.
For each message in the batch, the response contains a \n ChangeMessageVisibilityBatchResultEntry\n
tag if the message\n succeeds or a \n BatchResultErrorEntry\n
tag if the message\n fails.
Represents a message whose visibility timeout has been changed successfully.
", + "smithy.api#required": {} } + } }, - "com.amazonaws.sqs#CancelMessageMoveTaskResult": { - "type": "structure", - "members": { - "ApproximateNumberOfMessagesMoved": { - "target": "com.amazonaws.sqs#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The approximate number of messages already moved to the destination queue.
" - } - } - }, + "traits": { + "smithy.api#documentation": "Encloses the Id
of an entry in \n ChangeMessageVisibilityBatch.
\n
The URL of the Amazon SQS queue whose message's visibility is changed.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#ChangeMessageVisibility": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#ChangeMessageVisibilityRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sqs#InvalidAddress" - }, - { - "target": "com.amazonaws.sqs#InvalidSecurity" - }, - { - "target": "com.amazonaws.sqs#MessageNotInflight" - }, - { - "target": "com.amazonaws.sqs#QueueDoesNotExist" - }, - { - "target": "com.amazonaws.sqs#ReceiptHandleIsInvalid" - }, - { - "target": "com.amazonaws.sqs#RequestThrottled" - }, - { - "target": "com.amazonaws.sqs#UnsupportedOperation" - } - ], + }, + "ReceiptHandle": { + "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "Changes the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
\nFor example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed\n since you received the message, and you send a ChangeMessageVisibility call with\n VisibilityTimeout
set to 10 seconds, the 10 seconds begin to count from\n the time that you make the ChangeMessageVisibility
call. Thus, any attempt\n to change the visibility timeout or to delete that message 10 seconds after you\n initially change the visibility timeout (a total of 25 seconds) might result in an\n error.
An Amazon SQS message has three basic states:
\nSent to a queue by a producer.
\nReceived from the queue by a consumer.
\nDeleted from the queue.
\nA message is considered to be stored after it is sent to a queue\n by a producer, but not yet received from the queue by a consumer (that is, between\n states 1 and 2). There is no limit to the number of stored messages. A message is\n considered to be in flight after it is received from a queue by a\n consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is\n a limit to the number of in flight messages.
\nLimits that apply to in flight messages are unrelated to the\n unlimited number of stored messages.
\nFor most standard queues (depending on queue traffic and message backlog), there can\n be a maximum of approximately 120,000 in flight messages (received from a queue by a\n consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS\n returns the OverLimit
error message. To avoid reaching the limit, you\n should delete messages from the queue after they're processed. You can also increase the\n number of queues you use to process your messages. To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a\n queue by a consumer, but not yet deleted from the queue). If you reach this limit,\n Amazon SQS returns no error messages.
\nIf you attempt to set the VisibilityTimeout
to a value greater than\n the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically\n recalculate and increase the timeout to the maximum remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message\n the timeout value is applied immediately but isn't saved in memory for that message.\n If you don't delete a message after it is received, the visibility timeout for the\n message reverts to the original timeout value (not to the value you set using the\n ChangeMessageVisibility
action) the next time the message is\n received.
The receipt handle associated with the message, whose visibility timeout is changed.\n This parameter is returned by the \n ReceiveMessage\n
\n action.
Changes the visibility timeout of multiple messages. This is a batch version of\n \n ChangeMessageVisibility.
The result of the action\n on each message is reported individually in the response. You can send up to 10\n \n ChangeMessageVisibility\n
requests with each\n ChangeMessageVisibilityBatch
action.
Because the batch request can result in a combination of successful and\n unsuccessful actions, you should check for batch errors even when the call returns\n an HTTP status code of 200
.
The new value for the message's visibility timeout (in seconds). Values range:\n 0
to 43200
. Maximum: 12 hours.
The URL of the Amazon SQS queue whose messages' visibility is changed.
\nQueue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "Entries": { - "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntryList", - "traits": { - "smithy.api#documentation": "Lists the receipt handles of the messages for which the visibility timeout must be\n changed.
", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "ChangeMessageVisibilityBatchRequestEntry" - } - } - }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#CreateQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#CreateQueueRequest" + }, + "output": { + "target": "com.amazonaws.sqs#CreateQueueResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#QueueDeletedRecently" + }, + { + "target": "com.amazonaws.sqs#QueueNameExists" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:
\nIf you don't specify the FifoQueue
attribute, Amazon SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon SQS Developer Guide.
\nIf you don't provide a value for an attribute, the queue is created with the\n default value for the attribute.
\nIf you delete a queue, you must wait at least 60 seconds before creating a\n queue with the same name.
\nTo successfully create a new queue, you must provide a queue name that adheres to the\n limits\n related to queues and is unique within the scope of your queues.
\nAfter you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.
\nTo get the queue URL, use the \n GetQueueUrl\n
action.\n \n GetQueueUrl\n
requires only the\n QueueName
parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and\n values of all the queue's attributes, CreateQueue
returns the queue\n URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an\n existing queue, CreateQueue
returns an error.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nThe name of the new queue. The following limits apply to this name:
\nA queue name can have up to 80 characters.
\nValid values: alphanumeric characters, hyphens (-
), and\n underscores (_
).
A FIFO queue name must end with the .fifo
suffix.
Queue URLs and names are case-sensitive.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntry": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An identifier for this particular receipt handle used to communicate the\n result.
\nThe 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\n accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nA receipt handle.
", - "smithy.api#required": {} - } - }, - "VisibilityTimeout": { - "target": "com.amazonaws.sqs#NullableInteger", - "traits": { - "smithy.api#documentation": "The new value (in seconds) for the message's visibility timeout.
" - } - } - }, + }, + "tags": { + "target": "com.amazonaws.sqs#TagMap", "traits": { - "smithy.api#documentation": "Encloses a receipt handle and an entry ID for each message in \n ChangeMessageVisibilityBatch.
\n
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the existing tag.
\nFor a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.
\nTo be able to tag a queue on creation, you must have the\n sqs:CreateQueue
and sqs:TagQueue
permissions.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nA map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the CreateQueue
action uses:
\n DelaySeconds
– The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 seconds (15 minutes). Default: 0.
\n MaximumMessageSize
– The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
\n MessageRetentionPeriod
– The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1\n minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.
\n Policy
– The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the IAM User Guide.
\n ReceiveMessageWaitTimeSeconds
– The length of time, in\n seconds, for which a \n ReceiveMessage\n
action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.
\n VisibilityTimeout
– The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount
is exceeded.
\n maxReceiveCount
– The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
\n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy
– The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission
– The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll
– (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll
– No source queues can specify this queue as the dead-letter\n queue.
\n byQueue
– Only queues specified by the sourceQueueArns
parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns
– The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission
parameter is set to byQueue
. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission
parameter\n to allowAll
.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is\n always alias/aws/sqs
, the alias of a custom CMK can, for example,\n be alias/MyAlias\n
. For more examples, see\n KeyId in the Key Management Service API\n Reference.
\n KmsDataKeyReusePeriodSeconds
– The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?\n
\n SqsManagedSseEnabled
– Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out)\n queues:
\n\n FifoQueue
– Designates a queue as FIFO. Valid values are\n true
and false
. If you don't specify the FifoQueue
attribute, Amazon SQS creates a standard queue. You\n can provide this attribute only during queue creation. You can't change it for\n an existing queue. When you set this attribute, you must also provide the\n MessageGroupId
for your messages explicitly.
For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.
\n\n ContentBasedDeduplication
– Enables content-based\n deduplication. Valid values are true
and false
. For\n more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:
Every message must have a unique\n MessageDeduplicationId
.
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a\n MessageDeduplicationId
and you enable\n ContentBasedDeduplication
for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the\n message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and\n the queue doesn't have ContentBasedDeduplication
\n set, the action fails with an error.
If the queue has ContentBasedDeduplication
set,\n your MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.
If you send one message with ContentBasedDeduplication
\n enabled and then another message with a\n MessageDeduplicationId
that is the same as the one\n generated for the first MessageDeduplicationId
, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope
– Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup
and queue
.
\n FifoThroughputLimit
– Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue
and perMessageGroupId
. \n The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope
to messageGroup
.
Set FifoThroughputLimit
to perMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Attribute" } + } }, - "com.amazonaws.sqs#ChangeMessageVisibilityBatchResult": { - "type": "structure", - "members": { - "Successful": { - "target": "com.amazonaws.sqs#ChangeMessageVisibilityBatchResultEntryList", - "traits": { - "smithy.api#documentation": "A list of \n ChangeMessageVisibilityBatchResultEntry\n
\n items.
A list of \n BatchResultErrorEntry\n
items.
For each message in the batch, the response contains a \n ChangeMessageVisibilityBatchResultEntry\n
tag if the message\n succeeds or a \n BatchResultErrorEntry\n
tag if the message\n fails.
The URL of the created Amazon SQS queue.
" } + } }, - "com.amazonaws.sqs#ChangeMessageVisibilityBatchResultEntry": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "Represents a message whose visibility timeout has been changed successfully.
", - "smithy.api#required": {} - } - } - }, + "traits": { + "smithy.api#documentation": "Returns the QueueUrl
attribute of the created queue.
Deletes the specified message from the specified queue. To select the message to\n delete, use the ReceiptHandle
of the message (not the\n MessageId
which you receive when you send the message). Amazon SQS can\n delete a message from a queue even if a visibility timeout setting causes the message to\n be locked by another consumer. Amazon SQS automatically deletes messages left in a queue\n longer than the retention period configured for the queue.
The ReceiptHandle
is associated with a specific\n instance of receiving a message. If you receive a message more than\n once, the ReceiptHandle
is different each time you receive a message.\n When you use the DeleteMessage
action, you must provide the most\n recently received ReceiptHandle
for the message (otherwise, the request\n succeeds, but the message will not be deleted).
For standard queues, it is possible to receive a message even after you\n delete it. This might happen on rare occasions if one of the servers which stores a\n copy of the message is unavailable when you send the request to delete the message.\n The copy remains on the server and might be returned to you during a subsequent\n receive request. You should ensure that your application is idempotent, so that\n receiving a message more than once does not cause issues.
\nDeletes up to ten messages from the specified queue. This is a batch version of\n \n DeleteMessage.
The result of the action on each\n message is reported individually in the response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200
.
The URL of the Amazon SQS queue from which messages are deleted.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "Entries": { + "target": "com.amazonaws.sqs#DeleteMessageBatchRequestEntryList", + "traits": { + "smithy.api#documentation": "Lists the receipt handles for the messages to be deleted.
", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "DeleteMessageBatchRequestEntry" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#DeleteMessageBatchRequestEntry": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "Encloses the Id
of an entry in \n ChangeMessageVisibilityBatch.
\n
The identifier for this particular receipt handle. This is used to communicate the\n result.
\nThe 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 (_).
\nA receipt handle.
", + "smithy.api#required": {} } + } }, - "com.amazonaws.sqs#ChangeMessageVisibilityRequest": { - "type": "structure", - "members": { - "QueueUrl": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The URL of the Amazon SQS queue whose message's visibility is changed.
\nQueue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "ReceiptHandle": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The receipt handle associated with the message, whose visibility timeout is changed.\n This parameter is returned by the \n ReceiveMessage\n
\n action.
The new value for the message's visibility timeout (in seconds). Values range:\n 0
to 43200
. Maximum: 12 hours.
Encloses a receipt handle and an identifier for it.
" + } + }, + "com.amazonaws.sqs#DeleteMessageBatchRequestEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#DeleteMessageBatchRequestEntry" + } + }, + "com.amazonaws.sqs#DeleteMessageBatchResult": { + "type": "structure", + "members": { + "Successful": { + "target": "com.amazonaws.sqs#DeleteMessageBatchResultEntryList", + "traits": { + "smithy.api#documentation": "A list of \n DeleteMessageBatchResultEntry\n
items.
A list of \n BatchResultErrorEntry\n
items.
For each message in the batch, the response contains a \n DeleteMessageBatchResultEntry\n
tag if the message is deleted\n or a \n BatchResultErrorEntry\n
tag if the message can't be\n deleted.
Represents a successfully deleted message.
", + "smithy.api#required": {} } + } }, - "com.amazonaws.sqs#CreateQueue": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#CreateQueueRequest" - }, - "output": { - "target": "com.amazonaws.sqs#CreateQueueResult" - }, - "errors": [ - { - "target": "com.amazonaws.sqs#InvalidAddress" - }, - { - "target": "com.amazonaws.sqs#InvalidAttributeName" - }, - { - "target": "com.amazonaws.sqs#InvalidAttributeValue" - }, - { - "target": "com.amazonaws.sqs#InvalidSecurity" - }, - { - "target": "com.amazonaws.sqs#QueueDeletedRecently" - }, - { - "target": "com.amazonaws.sqs#QueueNameExists" - }, - { - "target": "com.amazonaws.sqs#RequestThrottled" - }, - { - "target": "com.amazonaws.sqs#UnsupportedOperation" - } - ], + "traits": { + "smithy.api#documentation": "Encloses the Id
of an entry in \n DeleteMessageBatch.
\n
Creates a new standard or FIFO queue. You can pass one or more attributes in the\n request. Keep the following in mind:
\nIf you don't specify the FifoQueue
attribute, Amazon SQS creates\n a standard queue.
You can't change the queue type after you create it and you can't convert\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon SQS Developer Guide.
\nIf you don't provide a value for an attribute, the queue is created with the\n default value for the attribute.
\nIf you delete a queue, you must wait at least 60 seconds before creating a\n queue with the same name.
\nTo successfully create a new queue, you must provide a queue name that adheres to the\n limits\n related to queues and is unique within the scope of your queues.
\nAfter you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.
\nTo get the queue URL, use the \n GetQueueUrl\n
action.\n \n GetQueueUrl\n
requires only the\n QueueName
parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and\n values of all the queue's attributes, CreateQueue
returns the queue\n URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an\n existing queue, CreateQueue
returns an error.
Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nThe URL of the Amazon SQS queue from which messages are deleted.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#CreateQueueRequest": { - "type": "structure", - "members": { - "QueueName": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The name of the new queue. The following limits apply to this name:
\nA queue name can have up to 80 characters.
\nValid values: alphanumeric characters, hyphens (-
), and\n underscores (_
).
A FIFO queue name must end with the .fifo
suffix.
Queue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "Attributes": { - "target": "com.amazonaws.sqs#QueueAttributeMap", - "traits": { - "smithy.api#documentation": "A map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the CreateQueue
action uses:
\n DelaySeconds
– The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 seconds (15 minutes). Default: 0.
\n MaximumMessageSize
– The limit of how many bytes a message can\n contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
\n MessageRetentionPeriod
– The length of time, in seconds, for which\n Amazon SQS retains a message. Valid values: An integer from 60 seconds (1\n minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to\n the MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.
\n Policy
– The queue's policy. A valid Amazon Web Services\n policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the IAM\n User Guide.
\n ReceiveMessageWaitTimeSeconds
– The length of time, in seconds, for\n which a \n ReceiveMessage\n
action waits for a message\n to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
\n VisibilityTimeout
– The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy
– The string that includes the parameters for the\n dead-letter queue functionality of the source queue as a JSON object. The\n parameters are as follows:
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of\n the dead-letter queue to which Amazon SQS moves messages after the value\n of maxReceiveCount
is exceeded.
\n maxReceiveCount
– The number of times a message is\n delivered to the source queue before being moved to the dead-letter\n queue. Default: 10. When the ReceiveCount
for a message\n exceeds the maxReceiveCount
for a queue, Amazon SQS moves\n the message to the dead-letter-queue.
\n RedriveAllowPolicy
– The string that includes the parameters for\n the permissions for the dead-letter queue redrive permission and which source\n queues can specify dead-letter queues as a JSON object. The parameters are as\n follows:
\n redrivePermission
– The permission type that defines\n which source queues can specify the current queue as the dead-letter\n queue. Valid values are:
\n allowAll
– (Default) Any source queues in this\n Amazon Web Services account in the same\n Region can specify this queue as the dead-letter queue.
\n denyAll
– No source queues can specify this queue\n as the dead-letter queue.
\n byQueue
– Only queues specified by the\n sourceQueueArns
parameter can specify this\n queue as the dead-letter queue.
\n sourceQueueArns
– The Amazon Resource Names (ARN)s of the\n source queues that can specify this queue as the dead-letter queue and\n redrive messages. You can specify this parameter only when the\n redrivePermission
parameter is set to\n byQueue
. You can specify up to 10 source queue ARNs. To\n allow more than 10 source queues to specify dead-letter queues, set the\n redrivePermission
parameter to\n allowAll
.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the\n dead-letter queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer\n master key (CMK) for Amazon SQS or a custom CMK. For more information, see\n Key Terms. While the alias of the Amazon Web Services\n managed CMK for Amazon SQS is always alias/aws/sqs
, the alias of a\n custom CMK can, for example, be alias/MyAlias\n
.\n For more examples, see KeyId in the Key Management Service API\n Reference.
\n KmsDataKeyReusePeriodSeconds
– The length of time, in seconds, for\n which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer representing\n seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default:\n 300 (5 minutes). A shorter time period provides better security but results in\n more calls to KMS which might incur charges after Free Tier. For more\n information, see How Does the Data Key Reuse Period Work?\n
\n SqsManagedSseEnabled
– Enables server-side queue encryption using\n SQS owned encryption keys. Only one server-side encryption option is supported\n per queue (for example, SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO\n (first-in-first-out) queues:
\n\n FifoQueue
– Designates a queue as FIFO. Valid values are\n true
and false
. If you don't specify the\n FifoQueue
attribute, Amazon SQS creates a standard queue. You\n can provide this attribute only during queue creation. You can't change it for\n an existing queue. When you set this attribute, you must also provide the\n MessageGroupId
for your messages explicitly.
For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.
\n\n ContentBasedDeduplication
– Enables content-based deduplication.\n Valid values are true
and false
. For more information,\n see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:
Every message must have a unique\n MessageDeduplicationId
.
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a\n MessageDeduplicationId
and you enable\n ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the\n message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and\n the queue doesn't have ContentBasedDeduplication
\n set, the action fails with an error.
If the queue has ContentBasedDeduplication
set,\n your MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.
If you send one message with ContentBasedDeduplication
\n enabled and then another message with a\n MessageDeduplicationId
that is the same as the one\n generated for the first MessageDeduplicationId
, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.
The following attributes apply only to high\n throughput for FIFO queues:
\n\n DeduplicationScope
– Specifies whether message deduplication\n occurs at the message group or queue level. Valid values are\n messageGroup
and queue
.
\n FifoThroughputLimit
– Specifies whether the FIFO queue throughput\n quota applies to the entire queue or per message group. Valid values are\n perQueue
and perMessageGroupId
. The\n perMessageGroupId
value is allowed only when the value for\n DeduplicationScope
is messageGroup
.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope
to messageGroup
.
Set FifoThroughputLimit
to perMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, see Quotas\n related to messages in the Amazon SQS Developer\n Guide.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Attribute" - } - }, - "tags": { - "target": "com.amazonaws.sqs#TagMap", - "traits": { - "smithy.api#documentation": "Add cost allocation tags to the specified Amazon SQS queue. For an overview, see\n Tagging\n Your Amazon SQS Queues in the Amazon SQS Developer\n Guide.
\nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character\n strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the\n existing tag.
\nFor a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer\n Guide.
\nTo be able to tag a queue on creation, you must have the\n sqs:CreateQueue
and sqs:TagQueue
permissions.
Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nThe receipt handle associated with the message to delete.
", + "smithy.api#required": {} } + } }, - "com.amazonaws.sqs#CreateQueueResult": { - "type": "structure", - "members": { - "QueueUrl": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The URL of the created Amazon SQS queue.
" - } - } - }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#DeleteQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#DeleteQueueRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Deletes the queue specified by the QueueUrl
, regardless of the queue's\n contents.
Be careful with the DeleteQueue
action: When you delete a queue, any\n messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you\n send involving that queue during the 60 seconds might succeed. For example, a\n \n SendMessage\n
request might succeed, but after 60\n seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue\n with the same name.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nThe delete operation uses the HTTP GET
verb.
Returns the QueueUrl
attribute of the created queue.
The URL of the Amazon SQS queue to delete.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} } + } }, - "com.amazonaws.sqs#DeleteMessage": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#DeleteMessageRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sqs#InvalidAddress" - }, - { - "target": "com.amazonaws.sqs#InvalidIdFormat" - }, - { - "target": "com.amazonaws.sqs#InvalidSecurity" - }, - { - "target": "com.amazonaws.sqs#QueueDoesNotExist" - }, - { - "target": "com.amazonaws.sqs#ReceiptHandleIsInvalid" - }, - { - "target": "com.amazonaws.sqs#RequestThrottled" - }, - { - "target": "com.amazonaws.sqs#UnsupportedOperation" - } - ], + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#EmptyBatchRequest": { + "type": "structure", + "members": {}, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.EmptyBatchRequest", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The batch request doesn't contain any entries.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#GetQueueAttributes": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#GetQueueAttributesRequest" + }, + "output": { + "target": "com.amazonaws.sqs#GetQueueAttributesResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAttributeName" + } + ], + "traits": { + "smithy.api#documentation": "Gets attributes for the specified queue.
\nTo determine whether a queue is FIFO, you can check whether QueueName
ends with the .fifo
suffix.
Deletes the specified message from the specified queue. To select the message to\n delete, use the ReceiptHandle
of the message (not the\n MessageId
which you receive when you send the message). Amazon SQS can\n delete a message from a queue even if a visibility timeout setting causes the message to\n be locked by another consumer. Amazon SQS automatically deletes messages left in a queue\n longer than the retention period configured for the queue.
The ReceiptHandle
is associated with a specific\n instance of receiving a message. If you receive a message more than\n once, the ReceiptHandle
is different each time you receive a message.\n When you use the DeleteMessage
action, you must provide the most\n recently received ReceiptHandle
for the message (otherwise, the request\n succeeds, but the message will not be deleted).
For standard queues, it is possible to receive a message even after you delete it.\n This might happen on rare occasions if one of the servers which stores a copy of the\n message is unavailable when you send the request to delete the message. The copy\n remains on the server and might be returned to you during a subsequent receive\n request. You should ensure that your application is idempotent, so that receiving a\n message more than once does not cause issues.
\nThe URL of the Amazon SQS queue whose attribute information is retrieved.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#DeleteMessageBatch": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#DeleteMessageBatchRequest" - }, - "output": { - "target": "com.amazonaws.sqs#DeleteMessageBatchResult" - }, - "errors": [ - { - "target": "com.amazonaws.sqs#BatchEntryIdsNotDistinct" - }, - { - "target": "com.amazonaws.sqs#EmptyBatchRequest" - }, - { - "target": "com.amazonaws.sqs#InvalidAddress" - }, - { - "target": "com.amazonaws.sqs#InvalidBatchEntryId" - }, - { - "target": "com.amazonaws.sqs#InvalidSecurity" - }, - { - "target": "com.amazonaws.sqs#QueueDoesNotExist" - }, - { - "target": "com.amazonaws.sqs#RequestThrottled" - }, - { - "target": "com.amazonaws.sqs#TooManyEntriesInBatchRequest" - }, - { - "target": "com.amazonaws.sqs#UnsupportedOperation" - } - ], + }, + "AttributeNames": { + "target": "com.amazonaws.sqs#AttributeNameList", "traits": { - "smithy.api#documentation": "Deletes up to ten messages from the specified queue. This is a batch version of\n \n DeleteMessage.
The result of the action on each\n message is reported individually in the response.
Because the batch request can result in a combination of successful and\n unsuccessful actions, you should check for batch errors even when the call returns\n an HTTP status code of 200
.
A list of attributes for which to retrieve information.
\nThe AttributeNames
parameter is optional, but if you don't specify values\n for this parameter, the request returns empty results.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nThe following attributes are supported:
\nThe ApproximateNumberOfMessagesDelayed
,\n ApproximateNumberOfMessagesNotVisible
, and\n ApproximateNumberOfMessages
metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is\n required for the queue metadata to reach eventual consistency.
\n All
– Returns all values.
\n ApproximateNumberOfMessages
– Returns the approximate\n number of messages available for retrieval from the queue.
\n ApproximateNumberOfMessagesDelayed
– Returns the\n approximate number of messages in the queue that are delayed and not available\n for reading immediately. This can happen when the queue is configured as a delay\n queue or when a message has been sent with a delay parameter.
\n ApproximateNumberOfMessagesNotVisible
– Returns the\n approximate number of messages that are in flight. Messages are considered to be\n in flight if they have been sent to a client but have\n not yet been deleted or have not yet reached the end of their visibility window.\n
\n CreatedTimestamp
– Returns the time when the queue was\n created in seconds (epoch\n time).
\n DelaySeconds
– Returns the default delay on the queue in\n seconds.
\n LastModifiedTimestamp
– Returns the time when the queue\n was last changed in seconds (epoch time).
\n MaximumMessageSize
– Returns the limit of how many bytes a\n message can contain before Amazon SQS rejects it.
\n MessageRetentionPeriod
– Returns the length of time, in\n seconds, for which Amazon SQS retains a message. When you change a queue's\n attributes, the change can take up to 60 seconds for most of the attributes to\n propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.
\n Policy
– Returns the policy of the queue.
\n QueueArn
– Returns the Amazon resource name (ARN) of the\n queue.
\n ReceiveMessageWaitTimeSeconds
– Returns the length of\n time, in seconds, for which the ReceiveMessage
action waits for a\n message to arrive.
\n VisibilityTimeout
– Returns the visibility timeout for the\n queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount
is exceeded.
\n maxReceiveCount
– The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
\n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy
– The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission
– The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll
– (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll
– No source queues can specify this queue as the dead-letter\n queue.
\n byQueue
– Only queues specified by the sourceQueueArns
parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns
– The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission
parameter is set to byQueue
. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission
parameter\n to allowAll
.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId
– Returns the ID of an Amazon Web Services managed customer\n master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
\n KmsDataKeyReusePeriodSeconds
– Returns the length of time,\n in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt\n messages before calling KMS again. For more information, see\n How Does the Data Key Reuse Period Work?.
\n SqsManagedSseEnabled
– Returns information about whether the\n queue is using SSE-SQS encryption using SQS owned encryption keys. Only one\n server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out)\n queues:
\n\n FifoQueue
– Returns information about whether the queue is\n FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.
To determine whether a queue is FIFO, you can check whether QueueName
ends with the .fifo
suffix.
\n ContentBasedDeduplication
– Returns whether content-based\n deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope
– Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup
and queue
.
\n FifoThroughputLimit
– Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue
and perMessageGroupId
. \n The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope
to messageGroup
.
Set FifoThroughputLimit
to perMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AttributeName" } + } }, - "com.amazonaws.sqs#DeleteMessageBatchRequest": { - "type": "structure", - "members": { - "QueueUrl": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The URL of the Amazon SQS queue from which messages are deleted.
\nQueue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "Entries": { - "target": "com.amazonaws.sqs#DeleteMessageBatchRequestEntryList", - "traits": { - "smithy.api#documentation": "Lists the receipt handles for the messages to be deleted.
", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "DeleteMessageBatchRequestEntry" - } - } - }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#GetQueueAttributesResult": { + "type": "structure", + "members": { + "Attributes": { + "target": "com.amazonaws.sqs#QueueAttributeMap", + "traits": { + "smithy.api#documentation": "A map of attributes to their respective values.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Attribute" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of returned queue attributes.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#GetQueueUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#GetQueueUrlRequest" + }, + "output": { + "target": "com.amazonaws.sqs#GetQueueUrlResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + } + ], + "traits": { + "smithy.api#documentation": "Returns the URL of an existing Amazon SQS queue.
\nTo access a queue that belongs to another AWS account, use the\n QueueOwnerAWSAccountId
parameter to specify the account ID of the\n queue's owner. The queue's owner must grant you permission to access the queue. For more\n information about shared queue access, see \n AddPermission\n
\n or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS\n Developer Guide.
The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values:\n alphanumeric characters, hyphens (-
), and underscores\n (_
).
Queue URLs and names are case-sensitive.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#DeleteMessageBatchRequestEntry": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The identifier for this particular receipt handle. This is used to communicate the\n result.
\nThe 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\n accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nA receipt handle.
", - "smithy.api#required": {} - } - } - }, + }, + "QueueOwnerAWSAccountId": { + "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "Encloses a receipt handle and an identifier for it.
" + "smithy.api#documentation": "The Amazon Web Services account ID of the account that created the queue.
" } + } }, - "com.amazonaws.sqs#DeleteMessageBatchRequestEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sqs#DeleteMessageBatchRequestEntry" + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#GetQueueUrlResult": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The URL of the queue.
" } + } }, - "com.amazonaws.sqs#DeleteMessageBatchResult": { - "type": "structure", - "members": { - "Successful": { - "target": "com.amazonaws.sqs#DeleteMessageBatchResultEntryList", - "traits": { - "smithy.api#documentation": "A list of \n DeleteMessageBatchResultEntry\n
items.
A list of \n BatchResultErrorEntry\n
items.
For more information, see Interpreting Responses in the Amazon SQS Developer\n Guide.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.sqs#InvalidAttributeName": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The specified attribute doesn't exist.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#InvalidBatchEntryId": { + "type": "structure", + "members": {}, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.InvalidBatchEntryId", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The Id
of a batch entry in a batch request doesn't abide by the\n specification.
The specified receipt handle isn't valid for the current version.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#InvalidMessageContents": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The message contains characters outside the allowed set.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#ListDeadLetterSourceQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of your queues that have the RedrivePolicy
queue attribute\n configured with a dead-letter queue.
The ListDeadLetterSourceQueues
methods supports pagination. Set\n parameter MaxResults
in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults
, the\n response includes a maximum of 1,000 results. If you set MaxResults
and\n there are additional results to display, the response includes a value for\n NextToken
. Use NextToken
as a parameter in your next\n request to ListDeadLetterSourceQueues
to receive the next page of results.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer\n Guide.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "queueUrls", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.sqs#ListDeadLetterSourceQueuesRequest": { + "type": "structure", + "members": { + "QueueUrl": { + "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "For each message in the batch, the response contains a \n DeleteMessageBatchResultEntry\n
tag if the message is deleted\n or a \n BatchResultErrorEntry\n
tag if the message can't be\n deleted.
The URL of a dead-letter queue.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#DeleteMessageBatchResultEntry": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "Represents a successfully deleted message.
", - "smithy.api#required": {} - } - } - }, + }, + "NextToken": { + "target": "com.amazonaws.sqs#Token", "traits": { - "smithy.api#documentation": "Encloses the Id
of an entry in \n DeleteMessageBatch.
\n
Pagination token to request the next set of results.
" } - }, - "com.amazonaws.sqs#DeleteMessageBatchResultEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sqs#DeleteMessageBatchResultEntry" + }, + "MaxResults": { + "target": "com.amazonaws.sqs#BoxedInteger", + "traits": { + "smithy.api#documentation": "Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set MaxResults
to receive a value for NextToken
in the\n response.
The URL of the Amazon SQS queue from which messages are deleted.
\nQueue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "ReceiptHandle": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The receipt handle associated with the message to delete.
", - "smithy.api#required": {} - } - } - }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ListDeadLetterSourceQueuesResult": { + "type": "structure", + "members": { + "queueUrls": { + "target": "com.amazonaws.sqs#QueueUrlList", "traits": { - "smithy.api#documentation": "", - "smithy.api#input": {} + "smithy.api#documentation": "A list of source queue URLs that have the RedrivePolicy
queue attribute\n configured with a dead-letter queue.
Pagination token to include in the next request. Token value is null
if\n there are no additional results to request, or if you did not set\n MaxResults
in the request.
A list of your dead letter source queues.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#ListMessageMoveTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "Gets the most recent message movement tasks (up to 10) under a specific source\n queue.
\nThis action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.
\nCurrently, only standard queues are supported.
\nOnly one active message movement task is supported per queue at any given\n time.
\nDeletes the queue specified by the QueueUrl
, regardless of the queue's\n contents.
Be careful with the DeleteQueue
action: When you delete a queue, any\n messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you\n send involving that queue during the 60 seconds might succeed. For example, a\n \n SendMessage\n
request might succeed, but after 60\n seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue\n with the same name.
\nCross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nThe delete operation uses the HTTP GET
verb.
The ARN of the queue whose message movement tasks are to be listed.
", + "smithy.api#required": {} } + }, + "MaxResults": { + "target": "com.amazonaws.sqs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to include in the response. The default is 1, which\n provides the most recent message movement task. The upper limit is 10.
" + } + } }, - "com.amazonaws.sqs#DeleteQueueRequest": { - "type": "structure", - "members": { - "QueueUrl": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The URL of the Amazon SQS queue to delete.
\nQueue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - } - }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ListMessageMoveTasksResult": { + "type": "structure", + "members": { + "Results": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksResultEntryList", "traits": { - "smithy.api#documentation": "", - "smithy.api#input": {} + "smithy.api#documentation": "A list of message movement tasks and their attributes.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "ListMessageMoveTasksResultEntry" } + } }, - "com.amazonaws.sqs#EmptyBatchRequest": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#ListMessageMoveTasksResultEntry": { + "type": "structure", + "members": { + "TaskHandle": { + "target": "com.amazonaws.sqs#String", "traits": { - "aws.protocols#awsQueryError": { - "code": "AWS.SimpleQueueService.EmptyBatchRequest", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "The batch request doesn't contain any entries.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#documentation": "An identifier associated with a message movement task. When this field is returned in\n the response of the ListMessageMoveTasks
action, it is only populated for\n tasks that are in RUNNING status.
The status of the message movement task. Possible values are: RUNNING, COMPLETED,\n CANCELLING, CANCELLED, and FAILED.
" + } + }, + "SourceArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The ARN of the queue that contains the messages to be moved to another queue.
" + } + }, + "DestinationArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The ARN of the destination queue if it has been specified in the\n StartMessageMoveTask
request. If a DestinationArn
has not\n been specified in the StartMessageMoveTask
request, this field value will\n be NULL.
The number of messages to be moved per second (the message movement rate), if it has\n been specified in the StartMessageMoveTask
request. If a\n MaxNumberOfMessagesPerSecond
has not been specified in the\n StartMessageMoveTask
request, this field value will be NULL.
The approximate number of messages already moved to the destination queue.
" + } + }, + "ApproximateNumberOfMessagesToMove": { + "target": "com.amazonaws.sqs#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of messages to be moved from the source queue. This number is obtained at\n the time of starting the message movement task.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The task failure reason (only included if the task status is FAILED).
" } + }, + "StartedTimestamp": { + "target": "com.amazonaws.sqs#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The timestamp of starting the message movement task.
" + } + } }, - "com.amazonaws.sqs#ExceptionMessage": { - "type": "string" + "traits": { + "smithy.api#documentation": "Contains the details of a message movement task.
" + } + }, + "com.amazonaws.sqs#ListMessageMoveTasksResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksResultEntry" + } + }, + "com.amazonaws.sqs#ListQueueTags": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListQueueTagsRequest" }, - "com.amazonaws.sqs#GetQueueAttributes": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#GetQueueAttributesRequest" - }, - "output": { - "target": "com.amazonaws.sqs#GetQueueAttributesResult" - }, - "errors": [ - { - "target": "com.amazonaws.sqs#InvalidAddress" - }, - { - "target": "com.amazonaws.sqs#InvalidAttributeName" - }, - { - "target": "com.amazonaws.sqs#InvalidSecurity" - }, - { - "target": "com.amazonaws.sqs#QueueDoesNotExist" - }, - { - "target": "com.amazonaws.sqs#RequestThrottled" - }, - { - "target": "com.amazonaws.sqs#UnsupportedOperation" - } - ], + "output": { + "target": "com.amazonaws.sqs#ListQueueTagsResult" + }, + "traits": { + "smithy.api#documentation": "List all cost allocation tags added to the specified Amazon SQS queue.\n For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nGets attributes for the specified queue.
\nTo determine whether a queue is FIFO, you can check whether QueueName
ends with the\n .fifo
suffix.
The URL of the queue.
", + "smithy.api#required": {} } + } }, - "com.amazonaws.sqs#GetQueueAttributesRequest": { - "type": "structure", - "members": { - "QueueUrl": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The URL of the Amazon SQS queue whose attribute information is retrieved.
\nQueue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "AttributeNames": { - "target": "com.amazonaws.sqs#AttributeNameList", - "traits": { - "smithy.api#documentation": "A list of attributes for which to retrieve information.
\nThe AttributeNames
parameter is optional, but if you don't specify values\n for this parameter, the request returns empty results.
In the future, new attributes might be added. If you write code that calls this\n action, we recommend that you structure your code so that it can handle new\n attributes gracefully.
\nThe following attributes are supported:
\nThe ApproximateNumberOfMessagesDelayed
,\n ApproximateNumberOfMessagesNotVisible
, and\n ApproximateNumberOfMessages
metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is\n required for the queue metadata to reach eventual consistency.
\n All
– Returns all values.
\n ApproximateNumberOfMessages
– Returns the approximate number of\n messages available for retrieval from the queue.
\n ApproximateNumberOfMessagesDelayed
– Returns the approximate\n number of messages in the queue that are delayed and not available for reading\n immediately. This can happen when the queue is configured as a delay queue or\n when a message has been sent with a delay parameter.
\n ApproximateNumberOfMessagesNotVisible
– Returns the approximate\n number of messages that are in flight. Messages are considered to be\n in flight if they have been sent to a client but have\n not yet been deleted or have not yet reached the end of their visibility window.\n
\n CreatedTimestamp
– Returns the time when the queue was created in\n seconds (epoch\n time).
\n DelaySeconds
– Returns the default delay on the queue in\n seconds.
\n LastModifiedTimestamp
– Returns the time when the queue was last\n changed in seconds (epoch\n time).
\n MaximumMessageSize
– Returns the limit of how many bytes a\n message can contain before Amazon SQS rejects it.
\n MessageRetentionPeriod
– Returns the length of time, in seconds,\n for which Amazon SQS retains a message. When you change a queue's attributes,\n the change can take up to 60 seconds for most of the attributes to propagate\n throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.
\n Policy
– Returns the policy of the queue.
\n QueueArn
– Returns the Amazon resource name (ARN) of the\n queue.
\n ReceiveMessageWaitTimeSeconds
– Returns the length of time, in\n seconds, for which the ReceiveMessage
action waits for a message to\n arrive.
\n VisibilityTimeout
– Returns the visibility timeout for the queue.\n For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy
– The string that includes the parameters for the\n dead-letter queue functionality of the source queue as a JSON object. The\n parameters are as follows:
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of\n the dead-letter queue to which Amazon SQS moves messages after the value\n of maxReceiveCount
is exceeded.
\n maxReceiveCount
– The number of times a message is\n delivered to the source queue before being moved to the dead-letter\n queue. Default: 10. When the ReceiveCount
for a message\n exceeds the maxReceiveCount
for a queue, Amazon SQS moves\n the message to the dead-letter-queue.
\n RedriveAllowPolicy
– The string that includes the parameters for\n the permissions for the dead-letter queue redrive permission and which source\n queues can specify dead-letter queues as a JSON object. The parameters are as\n follows:
\n redrivePermission
– The permission type that defines\n which source queues can specify the current queue as the dead-letter\n queue. Valid values are:
\n allowAll
– (Default) Any source queues in this\n Amazon Web Services account in the same\n Region can specify this queue as the dead-letter queue.
\n denyAll
– No source queues can specify this queue\n as the dead-letter queue.
\n byQueue
– Only queues specified by the\n sourceQueueArns
parameter can specify this\n queue as the dead-letter queue.
\n sourceQueueArns
– The Amazon Resource Names (ARN)s of the\n source queues that can specify this queue as the dead-letter queue and\n redrive messages. You can specify this parameter only when the\n redrivePermission
parameter is set to\n byQueue
. You can specify up to 10 source queue ARNs. To\n allow more than 10 source queues to specify dead-letter queues, set the\n redrivePermission
parameter to\n allowAll
.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the\n dead-letter queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId
– Returns the ID of an Amazon Web Services\n managed customer master key (CMK) for Amazon SQS or a custom CMK. For more\n information, see Key Terms.
\n KmsDataKeyReusePeriodSeconds
– Returns the length of time, in\n seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt\n messages before calling KMS again. For more information, see How Does the Data Key Reuse Period Work?.
\n SqsManagedSseEnabled
– Returns information about whether the queue\n is using SSE-SQS encryption using SQS owned encryption keys. Only one\n server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO\n (first-in-first-out) queues:
\n\n FifoQueue
– Returns information about whether the queue is FIFO.\n For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.
To determine whether a queue is FIFO, you can check whether QueueName
ends with\n the .fifo
suffix.
\n ContentBasedDeduplication
– Returns whether content-based\n deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
The following attributes apply only to high\n throughput for FIFO queues:
\n\n DeduplicationScope
– Specifies whether message deduplication\n occurs at the message group or queue level. Valid values are\n messageGroup
and queue
.
\n FifoThroughputLimit
– Specifies whether the FIFO queue throughput\n quota applies to the entire queue or per message group. Valid values are\n perQueue
and perMessageGroupId
. The\n perMessageGroupId
value is allowed only when the value for\n DeduplicationScope
is messageGroup
.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope
to messageGroup
.
Set FifoThroughputLimit
to perMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, see Quotas\n related to messages in the Amazon SQS Developer\n Guide.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "AttributeName" - } - } - }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ListQueueTagsResult": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.sqs#TagMap", "traits": { - "smithy.api#documentation": "", - "smithy.api#input": {} + "smithy.api#documentation": "The list of all tags added to the specified queue.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tag" } + } }, - "com.amazonaws.sqs#GetQueueAttributesResult": { - "type": "structure", - "members": { - "Attributes": { - "target": "com.amazonaws.sqs#QueueAttributeMap", - "traits": { - "smithy.api#documentation": "A map of attributes to their respective values.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Attribute" - } - } - }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#ListQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListQueuesRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ListQueuesResult" + }, + "traits": { + "smithy.api#documentation": "Returns a list of your queues in the current region. The response includes a maximum\n of 1,000 results. If you specify a value for the optional QueueNamePrefix
\n parameter, only queues with a name that begins with the specified value are\n returned.
The listQueues
methods supports pagination. Set parameter\n MaxResults
in the request to specify the maximum number of results to\n be returned in the response. If you do not set MaxResults
, the response\n includes a maximum of 1,000 results. If you set MaxResults
and there are\n additional results to display, the response includes a value for NextToken
.\n Use NextToken
as a parameter in your next request to\n listQueues
to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nA list of returned queue attributes.
", - "smithy.api#output": {} + "smithy.api#documentation": "A string to use for filtering the list results. Only those queues whose name begins\n with the specified string are returned.
\nQueue URLs and names are case-sensitive.
" } - }, - "com.amazonaws.sqs#GetQueueUrl": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#GetQueueUrlRequest" - }, - "output": { - "target": "com.amazonaws.sqs#GetQueueUrlResult" - }, - "errors": [ - { - "target": "com.amazonaws.sqs#InvalidAddress" - }, - { - "target": "com.amazonaws.sqs#InvalidSecurity" - }, - { - "target": "com.amazonaws.sqs#QueueDoesNotExist" - }, - { - "target": "com.amazonaws.sqs#RequestThrottled" - }, - { - "target": "com.amazonaws.sqs#UnsupportedOperation" - } - ], + }, + "NextToken": { + "target": "com.amazonaws.sqs#Token", "traits": { - "smithy.api#documentation": "Returns the URL of an existing Amazon SQS queue.
\nTo access a queue that belongs to another AWS account, use the\n QueueOwnerAWSAccountId
parameter to specify the account ID of the\n queue's owner. The queue's owner must grant you permission to access the queue. For more\n information about shared queue access, see \n AddPermission\n
\n or see Allow Developers to Write Messages to a Shared Queue in the\n Amazon SQS Developer Guide.
Pagination token to request the next set of results.
" } - }, - "com.amazonaws.sqs#GetQueueUrlRequest": { - "type": "structure", - "members": { - "QueueName": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values:\n alphanumeric characters, hyphens (-
), and underscores\n (_
).
Queue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "QueueOwnerAWSAccountId": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The Amazon Web\n Services account ID of the account that created the queue.
" - } - } - }, + }, + "MaxResults": { + "target": "com.amazonaws.sqs#BoxedInteger", "traits": { - "smithy.api#documentation": "", - "smithy.api#input": {} + "smithy.api#documentation": "Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set MaxResults
to receive a value for NextToken
in the\n response.
The URL of the queue.
" - } - } - }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ListQueuesResult": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sqs#Token", "traits": { - "smithy.api#documentation": "For more information, see Interpreting Responses in the Amazon SQS Developer\n Guide.
", - "smithy.api#output": {} + "smithy.api#documentation": "Pagination token to include in the next request. Token value is null
if\n there are no additional results to request, or if you did not set\n MaxResults
in the request.
A list of queue URLs, up to 1,000 entries, or the value of MaxResults
\n that you sent in the request.
A list of your queues.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.sqs#Message": { + "type": "structure", + "members": { + "MessageId": { + "target": "com.amazonaws.sqs#String", "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidAddress", - "httpResponseCode": 404 - }, - "smithy.api#documentation": "The accountId
is invalid.
A unique identifier for the message. A MessageId
is considered unique\n across all Amazon Web Services accounts for an extended period of time.
An identifier associated with the act of receiving the message. A new receipt handle\n is returned every time you receive a message. When deleting a message, you provide the\n last received receipt handle to delete the message.
" + } + }, + "MD5OfBody": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message body string.
" + } + }, + "Body": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The message's contents (not URL-encoded).
" + } + }, + "Attributes": { + "target": "com.amazonaws.sqs#MessageSystemAttributeMap", + "traits": { + "smithy.api#documentation": "A map of the attributes requested in \n ReceiveMessage\n
to\n their respective values. Supported attributes:
\n ApproximateReceiveCount
\n
\n ApproximateFirstReceiveTimestamp
\n
\n MessageDeduplicationId
\n
\n MessageGroupId
\n
\n SenderId
\n
\n SentTimestamp
\n
\n SequenceNumber
\n
\n ApproximateFirstReceiveTimestamp
and SentTimestamp
are each\n returned as an integer representing the epoch time in\n milliseconds.
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" + } + }, + "MessageAttributes": { + "target": "com.amazonaws.sqs#MessageBodyAttributeMap", + "traits": { + "smithy.api#documentation": "Each message attribute consists of a Name
, Type
, \nand Value
. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.
An Amazon SQS message.
" + } + }, + "com.amazonaws.sqs#MessageAttributeName": { + "type": "string" + }, + "com.amazonaws.sqs#MessageAttributeNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#MessageAttributeName" + } + }, + "com.amazonaws.sqs#MessageAttributeValue": { + "type": "structure", + "members": { + "StringValue": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters.
" + } + }, + "BinaryValue": { + "target": "com.amazonaws.sqs#Binary", + "traits": { + "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images.
" + } + }, + "StringListValues": { + "target": "com.amazonaws.sqs#StringList", + "traits": { + "smithy.api#documentation": "Not implemented. Reserved for future use.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "StringListValue" + } + }, + "BinaryListValues": { + "target": "com.amazonaws.sqs#BinaryList", "traits": { - "smithy.api#documentation": "The specified attribute doesn't exist.
", - "smithy.api#error": "client" + "smithy.api#documentation": "Not implemented. Reserved for future use.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "BinaryListValue" } + }, + "DataType": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "Amazon SQS supports the following logical data types: String
,\n Number
, and Binary
. For the Number
data type,\n you must use StringValue
.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.
", + "smithy.api#required": {} + } + } }, - "com.amazonaws.sqs#InvalidAttributeValue": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, + "traits": { + "smithy.api#documentation": "The user-specified message attribute value. For string data types, the\n Value
attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.
\n
\n Name
, type
, value
and the message body must not\n be empty or null. All parts of the message attribute, including Name
,\n Type
, and Value
, are part of the message size restriction\n (256 KiB or 262,144 bytes).
The specified message isn't in flight.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#MessageSystemAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sqs#MessageSystemAttributeName", + "traits": { + "smithy.api#xmlName": "Name" + } + }, + "value": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sqs#MessageSystemAttributeName": { + "type": "enum", + "members": { + "SenderId": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A queue attribute value is invalid.
", - "smithy.api#error": "client" + "smithy.api#enumValue": "SenderId" } - }, - "com.amazonaws.sqs#InvalidBatchEntryId": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, + }, + "SentTimestamp": { + "target": "smithy.api#Unit", "traits": { - "aws.protocols#awsQueryError": { - "code": "AWS.SimpleQueueService.InvalidBatchEntryId", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "The Id
of a batch entry in a batch request doesn't abide by the\n specification.
The specified receipt handle isn't valid for the current version.
", - "smithy.api#error": "client" + "smithy.api#enumValue": "ApproximateReceiveCount" } - }, - "com.amazonaws.sqs#InvalidMessageContents": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, + }, + "ApproximateFirstReceiveTimestamp": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The message contains characters outside the allowed set.
", - "smithy.api#error": "client" + "smithy.api#enumValue": "ApproximateFirstReceiveTimestamp" } - }, - "com.amazonaws.sqs#InvalidSecurity": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, + }, + "SequenceNumber": { + "target": "smithy.api#Unit", "traits": { - "aws.protocols#awsQueryError": { - "code": "InvalidSecurity", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "When the request to a queue is not HTTPS and SigV4.
", - "smithy.api#error": "client", - "smithy.api#httpError": 403 + "smithy.api#enumValue": "SequenceNumber" } - }, - "com.amazonaws.sqs#KmsAccessDenied": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, + }, + "MessageDeduplicationId": { + "target": "smithy.api#Unit", "traits": { - "aws.protocols#awsQueryError": { - "code": "KMS.AccessDeniedException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "The caller doesn't have the required KMS access.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#enumValue": "MessageDeduplicationId" } - }, - "com.amazonaws.sqs#KmsDisabled": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, + }, + "MessageGroupId": { + "target": "smithy.api#Unit", "traits": { - "aws.protocols#awsQueryError": { - "code": "KMS.DisabledException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "The request was denied due to request throttling.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#enumValue": "MessageGroupId" } - }, - "com.amazonaws.sqs#KmsInvalidKeyUsage": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, + }, + "AWSTraceHeader": { + "target": "smithy.api#Unit", "traits": { - "aws.protocols#awsQueryError": { - "code": "KMS.InvalidKeyUsageException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "The request was rejected for one of the following reasons:
\nThe KeyUsage value of the KMS key is incompatible with the API\n operation.
\nThe encryption algorithm or signing algorithm specified for the operation is\n incompatible with the type of key material in the KMS key (KeySpec).
\nThe request was rejected because the state of the specified resource is not valid for\n this request.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#enumValue": "DeadLetterQueueSourceArn" } - }, - "com.amazonaws.sqs#KmsNotFound": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, + } + } + }, + "com.amazonaws.sqs#MessageSystemAttributeNameForSends": { + "type": "enum", + "members": { + "AWSTraceHeader": { + "target": "smithy.api#Unit", "traits": { - "aws.protocols#awsQueryError": { - "code": "KMS.NotFoundException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "The request was rejected because the specified entity or resource could not be found.\n
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#enumValue": "AWSTraceHeader" } - }, - "com.amazonaws.sqs#KmsOptInRequired": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, + } + } + }, + "com.amazonaws.sqs#MessageSystemAttributeValue": { + "type": "structure", + "members": { + "StringValue": { + "target": "com.amazonaws.sqs#String", "traits": { - "aws.protocols#awsQueryError": { - "code": "KMS.OptInRequired", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "The request was rejected because the specified key policy isn't syntactically or\n semantically correct.
", - "smithy.api#error": "client", - "smithy.api#httpError": 403 + "smithy.api#documentation": "Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters.
" } - }, - "com.amazonaws.sqs#KmsThrottled": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, + }, + "BinaryValue": { + "target": "com.amazonaws.sqs#Binary", "traits": { - "aws.protocols#awsQueryError": { - "code": "KMS.ThrottlingException", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "Amazon Web Services KMS throttles requests for the following conditions.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images.
" } - }, - "com.amazonaws.sqs#ListDeadLetterSourceQueues": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesRequest" - }, - "output": { - "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesResult" - }, - "errors": [ - { - "target": "com.amazonaws.sqs#InvalidAddress" - }, - { - "target": "com.amazonaws.sqs#InvalidSecurity" - }, - { - "target": "com.amazonaws.sqs#QueueDoesNotExist" - }, - { - "target": "com.amazonaws.sqs#RequestThrottled" - }, - { - "target": "com.amazonaws.sqs#UnsupportedOperation" - } - ], + }, + "StringListValues": { + "target": "com.amazonaws.sqs#StringList", "traits": { - "smithy.api#documentation": "Returns a list of your queues that have the RedrivePolicy
queue attribute\n configured with a dead-letter queue.
The ListDeadLetterSourceQueues
methods supports pagination. Set\n parameter MaxResults
in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults
, the\n response includes a maximum of 1,000 results. If you set MaxResults
and\n there are additional results to display, the response includes a value for\n NextToken
. Use NextToken
as a parameter in your next\n request to ListDeadLetterSourceQueues
to receive the next page of results.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer\n Guide.
", - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "queueUrls", - "pageSize": "MaxResults" - } + "smithy.api#documentation": "Not implemented. Reserved for future use.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "StringListValue" } - }, - "com.amazonaws.sqs#ListDeadLetterSourceQueuesRequest": { - "type": "structure", - "members": { - "QueueUrl": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The URL of a dead-letter queue.
\nQueue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.sqs#Token", - "traits": { - "smithy.api#documentation": "Pagination token to request the next set of results.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sqs#BoxedInteger", - "traits": { - "smithy.api#documentation": "Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set MaxResults
to receive a value for NextToken
in the\n response.
Not implemented. Reserved for future use.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "BinaryListValue" } - }, - "com.amazonaws.sqs#ListDeadLetterSourceQueuesResult": { - "type": "structure", - "members": { - "queueUrls": { - "target": "com.amazonaws.sqs#QueueUrlList", - "traits": { - "smithy.api#documentation": "A list of source queue URLs that have the RedrivePolicy
queue attribute\n configured with a dead-letter queue.
Pagination token to include in the next request. Token value is null
if\n there are no additional results to request, or if you did not set\n MaxResults
in the request.
A list of your dead letter source queues.
", - "smithy.api#output": {} + "smithy.api#documentation": "Amazon SQS supports the following logical data types: String
,\n Number
, and Binary
. For the Number
data type,\n you must use StringValue
.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.
", + "smithy.api#required": {} } + } }, - "com.amazonaws.sqs#ListMessageMoveTasks": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#ListMessageMoveTasksRequest" - }, - "output": { - "target": "com.amazonaws.sqs#ListMessageMoveTasksResult" - }, - "errors": [ - { - "target": "com.amazonaws.sqs#InvalidAddress" - }, - { - "target": "com.amazonaws.sqs#InvalidSecurity" - }, - { - "target": "com.amazonaws.sqs#RequestThrottled" - }, - { - "target": "com.amazonaws.sqs#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.sqs#UnsupportedOperation" - } - ], + "traits": { + "smithy.api#documentation": "The user-specified message system attribute value. For string data types, the\n Value
attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.
\n
\n Name
, type
, value
and the message body must not\n be empty or null.
The specified action violates a limit. For example, ReceiveMessage
\n returns this error if the maximum number of in flight messages is reached and\n AddPermission
returns this error if the maximum number of permissions\n for the queue is reached.
Deletes available messages in a queue (including in-flight messages) specified by the\n QueueURL
parameter.
When you use the PurgeQueue
action, you can't retrieve any messages\n deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for 60\n seconds regardless of your queue's size.
\nMessages sent to the queue before you call\n PurgeQueue
might be received but are deleted within the next\n minute.
Messages sent to the queue after you call PurgeQueue
\n might be deleted while the queue is being purged.
Indicates that the specified queue previously received a PurgeQueue
\n request within the last 60 seconds (the time it can take to delete the messages in the\n queue).
Gets the most recent message movement tasks (up to 10) under a specific source\n queue.
\nThis action is currently limited to supporting message redrive from dead-letter queues (DLQs) only. In this context, the source\n queue is the dead-letter queue (DLQ), while the destination queue can be the\n original source queue (from which the messages were driven to the\n dead-letter-queue), or a custom destination queue.
\nCurrently, only standard queues are supported.
\nOnly one active message movement task is supported per queue at any given\n time.
\nThe URL of the queue from which the PurgeQueue
action deletes\n messages.
Queue URLs and names are case-sensitive.
", + "smithy.api#required": {} } + } }, - "com.amazonaws.sqs#ListMessageMoveTasksRequest": { - "type": "structure", - "members": { - "SourceArn": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The ARN of the queue whose message movement tasks are to be listed.
", - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.sqs#NullableInteger", - "traits": { - "smithy.api#documentation": "The maximum number of results to include in the response. The default is 1, which\n provides the most recent message movement task. The upper limit is 10.
" - } - } - }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#QueueAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sqs#QueueAttributeName", + "traits": { + "smithy.api#xmlName": "Name" + } + }, + "value": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sqs#QueueAttributeName": { + "type": "enum", + "members": { + "All": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#input": {} + "smithy.api#enumValue": "All" } - }, - "com.amazonaws.sqs#ListMessageMoveTasksResult": { - "type": "structure", - "members": { - "Results": { - "target": "com.amazonaws.sqs#ListMessageMoveTasksResultEntryList", - "traits": { - "smithy.api#documentation": "A list of message movement tasks and their attributes.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "ListMessageMoveTasksResultEntry" - } - } - }, + }, + "Policy": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#output": {}, - "smithy.api#xmlName": "ListMessageMoveTasksResult" + "smithy.api#enumValue": "Policy" } - }, - "com.amazonaws.sqs#ListMessageMoveTasksResultEntry": { - "type": "structure", - "members": { - "TaskHandle": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An identifier associated with a message movement task. When this field is returned in\n the response of the ListMessageMoveTasks
action, it is only populated for\n tasks that are in RUNNING status.
The status of the message movement task. Possible values are: RUNNING, COMPLETED,\n CANCELLING, CANCELLED, and FAILED.
" - } - }, - "SourceArn": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The ARN of the queue that contains the messages to be moved to another queue.
" - } - }, - "DestinationArn": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The ARN of the destination queue if it has been specified in the\n StartMessageMoveTask
request. If a DestinationArn
has not\n been specified in the StartMessageMoveTask
request, this field value will\n be NULL.
The number of messages to be moved per second (the message movement rate), if it has\n been specified in the StartMessageMoveTask
request. If a\n MaxNumberOfMessagesPerSecond
has not been specified in the\n StartMessageMoveTask
request, this field value will be NULL.
The approximate number of messages already moved to the destination queue.
" - } - }, - "ApproximateNumberOfMessagesToMove": { - "target": "com.amazonaws.sqs#NullableLong", - "traits": { - "smithy.api#documentation": "The number of messages to be moved from the source queue. This number is obtained at\n the time of starting the message movement task.
" - } - }, - "FailureReason": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The task failure reason (only included if the task status is FAILED).
" - } - }, - "StartedTimestamp": { - "target": "com.amazonaws.sqs#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The timestamp of starting the message movement task.
" - } - } - }, + }, + "VisibilityTimeout": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Contains the details of a message movement task.
" - } - }, - "com.amazonaws.sqs#ListMessageMoveTasksResultEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sqs#ListMessageMoveTasksResultEntry" + "smithy.api#enumValue": "VisibilityTimeout" } - }, - "com.amazonaws.sqs#ListQueueTags": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#ListQueueTagsRequest" - }, - "output": { - "target": "com.amazonaws.sqs#ListQueueTagsResult" - }, - "errors": [ - { - "target": "com.amazonaws.sqs#InvalidAddress" - }, - { - "target": "com.amazonaws.sqs#InvalidSecurity" - }, - { - "target": "com.amazonaws.sqs#QueueDoesNotExist" - }, - { - "target": "com.amazonaws.sqs#RequestThrottled" - }, - { - "target": "com.amazonaws.sqs#UnsupportedOperation" - } - ], + }, + "MaximumMessageSize": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "List all cost allocation tags added to the specified Amazon SQS queue. For an\n overview, see Tagging\n Your Amazon SQS Queues in the Amazon SQS Developer\n Guide.
\nCross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nThe URL of the queue.
", - "smithy.api#required": {} - } - } - }, + }, + "MessageRetentionPeriod": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#input": {} + "smithy.api#enumValue": "MessageRetentionPeriod" } - }, - "com.amazonaws.sqs#ListQueueTagsResult": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.sqs#TagMap", - "traits": { - "smithy.api#documentation": "The list of all tags added to the specified queue.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Tag" - } - } - }, + }, + "ApproximateNumberOfMessages": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#output": {} + "smithy.api#enumValue": "ApproximateNumberOfMessages" } - }, - "com.amazonaws.sqs#ListQueues": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#ListQueuesRequest" - }, - "output": { - "target": "com.amazonaws.sqs#ListQueuesResult" - }, - "errors": [ - { - "target": "com.amazonaws.sqs#InvalidAddress" - }, - { - "target": "com.amazonaws.sqs#InvalidSecurity" - }, - { - "target": "com.amazonaws.sqs#RequestThrottled" - }, - { - "target": "com.amazonaws.sqs#UnsupportedOperation" - } - ], + }, + "ApproximateNumberOfMessagesNotVisible": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Returns a list of your queues in the current region. The response includes a maximum\n of 1,000 results. If you specify a value for the optional QueueNamePrefix
\n parameter, only queues with a name that begins with the specified value are\n returned.
The listQueues
methods supports pagination. Set parameter\n MaxResults
in the request to specify the maximum number of results to\n be returned in the response. If you do not set MaxResults
, the response\n includes a maximum of 1,000 results. If you set MaxResults
and there are\n additional results to display, the response includes a value for NextToken
.\n Use NextToken
as a parameter in your next request to\n listQueues
to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nA string to use for filtering the list results. Only those queues whose name begins\n with the specified string are returned.
\nQueue URLs and names are case-sensitive.
" - } - }, - "NextToken": { - "target": "com.amazonaws.sqs#Token", - "traits": { - "smithy.api#documentation": "Pagination token to request the next set of results.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.sqs#BoxedInteger", - "traits": { - "smithy.api#documentation": "Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set MaxResults
to receive a value for NextToken
in the\n response.
A list of queue URLs, up to 1,000 entries, or the value of MaxResults
\n that you sent in the request.
Pagination token to include in the next request. Token value is null
if\n there are no additional results to request, or if you did not set\n MaxResults
in the request.
A list of your queues.
", - "smithy.api#output": {} + "smithy.api#enumValue": "LastModifiedTimestamp" } - }, - "com.amazonaws.sqs#Long": { - "type": "long", + }, + "QueueArn": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#default": 0 + "smithy.api#enumValue": "QueueArn" } - }, - "com.amazonaws.sqs#Message": { - "type": "structure", - "members": { - "MessageId": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "A unique identifier for the message. A MessageId
is considered unique\n across all Amazon Web Services accounts for an extended period of time.
An identifier associated with the act of receiving the message. A new receipt handle\n is returned every time you receive a message. When deleting a message, you provide the\n last received receipt handle to delete the message.
" - } - }, - "MD5OfBody": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message body string.
" - } - }, - "Body": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The message's contents (not URL-encoded).
" - } - }, - "Attributes": { - "target": "com.amazonaws.sqs#MessageSystemAttributeMap", - "traits": { - "smithy.api#documentation": "A map of the attributes requested in \n ReceiveMessage\n
to\n their respective values. Supported attributes:
\n ApproximateReceiveCount
\n
\n ApproximateFirstReceiveTimestamp
\n
\n MessageDeduplicationId
\n
\n MessageGroupId
\n
\n SenderId
\n
\n SentTimestamp
\n
\n SequenceNumber
\n
\n ApproximateFirstReceiveTimestamp
and SentTimestamp
are each\n returned as an integer representing the epoch time in\n milliseconds.
An MD5 digest of the non-URL-encoded message attribute string. You can use this\n attribute to verify that Amazon SQS received the message correctly. Amazon SQS\n URL-decodes the message before creating the MD5 digest. For information about MD5, see\n RFC1321.
" - } - }, - "MessageAttributes": { - "target": "com.amazonaws.sqs#MessageBodyAttributeMap", - "traits": { - "smithy.api#documentation": "Each message attribute consists of a Name
, Type
, and\n Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer\n Guide.
An Amazon SQS message.
" + "smithy.api#enumValue": "ApproximateNumberOfMessagesDelayed" } - }, - "com.amazonaws.sqs#MessageAttributeName": { - "type": "string" - }, - "com.amazonaws.sqs#MessageAttributeNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.sqs#MessageAttributeName" + }, + "DelaySeconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DelaySeconds" } - }, - "com.amazonaws.sqs#MessageAttributeValue": { - "type": "structure", - "members": { - "StringValue": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters.
" - } - }, - "BinaryValue": { - "target": "com.amazonaws.sqs#Binary", - "traits": { - "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images.
" - } - }, - "StringListValues": { - "target": "com.amazonaws.sqs#StringList", - "traits": { - "smithy.api#documentation": "Not implemented. Reserved for future use.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "StringListValue" - } - }, - "BinaryListValues": { - "target": "com.amazonaws.sqs#BinaryList", - "traits": { - "smithy.api#documentation": "Not implemented. Reserved for future use.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "BinaryListValue" - } - }, - "DataType": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "Amazon SQS supports the following logical data types: String
,\n Number
, and Binary
. For the Number
data type,\n you must use StringValue
.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.
", - "smithy.api#required": {} - } - } - }, + }, + "ReceiveMessageWaitTimeSeconds": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The user-specified message attribute value. For string data types, the\n Value
attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.
\n
\n Name
, type
, value
and the message body must not\n be empty or null. All parts of the message attribute, including Name
,\n Type
, and Value
, are part of the message size restriction\n (256 KiB or 262,144 bytes).
The specified message isn't in flight.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#enumValue": "KmsMasterKeyId" } - }, - "com.amazonaws.sqs#MessageSystemAttributeMap": { - "type": "map", - "key": { - "target": "com.amazonaws.sqs#MessageSystemAttributeName", - "traits": { - "smithy.api#xmlName": "Name" - } - }, - "value": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#xmlName": "Value" - } + }, + "KmsDataKeyReusePeriodSeconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsDataKeyReusePeriodSeconds" } - }, - "com.amazonaws.sqs#MessageSystemAttributeName": { - "type": "enum", - "members": { - "SenderId": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SenderId" - } - }, - "SentTimestamp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SentTimestamp" - } - }, - "ApproximateReceiveCount": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ApproximateReceiveCount" - } - }, - "ApproximateFirstReceiveTimestamp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ApproximateFirstReceiveTimestamp" - } - }, - "SequenceNumber": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SequenceNumber" - } - }, - "MessageDeduplicationId": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MessageDeduplicationId" - } - }, - "MessageGroupId": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MessageGroupId" - } - }, - "AWSTraceHeader": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWSTraceHeader" - } - }, - "DeadLetterQueueSourceArn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeadLetterQueueSourceArn" - } - } + }, + "DeduplicationScope": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeduplicationScope" } - }, - "com.amazonaws.sqs#MessageSystemAttributeNameForSends": { - "type": "enum", - "members": { - "AWSTraceHeader": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWSTraceHeader" - } - } + }, + "FifoThroughputLimit": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FifoThroughputLimit" } - }, - "com.amazonaws.sqs#MessageSystemAttributeValue": { - "type": "structure", - "members": { - "StringValue": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters.
" - } - }, - "BinaryValue": { - "target": "com.amazonaws.sqs#Binary", - "traits": { - "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images.
" - } - }, - "StringListValues": { - "target": "com.amazonaws.sqs#StringList", - "traits": { - "smithy.api#documentation": "Not implemented. Reserved for future use.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "StringListValue" - } - }, - "BinaryListValues": { - "target": "com.amazonaws.sqs#BinaryList", - "traits": { - "smithy.api#documentation": "Not implemented. Reserved for future use.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "BinaryListValue" - } - }, - "DataType": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "Amazon SQS supports the following logical data types: String
,\n Number
, and Binary
. For the Number
data type,\n you must use StringValue
.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.
", - "smithy.api#required": {} - } - } - }, + }, + "RedriveAllowPolicy": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The user-specified message system attribute value. For string data types, the\n Value
attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.
\n
\n Name
, type
, value
and the message body must not\n be empty or null.
The specified action violates a limit. For example, ReceiveMessage
\n returns this error if the maximum number of in flight messages is reached and\n AddPermission
returns this error if the maximum number of permissions\n for the queue is reached.
You must wait 60 seconds after deleting a queue before you can create another queue\n with the same name.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#QueueDoesNotExist": { + "type": "structure", + "members": {}, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.NonExistentQueue", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The specified queue doesn't exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#QueueNameExists": { + "type": "structure", + "members": {}, + "traits": { + "aws.protocols#awsQueryError": { + "code": "QueueAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "A queue with this name already exists. Amazon SQS returns this error only if the request\n includes attributes whose values differ from those of the existing queue.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#QueueUrlList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#String" + } + }, + "com.amazonaws.sqs#ReceiptHandleIsInvalid": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The specified receipt handle isn't valid.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.sqs#ReceiveMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ReceiveMessageRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ReceiveMessageResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#OverLimit" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves one or more messages (up to 10), from the specified queue. Using the\n WaitTimeSeconds
parameter enables long-poll support. For more\n information, see Amazon SQS\n Long Polling in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled\n on a ReceiveMessage
call. Thus, only the messages on the sampled machines\n are returned. If the number of messages in the queue is small (fewer than 1,000), you\n most likely get fewer messages than you requested per ReceiveMessage
call.\n If the number of messages in the queue is extremely small, you might not receive any\n messages in a particular ReceiveMessage
response. If this happens, repeat\n the request.
For each message returned, the response includes the following:
\nThe message body.
\nAn MD5 digest of the message body. For information about MD5, see RFC1321.
\nThe MessageId
you received when you sent the message to the\n queue.
The receipt handle.
\nThe message attributes.
\nAn MD5 digest of the message attributes.
\nThe receipt handle is the identifier you must provide when deleting the message. For\n more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.
\nYou can provide the VisibilityTimeout
parameter in your request. The\n parameter is applied to the messages that Amazon SQS returns in the response. If you don't\n include the parameter, the overall visibility timeout for the queue is used for the\n returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
A message that isn't deleted or a message whose visibility isn't extended before the\n visibility timeout expires counts as a failed receive. Depending on the configuration of\n the queue, the message might be sent to the dead-letter queue.
\nIn the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nDeletes available messages in a queue (including in-flight messages) specified by the\n QueueURL
parameter.
When you use the PurgeQueue
action, you can't retrieve any messages\n deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for 60\n seconds regardless of your queue's size.
\nMessages sent to the queue before you call\n PurgeQueue
might be received but are deleted within the next\n minute.
Messages sent to the queue after you call PurgeQueue
\n might be deleted while the queue is being purged.
The URL of the Amazon SQS queue from which messages are received.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#PurgeQueueInProgress": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, + }, + "AttributeNames": { + "target": "com.amazonaws.sqs#AttributeNameList", "traits": { - "aws.protocols#awsQueryError": { - "code": "AWS.SimpleQueueService.PurgeQueueInProgress", - "httpResponseCode": 403 - }, - "smithy.api#documentation": "Indicates that the specified queue previously received a PurgeQueue
\n request within the last 60 seconds (the time it can take to delete the messages in the\n queue).
A list of attributes that need to be returned along with each message. These\n attributes include:
\n\n All
– Returns all values.
\n ApproximateFirstReceiveTimestamp
– Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).
\n ApproximateReceiveCount
– Returns the number of times a\n message has been received across all queues but not deleted.
\n AWSTraceHeader
– Returns the X-Ray trace\n header string.
\n SenderId
\n
For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R
.
For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456
.
\n SentTimestamp
– Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).
\n SqsManagedSseEnabled
– Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
\n MessageDeduplicationId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
\n action.
\n MessageGroupId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
action.\n Messages with the same MessageGroupId
are returned in\n sequence.
\n SequenceNumber
– Returns the value provided by\n Amazon SQS.
The URL of the queue from which the PurgeQueue
action deletes\n messages.
Queue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - } - }, + }, + "MessageAttributeNames": { + "target": "com.amazonaws.sqs#MessageAttributeNameList", "traits": { - "smithy.api#documentation": "", - "smithy.api#input": {} + "smithy.api#documentation": "The name of the message attribute, where N is the index.
\nThe name can contain alphanumeric characters and the underscore\n (_
), hyphen (-
), and period\n (.
).
The name is case-sensitive and must be unique among all attribute names for\n the message.
\nThe name must not start with AWS-reserved prefixes such as AWS.
\n or Amazon.
(or any casing variants).
The name must not start or end with a period (.
), and it should\n not have periods in succession (..
).
The name can be up to 256 characters long.
\nWhen using ReceiveMessage
, you can send a list of attribute names to\n receive, or you can return all of the attributes by specifying All
or\n .*
in your request. You can also use all message attributes starting\n with a prefix, for example bar.*
.
The maximum number of messages to return. Amazon SQS never returns more messages than this\n value (however, fewer messages might be returned). Valid values: 1 to 10. Default:\n 1.
" } - }, - "com.amazonaws.sqs#QueueAttributeName": { - "type": "enum", - "members": { - "All": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "All" - } - }, - "Policy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Policy" - } - }, - "VisibilityTimeout": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VisibilityTimeout" - } - }, - "MaximumMessageSize": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MaximumMessageSize" - } - }, - "MessageRetentionPeriod": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MessageRetentionPeriod" - } - }, - "ApproximateNumberOfMessages": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ApproximateNumberOfMessages" - } - }, - "ApproximateNumberOfMessagesNotVisible": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ApproximateNumberOfMessagesNotVisible" - } - }, - "CreatedTimestamp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreatedTimestamp" - } - }, - "LastModifiedTimestamp": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LastModifiedTimestamp" - } - }, - "QueueArn": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QueueArn" - } - }, - "ApproximateNumberOfMessagesDelayed": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ApproximateNumberOfMessagesDelayed" - } - }, - "DelaySeconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DelaySeconds" - } - }, - "ReceiveMessageWaitTimeSeconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ReceiveMessageWaitTimeSeconds" - } - }, - "RedrivePolicy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RedrivePolicy" - } - }, - "FifoQueue": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FifoQueue" - } - }, - "ContentBasedDeduplication": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ContentBasedDeduplication" - } - }, - "KmsMasterKeyId": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KmsMasterKeyId" - } - }, - "KmsDataKeyReusePeriodSeconds": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "KmsDataKeyReusePeriodSeconds" - } - }, - "DeduplicationScope": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DeduplicationScope" - } - }, - "FifoThroughputLimit": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FifoThroughputLimit" - } - }, - "RedriveAllowPolicy": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RedriveAllowPolicy" - } - }, - "SqsManagedSseEnabled": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SqsManagedSseEnabled" - } - } + }, + "VisibilityTimeout": { + "target": "com.amazonaws.sqs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The duration (in seconds) that the received messages are hidden from subsequent\n retrieve requests after being retrieved by a ReceiveMessage
request.
You must wait 60 seconds after deleting a queue before you can create another queue\n with the same name.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#default": 0, + "smithy.api#documentation": "The duration (in seconds) for which the call waits for a message to arrive in the\n queue before returning. If a message is available, the call returns sooner than\n WaitTimeSeconds
. If no messages are available and the wait time\n expires, the call returns successfully with an empty list of messages.
To avoid HTTP errors, ensure that the HTTP response timeout for\n ReceiveMessage
requests is longer than the\n WaitTimeSeconds
parameter. For example, with the Java SDK, you can\n set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
The specified queue doesn't exist.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#documentation": "This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of ReceiveMessage
calls. If a networking\n issue occurs after a ReceiveMessage
action, and instead of a response you\n receive a generic error, it is possible to retry the same action with an identical\n ReceiveRequestAttemptId
to retrieve the same set of messages, even if\n their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId
only for 5 minutes after a\n ReceiveMessage
action.
When you set FifoQueue
, a caller of the\n ReceiveMessage
action can provide a\n ReceiveRequestAttemptId
explicitly.
If a caller of the ReceiveMessage
action doesn't provide a\n ReceiveRequestAttemptId
, Amazon SQS generates a\n ReceiveRequestAttemptId
.
It is possible to retry the ReceiveMessage
action with the same\n ReceiveRequestAttemptId
if none of the messages have been\n modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same\n ReceiveRequestAttemptId
return the same messages and receipt\n handles. If a retry occurs within the deduplication interval, it resets the\n visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
If a caller of the ReceiveMessage
action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe\n threshold before the visibility timeout expires and extend the visibility\n timeout as necessary.
\nWhile messages with a particular MessageGroupId
are invisible, no\n more messages belonging to the same MessageGroupId
are returned\n until the visibility timeout expires. You can still receive messages with\n another MessageGroupId
as long as it is also visible.
If a caller of ReceiveMessage
can't track the\n ReceiveRequestAttemptId
, no retries work until the original\n visibility timeout expires. As a result, delays might occur but the messages in\n the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId
is 128 characters.\n ReceiveRequestAttemptId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).
For best practices of using ReceiveRequestAttemptId
, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS\n Developer Guide.
A list of messages.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Message" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of received messages.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#RemovePermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#RemovePermissionRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Revokes any permissions in the queue policy that matches the specified\n Label
parameter.
Only the owner of a queue can remove permissions from it.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission
, RemovePermission
, and SetQueueAttributes
actions in your IAM policy.
A queue with this name already exists. Amazon SQS returns this error only if the\n request includes attributes whose values differ from those of the existing queue.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#documentation": "The URL of the Amazon SQS queue from which permissions are removed.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#QueueUrlList": { - "type": "list", - "member": { - "target": "com.amazonaws.sqs#String" + }, + "Label": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The identification of the permission to remove. This is the label added using the\n \n AddPermission\n
action.
One or more specified resources don't exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.sqs#SendMessage": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#SendMessageRequest" + }, + "output": { + "target": "com.amazonaws.sqs#SendMessageResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidMessageContents" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "Delivers a message to the specified queue.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nYou can use SendMessageBatch
to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage.
For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.
The result of sending each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200
.
The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144\n bytes).
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nIf you don't specify the DelaySeconds
parameter for an entry, Amazon SQS uses\n the default value for the queue.
The URL of the Amazon SQS queue to which batched messages are sent.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "Entries": { + "target": "com.amazonaws.sqs#SendMessageBatchRequestEntryList", + "traits": { + "smithy.api#documentation": "A list of \n SendMessageBatchRequestEntry\n
items.
The specified receipt handle isn't valid.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 + "smithy.api#documentation": "An identifier for a message in this batch used to communicate the result.
\nThe 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 (_).
\nRetrieves one or more messages (up to 10), from the specified queue. Using the\n WaitTimeSeconds
parameter enables long-poll support. For more\n information, see Amazon\n SQS Long Polling in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled\n on a ReceiveMessage
call. Thus, only the messages on the sampled machines\n are returned. If the number of messages in the queue is small (fewer than 1,000), you\n most likely get fewer messages than you requested per ReceiveMessage
call.\n If the number of messages in the queue is extremely small, you might not receive any\n messages in a particular ReceiveMessage
response. If this happens, repeat\n the request.
For each message returned, the response includes the following:
\nThe message body.
\nAn MD5 digest of the message body. For information about MD5, see RFC1321.
\nThe MessageId
you received when you sent the message to the\n queue.
The receipt handle.
\nThe message attributes.
\nAn MD5 digest of the message attributes.
\nThe receipt handle is the identifier you must provide when deleting the message. For\n more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.
\nYou can provide the VisibilityTimeout
parameter in your request. The\n parameter is applied to the messages that Amazon SQS returns in the response. If you\n don't include the parameter, the overall visibility timeout for the queue is used for\n the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
A message that isn't deleted or a message whose visibility isn't extended before the\n visibility timeout expires counts as a failed receive. Depending on the configuration of\n the queue, the message might be sent to the dead-letter queue.
\nIn the future, new attributes might be added. If you write code that calls this\n action, we recommend that you structure your code so that it can handle new\n attributes gracefully.
\nThe body of the message.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#ReceiveMessageRequest": { - "type": "structure", - "members": { - "QueueUrl": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The URL of the Amazon SQS queue from which messages are received.
\nQueue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "AttributeNames": { - "target": "com.amazonaws.sqs#AttributeNameList", - "traits": { - "smithy.api#documentation": "A list of attributes that need to be returned along with each message. These\n attributes include:
\n\n All
– Returns all values.
\n ApproximateFirstReceiveTimestamp
– Returns the time the message was\n first received from the queue (epoch time in\n milliseconds).
\n ApproximateReceiveCount
– Returns the number of times a message has\n been received across all queues but not deleted.
\n AWSTraceHeader
– Returns the X-Ray trace header\n string.
\n SenderId
\n
For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R
.
For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456
.
\n SentTimestamp
– Returns the time the message was sent to the queue\n (epoch time in\n milliseconds).
\n SqsManagedSseEnabled
– Enables server-side queue encryption using\n SQS owned encryption keys. Only one server-side encryption option is supported\n per queue (for example, SSE-KMS or SSE-SQS).
\n MessageDeduplicationId
– Returns the value provided by the\n producer that calls the \n SendMessage\n
\n action.
\n MessageGroupId
– Returns the value provided by the producer that\n calls the \n SendMessage\n
action. Messages with the\n same MessageGroupId
are returned in sequence.
\n SequenceNumber
– Returns the value provided by Amazon SQS.
The name of the message attribute, where N is the index.
\nThe name can contain alphanumeric characters and the underscore\n (_
), hyphen (-
), and period\n (.
).
The name is case-sensitive and must be unique among all attribute names for\n the message.
\nThe name must not start with AWS-reserved prefixes such as AWS.
\n or Amazon.
(or any casing variants).
The name must not start or end with a period (.
), and it should\n not have periods in succession (..
).
The name can be up to 256 characters long.
\nWhen using ReceiveMessage
, you can send a list of attribute names to\n receive, or you can return all of the attributes by specifying All
or\n .*
in your request. You can also use all message attributes starting\n with a prefix, for example bar.*
.
The maximum number of messages to return. Amazon SQS never returns more messages than\n this value (however, fewer messages might be returned). Valid values: 1 to 10. Default:\n 1.
" - } - }, - "VisibilityTimeout": { - "target": "com.amazonaws.sqs#NullableInteger", - "traits": { - "smithy.api#documentation": "The duration (in seconds) that the received messages are hidden from subsequent\n retrieve requests after being retrieved by a ReceiveMessage
request.
The duration (in seconds) for which the call waits for a message to arrive in the\n queue before returning. If a message is available, the call returns sooner than\n WaitTimeSeconds
. If no messages are available and the wait time\n expires, the call returns successfully with an empty list of messages.
To avoid HTTP errors, ensure that the HTTP response timeout for\n ReceiveMessage
requests is longer than the\n WaitTimeSeconds
parameter. For example, with the Java SDK, you can\n set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of ReceiveMessage
calls. If a networking\n issue occurs after a ReceiveMessage
action, and instead of a response you\n receive a generic error, it is possible to retry the same action with an identical\n ReceiveRequestAttemptId
to retrieve the same set of messages, even if\n their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId
only for 5 minutes after a\n ReceiveMessage
action.
When you set FifoQueue
, a caller of the\n ReceiveMessage
action can provide a\n ReceiveRequestAttemptId
explicitly.
If a caller of the ReceiveMessage
action doesn't provide a\n ReceiveRequestAttemptId
, Amazon SQS generates a\n ReceiveRequestAttemptId
.
It is possible to retry the ReceiveMessage
action with the same\n ReceiveRequestAttemptId
if none of the messages have been\n modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same\n ReceiveRequestAttemptId
return the same messages and receipt\n handles. If a retry occurs within the deduplication interval, it resets the\n visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
If a caller of the ReceiveMessage
action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe\n threshold before the visibility timeout expires and extend the visibility\n timeout as necessary.
\nWhile messages with a particular MessageGroupId
are invisible, no\n more messages belonging to the same MessageGroupId
are returned\n until the visibility timeout expires. You can still receive messages with\n another MessageGroupId
as long as it is also visible.
If a caller of ReceiveMessage
can't track the\n ReceiveRequestAttemptId
, no retries work until the original\n visibility timeout expires. As a result, delays might occur but the messages in\n the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId
is 128 characters.\n ReceiveRequestAttemptId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).
For best practices of using ReceiveRequestAttemptId
, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon\n SQS Developer Guide.
The length of time, in seconds, for which a specific message is delayed. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds
value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue is applied.
When you set FifoQueue
, you can't set DelaySeconds
per message. You can set this parameter only on a queue level.
A list of messages.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Message" - } - } - }, + }, + "MessageAttributes": { + "target": "com.amazonaws.sqs#MessageBodyAttributeMap", "traits": { - "smithy.api#documentation": "A list of received messages.
", - "smithy.api#output": {} + "smithy.api#documentation": "Each message attribute consists of a Name
, Type
, \nand Value
. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.
Revokes any permissions in the queue policy that matches the specified\n Label
parameter.
Only the owner of a queue can remove permissions from it.
\nCross-account permissions don't apply to this action. For more\n information, see Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny\n permission to the AddPermission
, RemovePermission
,\n and SetQueueAttributes
actions in your IAM policy.
The message system attribute to send Each message system attribute consists of a Name
, Type
, and Value
.
Currently, the only supported message system attribute is AWSTraceHeader
.\n Its type must be String
and its value must be a correctly formatted\n X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
\nThe URL of the Amazon SQS queue from which permissions are removed.
\nQueue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "Label": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The identification of the permission to remove. This is the label added using the\n \n AddPermission\n
action.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of messages within a 5-minute minimum deduplication\n interval. If a message with a particular MessageDeduplicationId
is sent\n successfully, subsequent messages with the same MessageDeduplicationId
are\n accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a MessageDeduplicationId
\n and you enable ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the\n queue doesn't have ContentBasedDeduplication
set, the\n action fails with an error.
If the queue has ContentBasedDeduplication
set, your\n MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled\n and then another message with a MessageDeduplicationId
that is the\n same as the one generated for the first MessageDeduplicationId
, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.
The MessageDeduplicationId
is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId
after the deduplication\n interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
\nThe length of MessageDeduplicationId
is 128 characters.\n MessageDeduplicationId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.
The request was denied due to request throttling.
\nThe rate of requests per second exceeds the Amazon Web Services KMS request quota for an\n account and Region.
\nA burst or sustained high rate of requests to change the state of the same KMS\n key. This condition is often known as a \"hot key.\"
\nRequests for operations on KMS keys in a Amazon Web Services CloudHSM key store\n might be throttled at a lower-than-expected rate when the Amazon Web Services\n CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is\n processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
\nThis parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId
values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId
with a message. If\n you don't provide a MessageGroupId
, the action fails.
\n ReceiveMessage
might return messages with multiple\n MessageGroupId
values. For each MessageGroupId
,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId
.
The length of MessageGroupId
is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.
\n MessageGroupId
is required for FIFO queues. You can't use it for\n Standard queues.
Contains the details of a single Amazon SQS message along with an Id
.
A list of \n SendMessageBatchResultEntry\n
items.
A list of \n BatchResultErrorEntry\n
items with error\n details about each message that can't be enqueued.
For each message in the batch, the response contains a \n SendMessageBatchResultEntry\n
tag if the message succeeds or a\n \n BatchResultErrorEntry\n
tag if the message\n fails.
One or more specified resources don't exist.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 + "smithy.api#documentation": "An identifier for the message in this batch.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#SendMessage": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#SendMessageRequest" - }, - "output": { - "target": "com.amazonaws.sqs#SendMessageResult" - }, - "errors": [ - { - "target": "com.amazonaws.sqs#InvalidAddress" - }, - { - "target": "com.amazonaws.sqs#InvalidMessageContents" - }, - { - "target": "com.amazonaws.sqs#InvalidSecurity" - }, - { - "target": "com.amazonaws.sqs#KmsAccessDenied" - }, - { - "target": "com.amazonaws.sqs#KmsDisabled" - }, - { - "target": "com.amazonaws.sqs#KmsInvalidKeyUsage" - }, - { - "target": "com.amazonaws.sqs#KmsInvalidState" - }, - { - "target": "com.amazonaws.sqs#KmsNotFound" - }, - { - "target": "com.amazonaws.sqs#KmsOptInRequired" - }, - { - "target": "com.amazonaws.sqs#KmsThrottled" - }, - { - "target": "com.amazonaws.sqs#QueueDoesNotExist" - }, - { - "target": "com.amazonaws.sqs#RequestThrottled" - }, - { - "target": "com.amazonaws.sqs#UnsupportedOperation" - } - ], + }, + "MessageId": { + "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "Delivers a message to the specified queue.
\nA message can include only XML, JSON, and unformatted text. The following Unicode\n characters are allowed:
\n\n #x9
| #xA
| #xD
| #x20
to\n #xD7FF
| #xE000
to #xFFFD
|\n #x10000
to #x10FFFF
\n
Any characters not included in this list will be rejected. For more information,\n see the W3C specification for\n characters.
\nAn identifier for the message.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#SendMessageBatch": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#SendMessageBatchRequest" - }, - "output": { - "target": "com.amazonaws.sqs#SendMessageBatchResult" - }, - "errors": [ - { - "target": "com.amazonaws.sqs#BatchEntryIdsNotDistinct" - }, - { - "target": "com.amazonaws.sqs#BatchRequestTooLong" - }, - { - "target": "com.amazonaws.sqs#EmptyBatchRequest" - }, - { - "target": "com.amazonaws.sqs#InvalidAddress" - }, - { - "target": "com.amazonaws.sqs#InvalidBatchEntryId" - }, - { - "target": "com.amazonaws.sqs#InvalidSecurity" - }, - { - "target": "com.amazonaws.sqs#KmsAccessDenied" - }, - { - "target": "com.amazonaws.sqs#KmsDisabled" - }, - { - "target": "com.amazonaws.sqs#KmsInvalidKeyUsage" - }, - { - "target": "com.amazonaws.sqs#KmsInvalidState" - }, - { - "target": "com.amazonaws.sqs#KmsNotFound" - }, - { - "target": "com.amazonaws.sqs#KmsOptInRequired" - }, - { - "target": "com.amazonaws.sqs#KmsThrottled" - }, - { - "target": "com.amazonaws.sqs#QueueDoesNotExist" - }, - { - "target": "com.amazonaws.sqs#RequestThrottled" - }, - { - "target": "com.amazonaws.sqs#TooManyEntriesInBatchRequest" - }, - { - "target": "com.amazonaws.sqs#UnsupportedOperation" - } - ], + }, + "MD5OfMessageBody": { + "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "You can use SendMessageBatch
to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage.
For a FIFO queue, multiple messages within a single batch are enqueued in\n the order they are sent.
The result of sending each message is reported individually in the response. Because\n the batch request can result in a combination of successful and unsuccessful actions,\n you should check for batch errors even when the call returns an HTTP status code of\n 200
.
The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144\n bytes).
\nA message can include only XML, JSON, and unformatted text. The following Unicode\n characters are allowed:
\n\n #x9
| #xA
| #xD
| #x20
to\n #xD7FF
| #xE000
to #xFFFD
|\n #x10000
to #x10FFFF
\n
Any characters not included in this list will be rejected. For more information,\n see the W3C specification for\n characters.
\nIf you don't specify the DelaySeconds
parameter for an entry, Amazon SQS\n uses the default value for the queue.
An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#SendMessageBatchRequest": { - "type": "structure", - "members": { - "QueueUrl": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The URL of the Amazon SQS queue to which batched messages are sent.
\nQueue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "Entries": { - "target": "com.amazonaws.sqs#SendMessageBatchRequestEntryList", - "traits": { - "smithy.api#documentation": "A list of \n SendMessageBatchRequestEntry\n
items.
An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" } - }, - "com.amazonaws.sqs#SendMessageBatchRequestEntry": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An identifier for a message in this batch used to communicate the result.
\nThe 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\n accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nThe body of the message.
", - "smithy.api#required": {} - } - }, - "DelaySeconds": { - "target": "com.amazonaws.sqs#NullableInteger", - "traits": { - "smithy.api#documentation": "The length of time, in seconds, for which a specific message is delayed. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds
value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue is applied.
When you set FifoQueue
, you can't set DelaySeconds
per\n message. You can set this parameter only on a queue level.
Each message attribute consists of a Name
, Type
, and\n Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer\n Guide.
The message system attribute to send Each message system attribute consists of a\n Name
, Type
, and Value
.
Currently, the only supported message system attribute is\n AWSTraceHeader
. Its type must be String
and\n its value must be a correctly formatted X-Ray trace\n header string.
The size of a message system attribute doesn't count towards the total\n size of a message.
\nThis parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of messages within a 5-minute minimum deduplication\n interval. If a message with a particular MessageDeduplicationId
is sent\n successfully, subsequent messages with the same MessageDeduplicationId
are\n accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a MessageDeduplicationId
\n and you enable ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the\n queue doesn't have ContentBasedDeduplication
set, the\n action fails with an error.
If the queue has ContentBasedDeduplication
set, your\n MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled\n and then another message with a MessageDeduplicationId
that is the\n same as the one generated for the first MessageDeduplicationId
, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.
The MessageDeduplicationId
is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId
after the deduplication\n interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the\n message is received and deleted.
\nThe length of MessageDeduplicationId
is 128 characters.\n MessageDeduplicationId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS\n Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however, messages\n in different message groups might be processed out of order). To interleave multiple\n ordered streams within a single queue, use MessageGroupId
values (for\n example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId
with a message. If\n you don't provide a MessageGroupId
, the action fails.
\n ReceiveMessage
might return messages with multiple\n MessageGroupId
values. For each MessageGroupId
,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId
.
The length of MessageGroupId
is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.
\n MessageGroupId
is required for FIFO queues. You can't use it for\n Standard queues.
Contains the details of a single Amazon SQS message along with an\n Id
.
An MD5 digest of the non-URL-encoded message system attribute string. You can use this \nattribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" } - }, - "com.amazonaws.sqs#SendMessageBatchRequestEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.sqs#SendMessageBatchRequestEntry" + }, + "SequenceNumber": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "This parameter applies only to FIFO (first-in-first-out) queues.
\nThe large, non-consecutive number that Amazon SQS assigns to each message.
\nThe length of SequenceNumber
is 128 bits. As SequenceNumber
\n continues to increase for a particular MessageGroupId
.
A list of \n SendMessageBatchResultEntry\n
items.
A list of \n BatchResultErrorEntry\n
items with error\n details about each message that can't be enqueued.
Encloses a MessageId
for a successfully-enqueued message in a \n SendMessageBatch.
\n
For each message in the batch, the response contains a \n SendMessageBatchResultEntry\n
tag if the message succeeds or a\n \n BatchResultErrorEntry\n
tag if the message\n fails.
The URL of the Amazon SQS queue to which a message is sent.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#SendMessageBatchResultEntry": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An identifier for the message in this batch.
", - "smithy.api#required": {} - } - }, - "MessageId": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An identifier for the message.
", - "smithy.api#required": {} - } - }, - "MD5OfMessageBody": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message body string. You can use this attribute\n to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the\n message before creating the MD5 digest. For information about MD5, see RFC1321.
", - "smithy.api#required": {} - } - }, - "MD5OfMessageAttributes": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message attribute string. You can use this\n attribute to verify that Amazon SQS received the message correctly. Amazon SQS\n URL-decodes the message before creating the MD5 digest. For information about MD5, see\n RFC1321.
" - } - }, - "MD5OfMessageSystemAttributes": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message system attribute string. You can use this\n attribute to verify that Amazon SQS received the message correctly. Amazon SQS\n URL-decodes the message before creating the MD5 digest. For information about MD5, see\n RFC1321.
" - } - }, - "SequenceNumber": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "This parameter applies only to FIFO (first-in-first-out) queues.
\nThe large, non-consecutive number that Amazon SQS assigns to each message.
\nThe length of SequenceNumber
is 128 bits. As SequenceNumber
\n continues to increase for a particular MessageGroupId
.
Encloses a MessageId
for a successfully-enqueued message in a \n SendMessageBatch.
\n
The message to send. The minimum size is one character. The maximum size is 256\n KiB.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9
| #xA
| #xD
| #x20
to #xD7FF
| #xE000
to #xFFFD
| #x10000
to #x10FFFF
\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\n The length of time, in seconds, for which to delay a specific message. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds
value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue applies.
When you set FifoQueue
, you can't set DelaySeconds
per message. You can set this parameter only on a queue level.
The URL of the Amazon SQS queue to which a message is sent.
\nQueue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "MessageBody": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The message to send. The minimum size is one character. The maximum size is 256\n KiB.
\nA message can include only XML, JSON, and unformatted text. The following Unicode\n characters are allowed:
\n\n #x9
| #xA
| #xD
| #x20
to\n #xD7FF
| #xE000
to #xFFFD
|\n #x10000
to #x10FFFF
\n
Any characters not included in this list will be rejected. For more information,\n see the W3C specification for\n characters.
\n The length of time, in seconds, for which to delay a specific message. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds
value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue applies.
When you set FifoQueue
, you can't set DelaySeconds
per\n message. You can set this parameter only on a queue level.
Each message attribute consists of a Name
, Type
, and\n Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer\n Guide.
The message system attribute to send. Each message system attribute consists of a\n Name
, Type
, and Value
.
Currently, the only supported message system attribute is\n AWSTraceHeader
. Its type must be String
and\n its value must be a correctly formatted X-Ray trace\n header string.
The size of a message system attribute doesn't count towards the total\n size of a message.
\nThis parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of sent messages. If a message with a particular\n MessageDeduplicationId
is sent successfully, any messages sent with the\n same MessageDeduplicationId
are accepted successfully but aren't delivered\n during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a MessageDeduplicationId
\n and you enable ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the\n queue doesn't have ContentBasedDeduplication
set, the\n action fails with an error.
If the queue has ContentBasedDeduplication
set, your\n MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled\n and then another message with a MessageDeduplicationId
that is the\n same as the one generated for the first MessageDeduplicationId
, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.
The MessageDeduplicationId
is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId
after the deduplication\n interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the\n message is received and deleted.
\nThe maximum length of MessageDeduplicationId
is 128 characters.\n MessageDeduplicationId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS\n Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however, messages\n in different message groups might be processed out of order). To interleave multiple\n ordered streams within a single queue, use MessageGroupId
values (for\n example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId
with a message. If\n you don't provide a MessageGroupId
, the action fails.
\n ReceiveMessage
might return messages with multiple\n MessageGroupId
values. For each MessageGroupId
,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId
.
The length of MessageGroupId
is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.
\n MessageGroupId
is required for FIFO queues. You can't use it for\n Standard queues.
Each message attribute consists of a Name
, Type
, \nand Value
. For more information, see \nAmazon SQS \nmessage attributes in the Amazon SQS Developer Guide.
An MD5 digest of the non-URL-encoded message body string. You can use this attribute\n to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the\n message before creating the MD5 digest. For information about MD5, see RFC1321.
" - } - }, - "MD5OfMessageAttributes": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message attribute string. You can use this\n attribute to verify that Amazon SQS received the message correctly. Amazon SQS\n URL-decodes the message before creating the MD5 digest. For information about MD5, see\n RFC1321.
" - } - }, - "MD5OfMessageSystemAttributes": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message system attribute string. You can use this\n attribute to verify that Amazon SQS received the message correctly. Amazon SQS\n URL-decodes the message before creating the MD5 digest.
" - } - }, - "MessageId": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An attribute containing the MessageId
of the message sent to the queue.\n For more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe large, non-consecutive number that Amazon SQS assigns to each message.
\nThe length of SequenceNumber
is 128 bits. SequenceNumber
\n continues to increase for a particular MessageGroupId
.
The MD5OfMessageBody
and MessageId
elements.
The message system attribute to send. Each message system attribute consists of a Name
, Type
, and Value
.
Currently, the only supported message system attribute is AWSTraceHeader
.\n Its type must be String
and its value must be a correctly formatted\n X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
\nSets the value of one or more queue attributes. When you change a queue's attributes,\n the change can take up to 60 seconds for most of the attributes to propagate throughout\n the Amazon SQS system. Changes made to the MessageRetentionPeriod
attribute\n can take up to 15 minutes and will impact existing messages in the queue potentially\n causing them to be expired and deleted if the MessageRetentionPeriod
is\n reduced below the age of existing messages.
In the future, new attributes might be added. If you write code that calls\n this action, we recommend that you structure your code so that it can handle\n new attributes gracefully.
\nCross-account permissions don't apply to this action. For more\n information, see Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny\n permission to the AddPermission
, RemovePermission
,\n and SetQueueAttributes
actions in your IAM policy.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of sent messages. If a message with a particular\n MessageDeduplicationId
is sent successfully, any messages sent with the\n same MessageDeduplicationId
are accepted successfully but aren't delivered\n during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
Every message must have a unique MessageDeduplicationId
,
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a MessageDeduplicationId
\n and you enable ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the\n queue doesn't have ContentBasedDeduplication
set, the\n action fails with an error.
If the queue has ContentBasedDeduplication
set, your\n MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication
enabled\n and then another message with a MessageDeduplicationId
that is the\n same as the one generated for the first MessageDeduplicationId
, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.
The MessageDeduplicationId
is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId
after the deduplication\n interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
\nThe maximum length of MessageDeduplicationId
is 128 characters.\n MessageDeduplicationId
can contain alphanumeric characters\n (a-z
, A-Z
, 0-9
) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
).
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.
The URL of the Amazon SQS queue whose attributes are set.
\nQueue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - }, - "Attributes": { - "target": "com.amazonaws.sqs#QueueAttributeMap", - "traits": { - "smithy.api#documentation": "A map of attributes to set.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the SetQueueAttributes
action uses:
\n DelaySeconds
– The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 (15 minutes). Default: 0.
\n MaximumMessageSize
– The limit of how many bytes a message can\n contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
\n MessageRetentionPeriod
– The length of time, in seconds, for which\n Amazon SQS retains a message. Valid values: An integer representing seconds,\n from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to\n the MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.
\n Policy
– The queue's policy. A valid Amazon Web Services\n policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the\n Identity and Access Management User Guide.\n
\n ReceiveMessageWaitTimeSeconds
– The length of time, in seconds, for\n which a \n ReceiveMessage\n
action waits for a message\n to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.
\n VisibilityTimeout
– The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy
– The string that includes the parameters for the\n dead-letter queue functionality of the source queue as a JSON object. The\n parameters are as follows:
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of\n the dead-letter queue to which Amazon SQS moves messages after the value\n of maxReceiveCount
is exceeded.
\n maxReceiveCount
– The number of times a message is\n delivered to the source queue before being moved to the dead-letter\n queue. Default: 10. When the ReceiveCount
for a message\n exceeds the maxReceiveCount
for a queue, Amazon SQS moves\n the message to the dead-letter-queue.
\n RedriveAllowPolicy
– The string that includes the parameters for\n the permissions for the dead-letter queue redrive permission and which source\n queues can specify dead-letter queues as a JSON object. The parameters are as\n follows:
\n redrivePermission
– The permission type that defines\n which source queues can specify the current queue as the dead-letter\n queue. Valid values are:
\n allowAll
– (Default) Any source queues in this\n Amazon Web Services account in the same\n Region can specify this queue as the dead-letter queue.
\n denyAll
– No source queues can specify this queue\n as the dead-letter queue.
\n byQueue
– Only queues specified by the\n sourceQueueArns
parameter can specify this\n queue as the dead-letter queue.
\n sourceQueueArns
– The Amazon Resource Names (ARN)s of the\n source queues that can specify this queue as the dead-letter queue and\n redrive messages. You can specify this parameter only when the\n redrivePermission
parameter is set to\n byQueue
. You can specify up to 10 source queue ARNs. To\n allow more than 10 source queues to specify dead-letter queues, set the\n redrivePermission
parameter to\n allowAll
.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the\n dead-letter queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer\n master key (CMK) for Amazon SQS or a custom CMK. For more information, see\n Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is\n always alias/aws/sqs
, the alias of a custom CMK can, for example,\n be alias/MyAlias\n
. For more examples, see\n KeyId in the Key Management Service API\n Reference.
\n KmsDataKeyReusePeriodSeconds
– The length of time, in seconds, for\n which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer representing\n seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default:\n 300 (5 minutes). A shorter time period provides better security but results in\n more calls to KMS which might incur charges after Free Tier. For more\n information, see How Does the Data Key Reuse Period Work?.
\n SqsManagedSseEnabled
– Enables server-side queue encryption using\n SQS owned encryption keys. Only one server-side encryption option is supported\n per queue (for example, SSE-KMS or SSE-SQS).
The following attribute applies only to FIFO\n (first-in-first-out) queues:
\n\n ContentBasedDeduplication
– Enables content-based deduplication.\n For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:
Every message must have a unique\n MessageDeduplicationId
.
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a\n MessageDeduplicationId
and you enable\n ContentBasedDeduplication
for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the\n message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and\n the queue doesn't have ContentBasedDeduplication
\n set, the action fails with an error.
If the queue has ContentBasedDeduplication
set,\n your MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.
If you send one message with ContentBasedDeduplication
\n enabled and then another message with a\n MessageDeduplicationId
that is the same as the one\n generated for the first MessageDeduplicationId
, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.
The following attributes apply only to high\n throughput for FIFO queues:
\n\n DeduplicationScope
– Specifies whether message deduplication\n occurs at the message group or queue level. Valid values are\n messageGroup
and queue
.
\n FifoThroughputLimit
– Specifies whether the FIFO queue throughput\n quota applies to the entire queue or per message group. Valid values are\n perQueue
and perMessageGroupId
. The\n perMessageGroupId
value is allowed only when the value for\n DeduplicationScope
is messageGroup
.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope
to messageGroup
.
Set FifoThroughputLimit
to perMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, see Quotas\n related to messages in the Amazon SQS Developer\n Guide.
", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Attribute" - } - } - }, + }, + "MessageGroupId": { + "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "", - "smithy.api#input": {} + "smithy.api#documentation": "This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId
values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId
with a message. If\n you don't provide a MessageGroupId
, the action fails.
\n ReceiveMessage
might return messages with multiple\n MessageGroupId
values. For each MessageGroupId
,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId
.
The length of MessageGroupId
is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~)
.
For best practices of using MessageGroupId
, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.
\n MessageGroupId
is required for FIFO queues. You can't use it for\n Standard queues.
Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue.
\nThis action is currently limited to supporting message redrive from queues\n that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS\n queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are\n currently not supported.
\nIn dead-letter queues redrive context, the\n StartMessageMoveTask
the source queue is the DLQ, while the\n destination queue can be the original source queue (from which the messages\n were driven to the dead-letter-queue), or a custom destination queue.
Currently, only standard queues support redrive. FIFO queues don't support\n redrive.
\nOnly one active message movement task is supported per queue at any given\n time.
\nAn MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" } - }, - "com.amazonaws.sqs#StartMessageMoveTaskRequest": { - "type": "structure", - "members": { - "SourceArn": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The ARN of the queue that contains the messages to be moved to another queue.\n Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues\n are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are\n not currently supported.
", - "smithy.api#required": {} - } - }, - "DestinationArn": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The ARN of the queue that receives the moved messages. You can use this field to\n specify the destination queue where you would like to redrive messages. If this field is\n left blank, the messages will be redriven back to their respective original source\n queues.
" - } - }, - "MaxNumberOfMessagesPerSecond": { - "target": "com.amazonaws.sqs#NullableInteger", - "traits": { - "smithy.api#documentation": "The number of messages to be moved per second (the message movement rate). You can use\n this field to define a fixed message movement rate. The maximum value for messages per\n second is 500. If this field is left blank, the system will optimize the rate based on\n the queue message backlog size, which may vary throughout the duration of the message\n movement task.
" - } - } - }, + }, + "MD5OfMessageAttributes": { + "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
" } - }, - "com.amazonaws.sqs#StartMessageMoveTaskResult": { - "type": "structure", - "members": { - "TaskHandle": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "An identifier associated with a message movement task. You can use this identifier to\n cancel a specified message movement task using the CancelMessageMoveTask
\n action.
An MD5 digest of the non-URL-encoded message system attribute string. You can use this \nattribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.
" } - }, - "com.amazonaws.sqs#String": { - "type": "string" - }, - "com.amazonaws.sqs#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#xmlName": "StringListValue" - } + }, + "MessageId": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "An attribute containing the MessageId
of the message sent to the queue.\n For more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe large, non-consecutive number that Amazon SQS assigns to each message.
\nThe length of SequenceNumber
is 128 bits. SequenceNumber
\n continues to increase for a particular MessageGroupId
.
The MD5OfMessageBody
and MessageId
elements.
Sets the value of one or more queue attributes. When you change a queue's attributes,\n the change can take up to 60 seconds for most of the attributes to propagate throughout\n the Amazon SQS system. Changes made to the MessageRetentionPeriod
attribute can\n take up to 15 minutes and will impact existing messages in the queue potentially causing\n them to be expired and deleted if the MessageRetentionPeriod
is reduced\n below the age of existing messages.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission
, RemovePermission
, and SetQueueAttributes
actions in your IAM policy.
The URL of the Amazon SQS queue whose attributes are set.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.sqs#QueueAttributeMap", + "traits": { + "smithy.api#documentation": "A map of attributes to set.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the SetQueueAttributes
action uses:
\n DelaySeconds
– The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 (15 minutes). Default: 0.
\n MaximumMessageSize
– The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
\n MessageRetentionPeriod
– The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer representing seconds,\n from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod
attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod
is reduced below\n the age of existing messages.
\n Policy
– The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the Identity and Access Management User\n Guide.
\n ReceiveMessageWaitTimeSeconds
– The length of time, in\n seconds, for which a \n ReceiveMessage\n
action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.
\n VisibilityTimeout
– The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount
is exceeded.
\n maxReceiveCount
– The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
\n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy
– The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission
– The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll
– (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll
– No source queues can specify this queue as the dead-letter\n queue.
\n byQueue
– Only queues specified by the sourceQueueArns
parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns
– The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission
parameter is set to byQueue
. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission
parameter\n to allowAll
.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is\n always alias/aws/sqs
, the alias of a custom CMK can, for example,\n be alias/MyAlias\n
. For more examples, see\n KeyId in the Key Management Service API\n Reference.
\n KmsDataKeyReusePeriodSeconds
– The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?.
\n SqsManagedSseEnabled
– Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
The following attribute applies only to FIFO (first-in-first-out)\n queues:
\n\n ContentBasedDeduplication
– Enables content-based\n deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:
Every message must have a unique\n MessageDeduplicationId
.
You may provide a MessageDeduplicationId
\n explicitly.
If you aren't able to provide a\n MessageDeduplicationId
and you enable\n ContentBasedDeduplication
for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId
using the body of the\n message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId
and\n the queue doesn't have ContentBasedDeduplication
\n set, the action fails with an error.
If the queue has ContentBasedDeduplication
set,\n your MessageDeduplicationId
overrides the generated\n one.
When ContentBasedDeduplication
is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.
If you send one message with ContentBasedDeduplication
\n enabled and then another message with a\n MessageDeduplicationId
that is the same as the one\n generated for the first MessageDeduplicationId
, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope
– Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup
and queue
.
\n FifoThroughputLimit
– Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue
and perMessageGroupId
. \n The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope
to messageGroup
.
Set FifoThroughputLimit
to perMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Attribute" + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#StartMessageMoveTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#StartMessageMoveTaskRequest" + }, + "output": { + "target": "com.amazonaws.sqs#StartMessageMoveTaskResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue.
\nThis action is currently limited to supporting message redrive from queues\n that are configured as dead-letter queues (DLQs) of other Amazon SQS queues only. Non-SQS\n queue sources of dead-letter queues, such as Lambda or Amazon SNS topics, are\n currently not supported.
\nIn dead-letter queues redrive context, the\n StartMessageMoveTask
the source queue is the DLQ, while the\n destination queue can be the original source queue (from which the messages\n were driven to the dead-letter-queue), or a custom destination queue.
Currently, only standard queues support redrive. FIFO queues don't support\n redrive.
\nOnly one active message movement task is supported per queue at any given\n time.
\nThe ARN of the queue that contains the messages to be moved to another queue.\n Currently, only ARNs of dead-letter queues (DLQs) whose sources are other Amazon SQS queues\n are accepted. DLQs whose sources are non-SQS queues, such as Lambda or Amazon SNS topics, are\n not currently supported.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#TagQueue": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#TagQueueRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sqs#InvalidAddress" - }, - { - "target": "com.amazonaws.sqs#InvalidSecurity" - }, - { - "target": "com.amazonaws.sqs#QueueDoesNotExist" - }, - { - "target": "com.amazonaws.sqs#RequestThrottled" - }, - { - "target": "com.amazonaws.sqs#UnsupportedOperation" - } - ], + }, + "DestinationArn": { + "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "Add cost allocation tags to the specified Amazon SQS queue. For an overview, see\n Tagging\n Your Amazon SQS Queues in the Amazon SQS Developer\n Guide.
\nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character\n strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the\n existing tag.
\nFor a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer\n Guide.
\nCross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nThe ARN of the queue that receives the moved messages. You can use this field to\n specify the destination queue where you would like to redrive messages. If this field is\n left blank, the messages will be redriven back to their respective original source\n queues.
" } - }, - "com.amazonaws.sqs#TagQueueRequest": { - "type": "structure", - "members": { - "QueueUrl": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The URL of the queue.
", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.sqs#TagMap", - "traits": { - "smithy.api#documentation": "The list of tags to be added to the specified queue.
", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Tag" - } - } - }, + }, + "MaxNumberOfMessagesPerSecond": { + "target": "com.amazonaws.sqs#Integer", "traits": { - "smithy.api#input": {} + "smithy.api#default": 0, + "smithy.api#documentation": "The number of messages to be moved per second (the message movement rate). You can use\n this field to define a fixed message movement rate. The maximum value for messages per\n second is 500. If this field is left blank, the system will optimize the rate based on\n the queue message backlog size, which may vary throughout the duration of the message\n movement task.
" } + } }, - "com.amazonaws.sqs#TagValue": { - "type": "string" - }, - "com.amazonaws.sqs#TaskStatus": { - "type": "enum", - "members": { - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "CANCELLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLING" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - } + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#StartMessageMoveTaskResult": { + "type": "structure", + "members": { + "TaskHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "An identifier associated with a message movement task. You can use this identifier to\n cancel a specified message movement task using the CancelMessageMoveTask
\n action.
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the existing tag.
\nFor a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nThe batch request contains more entries than permissible.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#documentation": "The URL of the queue.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#UnsupportedOperation": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.sqs#ExceptionMessage" - } - }, + }, + "Tags": { + "target": "com.amazonaws.sqs#TagMap", "traits": { - "aws.protocols#awsQueryError": { - "code": "AWS.SimpleQueueService.UnsupportedOperation", - "httpResponseCode": 400 - }, - "smithy.api#documentation": "Error code 400. Unsupported operation.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#documentation": "The list of tags to be added to the specified queue.
", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tag" } + } }, - "com.amazonaws.sqs#UntagQueue": { - "type": "operation", - "input": { - "target": "com.amazonaws.sqs#UntagQueueRequest" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.sqs#InvalidAddress" - }, - { - "target": "com.amazonaws.sqs#InvalidSecurity" - }, - { - "target": "com.amazonaws.sqs#QueueDoesNotExist" - }, - { - "target": "com.amazonaws.sqs#RequestThrottled" - }, - { - "target": "com.amazonaws.sqs#UnsupportedOperation" - } - ], + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#TagValue": { + "type": "string" + }, + "com.amazonaws.sqs#Token": { + "type": "string" + }, + "com.amazonaws.sqs#TooManyEntriesInBatchRequest": { + "type": "structure", + "members": {}, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.TooManyEntriesInBatchRequest", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The batch request contains more entries than permissible.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#UnsupportedOperation": { + "type": "structure", + "members": {}, + "traits": { + "aws.protocols#awsQueryError": { + "code": "AWS.SimpleQueueService.UnsupportedOperation", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "Error code 400. Unsupported operation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#UntagQueue": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#UntagQueueRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "traits": { + "smithy.api#documentation": "Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nRemove cost allocation tags from the specified Amazon SQS queue. For an overview, see\n Tagging\n Your Amazon SQS Queues in the Amazon SQS Developer\n Guide.
\nCross-account permissions don't apply to this action. For more information, see\n Grant cross-account permissions to a role and a username in the\n Amazon SQS Developer Guide.
\nThe URL of the queue.
", + "smithy.api#required": {} } - }, - "com.amazonaws.sqs#UntagQueueRequest": { - "type": "structure", - "members": { - "QueueUrl": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#documentation": "The URL of the queue.
", - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.sqs#TagKeyList", - "traits": { - "smithy.api#documentation": "The list of tags to be removed from the specified queue.
", - "smithy.api#required": {}, - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "TagKey" - } - } - }, + }, + "TagKeys": { + "target": "com.amazonaws.sqs#TagKeyList", "traits": { - "smithy.api#input": {} + "smithy.api#documentation": "The list of tags to be removed from the specified queue.
", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "TagKey" } + } + }, + "traits": { + "smithy.api#input": {} } + } } -} \ No newline at end of file +} From f068d1abff9307379a47bb24f8aeb0782642d7ea Mon Sep 17 00:00:00 2001 From: George FuWelcome 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.
+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
@@ -60,8 +60,7 @@ perform tasks such as the following automatically:-Amazon SQS in the Command Line -Interface +Amazon SQS in the Command Line Interface
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.
+ *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
@@ -493,8 +493,7 @@ export interface SQS { *- * Amazon SQS in the Command Line - * Interface + * Amazon SQS in the Command Line Interface * *
*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.
+ *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
@@ -391,8 +391,7 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {} *- * Amazon SQS in the Command Line - * Interface + * Amazon SQS in the Command Line Interface * *
*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.
+ * about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS + * Developer Guide. *
* 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.
+ * policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in
+ * the Amazon SQS Developer Guide.
* An Amazon SQS policy can have a maximum of seven actions per - * statement.
+ *An Amazon SQS policy can have a maximum of 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.
Amazon SQS AddPermission
does not support adding a non-account
+ * principal.
Cross-account permissions don't apply to this action. For more information, see - * Grant cross-account permissions to a role and a username in the - * Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, + * see Grant + * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
*The accountId
is invalid.
When the request to a queue is not HTTPS and SigV4.
- * * @throws {@link 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 Amazon Web Services 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/CancelMessageMoveTaskCommand.ts b/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts index 60bcb167db684..f54d1420e169b 100644 --- a/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts +++ b/clients/client-sqs/src/commands/CancelMessageMoveTaskCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { CancelMessageMoveTaskRequest, CancelMessageMoveTaskResult } from "../models/models_0"; -import { de_CancelMessageMoveTaskCommand, se_CancelMessageMoveTaskCommand } from "../protocols/Aws_json1_0"; +import { de_CancelMessageMoveTaskCommand, se_CancelMessageMoveTaskCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -81,31 +81,6 @@ export interface CancelMessageMoveTaskCommandOutput extends CancelMessageMoveTas * @see {@link CancelMessageMoveTaskCommandOutput} 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 RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the Amazon Web Services 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.
- *One or more specified resources don't exist.
* diff --git a/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts b/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts index 80692a3bf288d..554412f981518 100644 --- a/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts +++ b/clients/client-sqs/src/commands/ChangeMessageVisibilityBatchCommand.ts @@ -15,10 +15,7 @@ import { } from "@smithy/types"; import { ChangeMessageVisibilityBatchRequest, ChangeMessageVisibilityBatchResult } from "../models/models_0"; -import { - de_ChangeMessageVisibilityBatchCommand, - se_ChangeMessageVisibilityBatchCommand, -} from "../protocols/Aws_json1_0"; +import { de_ChangeMessageVisibilityBatchCommand, se_ChangeMessageVisibilityBatchCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -51,9 +48,7 @@ export interface ChangeMessageVisibilityBatchCommandOutput * requests with each *ChangeMessageVisibilityBatch
action.
* Because the batch request can result in a combination of successful and
- * unsuccessful actions, you should check for batch errors even when the call returns
- * an HTTP status code of 200
.
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 batch request doesn't contain any entries.
* - * @throws {@link InvalidAddress} (client fault) - *The accountId
is invalid.
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 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 Amazon Web Services 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 6b5387bc4e4b6..be14f0c923564 100644 --- a/clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts +++ b/clients/client-sqs/src/commands/ChangeMessageVisibilityCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { ChangeMessageVisibilityRequest } from "../models/models_0"; -import { de_ChangeMessageVisibilityCommand, se_ChangeMessageVisibilityCommand } from "../protocols/Aws_json1_0"; +import { de_ChangeMessageVisibilityCommand, se_ChangeMessageVisibilityCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -60,23 +60,14 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer { *Deleted from the queue.
*A message is considered to be stored after it is sent to a queue - * by a producer, but not yet received from the queue by a consumer (that is, between - * states 1 and 2). There is no limit to the number of stored messages. A message is - * considered to be in flight after it is received from a queue by a - * consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is - * a limit to the number of in flight messages.
- *Limits that apply to in flight messages are unrelated to the - * unlimited number of stored messages.
- *For most standard queues (depending on queue traffic and message backlog), there can
- * be a maximum of approximately 120,000 in flight messages (received from a queue by a
- * consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS
- * returns the OverLimit
error message. To avoid reaching the limit, you
- * should delete messages from the queue after they're processed. You can also increase the
- * number of queues you use to process your messages. To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a - * queue by a consumer, but not yet deleted from the queue). If you reach this limit, - * Amazon SQS returns no error messages.
+ *A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. + * A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages.
+ *Limits that apply to in flight messages are unrelated to the unlimited number of stored messages.
+ *For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue).
+ * If you reach this limit, Amazon SQS returns the OverLimit
error message.
+ * To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.
+ * To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
*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
@@ -111,43 +102,12 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
* @see {@link ChangeMessageVisibilityCommandOutput} 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 MessageNotInflight} (client fault) *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 Amazon Web Services 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 f5f67442a7205..db5b5019a5d66 100644 --- a/clients/client-sqs/src/commands/CreateQueueCommand.ts +++ b/clients/client-sqs/src/commands/CreateQueueCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { CreateQueueRequest, CreateQueueResult } from "../models/models_0"; -import { de_CreateQueueCommand, se_CreateQueueCommand } from "../protocols/Aws_json1_0"; +import { de_CreateQueueCommand, se_CreateQueueCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -37,12 +37,11 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB /** * @public - *Creates a new standard or FIFO queue. You can pass one or more attributes in the - * request. Keep the following in mind:
+ *Creates a new standard or FIFO queue. You can pass one or more attributes in + * 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 @@ -86,9 +85,9 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB *
Cross-account permissions don't apply to this action. For more information, see - * Grant cross-account permissions to a role and a username in the - * Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, + * see Grant + * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
*The accountId
is invalid.
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.
* * @throws {@link QueueNameExists} (client fault) - *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 Amazon Web Services 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.
+ *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 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 7ab2e70faf2f6..d8b5168f4ea77 100644 --- a/clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts +++ b/clients/client-sqs/src/commands/DeleteMessageBatchCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { DeleteMessageBatchRequest, DeleteMessageBatchResult } from "../models/models_0"; -import { de_DeleteMessageBatchCommand, se_DeleteMessageBatchCommand } from "../protocols/Aws_json1_0"; +import { de_DeleteMessageBatchCommand, se_DeleteMessageBatchCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -42,9 +42,7 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul * 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
.
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 batch request doesn't contain any entries.
* - * @throws {@link InvalidAddress} (client fault) - *The accountId
is invalid.
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 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 Amazon Web Services 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 0113931564cd3..e8e087a8c5c3a 100644 --- a/clients/client-sqs/src/commands/DeleteMessageCommand.ts +++ b/clients/client-sqs/src/commands/DeleteMessageCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { DeleteMessageRequest } from "../models/models_0"; -import { de_DeleteMessageCommand, se_DeleteMessageCommand } from "../protocols/Aws_json1_0"; +import { de_DeleteMessageCommand, se_DeleteMessageCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -50,12 +50,12 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {} * When you use theDeleteMessage
action, you must provide the most
* recently received ReceiptHandle
for the message (otherwise, the request
* 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. The copy - * remains on the server and might be returned to you during a subsequent receive - * request. You should ensure that your application is idempotent, so that receiving a - * message more than once does not cause issues.
+ *For standard queues, it is possible to receive a message even after you + * delete it. This might happen on rare occasions if one of the servers which stores a + * copy of the message is unavailable when you send the request to delete the message. + * The copy remains on the server and might be returned to you during a subsequent + * receive request. You should ensure that your application is idempotent, so that + * receiving a message more than once does not cause issues.
* * @example * Use a bare-bones client and the command you need to make an API call. @@ -79,43 +79,12 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {} * @see {@link DeleteMessageCommandOutput} for command's `response` shape. * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * - * @throws {@link InvalidAddress} (client fault) - *The accountId
is invalid.
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 Amazon Web Services 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 57bcba925930d..460c893aeeab0 100644 --- a/clients/client-sqs/src/commands/DeleteQueueCommand.ts +++ b/clients/client-sqs/src/commands/DeleteQueueCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { DeleteQueueRequest } from "../models/models_0"; -import { de_DeleteQueueCommand, se_DeleteQueueCommand } from "../protocols/Aws_json1_0"; +import { de_DeleteQueueCommand, se_DeleteQueueCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -52,9 +52,9 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {} *When you delete a queue, you must wait at least 60 seconds before creating a queue * with the same name.
*Cross-account permissions don't apply to this action. For more information, see - * Grant cross-account permissions to a role and a username in the - * Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, + * see Grant + * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
*The delete operation uses the HTTP GET
verb.
The accountId
is invalid.
When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link QueueDoesNotExist} (client fault) - *The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the Amazon Web Services 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 bd4a671697d57..cfc898af3634d 100644 --- a/clients/client-sqs/src/commands/GetQueueAttributesCommand.ts +++ b/clients/client-sqs/src/commands/GetQueueAttributesCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { GetQueueAttributesRequest, GetQueueAttributesResult } from "../models/models_0"; -import { de_GetQueueAttributesCommand, se_GetQueueAttributesCommand } from "../protocols/Aws_json1_0"; +import { de_GetQueueAttributesCommand, se_GetQueueAttributesCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -39,8 +39,7 @@ export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResul * @public *Gets attributes for the specified queue.
*To determine whether a queue is FIFO, you can check whether QueueName
ends with the
- * .fifo
suffix.
To determine whether a queue is FIFO, you can check whether QueueName
ends with the .fifo
suffix.
The accountId
is invalid.
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 Amazon Web Services 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 d52faa4771256..923cbac1c8de5 100644 --- a/clients/client-sqs/src/commands/GetQueueUrlCommand.ts +++ b/clients/client-sqs/src/commands/GetQueueUrlCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { GetQueueUrlRequest, GetQueueUrlResult } from "../models/models_0"; -import { de_GetQueueUrlCommand, se_GetQueueUrlCommand } from "../protocols/Aws_json1_0"; +import { de_GetQueueUrlCommand, se_GetQueueUrlCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -44,8 +44,8 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB * information about shared queue access, see
* AddPermission
*
- * or see Allow Developers to Write Messages to a Shared Queue in the
- * Amazon SQS Developer Guide.
+ * or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS
+ * Developer Guide.
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
@@ -70,37 +70,9 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB
* @see {@link GetQueueUrlCommandOutput} 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 Amazon Web Services 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 9af021df909ee..5921dab2e0a47 100644 --- a/clients/client-sqs/src/commands/ListDeadLetterSourceQueuesCommand.ts +++ b/clients/client-sqs/src/commands/ListDeadLetterSourceQueuesCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { ListDeadLetterSourceQueuesRequest, ListDeadLetterSourceQueuesResult } from "../models/models_0"; -import { de_ListDeadLetterSourceQueuesCommand, se_ListDeadLetterSourceQueuesCommand } from "../protocols/Aws_json1_0"; +import { de_ListDeadLetterSourceQueuesCommand, se_ListDeadLetterSourceQueuesCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -76,37 +76,9 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS * @see {@link ListDeadLetterSourceQueuesCommandOutput} for command's `response` shape. * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape. * - * @throws {@link InvalidAddress} (client fault) - *The accountId
is invalid.
When the request to a queue is not HTTPS and SigV4.
- * * @throws {@link QueueDoesNotExist} (client fault) *The specified queue doesn't exist.
* - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the Amazon Web Services 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/ListMessageMoveTasksCommand.ts b/clients/client-sqs/src/commands/ListMessageMoveTasksCommand.ts index b480ead1d2de7..5bdbf1cc4d553 100644 --- a/clients/client-sqs/src/commands/ListMessageMoveTasksCommand.ts +++ b/clients/client-sqs/src/commands/ListMessageMoveTasksCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { ListMessageMoveTasksRequest, ListMessageMoveTasksResult } from "../models/models_0"; -import { de_ListMessageMoveTasksCommand, se_ListMessageMoveTasksCommand } from "../protocols/Aws_json1_0"; +import { de_ListMessageMoveTasksCommand, se_ListMessageMoveTasksCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -72,7 +72,7 @@ export interface ListMessageMoveTasksCommandOutput extends ListMessageMoveTasksR * // Results: [ // ListMessageMoveTasksResultEntryList * // { // ListMessageMoveTasksResultEntry * // TaskHandle: "STRING_VALUE", - * // Status: "RUNNING" || "FAILED" || "CANCELLING" || "CANCELLED" || "COMPLETED", + * // Status: "STRING_VALUE", * // SourceArn: "STRING_VALUE", * // DestinationArn: "STRING_VALUE", * // MaxNumberOfMessagesPerSecond: Number("int"), @@ -92,31 +92,6 @@ export interface ListMessageMoveTasksCommandOutput extends ListMessageMoveTasksR * @see {@link ListMessageMoveTasksCommandOutput} 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 RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the Amazon Web Services 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.
- *One or more specified resources don't exist.
* diff --git a/clients/client-sqs/src/commands/ListQueueTagsCommand.ts b/clients/client-sqs/src/commands/ListQueueTagsCommand.ts index 442df30953c6c..771f6757bc2bb 100644 --- a/clients/client-sqs/src/commands/ListQueueTagsCommand.ts +++ b/clients/client-sqs/src/commands/ListQueueTagsCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { ListQueueTagsRequest, ListQueueTagsResult } from "../models/models_0"; -import { de_ListQueueTagsCommand, se_ListQueueTagsCommand } from "../protocols/Aws_json1_0"; +import { de_ListQueueTagsCommand, se_ListQueueTagsCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -37,14 +37,13 @@ export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __Metad /** * @public - *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.
+ *List all cost allocation tags added to the specified Amazon SQS queue. + * For an overview, see Tagging + * Your Amazon SQS Queues in the Amazon SQS Developer Guide.
*Cross-account permissions don't apply to this action. For more information, see - * Grant cross-account permissions to a role and a username in the - * Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, + * see Grant + * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
*The accountId
is invalid.
When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link QueueDoesNotExist} (client fault) - *The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the Amazon Web Services 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 a7bae57c1ffa8..c0ce110a55eba 100644 --- a/clients/client-sqs/src/commands/ListQueuesCommand.ts +++ b/clients/client-sqs/src/commands/ListQueuesCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { ListQueuesRequest, ListQueuesResult } from "../models/models_0"; -import { de_ListQueuesCommand, se_ListQueuesCommand } from "../protocols/Aws_json1_0"; +import { de_ListQueuesCommand, se_ListQueuesCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -49,9 +49,9 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea * UseNextToken
as a parameter in your next request to
* listQueues
to receive the next page of results.
* Cross-account permissions don't apply to this action. For more information, see - * Grant cross-account permissions to a role and a username in the - * Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, + * see Grant + * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
*The accountId
is invalid.
When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the Amazon Web Services 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 e9a08bd26c19f..a9fba13147c6c 100644 --- a/clients/client-sqs/src/commands/PurgeQueueCommand.ts +++ b/clients/client-sqs/src/commands/PurgeQueueCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { PurgeQueueRequest } from "../models/models_0"; -import { de_PurgeQueueCommand, se_PurgeQueueCommand } from "../protocols/Aws_json1_0"; +import { de_PurgeQueueCommand, se_PurgeQueueCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -71,12 +71,6 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {} * @see {@link PurgeQueueCommandOutput} 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 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
@@ -85,28 +79,6 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {}
* @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 Amazon Web Services 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 f4281554c95ce..46e5a979f50ce 100644 --- a/clients/client-sqs/src/commands/ReceiveMessageCommand.ts +++ b/clients/client-sqs/src/commands/ReceiveMessageCommand.ts @@ -16,7 +16,7 @@ import { } from "@smithy/types"; import { ReceiveMessageRequest, ReceiveMessageResult } from "../models/models_0"; -import { de_ReceiveMessageCommand, se_ReceiveMessageCommand } from "../protocols/Aws_json1_0"; +import { de_ReceiveMessageCommand, se_ReceiveMessageCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -40,8 +40,8 @@ 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
@@ -75,17 +75,15 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
* 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
+ * 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.
+ *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 accountId
is invalid.
When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link KmsAccessDenied} (client fault) - *The caller doesn't have the required KMS access.
- * - * @throws {@link KmsDisabled} (client fault) - *The request was denied due to request throttling.
- * - * @throws {@link KmsInvalidKeyUsage} (client fault) - *The request was rejected for one of the following reasons:
- *The KeyUsage value of the KMS key is incompatible with the API - * operation.
- *The encryption algorithm or signing algorithm specified for the operation is - * incompatible with the type of key material in the KMS key (KeySpec).
- *The request was rejected because the state of the specified resource is not valid for - * this request.
- * - * @throws {@link KmsNotFound} (client fault) - *The request was rejected because the specified entity or resource could not be found. - *
- * - * @throws {@link KmsOptInRequired} (client fault) - *The request was rejected because the specified key policy isn't syntactically or - * semantically correct.
- * - * @throws {@link KmsThrottled} (client fault) - *Amazon Web Services KMS throttles requests for the following conditions.
- * * @throws {@link OverLimit} (client fault) *The specified action violates a limit. For example, ReceiveMessage
* returns this error if the maximum number of in flight messages is reached and
* 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 Amazon Web Services 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 92a1a9cf8def4..822ff1e30e777 100644 --- a/clients/client-sqs/src/commands/RemovePermissionCommand.ts +++ b/clients/client-sqs/src/commands/RemovePermissionCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { RemovePermissionRequest } from "../models/models_0"; -import { de_RemovePermissionCommand, se_RemovePermissionCommand } from "../protocols/Aws_json1_0"; +import { de_RemovePermissionCommand, se_RemovePermissionCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -45,14 +45,12 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {} *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 username in the - * Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, + * see Grant + * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
*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.
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 Amazon Web Services 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 e6a6946dd5a03..2f9aeb3e5b3e8 100644 --- a/clients/client-sqs/src/commands/SendMessageBatchCommand.ts +++ b/clients/client-sqs/src/commands/SendMessageBatchCommand.ts @@ -16,7 +16,7 @@ import { } from "@smithy/types"; import { SendMessageBatchRequest, SendMessageBatchResult } from "../models/models_0"; -import { de_SendMessageBatchCommand, se_SendMessageBatchCommand } from "../protocols/Aws_json1_0"; +import { de_SendMessageBatchCommand, se_SendMessageBatchCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -41,29 +41,22 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _ *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 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
+ * #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.
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 InvalidAddress} (client fault) - *The accountId
is invalid.
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 Amazon Web Services 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 0d74fc2256f95..94401201b7546 100644 --- a/clients/client-sqs/src/commands/SendMessageCommand.ts +++ b/clients/client-sqs/src/commands/SendMessageCommand.ts @@ -16,7 +16,7 @@ import { } from "@smithy/types"; import { SendMessageRequest, SendMessageResult } from "../models/models_0"; -import { de_SendMessageCommand, se_SendMessageCommand } from "../protocols/Aws_json1_0"; +import { de_SendMessageCommand, se_SendMessageCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -40,16 +40,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
+ * #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 accountId
is invalid.
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 Amazon Web Services 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 aed92331e9338..4d30bdc7a1fd6 100644 --- a/clients/client-sqs/src/commands/SetQueueAttributesCommand.ts +++ b/clients/client-sqs/src/commands/SetQueueAttributesCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { SetQueueAttributesRequest } from "../models/models_0"; -import { de_SetQueueAttributesCommand, se_SetQueueAttributesCommand } from "../protocols/Aws_json1_0"; +import { de_SetQueueAttributesCommand, se_SetQueueAttributesCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -39,26 +39,22 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {} * @public *Sets the value of one or more queue attributes. When you change a queue's attributes,
* the change can take up to 60 seconds for most of the attributes to propagate throughout
- * the Amazon SQS system. Changes made to the MessageRetentionPeriod
attribute
- * can take up to 15 minutes and will impact existing messages in the queue potentially
- * causing them to be expired and deleted if the MessageRetentionPeriod
is
- * reduced below the age of existing messages.
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.
+ *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 username in the - * Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, + * see Grant + * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
*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.
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 Amazon Web Services 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/StartMessageMoveTaskCommand.ts b/clients/client-sqs/src/commands/StartMessageMoveTaskCommand.ts index e9489607a6cd1..de5d1a8e0582c 100644 --- a/clients/client-sqs/src/commands/StartMessageMoveTaskCommand.ts +++ b/clients/client-sqs/src/commands/StartMessageMoveTaskCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { StartMessageMoveTaskRequest, StartMessageMoveTaskResult } from "../models/models_0"; -import { de_StartMessageMoveTaskCommand, se_StartMessageMoveTaskCommand } from "../protocols/Aws_json1_0"; +import { de_StartMessageMoveTaskCommand, se_StartMessageMoveTaskCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -88,31 +88,6 @@ export interface StartMessageMoveTaskCommandOutput extends StartMessageMoveTaskR * @see {@link StartMessageMoveTaskCommandOutput} 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 RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the Amazon Web Services 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.
- *One or more specified resources don't exist.
* diff --git a/clients/client-sqs/src/commands/TagQueueCommand.ts b/clients/client-sqs/src/commands/TagQueueCommand.ts index 9785c18f2f29d..505548e8f3746 100644 --- a/clients/client-sqs/src/commands/TagQueueCommand.ts +++ b/clients/client-sqs/src/commands/TagQueueCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { TagQueueRequest } from "../models/models_0"; -import { de_TagQueueCommand, se_TagQueueCommand } from "../protocols/Aws_json1_0"; +import { de_TagQueueCommand, se_TagQueueCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -37,33 +37,30 @@ 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.
+ *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 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.
+ *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.
+ *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 username in the - * Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, + * see Grant + * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
*The accountId
is invalid.
When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link QueueDoesNotExist} (client fault) - *The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the Amazon Web Services 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 f0113c4971915..93ee98bec1d19 100644 --- a/clients/client-sqs/src/commands/UntagQueueCommand.ts +++ b/clients/client-sqs/src/commands/UntagQueueCommand.ts @@ -15,7 +15,7 @@ import { } from "@smithy/types"; import { UntagQueueRequest } from "../models/models_0"; -import { de_UntagQueueCommand, se_UntagQueueCommand } from "../protocols/Aws_json1_0"; +import { de_UntagQueueCommand, se_UntagQueueCommand } from "../protocols/Aws_query"; import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient"; /** @@ -37,14 +37,12 @@ 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.
+ *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 username in the - * Amazon SQS Developer Guide.
+ *Cross-account permissions don't apply to this action. For more information, + * see Grant + * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
*The accountId
is invalid.
When the request to a queue is not HTTPS and SigV4.
- * - * @throws {@link QueueDoesNotExist} (client fault) - *The specified queue doesn't exist.
- * - * @throws {@link RequestThrottled} (client fault) - *The request was denied due to request throttling.
- *The rate of requests per second exceeds the Amazon Web Services 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/index.ts b/clients/client-sqs/src/index.ts index 2569a59d426fc..db0ba7542efa5 100644 --- a/clients/client-sqs/src/index.ts +++ b/clients/client-sqs/src/index.ts @@ -2,15 +2,15 @@ /* eslint-disable */ /** *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.
+ *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
@@ -55,8 +55,7 @@ *- * Amazon SQS in the Command Line - * Interface + * Amazon SQS in the Command Line Interface * *
*The Amazon Web - * Services account numbers of the principals who are to receive - * permission. For information about locating the Amazon Web Services - * account identification, see Your Amazon Web - * Services Identifiers in the Amazon SQS Developer - * Guide.
+ *The Amazon Web Services account numbers of the principals who are to receive + * permission. For information about locating the Amazon Web Services account identification, see Your Amazon Web Services Identifiers in the Amazon SQS Developer + * Guide.
*/ AWSAccountIds: string[] | undefined; @@ -50,46 +47,6 @@ export interface AddPermissionRequest { Actions: string[] | undefined; } -/** - * @public - *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
@@ -113,82 +70,6 @@ export class OverLimit extends __BaseException {
}
}
-/**
- * @public
- *
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 Amazon Web Services 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: __ExceptionOptionTypeError code 400. Unsupported operation.
+ */ +export class UnsupportedOperation extends __BaseException { + readonly name: "UnsupportedOperation" = "UnsupportedOperation"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe 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 (_).
+ *This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
*Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging + * Your Amazon SQS Queues in the Amazon SQS Developer Guide.
+ *When you use queue tags, keep the following guidelines in mind:
+ *Adding more than 50 tags to a queue isn't recommended.
+ *Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
+ *Tags are case-sensitive.
+ *A new tag with a key identical to that of an existing tag overwrites the existing tag.
+ *For a full list of tag restrictions, see + * Quotas related to queues + * in the Amazon SQS Developer Guide.
+ *To be able to tag a queue on creation, you must have the
+ * sqs:CreateQueue
and sqs:TagQueue
permissions.
Cross-account permissions don't apply to this action. For more information, + * see Grant + * cross-account permissions to a role and a username in the Amazon SQS Developer Guide.
+ *A map of attributes with their corresponding values.
@@ -579,35 +511,36 @@ export interface CreateQueueRequest { * *
- * MaximumMessageSize
– The limit of how many bytes a message can
- * contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
+ * 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
+ * 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
+ * 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 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.
@@ -622,115 +555,102 @@ export interface CreateQueueRequest { *
- * RedrivePolicy
– The string that includes the parameters for the
- * dead-letter queue functionality of the source queue as a JSON object. The
- * parameters are as follows:
RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality
+ * of the source queue as a JSON object. The parameters are as follows:
*
- * deadLetterTargetArn
– The Amazon Resource Name (ARN) of
- * the dead-letter queue to which Amazon SQS moves messages after the value
- * of maxReceiveCount
is exceeded.
deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to
+ * which Amazon SQS moves messages after the value of maxReceiveCount
is exceeded.
*
- * maxReceiveCount
– The number of times a message is
- * delivered to the source queue before being moved to the dead-letter
- * queue. Default: 10. When the ReceiveCount
for a message
- * exceeds the maxReceiveCount
for a queue, Amazon SQS moves
- * the message to the dead-letter-queue.
maxReceiveCount
– The number of times a message is delivered to the source queue before being
+ * moved to the dead-letter queue. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
+ * for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
- * RedriveAllowPolicy
– The string that includes the parameters for
- * the permissions for the dead-letter queue redrive permission and which source
- * queues can specify dead-letter queues as a JSON object. The parameters are as
- * follows:
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:
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.
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.
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.
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
.
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 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
+ * KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master
+ * key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is
+ * always alias/aws/sqs
, the alias of a custom CMK can, for example,
+ * be alias/MyAlias
+ *
. For more examples, see
+ * KeyId in the Key Management Service API
* Reference.
- * KmsDataKeyReusePeriodSeconds
– The length of time, in seconds, for
- * which Amazon SQS can reuse a data key to
- * encrypt or decrypt messages before calling KMS again. An integer representing
- * seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default:
- * 300 (5 minutes). A shorter time period provides better security but results in
- * more calls to KMS which might incur charges after Free Tier. For more
- * information, see How Does the Data Key Reuse Period Work?
+ * KmsDataKeyReusePeriodSeconds
– The length of time, in
+ * seconds, for which Amazon SQS can reuse a data key to
+ * encrypt or decrypt messages before calling KMS again. An integer
+ * representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
+ * hours). Default: 300 (5 minutes). A shorter time period provides better security
+ * but results in more calls to KMS which might incur charges after Free Tier. For
+ * more information, see How Does the Data Key Reuse Period Work?
*
- * SqsManagedSseEnabled
– Enables server-side queue encryption using
- * SQS owned encryption keys. Only one server-side encryption option is supported
- * per queue (for example, SSE-KMS or SSE-SQS).
SqsManagedSseEnabled
– Enables server-side queue encryption
+ * using SQS owned encryption keys. Only one server-side encryption option is
+ * supported per queue (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
+ * 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.
- * ContentBasedDeduplication
– Enables content-based deduplication.
- * Valid values are true
and false
. For more information,
- * see Exactly-once processing in the Amazon SQS Developer
+ * 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:
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
+ * 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).
The following attributes apply only to high - * throughput for FIFO queues:
+ *The following attributes apply only to + * high throughput + * for FIFO queues:
*
- * DeduplicationScope
– Specifies whether message deduplication
- * occurs at the message group or queue level. Valid values are
- * messageGroup
and queue
.
DeduplicationScope
– Specifies whether message deduplication occurs at the
+ * message group or queue level. Valid values are messageGroup
and queue
.
*
* FifoThroughputLimit
– Specifies whether the FIFO queue throughput
- * quota applies to the entire queue or per message group. Valid values are
- * perQueue
and perMessageGroupId
. The
- * perMessageGroupId
value is allowed only when the value for
- * DeduplicationScope
is messageGroup
.
perQueue
and perMessageGroupId
.
+ * The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.
* To enable high throughput for FIFO queues, do the following:
@@ -817,47 +735,12 @@ export interface CreateQueueRequest { *If you set these attributes to anything other than the values shown for enabling high - * throughput, normal throughput is in effect and deduplication occurs as specified.
- *For information on throughput quotas, see Quotas - * related to messages in the Amazon SQS Developer - * Guide.
+ * throughput, normal throughput is in effect and deduplication occurs as specified. + *For information on throughput quotas, + * see Quotas related to messages + * in the Amazon SQS Developer Guide.
*/ Attributes?: PartialAdd 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 @@ -935,8 +778,8 @@ export class QueueDeletedRecently extends __BaseException { /** * @public - *
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.
+ *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.
*/ export class QueueNameExists extends __BaseException { readonly name: "QueueNameExists" = "QueueNameExists"; @@ -975,8 +818,6 @@ export interface DeleteMessageRequest { /** * @public - * @deprecated - * *The specified receipt handle isn't valid for the current version.
*/ export class InvalidIdFormat extends __BaseException { @@ -1006,8 +847,7 @@ export interface DeleteMessageBatchRequestEntry { * 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 (_).
+ *This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
*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.
+ *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:
*
- * 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).
* @@ -1161,9 +999,8 @@ 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).
* @@ -1172,10 +1009,10 @@ export interface GetQueueAttributesRequest { *
- * 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
– 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
@@ -1192,14 +1029,14 @@ 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
+ * VisibilityTimeout
– Returns the visibility timeout for the
+ * queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer
* Guide.
- * RedrivePolicy
– The string that includes the parameters for the
- * dead-letter queue functionality of the source queue as a JSON object. The
- * parameters are as follows:
RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality
+ * of the source queue as a JSON object. The parameters are as follows:
*
- * deadLetterTargetArn
– The Amazon Resource Name (ARN) of
- * the dead-letter queue to which Amazon SQS moves messages after the value
- * of maxReceiveCount
is exceeded.
deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to
+ * which Amazon SQS moves messages after the value of maxReceiveCount
is exceeded.
*
- * maxReceiveCount
– The number of times a message is
- * delivered to the source queue before being moved to the dead-letter
- * queue. Default: 10. When the ReceiveCount
for a message
- * exceeds the maxReceiveCount
for a queue, Amazon SQS moves
- * the message to the dead-letter-queue.
maxReceiveCount
– The number of times a message is delivered to the source queue before being
+ * moved to the dead-letter queue. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
+ * for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
- * RedriveAllowPolicy
– The string that includes the parameters for
- * the permissions for the dead-letter queue redrive permission and which source
- * queues can specify dead-letter queues as a JSON object. The parameters are as
- * follows:
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:
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.
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.
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.
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
.
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 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
+ * 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
+ * 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.
To determine whether a queue is FIFO, you can check whether QueueName
ends with the .fifo
suffix.
The following attributes apply only to high - * throughput for FIFO queues:
+ *The following attributes apply only to + * high throughput + * for FIFO queues:
*
- * DeduplicationScope
– Specifies whether message deduplication
- * occurs at the message group or queue level. Valid values are
- * messageGroup
and queue
.
DeduplicationScope
– Specifies whether message deduplication occurs at the
+ * message group or queue level. Valid values are messageGroup
and queue
.
*
* FifoThroughputLimit
– Specifies whether the FIFO queue throughput
- * quota applies to the entire queue or per message group. Valid values are
- * perQueue
and perMessageGroupId
. The
- * perMessageGroupId
value is allowed only when the value for
- * DeduplicationScope
is messageGroup
.
perQueue
and perMessageGroupId
.
+ * The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.
* To enable high throughput for FIFO queues, do the following:
@@ -1347,10 +1170,10 @@ export interface GetQueueAttributesRequest { * * *If you set these attributes to anything other than the values shown for enabling high - * throughput, normal throughput is in effect and deduplication occurs as specified.
- *For information on throughput quotas, see Quotas - * related to messages in the Amazon SQS Developer - * Guide.
+ * throughput, normal throughput is in effect and deduplication occurs as specified. + *For information on throughput quotas, + * see Quotas related to messages + * in the Amazon SQS Developer Guide.
*/ AttributeNames?: QueueAttributeName[]; } @@ -1367,6 +1190,26 @@ export interface GetQueueAttributesResult { Attributes?: PartialThe specified attribute doesn't exist.
+ */ +export class InvalidAttributeName extends __BaseException { + readonly name: "InvalidAttributeName" = "InvalidAttributeName"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe Amazon Web - * Services account ID of the account that created the queue.
+ *The Amazon Web Services account ID of the account that created the queue.
*/ QueueOwnerAWSAccountId?: string; } @@ -1392,7 +1234,7 @@ export interface GetQueueUrlRequest { /** * @public *For more information, see Interpreting Responses in the Amazon SQS Developer - * Guide.
+ * Guide. */ export interface GetQueueUrlResult { /** @@ -1402,6 +1244,26 @@ 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: __ExceptionOptionTypeContains the details of a message movement task.
@@ -1503,7 +1348,7 @@ export interface ListMessageMoveTasksResultEntry { *The status of the message movement task. Possible values are: RUNNING, COMPLETED, * CANCELLING, CANCELLED, and FAILED.
*/ - Status?: TaskStatus; + Status?: string; /** * @public @@ -1599,13 +1444,6 @@ export interface ListQueuesRequest { *A list of your queues.
*/ export interface ListQueuesResult { - /** - * @public - *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
@@ -1613,6 +1451,13 @@ export interface ListQueuesResult {
* 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.
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: __ExceptionOptionType
- * ApproximateFirstReceiveTimestamp
– Returns the time the message was
- * first received from the queue (epoch time in
+ * 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.
* @@ -1880,15 +1572,15 @@ export interface ReceiveMessageRequest { *
- * SentTimestamp
– Returns the time the message was sent to the queue
- * (epoch time in
+ * SentTimestamp
– Returns the time the message was sent to the
+ * queue (epoch time in
* milliseconds).
- * SqsManagedSseEnabled
– Enables server-side queue encryption using
- * SQS owned encryption keys. Only one server-side encryption option is supported
- * per queue (for example, SSE-KMS or SSE-SQS).
SqsManagedSseEnabled
– Enables server-side queue encryption
+ * using SQS owned encryption keys. Only one server-side encryption option is
+ * supported per queue (for example, SSE-KMS or SSE-SQS).
* @@ -1900,15 +1592,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 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: + *
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; @@ -2039,8 +1733,8 @@ export interface ReceiveMessageRequest { *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.
For best practices of using ReceiveRequestAttemptId
, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS
+ * Developer Guide.
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.
+ * Guide. */ DataType: string | undefined; } @@ -2201,18 +1895,16 @@ export interface Message { /** * @public - *An MD5 digest of the non-URL-encoded message attribute string. You can use this - * attribute to verify that Amazon SQS received the message correctly. Amazon SQS - * URL-decodes the message before creating the MD5 digest. For information about MD5, see - * RFC1321.
+ *An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
*/ MD5OfMessageAttributes?: string; /** * @public - *Each message attribute consists of a Name
, Type
, and
- * Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer
- * Guide.
Each message attribute consists of a Name
, Type
,
+ * and Value
. For more information, see
+ * Amazon SQS
+ * message attributes in the Amazon SQS Developer Guide.
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.
+ * Guide. */ DataType: string | undefined; } @@ -2351,16 +2043,11 @@ export interface SendMessageRequest { *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:
*
- * #x9
| #xA
| #xD
| #x20
to
- * #xD7FF
| #xE000
to #xFFFD
|
- * #x10000
to #x10FFFF
+ * #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.
*When you set FifoQueue
, you can't set DelaySeconds
per
- * message. You can set this parameter only on a queue level.
When you set FifoQueue
, you can't set DelaySeconds
per message. You can set this parameter only on a queue level.
Each message attribute consists of a Name
, Type
, and
- * Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer
- * Guide.
Each message attribute consists of a Name
, Type
,
+ * and Value
. For more information, see
+ * Amazon SQS
+ * message attributes in the Amazon SQS Developer Guide.
The message system attribute to send. Each message system attribute consists of a
- * Name
, Type
, and Value
.
The message system attribute to send. Each message system attribute consists of a Name
, Type
, and Value
.
Currently, the only supported message system attribute is
- * AWSTraceHeader
. Its type must be String
and
- * its value must be a correctly formatted X-Ray trace
- * header string.
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.
+ *The size of a message system attribute doesn't count towards the total size of a message.
*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.
+ * Guide.
* Every message must have a unique MessageDeduplicationId
,
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.
+ *Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
* *The maximum 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.
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer
+ * Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
*The tag that specifies that a message belongs to a specific message group. Messages
- * that belong to the same message group are processed in a FIFO manner (however, messages
- * in different message groups might be processed out of order). To interleave multiple
- * ordered streams within a single queue, use MessageGroupId
values (for
- * example, session data for multiple users). In this scenario, multiple consumers can
+ * that belong to the same message group are processed in a FIFO manner (however,
+ * messages in different message groups might be processed out of order). To interleave
+ * multiple ordered streams within a single queue, use MessageGroupId
values
+ * (for example, session data for multiple users). In this scenario, multiple consumers can
* process the queue, but the session data of each user is processed in a FIFO
* fashion.
An MD5 digest of the non-URL-encoded message body string. You can use this attribute - * to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the - * message before creating the MD5 digest. For information about MD5, see RFC1321.
+ *An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
*/ MD5OfMessageBody?: string; /** * @public - *An MD5 digest of the non-URL-encoded message attribute string. You can use this - * attribute to verify that Amazon SQS received the message correctly. Amazon SQS - * URL-decodes the message before creating the MD5 digest. For information about MD5, see - * RFC1321.
+ *An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
*/ MD5OfMessageAttributes?: string; /** * @public *An MD5 digest of the non-URL-encoded message system attribute string. You can use this - * attribute to verify that Amazon SQS received the message correctly. Amazon SQS - * URL-decodes the message before creating the MD5 digest.
+ * attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. */ MD5OfMessageSystemAttributes?: string; @@ -2580,8 +2257,7 @@ export class BatchRequestTooLong extends __BaseException { /** * @public - *Contains the details of a single Amazon SQS message along with an
- * Id
.
Contains the details of a single Amazon SQS message along with an Id
.
An identifier for a message in this batch 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 (_).
+ *This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
*When you set FifoQueue
, you can't set DelaySeconds
per
- * message. You can set this parameter only on a queue level.
When you set FifoQueue
, you can't set DelaySeconds
per message. You can set this parameter only on a queue level.
Each message attribute consists of a Name
, Type
, and
- * Value
. For more information, see Amazon SQS message attributes in the Amazon SQS Developer
- * Guide.
Each message attribute consists of a Name
, Type
,
+ * and Value
. For more information, see
+ * Amazon SQS
+ * message attributes in the Amazon SQS Developer Guide.
The message system attribute to send Each message system attribute consists of a
- * Name
, Type
, and Value
.
The message system attribute to send Each message system attribute consists of a Name
, Type
, and Value
.
Currently, the only supported message system attribute is
- * AWSTraceHeader
. Its type must be String
and
- * its value must be a correctly formatted X-Ray trace
- * header string.
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.
+ *The size of a message system attribute doesn't count towards the total size of a message.
*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.
+ * Guide.
* Every message must have a unique MessageDeduplicationId
,
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.
+ *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.
For best practices of using MessageDeduplicationId
, see Using the MessageDeduplicationId Property in the Amazon SQS Developer
+ * Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
*The tag that specifies that a message belongs to a specific message group. Messages
- * that belong to the same message group are processed in a FIFO manner (however, messages
- * in different message groups might be processed out of order). To interleave multiple
- * ordered streams within a single queue, use MessageGroupId
values (for
- * example, session data for multiple users). In this scenario, multiple consumers can
+ * that belong to the same message group are processed in a FIFO manner (however,
+ * messages in different message groups might be processed out of order). To interleave
+ * multiple ordered streams within a single queue, use MessageGroupId
values
+ * (for example, session data for multiple users). In this scenario, multiple consumers can
* process the queue, but the session data of each user is processed in a FIFO
* fashion.
An MD5 digest of the non-URL-encoded message body string. You can use this attribute - * to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the - * message before creating the MD5 digest. For information about MD5, see RFC1321.
+ *An MD5 digest of the non-URL-encoded message body string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
*/ MD5OfMessageBody: string | undefined; /** * @public - *An MD5 digest of the non-URL-encoded message attribute string. You can use this - * attribute to verify that Amazon SQS received the message correctly. Amazon SQS - * URL-decodes the message before creating the MD5 digest. For information about MD5, see - * RFC1321.
+ *An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.
*/ MD5OfMessageAttributes?: string; /** * @public *An MD5 digest of the non-URL-encoded message system attribute string. You can use this - * attribute to verify that Amazon SQS received the message correctly. Amazon SQS - * URL-decodes the message before creating the MD5 digest. For information about MD5, see - * RFC1321.
+ * attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321. */ MD5OfMessageSystemAttributes?: string; @@ -2877,36 +2541,37 @@ export interface SetQueueAttributesRequest { *
- * MaximumMessageSize
– The limit of how many bytes a message can
- * contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
+ * 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,
+ * 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
+ * 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
+ *
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.
@@ -2921,83 +2586,71 @@ export interface SetQueueAttributesRequest { *
- * RedrivePolicy
– The string that includes the parameters for the
- * dead-letter queue functionality of the source queue as a JSON object. The
- * parameters are as follows:
RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality
+ * of the source queue as a JSON object. The parameters are as follows:
*
- * deadLetterTargetArn
– The Amazon Resource Name (ARN) of
- * the dead-letter queue to which Amazon SQS moves messages after the value
- * of maxReceiveCount
is exceeded.
deadLetterTargetArn
– The Amazon Resource Name (ARN) of the dead-letter queue to
+ * which Amazon SQS moves messages after the value of maxReceiveCount
is exceeded.
*
- * maxReceiveCount
– The number of times a message is
- * delivered to the source queue before being moved to the dead-letter
- * queue. Default: 10. When the ReceiveCount
for a message
- * exceeds the maxReceiveCount
for a queue, Amazon SQS moves
- * the message to the dead-letter-queue.
maxReceiveCount
– The number of times a message is delivered to the source queue before being
+ * moved to the dead-letter queue. Default: 10. When the ReceiveCount
for a message exceeds the maxReceiveCount
+ * for a queue, Amazon SQS moves the message to the dead-letter-queue.
*
- * RedriveAllowPolicy
– The string that includes the parameters for
- * the permissions for the dead-letter queue redrive permission and which source
- * queues can specify dead-letter queues as a JSON object. The parameters are as
- * follows:
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:
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.
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.
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.
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
.
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 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
+ * 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
@@ -3006,28 +2659,28 @@ export interface SetQueueAttributesRequest {
*
- * KmsDataKeyReusePeriodSeconds
– The length of time, in seconds, for
- * which Amazon SQS can reuse a data key to
- * encrypt or decrypt messages before calling KMS again. An integer representing
- * seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default:
- * 300 (5 minutes). A shorter time period provides better security but results in
- * more calls to KMS which might incur charges after Free Tier. For more
- * information, see How Does the Data Key Reuse Period Work?.
KmsDataKeyReusePeriodSeconds
– The length of time, in
+ * seconds, for which Amazon SQS can reuse a data key to
+ * encrypt or decrypt messages before calling KMS again. An integer
+ * representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24
+ * hours). Default: 300 (5 minutes). A shorter time period provides better security
+ * but results in more calls to KMS which might incur charges after Free Tier. For
+ * more information, see How Does the Data Key Reuse Period Work?.
*
- * SqsManagedSseEnabled
– Enables server-side queue encryption using
- * SQS owned encryption keys. Only one server-side encryption option is supported
- * per queue (for example, SSE-KMS or SSE-SQS).
SqsManagedSseEnabled
– Enables server-side queue encryption
+ * using SQS owned encryption keys. Only one server-side encryption option is
+ * supported per queue (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
+ * ContentBasedDeduplication
– Enables content-based
+ * deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer
* Guide. Note the following:
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
+ * 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).
The following attributes apply only to high - * throughput for FIFO queues:
+ *The following attributes apply only to + * high throughput + * for FIFO queues:
*
- * DeduplicationScope
– Specifies whether message deduplication
- * occurs at the message group or queue level. Valid values are
- * messageGroup
and queue
.
DeduplicationScope
– Specifies whether message deduplication occurs at the
+ * message group or queue level. Valid values are messageGroup
and queue
.
*
* FifoThroughputLimit
– Specifies whether the FIFO queue throughput
- * quota applies to the entire queue or per message group. Valid values are
- * perQueue
and perMessageGroupId
. The
- * perMessageGroupId
value is allowed only when the value for
- * DeduplicationScope
is messageGroup
.
perQueue
and perMessageGroupId
.
+ * The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.
* To enable high throughput for FIFO queues, do the following:
@@ -3103,10 +2754,10 @@ export interface SetQueueAttributesRequest { *If you set these attributes to anything other than the values shown for enabling high - * throughput, normal throughput is in effect and deduplication occurs as specified.
- *For information on throughput quotas, see Quotas - * related to messages in the Amazon SQS Developer - * Guide.
+ * throughput, normal throughput is in effect and deduplication occurs as specified. + *For information on throughput quotas, + * see Quotas related to messages + * in the Amazon SQS Developer Guide.
*/ Attributes: Partial