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

******************
get_workflow_steps
******************



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

  

  Get granular list of steps in workflow.

  

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


  **Request Syntax**
  ::

    response = client.get_workflow_steps(
        DomainName='string',
        WorkflowId='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The unique name of the domain.

    

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

    Unique identifier for the workflow.

    

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

    
    ::

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

    

    - *(dict) --* 
      

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

        Unique identifier for the workflow.

        
      

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

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

        
      

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

        List containing workflow step details.

        
        

        - *(dict) --* 

          List containing steps in workflow.

          
          

          - **AppflowIntegration** *(dict) --* 

            Workflow step information specific to ``APPFLOW_INTEGRATION`` workflow.

            
            

            - **FlowName** *(string) --* 

              Name of the flow created during execution of workflow step. ``APPFLOW_INTEGRATION`` workflow type creates an appflow flow during workflow step execution on the customers behalf.

              
            

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

              Workflow step status for ``APPFLOW_INTEGRATION`` workflow.

              
            

            - **ExecutionMessage** *(string) --* 

              Message indicating execution of workflow step for ``APPFLOW_INTEGRATION`` workflow.

              
            

            - **RecordsProcessed** *(integer) --* 

              Total number of records processed during execution of workflow step for ``APPFLOW_INTEGRATION`` workflow.

              
            

            - **BatchRecordsStartTime** *(string) --* 

              Start datetime of records pulled in batch during execution of workflow step for ``APPFLOW_INTEGRATION`` workflow.

              
            

            - **BatchRecordsEndTime** *(string) --* 

              End datetime of records pulled in batch during execution of workflow step for ``APPFLOW_INTEGRATION`` workflow.

              
            

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

              Creation timestamp of workflow step for ``APPFLOW_INTEGRATION`` workflow.

              
            

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

              Last updated timestamp for workflow step for ``APPFLOW_INTEGRATION`` 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`

  