EC2 / Client / cancel_spot_instance_requests
cancel_spot_instance_requests#
- EC2.Client.cancel_spot_instance_requests(**kwargs)#
Cancels one or more Spot Instance requests.
Warning
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
See also: AWS API Documentation
Request Syntax
response = client.cancel_spot_instance_requests( DryRun=True|False, SpotInstanceRequestIds=[ 'string', ] )
- Parameters:
DryRun (boolean) – 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 isUnauthorizedOperation
.SpotInstanceRequestIds (list) –
[REQUIRED]
The IDs of the Spot Instance requests.
(string) –
- Return type:
dict
- Returns:
Response Syntax
{ 'CancelledSpotInstanceRequests': [ { 'SpotInstanceRequestId': 'string', 'State': 'active'|'open'|'closed'|'cancelled'|'completed' }, ] }
Response Structure
(dict) –
Contains the output of CancelSpotInstanceRequests.
CancelledSpotInstanceRequests (list) –
The Spot Instance requests.
(dict) –
Describes a request to cancel a Spot Instance.
SpotInstanceRequestId (string) –
The ID of the Spot Instance request.
State (string) –
The state of the Spot Instance request.
Examples
This example cancels a Spot Instance request.
response = client.cancel_spot_instance_requests( SpotInstanceRequestIds=[ 'sir-08b93456', ], ) print(response)
Expected Output:
{ 'CancelledSpotInstanceRequests': [ { 'SpotInstanceRequestId': 'sir-08b93456', 'State': 'cancelled', }, ], 'ResponseMetadata': { '...': '...', }, }