StartDeployment - AWS Amplify

StartDeployment

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

Request Syntax

POST /apps/appId/branches/branchName/deployments/start HTTP/1.1 Content-type: application/json { "jobId": "string", "sourceUrl": "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 for the branch, for the 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, generated by the create deployment request.

Type: String

Length Constraints: Maximum length of 255.

Pattern: [0-9]+

Required: No

sourceUrl

The source URL for this deployment, used when calling start deployment without create deployment. The source URL can be any HTTP GET URL that is publicly accessible and downloads a single .zip file.

Type: String

Length Constraints: Maximum length of 3000.

Pattern: (?s).*

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", "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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: