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

**********************************
cancel_service_pipeline_deployment
**********************************



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

  

  Attempts to cancel a service pipeline deployment on an  UpdateServicePipeline action, if the deployment is ``IN_PROGRESS``. For more information, see `Update a service pipeline <https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html>`__ in the *Proton User guide*.

   

  The following list includes potential cancellation scenarios.

   

  
  * If the cancellation attempt succeeds, the resulting deployment state is ``CANCELLED``.
   
  * If the cancellation attempt fails, the resulting deployment state is ``FAILED``.
   
  * If the current  UpdateServicePipeline action succeeds before the cancellation attempt starts, the resulting deployment state is ``SUCCEEDED`` and the cancellation attempt has no effect.
  

  

  .. 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/CancelServicePipelineDeployment>`_  


  **Request Syntax**
  ::

    response = client.cancel_service_pipeline_deployment(
        serviceName='string'
    )
    
  :type serviceName: string
  :param serviceName: **[REQUIRED]** 

    The name of the service with the service pipeline deployment to cancel.

    

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

    
    ::

      {
          'pipeline': {
              'arn': 'string',
              'createdAt': datetime(2015, 1, 1),
              'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED',
              'deploymentStatusMessage': 'string',
              'lastAttemptedDeploymentId': 'string',
              'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
              'lastDeploymentSucceededAt': datetime(2015, 1, 1),
              'lastSucceededDeploymentId': 'string',
              'spec': 'string',
              'templateMajorVersion': 'string',
              'templateMinorVersion': 'string',
              'templateName': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **pipeline** *(dict) --* 

        The service pipeline detail data that's returned by Proton.

        
        

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

          The Amazon Resource Name (ARN) of the service pipeline.

          
        

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

          The time when the service pipeline was created.

          
        

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

          The deployment status of the service pipeline.

          
        

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

          A service pipeline deployment status message.

          
        

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

          The ID of the last attempted deployment of this service pipeline.

          
        

        - **lastDeploymentAttemptedAt** *(datetime) --* 

          The time when a deployment of the service pipeline was last attempted.

          
        

        - **lastDeploymentSucceededAt** *(datetime) --* 

          The time when the service pipeline was last deployed successfully.

          
        

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

          The ID of the last successful deployment of this service pipeline.

          
        

        - **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.ConflictException`

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

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

  