Skip to content

/AWS1/CL_DYSSTREAMDESCRIPTION

Represents all of the data describing a particular stream.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_streamarn TYPE /AWS1/DYSSTREAMARN /AWS1/DYSSTREAMARN

The Amazon Resource Name (ARN) for the stream.

iv_streamlabel TYPE /AWS1/DYSSTRING /AWS1/DYSSTRING

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 Amazon Web Services customer ID.

  • the table name

  • the StreamLabel

iv_streamstatus TYPE /AWS1/DYSSTREAMSTATUS /AWS1/DYSSTREAMSTATUS

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.

iv_streamviewtype TYPE /AWS1/DYSSTREAMVIEWTYPE /AWS1/DYSSTREAMVIEWTYPE

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.

iv_creationrequestdatetime TYPE /AWS1/DYSDATE /AWS1/DYSDATE

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

iv_tablename TYPE /AWS1/DYSTABLENAME /AWS1/DYSTABLENAME

The DynamoDB table with which the stream is associated.

it_keyschema TYPE /AWS1/CL_DYSKEYSCHEMAELEMENT=>TT_KEYSCHEMA TT_KEYSCHEMA

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

it_shards TYPE /AWS1/CL_DYSSHARD=>TT_SHARDDESCRIPTIONLIST TT_SHARDDESCRIPTIONLIST

The shards that comprise the stream.

iv_lastevaluatedshardid TYPE /AWS1/DYSSHARDID /AWS1/DYSSHARDID

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.

Queryable Attributes

StreamArn

The Amazon Resource Name (ARN) for the stream.

Accessible with the following methods

Method Description
GET_STREAMARN() Getter for STREAMARN, with configurable default
ASK_STREAMARN() Getter for STREAMARN w/ exceptions if field has no value
HAS_STREAMARN() Determine if STREAMARN has a value

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 Amazon Web Services customer ID.

  • the table name

  • the StreamLabel

Accessible with the following methods

Method Description
GET_STREAMLABEL() Getter for STREAMLABEL, with configurable default
ASK_STREAMLABEL() Getter for STREAMLABEL w/ exceptions if field has no value
HAS_STREAMLABEL() Determine if STREAMLABEL has a value

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.

Accessible with the following methods

Method Description
GET_STREAMSTATUS() Getter for STREAMSTATUS, with configurable default
ASK_STREAMSTATUS() Getter for STREAMSTATUS w/ exceptions if field has no value
HAS_STREAMSTATUS() Determine if STREAMSTATUS has a value

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.

Accessible with the following methods

Method Description
GET_STREAMVIEWTYPE() Getter for STREAMVIEWTYPE, with configurable default
ASK_STREAMVIEWTYPE() Getter for STREAMVIEWTYPE w/ exceptions if field has no valu
HAS_STREAMVIEWTYPE() Determine if STREAMVIEWTYPE has a value

CreationRequestDateTime

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

Accessible with the following methods

Method Description
GET_CREATIONREQUESTDATETIME() Getter for CREATIONREQUESTDATETIME, with configurable defaul
ASK_CREATIONREQUESTDATETIME() Getter for CREATIONREQUESTDATETIME w/ exceptions if field ha
HAS_CREATIONREQUESTDATETIME() Determine if CREATIONREQUESTDATETIME has a value

TableName

The DynamoDB table with which the stream is associated.

Accessible with the following methods

Method Description
GET_TABLENAME() Getter for TABLENAME, with configurable default
ASK_TABLENAME() Getter for TABLENAME w/ exceptions if field has no value
HAS_TABLENAME() Determine if TABLENAME has a value

KeySchema

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

Accessible with the following methods

Method Description
GET_KEYSCHEMA() Getter for KEYSCHEMA, with configurable default
ASK_KEYSCHEMA() Getter for KEYSCHEMA w/ exceptions if field has no value
HAS_KEYSCHEMA() Determine if KEYSCHEMA has a value

Shards

The shards that comprise the stream.

Accessible with the following methods

Method Description
GET_SHARDS() Getter for SHARDS, with configurable default
ASK_SHARDS() Getter for SHARDS w/ exceptions if field has no value
HAS_SHARDS() Determine if SHARDS has a value

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.

Accessible with the following methods

Method Description
GET_LASTEVALUATEDSHARDID() Getter for LASTEVALUATEDSHARDID, with configurable default
ASK_LASTEVALUATEDSHARDID() Getter for LASTEVALUATEDSHARDID w/ exceptions if field has n
HAS_LASTEVALUATEDSHARDID() Determine if LASTEVALUATEDSHARDID has a value