Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CodePipeline.Types.JobData

Description

Synopsis

data JobData = JobData' {
- actionConfiguration :: Maybe ActionConfiguration
- actionTypeId :: Maybe ActionTypeId
- artifactCredentials :: Maybe (Sensitive AWSSessionCredentials)
- continuationToken :: Maybe Text
- encryptionKey :: Maybe EncryptionKey
- inputArtifacts :: Maybe [Artifact]
- outputArtifacts :: Maybe [Artifact]
- pipelineContext :: Maybe PipelineContext
}
newJobData :: JobData
jobData_actionConfiguration :: Lens' JobData (Maybe ActionConfiguration)
jobData_actionTypeId :: Lens' JobData (Maybe ActionTypeId)
jobData_artifactCredentials :: Lens' JobData (Maybe AWSSessionCredentials)
jobData_continuationToken :: Lens' JobData (Maybe Text)
jobData_encryptionKey :: Lens' JobData (Maybe EncryptionKey)
jobData_inputArtifacts :: Lens' JobData (Maybe [Artifact])
jobData_outputArtifacts :: Lens' JobData (Maybe [Artifact])
jobData_pipelineContext :: Lens' JobData (Maybe PipelineContext)

Documentation

data JobData Source #

Represents other information about a job required for a job worker to complete the job.

See: newJobData smart constructor.

Constructors

JobData'

Fields

actionConfiguration :: Maybe ActionConfiguration
Represents information about an action configuration.
actionTypeId :: Maybe ActionTypeId
Represents information about an action type.
artifactCredentials :: Maybe (Sensitive AWSSessionCredentials)
Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifacts for the pipeline in AWS CodePipeline.
continuationToken :: Maybe Text
A system-generated token, such as a AWS CodeDeploy deployment ID, required by a job to continue the job asynchronously.
encryptionKey :: Maybe EncryptionKey
Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.
inputArtifacts :: Maybe [Artifact]
The artifact supplied to the job.
outputArtifacts :: Maybe [Artifact]
The output of the job.
pipelineContext :: Maybe PipelineContext
Represents information about a pipeline to a job worker.
Includes pipelineArn and pipelineExecutionId for custom jobs.

Instances

Instances details

FromJSON JobData Source #
Instance details Defined in Amazonka.CodePipeline.Types.JobData Methods parseJSON :: Value -> Parser JobData # parseJSONList :: Value -> Parser [JobData] #
Generic JobData Source #
Instance details Defined in Amazonka.CodePipeline.Types.JobData Associated Types type Rep JobData :: Type -> Type # Methods from :: JobData -> Rep JobData x # to :: Rep JobData x -> JobData #
Show JobData Source #
Instance details Defined in Amazonka.CodePipeline.Types.JobData Methods showsPrec :: Int -> JobData -> ShowS # show :: JobData -> String # showList :: [JobData] -> ShowS #
NFData JobData Source #
Instance details Defined in Amazonka.CodePipeline.Types.JobData Methods rnf :: JobData -> () #
Eq JobData Source #
Instance details Defined in Amazonka.CodePipeline.Types.JobData Methods (==) :: JobData -> JobData -> Bool # (/=) :: JobData -> JobData -> Bool #
Hashable JobData Source #
Instance details Defined in Amazonka.CodePipeline.Types.JobData Methods hashWithSalt :: Int -> JobData -> Int # hash :: JobData -> Int #
type Rep JobData Source #
Instance details Defined in Amazonka.CodePipeline.Types.JobData type Rep JobData = D1 ('MetaData "JobData" "Amazonka.CodePipeline.Types.JobData" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "JobData'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "actionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActionConfiguration)) :: S1 ('MetaSel ('Just "actionTypeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActionTypeId))) :: (S1 ('MetaSel ('Just "artifactCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive AWSSessionCredentials))) :: S1 ('MetaSel ('Just "continuationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "encryptionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionKey)) :: S1 ('MetaSel ('Just "inputArtifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Artifact]))) :: (S1 ('MetaSel ('Just "outputArtifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Artifact])) :*: S1 ('MetaSel ('Just "pipelineContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipelineContext))))))

newJobData :: JobData Source #

Create a value of JobData 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:actionConfiguration:JobData', jobData_actionConfiguration - Represents information about an action configuration.

$sel:actionTypeId:JobData', jobData_actionTypeId - Represents information about an action type.

$sel:artifactCredentials:JobData', jobData_artifactCredentials - Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifacts for the pipeline in AWS CodePipeline.

$sel:continuationToken:JobData', jobData_continuationToken - A system-generated token, such as a AWS CodeDeploy deployment ID, required by a job to continue the job asynchronously.

$sel:encryptionKey:JobData', jobData_encryptionKey - Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.

$sel:inputArtifacts:JobData', jobData_inputArtifacts - The artifact supplied to the job.

$sel:outputArtifacts:JobData', jobData_outputArtifacts - The output of the job.

$sel:pipelineContext:JobData', jobData_pipelineContext - Represents information about a pipeline to a job worker.

Includes pipelineArn and pipelineExecutionId for custom jobs.

jobData_actionConfiguration :: Lens' JobData (Maybe ActionConfiguration) Source #

Represents information about an action configuration.

jobData_actionTypeId :: Lens' JobData (Maybe ActionTypeId) Source #

Represents information about an action type.

jobData_artifactCredentials :: Lens' JobData (Maybe AWSSessionCredentials) Source #

Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifacts for the pipeline in AWS CodePipeline.

jobData_continuationToken :: Lens' JobData (Maybe Text) Source #

A system-generated token, such as a AWS CodeDeploy deployment ID, required by a job to continue the job asynchronously.

jobData_encryptionKey :: Lens' JobData (Maybe EncryptionKey) Source #

Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.

jobData_inputArtifacts :: Lens' JobData (Maybe [Artifact]) Source #

The artifact supplied to the job.

jobData_outputArtifacts :: Lens' JobData (Maybe [Artifact]) Source #

The output of the job.

jobData_pipelineContext :: Lens' JobData (Maybe PipelineContext) Source #

Represents information about a pipeline to a job worker.

Includes pipelineArn and pipelineExecutionId for custom jobs.