/AWS1/CL_KNSSTREAMDESCSUMMARY¶
Represents the output for DescribeStreamSummary
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 setsStreamStatustoCREATING.
DELETING- The stream is being deleted. The specified stream is in theDELETINGstate 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 anACTIVEstream.
UPDATING- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATINGstate.
iv_retentionperiodhours TYPE /AWS1/KNSRETENTIONPERIODHOURS /AWS1/KNSRETENTIONPERIODHOURS¶
The current retention period, in hours.
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.
iv_openshardcount TYPE /AWS1/KNSSHARDCOUNTOBJECT /AWS1/KNSSHARDCOUNTOBJECT¶
The number of open shards in the stream.
Optional arguments:¶
iv_streamid TYPE /AWS1/KNSSTREAMID /AWS1/KNSSTREAMID¶
Not Implemented. Reserved for future use.
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 ycapacity mode and a provisioned capacity mode for your data streams.
iv_encryptiontype TYPE /AWS1/KNSENCRYPTIONTYPE /AWS1/KNSENCRYPTIONTYPE¶
The encryption type used. This value is one of the following:
KMS
NONE
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-123456789012Alias ARN example:
arn:aws:kms:us-east-1:123456789012:alias/MyAliasNameGlobally unique key ID example:
12345678-1234-1234-1234-123456789012Alias name example:
alias/MyAliasNameMaster key owned by Kinesis Data Streams:
alias/aws/kinesis
iv_consumercount TYPE /AWS1/KNSCONSUMERCOUNTOBJECT /AWS1/KNSCONSUMERCOUNTOBJECT¶
The number of enhanced fan-out consumers registered with the stream.
io_warmthroughput TYPE REF TO /AWS1/CL_KNSWARMTHRUPUTOBJECT /AWS1/CL_KNSWARMTHRUPUTOBJECT¶
The warm throughput in MB/s for the stream. This represents the throughput capacity that will be immediately available for write operations.
iv_maxrecordsizeinkib TYPE /AWS1/KNSMAXRECORDSIZEINKIB /AWS1/KNSMAXRECORDSIZEINKIB¶
The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.
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 |
StreamId¶
Not Implemented. Reserved for future use.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STREAMID() |
Getter for STREAMID, with configurable default |
ASK_STREAMID() |
Getter for STREAMID w/ exceptions if field has no value |
HAS_STREAMID() |
Determine if STREAMID 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 setsStreamStatustoCREATING.
DELETING- The stream is being deleted. The specified stream is in theDELETINGstate 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 anACTIVEstream.
UPDATING- Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in theUPDATINGstate.
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 ycapacity mode and a provisioned capacity mode for your data streams.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STREAMMODEDETAILS() |
Getter for STREAMMODEDETAILS |
RetentionPeriodHours¶
The current retention period, in hours.
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 encryption type used. This value is one of the following:
KMS
NONE
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-123456789012Alias ARN example:
arn:aws:kms:us-east-1:123456789012:alias/MyAliasNameGlobally unique key ID example:
12345678-1234-1234-1234-123456789012Alias name example:
alias/MyAliasNameMaster 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 |
OpenShardCount¶
The number of open shards in the stream.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OPENSHARDCOUNT() |
Getter for OPENSHARDCOUNT, with configurable default |
ASK_OPENSHARDCOUNT() |
Getter for OPENSHARDCOUNT w/ exceptions if field has no valu |
HAS_OPENSHARDCOUNT() |
Determine if OPENSHARDCOUNT has a value |
ConsumerCount¶
The number of enhanced fan-out consumers registered with the stream.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONSUMERCOUNT() |
Getter for CONSUMERCOUNT, with configurable default |
ASK_CONSUMERCOUNT() |
Getter for CONSUMERCOUNT w/ exceptions if field has no value |
HAS_CONSUMERCOUNT() |
Determine if CONSUMERCOUNT has a value |
WarmThroughput¶
The warm throughput in MB/s for the stream. This represents the throughput capacity that will be immediately available for write operations.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_WARMTHROUGHPUT() |
Getter for WARMTHROUGHPUT |
MaxRecordSizeInKiB¶
The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAXRECORDSIZEINKIB() |
Getter for MAXRECORDSIZEINKIB, with configurable default |
ASK_MAXRECORDSIZEINKIB() |
Getter for MAXRECORDSIZEINKIB w/ exceptions if field has no |
HAS_MAXRECORDSIZEINKIB() |
Determine if MAXRECORDSIZEINKIB has a value |