ListStreamConsumers

class Kinesis.Paginator.ListStreamConsumers

paginator = client.get_paginator('list_stream_consumers')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Kinesis.Client.list_stream_consumers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    StreamARN='string',
    StreamCreationTimestamp=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• StreamARN (string) --

  [REQUIRED]

  The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

• StreamCreationTimestamp (datetime) --

  Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.

  You can't specify this parameter if you specify the NextToken parameter.

• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Consumers': [
        {
            'ConsumerName': 'string',
            'ConsumerARN': 'string',
            'ConsumerStatus': 'CREATING'|'DELETING'|'ACTIVE',
            'ConsumerCreationTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) --

  • Consumers (list) --

    An array of JSON objects. Each object represents one registered consumer.

    • (dict) --

      An object that represents the details of the consumer you registered. This type of object is returned by RegisterStreamConsumer.

      • 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) --