:doc:`Proton <../../proton>` / Client / delete_deployment

*****************
delete_deployment
*****************



.. py:method:: Proton.Client.delete_deployment(**kwargs)

  

  Delete the deployment.

  

  .. danger::

        This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/DeleteDeployment>`_  


  **Request Syntax**
  ::

    response = client.delete_deployment(
        id='string'
    )
    
  :type id: string
  :param id: **[REQUIRED]** 

    The ID of the deployment to delete.

    

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

    
    ::

      {
          'deployment': {
              'arn': 'string',
              'completedAt': datetime(2015, 1, 1),
              'componentName': 'string',
              'createdAt': datetime(2015, 1, 1),
              'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
              'deploymentStatusMessage': 'string',
              'environmentName': 'string',
              'id': 'string',
              'initialState': {
                  'component': {
                      'serviceInstanceName': 'string',
                      'serviceName': 'string',
                      'serviceSpec': 'string',
                      'templateFile': 'string'
                  },
                  'environment': {
                      'spec': 'string',
                      'templateMajorVersion': 'string',
                      'templateMinorVersion': 'string',
                      'templateName': 'string'
                  },
                  'serviceInstance': {
                      'lastSuccessfulComponentDeploymentIds': [
                          'string',
                      ],
                      'lastSuccessfulEnvironmentDeploymentId': 'string',
                      'lastSuccessfulServicePipelineDeploymentId': 'string',
                      'spec': 'string',
                      'templateMajorVersion': 'string',
                      'templateMinorVersion': 'string',
                      'templateName': 'string'
                  },
                  'servicePipeline': {
                      'spec': 'string',
                      'templateMajorVersion': 'string',
                      'templateMinorVersion': 'string',
                      'templateName': 'string'
                  }
              },
              'lastAttemptedDeploymentId': 'string',
              'lastModifiedAt': datetime(2015, 1, 1),
              'lastSucceededDeploymentId': 'string',
              'serviceInstanceName': 'string',
              'serviceName': 'string',
              'targetArn': 'string',
              'targetResourceCreatedAt': datetime(2015, 1, 1),
              'targetResourceType': 'ENVIRONMENT'|'SERVICE_PIPELINE'|'SERVICE_INSTANCE'|'COMPONENT',
              'targetState': {
                  'component': {
                      'serviceInstanceName': 'string',
                      'serviceName': 'string',
                      'serviceSpec': 'string',
                      'templateFile': 'string'
                  },
                  'environment': {
                      'spec': 'string',
                      'templateMajorVersion': 'string',
                      'templateMinorVersion': 'string',
                      'templateName': 'string'
                  },
                  'serviceInstance': {
                      'lastSuccessfulComponentDeploymentIds': [
                          'string',
                      ],
                      'lastSuccessfulEnvironmentDeploymentId': 'string',
                      'lastSuccessfulServicePipelineDeploymentId': 'string',
                      'spec': 'string',
                      'templateMajorVersion': 'string',
                      'templateMinorVersion': 'string',
                      'templateName': 'string'
                  },
                  'servicePipeline': {
                      'spec': 'string',
                      'templateMajorVersion': 'string',
                      'templateMinorVersion': 'string',
                      'templateName': 'string'
                  }
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The detailed data of the deployment being deleted.

        
        

        - **arn** *(string) --* 

          The Amazon Resource Name (ARN) of the deployment.

          
        

        - **completedAt** *(datetime) --* 

          The date and time the deployment was completed.

          
        

        - **componentName** *(string) --* 

          The name of the component associated with this deployment.

          
        

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

          The date and time the deployment was created.

          
        

        - **deploymentStatus** *(string) --* 

          The status of the deployment.

          
        

        - **deploymentStatusMessage** *(string) --* 

          The deployment status message.

          
        

        - **environmentName** *(string) --* 

          The name of the environment associated with this deployment.

          
        

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

          The ID of the deployment.

          
        

        - **initialState** *(dict) --* 

          The initial state of the target resource at the time of the deployment.

          .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``component``, ``environment``, ``serviceInstance``, ``servicePipeline``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


        
          

          - **component** *(dict) --* 

            The state of the component associated with the deployment.

            
            

            - **serviceInstanceName** *(string) --* 

              The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

              
            

            - **serviceName** *(string) --* 

              The name of the service that ``serviceInstanceName`` is associated with. Provided when a component is attached to a service instance.

              
            

            - **serviceSpec** *(string) --* 

              The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

              
            

            - **templateFile** *(string) --* 

              The template file used.

              
        
          

          - **environment** *(dict) --* 

            The state of the environment associated with the deployment.

            
            

            - **spec** *(string) --* 

              The environment spec that was used to create the environment.

              
            

            - **templateMajorVersion** *(string) --* 

              The major version of the environment template that was used to create the environment.

              
            

            - **templateMinorVersion** *(string) --* 

              The minor version of the environment template that was used to create the environment.

              
            

            - **templateName** *(string) --* 

              The name of the environment template that was used to create the environment.

              
        
          

          - **serviceInstance** *(dict) --* 

            The state of the service instance associated with the deployment.

            
            

            - **lastSuccessfulComponentDeploymentIds** *(list) --* 

              The IDs for the last successful components deployed for this service instance.

              
              

              - *(string) --* 
          
            

            - **lastSuccessfulEnvironmentDeploymentId** *(string) --* 

              The ID for the last successful environment deployed for this service instance.

              
            

            - **lastSuccessfulServicePipelineDeploymentId** *(string) --* 

              The ID for the last successful service pipeline deployed for this service instance.

              
            

            - **spec** *(string) --* 

              The service spec that was used to create the service instance.

              
            

            - **templateMajorVersion** *(string) --* 

              The major version of the service template that was used to create the service pipeline.

              
            

            - **templateMinorVersion** *(string) --* 

              The minor version of the service template that was used to create the service pipeline.

              
            

            - **templateName** *(string) --* 

              The name of the service template that was used to create the service instance.

              
        
          

          - **servicePipeline** *(dict) --* 

            The state of the service pipeline associated with the deployment.

            
            

            - **spec** *(string) --* 

              The service spec that was used to create the service pipeline.

              
            

            - **templateMajorVersion** *(string) --* 

              The major version of the service template that was used to create the service pipeline.

              
            

            - **templateMinorVersion** *(string) --* 

              The minor version of the service template that was used to create the service pipeline.

              
            

            - **templateName** *(string) --* 

              The name of the service template that was used to create the service pipeline.

              
        
      
        

        - **lastAttemptedDeploymentId** *(string) --* 

          The ID of the last attempted deployment.

          
        

        - **lastModifiedAt** *(datetime) --* 

          The date and time the deployment was last modified.

          
        

        - **lastSucceededDeploymentId** *(string) --* 

          The ID of the last successful deployment.

          
        

        - **serviceInstanceName** *(string) --* 

          The name of the deployment's service instance.

          
        

        - **serviceName** *(string) --* 

          The name of the service in this deployment.

          
        

        - **targetArn** *(string) --* 

          The Amazon Resource Name (ARN) of the target of the deployment.

          
        

        - **targetResourceCreatedAt** *(datetime) --* 

          The date and time the depoyment target was created.

          
        

        - **targetResourceType** *(string) --* 

          The resource type of the deployment target. It can be an environment, service, service instance, or component.

          
        

        - **targetState** *(dict) --* 

          The target state of the target resource at the time of the deployment.

          .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``component``, ``environment``, ``serviceInstance``, ``servicePipeline``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


        
          

          - **component** *(dict) --* 

            The state of the component associated with the deployment.

            
            

            - **serviceInstanceName** *(string) --* 

              The name of the service instance that this component is attached to. Provided when a component is attached to a service instance.

              
            

            - **serviceName** *(string) --* 

              The name of the service that ``serviceInstanceName`` is associated with. Provided when a component is attached to a service instance.

              
            

            - **serviceSpec** *(string) --* 

              The service spec that the component uses to access service inputs. Provided when a component is attached to a service instance.

              
            

            - **templateFile** *(string) --* 

              The template file used.

              
        
          

          - **environment** *(dict) --* 

            The state of the environment associated with the deployment.

            
            

            - **spec** *(string) --* 

              The environment spec that was used to create the environment.

              
            

            - **templateMajorVersion** *(string) --* 

              The major version of the environment template that was used to create the environment.

              
            

            - **templateMinorVersion** *(string) --* 

              The minor version of the environment template that was used to create the environment.

              
            

            - **templateName** *(string) --* 

              The name of the environment template that was used to create the environment.

              
        
          

          - **serviceInstance** *(dict) --* 

            The state of the service instance associated with the deployment.

            
            

            - **lastSuccessfulComponentDeploymentIds** *(list) --* 

              The IDs for the last successful components deployed for this service instance.

              
              

              - *(string) --* 
          
            

            - **lastSuccessfulEnvironmentDeploymentId** *(string) --* 

              The ID for the last successful environment deployed for this service instance.

              
            

            - **lastSuccessfulServicePipelineDeploymentId** *(string) --* 

              The ID for the last successful service pipeline deployed for this service instance.

              
            

            - **spec** *(string) --* 

              The service spec that was used to create the service instance.

              
            

            - **templateMajorVersion** *(string) --* 

              The major version of the service template that was used to create the service pipeline.

              
            

            - **templateMinorVersion** *(string) --* 

              The minor version of the service template that was used to create the service pipeline.

              
            

            - **templateName** *(string) --* 

              The name of the service template that was used to create the service instance.

              
        
          

          - **servicePipeline** *(dict) --* 

            The state of the service pipeline associated with the deployment.

            
            

            - **spec** *(string) --* 

              The service spec that was used to create the service pipeline.

              
            

            - **templateMajorVersion** *(string) --* 

              The major version of the service template that was used to create the service pipeline.

              
            

            - **templateMinorVersion** *(string) --* 

              The minor version of the service template that was used to create the service pipeline.

              
            

            - **templateName** *(string) --* 

              The name of the service template that was used to create the service pipeline.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`Proton.Client.exceptions.ValidationException`

  
  *   :py:class:`Proton.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Proton.Client.exceptions.ThrottlingException`

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

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

  