View a markdown version of this page

QueueDescription - Amazon Kinesis Data Streams Service

QueueDescription

A description of a queue. Returned by CreateQueue, UpdateQueue, and DescribeQueue.

Contents

QueueARN

The ARN of the queue. The resource identifier in the ARN is generated when the queue is created and is not derived from QueueName. Use the returned QueueARN to identify the queue in subsequent requests.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws.*:kinesis:.*:\d{12}:queue/\S+

Required: Yes

QueueCreationTimestamp

The time the queue was created.

Type: Timestamp

Required: Yes

QueueName

The name of the queue.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

QueueStatus

The current status of the queue.

Type: String

Valid Values: CREATING | ACTIVE | UPDATING | DELETING

Required: Yes

StreamConfigurationList

The data stream the queue delivers records from, and the position in that stream where delivery begins. The list contains exactly one entry, because a queue delivers records from a single data stream.

Type: Array of QueueStreamConfiguration objects

Array Members: Fixed number of 1 item.

Required: Yes

QueueAttributes

The configuration attributes of the queue.

Type: QueueAttributes object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: