cancel_spot_instance_requests ( $spot_instance_request_id, $opt )

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. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current spot instance requests.

For conceptual information about Spot Instances, refer to the Amazon Elastic Compute Cloud Developer Guide or Amazon Elastic Compute Cloud User Guide.

Access

public

Parameters

Parameter

Type

Required

Description

$spot_instance_request_id

string
array

Required

Specifies the ID of the Spot Instance request. Pass a string for a single value, or an indexed array for multiple values.

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Cancel spot instance requests

$ec2 = new AmazonEC2();

$response = $ec2->cancel_spot_instance_requests('sir-769afa02');

var_dump($response->isOK());
Result:
bool(true)

Related Methods

Source

Method defined in services/ec2.class.php | Toggle source view (11 lines) | View on GitHub

public function cancel_spot_instance_requests($spot_instance_request_id, $opt = null)
{
    if (!$opt) $opt = array();
            
    // Required list (non-map)
    $opt = array_merge($opt, CFComplexType::map(array(
        'SpotInstanceRequestId' => (is_array($spot_instance_request_id) ? $spot_instance_request_id : array($spot_instance_request_id))
    )));

    return $this->authenticate('CancelSpotInstanceRequests', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback