ListScanJobSummaries - AWS Backup
リクエストの構文URI リクエストパラメータリクエスト本文レスポンスの構文レスポンス要素エラーその他の参照資料

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ListScanJobSummaries

これは、過去 30 日以内に作成または実行されたスキャンジョブの概要のリクエストです。

リクエストの構文

GET /audit/scan-job-summaries?AccountId=AccountId&AggregationPeriod=AggregationPeriod&MalwareScanner=MalwareScanner&MaxResults=MaxResults&NextToken=NextToken&ResourceType=ResourceType&ScanResultStatus=ScanResultStatus&State=State HTTP/1.1

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

AccountId

指定されたアカウントのジョブ数を返します。

リクエストがメンバーアカウントまたは AWS Organizations の一部ではないアカウントから送信されると、リクエスタのアカウント内のジョブが返されます。

ルート、管理者、委任された管理者アカウントは、 値を使用してANY、組織内のすべてのアカウントからジョブ数を返すことができます。

AGGREGATE_ALL は、認証された組織内のすべてのアカウントのジョブ数を集計し、その合計を返します。

パターン: ^[0-9]{12}$

AggregationPeriod

返された結果の期間。

  • ONE_DAY過去 1 日間の毎日のジョブ数。

  • SEVEN_DAYS過去 7 日間の毎日のジョブ数。

  • FOURTEEN_DAYS過去 14 日間の毎日のジョブ数。

有効な値：ONE_DAY | SEVEN_DAYS | FOURTEEN_DAYS

MalwareScanner

指定されたマルウェアスキャナーのスキャンジョブのみを返します。現在、MalwareScanner は のみですGUARDDUTY。ただし、 フィールドは ANY、、および もサポートしていますAGGREGATE_ALL。

有効な値：GUARDDUTY

MaxResults

返されるアイテムの最大数。

値は整数です。指定できる値の範囲は 1～500 です。

有効な範囲: 最小値 は 1 です。最大値は 1000 です。

NextToken

返された項目の一部リストに続く次の項目。たとえば、MaxResults アイテム数のリクエストが行われるようにされた場合、NextToken では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

ResourceType

指定されたリソースタイプのジョブ数を返します。リクエスト GetSupportedResourceTypes を使用して、サポートされているリソースタイプの文字列を取得します。

値は、すべてのリソースタイプのカウントANYを返します。

AGGREGATE_ALL は、すべてのリソースタイプのジョブ数を集計し、その合計を返します。

パターン: ^[a-zA-Z0-9\-\_\.]{1,50}$

ScanResultStatus

指定されたスキャン結果のスキャンジョブのみを返します。

有効な値：NO_THREATS_FOUND | THREATS_FOUND

State

指定されたスキャンジョブ状態のスキャンジョブのみを返します。

有効な値：CREATED | COMPLETED | COMPLETED_WITH_ISSUES | RUNNING | FAILED | CANCELED | AGGREGATE_ALL | ANY

リクエスト本文

リクエストにリクエスト本文がありません。

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "AggregationPeriod": "string",
   "NextToken": "string",
   "ScanJobSummaries": [ 
      { 
         "AccountId": "string",
         "Count": number,
         "EndTime": number,
         "MalwareScanner": "string",
         "Region": "string",
         "ResourceType": "string",
         "ScanResultStatus": "string",
         "StartTime": number,
         "State": "string"
      }
   ]
}

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

AggregationPeriod

返された結果の期間。

  • ONE_DAY過去 1 日間の毎日のジョブ数。

  • SEVEN_DAYS過去 7 日間の毎日のジョブ数。

  • FOURTEEN_DAYS過去 14 日間の毎日のジョブ数。

有効な値: 'ONE_DAY' | 'SEVEN_DAYS' | 'FOURTEEN_DAYS'

タイプ: 文字列

NextToken

返された項目の一部リストに続く次の項目。たとえば、MaxResults アイテム数のリクエストが行われるようにされた場合、NextToken では、次のトークンが指すロケーションから開始して、リスト内のより多くのアイテムを返すことができます。

タイプ: 文字列

ScanJobSummaries

概要情報。

型: ScanJobSummary オブジェクトの配列

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InvalidParameterValueException

パラメータの値に問題があることを示します。たとえば、値が範囲外であることです。

Context

Type

HTTP ステータスコード: 400

ServiceUnavailableException

サーバーの一時的障害のため、リクエストは失敗しました。

Context

Type

HTTP ステータスコード: 500

その他の参照資料

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。