[ aws . iotdeviceadvisor ]
получить-определение-набора-тестов
Описание
Получает информацию о наборе тестов Device Advisor.
Требуется разрешение на доступ к действию GetSuiteDefinition.
См. также: Документацию API AWS
Синтаксис
get-suite-definition
--suite-definition-id <value>
[--suite-definition-version <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--suite-definition-id (строка)
--suite-definition-version (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет принята буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или значение input, выводит JSON-пример входных данных, которые можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, оно выведет пример входных данных YAML, которые можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команд и возвращает пример выходных данных JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (булево)
Включить отладочную запись в журнал.
--endpoint-url (строка)
Переопределяет URL по умолчанию команды указанным URL.
--no-verify-ssl (булево)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.
--no-paginate (булево)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования для вывода команд.
- json
- text
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из файла учетных данных.
--region (строка)
Используемый регион. Переопределяет параметры конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- включить
- выключить
- авто
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Сборник сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет параметры конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображаемого на двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (булево)
Отключение пейджера CLI для вывода.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросов параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. Дополнительные сведения см. в разделе Использование кавычек со строками в руководстве пользователя AWS CLI.
Для получения информации о наборе тестов IoT Device Advisor
Следующий get-suite-definition пример получает информацию о наборе тестов 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.
Вывод
suiteDefinitionId -> (строка)
suiteDefinitionArn -> (строка)
suiteDefinitionVersion -> (строка)
latestVersion -> (строка)
suiteDefinitionConfiguration -> (структура)
Настройка набора тестов.
suiteDefinitionName -> (строка)
devices -> (список)
Получает настроенные устройства.
(структура)
Информация об устройстве для тестирования. Требуется ARN вещи, сертификата или ARN роли устройства.
thingArn -> (строка)
certificateArn -> (строка)
deviceRoleArn -> (строка)
intendedForQualification -> (булево)
isLongDurationTest -> (булево)
rootGroup -> (строка)
Получает корневую группу набора тестов. Это обязательный параметр. Для обновления или создания последнего набора квалификационных тестов, если intendedForQualification установлено в true, rootGroup может быть пустой строкой. Если intendedForQualification ложно, rootGroup не может быть пустой строкой. Если rootGroup пусто, а intendedForQualification установлено в true, все тесты квалификации включены, и конфигурация имеет значения по умолчанию.
Для набора квалификационных тестов минимальная длина составляет 0, а максимальная — 2048. Для набора тестов, не предназначенных для квалификации, минимальная длина — 1, а максимальная — 2048.
devicePermissionRoleArn -> (строка)
protocol -> (строка)
createdAt -> (метка времени)
lastModifiedAt -> (метка времени)
tags -> (карта)
Теги, прикрепленные к определению набора тестов.
key -> (строка)
value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.