Skip to content

DescribeStreamConsumerInput

Source code in docs_src/capo_kinesis/types/describe_stream_consumer_input.py 
14
15
16
17
18
19
20
21
22
class DescribeStreamConsumerInput(TypedDict, closed=True):
    stream_arn: NotRequired["capo_kinesis.types.stream_arn.StreamARN"]
    """<p>The ARN of the Kinesis data stream that the consumer is registered with. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a>.</p>"""
    consumer_name: NotRequired["capo_kinesis.types.consumer_name.ConsumerName"]
    """<p>The name that you gave to the consumer.</p>"""
    consumer_arn: NotRequired["capo_kinesis.types.consumer_arn.ConsumerARN"]
    """<p>The ARN returned by Kinesis Data Streams when you registered the consumer.</p>"""
    stream_id: NotRequired["capo_kinesis.types.stream_id.StreamId"]
    """<p>Not Implemented. Reserved for future use.</p>"""

consumer_arn instance-attribute 

consumer_arn: NotRequired[ConsumerARN]

The ARN returned by Kinesis Data Streams when you registered the consumer.

consumer_name instance-attribute 

consumer_name: NotRequired[ConsumerName]

The name that you gave to the consumer.

stream_arn instance-attribute 

stream_arn: NotRequired[StreamARN]

The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

stream_id instance-attribute 

stream_id: NotRequired[StreamId]

Not Implemented. Reserved for future use.