Skip to content

/AWS1/CL_KNSSTREAMDESCRIPTION

Represents the output for DescribeStream.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_streamname TYPE /AWS1/KNSSTREAMNAME /AWS1/KNSSTREAMNAME

The name of the stream being described.

iv_streamarn TYPE /AWS1/KNSSTREAMARN /AWS1/KNSSTREAMARN

The Amazon Resource Name (ARN) for the stream being described.

iv_streamstatus TYPE /AWS1/KNSSTREAMSTATUS /AWS1/KNSSTREAMSTATUS

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

it_shards TYPE /AWS1/CL_KNSSHARD=>TT_SHARDLIST TT_SHARDLIST

The shards that comprise the stream.

iv_hasmoreshards TYPE /AWS1/KNSBOOLEANOBJECT /AWS1/KNSBOOLEANOBJECT

If set to true, more shards in the stream are available to describe.

iv_retentionperiodhours TYPE /AWS1/KNSRETENTIONPERIODHOURS /AWS1/KNSRETENTIONPERIODHOURS

The current retention period, in hours. Minimum value of 24. Maximum value of 168.

iv_streamcreationtimestamp TYPE /AWS1/KNSTIMESTAMP /AWS1/KNSTIMESTAMP

The approximate time that the stream was created.

it_enhancedmonitoring TYPE /AWS1/CL_KNSENHANCEDMETRICS=>TT_ENHANCEDMONITORINGLIST TT_ENHANCEDMONITORINGLIST

Represents the current enhanced monitoring settings of the stream.

Optional arguments:

io_streammodedetails TYPE REF TO /AWS1/CL_KNSSTREAMMODEDETAILS /AWS1/CL_KNSSTREAMMODEDETAILS

Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

iv_encryptiontype TYPE /AWS1/KNSENCRYPTIONTYPE /AWS1/KNSENCRYPTIONTYPE

The server-side encryption type used on the stream. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.

iv_keyid TYPE /AWS1/KNSKEYID /AWS1/KNSKEYID

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

Queryable Attributes

StreamName

The name of the stream being described.

Accessible with the following methods

Method Description
GET_STREAMNAME() Getter for STREAMNAME, with configurable default
ASK_STREAMNAME() Getter for STREAMNAME w/ exceptions if field has no value
HAS_STREAMNAME() Determine if STREAMNAME has a value

StreamARN

The Amazon Resource Name (ARN) for the stream being described.

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

StreamStatus

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

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

StreamModeDetails

Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

Accessible with the following methods

Method Description
GET_STREAMMODEDETAILS() Getter for STREAMMODEDETAILS

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

HasMoreShards

If set to true, more shards in the stream are available to describe.

Accessible with the following methods

Method Description
GET_HASMORESHARDS() Getter for HASMORESHARDS, with configurable default
ASK_HASMORESHARDS() Getter for HASMORESHARDS w/ exceptions if field has no value
HAS_HASMORESHARDS() Determine if HASMORESHARDS has a value

RetentionPeriodHours

The current retention period, in hours. Minimum value of 24. Maximum value of 168.

Accessible with the following methods

Method Description
GET_RETENTIONPERIODHOURS() Getter for RETENTIONPERIODHOURS, with configurable default
ASK_RETENTIONPERIODHOURS() Getter for RETENTIONPERIODHOURS w/ exceptions if field has n
HAS_RETENTIONPERIODHOURS() Determine if RETENTIONPERIODHOURS has a value

StreamCreationTimestamp

The approximate time that the stream was created.

Accessible with the following methods

Method Description
GET_STREAMCREATIONTIMESTAMP() Getter for STREAMCREATIONTIMESTAMP, with configurable defaul
ASK_STREAMCREATIONTIMESTAMP() Getter for STREAMCREATIONTIMESTAMP w/ exceptions if field ha
HAS_STREAMCREATIONTIMESTAMP() Determine if STREAMCREATIONTIMESTAMP has a value

EnhancedMonitoring

Represents the current enhanced monitoring settings of the stream.

Accessible with the following methods

Method Description
GET_ENHANCEDMONITORING() Getter for ENHANCEDMONITORING, with configurable default
ASK_ENHANCEDMONITORING() Getter for ENHANCEDMONITORING w/ exceptions if field has no
HAS_ENHANCEDMONITORING() Determine if ENHANCEDMONITORING has a value

EncryptionType

The server-side encryption type used on the stream. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.

Accessible with the following methods

Method Description
GET_ENCRYPTIONTYPE() Getter for ENCRYPTIONTYPE, with configurable default
ASK_ENCRYPTIONTYPE() Getter for ENCRYPTIONTYPE w/ exceptions if field has no valu
HAS_ENCRYPTIONTYPE() Determine if ENCRYPTIONTYPE has a value

KeyId

The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

Accessible with the following methods

Method Description
GET_KEYID() Getter for KEYID, with configurable default
ASK_KEYID() Getter for KEYID w/ exceptions if field has no value
HAS_KEYID() Determine if KEYID has a value