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

*********************
describe_contact_flow
*********************



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

  

  Describes the specified 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>`__.

   

  Use the ``$SAVED`` alias in the request to describe the ``SAVED`` content of a Flow. For example, ``arn:aws:.../contact-flow/{id}:$SAVED``. After a flow is published, ``$SAVED`` needs to be supplied to view saved content that has not been published.

   

  Use ``arn:aws:.../contact-flow/{id}:{version}`` to retrieve the content of a specific flow version.

   

  In the response, **Status** indicates the flow status as either ``SAVED`` or ``PUBLISHED``. The ``PUBLISHED`` status will initiate validation on the content. ``SAVED`` does not initiate validation of the content. ``SAVED`` | ``PUBLISHED``

  

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


  **Request Syntax**
  ::

    response = client.describe_contact_flow(
        InstanceId='string',
        ContactFlowId='string'
    )
    
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance.

    

  
  :type ContactFlowId: string
  :param ContactFlowId: **[REQUIRED]** 

    The identifier of the flow.

    

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

    
    ::

      {
          'ContactFlow': {
              'Arn': 'string',
              'Id': 'string',
              'Name': 'string',
              'Type': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER'|'CAMPAIGN',
              'State': 'ACTIVE'|'ARCHIVED',
              'Status': 'PUBLISHED'|'SAVED',
              'Description': 'string',
              'Content': 'string',
              'Tags': {
                  'string': 'string'
              },
              'FlowContentSha256': 'string',
              'Version': 123,
              'VersionDescription': 'string',
              'LastModifiedTime': datetime(2015, 1, 1),
              'LastModifiedRegion': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ContactFlow** *(dict) --* 

        Information about the flow.

        
        

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

          The Amazon Resource Name (ARN) of the flow.

          
        

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

          The identifier of the flow.

          
        

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

          The name of the flow.

          
        

        - **Type** *(string) --* 

          The type of the flow. For descriptions of the available types, see `Choose a flow type <https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types>`__ in the *Amazon Connect Administrator Guide*.

          
        

        - **State** *(string) --* 

          The type of flow.

          
        

        - **Status** *(string) --* 

          The status of the flow.

          
        

        - **Description** *(string) --* 

          The description of the flow.

          
        

        - **Content** *(string) --* 

          The JSON string that represents the content of the flow. For an example, see `Example flow in Amazon Connect Flow language <https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html>`__.

           

          Length Constraints: Minimum length of 1. Maximum length of 256000.

          
        

        - **Tags** *(dict) --* 

          The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
        

        - **FlowContentSha256** *(string) --* 

          Indicates the checksum value of the flow content.

          
        

        - **Version** *(integer) --* 

          The identifier of the flow version.

          
        

        - **VersionDescription** *(string) --* 

          The description of the flow version.

          
        

        - **LastModifiedTime** *(datetime) --* 

          The time at which the flow was last modified.

          
        

        - **LastModifiedRegion** *(string) --* 

          The region in which the flow was last modified

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

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

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

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

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

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

  