class Aws::DynamoDBStreams::Types::StreamDescription

Represents all of the data describing a particular stream.

@!attribute [rw] stream_arn

The Amazon Resource Name (ARN) for the stream.
@return [String]

@!attribute [rw] stream_label

A timestamp, in ISO 8601 format, for this stream.

Note that `LatestStreamLabel` is not a unique identifier for the
stream, because it is possible that a stream from another table
might have the same timestamp. However, the combination of the
following three elements is guaranteed to be unique:

* the AWS customer ID.

* the table name

* the `StreamLabel`
@return [String]

@!attribute [rw] stream_status

Indicates the current status of the stream:

* `ENABLING` - Streams is currently being enabled on the DynamoDB
  table.

* `ENABLED` - the stream is enabled.

* `DISABLING` - Streams is currently being disabled on the DynamoDB
  table.

* `DISABLED` - the stream is disabled.
@return [String]

@!attribute [rw] stream_view_type

Indicates the format of the records within this stream:

* `KEYS_ONLY` - only the key attributes of items that were modified
  in the DynamoDB table.

* `NEW_IMAGE` - entire items from the table, as they appeared after
  they were modified.

* `OLD_IMAGE` - entire items from the table, as they appeared before
  they were modified.

* `NEW_AND_OLD_IMAGES` - both the new and the old images of the
  items from the table.
@return [String]

@!attribute [rw] creation_request_date_time

The date and time when the request to create this stream was issued.
@return [Time]

@!attribute [rw] table_name

The DynamoDB table with which the stream is associated.
@return [String]

@!attribute [rw] key_schema

The key attribute(s) of the stream's DynamoDB table.
@return [Array<Types::KeySchemaElement>]

@!attribute [rw] shards

The shards that comprise the stream.
@return [Array<Types::Shard>]

@!attribute [rw] last_evaluated_shard_id

The shard ID of the item where the operation stopped, inclusive of
the previous result set. Use this value to start a new operation,
excluding this value in the new request.

If `LastEvaluatedShardId` is empty, then the "last page" of
results has been processed and there is currently no more data to be
retrieved.

If `LastEvaluatedShardId` is not empty, it does not necessarily mean
that there is more data in the result set. The only way to know when
you have reached the end of the result set is when
`LastEvaluatedShardId` is empty.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/streams-dynamodb-2012-08-10/StreamDescription AWS API Documentation

Constants

SENSITIVE