list_channels_associated_with_channel_flow

ChimeSDKMessaging.Client.list_channels_associated_with_channel_flow(**kwargs)

Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.

See also: AWS API Documentation

Request Syntax

response = client.list_channels_associated_with_channel_flow(
    ChannelFlowArn='string',
    MaxResults=123,
    NextToken='string'
)

Parameters

• ChannelFlowArn (string) --

  [REQUIRED]

  The ARN of the channel flow.

• 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.

Return type

dict

Returns

Response Syntax

{
    'Channels': [
        {
            'Name': 'string',
            'ChannelArn': 'string',
            'Mode': 'UNRESTRICTED'|'RESTRICTED',
            'Privacy': 'PUBLIC'|'PRIVATE',
            'Metadata': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • Channels (list) --

    The information about each channel.

    • (dict) --

      Summary of details of a channel associated with channel flow.

      • Name (string) --

        The name of the channel flow.

      • ChannelArn (string) --

        The ARN of the channel.

      • Mode (string) --

        The mode of the channel.

      • Privacy (string) --

        The channel's privacy setting.

      • Metadata (string) --

        The channel's metadata.

  • NextToken (string) --

    The token passed by previous API calls until all requested 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