:doc:`QuickSight <../../quicksight>` / Client / get_flow_metadata

*****************
get_flow_metadata
*****************



.. py:method:: QuickSight.Client.get_flow_metadata(**kwargs)

  

  Retrieves the metadata of a flow, not including its definition specifying the steps.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetFlowMetadata>`_  


  **Request Syntax**
  ::

    response = client.get_flow_metadata(
        AwsAccountId='string',
        FlowId='string'
    )
    
  :type AwsAccountId: string
  :param AwsAccountId: **[REQUIRED]** 

    The ID of the Amazon Web Services account that contains the flow that you are getting metadata for.

    

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

    The unique identifier of the flow.

    

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

    
    ::

      {
          'Arn': 'string',
          'FlowId': 'string',
          'Name': 'string',
          'Description': 'string',
          'PublishState': 'PUBLISHED'|'DRAFT'|'PENDING_APPROVAL',
          'UserCount': 123,
          'RunCount': 123,
          'CreatedTime': datetime(2015, 1, 1),
          'LastUpdatedTime': datetime(2015, 1, 1),
          'RequestId': 'string',
          'Status': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The Amazon Resource Name (ARN) of the flow.

        
      

      - **FlowId** *(string) --* 

        The unique identifier of the flow.

        
      

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

        A display name for the flow.

        
      

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

        The description for the flow.

        
      

      - **PublishState** *(string) --* 

        The publish state for the flow. Valid values are ``DRAFT``, ``PUBLISHED``, or ``PENDING_APPROVAL``.

        
      

      - **UserCount** *(integer) --* 

        The number of users who have used the flow.

        
      

      - **RunCount** *(integer) --* 

        The number of runs done for the flow.

        
      

      - **CreatedTime** *(datetime) --* 

        The time this flow was created.

        
      

      - **LastUpdatedTime** *(datetime) --* 

        The last time this flow was modified.

        
      

      - **RequestId** *(string) --* 

        The Amazon Web Services request ID for this operation.

        
      

      - **Status** *(integer) --* 

        The HTTP status of the request.

        
  
  **Exceptions**
  
  *   :py:class:`QuickSight.Client.exceptions.ThrottlingException`

  
  *   :py:class:`QuickSight.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`QuickSight.Client.exceptions.InternalFailureException`

  
  *   :py:class:`QuickSight.Client.exceptions.AccessDeniedException`

  