Spec-Zone.ru › AWS CLI v2

[ aws . iotsitewise ]

list-asset-properties

Описание

Получает постраничный список свойств, связанных с активом. Если вы обновите свойства, связанные с моделью, прежде чем закончите перечисление всех свойств, вам нужно начать сначала.

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

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

Синтаксис

  list-asset-properties
--asset-id <value>
[--filter <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]

Параметры

--asset-id (строка)

ID актива. Это может быть фактический ID в формате UUID, или же externalId:, за которым следует внешний ID, если он есть. Дополнительную информацию см. в разделе «Ссылка на объекты с внешними ID» в Руководстве пользователя IoT SiteWise.

--filter (строка)

Фильтрует запрашиваемый список свойств актива. Вы можете выбрать один из следующих вариантов:

  • ALL — список включает все свойства актива для данного ID модели актива.
  • BASE — список включает только базовые свойства актива для данного ID модели актива.

По умолчанию: BASE

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

  • ALL
  • BASE

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

Вывод

assetPropertySummaries -> (список)

Список, обобщающий свойства, связанные с указанным активом.

(структура)

Содержит сводку свойства, связанного с активом.

id -> (строка)

ID свойства.

alias -> (строка)

Псевдоним, определяющий свойство, например, путь потока данных сервера OPC-UA (например, /company/windfarm/3/turbine/7/temperature). Дополнительную информацию см. в разделе «Сопоставление промышленных потоков данных с свойствами актива» в Руководстве пользователя IoT SiteWise.

unit -> (строка)

Единица измерения (например, Ньютоны или об/мин) свойства актива.

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

Содержит информацию о уведомлении о значении свойства актива. Когда состояние уведомления включено, IoT SiteWise публикует обновления значения свойства в уникальной MQTT-теме. Дополнительную информацию см. в разделе «Взаимодействие с другими сервисами» в Руководстве пользователя IoT SiteWise.

topic -> (строка)

MQTT-тема, в которую IoT SiteWise публикует уведомления об обновлениях значения свойства.

state -> (строка)

Текущее состояние уведомления.

assetCompositeModelId -> (строка)

ID составной модели, содержащей свойство актива.

path -> (список)

Структурированный путь к свойству от корня актива.

(структура)

Представляет один уровень между свойством и корнем актива.

id -> (строка)

ID сегмента пути.

name -> (строка)

Имя сегмента пути.

externalId -> (строка)

Внешний ID свойства. Дополнительную информацию см. в разделе «Использование внешних ID» в Руководстве пользователя IoT SiteWise.

nextToken -> (строка)

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

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

Spec-Zone.ru

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