Spec-Zone.ru › AWS CLI v2

[ aws . iotdeviceadvisor ]

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

Описание

Обновляет набор тестов Device Advisor.

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

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

Синтаксис

  update-suite-definition
--suite-definition-id <value>
--suite-definition-configuration <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-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"
}

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

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

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

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

Для получения дополнительной информации см. UpdateSuiteDefinition в справочнике API AWS IoT.

Вывод

suiteDefinitionId -> (строка)

Идентификатор обновленного набора тестов.

suiteDefinitionArn -> (строка)

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

suiteDefinitionName -> (строка)

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

suiteDefinitionVersion -> (строка)

Версия определения набора обновленных тестов.

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

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

lastUpdatedAt -> (временная метка)

Временная метка последнего обновления набора тестов.

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

Spec-Zone.ru

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