Skip to main content

pipelines_list_only

Lists pipelines in a region or regions, for all properties use pipelines

Overview

Namepipelines_list_only
TypeResource
DescriptionAn example resource schema demonstrating some basic constructs and validation rules.
Idaws.datapipeline.pipelines_list_only

Fields

NameDatatypeDescription
activatebooleanIndicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true.
descriptionstringA description of the pipeline.
namestringThe name of the pipeline.
parameter_objectsarrayThe parameter objects used with the pipeline.
parameter_valuesarrayThe parameter values used with the pipeline.
pipeline_objectsarrayThe objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see Editing Your Pipeline in the AWS Data Pipeline Developer Guide.
pipeline_tagsarrayA list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see Controlling Access to Pipelines and Resources in the AWS Data Pipeline Developer Guide.
pipeline_idstring
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all pipelines in a region.

SELECT
region,
pipeline_id
FROM aws.datapipeline.pipelines_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the pipelines_list_only resource, see pipelines