API version 2012-11-05 of the Amazon Simple Queue Service SDK configuration.

Two or more batch entries in the request have the same Id.

The length of all the messages put together is more than the limit.

The batch request doesn't contain any entries.

The specified attribute doesn't exist.

The Id of a batch entry in a batch request doesn't abide by the specification.

The specified receipt handle isn't valid for the current version.

The message contains characters outside the allowed set.

The specified message isn't in flight.

The specified action violates a limit. For example, ReceiveMessage returns this error if the maximum number of inflight messages is reached and AddPermission returns this error if the maximum number of permissions for the queue is reached.

Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).

You must wait 60 seconds after deleting a queue before you can create another queue 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 includes attributes whose values differ from those of the existing queue.

The specified receipt handle isn't valid.

The batch request contains more entries than permissible.

Error code 400. Unsupported operation.

See: newAddPermission smart constructor.

Create a value of AddPermission with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:queueUrl:AddPermission', addPermission_queueUrl - The URL of the Amazon SQS queue to which permissions are added.

Queue URLs and names are case-sensitive.

$sel:label:AddPermission', addPermission_label - The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

$sel:aWSAccountIds:AddPermission', addPermission_aWSAccountIds - 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.

$sel:actions:AddPermission', addPermission_actions - The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

See: newAddPermissionResponse smart constructor.

Create a value of AddPermissionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

See: newChangeMessageVisibility smart constructor.

Create a value of ChangeMessageVisibility with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:queueUrl:ChangeMessageVisibility', changeMessageVisibility_queueUrl - The URL of the Amazon SQS queue whose message's visibility is changed.

Queue URLs and names are case-sensitive.

ChangeMessageVisibility, changeMessageVisibility_receiptHandle - The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the ReceiveMessage action.

ChangeMessageVisibility, changeMessageVisibility_visibilityTimeout - The new value for the message's visibility timeout (in seconds). Values range: 0 to 43200. Maximum: 12 hours.

See: newChangeMessageVisibilityResponse smart constructor.

Create a value of ChangeMessageVisibilityResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

See: newChangeMessageVisibilityBatch smart constructor.

Create a value of ChangeMessageVisibilityBatch with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:queueUrl:ChangeMessageVisibilityBatch', changeMessageVisibilityBatch_queueUrl - The URL of the Amazon SQS queue whose messages' visibility is changed.

Queue URLs and names are case-sensitive.

$sel:entries:ChangeMessageVisibilityBatch', changeMessageVisibilityBatch_entries - A list of receipt handles of the messages for which the visibility timeout must be changed.

For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

See: newChangeMessageVisibilityBatchResponse smart constructor.

Create a value of ChangeMessageVisibilityBatchResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:ChangeMessageVisibilityBatchResponse', changeMessageVisibilityBatchResponse_httpStatus - The response's http status code.

$sel:successful:ChangeMessageVisibilityBatchResponse', changeMessageVisibilityBatchResponse_successful - A list of ChangeMessageVisibilityBatchResultEntry items.

$sel:failed:ChangeMessageVisibilityBatchResponse', changeMessageVisibilityBatchResponse_failed - A list of BatchResultErrorEntry items.

See: newCreateQueue smart constructor.

Create a value of CreateQueue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateQueue, createQueue_attributes - A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:

• DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.
• MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
• 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).
• Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Amazon IAM User Guide.
• 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.

• RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide.

  • deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
  • maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.

  The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.

• VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to server-side-encryption:

• KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the Key Management Service API Reference.
• KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.
• SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).

The following attributes apply only to FIFO (first-in-first-out) queues:

• FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.

  For more information, see FIFO queue logic in the Amazon SQS Developer Guide.

• ContentBasedDeduplication – Enables content-based deduplication. Valid values are true and false. For more information, see Exactly-once processing in the Amazon SQS Developer Guide. Note the following:

  • Every message must have a unique MessageDeduplicationId.

    • You may provide a MessageDeduplicationId explicitly.
    • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
    • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.
    • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
  • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
  • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

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.
• 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.

To enable high throughput for FIFO queues, do the following:

• Set DeduplicationScope to messageGroup.
• Set FifoThroughputLimit to perMessageGroupId.

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.

$sel:tags:CreateQueue', createQueue_tags - Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon SQS Developer Guide.

When you use queue tags, keep the following guidelines in mind:

• Adding more than 50 tags to a queue isn't recommended.
• Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
• Tags are case-sensitive.
• A new tag with a key identical to that of an existing tag overwrites the existing tag.

For a full list of tag restrictions, see Quotas related to queues in the Amazon SQS Developer Guide.

To be able to tag a queue on creation, you must have the sqs:CreateQueue and sqs:TagQueue permissions.

Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon SQS Developer Guide.

$sel:queueName:CreateQueue', createQueue_queueName - 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 (-), and underscores (_).
• A FIFO queue name must end with the .fifo suffix.

Queue URLs and names are case-sensitive.

Returns the QueueUrl attribute of the created queue.

See: newCreateQueueResponse smart constructor.

Create a value of CreateQueueResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:queueUrl:CreateQueueResponse', createQueueResponse_queueUrl - The URL of the created Amazon SQS queue.

$sel:httpStatus:CreateQueueResponse', createQueueResponse_httpStatus - The response's http status code.

See: newDeleteMessage smart constructor.

Create a value of DeleteMessage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:queueUrl:DeleteMessage', deleteMessage_queueUrl - The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

DeleteMessage, deleteMessage_receiptHandle - The receipt handle associated with the message to delete.

See: newDeleteMessageResponse smart constructor.

Create a value of DeleteMessageResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

See: newDeleteMessageBatch smart constructor.

Create a value of DeleteMessageBatch with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:queueUrl:DeleteMessageBatch', deleteMessageBatch_queueUrl - The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs and names are case-sensitive.

$sel:entries:DeleteMessageBatch', deleteMessageBatch_entries - A list of receipt handles for the messages to be deleted.

For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is deleted or a BatchResultErrorEntry tag if the message can't be deleted.

See: newDeleteMessageBatchResponse smart constructor.

Create a value of DeleteMessageBatchResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeleteMessageBatchResponse', deleteMessageBatchResponse_httpStatus - The response's http status code.

$sel:successful:DeleteMessageBatchResponse', deleteMessageBatchResponse_successful - A list of DeleteMessageBatchResultEntry items.

$sel:failed:DeleteMessageBatchResponse', deleteMessageBatchResponse_failed - A list of BatchResultErrorEntry items.

See: newDeleteQueue smart constructor.

Create a value of DeleteQueue with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:queueUrl:DeleteQueue', deleteQueue_queueUrl - The URL of the Amazon SQS queue to delete.

Queue URLs and names are case-sensitive.

See: newDeleteQueueResponse smart constructor.

Create a value of DeleteQueueResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

See: newGetQueueAttributes smart constructor.

Create a value of GetQueueAttributes with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributeNames:GetQueueAttributes', getQueueAttributes_attributeNames - A list of attributes for which to retrieve information.

The AttributeName.N parameter is optional, but if you don't specify values for this parameter, the request returns empty results.

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

The following attributes are supported:

The ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, and ApproximateNumberOfMessagesVisible metrics may not achieve consistency until at least 1 minute after the producers stop sending messages. This period is required for the queue metadata to reach eventual consistency.

• All – Returns all values.
• 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.
• 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).
• DelaySeconds – Returns the default delay on the queue in seconds.
• LastModifiedTimestamp – Returns the time when the queue was last changed in seconds (epoch time).
• MaximumMessageSize – Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.
• MessageRetentionPeriod – Returns the length of time, in seconds, for which Amazon SQS retains a message.
• Policy – Returns the policy of the queue.
• QueueArn – Returns the Amazon resource name (ARN) of the queue.
• ReceiveMessageWaitTimeSeconds – Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

• RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer Guide.

  • deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
  • maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
• VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to 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.
• KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. For more information, see How Does the Data Key Reuse Period Work?.
• SqsManagedSseEnabled – Returns information about whether the queue is using SSE-SQS encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).

The following attributes apply only to FIFO (first-in-first-out) queues:

• FifoQueue – Returns information about whether the queue is FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer Guide.

  To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

• ContentBasedDeduplication – Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.

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.
• 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.

To enable high throughput for FIFO queues, do the following:

• Set DeduplicationScope to messageGroup.
• Set FifoThroughputLimit to perMessageGroupId.

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.

$sel:queueUrl:GetQueueAttributes', getQueueAttributes_queueUrl - The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs and names are case-sensitive.

A list of returned queue attributes.

See: newGetQueueAttributesResponse smart constructor.

Create a value of GetQueueAttributesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetQueueAttributesResponse, getQueueAttributesResponse_attributes - A map of attributes to their respective values.

$sel:httpStatus:GetQueueAttributesResponse', getQueueAttributesResponse_httpStatus - The response's http status code.

See: newGetQueueUrl smart constructor.

Create a value of GetQueueUrl with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:queueOwnerAWSAccountId:GetQueueUrl', getQueueUrl_queueOwnerAWSAccountId - The Amazon Web Services account ID of the account that created the queue.

$sel:queueName:GetQueueUrl', getQueueUrl_queueName - The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_).

Queue URLs and names are case-sensitive.

For more information, see Interpreting Responses in the Amazon SQS Developer Guide.

See: newGetQueueUrlResponse smart constructor.

Create a value of GetQueueUrlResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:GetQueueUrlResponse', getQueueUrlResponse_httpStatus - The response's http status code.

$sel:queueUrl:GetQueueUrlResponse', getQueueUrlResponse_queueUrl - The URL of the queue.

See: newListDeadLetterSourceQueues smart constructor.