CodeDeploy / Client / stop_deployment

stop_deployment#

CodeDeploy.Client.stop_deployment(**kwargs)#

Attempts to stop an ongoing deployment.

See also: AWS API Documentation

Request Syntax

response = client.stop_deployment(
    deploymentId='string',
    autoRollbackEnabled=True|False
)
Parameters:

  • deploymentId (string) –

    [REQUIRED]

    The unique ID of a deployment.

  • autoRollbackEnabled (boolean) – Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'Pending'|'Succeeded',
    'statusMessage': 'string'
}

Response Structure

  • (dict) –

    Represents the output of a StopDeployment operation.

    • status (string) –

      The status of the stop deployment operation:

      • Pending: The stop operation is pending.

      • Succeeded: The stop operation was successful.

    • statusMessage (string) –

      An accompanying status message.

Exceptions

  • CodeDeploy.Client.exceptions.DeploymentIdRequiredException

  • CodeDeploy.Client.exceptions.DeploymentDoesNotExistException

  • CodeDeploy.Client.exceptions.DeploymentGroupDoesNotExistException

  • CodeDeploy.Client.exceptions.DeploymentAlreadyCompletedException

  • CodeDeploy.Client.exceptions.InvalidDeploymentIdException

  • CodeDeploy.Client.exceptions.UnsupportedActionForDeploymentTypeException