Spec-Zone.ru › AWS CLI v2

[ aws . iotfleetwise ]

list-decoder-manifest-signals

Описание

Список информации о декодерах сигналов, указанных в манифесте декодера.

Примечание

Данная операция API использует пагинацию. Укажите параметр nextToken в запросе для возврата дополнительных результатов.

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

list-decoder-manifest-signals является операцией с пагинацией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить пагинацию, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с пагинацией, аргумент --query должен извлекать данные из результатов следующих выражений запроса: signalDecoders

Синтаксис

  list-decoder-manifest-signals
--name <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--name (строка)

Имя манифеста декодера, информацию о котором требуется получить.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, указанному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения из JSON. Невозможно передавать произвольные двоичные значения, используя значение из JSON, так как строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Токен для указания места начала пагинации. Это NextToken из ранее урезанного ответа.

Примеры использования см. в разделе Пагинация в Руководстве пользователя командной строки AWS.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Пагинация в Руководстве пользователя командной строки AWS.

--max-items (целое число)

Общее количество элементов, которые должны быть возвращены в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления пагинации укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Пагинация в Руководстве пользователя командной строки AWS.

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

Вывод

signalDecoders -> (список)

Информация о списке сигналов для декодирования.

(структура)

Информация о декодере сигнала.

fullyQualifiedName -> (строка)

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

type -> (строка)

Сеть протокол для транспортного средства. Например, CAN_SIGNAL определяет протокол, который определяет, как данные передаются между электронными блоками управления (ЭБУ). OBD_SIGNAL определяет протокол, который определяет, как передаются данные самодиагностики между ЭБУ.

interfaceId -> (строка)

Идентификатор сетевого интерфейса, который определяет, какой сетевой протокол следует транспортное средство.

canSignal -> (структура)

Информация о декодере сигнала, использующего протокол Controller Area Network (CAN).

messageId -> (целое число)

Идентификатор сообщения.

isBigEndian -> (булево)

Указывает, является ли порядок байтов сообщения CAN big-endian.

isSigned -> (булево)

Определяет, является ли сообщение знаковым (true ) или беззнаковым (false ). Если сообщение знаковое, оно может представлять как положительные, так и отрицательные числа. Параметр isSigned применяется только к типу сигнала INTEGER raw, и он не влияет на тип сигнала FLOATING_POINT raw.

startBit -> (целое число)

Указывает начало CAN сигнала. Это всегда должен быть наименее значимый бит (LSB).

Это значение может отличаться от значения в файле DBC. Для сигналов little endian, startBit значение совпадает со значением в файле DBC. Для сигналов big endian в файле DBC начальный бит — наиболее значимый бит (MSB). Вам нужно будет рассчитать LSB и передать его как startBit.

offset -> (двойное число)

Смещение, используемое для вычисления значения сигнала. В сочетании с множителем, вычисление является value = raw_value * factor + offset .

factor -> (двойное число)

Множитель, используемый для декодирования CAN сообщения.

length -> (целое число)

Количество байтов данных в сообщении.

name -> (строка)

Имя сигнала.

signalValueType -> (строка)

Тип значения сигнала. Значение по умолчанию — INTEGER .

obdSignal -> (структура)

Информация о декодере сигнала, использующего протокол диагностики на борту (OBD) II.

pidResponseLength -> (целое число)

Длина запрашиваемых данных.

serviceMode -> (целое число)

Режим работы (диагностический сервис) в сообщении.

pid -> (целое число)

Диагностический код, используемый для запроса данных от транспортного средства для этого сигнала.

scaling -> (двойное число)

Множитель, используемый для декодирования сообщения.

offset -> (двойное число)

Смещение, используемое для вычисления значения сигнала. В сочетании со масштабированием, вычисление — это value = raw_value * scaling + offset .

startByte -> (целое число)

Указывает начало сообщения.

byteLength -> (целое число)

Длина сообщения.

bitRightShift -> (целое число)

Количество позиций для сдвига битов в сообщении.

bitMaskLength -> (целое число)

Количество битов для маскирования в сообщении.

isSigned -> (булево)

Определяет, является ли сообщение знаковым (true ) или беззнаковым (false ). Если сообщение знаковое, оно может представлять как положительные, так и отрицательные числа. Параметр isSigned применяется только к типу сигнала INTEGER raw, и он не влияет на тип сигнала FLOATING_POINT raw. Значение по умолчанию — false.

signalValueType -> (строка)

Тип значения сигнала. Значение по умолчанию — INTEGER .

messageSignal -> (структура)

Информация о декодировании определенного сообщения, которое поддерживает типы данных высшего порядка.

topicName -> (строка)

Имя темы для сигнала сообщения. Оно соответствует темам в ROS 2.

structuredMessage -> (структура помеченного объединения)

Структурированное сообщение для сигнала сообщения. Оно может быть определено с помощью primitiveMessageDefinition, structuredMessageListDefinition или structuredMessageDefinition рекурсивно.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition.

primitiveMessageDefinition -> (структура помеченного объединения)

Представляет узел примитивного типа сложной структуры данных.

Примечание

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

ros2PrimitiveMessageDefinition -> (структура)

Информация о PrimitiveMessage, используя сообщение примитивного типа ROS 2 совместимой сложной структуры данных.

primitiveType -> (строка)

Примитивный тип (целое число, число с плавающей запятой, булево и т. д.) для определения сообщения ROS 2 примитивного типа.

offset -> (двойное число)

Смещение, используемое для вычисления значения сигнала. В сочетании со масштабированием, вычисление — это value = raw_value * scaling + offset .

scaling -> (двойное число)

Множитель, используемый для декодирования сообщения.

upperBound -> (длинное целое число)

Необязательный атрибут, определяющий верхнюю границу для STRING и WSTRING .

structuredMessageListDefinition -> (структура)

Представляет узел типа списка сложной структуры данных.

name -> (строка)

Имя определения списка структурированных сообщений.

memberType -> (структура помеченного объединения)

Тип члена определения списка структурированных сообщений.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition.

primitiveMessageDefinition -> (структура помеченного объединения)

Представляет узел примитивного типа сложной структуры данных.

Примечание

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

ros2PrimitiveMessageDefinition -> (структура)

Информация о PrimitiveMessage, используя сообщение примитивного типа ROS 2 совместимой сложной структуры данных.

primitiveType -> (строка)

Примитивный тип (целое число, число с плавающей запятой, булево и т. д.) для определения сообщения ROS 2 примитивного типа.

offset -> (двойное число)

Смещение, используемое для вычисления значения сигнала. В сочетании со масштабированием, вычисление — это value = raw_value * scaling + offset .

scaling -> (двойное число)

Множитель, используемый для декодирования сообщения.

upperBound -> (длинное целое число)

Необязательный атрибут, определяющий верхнюю границу для STRING и WSTRING .

structuredMessageListDefinition -> (структура)

Представляет узел типа списка сложной структуры данных.

name -> (строка)

Имя определения списка структурированных сообщений.

( … рекурсивно … )listType -> (строка)

Тип списка определения списка структурированных сообщений.

capacity -> (целое число)

Емкость определения списка структурированных сообщений, когда тип списка является FIXED_CAPACITY или DYNAMIC_BOUNDED_CAPACITY .

structuredMessageDefinition -> (список)

Представляет узел типа структуры сложной структуры данных.

(структура)

Представляет элемент отображения StructureMessageName в DataType .

fieldName -> (строка)

Имя поля структурированного сообщения. Оно определяет, как значение данных ссылается на целевой язык.

( … рекурсивно … )

listType -> (строка)

Тип списка определения списка структурированных сообщений.

capacity -> (целое число)

Емкость определения списка структурированных сообщений, когда тип списка является FIXED_CAPACITY или DYNAMIC_BOUNDED_CAPACITY .

structuredMessageDefinition -> (список)

Представляет узел типа структуры сложной структуры данных.

(структура)

Представляет элемент отображения StructureMessageName в DataType .

fieldName -> (строка)

Имя поля структурированного сообщения. Оно определяет, как значение данных ссылается на целевой язык.

dataType -> (структура помеченного объединения)

Тип данных.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: primitiveMessageDefinition, structuredMessageListDefinition, structuredMessageDefinition.

primitiveMessageDefinition -> (структура помеченного объединения)

Представляет узел примитивного типа сложной структуры данных.

Примечание

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

ros2PrimitiveMessageDefinition -> (структура)

Информация о PrimitiveMessage, используя сообщение примитивного типа ROS 2 совместимой сложной структуры данных.

primitiveType -> (строка)

Примитивный тип (целое число, число с плавающей запятой, булево и т. д.) для определения сообщения ROS 2 примитивного типа.

offset -> (двойное число)

Смещение, используемое для вычисления значения сигнала. В сочетании со масштабированием, вычисление — это value = raw_value * scaling + offset .

scaling -> (двойное число)

Множитель, используемый для декодирования сообщения.

upperBound -> (длинное целое число)

Необязательный атрибут, определяющий верхнюю границу для STRING и WSTRING .

structuredMessageListDefinition -> (структура)

Представляет узел типа списка сложной структуры данных.

name -> (строка)

Имя определения списка структурированных сообщений.

( … рекурсивно … )listType -> (строка)

Тип списка определения списка структурированных сообщений.

capacity -> (целое число)

Емкость определения списка структурированных сообщений, когда тип списка является FIXED_CAPACITY или DYNAMIC_BOUNDED_CAPACITY .

structuredMessageDefinition -> (список)

Представляет узел типа структуры сложной структуры данных.

(структура)

Представляет элемент отображения StructureMessageName в DataType .

fieldName -> (строка)

Имя поля структурированного сообщения. Оно определяет, как значение данных ссылается на целевой язык.

( … рекурсивно … )

customDecodingSignal -> (структура)

Информация о пользовательском декодере сигнала.

Предупреждение

Доступ к определенным функциям Amazon Web Services IoT FleetWise в настоящее время ограничен. Для получения дополнительной информации см. Доступность областей Amazon Web Services и функций в Руководстве разработчика Amazon Web Services IoT FleetWise.

id -> (строка)

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

nextToken -> (строка)

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

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

Spec-Zone.ru

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