Skip to content

EC2  >  Operations  >  cancel_spot_instance_requests

cancel_spot_instance_requests

Operation

cancel_spot_instance_requests async

cancel_spot_instance_requests(request: CancelSpotInstanceRequestsInput | CancelSpotInstanceRequestsInputDict, /, *, plugins: list[Plugin] | None = None) -> CancelSpotInstanceRequestsOutput
cancel_spot_instance_requests(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelSpotInstanceRequestsInputDict]) -> CancelSpotInstanceRequestsOutput

Cancels one or more Spot Instance requests.

Warning

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

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CancelSpotInstanceRequestsOutput

An instance of CancelSpotInstanceRequestsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

CancelSpotInstanceRequestsInput dataclass

Bases: _SerdeShape

Contains the parameters for CancelSpotInstanceRequests.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | 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 class-attribute instance-attribute
spot_instance_request_ids: list[str] | None = ...

The IDs of the Spot Instance requests.

Dictionaries

CancelSpotInstanceRequestsInputDict

Bases: TypedDict

Dictionary form of CancelSpotInstanceRequestsInput.

Attributes
dry_run instance-attribute
dry_run: bool | 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 instance-attribute
spot_instance_request_ids: Required[Sequence[str]]

The IDs of the Spot Instance requests.

Output

CancelSpotInstanceRequestsOutput dataclass

Bases: _SerdeShape

Contains the output of CancelSpotInstanceRequests.

Attributes

cancelled_spot_instance_requests class-attribute instance-attribute
cancelled_spot_instance_requests: list[CancelledSpotInstanceRequest] | None = ...

The Spot Instance requests.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.