Kinesis / Paginator / ListChannels

ListChannels

class Kinesis.Paginator.ListChannels

paginator = client.get_paginator('list_channels')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• StreamFilter (list) –

  Filters the results to channels associated with the specified streams.

  • (dict) –

    Filters ListChannels results by source stream.

    • StreamARN (string) – [REQUIRED]

      The Amazon Resource Name (ARN) of the source stream to filter by.

    • StreamCreationTimestamp (datetime) –

      The creation timestamp of the source stream.

• 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

{
    'ChannelSummaries': [
        {
            'ChannelName': 'string',
            'ChannelARN': 'string',
            'ChannelId': 'string',
            'ChannelStatus': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
            'ChannelStatusReason': 'string',
            'ChannelCreationTimestamp': datetime(2015, 1, 1),
            'ChannelDestinationType': 'S3'|'S3_TABLES',
            'Streams': [
                {
                    'StreamARN': 'string',
                    'StreamCreationTimestamp': datetime(2015, 1, 1)
                },
            ]
        },
    ],

}

Response Structure

• (dict) –

  • ChannelSummaries (list) –

    A list of channel summaries.

    • (dict) –

      A summary of a channel, returned by ListChannels.

      • ChannelName (string) –

        The name of the channel.

      • ChannelARN (string) –

        The Amazon Resource Name (ARN) of the channel.

      • ChannelId (string) –

        The unique identifier of the channel.

      • ChannelStatus (string) –

        The current status of the channel. Valid values:

        • CREATING - The channel is being created.

        • ACTIVE - The channel is ready to deliver records.

        • UPDATING - The channel configuration is being updated.

        • DELETING - The channel is being deleted.

        • FAILED - See ChannelStatusReason for the failure cause.

      • ChannelStatusReason (string) –

        A message describing the reason for a FAILED status.

      • ChannelCreationTimestamp (datetime) –

        The time at which the channel was created.

      • ChannelDestinationType (string) –

        The destination type of the channel. Valid values:

        • S3 - Delivery to a general purpose Amazon S3 bucket.

        • S3_TABLES - Delivery to streaming tables on Apache Iceberg.

      • Streams (list) –

        The source streams associated with the channel.

        • (dict) –

          Identifies a source stream associated with a channel.

          • StreamARN (string) –

            The Amazon Resource Name (ARN) of the source Kinesis data stream.

          • StreamCreationTimestamp (datetime) –

            The time at which the source stream was created.