View a markdown version of this page

FlowDetail - Amazon Quick Sight

FlowDetail

The full details of a flow, including its definition specifying the steps.

Contents

Note

In the following list, the required parameters are described first.

Arn

The Amazon Resource Name (ARN) of the flow.

Type: String

Required: Yes

CreatedTime

The time this flow was created.

Type: Timestamp

Required: Yes

FlowDefinition

The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow's internal format. The format is subject to change.

Type: JSON value

Required: Yes

FlowId

The unique identifier of the flow.

Type: String

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

Name

The display name of the flow.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

PublishState

The publish state of the flow. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.

Type: String

Valid Values: PUBLISHED | DRAFT | PENDING_APPROVAL

Required: Yes

CreatedBy

The identifier of the principal who created the flow.

Type: String

Required: No

Description

The description of the flow.

Type: String

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

Required: No

LastUpdatedBy

The identifier of the last principal who updated the flow.

Type: String

Required: No

LastUpdatedTime

The last time this flow was modified.

Type: Timestamp

Required: No

StepAliases

A list of step alias mappings for the flow.

Type: Array of StepAliasMapping objects

Required: No

See Also

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