翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
StartSearchJob
このオペレーションは、SearchScope でフィルタリングされた復旧ポイントと ItemFilters でフィルタリングされた項目を返す検索ジョブを作成します。
オプションで、ClientToken、EncryptionKeyArn、名前、タグを含めることができます。
リクエストの構文
PUT /search-jobs HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"EncryptionKeyArn": "string",
"ItemFilters": {
"EBSItemFilters": [
{
"CreationTimes": [
{
"Operator": "string",
"Value": number
}
],
"FilePaths": [
{
"Operator": "string",
"Value": "string"
}
],
"LastModificationTimes": [
{
"Operator": "string",
"Value": number
}
],
"Sizes": [
{
"Operator": "string",
"Value": number
}
]
}
],
"S3ItemFilters": [
{
"CreationTimes": [
{
"Operator": "string",
"Value": number
}
],
"ETags": [
{
"Operator": "string",
"Value": "string"
}
],
"ObjectKeys": [
{
"Operator": "string",
"Value": "string"
}
],
"Sizes": [
{
"Operator": "string",
"Value": number
}
],
"VersionIds": [
{
"Operator": "string",
"Value": "string"
}
]
}
]
},
"Name": "string",
"SearchScope": {
"BackupResourceArns": [ "string" ],
"BackupResourceCreationTime": {
"CreatedAfter": number,
"CreatedBefore": number
},
"BackupResourceTags": {
"string" : "string"
},
"BackupResourceTypes": [ "string" ],
"SourceResourceArns": [ "string" ]
},
"Tags": {
"string" : "string"
}
}URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- ClientToken
-
このパラメータを含めて、冪等性の複数の同一の呼び出しを許可します。
クライアントトークンは、それを使用する最初のリクエストが完了した後、8 時間有効です。この時間が経過すると、同じトークンを持つすべてのリクエストは新しいリクエストとして扱われます。
タイプ: 文字列
必須: いいえ
- EncryptionKeyArn
-
指定された検索ジョブの暗号化キー。
タイプ: 文字列
必須: いいえ
- ItemFilters
-
Item Filters は、検索の作成時に指定されたすべての入力項目プロパティを表します。
EBSItemFilters または S3ItemFilters のいずれかを含む
型: ItemFilters オブジェクト
必須: いいえ
- Name
-
この検索ジョブの名前を作成するには、英数字を含めます。
タイプ: 文字列
長さの制約: 最小長は 0 です。500 の最大長。
必須: いいえ
- SearchScope
-
このオブジェクトには、BackupResourceTypes、BackupResourceArns、BackupResourceCreationTime、BackupResourceTags、および SourceResourceArns を含めて、検索ジョブによって返される復旧ポイントをフィルタリングできます。
型: SearchScope オブジェクト
必須: はい
- Tags
-
オペレーションによって返されるタグのリスト。
型: 文字列から文字列へのマップ
必須: いいえ
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"SearchJobArn": "string",
"SearchJobIdentifier": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- CreationTime
-
ジョブが作成された日時。Unix 形式および協定世界時 (UTC)。
CompletionTimeの値は、ミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ
- SearchJobArn
-
指定された検索ジョブの Amazon リソースネーム (ARN) を識別する一意の文字列。
タイプ: 文字列
- SearchJobIdentifier
-
検索ジョブを指定する一意の文字列。
タイプ: 文字列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
このアクションを実行する十分なアクセス権限がありません。
- message
-
ユーザーには、このアクションを実行するための十分なアクセス権がありません。
HTTP ステータスコード: 403
- ConflictException
-
この例外は、以前に成功したオペレーションとの競合が検出された場合に発生します。これは通常、前のオペレーションが現在のリクエストを処理するホストに伝達する時間がない場合に発生します。
再試行 (適切なバックオフロジックを使用) は、この例外に対する推奨レスポンスです。
- message
-
リソースを更新または削除すると、整合性のない状態になる可能性があります。
- resourceId
-
影響を受けるリソースの識別子。
- resourceType
-
影響を受けるリソースのタイプ。
HTTP ステータスコード: 409
- InternalServerException
-
内部サーバーエラーが発生しました。リクエストを再実行します。
- message
-
リクエストの処理中に予期しないエラーが発生しました。
- retryAfterSeconds
-
秒数後に呼び出しを再試行します。
HTTP ステータスコード: 500
- ResourceNotFoundException
-
このリクエストのリソースが見つかりませんでした。
ARN やタイプなどのリソース情報が正しく存在していることを確認し、リクエストを再試行してください。
- message
-
リクエストは、存在しないリソースを参照します。
- resourceId
-
影響を受けるリソースの仮定識別子。
- resourceType
-
影響を受けるリソースの仮説タイプ。
HTTP ステータスコード: 404
- ServiceQuotaExceededException
-
許可されたクォータ制限を超えたため、リクエストが拒否されました。
- message
-
サービスクォータが制限を超えたため、このリクエストは失敗しました。
- quotaCode
-
これはクォータタイプに固有のコードです。
- resourceId
-
リソースの識別子。
- resourceType
-
リソースのタイプ。
- serviceCode
-
これは、クォータを持つ元のサービスに固有のコードです。
HTTP ステータスコード: 402
- ThrottlingException
-
リクエストのスロットリングにより、リクエストが拒否されました。
- message
-
リクエストスロットリングのため、リクエストは失敗しました。
- quotaCode
-
これは、クォータを持つ元のサービスに固有のコードです。
- retryAfterSeconds
-
秒数後に呼び出しを再試行します。
- serviceCode
-
これは、元のサービスに固有のコードです。
HTTP ステータスコード: 429
- ValidationException
-
入力がサービスで指定された制約を満たしていません。
- message
-
入力が Amazon サービスで指定された制約を満たしていません。
HTTP ステータスコード: 400
以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
