Skip to content
AWS for Query.Farm

aws.osis.get_pipeline_change_progress

Example SQL Queries

SELECT * FROM
aws.osis.get_pipeline_change_progress
WHERE
"pipeline_name" = 'VALUE';

Description

Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created.

For more information, see Tracking the status of pipeline creation.

Table Definition

Column NameColumn Data Type
pipeline_name Required Input Column

The name of the pipeline.

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.

_aws_region Input Column

The AWS region to use.

VARCHAR
change_progress_statuses

The current status of the change happening on the pipeline.

STRUCT(
    "start_time" TIMESTAMP_S,
    "status" VARCHAR,
    "total_number_of_stages" BIGINT,
    "change_progress_stages" STRUCT(
        "name" VARCHAR,
        "status" VARCHAR,
        "description" VARCHAR,
        "last_updated_at" TIMESTAMP_S
    )[]
)[]
Show child fields
change_progress_statuses[]
Show child fields
change_progress_statuses[].change_progress_stages[]
Show child fields
change_progress_statuses[].change_progress_stages[].description

A description of the stage.

change_progress_statuses[].change_progress_stages[].last_updated_at

The most recent updated timestamp of the stage.

change_progress_statuses[].change_progress_stages[].name

The name of the stage.

change_progress_statuses[].change_progress_stages[].status

The current status of the stage that the change is in.

change_progress_statuses[].start_time

The time at which the configuration change is made on the pipeline.

change_progress_statuses[].status

The overall status of the pipeline configuration change.

change_progress_statuses[].total_number_of_stages

The total number of stages required for the pipeline configuration change.