Kafka / Client / list_channels

list_channels¶

Kafka.Client.list_channels(**kwargs)¶

Returns the list of channels in a cluster.

Request Syntax

response = client.list_channels(
    ClusterArn='string',
    MaxResults=123,
    NextToken='string',
    TopicNameFilter='string'
)

Parameters:

ClusterArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) that uniquely identifies the cluster.
MaxResults (integer) – Maximum number of channels to return in a single response.
NextToken (string) – If the response of ListChannels is truncated, it returns a nextToken in the response. This nextToken should be sent in the subsequent request to ListChannels.
TopicNameFilter (string) – Filters results to channels whose topic name matches the specified value.

Return type:

dict

Returns:

Response Syntax

{
    'Channels': [
        {
            'ChannelArn': 'string',
            'ChannelName': 'string',
            'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'|'SUSPENDING'|'SUSPENDED',
            'CreationTime': datetime(2015, 1, 1),
            'DestinationType': 'ICEBERG'|'S3',
            'ClusterOperationArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

Successful response.
- Channels (list) –
  
  The list of channels in the cluster.
  - (dict) –
    
    Summary information about a channel returned by ListChannels.
    - ChannelArn (string) –
      
      The Amazon Resource Name (ARN) that uniquely identifies the channel.
    - ChannelName (string) –
      
      The name of the channel.
    - Status (string) –
      
      The current lifecycle state of the channel.
    - CreationTime (datetime) –
      
      The time when the channel was created.
    - DestinationType (string) –
      
      The type of destination configured for the channel.
    - ClusterOperationArn (string) –
      
      The Amazon Resource Name (ARN) of the in-flight cluster operation. Returned only while the channel is in CREATING, UPDATING, or DELETING.
- NextToken (string) –
  
  If the response from ListChannels is truncated, this token is included. Send it as the nextToken parameter on a subsequent ListChannels call to retrieve the next page.

Exceptions

Kafka.Client.exceptions.BadRequestException
Kafka.Client.exceptions.UnauthorizedException
Kafka.Client.exceptions.InternalServerErrorException
Kafka.Client.exceptions.ForbiddenException
Kafka.Client.exceptions.NotFoundException
Kafka.Client.exceptions.ServiceUnavailableException
Kafka.Client.exceptions.TooManyRequestsException