Spec-Zone.ru › AWS CLI v2

[ aws . iotdeviceadvisor ]

создание-определения-набора-тестов

Описание

Создает набор тестов Device Advisor.

Требуется разрешение на доступ к действию CreateSuiteDefinition.

См. также: Документацию API AWS

Синтаксис

  create-suite-definition
--suite-definition-configuration <value>
[--tags <value>]
[--client-token <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-configuration (структура)

Создает набор тестов Device Advisor с конфигурацией определения набора тестов.

suiteDefinitionName -> (строка)

Получает имя определения набора тестов. Это обязательный параметр.

devices -> (список)

Получает настроенные устройства.

(структура)

Информация об устройстве для тестирования. Требуется ARN вещи, сертификата или ARN роли устройства.

thingArn -> (строка)

Список ARN вещи устройства.

certificateArn -> (строка)

Список ARN сертификата устройства.

deviceRoleArn -> (строка)

Список ARN роли устройства.

intendedForQualification -> (булево)

Получает тесты, предназначенные для квалификации в наборе.

isLongDurationTest -> (булево)

Проверяет, является ли набор тестов набором тестов длительного выполнения.

rootGroup -> (строка)

Получает корневую группу набора тестов. Это обязательный параметр. Для обновления или создания последнего набора квалификации, если intendedForQualification установлено в значение true, rootGroup может быть пустой строкой. Если intendedForQualification ложно, rootGroup не может быть пустой строкой. Если rootGroup пуста, а intendedForQualification установлено в значение true, все тесты квалификации включены, и конфигурация по умолчанию.

Для набора квалификации минимальная длина составляет 0, а максимальная — 2048. Для набора, не предназначенного для квалификации, минимальная длина составляет 1, а максимальная — 2048.

devicePermissionRoleArn -> (строка)

Получает ARN разрешения устройства. Это обязательный параметр.

protocol -> (строка)

Устанавливает протокол MQTT, настроенный в определении набора тестов.

Сокращенный синтаксис:

suiteDefinitionName=string,devices=[{thingArn=string,certificateArn=string,deviceRoleArn=string},{thingArn=string,certificateArn=string,deviceRoleArn=string}],intendedForQualification=boolean,isLongDurationTest=boolean,rootGroup=string,devicePermissionRoleArn=string,protocol=string

Синтаксис JSON:

{
  "suiteDefinitionName": "string",
  "devices": [
    {
      "thingArn": "string",
      "certificateArn": "string",
      "deviceRoleArn": "string"
    }
    ...
  ],
  "intendedForQualification": true|false,
  "isLongDurationTest": true|false,
  "rootGroup": "string",
  "devicePermissionRoleArn": "string",
  "protocol": "MqttV3_1_1"|"MqttV5"|"MqttV3_1_1_OverWebSocket"|"MqttV5_OverWebSocket"
}

--tags (карта)

Теги, которые необходимо прикрепить к определению набора тестов.

key -> (строка)

value -> (строка)

Сокращенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--client-token (строка)

Токен клиента для создания определения набора тестов. Этот токен используется для отслеживания создания определения набора тестов с помощью повторов и получения его состояния. Этот параметр необязателен.

--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
  • текст
  • таблица
  • 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок 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.

Пример 1: Создание набора тестов IoT Device Advisor

Следующий create-suite-definition пример создает набор тестов Device Advisor в AWS IoT с указанной конфигурацией определения набора тестов.

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 пример создает набор квалификационных тестов Device Advisor с последней версией в AWS IoT с указанной конфигурацией определения набора тестов.

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.

Вывод

suiteDefinitionId -> (строка)

UUID созданного набора тестов.

suiteDefinitionArn -> (строка)

Amazon Resource Name (ARN) набора тестов.

suiteDefinitionName -> (строка)

Имя определения набора тестов. Это обязательный параметр.

createdAt -> (метка времени)

Метка времени создания набора тестов.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API