/AWS1/CL_KYZGETSTREAMOUTPUT¶
GetStreamOutput
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_streamarn TYPE /AWS1/KYZSTREAMARN /AWS1/KYZSTREAMARN¶
The Amazon Resource Name (ARN) that uniquely identifies the stream within Amazon Keyspaces. This ARN can be used in other API operations to reference this specific stream.
iv_streamlabel TYPE /AWS1/KYZSTRING /AWS1/KYZSTRING¶
A timestamp that serves as a unique identifier for this stream, used for debugging and monitoring purposes. The stream label represents the point in time when the stream was created.
iv_streamstatus TYPE /AWS1/KYZSTREAMSTATUS /AWS1/KYZSTREAMSTATUS¶
The current status of the stream. Values can be
ENABLING,ENABLED,DISABLING, orDISABLED. Operations on the stream depend on its current status.
iv_streamviewtype TYPE /AWS1/KYZSTREAMVIEWTYPE /AWS1/KYZSTREAMVIEWTYPE¶
The format of the data records in this stream. Currently, this can be one of the following options:
NEW_AND_OLD_IMAGES- both versions of the row, before and after the change. This is the default.
NEW_IMAGE- the version of the row after the change.
OLD_IMAGE- the version of the row before the change.
KEYS_ONLY- the partition and clustering keys of the row that was changed.
iv_creationrequestdatetime TYPE /AWS1/KYZDATE /AWS1/KYZDATE¶
The date and time when the request to create this stream was issued. The value is represented in ISO 8601 format.
iv_keyspacename TYPE /AWS1/KYZKEYSPACENAME /AWS1/KYZKEYSPACENAME¶
The name of the keyspace containing the table associated with this stream. The keyspace name is part of the table's hierarchical identifier in Amazon Keyspaces.
iv_tablename TYPE /AWS1/KYZTABLENAME /AWS1/KYZTABLENAME¶
The name of the table associated with this stream. The stream captures changes to rows in this Amazon Keyspaces table.
Optional arguments:¶
it_shards TYPE /AWS1/CL_KYZSHARD=>TT_SHARDDESCRIPTIONLIST TT_SHARDDESCRIPTIONLIST¶
An array of shard objects associated with this stream. Each shard contains a subset of the stream's data records and has its own unique identifier. The collection of shards represents the complete stream data.
iv_nexttoken TYPE /AWS1/KYZSHARDIDTOKEN /AWS1/KYZSHARDIDTOKEN¶
A pagination token that can be used in a subsequent
GetStreamrequest. This token is returned if the response contains more shards than can be returned in a single response.
Queryable Attributes¶
streamArn¶
The Amazon Resource Name (ARN) that uniquely identifies the stream within Amazon Keyspaces. This ARN can be used in other API operations to reference this specific 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 that serves as a unique identifier for this stream, used for debugging and monitoring purposes. The stream label represents the point in time when the stream was created.
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¶
The current status of the stream. Values can be
ENABLING,ENABLED,DISABLING, orDISABLED. Operations on the stream depend on its current status.
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¶
The format of the data records in this stream. Currently, this can be one of the following options:
NEW_AND_OLD_IMAGES- both versions of the row, before and after the change. This is the default.
NEW_IMAGE- the version of the row after the change.
OLD_IMAGE- the version of the row before the change.
KEYS_ONLY- the partition and clustering keys of the row that was changed.
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. The value is represented in ISO 8601 format.
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 |
keyspaceName¶
The name of the keyspace containing the table associated with this stream. The keyspace name is part of the table's hierarchical identifier in Amazon Keyspaces.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KEYSPACENAME() |
Getter for KEYSPACENAME, with configurable default |
ASK_KEYSPACENAME() |
Getter for KEYSPACENAME w/ exceptions if field has no value |
HAS_KEYSPACENAME() |
Determine if KEYSPACENAME has a value |
tableName¶
The name of the table associated with this stream. The stream captures changes to rows in this Amazon Keyspaces table.
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 |
shards¶
An array of shard objects associated with this stream. Each shard contains a subset of the stream's data records and has its own unique identifier. The collection of shards represents the complete stream data.
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 |
nextToken¶
A pagination token that can be used in a subsequent
GetStreamrequest. This token is returned if the response contains more shards than can be returned in a single response.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NEXTTOKEN() |
Getter for NEXTTOKEN, with configurable default |
ASK_NEXTTOKEN() |
Getter for NEXTTOKEN w/ exceptions if field has no value |
HAS_NEXTTOKEN() |
Determine if NEXTTOKEN has a value |