翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeScanJob
指定された ScanJobID のスキャンジョブの詳細を返します。
リクエストの構文
GET /scan/jobs/ScanJobId HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- ScanJobId
-
リソースをスキャン AWS Backup する へのリクエストを一意に識別します。
必須: はい
リクエストボディ
リクエストにリクエスト本文がありません。
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"AccountId": "string",
"BackupVaultArn": "string",
"BackupVaultName": "string",
"CompletionDate": number,
"CreatedBy": {
"BackupPlanArn": "string",
"BackupPlanId": "string",
"BackupPlanVersion": "string",
"BackupRuleId": "string"
},
"CreationDate": number,
"IamRoleArn": "string",
"MalwareScanner": "string",
"RecoveryPointArn": "string",
"ResourceArn": "string",
"ResourceName": "string",
"ResourceType": "string",
"ScanBaseRecoveryPointArn": "string",
"ScanId": "string",
"ScanJobId": "string",
"ScanMode": "string",
"ScannerRoleArn": "string",
"ScanResult": {
"ScanResultStatus": "string"
},
"State": "string",
"StatusMessage": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- AccountId
-
スキャンジョブを所有するアカウント ID を返します。
パターン:
^[0-9]{12}$タイプ: 文字列
- BackupVaultArn
-
バックアップボールトを一意に識別する Amazon リソースネーム (ARN)。例:
arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVaultタイプ: 文字列
- BackupVaultName
-
バックアップを保存する論理コンテナの名前。バックアップボールトは、作成に使用したアカウントと作成先の AWS リージョンに固有の名前で識別されます。
パターン:
^[a-zA-Z0-9\-\_\.]{2,50}$タイプ: 文字列
- CompletionDate
-
バックアップインデックスの作成が終了した日時 (Unix 時刻形式および協定世界時 (UTC))。
CompletionDateの値は、ミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ
- CreatedBy
-
スキャンを開始したバックアッププランやルールなど、スキャンジョブの作成に関する識別情報が含まれます。
型: ScanJobCreator オブジェクト
- CreationDate
-
バックアップインデックスの作成が終了した日時 (Unix 時刻形式および協定世界時 (UTC))。
CreationDateの値は、ミリ秒単位の精度です。たとえば、1516925490.087 の値は、2018 年 1 月 26 日 (金) 午前12:11:30.087 を表します。タイプ: タイムスタンプ
- IamRoleArn
-
arn:aws:iam::123456789012:role/S3Accessなどのバックアップボールトを一意に識別する Amazon リソースネーム (ARN)。タイプ: 文字列
- MalwareScanner
-
対応するスキャンジョブに使用されるスキャンエンジン。現在は、
GUARDUTYのみがサポートされます。型: 文字列
有効な値：
GUARDDUTY - RecoveryPointArn
-
スキャンするターゲット復旧ポイントを一意に識別する ARN。例:
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45。タイプ: 文字列
- ResourceArn
-
対応する復旧ポイント ARN のソースリソースを一意に識別する ARN。
タイプ: 文字列
- ResourceName
-
指定されたバックアップに属するリソースの一意ではない名前。
タイプ: 文字列
- ResourceType
-
バックアップする AWS リソースのタイプ。Amazon Elastic Block Store (Amazon EBS) ボリュームなど。
パターン:
^[a-zA-Z0-9\-\_\.]{1,50}$型: 文字列
有効な値：
EBS | EC2 | S3 - ScanBaseRecoveryPointArn
-
スキャンの基本復旧ポイントを一意に識別する ARN。このフィールドは、増分スキャンジョブが行われた場合にのみ入力されます。
タイプ: 文字列
- ScanId
-
対応するスキャンジョブ ID リクエストの送信元として Amazon GuardDuty によって生成されたスキャン ID AWS Backup。
タイプ: 文字列
- ScanJobId
-
リクエストを一意に識別したスキャンジョブ ID AWS Backup。
タイプ: 文字列
- ScanMode
-
スキャンジョブに使用されるスキャンタイプを指定します。
型: 文字列
有効な値：
FULL_SCAN | INCREMENTAL_SCAN - ScannerRoleArn
-
スキャンジョブに使用するスキャナー IAM ロール ARN を指定します。
タイプ: 文字列
- ScanResult
-
スキャンジョブ
ScanResultsStatusの が含まれ、完了したジョブNO_THREATS_FOUNDのTHREATS_FOUNDまたは を返します。型: ScanResultInfo オブジェクト
- State
-
スキャンジョブの現在の状態。
型: 文字列
有効な値：
CANCELED | COMPLETED | COMPLETED_WITH_ISSUES | CREATED | FAILED | RUNNING - StatusMessage
-
リソースをバックアップするジョブのステータスを説明する詳細なメッセージ。
タイプ: 文字列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InvalidParameterValueException
-
パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。
- Context
- Type
HTTP ステータスコード: 400
- MissingParameterValueException
-
必須パラメータがないことを示します。
- Context
- Type
HTTP ステータスコード: 400
- ResourceNotFoundException
-
アクションに必要なリソースは存在しません。
- Context
- Type
HTTP ステータスコード: 400
- ServiceUnavailableException
-
サーバーの一時的障害のため、リクエストは失敗しました。
- Context
- Type
HTTP ステータスコード: 500
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
