Skip to content

DeleteStreamInput

Source code in docs_src/capo_kinesis/types/delete_stream_input.py 
14
15
16
17
18
19
20
21
22
23
24
class DeleteStreamInput(TypedDict, closed=True):
    stream_name: NotRequired["capo_kinesis.types.stream_name.StreamName"]
    """<p>The name of the stream to delete.</p>"""
    enforce_consumer_deletion: NotRequired[
        "capo_kinesis.types.boolean_object.BooleanObject"
    ]
    """<p>If this parameter is unset (<code>null</code>) or if you set it to <code>false</code>, and the stream has registered consumers, the call to <code>DeleteStream</code> fails with a <code>ResourceInUseException</code>. </p>"""
    stream_arn: NotRequired["capo_kinesis.types.stream_arn.StreamARN"]
    """<p>The ARN of the stream.</p>"""
    stream_id: NotRequired["capo_kinesis.types.stream_id.StreamId"]
    """<p>Not Implemented. Reserved for future use.</p>"""

enforce_consumer_deletion instance-attribute 

enforce_consumer_deletion: NotRequired[BooleanObject]

If this parameter is unset (null) or if you set it to false, and the stream has registered consumers, the call to DeleteStream fails with a ResourceInUseException.

stream_arn instance-attribute 

stream_arn: NotRequired[StreamARN]

The ARN of the stream.

stream_id instance-attribute 

stream_id: NotRequired[StreamId]

Not Implemented. Reserved for future use.

stream_name instance-attribute 

stream_name: NotRequired[StreamName]

The name of the stream to delete.