# UpdateDeployment
<a name="API_UpdateDeployment"></a>

Updates a deployment.

## Request Syntax
<a name="API_UpdateDeployment_RequestSyntax"></a>

```
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
<a name="API_UpdateDeployment_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateDeployment_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [deploymentId](#API_UpdateDeployment_RequestSyntax) **   <a name="launchwizard-UpdateDeployment-request-deploymentId"></a>
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](#API_UpdateDeployment_RequestSyntax) **   <a name="launchwizard-UpdateDeployment-request-deploymentPatternVersionName"></a>
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](#API_UpdateDeployment_RequestSyntax) **   <a name="launchwizard-UpdateDeployment-request-dryRun"></a>
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](#API_UpdateDeployment_RequestSyntax) **   <a name="launchwizard-UpdateDeployment-request-force"></a>
Forces the update even if validation warnings are present.  
Type: Boolean  
Required: No

 ** [specifications](#API_UpdateDeployment_RequestSyntax) **   <a name="launchwizard-UpdateDeployment-request-specifications"></a>
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](https://docs.aws.amazon.com/launchwizard/latest/APIReference/launch-wizard-specifications-sap.html). To retrieve the specifications required to create a deployment for other workloads, use the [https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_GetWorkloadDeploymentPattern.html](https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_GetWorkloadDeploymentPattern.html) 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](#API_UpdateDeployment_RequestSyntax) **   <a name="launchwizard-UpdateDeployment-request-workloadVersionName"></a>
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
<a name="API_UpdateDeployment_ResponseSyntax"></a>

```
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
<a name="API_UpdateDeployment_ResponseElements"></a>

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](#API_UpdateDeployment_ResponseSyntax) **   <a name="launchwizard-UpdateDeployment-response-deployment"></a>
The deployment.  
Type: [DeploymentDataSummary](API_DeploymentDataSummary.md) object

## Errors
<a name="API_UpdateDeployment_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://repost.aws/).  
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

## See Also
<a name="API_UpdateDeployment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/launch-wizard-2018-05-10/UpdateDeployment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/launch-wizard-2018-05-10/UpdateDeployment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/launch-wizard-2018-05-10/UpdateDeployment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/launch-wizard-2018-05-10/UpdateDeployment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/launch-wizard-2018-05-10/UpdateDeployment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/launch-wizard-2018-05-10/UpdateDeployment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/launch-wizard-2018-05-10/UpdateDeployment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/launch-wizard-2018-05-10/UpdateDeployment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/launch-wizard-2018-05-10/UpdateDeployment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/launch-wizard-2018-05-10/UpdateDeployment)