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

UpdateDeployment

Updates a deployment.

Request Syntax


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

{
   "deploymentId": "string",
   "deploymentPatternVersionName": "string",
   "dryRun": boolean,
   "force": boolean,
   "specifications": { 
      "string" : "string" 
   },
   "workloadVersionName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

deploymentId

The ID of the deployment.

Type: String

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

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

Required: Yes

deploymentPatternVersionName

The name of the deployment pattern version.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 30.

Pattern: (([A-Za-z0-9][a-zA-Z0-9-]*)|(\d+\.\d+\.\d+))

Required: No

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

force

Forces the update even if validation warnings are present.

Type: Boolean

Required: No

specifications

The settings specified for the deployment. These settings define how to deploy and configure your resources created by the deployment. For more information about the specifications required for creating a deployment for a SAP workload, see SAP deployment specifications. To retrieve the specifications required to create a deployment for other workloads, use the GetWorkloadDeploymentPattern operation.

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

workloadVersionName

The name of the workload version.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 30.

Pattern: (([A-Za-z0-9][a-zA-Z0-9-]*)|(\d+\.\d+\.\d+))

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "deployment": { 
      "createdAt": number,
      "id": "string",
      "modifiedAt": number,
      "name": "string",
      "patternName": "string",
      "status": "string",
      "workloadName": "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.

deployment

The deployment.

Type: DeploymentDataSummary object

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