翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
StartScanJob
特定のリソースのスキャンジョブを開始します。
リクエストの構文
PUT /scan/job HTTP/1.1
Content-type: application/json
{
"BackupVaultName": "string",
"IamRoleArn": "string",
"IdempotencyToken": "string",
"MalwareScanner": "string",
"RecoveryPointArn": "string",
"ScanBaseRecoveryPointArn": "string",
"ScanMode": "string",
"ScannerRoleArn": "string"
}URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- BackupVaultName
-
バックアップを保存する論理コンテナの名前。バックアップボールトは、作成に使用したアカウントと作成先の AWS リージョンに固有の名前で識別されます。
パターン:
^[a-zA-Z0-9\-\_]{2,50}$タイプ: 文字列
必須: はい
- IamRoleArn
-
ターゲット復旧ポイントの作成に使用する IAM ロール ARN を指定します。例えば、
arn:aws:iam::123456789012:role/S3Accessです。タイプ: 文字列
必須: はい
- IdempotencyToken
-
別の
StartScanJobへの同じコール間を区別するために使用できる顧客が選択した文字列。同じ冪等性トークンで成功したリクエストを再試行すると、アクションは実行されず、成功メッセージが表示されます。タイプ: 文字列
必須: いいえ
- MalwareScanner
-
スキャンジョブ中に使用されるマルウェアスキャナーを指定します。現在、 は のみをサポートしています
GUARDDUTY。型: 文字列
有効な値：
GUARDDUTY必須: はい
- RecoveryPointArn
-
復旧ポイントを一意に識別する Amazon リソースネーム (ARN)。これはフルスキャンのターゲット復旧ポイントです。増分スキャンを実行している場合、これは基本復旧ポイントの選択後に作成された復旧ポイントになります。
タイプ: 文字列
必須: はい
- ScanBaseRecoveryPointArn
-
増分スキャンに使用される基本復旧ポイントを一意に識別する ARN。
タイプ: 文字列
必須: いいえ
- ScanMode
-
スキャンジョブに使用するスキャンタイプを指定します。
含まれるもの:
-
FULL_SCANは、バックアップ内のデータ系統全体をスキャンします。 -
INCREMENTAL_SCANは、ターゲット復旧ポイントとベース復旧ポイント ARN 間のデータ差をスキャンします。
型: 文字列
有効な値：
FULL_SCAN | INCREMENTAL_SCAN必須: はい
-
- ScannerRoleArn
-
IAM スキャナーロール ARN を指定しました。
タイプ: 文字列
必須: はい
レスポンスの構文
HTTP/1.1 201
Content-type: application/json
{
"CreationDate": number,
"ScanJobId": "string"
}レスポンス要素
アクションが成功すると、HTTP 201 レスポンスが返されます。
サービスから以下のデータが JSON 形式で返されます。
- CreationDate
-
Unix 時刻形式および協定世界時 (UTC)で、バックアップジョブが作成された日時。
CreationDateの値はミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ
- ScanJobId
-
リソースをバックアップ AWS Backup するための へのリクエストを一意に識別します。
タイプ: 文字列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InvalidParameterValueException
-
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。
- Context
- Type
HTTP ステータスコード: 400
- InvalidRequestException
-
リクエストへの入力に何らかの問題が発生していることを示します。たとえば、パラメータのタイプが間違っています。
- Context
- Type
HTTP ステータスコード: 400
- LimitExceededException
-
たとえば、リクエストで許可されるアイテムの最大数などのリクエストの制限を超えました。
- Context
- Type
HTTP ステータスコード: 400
- MissingParameterValueException
-
必須パラメータがないことを示します。
- Context
- Type
HTTP ステータスコード: 400
- ResourceNotFoundException
-
アクションに必要なリソースは存在しません。
- Context
- Type
HTTP ステータスコード: 400
- ServiceUnavailableException
-
サーバーの一時的障害のため、リクエストは失敗しました。
- Context
- Type
HTTP ステータスコード: 500
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
