View a markdown version of this page

Contoh Device Advisor menggunakan AWS CLI - AWS Command Line Interface
Tindakan

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

Contoh Device Advisor menggunakan AWS CLI

Contoh kode berikut menunjukkan cara melakukan tindakan dan menerapkan skenario umum dengan menggunakan AWS Command Line Interface with Device Advisor.

Tindakan merupakan kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Sementara tindakan menunjukkan cara memanggil fungsi layanan individual, Anda dapat melihat tindakan dalam konteks dalam skenario terkait.

Setiap contoh menyertakan tautan ke kode sumber lengkap, di mana Anda dapat menemukan instruksi tentang cara mengatur dan menjalankan kode dalam konteks.

Tindakan

Contoh kode berikut menunjukkan cara menggunakancreate-suite-definition.

AWS CLI

Contoh 1: Untuk membuat rangkaian pengujian Penasihat Perangkat IoT

create-suite-definitionContoh berikut membuat rangkaian pengujian penasihat perangkat di AWS IoT dengan konfigurasi definisi suite yang ditentukan.

aws iotdeviceadvisor create-suite-definition \
    --suite-definition-configuration '{ \
        "suiteDefinitionName": "TestSuiteName", \
        "devices": [{"thingArn":"arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"}], \
        "intendedForQualification": false, \
        "rootGroup": "{\"configuration\":{},\"tests\":[{\"name\":\"MQTT Connect\",\"configuration\":{\"EXECUTION_TIMEOUT\":120},\"tests\":[{\"name\":\"MQTT_Connect\",\"configuration\":{},\"test\":{\"id\":\"MQTT_Connect\",\"testCase\":null,\"version\":\"0.0.0\"}}]}]}", \
        "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole"}'

Output:

{
    "suiteDefinitionId": "0jtsgio7yenu",
    "suiteDefinitionArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/0jtsgio7yenu",
    "suiteDefinitionName": "TestSuiteName",
    "createdAt": "2022-12-02T11:38:13.263000-05:00"
}

Untuk informasi selengkapnya, lihat Membuat definisi rangkaian pengujian di Panduan Pengembang Inti AWS IoT.

Contoh 2: Untuk membuat rangkaian uji Kualifikasi Terbaru Penasihat Perangkat IoT

create-suite-definitionContoh berikut membuat rangkaian uji kualifikasi penasihat perangkat dengan versi terbaru di AWS IoT dengan konfigurasi definisi suite yang ditentukan.

aws iotdeviceadvisor create-suite-definition \
    --suite-definition-configuration '{ \
        "suiteDefinitionName": "TestSuiteName", \
        "devices": [{"thingArn":"arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"}], \
        "intendedForQualification": true, \
        "rootGroup": "", \
        "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole"}'

Output:

{
    "suiteDefinitionId": "txgsuolk2myj",
    "suiteDefinitionArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/txgsuolk2myj",
    "suiteDefinitionName": "TestSuiteName",
    "createdAt": "2022-12-02T11:38:13.263000-05:00"
}

Untuk informasi selengkapnya, lihat Membuat definisi rangkaian pengujian di Panduan Pengembang Inti AWS IoT.

Contoh kode berikut menunjukkan cara menggunakandelete-suite-definition.

AWS CLI

Untuk menghapus rangkaian pengujian Penasihat Perangkat IoT

delete-suite-definitionContoh berikut menghapus rangkaian pengujian penasihat perangkat dengan ID definisi suite yang ditentukan.

aws iotdeviceadvisor delete-suite-definition \
    --suite-definition-id 0jtsgio7yenu

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat DeleteSuiteDefinition di Refer AWS ensi API IoT.

Contoh kode berikut menunjukkan cara menggunakanget-endpoint.

AWS CLI

Contoh 1: Untuk mendapatkan informasi tentang titik akhir IoT Device Account-level Advisor

get-endpointContoh berikut mendapatkan informasi tentang titik akhir Account-level pengujian penasihat perangkat.

aws iotdeviceadvisor get-endpoint

Output:

{
    "endpoint": "t6y4c143x9sfo.deviceadvisor.iot.us-east-1.amazonaws.com"
}

Contoh 2: Untuk mendapatkan informasi tentang titik akhir IoT Device Device-level Advisor

get-endpointContoh berikut mendapatkan informasi tentang titik akhir pengujian tingkat perangkat penasihat perangkat dengan thing-arn atau sertifikat-arn yang ditentukan.

aws iotdeviceadvisor get-endpoint \
    --thing-arn arn:aws:iot:us-east-1:123456789012:thing/MyIotThing

Output:

{
    "endpoint": "tdb7719be5t6y4c143x9sfo.deviceadvisor.iot.us-east-1.amazonaws.com"
}

Untuk informasi selengkapnya, lihat Mendapatkan titik akhir pengujian di Panduan Pengembang AWS IoT Core.

  • Untuk detail API, lihat GetEndpoint di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakanget-suite-definition.

AWS CLI

Untuk mendapatkan informasi tentang rangkaian pengujian IoT Device Advisor

get-suite-definitionContoh berikut mendapatkan informasi tentang rangkaian pengujian penasihat aevice dengan ID definisi suite yang ditentukan.

aws iotdeviceadvisor get-suite-definition \
    --suite-definition-id qqcsmtyyjabl

Output:

{
    "suiteDefinitionId": "qqcsmtyyjabl",
    "suiteDefinitionArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/qqcsmtyyjabl",
    "suiteDefinitionVersion": "v1",
    "latestVersion": "v1",
    "suiteDefinitionConfiguration": {
        "suiteDefinitionName": "MQTT connection",
        "devices": [],
        "intendedForQualification": false,
        "isLongDurationTest": false,
        "rootGroup": "{\"configuration\":{},\"tests\":[{\"id\":\"uta5d9j1kvwc\",\"name\":\"Test group 1\",\"configuration\":{},\"tests\":[{\"id\":\"awr8pq5vc9yp\",\"name\":\"MQTT Connect\",\"configuration\":{},\"test\":{\"id\":\"MQTT_Connect\",\"testCase\":null,\"version\":\"0.0.0\"}}]}]}",
        "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole",
        "protocol": "MqttV3_1_1"
    },
    "createdAt": "2022-11-11T22:28:52.389000-05:00",
    "lastModifiedAt": "2022-11-11T22:28:52.389000-05:00",
    "tags": {}
}

Untuk informasi selengkapnya, lihat Mendapatkan definisi rangkaian pengujian di Panduan Pengembang Inti AWS IoT.

Contoh kode berikut menunjukkan cara menggunakanget-suite-run-report.

AWS CLI

Untuk mendapatkan informasi tentang laporan menjalankan rangkaian pengujian yang memenuhi syarat Penasihat Perangkat IoT

get-suite-run-reportContoh berikut mendapatkan tautan unduhan laporan untuk menjalankan rangkaian pengujian yang memenuhi syarat penasihat perangkat yang berhasil dengan ID definisi suite dan ID run suite yang ditentukan.

aws iotdeviceadvisor get-suite-run-report \
    --suite-definition-id ztvb5aek4w4x \
    --suite-run-id p6awv83nre6v

Output:

{
    "qualificationReportDownloadUrl": "https://senate-apn-reports-us-east-1-prod.s3.amazonaws.com/report.downloadlink"
}

Untuk informasi selengkapnya, lihat M endapatkan laporan kualifikasi untuk rangkaian uji kualifikasi yang berhasil dijalankan di Panduan Pengembang Inti AWS IoT.

Contoh kode berikut menunjukkan cara menggunakanget-suite-run.

AWS CLI

Untuk mendapatkan informasi tentang status menjalankan rangkaian pengujian IoT Device Advisor

get-suite-runContoh berikut mendapatkan informasi tentang status menjalankan rangkaian pengujian penasihat perangkat dengan ID definisi suite dan ID run suite yang ditentukan.

aws iotdeviceadvisor get-suite-run \
    --suite-definition-id qqcsmtyyjabl \
    --suite-run-id nzlfyhaa18oa

Output:

{
    "suiteDefinitionId": "qqcsmtyyjabl",
    "suiteDefinitionVersion": "v1",
    "suiteRunId": "nzlfyhaa18oa",
    "suiteRunArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suiterun/qqcsmtyyjabl/nzlfyhaa18oa",
    "suiteRunConfiguration": {
        "primaryDevice": {
            "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/MyIotThing",
            "certificateArn": "arn:aws:iot:us-east-1:123456789012:cert/certFile"
        },
        "parallelRun": false
    },
    "testResult": {
        "groups": [
            {
                "groupId": "uta5d9j1kvwc",
                "groupName": "Test group 1",
                "tests": [
                    {
                        "testCaseRunId": "2ve2twrqyr0s",
                        "testCaseDefinitionId": "awr8pq5vc9yp",
                        "testCaseDefinitionName": "MQTT Connect",
                        "status": "PASS",
                        "startTime": "2022-11-12T00:01:53.693000-05:00",
                        "endTime": "2022-11-12T00:02:15.443000-05:00",
                        "logUrl": "https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logEventViewer:group=/aws/iot/deviceadvisor/qqcsmtyyjabl;stream=nzlfyhaa18oa_2ve2twrqyr0s",
                        "warnings": "null",
                        "failure": "null"
                    }
                ]
            }
        ]
    },
    "startTime": "2022-11-12T00:01:52.673000-05:00",
    "endTime": "2022-11-12T00:02:16.496000-05:00",
    "status": "PASS",
    "tags": {}
}

Untuk informasi selengkapnya, lihat Menjalankan rangkaian pengujian di Panduan Pengembang AWS IoT Core.

  • Untuk detail API, lihat GetSuiteRun di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakanlist-suite-definitions.

AWS CLI

Contoh 1: Untuk membuat daftar rangkaian pengujian IoT Device Advisor yang Anda buat

list-suite-definitionsContoh berikut mencantumkan hingga 25 rangkaian pengujian penasihat perangkat yang Anda buat di AWS IoT. Jika Anda memiliki lebih dari 25 suite pengujian, “NextToken” akan ditampilkan dalam output. Anda dapat menggunakan “NextToken” ini untuk menampilkan rangkaian pengujian lainnya yang Anda buat.

aws iotdeviceadvisor list-suite-definitions

Output:

{
    "suiteDefinitionInformationList": [
        {
            "suiteDefinitionId": "3hsn88h4p2g5",
            "suiteDefinitionName": "TestSuite1",
            "defaultDevices": [
                {
                    "thingArn": "arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"
                }
            ],
            "intendedForQualification": false,
            "isLongDurationTest": false,
            "protocol": "MqttV3_1_1",
            "createdAt": "2022-11-17T14:15:56.830000-05:00"
        },
        {
            ......
        }
    ],
    "nextToken": "nextTokenValue"
}

Contoh 2: Untuk membuat daftar rangkaian pengujian IoT Device Advisor yang Anda buat dengan pengaturan yang ditentukan

list-suite-definitionsContoh berikut mencantumkan rangkaian pengujian penasihat perangkat yang Anda buat di AWS IoT dengan nomor hasil maksimal yang ditentukan. Jika Anda memiliki lebih banyak rangkaian pengujian daripada angka maksimum, “NextToken” akan ditampilkan dalam output. Jika Anda memiliki “NextToken”, Anda dapat menggunakan “NextToken” untuk menampilkan rangkaian pengujian yang Anda buat yang tidak ditampilkan sebelumnya.

aws iotdeviceadvisor list-suite-definitions \
    --max-result 1 \
    --next-token "nextTokenValue"

Output:

{
    "suiteDefinitionInformationList": [
        {
            "suiteDefinitionId": "ztvb5aew4w4x",
            "suiteDefinitionName": "TestSuite2",
            "defaultDevices": [],
            "intendedForQualification": true,
            "isLongDurationTest": false,
            "protocol": "MqttV3_1_1",
            "createdAt": "2022-11-17T14:15:56.830000-05:00"
        }
    ],
    "nextToken": "nextTokenValue"
}

Untuk informasi selengkapnya, lihat ListSuiteDefinitions di Refer AWS ensi API IoT.

Contoh kode berikut menunjukkan cara menggunakanlist-suite-runs.

AWS CLI

Contoh 1: Untuk mencantumkan semua informasi tentang rangkaian pengujian IoT Device Advisor yang ditentukan menjalankan status

list-suite-runsContoh berikut mencantumkan semua informasi tentang rangkaian pengujian penasihat perangkat menjalankan status dengan ID definisi suite yang ditentukan. Jika Anda menjalankan lebih dari 25 test suite, “NextToken” akan ditampilkan dalam output. Anda dapat menggunakan “NextToken” ini untuk menunjukkan sisa rangkaian pengujian yang berjalan.

aws iotdeviceadvisor list-suite-runs \
    --suite-definition-id ztvb5aew4w4x

Output:

{
    "suiteRunsList": [
        {
            "suiteDefinitionId": "ztvb5aew4w4x",
            "suiteDefinitionVersion": "v1",
            "suiteDefinitionName": "TestSuite",
            "suiteRunId": "p6awv89nre6v",
            "createdAt": "2022-12-01T16:33:14.212000-05:00",
            "startedAt": "2022-12-01T16:33:15.710000-05:00",
            "endAt": "2022-12-01T16:42:03.323000-05:00",
            "status": "PASS",
            "passed": 6,
            "failed": 0
        }
    ]
}

Contoh 2: Untuk mencantumkan informasi tentang rangkaian pengujian IoT Device Advisor yang ditentukan menjalankan status dengan pengaturan yang ditentukan

list-suite-runsContoh berikut mencantumkan informasi tentang rangkaian pengujian penasihat perangkat menjalankan status dengan ID definisi suite yang ditentukan dan nomor hasil maksimal yang ditentukan. Jika Anda memiliki lebih banyak test suite yang dijalankan daripada jumlah maksimum, “NextToken” akan ditampilkan dalam output. Jika Anda memiliki “NextToken”, Anda dapat menggunakan “NextToken” untuk menunjukkan rangkaian pengujian yang tidak ditampilkan sebelumnya.

aws iotdeviceadvisor list-suite-runs \
    --suite-definition-id qqcsmtyyjaml \
    --max-result 1 \
    --next-token "nextTokenValue"

Output:

{
    "suiteRunsList": [
        {
            "suiteDefinitionId": "qqcsmtyyjaml",
            "suiteDefinitionVersion": "v1",
            "suiteDefinitionName": "MQTT connection",
            "suiteRunId": "gz9vm2s6d2jy",
            "createdAt": "2022-12-01T20:10:27.079000-05:00",
            "startedAt": "2022-12-01T20:10:28.003000-05:00",
            "endAt": "2022-12-01T20:10:45.084000-05:00",
            "status": "STOPPED",
            "passed": 0,
            "failed": 0
        }
    ],
    "nextToken": "nextTokenValue"
}

Untuk informasi selengkapnya, lihat ListSuiteRuns di Refer AWS ensi API IoT.

Contoh kode berikut menunjukkan cara menggunakanlist-tags-for-resource.

AWS CLI

Untuk membuat daftar tag yang dilampirkan ke sumber daya Penasihat Perangkat IoT

list-tags-for-resourceContoh berikut mencantumkan tag yang dilampirkan ke sumber daya penasihat perangkat. Sumber daya penasihat perangkat dapat berupa a Suitedefinition-Arn atau a Suiterun-Arn.

aws iotdeviceadvisor list-tags-for-resource \
    --resource-arn arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/ba0uyjpg38ny

Output:

{
    "tags": {
        "TestTagKey": "TestTagValue"
    }
}

Untuk informasi selengkapnya, lihat ListTagsForResource di Referensi AWS IoT API dan Jenis Sumber Daya yang ditentukan oleh Penasihat Perangkat Inti AWS IoT di Referensi Otorisasi Layanan.

Contoh kode berikut menunjukkan cara menggunakanstart-suite-run.

AWS CLI

Untuk memulai menjalankan rangkaian pengujian Penasihat Perangkat IoT

start-suite-runContoh berikut mencantumkan widget yang tersedia di AWS akun Anda.

aws iotdeviceadvisor start-suite-run \
    --suite-definition-id qqcsmtyyjabl \
    --suite-definition-version v1 \
    --suite-run-configuration '{"primaryDevice":{"thingArn": "arn:aws:iot:us-east-1:123456789012:thing/MyIotThing","certificateArn":"arn:aws:iot:us-east-1:123456789012:cert/certFile"}}'

Output:

{
    "suiteRunId": "pwmucgw7lt9s",
    "suiteRunArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suiterun/qqcsmtyyjabl/pwmucgw7lk9s",
    "createdAt": "2022-12-02T15:43:05.581000-05:00"
}

Untuk informasi selengkapnya, lihat Mem ulai menjalankan rangkaian pengujian di Panduan Pengembang AWS IoT Core.

Contoh kode berikut menunjukkan cara menggunakanstop-suite-run.

AWS CLI

Untuk menghentikan rangkaian pengujian IoT Device Advisor yang sedang berjalan

stop-suite-runContoh berikut menghentikan rangkaian pengujian penasihat perangkat yang saat ini berjalan dengan ID definisi suite dan ID run suite yang ditentukan.

aws iotdeviceadvisor stop-suite-run \
    --suite-definition-id qqcsmtyyjabl \
    --suite-run-id nzlfyhaa18oa

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mengh entikan menjalankan rangkaian pengujian di Panduan Pengembang AWS IoT Core.

  • Untuk detail API, lihat StopSuiteRun di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakantag-resource.

AWS CLI

Untuk menambahkan dan memodifikasi tag yang ada dari sumber daya Penasihat Perangkat IoT

tag-resourceContoh berikut menambah dan memodifikasi tag yang ada dari sumber daya penasihat perangkat dengan arn dan tag sumber daya yang ditentukan. Sumber daya penasihat perangkat dapat berupa a Suitedefinition-Arn atau a Suiterun-Arn.

aws iotdeviceadvisor tag-resource \
    --resource-arn arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/ba0uyjpg38ny \
    --tags '{"TagKey": "TagValue"}'

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat TagResource di Referensi AWS IoT API dan Jenis Sumber Daya yang ditentukan oleh Penasihat Perangkat Inti AWS IoT di Referensi Otorisasi Layanan.

  • Untuk detail API, lihat TagResource di Refer AWS CLI ensi Perintah.

Contoh kode berikut menunjukkan cara menggunakanuntag-resource.

AWS CLI

Untuk menghapus tag yang ada dari sumber daya Penasihat Perangkat IoT

untag-resourceContoh berikut menghapus tag yang ada dari sumber daya penasihat perangkat dengan arn sumber daya dan kunci tag yang ditentukan. Sumber daya penasihat perangkat dapat berupa a Suitedefinition-Arn atau a Suiterun-Arn.

aws iotdeviceadvisor untag-resource \
    --resource-arn arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/ba0uyjpg38ny \
    --tag-keys "TagKey"

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat UntagResource di Referensi AWS IoT API dan Jenis Sumber Daya yang ditentukan oleh Penasihat Perangkat Inti AWS IoT di Referensi Otorisasi Layanan.

Contoh kode berikut menunjukkan cara menggunakanupdate-suite-definition.

AWS CLI

Contoh 1: Untuk memperbarui rangkaian pengujian Penasihat Perangkat IoT

update-suite-definitionContoh berikut memperbarui rangkaian pengujian penasihat perangkat di AWS IoT dengan ID definisi suite yang ditentukan dan konfigurasi definisi suite.

aws iotdeviceadvisor update-suite-definition \
    --suite-definition-id 3hsn88h4p2g5 \
    --suite-definition-configuration '{ \
        "suiteDefinitionName": "TestSuiteName", \
        "devices": [{"thingArn":"arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"}], \
        "intendedForQualification": false, \
        "rootGroup": "{\"configuration\":{},\"tests\":[{\"name\":\"MQTT Connect\",\"configuration\":{\"EXECUTION_TIMEOUT\":120},\"tests\":[{\"name\":\"MQTT_Connect\",\"configuration\":{},\"test\":{\"id\":\"MQTT_Connect\",\"testCase\":null,\"version\":\"0.0.0\"}}]}]}", \
        "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole"}'

Output:

{
    "suiteDefinitionId": "3hsn88h4p2g5",
    "suiteDefinitionName": "TestSuiteName",
    "suiteDefinitionVersion": "v3",
    "createdAt": "2022-11-17T14:15:56.830000-05:00",
    "lastUpdatedAt": "2022-12-02T16:02:45.857000-05:00"
}

Contoh 2: Untuk memperbarui rangkaian uji Kualifikasi Penasihat Perangkat IoT

update-suite-definitionContoh berikut memperbarui rangkaian uji kualifikasi penasihat perangkat di AWS IoT dengan ID definisi suite yang ditentukan dan konfigurasi definisi suite.

aws iotdeviceadvisor update-suite-definition \
    --suite-definition-id txgsuolk2myj \
    --suite-definition-configuration '{
        "suiteDefinitionName": "TestSuiteName", \
        "devices": [{"thingArn":"arn:aws:iot:us-east-1:123456789012:thing/MyIotThing"}], \
        "intendedForQualification": true, \
        "rootGroup": "", \
        "devicePermissionRoleArn": "arn:aws:iam::123456789012:role/Myrole"}'

Output:

{
    "suiteDefinitionId": "txgsuolk2myj",
    "suiteDefinitionName": "TestSuiteName",
    "suiteDefinitionVersion": "v3",
    "createdAt": "2022-11-17T14:15:56.830000-05:00",
    "lastUpdatedAt": "2022-12-02T16:02:45.857000-05:00"
}

Untuk informasi selengkapnya, lihat UpdateSuiteDefinition di Refer AWS ensi API IoT.