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

CreateDeployment

Creates a deployment for the given workload. Deployments created by this operation are not available in the Launch Wizard console to use the Clone deployment action on.

Request Syntax


POST /createDeployment HTTP/1.1
Content-type: application/json

{
   "deploymentPatternName": "string",
   "dryRun": boolean,
   "name": "string",
   "specifications": { 
      "string" : "string" 
   },
   "workloadName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

deploymentPatternName

The name of the deployment pattern supported by a given workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.

Type: String

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

Pattern: ^[a-zA-Z0-9-]+$

Required: Yes

dryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

name

The name of the deployment.

Type: String

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

Pattern: ^[A-Za-z0-9_\s\.-]+$

Required: Yes

specifications

The settings specified for the deployment. For more information on the specifications required for creating a deployment, see Workload specifications.

Type: String to string map

Map Entries: Maximum number of 100 items.

Key Length Constraints: Minimum length of 3. Maximum length of 256.

Key Pattern: ^[a-zA-Z0-9-:]+$

Value Length Constraints: Minimum length of 1. Maximum length of 1500.

Required: Yes

workloadName

The name of the workload. You can use the ListWorkloadDeploymentPatterns operation to discover supported values for this parameter.

Type: String

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

Pattern: ^[A-Za-z][a-zA-Z0-9-_]*$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "deploymentId": "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.

deploymentId

The ID of the deployment.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-]+$

Errors

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

InternalServerException

An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post.

HTTP Status Code: 500

ResourceLimitException

You have exceeded an AWS Launch Wizard resource limit. For example, you might have too many deployments in progress.

HTTP Status Code: 400

ResourceNotFoundException

The specified workload or deployment resource can't be found.

HTTP Status Code: 404

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400