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

****************************
describe_contact_flow_module
****************************



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

  

  Describes the specified flow module.

   

  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.

  

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


  **Request Syntax**
  ::

    response = client.describe_contact_flow_module(
        InstanceId='string',
        ContactFlowModuleId='string'
    )
    
  :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 ContactFlowModuleId: string
  :param ContactFlowModuleId: **[REQUIRED]** 

    The identifier of the flow module.

    

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

    
    ::

      {
          'ContactFlowModule': {
              'Arn': 'string',
              'Id': 'string',
              'Name': 'string',
              'Content': 'string',
              'Description': 'string',
              'State': 'ACTIVE'|'ARCHIVED',
              'Status': 'PUBLISHED'|'SAVED',
              'Tags': {
                  'string': 'string'
              },
              'FlowModuleContentSha256': 'string',
              'Version': 123,
              'VersionDescription': 'string',
              'Settings': 'string',
              'ExternalInvocationConfiguration': {
                  'Enabled': True|False
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ContactFlowModule** *(dict) --* 

        Information about the flow module.

        
        

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

          The Amazon Resource Name (ARN).

          
        

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

          The identifier of the flow module.

          
        

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

          The name of the flow module.

          
        

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

          
        

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

          The description of the flow module.

          
        

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

          The type of flow module.

          
        

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

          The status of the flow module.

          
        

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

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

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
        

        - **FlowModuleContentSha256** *(string) --* 

          Hash of the module content for integrity verification.

          
        

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

          The version of the flow module.

          
        

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

          Description of the version.

          
        

        - **Settings** *(string) --* 

          The configuration settings for the flow module.

          
        

        - **ExternalInvocationConfiguration** *(dict) --* 

          The external invocation configuration for the flow module

          
          

          - **Enabled** *(boolean) --* 

            Enable external invocation.

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

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

  