Spec-Zone.ru › AWS CLI v2

[ aws . iotfleetwise ]

list-vehicles

Описание

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

Примечание

Данный API-запрос использует пагинацию. Укажите параметр nextToken в запросе, чтобы получить больше результатов.

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

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

Синтаксис

  list-vehicles
[--model-manifest-arn <value>]
[--attribute-names <value>]
[--attribute-values <value>]
[--list-response-scope <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]

Параметры

--model-manifest-arn (строка)

Amazon Resource Name (ARN) модели транспортного средства (манифеста модели). Вы можете использовать этот необязательный параметр, чтобы отобразить только транспортные средства, созданные по определенной модели транспортного средства.

--attribute-names (список)

Полные имена атрибутов. Вы можете использовать этот необязательный параметр, чтобы отобразить транспортные средства, содержащие все атрибуты в запросе. Например, attributeNames может быть “Vehicle.Body.Engine.Type, Vehicle.Color”, а соответствующий attributeValues — “1.3 L R2, Blue”. В этом случае API отфильтрует транспортные средства с именем атрибута Vehicle.Body.Engine.Type, содержащим значение 1.3 L R2 И именем атрибута Vehicle.Color, содержащим значение “Blue”. Запрос должен содержать уникальные значения для фильтра attributeNames и соответствующее количество фильтров attributeValues, чтобы вернуть подмножество транспортных средств, соответствующих условию фильтрации атрибутов.

(строка)

Синтаксис:

"string" "string" ...

--attribute-values (список)

Статическая информация о значении атрибута транспортного средства в строковом формате. Вы можете использовать этот необязательный параметр совместно с attributeNames, чтобы отобразить транспортные средства, содержащие все значения атрибутов, соответствующие фильтру attributeNames. Например, attributeValues может быть “1.3 L R2, Blue”, а соответствующий фильтр attributeNames — “Vehicle.Body.Engine.Type, Vehicle.Color”. В этом случае API отфильтрует транспортные средства с именем атрибута Vehicle.Body.Engine.Type, содержащим значение 1.3 L R2 И именем атрибута Vehicle.Color, содержащим значение “Blue”. Запрос должен содержать уникальные значения для фильтра attributeNames и соответствующее количество фильтров attributeValues, чтобы вернуть подмножество транспортных средств, соответствующих условию фильтрации атрибутов.

(строка)

Синтаксис:

"string" "string" ...

--list-response-scope (строка)

При установке параметра listResponseScope в значение METADATA_ONLY, ответ списка включает: имя транспортного средства, Amazon Resource Name (ARN), время создания и последнее время изменения.

Возможные значения:

  • METADATA_ONLY

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

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

Токен, указывающий, где начать пагинацию. Это значение NextToken из ранее усечённого ответа.

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

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

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

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

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

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

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

--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
  • table
  • yaml
  • yaml-stream

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

Вывод

vehicleSummaries -> (список)

Список транспортных средств и информации о них.

(структура)

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

Чтобы получить эту информацию о транспортных средствах в вашей учётной записи, вы можете использовать API-операцию.

vehicleName -> (строка)

Уникальный идентификатор транспортного средства.

arn -> (строка)

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

modelManifestArn -> (строка)

ARN модели транспортного средства (манифеста модели), связанной с транспортным средством.

decoderManifestArn -> (строка)

ARN манифеста декодера, связанного с транспортным средством.

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

Время создания транспортного средства в секундах с момента эпохи (00:00:00 1 января 1970 UTC).

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

Время последнего обновления транспортного средства в секундах с момента эпохи (00:00:00 1 января 1970 UTC).

attributes -> (карта)

Статическая информация о транспортном средстве в формате ключ-значение. Например:

"engineType" : "1.3 L R2"

ключ -> (строка)

значение -> (строка)

nextToken -> (строка)

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

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

Spec-Zone.ru

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