v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14128667.3 KB

This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.

You can optionally include ClientToken, EncryptionKeyArn, Name, and/or Tags.

put/search-jobs

Request body

Tagsobject

List of tags returned by the operation.

Namestring

Include alphanumeric characters to create a name for this search job.

EncryptionKeyArnstring

The encryption key for the specified search job.

ClientTokenstring
<p>Include this parameter to allow multiple identical calls for idempotency.</p> <p>A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.</p>

Response

Success

SearchJobArnstring

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

CreationTimestring date-time

The date and time that a 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

The unique string that specifies the search job.