Kinesis / Client / describe_stream_consumer

describe_stream_consumer#

Kinesis.Client.describe_stream_consumer(**kwargs)#

To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don’t conflict with each other. If you don’t know the name or ARN of the consumer that you want to describe, 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.

This operation has a limit of 20 transactions per second per stream.

Note

When making a cross-account call with DescribeStreamConsumer, make sure to provide the ARN of the consumer.

See also: AWS API Documentation

Request Syntax

response = client.describe_stream_consumer(
    StreamARN='string',
    ConsumerName='string',
    ConsumerARN='string'
)
Parameters:

  • StreamARN (string) – 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.

  • ConsumerName (string) – The name that you gave to the consumer.

  • ConsumerARN (string) – The ARN returned by Kinesis Data Streams when you registered the consumer.

Return type:

dict

Returns:

Response Syntax

{
    'ConsumerDescription': {
        'ConsumerName': 'string',
        'ConsumerARN': 'string',
        'ConsumerStatus': 'CREATING'|'DELETING'|'ACTIVE',
        'ConsumerCreationTimestamp': datetime(2015, 1, 1),
        'StreamARN': 'string'
    }
}

Response Structure

  • (dict) –

    • ConsumerDescription (dict) –

      An object that represents the details of the consumer.

      • ConsumerName (string) –

        The name of the consumer is something you choose when you register the consumer.

      • ConsumerARN (string) –

        When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

        If you delete a consumer and then create a new one with the same name, it won’t have the same ARN. That’s because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

      • ConsumerStatus (string) –

        A consumer can’t read data while in the CREATING or DELETING states.

      • ConsumerCreationTimestamp (datetime) –

      • StreamARN (string) –

        The ARN of the stream with which you registered the consumer.

Exceptions