Skip to content
AWS for Query.Farm

aws.imagebuilder.get_image_pipeline

Example SQL Queries

SELECT * FROM
aws.imagebuilder.get_image_pipeline
WHERE
"image_pipeline_arn" = 'VALUE';

Description

Gets an image pipeline.

Table Definition

Column NameColumn Data Type
image_pipeline_arn Required Input Column

The Amazon Resource Name (ARN) of the image pipeline that you want to retrieve.

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.

image_pipeline

The image pipeline object.

STRUCT(
    "arn" VARCHAR,
    "name" VARCHAR,
    "description" VARCHAR,
    "platform" VARCHAR,
    "enhanced_image_metadata_enabled" BOOLEAN,
    "image_recipe_arn" VARCHAR,
    "container_recipe_arn" VARCHAR,
    "infrastructure_configuration_arn" VARCHAR,
    "distribution_configuration_arn" VARCHAR,
    "image_tests_configuration" STRUCT(
        "image_tests_enabled" BOOLEAN,
        "timeout_minutes" BIGINT
    ),
    "schedule" STRUCT(
        "schedule_expression" VARCHAR,
        "timezone" VARCHAR,
        "pipeline_execution_start_condition" VARCHAR
    ),
    "status" VARCHAR,
    "date_created" VARCHAR,
    "date_updated" VARCHAR,
    "date_last_run" VARCHAR,
    "date_next_run" VARCHAR,
    "tags" MAP(VARCHAR, VARCHAR),
    "image_scanning_configuration" STRUCT(
        "image_scanning_enabled" BOOLEAN,
        "ecr_configuration" STRUCT(
            "repository_name" VARCHAR,
            "container_tags" VARCHAR[]
        )
    ),
    "execution_role" VARCHAR,
    "workflows" STRUCT(
        "workflow_arn" VARCHAR,
        "parameters" STRUCT(
            "name" VARCHAR,
            "value" VARCHAR[]
        )[],
        "parallel_group" VARCHAR,
        "on_failure" VARCHAR
    )[]
)
Show child fields
image_pipeline.arn

The Amazon Resource Name (ARN) of the image pipeline.

image_pipeline.container_recipe_arn

The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.

image_pipeline.date_created

The date on which this image pipeline was created.

image_pipeline.date_last_run

This is no longer supported, and does not return a value.

image_pipeline.date_next_run

The next date when the pipeline is scheduled to run.

image_pipeline.date_updated

The date on which this image pipeline was last updated.

image_pipeline.description

The description of the image pipeline.

image_pipeline.distribution_configuration_arn

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

image_pipeline.enhanced_image_metadata_enabled

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

image_pipeline.execution_role

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

image_pipeline.image_recipe_arn

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

image_pipeline.image_scanning_configuration

Contains settings for vulnerability scans.

Show child fields
image_pipeline.image_scanning_configuration.ecr_configuration

Contains Amazon ECR settings for vulnerability scans.

Show child fields
image_pipeline.image_scanning_configuration.ecr_configuration.container_tags[]
image_pipeline.image_scanning_configuration.ecr_configuration.repository_name

The name of the container repository that Amazon Inspector scans to identify findings for your container images. The name includes the path for the repository location. If you don’t provide this information, Image Builder creates a repository in your account named image-builder-image-scanning-repository for vulnerability scans of your output container images.

image_pipeline.image_scanning_configuration.image_scanning_enabled

A setting that indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.

image_pipeline.image_tests_configuration

The image tests configuration of the image pipeline.

Show child fields
image_pipeline.image_tests_configuration.image_tests_enabled

Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.

image_pipeline.image_tests_configuration.timeout_minutes

The maximum time in minutes that tests are permitted to run.

The timeoutMinutes attribute is not currently active. This value is ignored.

image_pipeline.infrastructure_configuration_arn

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

image_pipeline.name

The name of the image pipeline.

image_pipeline.platform

The platform of the image pipeline.

image_pipeline.schedule

The schedule of the image pipeline.

Show child fields
image_pipeline.schedule.pipeline_execution_start_condition

The condition configures when the pipeline should trigger a new image build. When the pipelineExecutionStartCondition is set to EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to EXPRESSION_MATCH_ONLY, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference.

image_pipeline.schedule.schedule_expression

The cron expression determines how often EC2 Image Builder evaluates your pipelineExecutionStartCondition.

For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder.

image_pipeline.schedule.timezone

The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the IANA timezone format. If not specified this defaults to UTC.

image_pipeline.status

The status of the image pipeline.

image_pipeline.tags

The tags of this image pipeline.

image_pipeline.workflows[]
Show child fields
image_pipeline.workflows[].on_failure

The action to take if the workflow fails.

image_pipeline.workflows[].parallel_group

Test workflows are defined within named runtime groups called parallel groups. The parallel group is the named group that contains this test workflow. Test workflows within a parallel group can run at the same time. Image Builder starts up to five test workflows in the group at the same time, and starts additional workflows as others complete, until all workflows in the group have completed. This field only applies for test workflows.

image_pipeline.workflows[].parameters[]
Show child fields
image_pipeline.workflows[].parameters[].name

The name of the workflow parameter to set.

image_pipeline.workflows[].parameters[].value[]
image_pipeline.workflows[].workflow_arn

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

request_id

The request ID that uniquely identifies this request.

VARCHAR