Kinesis / Client / list_channels

list_channels

Kinesis.Client.list_channels(**kwargs)

Lists the channels in your account. You can filter the results by source stream. The results are paginated. Use the NextToken value returned in the response to retrieve additional results.

Use this operation to find channels before deleting a stream, or to audit the channels configured in an Amazon Web Services Region.

This operation has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. Exceeding 5 TPS results in a LimitExceededException.

See also: AWS API Documentation

Request Syntax

response = client.list_channels(
    StreamFilter=[
        {
            'StreamARN': 'string',
            'StreamCreationTimestamp': datetime(2015, 1, 1)
        },
    ],
    MaxResults=123,
    NextToken='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.

• MaxResults (integer) – The maximum number of channels to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

• NextToken (string) – The pagination token returned by a previous call. Specify this token to retrieve the next page of results. This value is null when there are no more results to return.

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)
                },
            ]
        },
    ],
    'NextToken': 'string'
}

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.

  • NextToken (string) –

    The pagination token to use in a subsequent call to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

• Kinesis.Client.exceptions.ValidationException

• Kinesis.Client.exceptions.ExpiredNextTokenException

• Kinesis.Client.exceptions.LimitExceededException

• Kinesis.Client.exceptions.InvalidArgumentException

• Kinesis.Client.exceptions.AccessDeniedException