Perintah audit - AWS IoT Device Defender

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Perintah audit

Mengelola setelan audit

Gunakan UpdateAccountAuditConfiguration untuk mengonfigurasi pengaturan audit untuk akun Anda. Perintah ini memungkinkan Anda untuk mengaktifkan pemeriksaan yang Anda inginkan tersedia untuk audit, mengatur pemberitahuan opsional, dan mengonfigurasi izin.

Periksa pengaturan ini denganDescribeAccountAuditConfiguration.

Gunakan DeleteAccountAuditConfiguration untuk menghapus pengaturan audit Anda. Ini mengembalikan semua nilai default, dan secara efektif menonaktifkan audit karena semua pemeriksaan dinonaktifkan secara default.

UpdateAccountAuditConfiguration

Mengkonfigurasi atau mengkonfigurasi ulang pengaturan audit Device Defender untuk akun ini. Pengaturan mencakup cara notifikasi audit dikirimkan dan pemeriksaan audit mana yang diaktifkan atau dinonaktifkan.

Sinopsis

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-jsonformat

{ "roleArn": "string", "auditNotificationTargetConfigurations": { "string": { "targetArn": "string", "roleArn": "string", "enabled": "boolean" } }, "auditCheckConfigurations": { "string": { "enabled": "boolean" } } }
cli-input-jsonBidang

Nama

Tipe

Deskripsi

roleArn

string

panjang- maks: 2048 menit: 20

ARN peran yang memberikan izin AWS IoT untuk mengakses informasi tentang perangkat, kebijakan, sertifikat, dan item lainnya saat melakukan audit.

auditNotificationTargetKonfigurasi

map

Informasi tentang target untuk mengirimkan notifikasi audit.

targetArn

string

ARN target (topik SNS) tujuan pengiriman notifikasi audit.

roleArn

string

panjang- maks: 2048 menit: 20

ARN peran yang memberikan izin untuk mengirim notifikasi ke target.

diaktifkan

boolean

Betul jika notifikasi ke target diaktifkan.

auditCheckConfigurations

map

Menentukan pemeriksaan audit mana yang diaktifkan dan dinonaktifkan untuk akun ini. Gunakan DescribeAccountAuditConfiguration untuk melihat daftar semua pemeriksaan, termasuk yang saat ini diaktifkan.

Beberapa pengumpulan data mungkin langsung dimulai saat pemeriksaan tertentu diaktifkan. Ketika pemeriksaan dinonaktifkan, data yang sudah dikumpulkan dalam kaitannya dengan pemeriksaan dihapus.

Anda tidak dapat menonaktifkan pemeriksaan jika digunakan oleh audit terjadwal. Anda harus terlebih dahulu menghapus cek dari audit terjadwal atau menghapus audit terjadwal itu sendiri.

Pada panggilan pertama keUpdateAccountAuditConfiguration, parameter ini diperlukan dan harus menentukan setidaknya satu pemeriksaan yang diaktifkan.

diaktifkan

boolean

Betul jika pemeriksaan audit ini diaktifkan untuk akun ini.

Output

Tidak ada

Kesalahan

InvalidRequestException

Isi permintaan tidak valid.

ThrottlingException

Tarif melebihi batas.

InternalFailureException

Terjadi kesalahan tak terduga.

DescribeAccountAuditConfiguration

Mendapat informasi tentang pengaturan audit Device Defender untuk akun ini. Pengaturan mencakup cara notifikasi audit dikirimkan dan pemeriksaan audit mana yang diaktifkan atau dinonaktifkan.

Sinopsis

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

cli-input-jsonformat

{ }

Output

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

Nama

Tipe

Deskripsi

roleArn

string

panjang- maks: 2048 menit: 20

ARN peran yang memberikan izin AWS IoT untuk mengakses informasi tentang perangkat, kebijakan, sertifikat, dan item lainnya saat melakukan audit.

Pada panggilan pertama keUpdateAccountAuditConfiguration, parameter ini diperlukan.

auditNotificationTargetKonfigurasi

map

Informasi tentang target yang pemberitahuan audit dikirim untuk akun ini.

targetArn

string

ARN target (topik SNS) tujuan pengiriman notifikasi audit.

roleArn

string

panjang- maks: 2048 menit: 20

ARN peran yang memberikan izin untuk mengirim notifikasi ke target.

diaktifkan

boolean

Betul jika notifikasi ke target diaktifkan.

auditCheckConfigurations

map

Pemeriksaan audit mana yang diaktifkan dan dinonaktifkan untuk akun ini.

diaktifkan

boolean

Betul jika pemeriksaan audit ini diaktifkan untuk akun ini.

Kesalahan

ThrottlingException

Tarif melebihi batas.

InternalFailureException

Terjadi kesalahan tak terduga.

DeleteAccountAuditConfiguration

Mengembalikan pengaturan default untuk audit Device Defender untuk akun ini. Setiap data konfigurasi yang Anda masukkan dihapus dan semua pemeriksaan audit diatur ulang ke dinonaktifkan.

Sinopsis

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

cli-input-jsonformat

{ "deleteScheduledAudits": "boolean" }
cli-input-jsonBidang

Nama

Tipe

Deskripsi

deleteScheduledAudits

boolean

Jika benar, semua audit terjadwal akan dihapus.

Output

Tidak ada

Kesalahan

InvalidRequestException

Isi permintaan tidak valid.

ResourceNotFoundException

Sumber daya yang ditentukan tidak ada.

ThrottlingException

Tarif melebihi batas.

InternalFailureException

Terjadi kesalahan tak terduga.

Jadwalkan audit

Gunakan CreateScheduledAudit untuk membuat satu atau lebih audit terjadwal. Perintah ini memungkinkan Anda menentukan pemeriksaan yang ingin Anda lakukan selama audit dan seberapa sering audit harus dijalankan.

Melacak audit terjadwal Anda dengan ListScheduledAudits danDescribeScheduledAudit.

Ubah audit terjadwal yang ada dengan UpdateScheduledAudit atau hapus denganDeleteScheduledAudit.

CreateScheduledAudit

Membuat audit terjadwal yang dijalankan pada interval waktu tertentu.

Sinopsis

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-jsonformat

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

Nama

Tipe

Deskripsi

frekuensi

string

Seberapa sering audit terjadwal berlangsung. Bisa menjadi salah satu dari HARIAN, MINGGUAN, DUA MINGGU, atau BULANAN. Waktu mulai aktual dari setiap audit ditentukan oleh sistem.

enum: HARIAN | MINGGUAN | DUA MINGGUAN | BULANAN

dayOfMonth

string

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

Hari bulan di mana audit terjadwal berlangsung. Bisa 1 sampai 31 atau TERAKHIR. Bidang ini diperlukan jika frequency parameter diatur ke BULANAN. Jika hari 29-31 ditentukan, dan bulan tidak memiliki banyak hari, audit dilakukan pada hari TERAKHIR bulan itu.

dayOfWeek

string

Hari dalam seminggu di mana audit terjadwal berlangsung. Bisa salah satu SUN, MON, TUE, WED, THU, FRI, atau SAT. Bidang ini diperlukan jika frequency parameter diatur ke MINGGUAN atau BIWEEKLY.

enum: SUN | SEN | SEL | RAB | KAM | JUM | SAT

targetCheckNames

daftar

anggota: AuditCheckName

Pemeriksaan mana yang dilakukan selama audit terjadwal. Pemeriksaan harus diaktifkan untuk akun Anda. (Gunakan DescribeAccountAuditConfiguration untuk melihat daftar semua pemeriksaan, termasuk yang diaktifkan atau UpdateAccountAuditConfiguration untuk memilih pemeriksaan mana yang diaktifkan.)

tag

daftar

anggota: Tag

kelas java: java.util.list

Metadata yang dapat digunakan untuk mengelola audit terjadwal.

Kunci

string

Kunci tag.

Nilai

string

Nilai tag.

scheduledAuditName

string

panjang- maks: 128 menit: 1

pola: [A-ZA-Z0-9_-] +

Nama yang ingin Anda berikan untuk audit terjadwal. (Maksimal 128 karakter)

Output

{ "scheduledAuditArn": "string" }
Bidang keluaran CLI

Nama

Tipe

Deskripsi

scheduledAuditArn

string

ARN dari audit terjadwal.

Kesalahan

InvalidRequestException

Isi permintaan tidak valid.

ThrottlingException

Tarif melebihi batas.

InternalFailureException

Terjadi kesalahan tak terduga.

LimitExceededException

Batas telah terlampaui.

ListScheduledAudits

Daftar semua audit terjadwal Anda.

Sinopsis

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

cli-input-jsonformat

{ "nextToken": "string", "maxResults": "integer" }
cli-input-jsonBidang

Nama

Tipe

Deskripsi

nextToken

string

Token untuk set hasil berikutnya.

maxResults

integer

rentang- maks: 250 menit: 1

Jumlah maksimum hasil untuk kembali pada satu waktu. Default-nya adalah 25.

Output

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

Nama

Tipe

Deskripsi

scheduledAudits

daftar

anggota: ScheduledAuditMetadata

kelas java: java.util.list

Daftar audit terjadwal.

scheduledAuditName

string

panjang- maks: 128 menit: 1

pola: [A-ZA-Z0-9_-] +

Nama audit terjadwal.

scheduledAuditArn

string

ARN dari audit terjadwal.

frekuensi

string

Seberapa sering audit terjadwal berlangsung.

enum: HARIAN | MINGGUAN | DUA MINGGUAN | BULANAN

dayOfMonth

string

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

Hari bulan di mana audit terjadwal dijalankan (jika frequency BULANAN). Jika hari 29-31 ditentukan, dan bulan tidak memiliki banyak hari, audit dilakukan pada hari TERAKHIR bulan itu.

dayOfWeek

string

Hari dalam seminggu di mana audit terjadwal dijalankan (jika MINGGUAN atau BIWEEKLY). frequency

enum: SUN | SEN | SEL | RAB | KAM | JUM | SAT

nextToken

string

Token yang dapat digunakan untuk mengambil set hasil berikutnya, atau null jika tidak ada hasil lagi.

Kesalahan

InvalidRequestException

Isi permintaan tidak valid.

ThrottlingException

Tarif melebihi batas.

InternalFailureException

Terjadi kesalahan tak terduga.

DescribeScheduledAudit

Mendapat informasi tentang audit terjadwal.

Sinopsis

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

cli-input-jsonformat

{ "scheduledAuditName": "string" }
cli-input-jsonBidang

Nama

Tipe

Deskripsi

scheduledAuditName

string

panjang- maks: 128 menit: 1

pola: [A-ZA-Z0-9_-] +

Nama audit terjadwal yang informasinya ingin Anda dapatkan.

Output

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

Nama

Tipe

Deskripsi

frekuensi

string

Seberapa sering audit terjadwal berlangsung. Salah satu dari HARIAN, MINGGUAN, DUA MINGGU, atau BULANAN. Waktu mulai aktual dari setiap audit ditentukan oleh sistem.

enum: HARIAN | MINGGUAN | DUA MINGGUAN | BULANAN

dayOfMonth

string

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

Hari bulan di mana audit terjadwal berlangsung. Bisa 1 sampai 31 atau TERAKHIR. Jika hari 29-31 ditentukan, dan bulan tidak memiliki banyak hari, audit dilakukan pada hari TERAKHIR bulan itu.

dayOfWeek

string

Hari dalam seminggu di mana audit terjadwal berlangsung. Salah satu SUN, MON, TUE, WED, THU, FRI, atau SAT.

enum: SUN | SEN | SEL | RAB | KAM | JUM | SAT

targetCheckNames

daftar

anggota: AuditCheckName

Pemeriksaan mana yang dilakukan selama audit terjadwal. Pemeriksaan harus diaktifkan untuk akun Anda. (Gunakan DescribeAccountAuditConfiguration untuk melihat daftar semua pemeriksaan, termasuk yang diaktifkan atau menggunakan UpdateAccountAuditConfiguration untuk memilih pemeriksaan mana yang diaktifkan.)

scheduledAuditName

string

panjang- maks: 128 menit: 1

pola: [A-ZA-Z0-9_-] +

Nama audit terjadwal.

scheduledAuditArn

string

ARN dari audit terjadwal.

Kesalahan

InvalidRequestException

Isi permintaan tidak valid.

ResourceNotFoundException

Sumber daya yang ditentukan tidak ada.

ThrottlingException

Tarif melebihi batas.

InternalFailureException

Terjadi kesalahan tak terduga.

UpdateScheduledAudit

Memperbarui audit terjadwal, termasuk pemeriksaan mana yang dilakukan dan seberapa sering audit berlangsung.

Sinopsis

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-jsonformat

{ "frequency": "string", "dayOfMonth": "string", "dayOfWeek": "string", "targetCheckNames": [ "string" ], "scheduledAuditName": "string" }
cli-input-jsonBidang

Nama

Tipe

Deskripsi

frekuensi

string

Seberapa sering audit terjadwal berlangsung. Bisa menjadi salah satu dari HARIAN, MINGGUAN, DUA MINGGU, atau BULANAN. Waktu mulai aktual dari setiap audit ditentukan oleh sistem.

enum: HARIAN | MINGGUAN | DUA MINGGUAN | BULANAN

dayOfMonth

string

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

Hari bulan di mana audit terjadwal berlangsung. Bisa 1 sampai 31 atau TERAKHIR. Bidang ini diperlukan jika frequency parameter diatur ke BULANAN. Jika hari 29-31 ditentukan, dan bulan tidak memiliki banyak hari, audit dilakukan pada hari TERAKHIR bulan itu.

dayOfWeek

string

Hari dalam seminggu di mana audit terjadwal berlangsung. Bisa salah satu SUN, MON, TUE, WED, THU, FRI, atau SAT. Bidang ini diperlukan jika frequency parameter diatur ke MINGGUAN atau BIWEEKLY.

enum: SUN | SEN | SEL | RAB | KAM | JUM | SAT

targetCheckNames

daftar

anggota: AuditCheckName

Pemeriksaan mana yang dilakukan selama audit terjadwal. Pemeriksaan harus diaktifkan untuk akun Anda. (Gunakan DescribeAccountAuditConfiguration untuk melihat daftar semua pemeriksaan, termasuk yang diaktifkan atau menggunakan UpdateAccountAuditConfiguration untuk memilih pemeriksaan mana yang diaktifkan.)

scheduledAuditName

string

panjang- maks: 128 menit: 1

pola: [A-ZA-Z0-9_-] +

Nama audit terjadwal. (Maksimal 128 karakter)

Output

{ "scheduledAuditArn": "string" }
Bidang keluaran CLI

Nama

Tipe

Deskripsi

scheduledAuditArn

string

ARN dari audit terjadwal.

Kesalahan

InvalidRequestException

Isi permintaan tidak valid.

ResourceNotFoundException

Sumber daya yang ditentukan tidak ada.

ThrottlingException

Tarif melebihi batas.

InternalFailureException

Terjadi kesalahan tak terduga.

DeleteScheduledAudit

Menghapus audit terjadwal.

Sinopsis

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

cli-input-jsonformat

{ "scheduledAuditName": "string" }
cli-input-jsonBidang

Nama

Tipe

Deskripsi

scheduledAuditName

string

panjang- maks: 128 menit: 1

pola: [A-ZA-Z0-9_-] +

Nama audit terjadwal yang ingin Anda hapus.

Output

Tidak ada

Kesalahan

InvalidRequestException

Isi permintaan tidak valid.

ResourceNotFoundException

Sumber daya yang ditentukan tidak ada.

ThrottlingException

Tarif melebihi batas.

InternalFailureException

Terjadi kesalahan tak terduga.

Jalankan audit On-Demand

Gunakan StartOnDemandAuditTask untuk menentukan pemeriksaan yang ingin Anda lakukan dan segera memulai audit yang berjalan.

StartOnDemandAuditTask

Memulai audit Device Defender sesuai permintaan.

Sinopsis

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

cli-input-jsonformat

{ "targetCheckNames": [ "string" ] }
cli-input-jsonBidang

Nama

Tipe

Deskripsi

targetCheckNames

daftar

anggota: AuditCheckName

Pemeriksaan mana yang dilakukan selama audit. Pemeriksaan yang Anda tentukan harus diaktifkan untuk akun Anda atau pengecualian terjadi. Gunakan DescribeAccountAuditConfiguration untuk melihat daftar semua pemeriksaan, termasuk yang diaktifkan atau digunakan UpdateAccountAuditConfiguration untuk memilih pemeriksaan mana yang diaktifkan.

Output

{ "taskId": "string" }
Bidang keluaran CLI

Nama

Tipe

Deskripsi

taskId

string

panjang- maks: 40 menit: 1

pola: [A-za-Z0-9-] +

ID audit sesuai permintaan yang Anda mulai.

Kesalahan

InvalidRequestException

Isi permintaan tidak valid.

ThrottlingException

Tarif melebihi batas.

InternalFailureException

Terjadi kesalahan tak terduga.

LimitExceededException

Batas telah terlampaui.

Mengelola contoh audit

Gunakan DescribeAuditTask untuk mendapatkan informasi tentang contoh audit tertentu. Jika sudah berjalan, hasilnya termasuk pemeriksaan mana yang gagal dan mana yang lolos, yang tidak dapat diselesaikan oleh sistem, dan jika audit masih berlangsung, yang masih dikerjakan.

Gunakan ListAuditTasks untuk menemukan audit yang dijalankan selama interval waktu tertentu.

Gunakan CancelAuditTask untuk menghentikan audit yang sedang berlangsung.

DescribeAuditTask

Mendapat informasi tentang audit Device Defender.

Sinopsis

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

cli-input-jsonformat

{ "taskId": "string" }
cli-input-jsonBidang

Nama

Tipe

Deskripsi

taskId

string

panjang- maks: 40 menit: 1

pola: [A-za-Z0-9-] +

ID audit yang informasinya ingin Anda dapatkan.

Output

{ "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" } } }
Bidang keluaran CLI

Nama

Tipe

Deskripsi

taskStatus

string

Status audit: salah satu IN_PROGRESS, SELESAI, GAGAL, atau DIBATALKAN.

enum: IN_PROGRESS | SELESAI | GAGAL | DIBATALKAN

taskType

string

Jenis audit: ON_DEMAND_AUDIT_TASK atau SCHEDULED_AUDIT_TASK.

enum: ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK

taskStartTime

timestamp

Waktu audit dimulai.

taskStatistics

TaskStatistics

Informasi statistik tentang audit.

totalChecks

integer

Jumlah cek dalam audit ini.

inProgressChecks

integer

Jumlah cek yang sedang berlangsung.

waitingForDataCollectionChecks

integer

Jumlah cek yang menunggu pengumpulan data.

compliantChecks

integer

Jumlah cek yang menemukan sumber daya yang sesuai.

nonCompliantChecks

integer

Jumlah cek yang menemukan sumber daya yang tidak sesuai.

failedChecks

integer

Jumlah cek.

canceledChecks

integer

Jumlah cek yang tidak berjalan karena audit dibatalkan.

scheduledAuditName

string

panjang- maks: 128 menit: 1

pola: [A-ZA-Z0-9_-] +

Nama audit terjadwal (hanya jika audit adalah audit terjadwal).

auditDetails

map

Informasi terperinci tentang setiap pemeriksaan yang dilakukan selama audit ini.

checkRunStatus

string

Status penyelesaian pemeriksaan ini, salah satu IN_PROGRESS, WAITING_FOR_DATA_COLLECTION, CANCELED, COMPLETED_COMPLIANT, COMPLETED_NON_COMPLIANT, atau FAILED.

enum: IN_PROGRESS | WAITING_FOR_DATA_COLLECTION | DIBATALKAN | COMPLETED_COMPLIANT | COMPLETED_NON_COMPLIANT | GAGAL

checkCompliant

boolean

Benar jika pemeriksaan selesai dan menemukan semua sumber daya sesuai.

totalResourcesCount

long

Jumlah sumber daya tempat pemeriksaan dilakukan.

nonCompliantResourcesHitung

long

Jumlah sumber daya yang menurut cek tidak sesuai.

errorCode

string

Kode kesalahan apa pun yang ditemui saat melakukan pemeriksaan ini selama audit ini. Salah satu dari INSUFFICIENT_PERMISSIONS atau AUDIT_CHECK_DISABLED.

pesan

string

panjang- maks: 2048

Pesan yang terkait dengan kesalahan apa pun yang ditemui saat melakukan pemeriksaan ini selama audit ini.

Kesalahan

InvalidRequestException

Isi permintaan tidak valid.

ResourceNotFoundException

Sumber daya yang ditentukan tidak ada.

ThrottlingException

Tarif melebihi batas.

InternalFailureException

Terjadi kesalahan tak terduga.

ListAuditTasks

Daftar audit Device Defender yang telah dilakukan selama periode waktu tertentu.

Sinopsis

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-jsonformat

{ "startTime": "timestamp", "endTime": "timestamp", "taskType": "string", "taskStatus": "string", "nextToken": "string", "maxResults": "integer" }
cli-input-jsonBidang

Nama

Tipe

Deskripsi

startTime

timestamp

Awal periode waktu. Informasi audit disimpan untuk waktu yang terbatas (180 hari). Meminta waktu mulai sebelum apa yang dipertahankan menghasilkan. InvalidRequestException

endTime

timestamp

Akhir periode waktu.

taskType

string

Filter untuk membatasi output ke jenis audit yang ditentukan: dapat berupa salah satu ON_DEMAND_AUDIT_TASK atau SCHEDULED__AUDIT_TASK.

enum: ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK

taskStatus

string

Filter untuk membatasi output ke audit dengan status penyelesaian yang ditentukan: dapat berupa salah satu dari IN_PROGRESS, COMPLETED, FAILED, atau CANCELED.

enum: IN_PROGRESS | SELESAI | GAGAL | DIBATALKAN

nextToken

string

Token untuk set hasil berikutnya.

maxResults

integer

rentang- maks: 250 menit: 1

Jumlah maksimum hasil untuk kembali pada satu waktu. Default-nya adalah 25.

Output

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

Nama

Tipe

Deskripsi

tugas

daftar

anggota: AuditTaskMetadata

kelas java: java.util.list

Audit yang dilakukan selama periode waktu yang ditentukan.

taskId

string

panjang- maks: 40 menit: 1

pola: [A-za-Z0-9-] +

ID audit ini.

taskStatus

string

Status audit ini: salah satu IN_PROGRESS, SELESAI, GAGAL, atau DIBATALKAN.

enum: IN_PROGRESS | SELESAI | GAGAL | DIBATALKAN

taskType

string

Jenis audit ini: salah satu ON_DEMAND_AUDIT_TASK atau SCHEDULED_AUDIT_TASK.

enum: ON_DEMAND_AUDIT_TASK | SCHEDULED_AUDIT_TASK

nextToken

string

Token yang dapat digunakan untuk mengambil set hasil berikutnya, atau null jika tidak ada hasil tambahan.

Kesalahan

InvalidRequestException

Isi permintaan tidak valid.

ThrottlingException

Tarif melebihi batas.

InternalFailureException

Terjadi kesalahan tak terduga.

CancelAuditTask

Membatalkan audit yang sedang berlangsung. Audit dapat dijadwalkan atau sesuai permintaan. Jika audit tidak sedang berlangsung, InvalidRequestException terjadi.

Sinopsis

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

cli-input-jsonformat

{ "taskId": "string" }
cli-input-jsonBidang

Nama

Tipe

Deskripsi

taskId

string

panjang- maks: 40 menit: 1

pola: [A-za-Z0-9-] +

ID audit yang ingin Anda batalkan. Anda hanya dapat membatalkan audit yang IN_PROGRESS.

Output

Tidak ada

Kesalahan

ResourceNotFoundException

Sumber daya yang ditentukan tidak ada.

InvalidRequestException

Isi permintaan tidak valid.

ThrottlingException

Tarif melebihi batas.

InternalFailureException

Terjadi kesalahan tak terduga.

Periksa hasil audit

Gunakan ListAuditFindings untuk melihat hasil audit. Anda dapat memfilter hasil berdasarkan jenis pemeriksaan, sumber daya tertentu, atau waktu audit. Anda dapat menggunakan informasi ini untuk mengurangi masalah yang ditemukan.

Anda dapat menentukan tindakan mitigasi dan menerapkannya pada temuan dari audit Anda. Untuk informasi selengkapnya, lihat Tindakan mitigasi.

ListAuditFindings

Daftar temuan (hasil) audit Device Defender atau audit yang dilakukan selama periode waktu tertentu. (Temuan dipertahankan selama 180 hari.)

Sinopsis

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-jsonformat

{ "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-jsonBidang

Nama

Tipe

Deskripsi

taskId

string

panjang- maks: 40 menit: 1

pola: [A-za-Z0-9-] +

Filter untuk membatasi hasil audit dengan ID yang ditentukan. Anda harus menentukan TasKid atau StartTime dan EndTime, tetapi tidak keduanya.

checkName

string

Filter untuk membatasi hasil temuan untuk pemeriksaan audit yang ditentukan.

resourceIdentifier

ResourceIdentifier

Informasi yang mengidentifikasi sumber daya yang tidak sesuai.

deviceCertificateId

string

panjang- maks: 64 menit: 64

pola: (0x)? [A-FA-F0-9] +

ID sertifikat yang dilampirkan pada sumber daya.

caCertificateId

string

panjang- maks: 64 menit: 64

pola: (0x)? [A-FA-F0-9] +

ID sertifikat CA yang digunakan untuk mengotorisasi sertifikat.

cognitoIdentityPoolId

string

ID kumpulan identitas Amazon Cognito.

clientId

string

ID klien.

policyVersionIdentifier

PolicyVersionIdentifier

Versi kebijakan yang terkait dengan sumber daya.

policyName

string

panjang- maks: 128 menit: 1

pola: [w+=, .@-] +

Nama kebijakan .

policyVersionId

string

pola: [0-9] +

ID versi kebijakan yang terkait dengan sumber daya.

roleAliasArn

string

ARN alias peran yang memiliki tindakan terlalu permisif.

panjang- maks: 2048 menit: 1

akun

string

panjang- maks: 12 menit: 12

pola: [0-9] +

Akun yang terkait dengan sumber daya.

maxResults

integer

rentang- maks: 250 menit: 1

Jumlah maksimum hasil untuk kembali pada satu waktu. Default-nya adalah 25.

nextToken

string

Token untuk set hasil berikutnya.

startTime

timestamp

Filter untuk membatasi hasil yang ditemukan setelah waktu yang ditentukan. Anda harus menentukan baik StartTime dan EndTime atau TasKid, tetapi tidak keduanya.

endTime

timestamp

Filter untuk membatasi hasil yang ditemukan sebelum waktu yang ditentukan. Anda harus menentukan baik StartTime dan EndTime atau TasKid, tetapi tidak keduanya.

Output

{ "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" }
Bidang keluaran CLI

Nama

Tipe

Deskripsi

temuan

daftar

anggota: AuditFinding

Temuan (hasil) audit.

taskId

string

panjang- maks: 40 menit: 1

pola: [A-za-Z0-9-] +

ID audit yang menghasilkan hasil ini (temuan).

checkName

string

Pemeriksaan audit yang menghasilkan hasil ini.

taskStartTime

timestamp

Waktu audit dimulai.

findingTime

timestamp

Waktu hasil (temuan) ditemukan.

kepelikan

string

Tingkat keparahan hasil (temuan).

enum: KRITIS | TINGGI | SEDANG | RENDAH

nonCompliantResource

NonCompliantResource

Sumber daya yang ditemukan tidak sesuai dengan pemeriksaan audit.

resourceType

string

Jenis sumber daya yang tidak sesuai.

enum: DEVICE_CERTIFICATE | CA_CERTIFICATE | IOT_POLICY | COGNITO_IDENTITY_POOL | CLIENT_ID | ACCOUNT_SETTINGS

resourceIdentifier

ResourceIdentifier

Informasi yang mengidentifikasi sumber daya yang tidak sesuai.

deviceCertificateId

string

panjang- maks: 64 menit: 64

pola: (0x)? [A-FA-F0-9] +

ID sertifikat yang dilampirkan pada sumber daya.

caCertificateId

string

panjang- maks: 64 menit: 64

pola: (0x)? [A-FA-F0-9] +

ID sertifikat CA yang digunakan untuk mengotorisasi sertifikat.

cognitoIdentityPoolId

string

ID kumpulan identitas Amazon Cognito.

clientId

string

ID klien.

policyVersionIdentifier

PolicyVersionIdentifier

Versi kebijakan yang terkait dengan sumber daya.

policyName

string

panjang- maks: 128 menit: 1

pola: [w+=, .@-] +

Nama kebijakan .

policyVersionId

string

pola: [0-9] +

ID versi kebijakan yang terkait dengan sumber daya.

akun

string

panjang- maks: 12 menit: 12

pola: [0-9] +

Akun yang terkait dengan sumber daya.

additionalInfo

map

Informasi lain tentang sumber daya yang tidak patuh.

relatedResources

daftar

anggota: RelatedResource

Daftar sumber daya terkait.

resourceType

string

Tipe sumber daya.

enum: DEVICE_CERTIFICATE | CA_CERTIFICATE | IOT_POLICY | COGNITO_IDENTITY_POOL | CLIENT_ID | ACCOUNT_SETTINGS

resourceIdentifier

ResourceIdentifier

Informasi yang mengidentifikasi sumber daya.

deviceCertificateId

string

panjang- maks: 64 menit: 64

pola: (0x)? [A-FA-F0-9] +

ID sertifikat yang dilampirkan pada sumber daya.

caCertificateId

string

panjang- maks: 64 menit: 64

pola: (0x)? [A-FA-F0-9] +

ID sertifikat CA yang digunakan untuk mengotorisasi sertifikat.

cognitoIdentityPoolId

string

ID kumpulan identitas Amazon Cognito.

clientId

string

ID klien.

policyVersionIdentifier

PolicyVersionIdentifier

Versi kebijakan yang terkait dengan sumber daya.

iamRoleArn

string

panjang- maks: 2048 menit: 20

ARN dari peran IAM yang memiliki tindakan terlalu permisif.

policyName

string

panjang- maks: 128 menit: 1

pola: [w+=, .@-] +

Nama kebijakan .

policyVersionId

string

pola: [0-9] +

ID versi kebijakan yang terkait dengan sumber daya.

roleAliasArn

string

panjang- maks: 2048 menit: 1

ARN alias peran yang memiliki tindakan terlalu permisif.

akun

string

panjang- maks: 12 menit: 12

pola: [0-9] +

Akun yang terkait dengan sumber daya.

additionalInfo

map

Informasi lain tentang sumber daya.

reasonForNonKepatuhan

string

Alasan sumber daya itu tidak patuh.

reasonForNonComplianceCode

string

Kode yang menunjukkan alasan bahwa sumber daya tidak sesuai.

nextToken

string

Token yang dapat digunakan untuk mengambil set hasil berikutnya, atau null jika tidak ada hasil tambahan.

Kesalahan

InvalidRequestException

Isi permintaan tidak valid.

ThrottlingException

Tarif melebihi batas.

InternalFailureException

Terjadi kesalahan tak terduga.