Skip to content

StartJobRequest

Source code in docs_src/capo_amplify/types/start_job_request.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class StartJobRequest(TypedDict, closed=True):
    app_id: "capo_amplify.types.app_id.AppId"
    """<p>The unique ID for an Amplify app. </p>"""
    branch_name: "capo_amplify.types.branch_name.BranchName"
    """<p>The name of the branch to use for the job. </p>"""
    job_id: NotRequired["capo_amplify.types.job_id.JobId"]
    """<p>The unique ID for an existing job. This is required if the value of <code>jobType</code> is <code>RETRY</code>. </p>"""
    job_type: "capo_amplify.types.job_type.JobType"
    """<p>Describes the type for the job. The job type <code>RELEASE</code> starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository. </p> <p>The job type <code>RETRY</code> retries an existing job. If the job type value is <code>RETRY</code>, the <code>jobId</code> is also required. </p>"""
    job_reason: NotRequired["capo_amplify.types.job_reason.JobReason"]
    """<p>A descriptive reason for starting the job.</p>"""
    commit_id: NotRequired["capo_amplify.types.commit_id.CommitId"]
    """<p> The commit ID from a third-party repository provider for the job. </p>"""
    commit_message: NotRequired["capo_amplify.types.commit_message.CommitMessage"]
    """<p> The commit message from a third-party repository provider for the job. </p>"""
    commit_time: NotRequired["capo_amplify.types.commit_time.CommitTime"]
    """<p> The commit date and time for the job. </p>"""

app_id instance-attribute 

app_id: AppId

The unique ID for an Amplify app.

branch_name instance-attribute 

branch_name: BranchName

The name of the branch to use for the job.

commit_id instance-attribute 

commit_id: NotRequired[CommitId]

The commit ID from a third-party repository provider for the job.

commit_message instance-attribute 

commit_message: NotRequired[CommitMessage]

The commit message from a third-party repository provider for the job.

commit_time instance-attribute 

commit_time: NotRequired[CommitTime]

The commit date and time for the job.

job_id instance-attribute 

job_id: NotRequired[JobId]

The unique ID for an existing job. This is required if the value of jobType is RETRY.

job_reason instance-attribute 

job_reason: NotRequired[JobReason]

A descriptive reason for starting the job.

job_type instance-attribute 

job_type: JobType

Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository.

The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.