Proton / Client / cancel_service_pipeline_deployment

cancel_service_pipeline_deployment#

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 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.

See also: AWS API Documentation

Request Syntax

response = client.cancel_service_pipeline_deployment(
    serviceName='string'
)

Parameters:

serviceName (string) –

[REQUIRED]

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

Return type:

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',
        'lastDeploymentAttemptedAt': datetime(2015, 1, 1),
        'lastDeploymentSucceededAt': datetime(2015, 1, 1),
        '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.
  - 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.
  - 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

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ConflictException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException