StreamDescriptionSummary ¶

class StreamDescriptionSummary(TypedDict, closed=True):
    stream_name: "capo_kinesis.types.stream_name.StreamName"
    """<p>The name of the stream being described.</p>"""
    stream_arn: "capo_kinesis.types.stream_arn.StreamARN"
    """<p>The Amazon Resource Name (ARN) for the stream being described.</p>"""
    stream_id: NotRequired["capo_kinesis.types.stream_id.StreamId"]
    """<p>Not Implemented. Reserved for future use.</p>"""
    stream_status: "capo_kinesis.types.stream_status.StreamStatus"
    """<p>The current status of the stream being described. The stream status is one of the following states:</p> <ul> <li> <p> <code>CREATING</code> - The stream is being created. Kinesis Data Streams immediately returns and sets <code>StreamStatus</code> to <code>CREATING</code>.</p> </li> <li> <p> <code>DELETING</code> - The stream is being deleted. The specified stream is in the <code>DELETING</code> state until Kinesis Data Streams completes the deletion.</p> </li> <li> <p> <code>ACTIVE</code> - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an <code>ACTIVE</code> stream.</p> </li> <li> <p> <code>UPDATING</code> - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state.</p> </li> </ul>"""
    stream_mode_details: NotRequired[
        "capo_kinesis.types.stream_mode_details.StreamModeDetails"
    ]
    """<p> Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an <b>on-demand</b> ycapacity mode and a <b>provisioned</b> capacity mode for your data streams. </p>"""
    retention_period_hours: (
        "capo_kinesis.types.retention_period_hours.RetentionPeriodHours"
    )
    """<p>The current retention period, in hours.</p>"""
    stream_creation_timestamp: "capo_kinesis.types.timestamp.Timestamp"
    """<p>The approximate time that the stream was created.</p>"""
    enhanced_monitoring: (
        "capo_kinesis.types.enhanced_monitoring_list.EnhancedMonitoringList"
    )
    """<p>Represents the current enhanced monitoring settings of the stream.</p>"""
    encryption_type: NotRequired["capo_kinesis.types.encryption_type.EncryptionType"]
    """<p>The encryption type used. This value is one of the following:</p> <ul> <li> <p> <code>KMS</code> </p> </li> <li> <p> <code>NONE</code> </p> </li> </ul>"""
    key_id: NotRequired["capo_kinesis.types.key_id.KeyId"]
    """<p>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 <code>aws/kinesis</code>.</p> <ul> <li> <p>Key ARN example: <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias ARN example: <code> arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code> </p> </li> <li> <p>Globally unique key ID example: <code>12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias name example: <code>alias/MyAliasName</code> </p> </li> <li> <p>Master key owned by Kinesis Data Streams: <code>alias/aws/kinesis</code> </p> </li> </ul>"""
    open_shard_count: "capo_kinesis.types.shard_count_object.ShardCountObject"
    """<p>The number of open shards in the stream.</p>"""
    consumer_count: NotRequired[
        "capo_kinesis.types.consumer_count_object.ConsumerCountObject"
    ]
    """<p>The number of enhanced fan-out consumers registered with the stream.</p>"""
    warm_throughput: NotRequired[
        "capo_kinesis.types.warm_throughput_object.WarmThroughputObject"
    ]
    """<p>The warm throughput in MB/s for the stream. This represents the throughput capacity that will be immediately available for write operations.</p>"""
    max_record_size_in_ki_b: NotRequired[
        "capo_kinesis.types.max_record_size_in_ki_b.MaxRecordSizeInKiB"
    ]
    """<p>The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.</p>"""
    channel_count: NotRequired[
        "capo_kinesis.types.channel_count_object.ChannelCountObject"
    ]
    """<p>The number of channels associated with the stream.</p>"""
    record_distribution_strategy: NotRequired[
        "capo_kinesis.types.record_distribution_strategy.RecordDistributionStrategy"
    ]
    """<p>The record distribution strategy that the stream currently uses. A value of <code>AUTO</code> indicates that Amazon Kinesis Data Streams distributes records across shards using service-managed algorithms. A value of <code>USER_PARTITION_KEY</code> indicates that shard placement is determined by the partition key that producers supply. This field is only present for streams that use the on-demand capacity mode.</p>"""