:doc:`ChimeSDKMessaging <../../chime-sdk-messaging>` / Client / list_channels_associated_with_channel_flow

******************************************
list_channels_associated_with_channel_flow
******************************************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlow>`_  


  **Request Syntax**
  ::

    response = client.list_channels_associated_with_channel_flow(
        ChannelFlowArn='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type ChannelFlowArn: string
  :param ChannelFlowArn: **[REQUIRED]** 

    The ARN of the channel flow.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of channels that you want to return.

    

  
  :type NextToken: string
  :param NextToken: 

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

    

  
  
  :rtype: 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**
  
  *   :py:class:`ChimeSDKMessaging.Client.exceptions.BadRequestException`

  
  *   :py:class:`ChimeSDKMessaging.Client.exceptions.ForbiddenException`

  
  *   :py:class:`ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException`

  
  *   :py:class:`ChimeSDKMessaging.Client.exceptions.ThrottledClientException`

  
  *   :py:class:`ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`ChimeSDKMessaging.Client.exceptions.ServiceFailureException`

  