Creates a deployment for a manually deployed Amplify 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 HTTP/1.1
Content-type: application/json
{
"fileMap": {
"string" : "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 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.
- fileMap
-
An optional file map that contains the file name as the key and the file content md5 hash as the value. If this argument is provided, the service will generate a unique upload URL per file. Otherwise, the service will only generate a single upload URL for the zipped files.
Type: String to string map
Key Length Constraints: Maximum length of 255.
Key Pattern:
(?s).*Value Length Constraints: Maximum length of 32.
Value Pattern:
(?s).*Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"fileUploadUrls": {
"string" : "string"
},
"jobId": "string",
"zipUploadUrl": "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.
- fileUploadUrls
-
When the
fileMapargument is provided in the request,fileUploadUrlswill contain a map of file names to upload URLs.Type: String to string map
Key Length Constraints: Maximum length of 255.
Key Pattern:
(?s).*Value Length Constraints: Maximum length of 1000.
- jobId
-
The job ID for this deployment. will supply to start deployment api.
Type: String
Length Constraints: Maximum length of 255.
Pattern:
[0-9]+ - zipUploadUrl
-
When the
fileMapargument is not provided in the request, thiszipUploadUrlis returned.Type: String
Length Constraints: Maximum length of 1000.
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
- 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:
