Skip to content

JobData

Source code in docs_src/capo_codepipeline/types/job_data.py
class JobData(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>Includes <code>pipelineArn</code> and <code>pipelineExecutionId</code> for custom jobs.</p> </note>"""
    input_artifacts: NotRequired["capo_codepipeline.types.artifact_list.ArtifactList"]
    """<p>The artifact supplied to the job.</p>"""
    output_artifacts: NotRequired["capo_codepipeline.types.artifact_list.ArtifactList"]
    """<p>The output of the job.</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 artifacts for the pipeline in CodePipeline.</p>"""
    continuation_token: NotRequired[
        "capo_codepipeline.types.continuation_token.ContinuationToken"
    ]
    """<p>A system-generated token, such as a deployment ID, required by a job to continue the job asynchronously.</p>"""
    encryption_key: NotRequired["capo_codepipeline.types.encryption_key.EncryptionKey"]
    """<p>Represents information about the key used to encrypt data in the artifact store, such as an KMS key. </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 artifacts for the pipeline in CodePipeline.

continuation_token instance-attribute

continuation_token: NotRequired[ContinuationToken]

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

encryption_key instance-attribute

encryption_key: NotRequired[EncryptionKey]

Represents information about the key used to encrypt data in the artifact store, such as an KMS key.

input_artifacts instance-attribute

input_artifacts: NotRequired[ArtifactList]

The artifact supplied to the job.

output_artifacts instance-attribute

output_artifacts: NotRequired[ArtifactList]

The output of the job.

pipeline_context instance-attribute

pipeline_context: NotRequired[PipelineContext]

Represents information about a pipeline to a job worker.

Includes pipelineArn and pipelineExecutionId for custom jobs.