Skip to content

StartDeploymentRequest

Source code in docs_src/capo_amplify/types/start_deployment_request.py 
15
16
17
18
19
20
21
22
23
24
25
class StartDeploymentRequest(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 deployment job. </p>"""
    job_id: NotRequired["capo_amplify.types.job_id.JobId"]
    """<p>The job ID for this deployment that is generated by the <code>CreateDeployment</code> request. </p>"""
    source_url: NotRequired["capo_amplify.types.source_url.SourceUrl"]
    """<p>The source URL for the deployment that is used when calling <code>StartDeployment</code> without <code>CreateDeployment</code>. 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>"""

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 deployment job.

job_id instance-attribute 

job_id: NotRequired[JobId]

The job ID for this deployment that is generated by the CreateDeployment request.

source_url instance-attribute 

source_url: NotRequired[SourceUrl]

The source URL for the deployment that is used when calling StartDeployment without CreateDeployment. 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.