Skip to content

DeregisterStreamConsumerInput

Source code in docs_src/capo_kinesis/types/deregister_stream_consumer_input.py
class DeregisterStreamConsumerInput(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. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.</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. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.

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.