libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline
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.CodePipeline.Types.ThirdPartyJobData

Description

 
Synopsis

Documentation

data ThirdPartyJobData Source #

Represents information about the job data for a partner action.

See: newThirdPartyJobData smart constructor.

Constructors

ThirdPartyJobData' 

Fields

  • continuationToken :: Maybe Text

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

  • outputArtifacts :: Maybe [Artifact]

    The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.

  • 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 artifact for the pipeline in AWS CodePipeline.

  • pipelineContext :: Maybe PipelineContext

    Represents information about a pipeline to a job worker.

    Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.

  • encryptionKey :: Maybe EncryptionKey

    The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.

  • actionTypeId :: Maybe ActionTypeId

    Represents information about an action type.

  • inputArtifacts :: Maybe [Artifact]

    The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.

  • actionConfiguration :: Maybe ActionConfiguration

    Represents information about an action configuration.

Instances

Instances details
Eq ThirdPartyJobData Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.ThirdPartyJobData

Show ThirdPartyJobData Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.ThirdPartyJobData

Generic ThirdPartyJobData Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.ThirdPartyJobData

Associated Types

type Rep ThirdPartyJobData :: Type -> Type #

NFData ThirdPartyJobData Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.ThirdPartyJobData

Methods

rnf :: ThirdPartyJobData -> () #

Hashable ThirdPartyJobData Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.ThirdPartyJobData

FromJSON ThirdPartyJobData Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.ThirdPartyJobData

type Rep ThirdPartyJobData Source # 
Instance details

Defined in Amazonka.CodePipeline.Types.ThirdPartyJobData

type Rep ThirdPartyJobData = D1 ('MetaData "ThirdPartyJobData" "Amazonka.CodePipeline.Types.ThirdPartyJobData" "libZSservicesZSamazonka-codepipelineZSamazonka-codepipeline" 'False) (C1 ('MetaCons "ThirdPartyJobData'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "continuationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "outputArtifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Artifact]))) :*: (S1 ('MetaSel ('Just "artifactCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive AWSSessionCredentials))) :*: S1 ('MetaSel ('Just "pipelineContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PipelineContext)))) :*: ((S1 ('MetaSel ('Just "encryptionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionKey)) :*: S1 ('MetaSel ('Just "actionTypeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActionTypeId))) :*: (S1 ('MetaSel ('Just "inputArtifacts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Artifact])) :*: S1 ('MetaSel ('Just "actionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActionConfiguration))))))

newThirdPartyJobData :: ThirdPartyJobData Source #

Create a value of ThirdPartyJobData 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:continuationToken:ThirdPartyJobData', thirdPartyJobData_continuationToken - A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires to continue the job asynchronously.

$sel:outputArtifacts:ThirdPartyJobData', thirdPartyJobData_outputArtifacts - The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.

$sel:artifactCredentials:ThirdPartyJobData', thirdPartyJobData_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 artifact for the pipeline in AWS CodePipeline.

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

Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.

$sel:encryptionKey:ThirdPartyJobData', thirdPartyJobData_encryptionKey - The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.

$sel:actionTypeId:ThirdPartyJobData', thirdPartyJobData_actionTypeId - Represents information about an action type.

$sel:inputArtifacts:ThirdPartyJobData', thirdPartyJobData_inputArtifacts - The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.

$sel:actionConfiguration:ThirdPartyJobData', thirdPartyJobData_actionConfiguration - Represents information about an action configuration.

thirdPartyJobData_continuationToken :: Lens' ThirdPartyJobData (Maybe Text) Source #

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

thirdPartyJobData_outputArtifacts :: Lens' ThirdPartyJobData (Maybe [Artifact]) Source #

The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.

thirdPartyJobData_artifactCredentials :: Lens' ThirdPartyJobData (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 artifact for the pipeline in AWS CodePipeline.

thirdPartyJobData_pipelineContext :: Lens' ThirdPartyJobData (Maybe PipelineContext) Source #

Represents information about a pipeline to a job worker.

Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.

thirdPartyJobData_encryptionKey :: Lens' ThirdPartyJobData (Maybe EncryptionKey) Source #

The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.

thirdPartyJobData_actionTypeId :: Lens' ThirdPartyJobData (Maybe ActionTypeId) Source #

Represents information about an action type.

thirdPartyJobData_inputArtifacts :: Lens' ThirdPartyJobData (Maybe [Artifact]) Source #

The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.

thirdPartyJobData_actionConfiguration :: Lens' ThirdPartyJobData (Maybe ActionConfiguration) Source #

Represents information about an action configuration.