DescribedWorkflow - Amazon Transfer Family
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribedWorkflow

Describes the properties of the specified workflow

Contents

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

Required: Yes

Description

Specifies the text description for the workflow.

Type: String

Length Constraints: 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: 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: Maximum number of 8 items.

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

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: