:doc:`Connect <../../connect>` / Client / list_contact_flows

******************
list_contact_flows
******************



.. py:method:: Connect.Client.list_contact_flows(**kwargs)

  

  Provides information about the flows for the specified Amazon Connect instance.

   

  You can also create and update flows using the `Amazon Connect Flow language <https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html>`__.

   

  For more information about flows, see `Flows <https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html>`__ in the *Amazon Connect Administrator Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactFlows>`_  


  **Request Syntax**
  ::

    response = client.list_contact_flows(
        InstanceId='string',
        ContactFlowTypes=[
            'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER'|'CAMPAIGN',
        ],
        NextToken='string',
        MaxResults=123
    )
    
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

    

  
  :type ContactFlowTypes: list
  :param ContactFlowTypes: 

    The type of flow.

    

  
    - *(string) --* 

    

  :type NextToken: string
  :param NextToken: 

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return per page. The default MaxResult size is 100.

    

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

    
    ::

      {
          'ContactFlowSummaryList': [
              {
                  'Id': 'string',
                  'Arn': 'string',
                  'Name': 'string',
                  'ContactFlowType': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER'|'CAMPAIGN',
                  'ContactFlowState': 'ACTIVE'|'ARCHIVED',
                  'ContactFlowStatus': 'PUBLISHED'|'SAVED'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ContactFlowSummaryList** *(list) --* 

        Information about the flows.

        
        

        - *(dict) --* 

          Contains summary information about a flow.

           

          You can also create and update flows using the `Amazon Connect Flow language <https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html>`__.

          
          

          - **Id** *(string) --* 

            The identifier of the flow.

            
          

          - **Arn** *(string) --* 

            The Amazon Resource Name (ARN) of the flow.

            
          

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

            The name of the flow.

            
          

          - **ContactFlowType** *(string) --* 

            The type of flow.

            
          

          - **ContactFlowState** *(string) --* 

            The type of flow.

            
          

          - **ContactFlowStatus** *(string) --* 

            The status of the flow.

            
      
    
      

      - **NextToken** *(string) --* 

        If there are additional results, this is the token for the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Connect.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`Connect.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Connect.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

  