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

******************
list_channel_flows
******************



.. py:method:: ChimeSDKMessaging.Client.list_channel_flows(**kwargs)

  

  Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelFlows>`_  


  **Request Syntax**
  ::

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

    The ARN of the app instance.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of channel flows that you want to return.

    

  
  :type NextToken: string
  :param NextToken: 

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

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ChannelFlows': [
              {
                  'ChannelFlowArn': 'string',
                  'Name': 'string',
                  'Processors': [
                      {
                          'Name': 'string',
                          'Configuration': {
                              'Lambda': {
                                  'ResourceArn': 'string',
                                  'InvocationType': 'ASYNC'
                              }
                          },
                          'ExecutionOrder': 123,
                          'FallbackAction': 'CONTINUE'|'ABORT'
                      },
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ChannelFlows** *(list) --* 

        The information about each channel flow.

        
        

        - *(dict) --* 

          Summary of details of a channel flow.

          
          

          - **ChannelFlowArn** *(string) --* 

            The ARN of the channel flow.

            
          

          - **Name** *(string) --* 

            The name of the channel flow.

            
          

          - **Processors** *(list) --* 

            Information about the processor Lambda functions.

            
            

            - *(dict) --* 

              The information about a processor in a channel flow.

              
              

              - **Name** *(string) --* 

                The name of the channel flow.

                
              

              - **Configuration** *(dict) --* 

                The information about the type of processor and its identifier.

                
                

                - **Lambda** *(dict) --* 

                  Indicates that the processor is of type Lambda.

                  
                  

                  - **ResourceArn** *(string) --* 

                    The ARN of the Lambda message processing function.

                    
                  

                  - **InvocationType** *(string) --* 

                    Controls how the Lambda function is invoked.

                    
              
            
              

              - **ExecutionOrder** *(integer) --* 

                The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.

                
              

              - **FallbackAction** *(string) --* 

                Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of ``ABORT`` and communication with it fails, the processor sets the message status to ``FAILED`` and does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action of ``CONTINUE`` and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.

                
          
        
      
    
      

      - **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`

  