[ aws . customer-profiles ]

list-workflows

Description

Query to list all workflows.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-workflows
--domain-name <value>
[--workflow-type <value>]
[--status <value>]
[--query-start-date <value>]
[--query-end-date <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--domain-name (string)

The unique name of the domain.

--workflow-type (string)

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

Possible values:

• APPFLOW_INTEGRATION

--status (string)

Status of workflow execution.

Possible values:

• NOT_STARTED

• IN_PROGRESS

• COMPLETE

• FAILED

• SPLIT

• RETRY

• CANCELLED

--query-start-date (timestamp)

Retrieve workflows started after timestamp.

--query-end-date (timestamp)

Retrieve workflows ended after timestamp.

--next-token (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.

--max-results (integer)

The maximum number of results to return per page.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Items -> (list)

List containing workflow details.

(structure)

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 -> (timestamp)

Creation timestamp for workflow.

LastUpdatedAt -> (timestamp)

Last updated timestamp for workflow.

NextToken -> (string)

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