WorkflowSummary - EC2 Image Builder
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 (PDF).

WorkflowSummary

Contains metadata about the workflow resource.

Contents

arn

The Amazon Resource Name (ARN) of the workflow resource.

Type: String

Pattern: ^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[a-z0-9-_]+/x\.x\.x$

Required: No

changeDescription

The change description for the current version of the workflow resource.

Type: String

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

Required: No

dateCreated

The original creation date of the workflow resource.

Type: String

Required: No

description

Describes the workflow.

Type: String

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

Required: No

name

The name of the workflow.

Type: String

Pattern: ^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$

Required: No

owner

The owner of the workflow resource.

Type: String

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

Required: No

state

Describes the current state of the workflow resource.

Type: WorkflowState object

Required: No

tags

Contains a list of tags that are defined for the workflow.

Type: String to string map

Map Entries: Maximum number of 50 items.

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

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

type

The image creation stage that this workflow applies to. Image Builder currently supports build and test stage workflows.

Type: String

Valid Values: BUILD | TEST | DISTRIBUTION

Required: No

version

The version of the workflow.

Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Required: No

See Also

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