AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . amplify ]

start-deployment

Description

Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a Git repository.

The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail.

See also: AWS API Documentation

Synopsis

  start-deployment
--app-id <value>
--branch-name <value>
[--job-id <value>]
[--source-url <value>]
[--source-url-type <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--app-id (string)

The unique ID for an Amplify app.

--branch-name (string)

The name of the branch to use for the deployment job.

--job-id (string)

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

--source-url (string)

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 (string)

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 .

Possible values:

  • ZIP
  • BUCKET_PREFIX

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

jobSummary -> (structure)

The summary for the job.

jobArn -> (string)

The Amazon Resource Name (ARN) for the job.

jobId -> (string)

The unique ID for the job.

commitId -> (string)

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

commitMessage -> (string)

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

commitTime -> (timestamp)

The commit date and time for the job.

startTime -> (timestamp)

The start date and time for the job.

status -> (string)

The current status for the job.

endTime -> (timestamp)

The end date and time for the job.

jobType -> (string)

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.

sourceUrl -> (string)

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.

sourceUrlType -> (string)

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 .