Skip to content
AWS for Query.Farm

aws.osis.list_pipelines

Example SQL Queries

SELECT * FROM
aws.osis.list_pipelines;

Description

Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines.

Table Definition

Column NameColumn Data Type
max_results Input Column

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

BIGINT
next_token Input Column

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

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
pipelines

A list of all existing Data Prepper pipelines.

STRUCT(
    "status" VARCHAR,
    "status_reason" STRUCT(
        "description" VARCHAR
    ),
    "pipeline_name" VARCHAR,
    "pipeline_arn" VARCHAR,
    "min_units" BIGINT,
    "max_units" BIGINT,
    "created_at" TIMESTAMP_S,
    "last_updated_at" TIMESTAMP_S,
    "destinations" STRUCT(
        "service_name" VARCHAR,
        "endpoint" VARCHAR
    )[],
    "tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[]
)[]
Show child fields
pipelines[]
Show child fields
pipelines[].created_at

The date and time when the pipeline was created.

pipelines[].destinations[]
Show child fields
pipelines[].destinations[].endpoint

The endpoint receiving data from the pipeline.

pipelines[].destinations[].service_name

The name of the service receiving data from the pipeline.

pipelines[].last_updated_at

The date and time when the pipeline was last updated.

pipelines[].max_units

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

pipelines[].min_units

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

pipelines[].pipeline_arn

The Amazon Resource Name (ARN) of the pipeline.

pipelines[].pipeline_name

The name of the pipeline.

pipelines[].status

The current status of the pipeline.

pipelines[].status_reason

Information about a pipeline's current status.

Show child fields
pipelines[].status_reason.description

A description of why a pipeline has a certain status.

pipelines[].tags[]
Show child fields
pipelines[].tags[].key

The tag key. Tag keys must be unique for the pipeline to which they are attached.

pipelines[].tags[].value

The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity