Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StartDeployment

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.

Request Syntax


POST /apps/appId/branches/branchName/deployments/start HTTP/1.1
Content-type: application/json

{
   "jobId": "string",
   "sourceUrl": "string",
   "sourceUrlType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

appId

The unique ID for an Amplify app.

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: d[a-z0-9]+

Required: Yes

branchName

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

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

Required: Yes

Request Body

The request accepts the following data in JSON format.

jobId

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

Type: String

Length Constraints: Maximum length of 255.

Pattern: [0-9]+

Required: No

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.

Type: String

Length Constraints: Maximum length of 3000.

Pattern: ^(s3|https|http)://.*

Required: No

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.

Type: String

Valid Values: ZIP | BUCKET_PREFIX

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "jobSummary": { 
      "commitId": "string",
      "commitMessage": "string",
      "commitTime": number,
      "endTime": number,
      "jobArn": "string",
      "jobId": "string",
      "jobType": "string",
      "sourceUrl": "string",
      "sourceUrlType": "string",
      "startTime": number,
      "status": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

jobSummary

The summary for the job.

Type: JobSummary object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

A request contains unexpected data.

HTTP Status Code: 400

InternalFailureException

The service failed to perform an operation due to an internal issue.

HTTP Status Code: 500

LimitExceededException

A resource could not be created because service quotas were exceeded.

HTTP Status Code: 429

NotFoundException

An entity was not found during an operation.

HTTP Status Code: 404

UnauthorizedException

An operation failed due to a lack of access.

HTTP Status Code: 401