Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14128667.3 KB

This operation retrieves metadata of a search job, including its progress.

get/search-jobs/{SearchJobIdentifier}

Path parameters

SearchJobIdentifierstring required

Required unique string that specifies the search job.

Response

Success

Namestring

Returned name of the specified search job.

StatusMessagestring
<p>A status message will be returned for either a earch job with a status of <code>ERRORED</code> or a status of <code>COMPLETED</code> jobs with issues.</p> <p>For example, a message may say that a search contained recovery points unable to be scanned because of a permissions issue.</p>
EncryptionKeyArnstring
<p>The encryption key for the specified search job.</p> <p>Example: <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
CompletionTimestring date-time

The date and time that a search job completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Status'RUNNING' | 'COMPLETED' | 'STOPPING' | 'STOPPED' | 'FAILED' required
<p>The current status of the specified search job.</p> <p>A search job may have one of the following statuses: <code>RUNNING</code>; <code>COMPLETED</code>; <code>STOPPED</code>; <code>FAILED</code>; <code>TIMED_OUT</code>; or <code>EXPIRED</code> .</p>
CreationTimestring date-time required

The date and time that a search job was created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

SearchJobIdentifierstring required

The unique string that identifies the specified search job.

SearchJobArnstring required

The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.

All 12 operations