監査コマンド

監査設定の管理

アカウントの監査設定を行うには、UpdateAccountAuditConfiguration を使用します。このコマンドを使用すると、監査で使用するこれらのチェック項目を有効にする、オプションの通知を設定する、アクセス許可を設定することができます。

DescribeAccountAuditConfiguration でこれらの設定を確認します。

監査設定を削除するには、DeleteAccountAuditConfiguration を使用します。これにより、すべてのデフォルト値が復元されます。すべてのチェック項目はデフォルトで無効になっているため、監査が事実上無効になります。

UpdateAccountAuditConfiguration

このアカウントの Device Defender 監査設定を設定または再設定します。設定には、監査通知が送信される方法と有効または無効な監査チェック項目が含まれています。

概要

aws iot  update-account-audit-configuration \
    [--role-arn <value>] \
    [--audit-notification-target-configurations <value>] \
    [--audit-check-configurations <value>]  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]

cli-input-json 形式

{
  "roleArn": "string",
  "auditNotificationTargetConfigurations": {
    "string": {
      "targetArn": "string",
      "roleArn": "string",
      "enabled": "boolean"
    }
  },
  "auditCheckConfigurations": {
    "string": {
      "enabled": "boolean"
    }
  }
}

cli-input-json フィールド

名前	型	説明
roleArn	string 長さ - 最大:2048 最小:20	監査を実行するときに、デバイス、ポリシー、証明書、他の項目に関する情報にアクセスするアクセス許可を AWS IoT に付与するロールの ARN。
auditNotificationTargetConfigurations	map	監査通知が送信されるターゲットに関する情報。
targetArn	string	監査通知が送信されるターゲット (SNS トピック) の ARN。
roleArn	string 長さ - 最大:2048 最小:20	ターゲットに通知を送信するアクセス許可を付与するロールの ARN。
有効	boolean	ターゲットへの通知が有効な場合は true。
auditCheckConfigurations	map	このアカウントで有効および無効になっている監査チェック項目が指定されます。現在有効になっているチェック項目を含むすべてのチェック項目のリストを表示するには、DescribeAccountAuditConfiguration を使用します。 特定のチェック項目を有効にすると、一部のデータ収集がすぐに開始されます。チェックが無効になると、そのチェック項目に関連してこれまでに収集されたデータがすべて削除されます。 スケジュールによる監査により使用されている場合、チェック項目を無効にすることはできません。まず、スケジュールによる監査からチェック項目を削除するか、スケジュールによる監査自体を削除する必要があります。 UpdateAccountAuditConfiguration の最初の呼び出しでは、このパラメータは必須であり、少なくとも 1 つの有効なチェック項目を指定する必要があります。
有効	boolean	このアカウントでこの監査チェック項目が有効になっている場合は true。

出力

なし

エラー

InvalidRequestException

リクエストの内容が無効です。

ThrottlingException

レートが制限を超えています。

InternalFailureException

予期しないエラーが発生しました。

DescribeAccountAuditConfiguration

このアカウントの Device Defender 監査設定の情報を取得します。設定には、監査通知が送信される方法と有効または無効な監査チェック項目が含まれています。

概要

aws iot  describe-account-audit-configuration  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]

cli-input-json 形式

{
}

出力

{
  "roleArn": "string",
  "auditNotificationTargetConfigurations": {
    "string": {
      "targetArn": "string",
      "roleArn": "string",
      "enabled": "boolean"
    }
  },
  "auditCheckConfigurations": {
    "string": {
      "enabled": "boolean"
    }
  }
}

CLI 出力フィールド

名前	型	説明
roleArn	string 長さ - 最大:2048 最小:20	監査を実行するときに、デバイス、ポリシー、証明書、他の項目に関する情報にアクセスするアクセス許可を AWS IoT に付与するロールの ARN。 UpdateAccountAuditConfiguration の最初の呼び出しでは、このパラメータは必須です。
auditNotificationTargetConfigurations	map	監査通知が送信されるこのアカウントのターゲットに関する情報。
targetArn	string	監査通知が送信されるターゲット (SNS トピック) の ARN。
roleArn	string 長さ - 最大:2048 最小:20	ターゲットに通知を送信するアクセス許可を付与するロールの ARN。
有効	boolean	ターゲットへの通知が有効な場合は true。
auditCheckConfigurations	map	このアカウントで有効および無効になっている監査チェック項目。
有効	boolean	このアカウントでこの監査チェック項目が有効になっている場合は true。

エラー

ThrottlingException

レートが制限を超えています。

InternalFailureException

予期しないエラーが発生しました。

DeleteAccountAuditConfiguration

このアカウントの Device Defender の監査のデフォルト設定を復元します。入力した設定データがすべて削除され、すべての監査チェック項目が無効にリセットされます。

概要

aws iot  delete-account-audit-configuration \
    [--delete-scheduled-audits | --no-delete-scheduled-audits]  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]

cli-input-json 形式

{
  "deleteScheduledAudits": "boolean"
}

cli-input-json フィールド

名前	型	説明
deleteScheduledAudits	boolean	true の場合、スケジュールによる監査がすべて削除されます。

出力

なし

エラー

InvalidRequestException

リクエストの内容が無効です。

ResourceNotFoundException

指定されたリソースは存在しません

ThrottlingException

レートが制限を超えています。

InternalFailureException

予期しないエラーが発生しました。

監査のスケジュール

1 つ以上のスケジュールによる監査を作成するには、CreateScheduledAudit を使用します。このコマンドを使用すると、監査中に実行するチェック項目と監査の実行頻度を指定できます。

ListScheduledAudits と DescribeScheduledAudit を使用してスケジュールによる監査を追跡します。

UpdateScheduledAudit を使用して既存のスケジュールによる監査を変更するか、DeleteScheduledAudit を使用して削除します。

CreateScheduledAudit

指定された間隔で実行される、スケジュールによる監査を作成します。

概要

aws iot  create-scheduled-audit \
    --frequency <value> \
    [--day-of-month <value>] \
    [--day-of-week <value>] \
    --target-check-names <value> \
    [--tags <value>] \
    --scheduled-audit-name <value>  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]

cli-input-json 形式

{
  "frequency": "string",
  "dayOfMonth": "string",
  "dayOfWeek": "string",
  "targetCheckNames": [
    "string"
  ],
  "tags": [
    {
      "Key": "string",
      "Value": "string"
    }
  ],
  "scheduledAuditName": "string"
}

cli-input-json フィールド

名前	型	説明
frequency	string	スケジュールによる監査が行われる頻度。「DAILY」、「WEEKLY」、「BIWEEKLY」、「MONTHLY」のいずれかを選択できます。各監査の実際の開始時刻は、システムによって決定されます。 列挙値: DAILY | WEEKLY | BIWEEKLY | MONTHLY
dayOfMonth	string pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$	スケジュールによる監査が行われる毎月の日付。「1」から「31」、または「LAST」を選択できます。このフィールドは、frequency パラメータが「MONTHLY」に設定されている場合に必要です。29 ～ 31 日が指定されていて、その月にその日付がない場合、監査はその月の末日 (LAST) に行われます。
dayOfWeek	string	スケジュールによる監査が行われる曜日。「SUN」、「MON」、「TUE」、「WED」、「THU」、「FRI」、「SAT」のいずれかに設定できます。このフィールドは、frequency パラメータが「WEEKLY」または「BIWEEKLY」に設定されている場合に必要です。 列挙値: SUN | MON | TUE | WED | THU | FRI | SAT
targetCheckNames	リスト メンバー: AuditCheckName	スケジュールによる監査中に実行されるチェック項目。アカウントでチェック項目が有効になっている必要があります。(有効なチェック項目を含むすべてのチェック項目のリストを参照するには DescribeAccountAuditConfiguration、有効になっているチェック項目を選択するには UpdateAccountAuditConfiguration を使用します)。
タグ	リスト メンバー: Tag java class: java.util.List	スケジュールによる監査を管理するために使用できるメタデータ。
キー	string	タグのキー。
値	string	タグの値。
scheduledAuditName	string 長さ - 最大:128 最小:1 pattern: [a-zA-Z0-9_-]+	スケジュールによる監査に割り当てる名前。(最大 128 文字)

出力

{
  "scheduledAuditArn": "string"
}

CLI 出力フィールド

名前	型	説明
scheduledAuditArn	string	スケジュールによる監査の ARN。

エラー

InvalidRequestException

リクエストの内容が無効です。

ThrottlingException

レートが制限を超えています。

InternalFailureException

予期しないエラーが発生しました。

LimitExceededException

制限を超過しました。

ListScheduledAudits

スケジュールによる監査をすべて一覧表示します。

概要

aws iot  list-scheduled-audits \
    [--next-token <value>] \
    [--max-results <value>]  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]

cli-input-json 形式

{
  "nextToken": "string",
  "maxResults": "integer"
}

cli-input-json フィールド

名前	型	説明
nextToken	string	次の結果セットのトークン。
maxResults	integer 範囲 - 最大: 250 最小: 1	一度に返す結果の最大数。デフォルトは 25 です。

出力

{
  "scheduledAudits": [
    {
      "scheduledAuditName": "string",
      "scheduledAuditArn": "string",
      "frequency": "string",
      "dayOfMonth": "string",
      "dayOfWeek": "string"
    }
  ],
  "nextToken": "string"
}

CLI 出力フィールド

名前	型	説明
scheduledAudits	リスト メンバー: ScheduledAuditMetadata java class: java.util.List	スケジュールによる監査のリスト。
scheduledAuditName	string 長さ - 最大:128 最小:1 pattern: [a-zA-Z0-9_-]+	スケジュールによる監査の名前。
scheduledAuditArn	string	スケジュールによる監査の ARN。
frequency	string	スケジュールによる監査が行われる頻度。 列挙値: DAILY | WEEKLY | BIWEEKLY | MONTHLY
dayOfMonth	string pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$	スケジュールによる監査が実行される月の日付 (frequency が「MONTHLY」の場合)。29 ～ 31 日が指定されていて、その月にその日付がない場合、監査はその月の末日 (LAST) に行われます。
dayOfWeek	string	スケジュールによる監査が実行される曜日 (frequency が「WEEKLY」または「BIWEEKLY」の場合)。 列挙値: SUN | MON | TUE | WED | THU | FRI | SAT
nextToken	string	次の結果セットの取得に使用できるトークン、または他に結果がない場合は null です。

エラー

InvalidRequestException

リクエストの内容が無効です。

ThrottlingException

レートが制限を超えています。

InternalFailureException

予期しないエラーが発生しました。

DescribeScheduledAudit

スケジュールによる監査に関する情報を取得します。

概要

aws iot  describe-scheduled-audit \
    --scheduled-audit-name <value>  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]

cli-input-json 形式

{
  "scheduledAuditName": "string"
}

cli-input-json フィールド

名前	型	説明
scheduledAuditName	string 長さ - 最大:128 最小:1 pattern: [a-zA-Z0-9_-]+	情報を取得するスケジュールによる監査の名前。

出力

{
  "frequency": "string",
  "dayOfMonth": "string",
  "dayOfWeek": "string",
  "targetCheckNames": [
    "string"
  ],
  "scheduledAuditName": "string",
  "scheduledAuditArn": "string"
}

CLI 出力フィールド

名前	型	説明
frequency	string	スケジュールによる監査が行われる頻度。「DAILY」、「WEEKLY」、「BIWEEKLY」、「MONTHLY」のいずれか。各監査の実際の開始時刻は、システムによって決定されます。 列挙値: DAILY | WEEKLY | BIWEEKLY | MONTHLY
dayOfMonth	string pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$	スケジュールによる監査が行われる毎月の日付。「1」から「31」、または「LAST」を選択できます。29 ～ 31 日が指定されていて、その月にその日付がない場合、監査はその月の末日 (LAST) に行われます。
dayOfWeek	string	スケジュールによる監査が行われる曜日。「SUN」、「MON」、「TUE」、「WED」、「THU」、「FRI」、「SAT」のいずれか。 列挙値: SUN | MON | TUE | WED | THU | FRI | SAT
targetCheckNames	リスト メンバー: AuditCheckName	スケジュールによる監査中に実行されるチェック項目。アカウントでチェック項目が有効になっている必要があります。(有効なチェック項目を含むすべてのチェック項目のリストを参照するには DescribeAccountAuditConfiguration、有効になっているチェック項目を選択するには UpdateAccountAuditConfiguration を使用します)。
scheduledAuditName	string 長さ - 最大:128 最小:1 pattern: [a-zA-Z0-9_-]+	スケジュールによる監査の名前。
scheduledAuditArn	string	スケジュールによる監査の ARN。

エラー

InvalidRequestException

リクエストの内容が無効です。

ResourceNotFoundException

指定されたリソースは存在しません

ThrottlingException

レートが制限を超えています。

InternalFailureException

予期しないエラーが発生しました。

UpdateScheduledAudit

実行されるチェック項目や監査が実行される頻度など、スケジュールによる監査が更新されます。

概要

aws iot  update-scheduled-audit \
    [--frequency <value>] \
    [--day-of-month <value>] \
    [--day-of-week <value>] \
    [--target-check-names <value>] \
    --scheduled-audit-name <value>  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]

cli-input-json 形式

{
  "frequency": "string",
  "dayOfMonth": "string",
  "dayOfWeek": "string",
  "targetCheckNames": [
    "string"
  ],
  "scheduledAuditName": "string"
}

cli-input-json フィールド

名前	型	説明
frequency	string	スケジュールによる監査が行われる頻度。「DAILY」、「WEEKLY」、「BIWEEKLY」、「MONTHLY」のいずれかを選択できます。各監査の実際の開始時刻は、システムによって決定されます。 列挙値: DAILY | WEEKLY | BIWEEKLY | MONTHLY
dayOfMonth	string pattern: ^([1-9]|[12][0-9]|3[01])$|^LAST$	スケジュールによる監査が行われる毎月の日付。「1」から「31」、または「LAST」を選択できます。このフィールドは、frequency パラメータが「MONTHLY」に設定されている場合に必要です。29 ～ 31 日が指定されていて、その月にその日付がない場合、監査はその月の末日 (LAST) に行われます。
dayOfWeek	string	スケジュールによる監査が行われる曜日。「SUN」、「MON」、「TUE」、「WED」、「THU」、「FRI」、「SAT」のいずれかを選択できます。このフィールドは、frequency パラメータが「WEEKLY」または「BIWEEKLY」に設定されている場合に必要です。 列挙値: SUN | MON | TUE | WED | THU | FRI | SAT
targetCheckNames	リスト メンバー: AuditCheckName	スケジュールによる監査中に実行されるチェック項目。アカウントでチェック項目が有効になっている必要があります。(有効なチェック項目を含むすべてのチェック項目のリストを参照するには DescribeAccountAuditConfiguration、有効になっているチェック項目を選択するには UpdateAccountAuditConfiguration を使用します)。
scheduledAuditName	string 長さ - 最大:128 最小:1 pattern: [a-zA-Z0-9_-]+	スケジュールによる監査の名前。(最大 128 文字)

出力

{
  "scheduledAuditArn": "string"
}

CLI 出力フィールド

名前	型	説明
scheduledAuditArn	string	スケジュールによる監査の ARN。

エラー

InvalidRequestException

リクエストの内容が無効です。

ResourceNotFoundException

指定されたリソースは存在しません

ThrottlingException

レートが制限を超えています。

InternalFailureException

予期しないエラーが発生しました。

DeleteScheduledAudit

スケジュールによる監査を削除します。

概要

aws iot  delete-scheduled-audit \
    --scheduled-audit-name <value>  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]

cli-input-json 形式

{
  "scheduledAuditName": "string"
}

cli-input-json フィールド

名前	型	説明
scheduledAuditName	string 長さ - 最大:128 最小:1 pattern: [a-zA-Z0-9_-]+	削除するスケジュールによる監査の名前。

出力

なし

エラー

InvalidRequestException

リクエストの内容が無効です。

ResourceNotFoundException

指定されたリソースは存在しません

ThrottlingException

レートが制限を超えています。

InternalFailureException

予期しないエラーが発生しました。

オンデマンド監査の実行

実行するチェック項目を指定し、監査の実行をすぐに開始するには、StartOnDemandAuditTask を使用します。

StartOnDemandAuditTask

オンデマンドの Device Defender 監査を開始します。

概要

aws iot  start-on-demand-audit-task \
    --target-check-names <value>  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]

cli-input-json 形式

{
  "targetCheckNames": [
    "string"
  ]
}

cli-input-json フィールド

名前	型	説明
targetCheckNames	リスト メンバー: AuditCheckName	監査中に実行されるチェック項目。指定するチェック項目は、アカウントで有効になっている必要があります。有効になっていないと、例外が発生します。(有効なチェック項目を含むすべてのチェック項目のリストを参照するには DescribeAccountAuditConfiguration、有効になっているチェック項目を選択するには UpdateAccountAuditConfiguration を使用します)。

出力

{
  "taskId": "string"
}

CLI 出力フィールド

名前	型	説明
taskId	string 長さ - 最大:40 最小:1 pattern: [a-zA-Z0-9-]+	開始したオンデマンド監査の ID。

エラー

InvalidRequestException

リクエストの内容が無効です。

ThrottlingException

レートが制限を超えています。

InternalFailureException

予期しないエラーが発生しました。

LimitExceededException

制限を超過しました。

監査インスタンスの管理

特定の監査インスタンスに関する情報を取得するには、DescribeAuditTask を使用します。すでに実行されている場合、結果には失敗したチェック項目と成功したチェック項目、システムが完了できなかったチェック項目、監査がまだ進行中の場合は処理中のチェック項目が含まれます。

特定の期間内に実行された監査を調べるには、ListAuditTasks を使用します。

進行中の監査を停止するには、CancelAuditTask を使用します。

DescribeAuditTask

Device Defender の監査に関する情報を取得します。

概要

aws iot  describe-audit-task \
    --task-id <value>  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]

cli-input-json 形式

{
  "taskId": "string"
}

cli-input-json フィールド

名前	型	説明
taskId	string 長さ - 最大:40 最小:1 pattern: [a-zA-Z0-9-]+	情報を取得する監査の ID。

出力

{
  "taskStatus": "string",
  "taskType": "string",
  "taskStartTime": "timestamp",
  "taskStatistics": {
    "totalChecks": "integer",
    "inProgressChecks": "integer",
    "waitingForDataCollectionChecks": "integer",
    "compliantChecks": "integer",
    "nonCompliantChecks": "integer",
    "failedChecks": "integer",
    "canceledChecks": "integer"
  },
  "scheduledAuditName": "string",
  "auditDetails": {
    "string": {
      "checkRunStatus": "string",
      "checkCompliant": "boolean",
      "totalResourcesCount": "long",
      "nonCompliantResourcesCount": "long",
      "errorCode": "string",
      "message": "string"
    }
  }
}

CLI 出力フィールド

名前	型	説明
taskStatus	string	監査のステータス: 「IN_PROGRESS」、「COMPLETED」、「FAILED」、「CANCELED」のいずれか。 列挙値: IN_PROGRESS | COMPLETED | FAILED | CANCELED
taskType	string	監査のタイプ: 「ON_DEMAND_AUDIT_TASK」または「SCHEDULED_AUDIT_TASK」。 列挙値: ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK
taskStartTime	timestamp	監査の開始時刻。
taskStatistics	TaskStatistics	監査に関する統計情報。
totalChecks	integer	この監査のチェック項目の数。
inProgressChecks	integer	進行中のチェック項目の数。
waitingForDataCollectionChecks	integer	データ収集を待機しているチェック項目の数。
compliantChecks	integer	適合しているリソースが見つかったチェック項目の数。
nonCompliantChecks	integer	不適合リソースが見つかったチェック項目の数。
failedChecks	integer	チェック項目の数。
canceledChecks	integer	監査がキャンセルされたために実行されなかったチェック項目の数。
scheduledAuditName	string 長さ - 最大:128 最小:1 pattern: [a-zA-Z0-9_-]+	スケジュールによる監査の名前 (監査がスケジュールによる監査の場合のみ)。
auditDetails	map	この監査中に実行された各チェック項目に関する詳細情報。
checkRunStatus	string	このチェック項目の完了ステータス: 「IN_PROGRESS」、「WAITING_FOR_DATA_COLLECTION」、「CANCELED」、「COMPLETED_COMPLIANT」、「COMPLETED_NON_COMPLIANT」、「FAILED」のいずれか。 列挙値: IN_PROGRESS | WAITING_FOR_DATA_COLLECTION | CANCELED | COMPLETED_COMPLIANT | COMPLETED_NON_COMPLIANT | FAILED
checkCompliant	boolean	チェックが完了し、すべてのリソースが適合していることが分かった場合は true。
totalResourcesCount	long	チェック項目が実行されたリソースの数。
nonCompliantResourcesCount	long	チェックで不適合が検出されたリソースの数。
errorCode	string	この監査中にこのチェック項目を実行する際に発生したエラーのコード。「INSUFFICIENT_PERMISSIONS」または「AUDIT_CHECK_DISABLED」。
メッセージ	string 長さ - 最大:2048	この監査中にこのチェック項目を実行する際に発生したエラーに関連付けられたメッセージ。

エラー

InvalidRequestException

リクエストの内容が無効です。

ResourceNotFoundException

指定されたリソースは存在しません

ThrottlingException

レートが制限を超えています。

InternalFailureException

予期しないエラーが発生しました。

ListAuditTasks

指定された期間中に実行された Device Defender の監査を一覧表示します。

概要

aws iot  list-audit-tasks \
    --start-time <value> \
    --end-time <value> \
    [--task-type <value>] \
    [--task-status <value>] \
    [--next-token <value>] \
    [--max-results <value>]  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]

cli-input-json 形式

{
  "startTime": "timestamp",
  "endTime": "timestamp",
  "taskType": "string",
  "taskStatus": "string",
  "nextToken": "string",
  "maxResults": "integer"
}

cli-input-json フィールド

名前	型	説明
startTime	timestamp	期間の開始。監査情報は限られた期間内 (180 日) のみ保持されます。保持される内容より前に開始時間をリクエストすると、InvalidRequestException が生成されます。
endTime	timestamp	期間の終了。
taskType	string	指定されたタイプの監査に出力を制限するフィルタ: 「ON_DEMAND_AUDIT_TASK」または「SCHEDULED__AUDIT_TASK」を選択ことができます。 列挙値: ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK
taskStatus	string	指定された完了ステータスを持つ監査に出力を制限するフィルタ: 「IN_PROGRESS」、「COMPLETED」、「FAILED」、「CANCELED」のいずれかを選択することができます。 列挙値: IN_PROGRESS | COMPLETED | FAILED | CANCELED
nextToken	string	次の結果セットのトークン。
maxResults	integer 範囲 - 最大: 250 最小: 1	一度に返す結果の最大数。デフォルトは 25 です。

出力

{
  "tasks": [
    {
      "taskId": "string",
      "taskStatus": "string",
      "taskType": "string"
    }
  ],
  "nextToken": "string"
}

CLI 出力フィールド

名前	型	説明
tasks	リスト メンバー: AuditTaskMetadata java class: java.util.List	指定された期間中に実行された監査。
taskId	string 長さ - 最大:40 最小:1 pattern: [a-zA-Z0-9-]+	この監査の ID。
taskStatus	string	この監査のステータス: 「IN_PROGRESS」、「COMPLETED」、「FAILED」、「CANCELED」のいずれか。 列挙値: IN_PROGRESS | COMPLETED | FAILED | CANCELED
taskType	string	この監査のタイプ: 「ON_DEMAND_AUDIT_TASK」または「SCHEDULED_AUDIT_TASK」。 列挙値: ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK
nextToken	string	次の結果セットの取得に使用できるトークン、または追加の結果がない場合は null です。

エラー

InvalidRequestException

リクエストの内容が無効です。

ThrottlingException

レートが制限を超えています。

InternalFailureException

予期しないエラーが発生しました。

CancelAuditTask

進行中の監査をキャンセルします。監査は、スケジュールすることもオンデマンドにすることもできます。監査が進行中でない場合は、InvalidRequestException が発生します。

概要

aws iot  cancel-audit-task \
    --task-id <value>  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]

cli-input-json 形式

{
  "taskId": "string"
}

cli-input-json フィールド

名前	型	説明
taskId	string 長さ - 最大:40 最小:1 pattern: [a-zA-Z0-9-]+	キャンセルする監査の ID です。「IN_PROGRESS」の監査のみキャンセルすることができます。

出力

なし

エラー

ResourceNotFoundException

指定されたリソースは存在しません

InvalidRequestException

リクエストの内容が無効です。

ThrottlingException

レートが制限を超えています。

InternalFailureException

予期しないエラーが発生しました。

監査結果のチェック

監査の結果を表示するには、ListAuditFindings を使用します。チェック項目の種類、特定のリソース、または監査の時間によって結果をフィルタリングすることができます。この情報を使用して、検知された問題を軽減することができます。

緩和アクションを定義し、監査の結果に適用できます。詳細については、「緩和アクション」を参照してください。

ListAuditFindings

Device Defender の監査または指定された期間に実行された監査の結果を一覧表示します。(結果は 180 日間保持されます)。

概要

aws iot  list-audit-findings \
    [--task-id <value>] \
    [--check-name <value>] \
    [--resource-identifier <value>] \
    [--max-results <value>] \
    [--next-token <value>] \
    [--start-time <value>] \
    [--end-time <value>]  \
    [--cli-input-json <value>] \
    [--generate-cli-skeleton]

cli-input-json 形式

{
  "taskId": "string",
  "checkName": "string",
  "resourceIdentifier": {
    "deviceCertificateId": "string",
    "caCertificateId": "string",
    "cognitoIdentityPoolId": "string",
    "clientId": "string",
    "policyVersionIdentifier": {
      "policyName": "string",
      "policyVersionId": "string"
    },
   
    "roleAliasArn": "string",
    "account": "string"
  },
  "maxResults": "integer",
  "nextToken": "string",
  "startTime": "timestamp",
  "endTime": "timestamp"
}

cli-input-json フィールド

名前	型	説明
taskId	string 長さ - 最大:40 最小:1 pattern: [a-zA-Z0-9-]+	指定された ID を持つ監査に結果を制限するフィルタ。taskId または startTime と endTime のどちらかを指定する必要がありますが、両方を指定することはできません。
checkName	string	指定された監査チェック項目の結果に結果を制限するフィルタ。
resourceIdentifier	ResourceIdentifier	不適合リソースを識別する情報。
deviceCertificateId	string 長さ - 最大:64 最小:64 pattern: (0x)?[a-fA-F0-9]+	リソースにアタッチされた証明書の ID。
caCertificateId	string 長さ - 最大:64 最小:64 pattern: (0x)?[a-fA-F0-9]+	証明書を承認するために使用する CA 証明書の ID。
cognitoIdentityPoolId	string	Amazon Cognito ID プールの ID。
clientId	string	クライアント ID。
policyVersionIdentifier	PolicyVersionIdentifier	リソースに関連付けられているポリシーのバージョン。
policyName	string 長さ - 最大:128 最小:1 pattern: [w+=,.@-]+	ポリシーの名前。
policyVersionId	string pattern: [0-9]+	リソースに関連付けられているポリシーのバージョンの ID。
roleAliasArn	string	過度に許容されたアクションを持つロールエイリアスの ARN。 長さ - 最大: 2048 最小: 1
account	string 長さ - 最大:12 最小:12 pattern: [0-9]+	リソースが関連付けられているアカウント。
maxResults	integer 範囲 - 最大: 250 最小: 1	一度に返す結果の最大数。デフォルトは 25 です。
nextToken	string	次の結果セットのトークン。
startTime	timestamp	指定された時刻後に見つかった結果に結果を制限するフィルタ。startTime と endTime または taskId のどちらかを指定する必要がありますが、両方を指定することはできません。
endTime	timestamp	指定された時刻前に見つかった結果に結果を制限するフィルタ。startTime と endTime または taskId のどちらかを指定する必要がありますが、両方を指定することはできません。

出力

{
  "findings": [
    {
      "taskId": "string",
      "checkName": "string",
      "taskStartTime": "timestamp",
      "findingTime": "timestamp",
      "severity": "string",
      "nonCompliantResource": {
        "resourceType": "string",
        "resourceIdentifier": {
          "deviceCertificateId": "string",
          "caCertificateId": "string",
          "cognitoIdentityPoolId": "string",
          "clientId": "string",
          "policyVersionIdentifier": {
            "policyName": "string",
            "policyVersionId": "string"
          },
          "account": "string"
        },
        "additionalInfo": {
          "string": "string"
        }
      },
      "relatedResources": [
        {
          "resourceType": "string",
          "resourceIdentifier": {
            "deviceCertificateId": "string",
            "caCertificateId": "string",
            "cognitoIdentityPoolId": "string",
            "clientId": "string",
    
            "iamRoleArn": "string",
    
            "policyVersionIdentifier": {
              "policyName": "string",
              "policyVersionId": "string"
            },
            "account": "string"
          },
    
          "roleAliasArn": "string",
    
          "additionalInfo": {
            "string": "string"
          }
        }
      ],
      "reasonForNonCompliance": "string",
      "reasonForNonComplianceCode": "string"
    }
  ],
  "nextToken": "string"
}

CLI 出力フィールド

名前	型	説明
findings	リスト メンバー: AuditFinding	監査の結果。
taskId	string 長さ - 最大:40 最小:1 pattern: [a-zA-Z0-9-]+	この結果 (所見) を生成した監査の ID。
checkName	string	この結果を生成した監査チェック項目。
taskStartTime	timestamp	監査の開始時刻。
findingTime	timestamp	結果が検出された時刻。
severity	string	結果の重要度。 列挙値: CRITICAL | HIGH | MEDIUM | LOW
nonCompliantResource	NonCompliantResource	監査チェックの結果、適合していないことが判明したリソース。
resourceType	string	不適合リソースのタイプ。 列挙値: DEVICE_CERTIFICATE | CA_CERTIFICATE | IOT_POLICY | COGNITO_IDENTITY_POOL | CLIENT_ID | ACCOUNT_SETTINGS
resourceIdentifier	ResourceIdentifier	不適合リソースを識別する情報。
deviceCertificateId	string 長さ - 最大:64 最小:64 pattern: (0x)?[a-fA-F0-9]+	リソースにアタッチされた証明書の ID。
caCertificateId	string 長さ - 最大:64 最小:64 pattern: (0x)?[a-fA-F0-9]+	証明書を承認するために使用する CA 証明書の ID。
cognitoIdentityPoolId	string	Amazon Cognito ID プールの ID。
clientId	string	クライアント ID。
policyVersionIdentifier	PolicyVersionIdentifier	リソースに関連付けられているポリシーのバージョン。
policyName	string 長さ - 最大:128 最小:1 pattern: [w+=,.@-]+	ポリシーの名前。
policyVersionId	string pattern: [0-9]+	リソースに関連付けられているポリシーのバージョンの ID。
account	string 長さ - 最大:12 最小:12 pattern: [0-9]+	リソースが関連付けられているアカウント。
additionalInfo	map	不適合リソースに関するその他の情報。
relatedResources	リスト メンバー: RelatedResource	関連リソースのリスト。
resourceType	string	リソースのタイプ。 列挙値: DEVICE_CERTIFICATE | CA_CERTIFICATE | IOT_POLICY | COGNITO_IDENTITY_POOL | CLIENT_ID | ACCOUNT_SETTINGS
resourceIdentifier	ResourceIdentifier	リソースを識別する情報。
deviceCertificateId	string 長さ - 最大:64 最小:64 pattern: (0x)?[a-fA-F0-9]+	リソースにアタッチされた証明書の ID。
caCertificateId	string 長さ - 最大:64 最小:64 pattern: (0x)?[a-fA-F0-9]+	証明書を承認するために使用する CA 証明書の ID。
cognitoIdentityPoolId	string	Amazon Cognito ID プールの ID。
clientId	string	クライアント ID。
policyVersionIdentifier	PolicyVersionIdentifier	リソースに関連付けられているポリシーのバージョン。
iamRoleArn	string 長さ - 最大:2048 最小:20	過度に許容されたアクションを持つ IAM ロールの ARN。
policyName	string 長さ - 最大:128 最小:1 pattern: [w+=,.@-]+	ポリシーの名前。
policyVersionId	string pattern: [0-9]+	リソースに関連付けられているポリシーのバージョンの ID。
roleAliasArn	string 長さ - 最大: 2048 最小: 1	過度に許容されたアクションを持つロールエイリアスの ARN。
account	string 長さ - 最大:12 最小:12 pattern: [0-9]+	リソースが関連付けられているアカウント。
additionalInfo	map	リソースに関するその他の情報。
reasonForNonCompliance	string	リソースが不適合だった理由。
reasonForNonComplianceCode	string	リソースが不適合だった理由を示すコード。
nextToken	string	次の結果セットの取得に使用できるトークン、または追加の結果がない場合は null です。

エラー

InvalidRequestException

リクエストの内容が無効です。

ThrottlingException

レートが制限を超えています。

InternalFailureException

予期しないエラーが発生しました。