QueueStartingPosition
The position in a data stream from which a queue begins delivering records.
Contents
- Type
-
You can set the starting position to one of the following values:
LATEST: Delivers records that arrive after you create the queue. This is the default.TRIM_HORIZON: Start delivering at the last untrimmed record in the stream, which is the oldest record the stream still retains.AT_TIMESTAMP: Delivers records that arrive at or after a time stamp that you provide.Type: String
Valid Values:
TRIM_HORIZON | LATEST | AT_TIMESTAMPRequired: Yes
- Timestamp
-
The approximate time from which the queue begins delivering records. Records that arrive at approximately this time or later are delivered.
In a request, specify this value only when
TypeisAT_TIMESTAMP. It is required in that case, and specifying it for any other type returns aValidationException.In a response, this value is approximate and reflects the queue's effective starting position. While the queue is
CREATING, the response echoes what you configured: forAT_TIMESTAMP, the timestamp you provided, and forTRIM_HORIZONandLATEST, this member is absent because the effective position is not yet determined. Once the queue isACTIVE, the response always includes this member. ForAT_TIMESTAMP, it is the timestamp you provided or the earliest time the stream can be read from, whichever is later.Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: