Skip to content

ThirdPartyJobData

Source code in docs_src/capo_codepipeline/types/third_party_job_data.py
class ThirdPartyJobData(TypedDict, closed=True):
    action_type_id: NotRequired["capo_codepipeline.types.action_type_id.ActionTypeId"]
    """<p>Represents information about an action type.</p>"""
    action_configuration: NotRequired[
        "capo_codepipeline.types.action_configuration.ActionConfiguration"
    ]
    """<p>Represents information about an action configuration.</p>"""
    pipeline_context: NotRequired[
        "capo_codepipeline.types.pipeline_context.PipelineContext"
    ]
    """<p>Represents information about a pipeline to a job worker.</p> <note> <p>Does not include <code>pipelineArn</code> and <code>pipelineExecutionId</code> for ThirdParty jobs.</p> </note>"""
    input_artifacts: NotRequired["capo_codepipeline.types.artifact_list.ArtifactList"]
    """<p>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.</p>"""
    output_artifacts: NotRequired["capo_codepipeline.types.artifact_list.ArtifactList"]
    """<p>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.</p>"""
    artifact_credentials: NotRequired[
        "capo_codepipeline.types.aws_session_credentials.AWSSessionCredentials"
    ]
    """<p>Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services 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 CodePipeline. </p>"""
    continuation_token: NotRequired[
        "capo_codepipeline.types.continuation_token.ContinuationToken"
    ]
    """<p>A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously.</p>"""
    encryption_key: NotRequired["capo_codepipeline.types.encryption_key.EncryptionKey"]
    """<p>The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an Amazon Web Services Key Management Service (Amazon Web Services KMS) key. This is optional and might not be present.</p>"""

action_configuration instance-attribute

action_configuration: NotRequired[ActionConfiguration]

Represents information about an action configuration.

action_type_id instance-attribute

action_type_id: NotRequired[ActionTypeId]

Represents information about an action type.

artifact_credentials instance-attribute

artifact_credentials: NotRequired[AWSSessionCredentials]

Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services 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 CodePipeline.

continuation_token instance-attribute

continuation_token: NotRequired[ContinuationToken]

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

encryption_key instance-attribute

encryption_key: NotRequired[EncryptionKey]

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

input_artifacts instance-attribute

input_artifacts: NotRequired[ArtifactList]

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.

output_artifacts instance-attribute

output_artifacts: NotRequired[ArtifactList]

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.

pipeline_context instance-attribute

pipeline_context: NotRequired[PipelineContext]

Represents information about a pipeline to a job worker.

Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.