:doc:`SupplyChain <../../supplychain>` / Client / list_data_integration_flow_executions

*************************************
list_data_integration_flow_executions
*************************************



.. py:method:: SupplyChain.Client.list_data_integration_flow_executions(**kwargs)

  

  List flow executions.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/supplychain-2024-01-01/ListDataIntegrationFlowExecutions>`_  


  **Request Syntax**
  ::

    response = client.list_data_integration_flow_executions(
        instanceId='string',
        flowName='string',
        nextToken='string',
        maxResults=123
    )
    
  :type instanceId: string
  :param instanceId: **[REQUIRED]** 

    The AWS Supply Chain instance identifier.

    

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

    The flow name.

    

  
  :type nextToken: string
  :param nextToken: 

    The pagination token to fetch next page of flow executions.

    

  
  :type maxResults: integer
  :param maxResults: 

    The number to specify the max number of flow executions to fetch in this paginated request.

    

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

    
    ::

      {
          'flowExecutions': [
              {
                  'instanceId': 'string',
                  'flowName': 'string',
                  'executionId': 'string',
                  'status': 'SUCCEEDED'|'IN_PROGRESS'|'FAILED',
                  'sourceInfo': {
                      'sourceType': 'S3'|'DATASET',
                      's3Source': {
                          'bucketName': 'string',
                          'key': 'string'
                      },
                      'datasetSource': {
                          'datasetIdentifier': 'string'
                      }
                  },
                  'message': 'string',
                  'startTime': datetime(2015, 1, 1),
                  'endTime': datetime(2015, 1, 1),
                  'outputMetadata': {
                      'diagnosticReportsRootS3URI': 'string'
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The response parameters of ListFlowExecutions.

      
      

      - **flowExecutions** *(list) --* 

        The list of flow executions.

        
        

        - *(dict) --* 

          The flow execution details.

          
          

          - **instanceId** *(string) --* 

            The flow execution's instanceId.

            
          

          - **flowName** *(string) --* 

            The flow execution's flowName.

            
          

          - **executionId** *(string) --* 

            The flow executionId.

            
          

          - **status** *(string) --* 

            The status of flow execution.

            
          

          - **sourceInfo** *(dict) --* 

            The source information for a flow execution.

            
            

            - **sourceType** *(string) --* 

              The data integration flow execution source type.

              
            

            - **s3Source** *(dict) --* 

              The source details of a flow execution with S3 source.

              
              

              - **bucketName** *(string) --* 

                The S3 bucket name of the S3 source.

                
              

              - **key** *(string) --* 

                The S3 object key of the S3 source.

                
          
            

            - **datasetSource** *(dict) --* 

              The source details of a flow execution with dataset source.

              
              

              - **datasetIdentifier** *(string) --* 

                The ARN of the dataset source.

                
          
        
          

          - **message** *(string) --* 

            The failure message (if any) of failed flow execution.

            
          

          - **startTime** *(datetime) --* 

            The flow execution start timestamp.

            
          

          - **endTime** *(datetime) --* 

            The flow execution end timestamp.

            
          

          - **outputMetadata** *(dict) --* 

            The flow execution output metadata.

            
            

            - **diagnosticReportsRootS3URI** *(string) --* 

              The S3 URI under which all diagnostic files (such as deduped records if any) are stored.

              
        
      
    
      

      - **nextToken** *(string) --* 

        The pagination token to fetch next page of flow executions.

        
  
  **Exceptions**
  
  *   :py:class:`SupplyChain.Client.exceptions.ServiceQuotaExceededException`

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

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

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

  
  *   :py:class:`SupplyChain.Client.exceptions.ValidationException`

  
  *   :py:class:`SupplyChain.Client.exceptions.InternalServerException`

  
  *   :py:class:`SupplyChain.Client.exceptions.ConflictException`

  