cancel_spot_instance_requests ¶

cancel_spot_instance_requests(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    spot_instance_request_ids: Optional[SpotInstanceRequestIdList] = None,
) -> CancelSpotInstanceRequestsResult

Cancels one or more Spot Instance requests.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

Parameters:

dry_run (Optional[Boolean], default: None ) –

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
spot_instance_request_ids (Optional[SpotInstanceRequestIdList], default: None ) –

The IDs of the Spot Instance requests.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To cancel Spot Instance requests This example cancels a Spot Instance request.

>>> client.cancel_spot_instance_requests(spot_instance_request_ids=['sir-08b93456'])

Source code in docs_src/capo_ec2/_services/ec2.py

def cancel_spot_instance_requests(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    spot_instance_request_ids: Optional[
        "capo_ec2.types.spot_instance_request_id_list.SpotInstanceRequestIdList"
    ] = None,
) -> "capo_ec2.types.cancel_spot_instance_requests_result.CancelSpotInstanceRequestsResult":
    """<p>Cancels one or more Spot Instance requests.</p> <important> <p>Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.</p> </important>

    Args:
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        spot_instance_request_ids: <p>The IDs of the Spot Instance requests.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To cancel Spot Instance requests
        This example cancels a Spot Instance request.

        >>> client.cancel_spot_instance_requests(spot_instance_request_ids=['sir-08b93456'])
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.cancel_spot_instance_requests_request.CancelSpotInstanceRequestsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.cancel_spot_instance_requests_result.CancelSpotInstanceRequestsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.cancel_spot_instance_requests

        output, http_response = (
            capo_ec2._operations.amazon_ec2.cancel_spot_instance_requests.cancel_spot_instance_requests(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelSpotInstanceRequests")
    )
    input_: capo_ec2.types.cancel_spot_instance_requests_request.CancelSpotInstanceRequestsRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if spot_instance_request_ids is not None:
        input_["spot_instance_request_ids"] = spot_instance_request_ids

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