openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 266 kB

JSON

{"openapi":"3.0.0","info":{"version":"2012-11-05","x-release":"v4","title":"Amazon Simple Queue Service","description":"Welcome to the Amazon SQS API Reference. Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components. For information on the permissions you need to use this API, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html\">Identity and access management</a> in the Amazon SQS Developer Guide. You can use <a href=\"http://aws.amazon.com/tools/#sdk\">Amazon Web Services SDKs</a> to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically: <ul> <li> Cryptographically sign your service requests </li> <li> Retry requests </li> <li> Handle error responses </li> </ul> Additional information <ul> <li> <a href=\"http://aws.amazon.com/sqs/\">Amazon SQS Product Page</a> </li> <li> Amazon SQS Developer Guide <ul> <li> <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html\">Making API Requests</a> </li> <li> <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes\">Amazon SQS Message Attributes</a> </li> <li> <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html\">Amazon SQS Dead-Letter Queues</a> </li> </ul> </li> <li> <a href=\"http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html\">Amazon SQS in the Command Line Interface </a> </li> <li> Amazon Web Services General Reference <ul> <li> <a href=\"https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region\">Regions and Endpoints</a> </li> </ul> </li> </ul>","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"sqs","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/sqs-2012-11-05.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/sqs/"},"servers":[{"url":"http://sqs.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon SQS multi-region endpoint"},{"url":"https://sqs.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon SQS multi-region endpoint"},{"url":"http://sqs.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon SQS endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://sqs.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon SQS endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/{AccountNumber}/{QueueName}/#Action=AddPermission":{"get":{"x-aws-operation-name":"AddPermission","operationId":"GET_AddPermission","description":"Adds a permission to a queue for a specific <a href=\"https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P\">principal</a>. This allows sharing access to the queue. When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue\">Allow Developers to Write Messages to a Shared Queue</a> in the Amazon SQS Developer Guide. <note> <ul> <li> <code>AddPermission</code> generates a policy for you. You can use <code> <a>SetQueueAttributes</a> </code> to upload your policy. For more information, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html\">Using Custom Policies with the Amazon SQS Access Policy Language</a> in the Amazon SQS Developer Guide. </li> <li> An Amazon SQS policy can have a maximum of seven actions per statement. </li> <li> To remove the ability to change queue permissions, you must deny permission to the <code>AddPermission</code>, <code>RemovePermission</code>, and <code>SetQueueAttributes</code> actions in your IAM policy. </li> <li> Amazon SQS <code>AddPermission</code> does not support adding a non-account principal. </li> </ul> </note> <note> Cross-account permissions don't apply to this action. For more information, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name\">Grant cross-account permissions to a role and a username</a> in the Amazon SQS Developer Guide. </note>","responses":{"200":{"description":"Success"},"480":{"description":"OverLimit","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/OverLimit"}}}}},"parameters":[{"name":"Label","in":"query","required":true,"description":"The unique identification of the permission you're setting (for example, <code>AliceSendMessage</code>). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (<code>-</code>), and underscores (<code>_</code>).","schema":{"type":"string"}},{"name":"AWSAccountIds","in":"query","required":true,"description":"The Amazon Web Services account numbers of the <a href=\"https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P\">principals</a> who are to receive permission. For information about locating the Amazon Web Services account identification, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication\">Your Amazon Web Services Identifiers</a> in the Amazon SQS Developer Guide.","schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/String"},{"xml":{"name":"AWSAccountId"}}]},"xml":{"wrapped":false}}},{"name":"Actions","in":"query","required":true,"description":"The action the client wants to allow for the specified principal. Valid values: the name of any action or <code>*</code>. For more information about these actions, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-overview-of-managing-access.html\">Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource</a> in the Amazon SQS Developer Guide. Specifying <code>SendMessage</code>, <code>DeleteMessage</code>, or <code>ChangeMessageVisibility</code> for <code>ActionName.n</code> also grants permissions for the corresponding batch versions of those actions: <code>SendMessageBatch</code>, <code>DeleteMessageBatch</code>, and <code>ChangeMessageVisibilityBatch</code>.","schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/String"},{"xml":{"name":"ActionName"}}]},"xml":{"wrapped":false}}},{"in":"path","name":"AccountNumber","required":true,"description":"The AWS account number","schema":{"type":"integer"}},{"in":"path","name":"QueueName","required":true,"description":"The name of the queue","schema":{"type":"string"}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AddPermission"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2012-11-05"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#Action=AddPermission":{"post":{"x-aws-operation-name":"AddPermission","operationId":"POST_AddPermission","description":"Adds a permission to a queue for a specific <a href=\"https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P\">principal</a>. This allows sharing access to the queue. When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue\">Allow Developers to Write Messages to a Shared Queue</a> in the Amazon SQS Developer Guide. <note> <ul> <li> <code>AddPermission</code> generates a policy for you. You can use <code> <a>SetQueueAttributes</a> </code> to upload your policy. For more information, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html\">Using Custom Policies with the Amazon SQS Access Policy Language</a> in the Amazon SQS Developer Guide. </li> <li> An Amazon SQS policy can have a maximum of seven actions per statement. </li> <li> To remove the ability to change queue permissions, you must deny permission to the <code>AddPermission</code>, <code>RemovePermission</code>, and <code>SetQueueAttributes</code> actions in your IAM policy. </li> <li> Amazon SQS <code>AddPermission</code> does not support adding a non-account principal. </li> </ul> </note> <note> Cross-account permissions don't apply to this action. For more information, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name\">Grant cross-account permissions to a role and a username</a> in the Amazon SQS Developer Guide. </note>","responses":{"200":{"description":"Success"},"480":{"description":"OverLimit","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/OverLimit"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/AddPermissionRequest"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["AddPermission"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2012-11-05"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#Action=CancelMessageMoveTask":{"get":{"x-aws-operation-name":"CancelMessageMoveTask","operationId":"GET_CancelMessageMoveTask","description":"Cancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet. <note> <ul> <li> This action is currently limited to supporting message redrive from <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html\">dead-letter queues (DLQs)</a> only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue. </li> <li> Currently, only standard queues are supported. </li> <li> Only one active message movement task is supported per queue at any given time. </li> </ul> </note>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CancelMessageMoveTaskResult"}}}},"480":{"description":"ResourceNotFoundException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"UnsupportedOperation","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/UnsupportedOperation"}}}}},"parameters":[{"name":"TaskHandle","in":"query","required":true,"description":"An identifier associated with a message movement task.","schema":{"type":"string"}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CancelMessageMoveTask"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2012-11-05"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"CancelMessageMoveTask","operationId":"POST_CancelMessageMoveTask","description":"Cancels a specified message movement task. A message movement can only be cancelled when the current status is RUNNING. Cancelling a message movement task does not revert the messages that have already been moved. It can only stop the messages that have not been moved yet. <note> <ul> <li> This action is currently limited to supporting message redrive from <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html\">dead-letter queues (DLQs)</a> only. In this context, the source queue is the dead-letter queue (DLQ), while the destination queue can be the original source queue (from which the messages were driven to the dead-letter-queue), or a custom destination queue. </li> <li> Currently, only standard queues are supported. </li> <li> Only one active message movement task is supported per queue at any given time. </li> </ul> </note>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CancelMessageMoveTaskResult"}}}},"480":{"description":"ResourceNotFoundException","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"UnsupportedOperation","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/UnsupportedOperation"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CancelMessageMoveTaskRequest"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CancelMessageMoveTask"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2012-11-05"]}}]}},"/{AccountNumber}/{QueueName}/#Action=ChangeMessageVisibility":{"get":{"x-aws-operation-name":"ChangeMessageVisibility","operationId":"GET_ChangeMessageVisibility","description":"Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html\">Visibility Timeout</a> in the Amazon SQS Developer Guide. For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed since you received the message, and you send a ChangeMessageVisibility call with <code>VisibilityTimeout</code> set to 10 seconds, the 10 seconds begin to count from the time that you make the <code>ChangeMessageVisibility</code> call. Thus, any attempt to change the visibility timeout or to delete that message 10 seconds after you initially change the visibility timeout (a total of 25 seconds) might result in an error. An Amazon SQS message has three basic states: <ol> <li> Sent to a queue by a producer. </li> <li> Received from the queue by a consumer. </li> <li> Deleted from the queue. </li> </ol> 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 <code>OverLimit</code> 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, <a href=\"https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sqs\">file a support request</a>. 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. <important> If you attempt to set the <code>VisibilityTimeout</code> to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time. Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the <code>ChangeMessageVisibility</code> action) the next time the message is received. </important>","responses":{"200":{"description":"Success"},"480":{"description":"MessageNotInflight","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/MessageNotInflight"}}}},"481":{"description":"ReceiptHandleIsInvalid","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ReceiptHandleIsInvalid"}}}}},"parameters":[{"name":"ReceiptHandle","in":"query","required":true,"description":"The receipt handle associated with the message, whose visibility timeout is changed. This parameter is returned by the <code> <a>ReceiveMessage</a> </code> action.","schema":{"type":"string"}},{"name":"VisibilityTimeout","in":"query","required":true,"description":"The new value for the message's visibility timeout (in seconds). Values range: <code>0</code> to <code>43200</code>. Maximum: 12 hours.","schema":{"type":"integer"}},{"in":"path","name":"AccountNumber","required":true,"description":"The AWS account number","schema":{"type":"integer"}},{"in":"path","name":"QueueName","required":true,"description":"The name of the queue","schema":{"type":"string"}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ChangeMessageVisibility"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2012-11-05"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#Action=ChangeMessageVisibility":{"post":{"x-aws-operation-name":"ChangeMessageVisibility","operationId":"POST_ChangeMessageVisibility","description":"Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html\">Visibility Timeout</a> in the Amazon SQS Developer Guide. For example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed since you received the message, and you send a ChangeMessageVisibility call with <code>VisibilityTimeout</code> set to 10 seconds, the 10 seconds begin to count from the time that you make the <code>ChangeMessageVisibility</code> call. Thus, any attempt to change the visibility timeout or to delete that message 10 seconds after you initially change the visibility timeout (a total of 25 seconds) might result in an error. An Amazon SQS message has three basic states: <ol> <li> Sent to a queue by a producer. </li> <li> Received from the queue by a consumer. </li> <li> Deleted from the queue. </li> </ol> 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 <code>OverLimit</code> 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, <a href=\"https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sqs\">file a support request</a>. 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. <important> If you attempt to set the <code>VisibilityTimeout</code> to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time. Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the <code>ChangeMessageVisibility</code> action) the next time the message is received. </important>","responses":{"200":{"description":"Success"},"480":{"description":"MessageNotInflight","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/MessageNotInflight"}}}},"481":{"description":"ReceiptHandleIsInvalid","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ReceiptHandleIsInvalid"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ChangeMessageVisibilityRequest"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ChangeMessageVisibility"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2012-11-05"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/{AccountNumber}/{QueueName}/#Action=ChangeMessageVisibilityBatch":{"get":{"x-aws-operation-name":"ChangeMessageVisibilityBatch","operationId":"GET_ChangeMessageVisibilityBatch","description":"Changes the visibility timeout of multiple messages. This is a batch version of <code> <a>ChangeMessageVisibility</a>.</code> The result of the action on each message is reported individually in the response. You can send up to 10 <code> <a>ChangeMessageVisibility</a> </code> requests with each <code>ChangeMessageVisibilityBatch</code> action. <important> 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 <code>200</code>. </important>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ChangeMessageVisibilityBatchResult"}}}},"480":{"description":"TooManyEntriesInBatchRequest","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyEntriesInBatchRequest"}}}},"481":{"description":"EmptyBatchRequest","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/EmptyBatchRequest"}}}},"482":{"description":"BatchEntryIdsNotDistinct","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/BatchEntryIdsNotDistinct"}}}},"483":{"description":"InvalidBatchEntryId","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidBatchEntryId"}}}}},"parameters":[{"name":"Entries","in":"query","required":true,"description":"Lists the receipt handles of the messages for which the visibility timeout must be changed.","schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/ChangeMessageVisibilityBatchRequestEntry"},{"xml":{"name":"ChangeMessageVisibilityBatchRequestEntry"}}]},"xml":{"wrapped":false}}},{"in":"path","name":"AccountNumber","required":true,"description":"The AWS account number","schema":{"type":"integer"}},{"in":"path","name":"QueueName","required":true,"description":"The name of the queue","schema":{"type":"string"}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ChangeMessageVisibilityBatch"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2012-11-05"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#Action=ChangeMessageVisibilityBatch":{"post":{"x-aws-operation-name":"ChangeMessageVisibilityBatch","operationId":"POST_ChangeMessageVisibilityBatch","description":"Changes the visibility timeout of multiple messages. This is a batch version of <code> <a>ChangeMessageVisibility</a>.</code> The result of the action on each message is reported individually in the response. You can send up to 10 <code> <a>ChangeMessageVisibility</a> </code> requests with each <code>ChangeMessageVisibilityBatch</code> action. <important> 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 <code>200</code>. </important>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ChangeMessageVisibilityBatchResult"}}}},"480":{"description":"TooManyEntriesInBatchRequest","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/TooManyEntriesInBatchRequest"}}}},"481":{"description":"EmptyBatchRequest","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/EmptyBatchRequest"}}}},"482":{"description":"BatchEntryIdsNotDistinct","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/BatchEntryIdsNotDistinct"}}}},"483":{"description":"InvalidBatchEntryId","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/InvalidBatchEntryId"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/ChangeMessageVisibilityBatchRequest"}}}},"parameters":[{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["ChangeMessageVisibilityBatch"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2012-11-05"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#Action=CreateQueue":{"get":{"x-aws-operation-name":"CreateQueue","operationId":"GET_CreateQueue","description":"Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind: <ul> <li> If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue. <note> You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving\">Moving From a Standard Queue to a FIFO Queue</a> in the Amazon SQS Developer Guide. </note> </li> <li> If you don't provide a value for an attribute, the queue is created with the default value for the attribute. </li> <li> If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. </li> </ul> To successfully create a new queue, you must provide a queue name that adheres to the <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html\">limits related to queues</a> and is unique within the scope of your queues. <note> After you create a queue, you must wait at least one second after the queue is created to be able to use the queue. </note> To get the queue URL, use the <code> <a>GetQueueUrl</a> </code> action. <code> <a>GetQueueUrl</a> </code> requires only the <code>QueueName</code> parameter. be aware of existing queue names: <ul> <li> If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, <code>CreateQueue</code> returns the queue URL for the existing queue. </li> <li> If the queue name, attribute names, or attribute values don't match an existing queue, <code>CreateQueue</code> returns an error. </li> </ul> <note> Cross-account permissions don't apply to this action. For more information, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name\">Grant cross-account permissions to a role and a username</a> in the Amazon SQS Developer Guide. </note>","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/CreateQueueResult"}}}},"480":{"description":"QueueDeletedRecently","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/QueueDeletedRecently"}}}},"481":{"description":"QueueNameExists","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/QueueNameExists"}}}}},"parameters":[{"name":"QueueName","in":"query","required":true,"description":"The name of the new queue. The following limits apply to this name: <ul> <li> A queue name can have up to 80 characters. </li> <li> Valid values: alphanumeric characters, hyphens (<code>-</code>), and underscores (<code>_</code>). </li> <li> A FIFO queue name must end with the <code>.fifo</code> suffix. </li> </ul> Queue URLs and names are case-sensitive.","schema":{"type":"string"}},{"name":"Attribute","in":"query","required":false,"description":"A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the <code>CreateQueue</code> action uses: <ul> <li> <code>DelaySeconds</code> – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0. </li> <li> <code>MaximumMessageSize</code> – 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). </li> <li> <code>MessageRetentionPeriod</code> – 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 <code>MessageRetentionPeriod</code> 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 <code>MessageRetentionPeriod</code> is reduced below the age of existing messages. </li> <li> <code>Policy</code> – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html\">Overview of Amazon Web Services IAM Policies</a> in the IAM User Guide. </li> <li> <code>ReceiveMessageWaitTimeSeconds</code> – The length of time, in seconds, for which a <code> <a>ReceiveMessage</a> </code> action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0. </li> <li> <code>VisibilityTimeout</code> – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html\">Visibility Timeout</a> in the Amazon SQS Developer Guide. </li> </ul> The following attributes apply only to <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html\">dead-letter queues:</a> <ul> <li> <code>RedrivePolicy</code> – 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: <ul> <li> <code>deadLetterTargetArn</code> – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of <code>maxReceiveCount</code> is exceeded. </li> <li> <code>maxReceiveCount</code> – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. Default: 10. When the <code>ReceiveCount</code> for a message exceeds the <code>maxReceiveCount</code> for a queue, Amazon SQS moves the message to the dead-letter-queue. </li> </ul> </li> <li> <code>RedriveAllowPolicy</code> – 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: <ul> <li> <code>redrivePermission</code> – The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are: <ul> <li> <code>allowAll</code> – (Default) Any source queues in this Amazon Web Services account in the same Region can specify this queue as the dead-letter queue. </li> <li> <code>denyAll</code> – No source queues can specify this queue as the dead-letter queue. </li> <li> <code>byQueue</code> – Only queues specified by the <code>sourceQueueArns</code> parameter can specify this queue as the dead-letter queue. </li> </ul> </li> <li> <code>sourceQueueArns</code> – 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 <code>redrivePermission</code> parameter is set to <code>byQueue</code>. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the <code>redrivePermission</code> parameter to <code>allowAll</code>. </li> </ul> </li> </ul> <note> 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. </note> The following attributes apply only to <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html\">server-side-encryption</a>: <ul> <li> <code>KmsMasterKeyId</code> – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms\">Key Terms</a>. While the alias of the Amazon Web Services managed CMK for Amazon SQS is always <code>alias/aws/sqs</code>, the alias of a custom CMK can, for example, be <code>alias/MyAlias </code>. For more examples, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters\">KeyId</a> in the Key Management Service API Reference. </li> <li> <code>KmsDataKeyReusePeriodSeconds</code> – The length of time, in seconds, for which Amazon SQS can reuse a <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys\">data key</a> 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 <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work\">How Does the Data Key Reuse Period Work?</a> </li> <li> <code>SqsManagedSseEnabled</code> – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html\">SSE-KMS</a> or <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html\">SSE-SQS</a>). </li> </ul> The following attributes apply only to <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html\">FIFO (first-in-first-out) queues</a>: <ul> <li> <code>FifoQueue</code> – Designates a queue as FIFO. Valid values are <code>true</code> and <code>false</code>. If you don't specify the <code>FifoQueue</code> 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 <code>MessageGroupId</code> for your messages explicitly. For more information, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html\">FIFO queue logic</a> in the Amazon SQS Developer Guide. </li> <li> <code>ContentBasedDeduplication</code> – Enables content-based deduplication. Valid values are <code>true</code> and <code>false</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html\">Exactly-once processing</a> in the Amazon SQS Developer Guide. Note the following: <ul> <li> Every message must have a unique <code>MessageDeduplicationId</code>. <ul> <li> You may provide a <code>MessageDeduplicationId</code> explicitly. </li> <li> If you aren't able to provide a <code>MessageDeduplicationId</code> and you enable <code>ContentBasedDeduplication</code> for your queue, Amazon SQS uses a SHA-256 hash to generate the <code>MessageDeduplicationId</code> using the body of the message (but not the attributes of the message). </li> <li> If you don't provide a <code>MessageDeduplicationId</code> and the queue doesn't have <code>ContentBasedDeduplication</code> set, the action fails with an error. </li> <li> If the queue has <code>ContentBasedDeduplication</code> set, your <code>MessageDeduplicationId</code> overrides the generated one. </li> </ul> </li> <li> When <code>ContentBasedDeduplication</code> is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered. </li> <li> If you send one message with <code>ContentBasedDeduplication</code> enabled and then another message with a <code>MessageDeduplicationId</code> that is the same as the one generated for the first <code>MessageDeduplicationId</code>, the two messages are treated as duplicates and only one copy of the message is delivered. </li> </ul> </li> </ul> The following attributes apply only to <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html\">high throughput for FIFO queues</a>: <ul> <li> <code>DeduplicationScope</code> – Specifies whether message deduplication occurs at the message group or queue level. Valid values are <code>messageGroup</code> and <code>queue</code>. </li> <li> <code>FifoThroughputLimit</code> – Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are <code>perQueue</code> and <code>perMessageGroupId</code>. The <code>perMessageGroupId</code> value is allowed only when the value for <code>DeduplicationScope</code> is <code>messageGroup</code>. </li> </ul> To enable high throughput for FIFO queues, do the following: <ul> <li> Set <code>DeduplicationScope</code> to <code>messageGroup</code>. </li> <li> Set <code>FifoThroughputLimit</code> to <code>perMessageGroupId</code>. </li> </ul> 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 <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html\">Quotas related to messages</a> in the Amazon SQS Developer Guide.","schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/String"},"xml":{"wrapped":false}}},{"name":"Tag","in":"query","required":false,"description":"Add cost allocation tags to the specified Amazon SQS queue. For an overview, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html\">Tagging Your Amazon SQS Queues</a> in the Amazon SQS Developer Guide. When you use queue tags, keep the following guidelines in mind: <ul> <li> Adding more than 50 tags to a queue isn't recommended. </li> <li> Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings. </li> <li> Tags are case-sensitive. </li> <li> A new tag with a key identical to that of an existing tag overwrites the existing tag. </li> </ul> For a full list of tag restrictions, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues\">Quotas related to queues</a> in the Amazon SQS Developer Guide. <note> To be able to tag a queue on creation, you must have the <code>sqs:CreateQueue</code> and <code>sqs:TagQueue</code> permissions. Cross-account permissions don't apply to this action. For more information, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name\">Grant cross-account permissions to a role and a username</a> in the Amazon SQS Developer Guide. </note>","schema":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/TagValue"},"xml":{"wrapped":false}}},{"name":"Action","in":"query","required":true,"schema":{"type":"string","enum":["CreateQueue"]}},{"name":"Version","in":"query","required":true,"schema":{"type":"string","enum":["2012-11-05"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"x-aws-operation-name":"CreateQueue","operationId":"POST_CreateQueue","description":"Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind: <ul> <li> If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue. <note> You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving\">Moving From a Standard Queue to a FIFO Queue</a> in the Amazon SQS Developer Guide. </note> </li> <li> If you don't provide a value for an attribute, the queue is created with the default value for the attribute. </li> <li> If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name. </li> </ul> To successfully create a new queue, you must provide a queue name that adheres to the <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html\">limits related to queues</a> and is unique within the scope of your queues. <note> After you create a queue, you must wait at least one second after the queue is created to be able to use the queue. </note> To get the queue URL, use the <code> <a>GetQueueUrl</a> </code> action. <code> <a>GetQueueUrl</a> </code> requires only the <code>QueueName</code> parameter. be aware of existing queue names: <ul> <li> If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, <code>CreateQueue</code> returns the queue URL for the existing queue. </li> <li> If the queue name, attribute names, or attribute values don't match an existing queue, <code>CreateQueue</code> returns an error. </li> </ul> <note> Cross-account permissions don't apply to this action. For more information, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/S