Skip to content

JobSummary

Source code in docs_src/capo_amplify/types/job_summary.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
class JobSummary(TypedDict, closed=True):
    job_arn: "capo_amplify.types.job_arn.JobArn"
    """<p> The Amazon Resource Name (ARN) for the job. </p>"""
    job_id: "capo_amplify.types.job_id.JobId"
    """<p> The unique ID for the job. </p>"""
    commit_id: "capo_amplify.types.commit_id.CommitId"
    """<p> The commit ID from a third-party repository provider for the job. </p>"""
    commit_message: "capo_amplify.types.commit_message.CommitMessage"
    """<p> The commit message from a third-party repository provider for the job. </p>"""
    commit_time: "capo_amplify.types.commit_time.CommitTime"
    """<p>The commit date and time for the job. </p>"""
    start_time: "capo_amplify.types.start_time.StartTime"
    """<p> The start date and time for the job. </p>"""
    status: "capo_amplify.types.job_status.JobStatus"
    """<p> The current status for the job. </p>"""
    end_time: NotRequired["capo_amplify.types.end_time.EndTime"]
    """<p> The end date and time for the job. </p>"""
    job_type: "capo_amplify.types.job_type.JobType"
    """<p> The type for the job. If the value is <code>RELEASE</code>, the job was manually released from its source by using the <code>StartJob</code> API. This value is available only for apps that are connected to a repository.</p> <p>If the value is <code>RETRY</code>, the job was manually retried using the <code>StartJob</code> API. If the value is <code>WEB_HOOK</code>, the job was automatically triggered by webhooks. If the value is <code>MANUAL</code>, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.</p>"""
    source_url: NotRequired["capo_amplify.types.source_url.SourceUrl"]
    """<p>The source URL for the files to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.</p>"""
    source_url_type: NotRequired["capo_amplify.types.source_url_type.SourceUrlType"]
    """<p>The type of source specified by the <code>sourceURL</code>. If the value is <code>ZIP</code>, the source is a .zip file. If the value is <code>BUCKET_PREFIX</code>, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is <code>ZIP</code>.</p>"""

commit_id instance-attribute 

commit_id: CommitId

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

commit_message instance-attribute 

commit_message: CommitMessage

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

commit_time instance-attribute 

commit_time: CommitTime

The commit date and time for the job.

end_time instance-attribute 

end_time: NotRequired[EndTime]

The end date and time for the job.

job_arn instance-attribute 

job_arn: JobArn

The Amazon Resource Name (ARN) for the job.

job_id instance-attribute 

job_id: JobId

The unique ID for the job.

job_type instance-attribute 

job_type: JobType

The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. This value is available only for apps that are connected to a repository.

If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository.

source_url instance-attribute 

source_url: NotRequired[SourceUrl]

The source URL for the files to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip file, or an Amazon S3 bucket and prefix.

source_url_type instance-attribute 

source_url_type: NotRequired[SourceUrlType]

The type of source specified by the sourceURL. If the value is ZIP, the source is a .zip file. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and prefix. If no value is specified, the default is ZIP.

start_time instance-attribute 

start_time: StartTime

The start date and time for the job.

status instance-attribute 

status: JobStatus

The current status for the job.