감사 명령 - AWS IoT Device Defender
감사 설정 관리감사 예약온디맨드 감사 실행감사 인스턴스 관리감사 결과 점검

감사 명령

감사 설정 관리

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 Fields

명칭

유형

설명

roleArn

문자열

최대 길이: 2048 최소 길이: 20

감사를 수행할 때 AWS IoT에 디바이스, 정책, 인증서 및 기타 항목에 대한 정보에 액세스할 수 있는 권한을 부여하는 역할의 ARN입니다.

auditNotificationTargetConfigurations

map

감사 알림을 전송할 대상에 대한 정보입니다.

targetArn

문자열

감사 알림을 전송할 대상(SNS 주제)의 ARN입니다.

roleArn

문자열

최대 길이: 2048 최소 길이: 20

대상으로 알림을 전송할 권한을 부여하는 역할의 ARN입니다.

활성화

boolean

대상에 대한 알림이 활성화된 경우 True입니다.

auditCheckConfigurations

map

이 계정에 대해 활성화 및 비활성화된 감사 검사를 지정합니다. 현재 활성화된 점검을 비롯한 모든 점검 목록을 보려면 DescribeAccountAuditConfiguration을 사용합니다.

특정 점검이 활성화된 경우 일부 데이터 수집이 즉시 시작될 수 있습니다. 점검이 비활성화되면 점검과 관련하여 지금까지 수집된 모든 데이터가 삭제됩니다.

예정된 감사에서 사용되는 경우에는 점검을 비활성화할 수 없습니다. 먼저 예정된 감사에서 점검을 삭제하거나 예정된 감사 자체를 삭제해야 합니다.

UpdateAccountAuditConfiguration에 대한 첫 번째 호출에서 이 파라미터는 필수이며, 하나 이상의 활성화된 점검을 지정해야 합니다.

활성화

boolean

이 계정에 대해 이 감사 검사가 활성화된 경우 True입니다.

구성

map

(선택 사항) CERT_AGE_THRESHOLD_IN_DAYS 및 CERT_EXPIRATION_THRESHOLD_IN_DAYS 등의 특정 감사 검사에 대한 사용자 지정 구성을 사용하면 인증서 수명 및 임박한 만료에 대한 알림을 받을 시기를 정의할 수 있습니다.

출력

없음

오류

InvalidRequestException

요청 내용이 잘못되었습니다.

ThrottlingException

속도가 제한을 초과했습니다.

InternalFailureException

예상치 못한 오류가 발생했습니다.

DescribeAccountAuditConfiguration

이 계정에 대한 Device Defender Audit 설정에 대한 정보를 가져옵니다. 설정에는 감사 알림을 전송하는 방법과 활성화 또는 비활성화된 감사 검사가 포함되어 있습니다.

시놉시스

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

문자열

최대 길이: 2048 최소 길이: 20

감사를 수행할 때 AWS IoT에 디바이스, 정책, 인증서 및 기타 항목에 대한 정보에 액세스할 수 있는 권한을 부여하는 역할의 ARN입니다.

UpdateAccountAuditConfiguration에 대한 첫 번째 호출에서 이 파라미터는 필수입니다.

auditNotificationTargetConfigurations

map

이 계정의 감사 알림을 전송할 대상에 대한 정보입니다.

targetArn

문자열

감사 알림을 전송할 대상(SNS 주제)의 ARN입니다.

roleArn

문자열

최대 길이: 2048 최소 길이: 20

대상으로 알림을 전송할 권한을 부여하는 역할의 ARN입니다.

활성화

boolean

대상에 대한 알림이 활성화된 경우 True입니다.

auditCheckConfigurations

map

이 계정에 대해 활성화 및 비활성화된 감사 검사입니다.

활성화

boolean

이 계정에 대해 이 감사 검사가 활성화된 경우 True입니다.

구성

map

(선택 사항) 여기서는 인증서의 최대 허용 기간 또는 알림이 트리거되어야 하는 만료 전 일수와 같은 특정 감사 검사에 적합한 특정 구성을 제공합니다.

오류

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 Fields

명칭

유형

설명

deleteScheduledAudits

boolean

true인 경우 예정된 감사가 모두 삭제됩니다.

출력

없음

오류

InvalidRequestException

요청 내용이 잘못되었습니다.

ResourceNotFoundException

지정한 리소스가 존재하지 않습니다.

ThrottlingException

속도가 제한을 초과했습니다.

InternalFailureException

예상치 못한 오류가 발생했습니다.

감사 예약

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 Fields

명칭

유형

설명

frequency

문자열

예정된 감사가 발생하는 빈도입니다. DAILY, WEEKLY, BIWEEKLY 또는 MONTHLY 중 하나일 수 있습니다. 각 감사의 실제 시작 시간은 시스템에서 결정됩니다.

열거형: DAILY | WEEKLY | BIWEEKLY | MONTHLY

dayOfMonth

문자열

패턴: ^([1-9]|[12][0-9]|3[01])$|^LAST$

예정된 감사가 발생하는 월의 날입니다. 1~31 또는 LAST일 수 있습니다. frequency 파라미터가 MONTHLY로 설정된 경우 이 필드는 필수입니다. 29~31일이 지정되고 그만큼 많은 날이 없는 월의 경우에는 월의 LAST 날에 감사가 발생합니다.

dayOfWeek

문자열

예정된 감사가 발생하는 주의 날입니다. SUN, MON, TUE, WED, THU, FRI 또는 SAT 중 하나일 수 있습니다. frequency 파라미터가 WEEKLY 또는 BIWEEKLY로 설정된 경우 이 필드는 필수입니다.

열거형: SUN | MON | TUE | WED | THU | FRI | SAT

targetCheckNames

list

멤버: AuditCheckName

예정된 감사 중 어떤 점검이 수행되는지를 나타냅니다. 계정에 대해 점검이 활성화되어야 합니다. (활성화된 점검을 비롯한 모든 점검 목록을 보려면 DescribeAccountAuditConfiguration을 사용하고, 활성화된 점검을 선택하려면 UpdateAccountAuditConfiguration을 사용합니다.)

tags

list

멤버: Tag

java 클래스: java.util.List

예정된 감사 관리에 사용할 수 있는 메타데이터입니다.

키

문자열

태그 키.

값

문자열

태그 값.

scheduledAuditName

문자열

최대 길이: 128 최소 길이: 1

패턴: [a-zA-Z0-9_-]+

예정된 감사에 제공할 이름입니다. (최대 128자)

출력

{
  "scheduledAuditArn": "string"
}
CLI 출력 필드

명칭

유형

설명

scheduledAuditArn

문자열

예정된 감사의 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 Fields

명칭

유형

설명

nextToken

문자열

다음 결과 집합에 대한 토큰입니다.

maxResults

정수

최대 범위: 250 최소 범위: 1

한 번에 반환할 수 있는 최대 결과 수입니다. 기본값은 25입니다.

출력

{
  "scheduledAudits": [
    {
      "scheduledAuditName": "string",
      "scheduledAuditArn": "string",
      "frequency": "string",
      "dayOfMonth": "string",
      "dayOfWeek": "string"
    }
  ],
  "nextToken": "string"
}
CLI 출력 필드

명칭

유형

설명

scheduledAudits

list

멤버: ScheduledAuditMetadata

java 클래스: java.util.List

예정된 감사의 목록입니다.

scheduledAuditName

문자열

최대 길이: 128 최소 길이: 1

패턴: [a-zA-Z0-9_-]+

예약된 감사의 이름입니다.

scheduledAuditArn

문자열

예정된 감사의 ARN입니다.

frequency

문자열

예정된 감사가 발생하는 빈도입니다.

열거형: DAILY | WEEKLY | BIWEEKLY | MONTHLY

dayOfMonth

문자열

패턴: ^([1-9]|[12][0-9]|3[01])$|^LAST$

예정된 감사가 실행되는 월의 날입니다(frequency가 MONTHLY인 경우). 29~31일이 지정되고 그만큼 많은 날이 없는 월의 경우에는 월의 LAST 날에 감사가 발생합니다.

dayOfWeek

문자열

예정된 감사가 실행되는 주의 날입니다(frequency가 WEEKLY 또는 BIWEEKLY인 경우).

열거형: SUN | MON | TUE | WED | THU | FRI | SAT

nextToken

문자열

다음 결과 집합을 가져오는 데 사용할 수 있는 토큰 또는 결과가 더 이상 없는 경우 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 Fields

명칭

유형

설명

scheduledAuditName

문자열

최대 길이: 128 최소 길이: 1

패턴: [a-zA-Z0-9_-]+

가져올 정보가 포함된 예정된 감사의 이름입니다.

출력

{
  "frequency": "string",
  "dayOfMonth": "string",
  "dayOfWeek": "string",
  "targetCheckNames": [
    "string"
  ],
  "scheduledAuditName": "string",
  "scheduledAuditArn": "string"
}
CLI 출력 필드

명칭

유형

설명

frequency

문자열

예정된 감사가 발생하는 빈도입니다. DAILY, WEEKLY, BIWEEKLY 또는 MONTHLY 중 하나입니다. 각 감사의 실제 시작 시간은 시스템에서 결정됩니다.

열거형: DAILY | WEEKLY | BIWEEKLY | MONTHLY

dayOfMonth

문자열

패턴: ^([1-9]|[12][0-9]|3[01])$|^LAST$

예정된 감사가 발생하는 월의 날입니다. 1~31 또는 LAST일 수 있습니다. 29~31일이 지정되고 그만큼 많은 날이 없는 월의 경우에는 월의 LAST 날에 감사가 발생합니다.

dayOfWeek

문자열

예정된 감사가 발생하는 주의 날입니다. SUN, MON, TUE, WED, THU, FRI 또는 SAT 중 하나입니다.

열거형: SUN | MON | TUE | WED | THU | FRI | SAT

targetCheckNames

list

멤버: AuditCheckName

예정된 감사 중 어떤 점검이 수행되는지를 나타냅니다. 계정에 대해 점검이 활성화되어야 합니다. (활성화된 점검을 비롯한 모든 점검 목록을 보려면 DescribeAccountAuditConfiguration을 사용하고, 활성화된 점검을 선택하려면 UpdateAccountAuditConfiguration을 사용합니다.)

scheduledAuditName

문자열

최대 길이: 128 최소 길이: 1

패턴: [a-zA-Z0-9_-]+

예약된 감사의 이름입니다.

scheduledAuditArn

문자열

예정된 감사의 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 Fields

명칭

유형

설명

frequency

문자열

예정된 감사가 발생하는 빈도입니다. DAILY, WEEKLY, BIWEEKLY 또는 MONTHLY 중 하나일 수 있습니다. 각 감사의 실제 시작 시간은 시스템에서 결정됩니다.

열거형: DAILY | WEEKLY | BIWEEKLY | MONTHLY

dayOfMonth

문자열

패턴: ^([1-9]|[12][0-9]|3[01])$|^LAST$

예정된 감사가 발생하는 월의 날입니다. 1~31 또는 LAST일 수 있습니다. frequency 파라미터가 MONTHLY로 설정된 경우 이 필드는 필수입니다. 29~31일이 지정되고 그만큼 많은 날이 없는 월의 경우에는 월의 LAST 날에 감사가 발생합니다.

dayOfWeek

문자열

예정된 감사가 발생하는 주의 날입니다. SUN, MON, TUE, WED, THU, FRI 또는 SAT 중 하나일 수 있습니다. frequency 파라미터가 WEEKLY 또는 BIWEEKLY로 설정된 경우 이 필드는 필수입니다.

열거형: SUN | MON | TUE | WED | THU | FRI | SAT

targetCheckNames

list

멤버: AuditCheckName

예정된 감사 중 어떤 점검이 수행되는지를 나타냅니다. 계정에 대해 점검이 활성화되어야 합니다. (활성화된 점검을 비롯한 모든 점검 목록을 보려면 DescribeAccountAuditConfiguration을 사용하고, 활성화된 점검을 선택하려면 UpdateAccountAuditConfiguration을 사용합니다.)

scheduledAuditName

문자열

최대 길이: 128 최소 길이: 1

패턴: [a-zA-Z0-9_-]+

예약된 감사의 이름입니다. (최대 128자)

출력

{
  "scheduledAuditArn": "string"
}
CLI 출력 필드

명칭

유형

설명

scheduledAuditArn

문자열

예정된 감사의 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 Fields

명칭

유형

설명

scheduledAuditName

문자열

최대 길이: 128 최소 길이: 1

패턴: [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 Fields

명칭

유형

설명

targetCheckNames

list

멤버: AuditCheckName

감사 중 어떤 점검이 수행되는지를 나타냅니다. 지정하는 점검은 계정에 대해 활성화되어야 합니다. 그렇지 않으면 예외가 발생합니다. 활성화된 점검을 비롯한 모든 점검 목록을 보려면 DescribeAccountAuditConfiguration을 사용하고, 활성화된 점검을 선택하려면 UpdateAccountAuditConfiguration을 사용합니다.

출력

{
  "taskId": "string"
}
CLI 출력 필드

명칭

유형

설명

taskId

문자열

최대 길이: 40 최소 길이: 1

패턴: [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 Fields

명칭

유형

설명

taskId

문자열

최대 길이: 40 최소 길이: 1

패턴: [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

문자열

감사의 상태로 IN_PROGRESS, COMPLETED, FAILED 또는 CANCELED 중 하나입니다.

열거형: IN_PROGRESS | COMPLETED | FAILED | CANCELED

taskType

문자열

감사 유형으로 ON_DEMAND_AUDIT_TASK 또는 SCHEDULED_AUDIT_TASK입니다.

열거형: ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK

taskStartTime

타임스탬프

감사가 시작된 시간입니다.

taskStatistics

TaskStatistics

감사에 대한 통계 정보입니다.

totalChecks

정수

이 감사의 점검 수입니다.

inProgressChecks

정수

진행 중인 점검 수입니다.

waitingForDataCollectionChecks

정수

데이터 수집 대기 중인 점검 수입니다.

compliantChecks

정수

규정 준수 리소스를 발견한 점검 수입니다.

nonCompliantChecks

정수

규정 미준수 리소스를 발견한 점검 수입니다.

failedChecks

정수

점검 수입니다.

canceledChecks

정수

감사가 취소되어 실행되지 않은 점검 수입니다.

scheduledAuditName

문자열

최대 길이: 128 최소 길이: 1

패턴: [a-zA-Z0-9_-]+

예정된 감사의 이름입니다(감사가 예정된 감사인 경우에만 해당).

auditDetails

map

이 감사 중 수행된 각 점검에 대한 세부 정보입니다.

checkRunStatus

문자열

이 점검의 완료 상태로 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

문자열

이 감사 중 이 점검을 수행할 때 발생한 오류 코드입니다. INSUFFICIENT_PERMISSIONS 또는 AUDIT_CHECK_DISABLED 중 하나입니다.

message

문자열

최대 길이: 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 Fields

명칭

유형

설명

startTime

타임스탬프

기간의 시작입니다. 감사 정보는 제한된 시간(180일) 동안 보관됩니다. 보관되기 전에 시작 시간을 요청하면 InvalidRequestException이 발생합니다.

endTime

타임스탬프

기간의 끝입니다.

taskType

문자열

출력을 지정된 감사 유형으로 제한하기 위한 필터로 ON_DEMAND_AUDIT_TASK 또는 SCHEDULED__AUDIT_TASK 중 하나일 수 있습니다.

열거형: ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK

taskStatus

문자열

감사에 대한 출력을 지정된 완료 상태로 제한하기 위한 필터로 IN_PROGRESS, COMPLETED, FAILED 또는 CANCELED 중 하나일 수 있습니다.

열거형: IN_PROGRESS | COMPLETED | FAILED | CANCELED

nextToken

문자열

다음 결과 집합에 대한 토큰입니다.

maxResults

정수

최대 범위: 250 최소 범위: 1

한 번에 반환할 수 있는 최대 결과 수입니다. 기본값은 25입니다.

출력

{
  "tasks": [
    {
      "taskId": "string",
      "taskStatus": "string",
      "taskType": "string"
    }
  ],
  "nextToken": "string"
}
CLI 출력 필드

명칭

유형

설명

작업

list

멤버: AuditTaskMetadata

java 클래스: java.util.List

지정된 기간 동안 수행된 감사입니다.

taskId

문자열

최대 길이: 40 최소 길이: 1

패턴: [a-zA-Z0-9-]+

이 감사의 ID입니다.

taskStatus

문자열

이 감사의 상태로 IN_PROGRESS, COMPLETED, FAILED 또는 CANCELED 중 하나입니다.

열거형: IN_PROGRESS | COMPLETED | FAILED | CANCELED

taskType

문자열

이 감사 유형으로 ON_DEMAND_AUDIT_TASK 또는 SCHEDULED_AUDIT_TASK 중 하나입니다.

열거형: ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK

nextToken

문자열

다음 결과 집합을 가져오기 위해 사용할 수 있는 토큰이지만 결과가 더 이상 없는 경우에는 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 Fields

명칭

유형

설명

taskId

문자열

최대 길이: 40 최소 길이: 1

패턴: [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 Fields

명칭

유형

설명

taskId

문자열

최대 길이: 40 최소 길이: 1

패턴: [a-zA-Z0-9-]+

감사에 대한 결과를 지정된 ID로 제한하는 필터입니다. taskId나 startTime 및 endTime을 지정해야 하지만, 둘 다 지정하면 안 됩니다.

checkName

문자열

결과를 지정된 감사 검사에 대한 결과로 제한하는 필터입니다.

resourceIdentifier

ResourceIdentifier

규정 미준수 리소스를 식별하는 정보입니다.

deviceCertificateId

문자열

최대 길이: 64 최소 길이: 64

패턴: (0x)?[a-fA-F0-9]+

리소스에 연결된 인증서의 ID입니다.

caCertificateId

문자열

최대 길이: 64 최소 길이: 64

패턴: (0x)?[a-fA-F0-9]+

인증서를 승인하는 데 사용되는 CA 인증서의 ID입니다.

cognitoIdentityPoolId

문자열

Amazon Cognito 자격 증명 풀의 ID입니다.

clientId

문자열

클라이언트 ID입니다.

policyVersionIdentifier

PolicyVersionIdentifier

리소스와 연관된 정책의 버전입니다.

policyName

문자열

최대 길이: 128 최소 길이: 1

패턴: [w+=,.@-]+

정책의 이름입니다.

policyVersionId

문자열

패턴: [0-9]+

리소스와 연관된 정책의 버전 ID입니다.

roleAliasArn

문자열

과도하게 허용적인 작업이 있는 역할 별칭의 ARN입니다.

최대 길이: 2048 최소 길이: 1

account

문자열

최대 길이: 12 최소 길이: 12

패턴: [0-9]+

리소스와 연관된 계정입니다.

maxResults

정수

최대 범위: 250 최소 범위: 1

한 번에 반환할 수 있는 최대 결과 수입니다. 기본값은 25입니다.

nextToken

문자열

다음 결과 집합에 대한 토큰입니다.

startTime

타임스탬프

결과를 지정된 시간 이후에 발견된 결과로 제한하는 필터입니다. startTime 및 endTime이나 taskId를 지정해야 하지만, 둘 다 지정하면 안 됩니다.

endTime

타임스탬프

결과를 지정된 시간 이전에 발견된 결과로 제한하는 필터입니다. 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 출력 필드

명칭

유형

설명

결과

list

멤버: AuditFinding

감사의 결과입니다.

taskId

문자열

최대 길이: 40 최소 길이: 1

패턴: [a-zA-Z0-9-]+

이 결과가 생성된 감사의 ID입니다.

checkName

문자열

이 결과가 생성된 감사 검사입니다.

taskStartTime

타임스탬프

감사가 시작된 시간입니다.

findingTime

타임스탬프

결과가 발견된 시간입니다.

severity

문자열

결과의 심각도입니다.

열거형: CRITICAL | HIGH | MEDIUM | LOW

nonCompliantResource

NonCompliantResource

감사 검사를 통해 규정 미준수로 확인된 리소스입니다.

resourceType

문자열

규정 미준수 리소스의 유형입니다.

열거형: DEVICE_CERTIFICATE | CA_CERTIFICATE | IOT_POLICY | COGNITO_IDENTITY_POOL | CLIENT_ID | ACCOUNT_SETTINGS

resourceIdentifier

ResourceIdentifier

규정 미준수 리소스를 식별하는 정보입니다.

deviceCertificateId

문자열

최대 길이: 64 최소 길이: 64

패턴: (0x)?[a-fA-F0-9]+

리소스에 연결된 인증서의 ID입니다.

caCertificateId

문자열

최대 길이: 64 최소 길이: 64

패턴: (0x)?[a-fA-F0-9]+

인증서를 승인하는 데 사용되는 CA 인증서의 ID입니다.

cognitoIdentityPoolId

문자열

Amazon Cognito 자격 증명 풀의 ID입니다.

clientId

문자열

클라이언트 ID입니다.

policyVersionIdentifier

PolicyVersionIdentifier

리소스와 연관된 정책의 버전입니다.

policyName

문자열

최대 길이: 128 최소 길이: 1

패턴: [w+=,.@-]+

정책의 이름입니다.

policyVersionId

문자열

패턴: [0-9]+

리소스와 연관된 정책의 버전 ID입니다.

account

문자열

최대 길이: 12 최소 길이: 12

패턴: [0-9]+

리소스와 연관된 계정입니다.

additionalInfo

map

규정 미준수 리소스에 대한 기타 정보입니다.

relatedResources

list

멤버: RelatedResource

관련 리소스의 목록입니다.

resourceType

문자열

리소스의 유형입니다.

열거형: DEVICE_CERTIFICATE | CA_CERTIFICATE | IOT_POLICY | COGNITO_IDENTITY_POOL | CLIENT_ID | ACCOUNT_SETTINGS

resourceIdentifier

ResourceIdentifier

리소스를 식별하는 정보입니다.

deviceCertificateId

문자열

최대 길이: 64 최소 길이: 64

패턴: (0x)?[a-fA-F0-9]+

리소스에 연결된 인증서의 ID입니다.

caCertificateId

문자열

최대 길이: 64 최소 길이: 64

패턴: (0x)?[a-fA-F0-9]+

인증서를 승인하는 데 사용되는 CA 인증서의 ID입니다.

cognitoIdentityPoolId

문자열

Amazon Cognito 자격 증명 풀의 ID입니다.

clientId

문자열

클라이언트 ID입니다.

policyVersionIdentifier

PolicyVersionIdentifier

리소스와 연관된 정책의 버전입니다.

iamRoleArn

문자열

최대 길이: 2048 최소 길이: 20

과도하게 허용적인 작업이 있는 IAM 역할의 ARN입니다.

policyName

문자열

최대 길이: 128 최소 길이: 1

패턴: [w+=,.@-]+

정책의 이름입니다.

policyVersionId

문자열

패턴: [0-9]+

리소스와 연관된 정책의 버전 ID입니다.

roleAliasArn

문자열

최대 길이: 2048 최소 길이: 1

과도하게 허용적인 작업이 있는 역할 별칭의 ARN입니다.

account

문자열

최대 길이: 12 최소 길이: 12

패턴: [0-9]+

리소스와 연관된 계정입니다.

additionalInfo

map

리소스에 대한 기타 정보입니다.

reasonForNonCompliance

문자열

리소스가 규정 미준수인 사유입니다.

reasonForNonComplianceCode

문자열

리소스가 규정 미준수인 사유를 나타내는 코드입니다.

nextToken

문자열

다음 결과 집합을 가져오기 위해 사용할 수 있는 토큰이지만 결과가 더 이상 없는 경우에는 null입니다.

오류

InvalidRequestException

요청 내용이 잘못되었습니다.

ThrottlingException

속도가 제한을 초과했습니다.

InternalFailureException

예상치 못한 오류가 발생했습니다.