DescribedWorkflow

Describes the properties of the specified workflow

Arn

Specifies the unique Amazon Resource Name (ARN) for the workflow.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1600.

Pattern: arn:\S+

Required: Yes

Description

Specifies the text description for the workflow.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\w- ]*

Required: No

OnExceptionSteps

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

Type: Array of WorkflowStep objects

Array Members: Minimum number of 0 items. Maximum number of 8 items.

Required: No

Steps

Specifies the details for the steps that are in the specified workflow.

Type: Array of WorkflowStep objects

Array Members: Minimum number of 0 items. Maximum number of 8 items.

Required: No

StructuredLogDestinations

Specifies the log groups to which your workflow logs are sent.

To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

arn:partition:logs:region-name:amazon-account-id:log-group:log-group-name:*

For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Length Constraints: Minimum length of 20. Maximum length of 1600.

Pattern: arn:\S+

Required: No

Tags

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

WorkflowId

A unique identifier for the workflow.

Type: String

Length Constraints: Fixed length of 19.

Pattern: w-([a-z0-9]{17})

Required: No

Contents