Amazonka.CodePipeline.Types.PipelineContext

Documentation

data PipelineContext

Represents information about a pipeline to a job worker.

PipelineContext contains pipelineArn and pipelineExecutionId for custom action jobs. The pipelineArn and pipelineExecutionId fields are not populated for ThirdParty action jobs.

See: newPipelineContext smart constructor.

Constructors

PipelineContext'

Fields

• action :: Maybe ActionContext

  The context of an action to a job worker in the stage of a pipeline.

• pipelineArn :: Maybe Text

  The Amazon Resource Name (ARN) of the pipeline.

• pipelineExecutionId :: Maybe Text

  The execution ID of the pipeline.

• pipelineName :: Maybe Text

  The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.

• stage :: Maybe StageContext

  The stage of the pipeline.

Instances

FromJSON PipelineContext

Defined in Amazonka.CodePipeline.Types.PipelineContext

Methods

parseJSON :: Value -> Parser PipelineContext

parseJSONList :: Value -> Parser [PipelineContext]

Generic PipelineContext

Defined in Amazonka.CodePipeline.Types.PipelineContext

Associated Types

type Rep PipelineContext :: Type -> Type

Methods

from :: PipelineContext -> Rep PipelineContext x

to :: Rep PipelineContext x -> PipelineContext

Read PipelineContext

Defined in Amazonka.CodePipeline.Types.PipelineContext

Methods

readsPrec :: Int -> ReadS PipelineContext

readList :: ReadS [PipelineContext]

readPrec :: ReadPrec PipelineContext

readListPrec :: ReadPrec [PipelineContext]

Show PipelineContext

Defined in Amazonka.CodePipeline.Types.PipelineContext

Methods

showsPrec :: Int -> PipelineContext -> ShowS

show :: PipelineContext -> String

showList :: [PipelineContext] -> ShowS

NFData PipelineContext

Defined in Amazonka.CodePipeline.Types.PipelineContext

Methods

rnf :: PipelineContext -> ()

Eq PipelineContext

Defined in Amazonka.CodePipeline.Types.PipelineContext

Methods

(==) :: PipelineContext -> PipelineContext -> Bool

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

Hashable PipelineContext

Defined in Amazonka.CodePipeline.Types.PipelineContext

Methods

hashWithSalt :: Int -> PipelineContext -> Int

hash :: PipelineContext -> Int

type Rep PipelineContext

Defined in Amazonka.CodePipeline.Types.PipelineContext

type Rep PipelineContext = D1 ('MetaData "PipelineContext" "Amazonka.CodePipeline.Types.PipelineContext" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "PipelineContext'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActionContext)) :*: S1 ('MetaSel ('Just "pipelineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "pipelineExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pipelineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StageContext))))))

newPipelineContext :: PipelineContext

Create a value of PipelineContext 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:action:PipelineContext', pipelineContext_action - The context of an action to a job worker in the stage of a pipeline.

$sel:pipelineArn:PipelineContext', pipelineContext_pipelineArn - The Amazon Resource Name (ARN) of the pipeline.

$sel:pipelineExecutionId:PipelineContext', pipelineContext_pipelineExecutionId - The execution ID of the pipeline.

$sel:pipelineName:PipelineContext', pipelineContext_pipelineName - The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.

$sel:stage:PipelineContext', pipelineContext_stage - The stage of the pipeline.

pipelineContext_action :: Lens' PipelineContext (Maybe ActionContext)

The context of an action to a job worker in the stage of a pipeline.

pipelineContext_pipelineArn :: Lens' PipelineContext (Maybe Text)

The Amazon Resource Name (ARN) of the pipeline.

pipelineContext_pipelineExecutionId :: Lens' PipelineContext (Maybe Text)

The execution ID of the pipeline.

pipelineContext_pipelineName :: Lens' PipelineContext (Maybe Text)

The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.

pipelineContext_stage :: Lens' PipelineContext (Maybe StageContext)

The stage of the pipeline.