Table of Contents

Class StreamDescription

Namespace
Amazon.DynamoDBv2.Model
Assembly
AWSSDK.DynamoDBv2.dll

Represents all of the data describing a particular stream.

public class StreamDescription
Inheritance
StreamDescription
Inherited Members

Constructors

StreamDescription()

public StreamDescription()

Properties

CreationRequestDateTime

Gets and sets the property CreationRequestDateTime.

The date and time when the request to create this stream was issued.

public DateTime CreationRequestDateTime { get; set; }

Property Value

DateTime

KeySchema

Gets and sets the property KeySchema.

The key attribute(s) of the stream's DynamoDB table.

public List<KeySchemaElement> KeySchema { get; set; }

Property Value

List<KeySchemaElement>

LastEvaluatedShardId

Gets and sets the property LastEvaluatedShardId.

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.
public string LastEvaluatedShardId { get; set; }

Property Value

string

Shards

Gets and sets the property Shards.

The shards that comprise the stream.

public List<Shard> Shards { get; set; }

Property Value

List<Shard>

StreamArn

Gets and sets the property StreamArn.

The Amazon Resource Name (ARN) for the stream.

public string StreamArn { get; set; }

Property Value

string

StreamLabel

Gets and sets the property StreamLabel.

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
public string StreamLabel { get; set; }

Property Value

string

StreamStatus

Gets and sets the property StreamStatus.

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.
public StreamStatus StreamStatus { get; set; }

Property Value

StreamStatus

StreamViewType

Gets and sets the property StreamViewType.

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.
public StreamViewType StreamViewType { get; set; }

Property Value

StreamViewType

TableName

Gets and sets the property TableName.

The DynamoDB table with which the stream is associated.

public string TableName { get; set; }

Property Value

string