:doc:`CustomerProfiles <../../customer-profiles>` / Client / list_workflows

**************
list_workflows
**************



.. py:method:: CustomerProfiles.Client.list_workflows(**kwargs)

  

  Query to list all workflows.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListWorkflows>`_  


  **Request Syntax**
  ::

    response = client.list_workflows(
        DomainName='string',
        WorkflowType='APPFLOW_INTEGRATION',
        Status='NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'FAILED'|'SPLIT'|'RETRY'|'CANCELLED',
        QueryStartDate=datetime(2015, 1, 1),
        QueryEndDate=datetime(2015, 1, 1),
        NextToken='string',
        MaxResults=123
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The unique name of the domain.

    

  
  :type WorkflowType: string
  :param WorkflowType: 

    The type of workflow. The only supported value is APPFLOW_INTEGRATION.

    

  
  :type Status: string
  :param Status: 

    Status of workflow execution.

    

  
  :type QueryStartDate: datetime
  :param QueryStartDate: 

    Retrieve workflows started after timestamp.

    

  
  :type QueryEndDate: datetime
  :param QueryEndDate: 

    Retrieve workflows ended after timestamp.

    

  
  :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.

    

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

    
    ::

      {
          'Items': [
              {
                  'WorkflowType': 'APPFLOW_INTEGRATION',
                  'WorkflowId': 'string',
                  'Status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETE'|'FAILED'|'SPLIT'|'RETRY'|'CANCELLED',
                  'StatusDescription': 'string',
                  'CreatedAt': datetime(2015, 1, 1),
                  'LastUpdatedAt': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Items** *(list) --* 

        List containing workflow details.

        
        

        - *(dict) --* 

          A workflow in list of workflows.

          
          

          - **WorkflowType** *(string) --* 

            The type of workflow. The only supported value is APPFLOW_INTEGRATION.

            
          

          - **WorkflowId** *(string) --* 

            Unique identifier for the workflow.

            
          

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

            Status of workflow execution.

            
          

          - **StatusDescription** *(string) --* 

            Description for workflow execution status.

            
          

          - **CreatedAt** *(datetime) --* 

            Creation timestamp for workflow.

            
          

          - **LastUpdatedAt** *(datetime) --* 

            Last updated timestamp for workflow.

            
      
    
      

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

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

        
  
  **Exceptions**
  
  *   :py:class:`CustomerProfiles.Client.exceptions.BadRequestException`

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

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

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

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

  