AWS CLI를 사용한 Device Advisor 예시

예시 1: IoT Device Advisor 테스트 도구 모음 생성

다음 create-suite-definition 예시에서는 지정된 도구 모음 정의 구성을 사용하여 AWS IoT에 Device Advisor 테스트 도구 모음을 생성합니다.

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"}'

출력:

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

자세한 내용은 AWS IoT Core 개발자 안내서의 테스트 도구 모음 생성을 참조하세요.

예시 2: IoT Device Advisor 최신 자격 테스트 도구 모음 생성

다음 create-suite-definition 예시에서는 지정된 도구 모음 정의 구성을 사용하여 AWS IoT에 최신 버전의 Device Advisor 자격 테스트 도구 모음을 생성합니다.

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"}'

출력:

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

자세한 내용은 AWS IoT Core 개발자 안내서의 테스트 도구 모음 생성을 참조하세요.

IoT Device Advisor 테스트 도구 모음 삭제

다음 delete-suite-definition 예시에서는 지정된 도구 모음 정의 ID로 Device Advisor 테스트 도구 모음을 삭제합니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT API 참조의 DeleteSuiteDefinition을 참조하세요.

예시 1: IoT Device Advisor 계정 수준 엔드포인트의 정보 가져오기

다음 get-endpoint 예시에서는 Device Advisor 계정 수준 테스트 엔드포인트의 정보를 가져옵니다.

aws iotdeviceadvisor get-endpoint

출력:

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

예시 2: IoT Device Advisor 디바이스 수준 엔드포인트의 정보 가져오기

다음 get-endpoint 예시에서는 지정된 사물 ARN 또는 인증서 ARN을 사용하는 Device Advisor 디바이스 수준 테스트 엔드포인트의 정보를 가져옵니다.

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

출력:

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

자세한 내용은 AWS IoT Core 개발자 안내서의 테스트 엔드드포인트 가져오기를 참조하세요.

IoT Device Advisor 테스트 도구 모음의 정보 가져오기

다음 get-suite-definition 예시에서는 지정된 도구 모음 정의 ID로 Device Advisor 테스트 도구 모음의 정보를 가져옵니다.

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

출력:

{
    "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": {}
}

자세한 내용은 AWS IoT Core 개발자 안내서의 테스트 도구 모음 정의 가져오기를 참조하세요.

IoT Device Advisor 자격 테스트 도구 모음 실행 보고서의 정보 가져오기

다음 get-suite-run-report 예시에서는 지정된 도구 모음 정의 ID 및 도구 모음 실행 ID로 성공적인 Device Advisor 자격 테스트 도구 모음 실행에 대한 보고서 다운로드 링크를 가져옵니다.

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

출력:

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

자세한 내용은 AWS IoT Core 개발자 안내서의 성공적인 자격 테스트 도구 모음 실행을 위한 자격 보고서 가져오기를 참조하세요.

IoT Device Advisor 테스트 도구 모음 실행 상태의 정보 가져오기

다음 get-suite-run 예시에서는 지정된 도구 모음 정의 ID 및 도구 모음 실행 ID로 Device Advisor 테스트 도구 모음 실행 상태의 정보를 가져옵니다.

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

출력:

{
    "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": {}
}

자세한 내용은 AWS IoT Core 개발자 안내서의 테스트 도구 모음 실행 가져오기를 참조하세요.

예시 1: 생성한 IoT Device Advisor 테스트 도구 모음 나열

다음 list-suite-definitions 예시에서는 AWS IoT에서 생성한 최대 25개의 Device Advisor 테스트 도구 모음을 나열합니다. 테스트 도구 모음이 25개를 초과하는 경우 출력에 ‘nextToken’이 표시됩니다. 이 ‘nextToken’을 사용하면 생성한 나머지 테스트 도구 모음을 표시할 수 있습니다.

aws iotdeviceadvisor list-suite-definitions

출력:

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

예시 2: 지정된 설정으로 생성한 IoT Device Advisor 테스트 도구 모음 나열

다음 list-suite-definitions 예시에서는 AWS IoT에서 생성한 Device Advisor 테스트 도구 모음을 지정된 최대 결과 개수 내에서 나열합니다. 테스트 도구 모음이 최대 개수보다 많은 경우 출력에 ‘nextToken’이 표시됩니다. ‘nextToken’이 있는 경우 ‘nextToken’을 사용하여 이전에 표시되지 않은 생성한 테스트 도구 모음을 표시할 수 있습니다.

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

출력:

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

자세한 내용은 AWS IoT API 참조의 ListSuiteDefinitions를 참조하세요.

예시 1: 지정된 IoT Device Advisor 테스트 도구 모음 실행 상태의 모든 정보 나열

다음 list-suite-runs 예시에서는 Device Advisor 테스트 도구 모음 실행 상태의 모든 정보를 지정된 도구 모음 정의 ID를 사용하여 나열합니다. 테스트 도구 모음 실행이 25개를 초과하는 경우 출력에 ‘nextToken’이 표시됩니다. 이 ‘nextToken’을 사용하면 나머지 테스트 도구 모음 실행을 표시할 수 있습니다.

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

출력:

{
    "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
        }
    ]
}

예시 2: 지정된 IoT Device Advisor 테스트 도구 모음 실행 상태의 정보를 지정된 설정으로 나열

다음 list-suite-runs 예시에서는 Device Advisor 테스트 도구 모음 실행 상태의 정보를 지정된 도구 모음 정의 ID를 사용하여 최대 결과 개수 내에서 나열합니다. 테스트 도구 모음 실행이 최대 개수를 초과한 경우 출력에 ‘nextToken’이 표시됩니다. ‘nextToken’이 있는 경우 ‘nextToken’을 사용하여 이전에 표시되지 않은 테스트 도구 모음 실행을 표시할 수 있습니다.

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

출력:

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

자세한 내용은 AWS IoT API 참조의 ListSuiteRuns를 참조하세요.

IoT Device Advisor 리소스에 연결된 태그 나열

다음 list-tags-for-resource 예시에서는 Device Advisor 리소스에 연결된 태그를 나열합니다. Device Advisor 리소스는 Suitedefinition ARN 또는 Suiterun ARN일 수 있습니다.

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

출력:

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

자세한 내용은 AWS IoT API 참조의 ListTagsForResource 및 서비스 승인 참조의 AWS IoT Core Device Advisor에 의해 정의된 리소스 유형을 참조하세요.

IoT Device Advisor 테스트 도구 모음 실행 시작

다음 start-suite-run 예시에서는 AWS 계정에서 사용 가능한 위젯을 나열합니다.

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"}}'

출력:

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

자세한 내용은 AWS IoT Core 개발자 안내서의 테스트 도구 모음 실행 시작을 참조하세요.

현재 실행 중인 IoT Device Advisor 테스트 도구 모음 중지

다음 stop-suite-run 예시에서는 지정된 도구 모음 정의 ID 및 도구 모음 실행 ID로 현재 실행 중인 Device Advisor 테스트 도구 모음을 중지합니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT Core 개발자 안내서의 테스트 도구 모음 실행 중지를 참조하세요.

IoT Device Advisor 리소스의 기존 태그를 추가 및 수정

다음 tag-resource 예시에서는 지정된 리소스 ARN 및 태그를 사용하여 Device Advisor 리소스의 기존 태그를 추가 및 수정합니다. Device Advisor 리소스는 Suitedefinition ARN 또는 Suiterun ARN일 수 있습니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT API 참조의 TagResource 및 서비스 승인 참조의 AWS IoT Core Device Advisor에 의해 정의된 리소스 유형을 참조하세요.

IoT Device Advisor 리소스에서 기존 태그 제거

다음 untag-resource 예시에서는 지정된 리소스 ARN 및 태그 키를 사용하여 Device Advisor 리소스에서 기존 태그를 제거합니다. Device Advisor 리소스는 Suitedefinition ARN 또는 Suiterun ARN일 수 있습니다.

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

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 AWS IoT API 참조의 UntagResource 및 서비스 승인 참조의 AWS IoT Core Device Advisor에 의해 정의된 리소스 유형을 참조하세요.

예시 1: IoT Device Advisor 테스트 도구 모음 업데이트

다음 update-suite-definition 예시에서는 AWS IoT의 Device Advisor 테스트 도구 모음을 지정된 도구 모음 정의 ID 및 도구 모음 정의 구성으로 업데이트합니다.

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"}'

출력:

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

예시 2: IoT Device Advisor 자격 테스트 도구 모음 업데이트

다음 update-suite-definition 예시에서는 AWS IoT의 Device Advisor 자격 테스트 도구 모음을 지정된 도구 모음 정의 ID 및 도구 모음 정의 구성으로 업데이트합니다.

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"}'

출력:

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

자세한 내용은 AWS IoT API 참조의 UpdateSuiteDefinition을 참조하세요.