Amazonka.DataPipeline.Types.PipelineDescription

Documentation

data PipelineDescription

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

FromJSON PipelineDescription

Defined in Amazonka.DataPipeline.Types.PipelineDescription

Methods

parseJSON :: Value -> Parser PipelineDescription

parseJSONList :: Value -> Parser [PipelineDescription]

Generic PipelineDescription

Defined in Amazonka.DataPipeline.Types.PipelineDescription

Associated Types

type Rep PipelineDescription :: Type -> Type

Methods

from :: PipelineDescription -> Rep PipelineDescription x

to :: Rep PipelineDescription x -> PipelineDescription

Read PipelineDescription

Defined in Amazonka.DataPipeline.Types.PipelineDescription

Methods

readsPrec :: Int -> ReadS PipelineDescription

readList :: ReadS [PipelineDescription]

readPrec :: ReadPrec PipelineDescription

readListPrec :: ReadPrec [PipelineDescription]

Show PipelineDescription

Defined in Amazonka.DataPipeline.Types.PipelineDescription

Methods

showsPrec :: Int -> PipelineDescription -> ShowS

show :: PipelineDescription -> String

showList :: [PipelineDescription] -> ShowS

NFData PipelineDescription

Defined in Amazonka.DataPipeline.Types.PipelineDescription

Methods

rnf :: PipelineDescription -> ()

Eq PipelineDescription

Defined in Amazonka.DataPipeline.Types.PipelineDescription

Methods

(==) :: PipelineDescription -> PipelineDescription -> Bool

(/=) :: PipelineDescription -> PipelineDescription -> Bool

Hashable PipelineDescription

Defined in Amazonka.DataPipeline.Types.PipelineDescription

Methods

hashWithSalt :: Int -> PipelineDescription -> Int

hash :: PipelineDescription -> Int

type Rep PipelineDescription

Defined in Amazonka.DataPipeline.Types.PipelineDescription

type Rep PipelineDescription = D1 ('MetaData "PipelineDescription" "Amazonka.DataPipeline.Types.PipelineDescription" "amazonka-datapipeline-2.0-1cySuAk2jmdDRpZSxMUuos" '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

Arguments

:: Text

$sel:pipelineId:PipelineDescription'

-> Text

$sel:name:PipelineDescription'

-> PipelineDescription

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_description :: Lens' PipelineDescription (Maybe Text)

Description of the pipeline.

pipelineDescription_tags :: Lens' PipelineDescription (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.

pipelineDescription_pipelineId :: Lens' PipelineDescription Text

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

pipelineDescription_name :: Lens' PipelineDescription Text

The name of the pipeline.

pipelineDescription_fields :: Lens' PipelineDescription [Field]

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