Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

CancelSpotInstanceRequests

Cancels one or more Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot price. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

Important

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

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DryRun

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.

Type: Boolean

Required: No

SpotInstanceRequestId.N

One or more Spot Instance request IDs.

Type: Array of strings

Required: Yes

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

spotInstanceRequestSet

One or more Spot Instance requests.

Type: Array of CancelledSpotInstanceRequest objects

Errors

For information about the errors that are common to all actions, see Common Client Errors.

Example

Example

This example cancels the specified Spot Instance request.

Sample Request

https://ec2.amazonaws.com/?Action=CancelSpotInstanceRequests &SpotInstanceRequestId.1=sir-1a2b3c4d &AUTHPARAMS

Sample Response

<CancelSpotInstanceRequestsResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <spotInstanceRequestSet> <item> <spotInstanceRequestId>sir-1a2b3c4d</spotInstanceRequestId> <state>cancelled</state> </item> </spotInstanceRequestSet> </CancelSpotInstanceRequestsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: