Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . amplify ]

start-deployment

Description

Start a deployment for manual deploy apps. (Apps are not connected to repository)

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  start-deployment
--app-id <value>
--branch-name <value>
[--job-id <value>]
[--source-url <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

Unique Id for an Amplify App.

--branch-name (string)

Name for the branch, for the Job.

--job-id (string)

The job id for this deployment, generated by create deployment request.

--source-url (string)

The sourceUrl for this deployment, used when calling start deployment without create deployment. SourceUrl can be any HTTP GET url that is public accessible and downloads a single zip.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

jobSummary -> (structure)

Summary for the Job.

jobArn -> (string)

Arn for the Job.

jobId -> (string)

Unique Id for the Job.

commitId -> (string)

Commit Id from 3rd party repository provider for the Job.

commitMessage -> (string)

Commit message from 3rd party repository provider for the Job.

commitTime -> (timestamp)

Commit date / time for the Job.

startTime -> (timestamp)

Start date / time for the Job.

status -> (string)

Status for the Job.

endTime -> (timestamp)

End date / time for the Job.

jobType -> (string)

Type for the Job. n "RELEASE": Manually released from source by using StartJob API. "RETRY": Manually retried by using StartJob API. "WEB_HOOK": Automatically triggered by WebHooks.