Skip to content

PipelineDescription

Source code in docs_src/capo_data_pipeline/types/pipeline_description.py 
16
17
18
19
20
21
22
23
24
25
26
class PipelineDescription(TypedDict, closed=True):
    pipeline_id: "capo_data_pipeline.types.id.id"
    """<p>The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form <code>df-297EG78HU43EEXAMPLE</code>.</p>"""
    name: "capo_data_pipeline.types.id.id"
    """<p>The name of the pipeline.</p>"""
    fields: "capo_data_pipeline.types.field_list.fieldList"
    """<p>A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.</p>"""
    description: NotRequired["capo_data_pipeline.types.string.string"]
    """<p>Description of the pipeline.</p>"""
    tags: NotRequired["capo_data_pipeline.types.tag_list.tagList"]
    """<p>A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see <a href="http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html">Controlling User Access to Pipelines</a> in the <i>AWS Data Pipeline Developer Guide</i>.</p>"""

description instance-attribute 

description: NotRequired[string]

Description of the pipeline.

fields instance-attribute 

fields: fieldList

A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.

name instance-attribute 

name: id

The name of the pipeline.

pipeline_id instance-attribute 

pipeline_id: id

The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

tags instance-attribute 

tags: NotRequired[tagList]

A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.