Skip to content
AWS for Query.Farm

aws.codecatalyst.get_workflow

Example SQL Queries

SELECT * FROM
aws.codecatalyst.get_workflow
WHERE
"space_name" = 'VALUE'
AND "id" = 'VALUE'
AND "project_name" = 'VALUE';

Description

Returns information about a workflow.

Table Definition

Column NameColumn Data Type
id Required Input Column

The ID of the workflow.

VARCHAR
project_name Required Input Column

The name of the project in the space.

VARCHAR
space_name Required Input Column

The name of the space.

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.

created_time

The date and time the workflow was created, in coordinated universal time (UTC) timestamp format as specified in RFC 3339 

TIMESTAMP_S
definition

Information about the workflow definition file for the workflow.

STRUCT(
    "path" VARCHAR
)
Show child fields
definition.path

The path to the workflow definition file stored in the source repository for the project, including the file name.

last_updated_time

The date and time the workflow was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339 

TIMESTAMP_S
name

The name of the workflow.

VARCHAR
run_mode

The behavior to use when multiple workflows occur at the same time. For more information, see https://docs.aws.amazon.com/codecatalyst/latest/userguide/workflows-configure-runs.html in the Amazon CodeCatalyst User Guide.

VARCHAR
source_branch_name

The name of the branch that contains the workflow YAML.

VARCHAR
source_repository_name

The name of the source repository where the workflow YAML is stored.

VARCHAR
status

The status of the workflow.

VARCHAR