:doc:`LaunchWizard <../../launch-wizard>` / Client / update_deployment

*****************
update_deployment
*****************



.. py:method:: LaunchWizard.Client.update_deployment(**kwargs)

  

  Updates a deployment.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/launch-wizard-2018-05-10/UpdateDeployment>`_  


  **Request Syntax**
  ::

    response = client.update_deployment(
        deploymentId='string',
        specifications={
            'string': 'string'
        },
        workloadVersionName='string',
        deploymentPatternVersionName='string',
        dryRun=True|False,
        force=True|False
    )
    
  :type deploymentId: string
  :param deploymentId: **[REQUIRED]** 

    The ID of the deployment.

    

  
  :type specifications: dict
  :param specifications: **[REQUIRED]** 

    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 `GetWorkloadDeploymentPattern <https://docs.aws.amazon.com/launchwizard/latest/APIReference/API_GetWorkloadDeploymentPattern.html>`__ operation.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  :type workloadVersionName: string
  :param workloadVersionName: 

    The name of the workload version.

    

  
  :type deploymentPatternVersionName: string
  :param deploymentPatternVersionName: 

    The name of the deployment pattern version.

    

  
  :type dryRun: boolean
  :param 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 force: boolean
  :param force: 

    Forces the update even if validation warnings are present.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'deployment': {
              'name': 'string',
              'id': 'string',
              'workloadName': 'string',
              'patternName': 'string',
              'status': 'COMPLETED'|'CREATING'|'DELETE_IN_PROGRESS'|'DELETE_INITIATING'|'DELETE_FAILED'|'DELETED'|'FAILED'|'IN_PROGRESS'|'VALIDATING'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETED'|'UPDATE_FAILED'|'UPDATE_ROLLBACK_COMPLETED'|'UPDATE_ROLLBACK_FAILED',
              'createdAt': datetime(2015, 1, 1),
              'modifiedAt': datetime(2015, 1, 1)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **deployment** *(dict) --* 

        The deployment.

        
        

        - **name** *(string) --* 

          The name of the deployment

          
        

        - **id** *(string) --* 

          The ID of the deployment.

          
        

        - **workloadName** *(string) --* 

          The name of the workload.

          
        

        - **patternName** *(string) --* 

          The name of the workload deployment pattern.

          
        

        - **status** *(string) --* 

          The status of the deployment.

          
        

        - **createdAt** *(datetime) --* 

          The time the deployment was created.

          
        

        - **modifiedAt** *(datetime) --* 

          The time the deployment was last modified.

          
    
  
  **Exceptions**
  
  *   :py:class:`LaunchWizard.Client.exceptions.ResourceLimitException`

  
  *   :py:class:`LaunchWizard.Client.exceptions.InternalServerException`

  
  *   :py:class:`LaunchWizard.Client.exceptions.ValidationException`

  
  *   :py:class:`LaunchWizard.Client.exceptions.ResourceNotFoundException`

  