list_sub_channels

ChimeSDKMessaging.Client.list_sub_channels(**kwargs)

Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.

See also: AWS API Documentation

Request Syntax

response = client.list_sub_channels(
    ChannelArn='string',
    ChimeBearer='string',
    MaxResults=123,
    NextToken='string'
)

Parameters

• ChannelArn (string) --

  [REQUIRED]

  The ARN of elastic channel.

• ChimeBearer (string) --

  [REQUIRED]

  The AppInstanceUserArn of the user making the API call.

• MaxResults (integer) -- The maximum number of sub-channels that you want to return.
• NextToken (string) -- The token passed by previous API calls until all requested sub-channels are returned.

Return type

dict

Returns

Response Syntax

{
    'ChannelArn': 'string',
    'SubChannels': [
        {
            'SubChannelId': 'string',
            'MembershipCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • ChannelArn (string) --

    The ARN of elastic channel.

  • SubChannels (list) --

    The information about each sub-channel.

    • (dict) --

      Summary of the sub-channels associated with the elastic channel.

      • SubChannelId (string) --

        The unique ID of a SubChannel.

      • MembershipCount (integer) --

        The number of members in a SubChannel.

  • NextToken (string) --

    The token passed by previous API calls until all requested sub-channels are returned.

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