[ aws . customer-profiles ]



Get details of specified workflow.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--domain-name <value>
--workflow-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--domain-name (string)

The unique name of the domain.

--workflow-id (string)

Unique identifier for the workflow.

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


WorkflowId -> (string)

Unique identifier for the workflow.

WorkflowType -> (string)

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

Status -> (string)

Status of workflow execution.

ErrorDescription -> (string)

Workflow error messages during execution (if any).

StartDate -> (timestamp)

The timestamp that represents when workflow execution started.

LastUpdatedAt -> (timestamp)

The timestamp that represents when workflow execution last updated.

Attributes -> (structure)

Attributes provided for workflow execution.

AppflowIntegration -> (structure)

Workflow attributes specific to APPFLOW_INTEGRATION workflow.

SourceConnectorType -> (string)

Specifies the source connector type, such as Salesforce, ServiceNow, and Marketo. Indicates source of ingestion.

ConnectorProfileName -> (string)

The name of the AppFlow connector profile used for ingestion.

RoleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.

Metrics -> (structure)

Workflow specific execution metrics.

AppflowIntegration -> (structure)

Workflow execution metrics for APPFLOW_INTEGRATION workflow.

RecordsProcessed -> (long)

Number of records processed in APPFLOW_INTEGRATION workflow.

StepsCompleted -> (long)

Total steps completed in APPFLOW_INTEGRATION workflow.

TotalSteps -> (long)

Total steps in APPFLOW_INTEGRATION workflow.