CustomerProfiles / Client / list_workflows

list_workflows#

CustomerProfiles.Client.list_workflows(**kwargs)#

Query to list all workflows.

See also: AWS API Documentation

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
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • WorkflowType (string) – The type of workflow. The only supported value is APPFLOW_INTEGRATION.

  • Status (string) – Status of workflow execution.

  • QueryStartDate (datetime) – Retrieve workflows started after timestamp.

  • QueryEndDate (datetime) – Retrieve workflows ended after timestamp.

  • NextToken (string) – 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.

  • MaxResults (integer) – The maximum number of results to return per page.

Return type:

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