Skip to content
AWS for Query.Farm

aws.imagebuilder.get_workflow

Example SQL Queries

SELECT * FROM
aws.imagebuilder.get_workflow
WHERE
"workflow_build_version_arn" = 'VALUE';

Description

Get a workflow resource object.

Table Definition

Column NameColumn Data Type
workflow_build_version_arn Required Input Column

The Amazon Resource Name (ARN) of the workflow resource that you want to get.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

workflow

The workflow resource specified in the request.

STRUCT(
    "arn" VARCHAR,
    "name" VARCHAR,
    "version" VARCHAR,
    "description" VARCHAR,
    "change_description" VARCHAR,
    "type" VARCHAR,
    "state" STRUCT(
        "status" VARCHAR,
        "reason" VARCHAR
    ),
    "owner" VARCHAR,
    "data" VARCHAR,
    "kms_key_id" VARCHAR,
    "date_created" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "parameters" STRUCT(
        "name" VARCHAR,
        "type" VARCHAR,
        "default_value" VARCHAR[],
        "description" VARCHAR
    )[]
)
Show child fields
workflow.arn

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

workflow.change_description

Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.

workflow.data

Contains the YAML document content for the workflow.

workflow.date_created

The timestamp when Image Builder created the workflow resource.

workflow.description

The description of the workflow.

workflow.kms_key_id

The KMS key identifier used to encrypt the workflow resource.

workflow.name

The name of the workflow resource.

workflow.owner

The owner of the workflow resource.

workflow.parameters[]
Show child fields
workflow.parameters[].default_value[]
workflow.parameters[].description

Describes this parameter.

workflow.parameters[].name

The name of this input parameter.

workflow.parameters[].type

The type of input this parameter provides. The currently supported value is "string".

workflow.state

Describes the current status of the workflow and the reason for that status.

Show child fields
workflow.state.reason

Describes how or why the workflow changed state.

workflow.state.status

The current state of the workflow.

workflow.tags

The tags that apply to the workflow resource

workflow.type

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

workflow.version

The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.