/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace SQS { namespace Model { /** *

*/ class AWS_SQS_API GetQueueAttributesRequest : public SQSRequest { public: GetQueueAttributesRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "GetQueueAttributes"; } Aws::String SerializePayload() const override; protected: void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs and names are case-sensitive.

*/ inline const Aws::String& GetQueueUrl() const{ return m_queueUrl; } /** *

The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs and names are case-sensitive.

*/ inline bool QueueUrlHasBeenSet() const { return m_queueUrlHasBeenSet; } /** *

The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs and names are case-sensitive.

*/ inline void SetQueueUrl(const Aws::String& value) { m_queueUrlHasBeenSet = true; m_queueUrl = value; } /** *

The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs and names are case-sensitive.

*/ inline void SetQueueUrl(Aws::String&& value) { m_queueUrlHasBeenSet = true; m_queueUrl = std::move(value); } /** *

The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs and names are case-sensitive.

*/ inline void SetQueueUrl(const char* value) { m_queueUrlHasBeenSet = true; m_queueUrl.assign(value); } /** *

The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs and names are case-sensitive.

*/ inline GetQueueAttributesRequest& WithQueueUrl(const Aws::String& value) { SetQueueUrl(value); return *this;} /** *

The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs and names are case-sensitive.

*/ inline GetQueueAttributesRequest& WithQueueUrl(Aws::String&& value) { SetQueueUrl(std::move(value)); return *this;} /** *

The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs and names are case-sensitive.

*/ inline GetQueueAttributesRequest& WithQueueUrl(const char* value) { SetQueueUrl(value); return *this;} /** *

A list of attributes for which to retrieve information.

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 Simple Queue Service * 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 Simple Queue Service Developer Guide.
*

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

KmsMasterKeyId – Returns the ID of an AWS-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 AWS KMS again. For more * information, see How * Does the Data Key Reuse Period Work?.

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

FifoQueue – * Returns whether the queue is FIFO. For more information, see FIFO * Queue Logic in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
*

*/ inline const Aws::Vector& GetAttributeNames() const{ return m_attributeNames; } /** *

A list of attributes for which to retrieve information.

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:

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 Simple Queue Service * 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 Simple Queue Service Developer Guide.
*

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

KmsMasterKeyId – Returns the ID of an AWS-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 AWS KMS again. For more * information, see How * Does the Data Key Reuse Period Work?.

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

FifoQueue – * Returns whether the queue is FIFO. For more information, see FIFO * Queue Logic in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
*

*/ inline bool AttributeNamesHasBeenSet() const { return m_attributeNamesHasBeenSet; } /** *

A list of attributes for which to retrieve information.

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:

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 Simple Queue Service * 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 Simple Queue Service Developer Guide.
*

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

KmsMasterKeyId – Returns the ID of an AWS-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 AWS KMS again. For more * information, see How * Does the Data Key Reuse Period Work?.

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

FifoQueue – * Returns whether the queue is FIFO. For more information, see FIFO * Queue Logic in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
*

*/ inline void SetAttributeNames(const Aws::Vector& value) { m_attributeNamesHasBeenSet = true; m_attributeNames = value; } /** *

A list of attributes for which to retrieve information.

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:

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 Simple Queue Service * 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 Simple Queue Service Developer Guide.
*

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

KmsMasterKeyId – Returns the ID of an AWS-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 AWS KMS again. For more * information, see How * Does the Data Key Reuse Period Work?.

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

FifoQueue – * Returns whether the queue is FIFO. For more information, see FIFO * Queue Logic in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
*

*/ inline void SetAttributeNames(Aws::Vector&& value) { m_attributeNamesHasBeenSet = true; m_attributeNames = std::move(value); } /** *

A list of attributes for which to retrieve information.

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:

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 Simple Queue Service * 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 Simple Queue Service Developer Guide.
*

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

KmsMasterKeyId – Returns the ID of an AWS-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 AWS KMS again. For more * information, see How * Does the Data Key Reuse Period Work?.

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

FifoQueue – * Returns whether the queue is FIFO. For more information, see FIFO * Queue Logic in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
*

*/ inline GetQueueAttributesRequest& WithAttributeNames(const Aws::Vector& value) { SetAttributeNames(value); return *this;} /** *

A list of attributes for which to retrieve information.

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:

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 Simple Queue Service * 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 Simple Queue Service Developer Guide.
*

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

KmsMasterKeyId – Returns the ID of an AWS-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 AWS KMS again. For more * information, see How * Does the Data Key Reuse Period Work?.

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

FifoQueue – * Returns whether the queue is FIFO. For more information, see FIFO * Queue Logic in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
*

*/ inline GetQueueAttributesRequest& WithAttributeNames(Aws::Vector&& value) { SetAttributeNames(std::move(value)); return *this;} /** *

A list of attributes for which to retrieve information.

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:

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 Simple Queue Service * 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 Simple Queue Service Developer Guide.
*

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

KmsMasterKeyId – Returns the ID of an AWS-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 AWS KMS again. For more * information, see How * Does the Data Key Reuse Period Work?.

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

FifoQueue – * Returns whether the queue is FIFO. For more information, see FIFO * Queue Logic in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
*

*/ inline GetQueueAttributesRequest& AddAttributeNames(const QueueAttributeName& value) { m_attributeNamesHasBeenSet = true; m_attributeNames.push_back(value); return *this; } /** *

A list of attributes for which to retrieve information.

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:

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 Simple Queue Service * 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 Simple Queue Service Developer Guide.
*

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

KmsMasterKeyId – Returns the ID of an AWS-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 AWS KMS again. For more * information, see How * Does the Data Key Reuse Period Work?.

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

FifoQueue – * Returns whether the queue is FIFO. For more information, see FIFO * Queue Logic in the Amazon Simple Queue Service 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 Simple Queue Service Developer Guide.
*

*/ inline GetQueueAttributesRequest& AddAttributeNames(QueueAttributeName&& value) { m_attributeNamesHasBeenSet = true; m_attributeNames.push_back(std::move(value)); return *this; } private: Aws::String m_queueUrl; bool m_queueUrlHasBeenSet; Aws::Vector m_attributeNames; bool m_attributeNamesHasBeenSet; }; } // namespace Model } // namespace SQS } // namespace Aws

See Also: