[ aws . customer-profiles ]

get-workflow-steps

Description

Get granular list of steps in workflow.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-workflow-steps
--domain-name <value>
--workflow-id <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-id (string)

Unique identifier for the workflow.

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

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.

(structure)

List containing steps in workflow.

AppflowIntegration -> (structure)

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

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

Creation timestamp of workflow step for APPFLOW_INTEGRATION workflow.

LastUpdatedAt -> (timestamp)

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.