Skip to content
AWS for Query.Farm

aws.iotanalytics.describe_pipeline

Example SQL Queries

SELECT * FROM
aws.iotanalytics.describe_pipeline
WHERE
"pipeline_name" = 'VALUE';

Description

Retrieves information about a pipeline.

Table Definition

Column NameColumn Data Type
pipeline_name Required Input Column

The name of the pipeline whose information is retrieved.

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

A Pipeline object that contains information about the pipeline.

STRUCT(
    "name" VARCHAR,
    "arn" VARCHAR,
    "activities" STRUCT(
        "channel" STRUCT(
            "name" VARCHAR,
            "channel_name" VARCHAR,
            "next" VARCHAR
        ),
        "lambda" STRUCT(
            "name" VARCHAR,
            "lambda_name" VARCHAR,
            "batch_size" BIGINT,
            "next" VARCHAR
        ),
        "datastore" STRUCT(
            "name" VARCHAR,
            "datastore_name" VARCHAR
        ),
        "add_attributes" STRUCT(
            "name" VARCHAR,
            "attributes" MAP(VARCHAR, VARCHAR),
            "next" VARCHAR
        ),
        "remove_attributes" STRUCT(
            "name" VARCHAR,
            "attributes" VARCHAR[],
            "next" VARCHAR
        ),
        "select_attributes" STRUCT(
            "name" VARCHAR,
            "attributes" VARCHAR[],
            "next" VARCHAR
        ),
        "filter" STRUCT(
            "name" VARCHAR,
            "filter" VARCHAR,
            "next" VARCHAR
        ),
        "math" STRUCT(
            "name" VARCHAR,
            "attribute" VARCHAR,
            "math" VARCHAR,
            "next" VARCHAR
        ),
        "device_registry_enrich" STRUCT(
            "name" VARCHAR,
            "attribute" VARCHAR,
            "thing_name" VARCHAR,
            "role_arn" VARCHAR,
            "next" VARCHAR
        ),
        "device_shadow_enrich" STRUCT(
            "name" VARCHAR,
            "attribute" VARCHAR,
            "thing_name" VARCHAR,
            "role_arn" VARCHAR,
            "next" VARCHAR
        )
    )[],
    "reprocessing_summaries" STRUCT(
        "id" VARCHAR,
        "status" VARCHAR,
        "creation_time" TIMESTAMP_S
    )[],
    "creation_time" TIMESTAMP_S,
    "last_update_time" TIMESTAMP_S
)
Show child fields
pipeline.activities[]
Show child fields
pipeline.activities[].add_attributes

Adds other attributes based on existing attributes in the message.

Show child fields
pipeline.activities[].add_attributes.attributes

A list of 1-50 AttributeNameMapping objects that map an existing attribute to a new attribute.

The existing attributes remain in the message, so if you want to remove the originals, use RemoveAttributeActivity.

pipeline.activities[].add_attributes.name

The name of the addAttributes activity.

pipeline.activities[].add_attributes.next

The next activity in the pipeline.

pipeline.activities[].channel

Determines the source of the messages to be processed.

Show child fields
pipeline.activities[].channel.channel_name

The name of the channel from which the messages are processed.

pipeline.activities[].channel.name

The name of the channel activity.

pipeline.activities[].channel.next

The next activity in the pipeline.

pipeline.activities[].datastore

Specifies where to store the processed message data.

Show child fields
pipeline.activities[].datastore.datastore_name

The name of the data store where processed messages are stored.

pipeline.activities[].datastore.name

The name of the datastore activity.

pipeline.activities[].device_registry_enrich

Adds data from the IoT device registry to your message.

Show child fields
pipeline.activities[].device_registry_enrich.attribute

The name of the attribute that is added to the message.

pipeline.activities[].device_registry_enrich.name

The name of the deviceRegistryEnrich activity.

pipeline.activities[].device_registry_enrich.next

The next activity in the pipeline.

pipeline.activities[].device_registry_enrich.role_arn

The ARN of the role that allows access to the device's registry information.

pipeline.activities[].device_registry_enrich.thing_name

The name of the IoT device whose registry information is added to the message.

pipeline.activities[].device_shadow_enrich

Adds information from the IoT Device Shadow service to a message.

Show child fields
pipeline.activities[].device_shadow_enrich.attribute

The name of the attribute that is added to the message.

pipeline.activities[].device_shadow_enrich.name

The name of the deviceShadowEnrich activity.

pipeline.activities[].device_shadow_enrich.next

The next activity in the pipeline.

pipeline.activities[].device_shadow_enrich.role_arn

The ARN of the role that allows access to the device's shadow.

pipeline.activities[].device_shadow_enrich.thing_name

The name of the IoT device whose shadow information is added to the message.

pipeline.activities[].filter

Filters a message based on its attributes.

Show child fields
pipeline.activities[].filter.filter

An expression that looks like a SQL WHERE clause that must return a Boolean value. Messages that satisfy the condition are passed to the next activity.

pipeline.activities[].filter.name

The name of the filter activity.

pipeline.activities[].filter.next

The next activity in the pipeline.

pipeline.activities[].lambda

Runs a Lambda function to modify the message.

Show child fields
pipeline.activities[].lambda.batch_size

The number of messages passed to the Lambda function for processing.

The Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.

pipeline.activities[].lambda.lambda_name

The name of the Lambda function that is run on the message.

pipeline.activities[].lambda.name

The name of the lambda activity.

pipeline.activities[].lambda.next

The next activity in the pipeline.

pipeline.activities[].math

Computes an arithmetic expression using the message's attributes and adds it to the message.

Show child fields
pipeline.activities[].math.attribute

The name of the attribute that contains the result of the math operation.

pipeline.activities[].math.math

An expression that uses one or more existing attributes and must return an integer value.

pipeline.activities[].math.name

The name of the math activity.

pipeline.activities[].math.next

The next activity in the pipeline.

pipeline.activities[].remove_attributes

Removes attributes from a message.

Show child fields
pipeline.activities[].remove_attributes.attributes[]
pipeline.activities[].remove_attributes.name

The name of the removeAttributes activity.

pipeline.activities[].remove_attributes.next

The next activity in the pipeline.

pipeline.activities[].select_attributes

Used to create a new message using only the specified attributes from the original message.

Show child fields
pipeline.activities[].select_attributes.attributes[]
pipeline.activities[].select_attributes.name

The name of the selectAttributes activity.

pipeline.activities[].select_attributes.next

The next activity in the pipeline.

pipeline.arn

The ARN of the pipeline.

pipeline.creation_time

When the pipeline was created.

pipeline.last_update_time

The last time the pipeline was updated.

pipeline.name

The name of the pipeline.

pipeline.reprocessing_summaries[]
Show child fields
pipeline.reprocessing_summaries[].creation_time

The time the pipeline reprocessing was created.

pipeline.reprocessing_summaries[].id

The reprocessingId returned by StartPipelineReprocessing.

pipeline.reprocessing_summaries[].status

The status of the pipeline reprocessing.