list_channels

list_channels(**kwargs)

Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results.

Functionality & restrictions

• Use privacy = PUBLIC to retrieve all public channels in the account.
• Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account.

Note

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

See also: AWS API Documentation

Request Syntax

response = client.list_channels(
    AppInstanceArn='string',
    Privacy='PUBLIC'|'PRIVATE',
    MaxResults=123,
    NextToken='string',
    ChimeBearer='string'
)

Parameters

• AppInstanceArn (string) --

  [REQUIRED]

  The ARN of the AppInstance .

• Privacy (string) -- The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.
• MaxResults (integer) -- The maximum number of channels that you want to return.
• NextToken (string) -- The token passed by previous API calls until all requested channels are returned.
• ChimeBearer (string) --

  [REQUIRED]

  The AppInstanceUserArn of the user that makes the API call.

Return type

dict

Returns

Response Syntax

{
    'Channels': [
        {
            'Name': 'string',
            'ChannelArn': 'string',
            'Mode': 'UNRESTRICTED'|'RESTRICTED',
            'Privacy': 'PUBLIC'|'PRIVATE',
            'Metadata': 'string',
            'LastMessageTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Channels (list) --

    The information about each channel.

    • (dict) --

      Summary of the details of a Channel .

      • Name (string) --

        The name of the channel.

      • ChannelArn (string) --

        The ARN of the channel.

      • Mode (string) --

        The mode of the channel.

      • Privacy (string) --

        The privacy setting of the channel.

      • Metadata (string) --

        The metadata of the channel.

      • LastMessageTimestamp (datetime) --

        The time at which the last persistent message in a channel was sent.

  • NextToken (string) --

    The token returned from previous API requests until the number of channels is reached.

Exceptions

• ChimeSDKMessaging.Client.exceptions.BadRequestException
• ChimeSDKMessaging.Client.exceptions.ForbiddenException
• ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException
• ChimeSDKMessaging.Client.exceptions.ThrottledClientException
• ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException
• ChimeSDKMessaging.Client.exceptions.ServiceFailureException