Skip to content

stop_deployment 

stop_deployment(
    deployment_id: DeploymentId,
    *,
    config_overrides: Optional[CodeDeployClientConfig] = None,
    auto_rollback_enabled: Optional[NullableBoolean] = None,
) -> StopDeploymentOutput

Attempts to stop an ongoing deployment.

Parameters:

  • deployment_id (DeploymentId) –

    The unique ID of a deployment.

  • auto_rollback_enabled (Optional[NullableBoolean], default: None ) –

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

Raises:

Source code in docs_src/capo_codedeploy/_services/code_deploy.py 
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
def stop_deployment(
    self,
    deployment_id: "capo_codedeploy.types.deployment_id.DeploymentId",
    *,
    config_overrides: Optional[CodeDeployClientConfig] = None,
    auto_rollback_enabled: Optional[
        "capo_codedeploy.types.nullable_boolean.NullableBoolean"
    ] = None,
) -> "capo_codedeploy.types.stop_deployment_output.StopDeploymentOutput":
    """<p>Attempts to stop an ongoing deployment.</p>

    Args:
        deployment_id: <p> The unique ID of a deployment. </p>
        auto_rollback_enabled: <p> Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision. </p>

    Raises:
        capo_codedeploy.errors.deployment_already_completed_exception.DeploymentAlreadyCompletedException: <p>The deployment is already complete.</p>
        capo_codedeploy.errors.deployment_does_not_exist_exception.DeploymentDoesNotExistException: <p>The deployment with the user or Amazon Web Services account does not exist.</p>
        capo_codedeploy.errors.deployment_group_does_not_exist_exception.DeploymentGroupDoesNotExistException: <p>The named deployment group with the user or Amazon Web Services account does not exist.</p>
        capo_codedeploy.errors.deployment_id_required_exception.DeploymentIdRequiredException: <p>At least one deployment ID must be specified.</p>
        capo_codedeploy.errors.invalid_deployment_id_exception.InvalidDeploymentIdException: <p>At least one of the deployment IDs was specified in an invalid format.</p>
        capo_codedeploy.errors.unsupported_action_for_deployment_type_exception.UnsupportedActionForDeploymentTypeException: <p>A call was submitted that is not supported for the specified deployment type.</p>
        capo_codedeploy.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codedeploy.types.stop_deployment_input.StopDeploymentInput]",
    ) -> OperationResponse[
        "capo_codedeploy.types.stop_deployment_output.StopDeploymentOutput"
    ]:
        import capo_codedeploy._operations.code_deploy_20141006.stop_deployment

        output, http_response = (
            capo_codedeploy._operations.code_deploy_20141006.stop_deployment.stop_deployment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopDeployment")
    )
    input_: capo_codedeploy.types.stop_deployment_input.StopDeploymentInput = {
        "deployment_id": deployment_id
    }
    if auto_rollback_enabled is not None:
        input_["auto_rollback_enabled"] = auto_rollback_enabled

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output