libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DataPipeline.Types.PipelineDescription

Description

 
Synopsis

Documentation

data PipelineDescription Source #

Contains pipeline metadata.

See: newPipelineDescription smart constructor.

Constructors

PipelineDescription' 

Fields

  • description :: Maybe Text

    Description of the pipeline.

  • tags :: Maybe [Tag]

    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.

  • pipelineId :: Text

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

  • name :: Text

    The name of the pipeline.

  • fields :: [Field]

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

Instances

Instances details
Eq PipelineDescription Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.PipelineDescription

Read PipelineDescription Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.PipelineDescription

Show PipelineDescription Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.PipelineDescription

Generic PipelineDescription Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.PipelineDescription

Associated Types

type Rep PipelineDescription :: Type -> Type #

NFData PipelineDescription Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.PipelineDescription

Methods

rnf :: PipelineDescription -> () #

Hashable PipelineDescription Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.PipelineDescription

FromJSON PipelineDescription Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.PipelineDescription

type Rep PipelineDescription Source # 
Instance details

Defined in Amazonka.DataPipeline.Types.PipelineDescription

type Rep PipelineDescription = D1 ('MetaData "PipelineDescription" "Amazonka.DataPipeline.Types.PipelineDescription" "libZSservicesZSamazonka-datapipelineZSamazonka-datapipeline" 'False) (C1 ('MetaCons "PipelineDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "pipelineId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Field])))))

newPipelineDescription Source #

Create a value of PipelineDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:PipelineDescription', pipelineDescription_description - Description of the pipeline.

$sel:tags:PipelineDescription', pipelineDescription_tags - 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.

$sel:pipelineId:PipelineDescription', pipelineDescription_pipelineId - The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

$sel:name:PipelineDescription', pipelineDescription_name - The name of the pipeline.

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

pipelineDescription_tags :: Lens' PipelineDescription (Maybe [Tag]) Source #

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.

pipelineDescription_pipelineId :: Lens' PipelineDescription Text Source #

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

pipelineDescription_fields :: Lens' PipelineDescription [Field] Source #

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