Skip to content

aws.osis.get_pipeline

Example SQL Queries

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

Description

Retrieves information about an OpenSearch Ingestion pipeline.

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
pipeline

Detailed information about the requested pipeline.

STRUCT(
"pipeline_name" VARCHAR,
"pipeline_arn" VARCHAR,
"min_units" BIGINT,
"max_units" BIGINT,
"status" VARCHAR,
"status_reason" STRUCT(
"description" VARCHAR
),
"pipeline_configuration_body" VARCHAR,
"created_at" TIMESTAMP_S,
"last_updated_at" TIMESTAMP_S,
"ingest_endpoint_urls" VARCHAR[],
"log_publishing_options" STRUCT(
"is_logging_enabled" BOOLEAN,
"cloud_watch_log_destination" STRUCT(
"log_group" VARCHAR
)
),
"vpc_endpoints" STRUCT(
"vpc_endpoint_id" VARCHAR,
"vpc_id" VARCHAR,
"vpc_options" STRUCT(
"subnet_ids" VARCHAR[],
"security_group_ids" VARCHAR[],
"vpc_attachment_options" STRUCT(
"attach_to_vpc" BOOLEAN,
"cidr_block" VARCHAR
),
"vpc_endpoint_management" VARCHAR
)
)[],
"buffer_options" STRUCT(
"persistent_buffer_enabled" BOOLEAN
),
"encryption_at_rest_options" STRUCT(
"kms_key_arn" VARCHAR
),
"vpc_endpoint_service" VARCHAR,
"service_vpc_endpoints" STRUCT(
"service_name" VARCHAR,
"vpc_endpoint_id" VARCHAR
)[],
"destinations" STRUCT(
"service_name" VARCHAR,
"endpoint" VARCHAR
)[],
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)
Show child fields
pipeline.buffer_options

Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions. For more information, see Persistent buffering.

Show child fields
pipeline.buffer_options.persistent_buffer_enabled

Whether persistent buffering should be enabled.

pipeline.created_at

The date and time when the pipeline was created.

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

The endpoint receiving data from the pipeline.

pipeline.destinations[].service_name

The name of the service receiving data from the pipeline.

pipeline.encryption_at_rest_options

Options to control how OpenSearch encrypts buffer data.

Show child fields
pipeline.encryption_at_rest_options.kms_key_arn

The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key.

pipeline.ingest_endpoint_urls[]
pipeline.last_updated_at

The date and time when the pipeline was last updated.

pipeline.log_publishing_options

Key-value pairs that represent log publishing settings.

Show child fields
pipeline.log_publishing_options.cloud_watch_log_destination

The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if IsLoggingEnabled is set to true.

Show child fields
pipeline.log_publishing_options.cloud_watch_log_destination.log_group

The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, /aws/vendedlogs/OpenSearchService/pipelines.

pipeline.log_publishing_options.is_logging_enabled

Whether logs should be published.

pipeline.max_units

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

pipeline.min_units

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

pipeline.pipeline_arn

The Amazon Resource Name (ARN) of the pipeline.

pipeline.pipeline_configuration_body

The Data Prepper pipeline configuration in YAML format.

pipeline.pipeline_name

The name of the pipeline.

pipeline.service_vpc_endpoints[]
Show child fields
pipeline.service_vpc_endpoints[].service_name

The name of the service for which a VPC endpoint was created.

pipeline.service_vpc_endpoints[].vpc_endpoint_id

The unique identifier of the VPC endpoint that was created.

pipeline.status

The current status of the pipeline.

pipeline.status_reason

The reason for the current status of the pipeline.

Show child fields
pipeline.status_reason.description

A description of why a pipeline has a certain status.

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

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

pipeline.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

pipeline.vpc_endpoint_service

The VPC endpoint service name for the pipeline.

pipeline.vpc_endpoints[]
Show child fields
pipeline.vpc_endpoints[].vpc_endpoint_id

The unique identifier of the endpoint.

pipeline.vpc_endpoints[].vpc_id

The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC.

pipeline.vpc_endpoints[].vpc_options

Information about the VPC, including associated subnets and security groups.

Show child fields
pipeline.vpc_endpoints[].vpc_options.security_group_ids[]
pipeline.vpc_endpoints[].vpc_options.subnet_ids[]
pipeline.vpc_endpoints[].vpc_options.vpc_attachment_options

Options for attaching a VPC to a pipeline.

Show child fields
pipeline.vpc_endpoints[].vpc_options.vpc_attachment_options.attach_to_vpc

Whether a VPC is attached to the pipeline.

pipeline.vpc_endpoints[].vpc_options.vpc_attachment_options.cidr_block

The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).

pipeline.vpc_endpoints[].vpc_options.vpc_endpoint_management

Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.