cancel_job ( $job_id, $opt )

This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete.

Access

public

Parameters

Parameter

Type

Required

Description

$job_id

string

Required

A unique identifier which refers to a particular job.

$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 a job.

$ies = new AmazonImportExport();

$response = $ies->cancel_job('C5Y68');

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

Related Methods

Source

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

public function cancel_job($job_id, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['JobId'] = $job_id;
    
    return $this->authenticate('CancelJob', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback