Spec-Zone.ru › AWS CLI v2

[ aws . iottwinmaker ]

list-entities

Описание

Выводит все сущности в рабочей области.

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

Синтаксис

  list-entities
--workspace-id <value>
[--filters <value>]
[--max-results <value>]
[--next-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]

Параметры

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

Идентификатор рабочей области.

--filters (список)

Список объектов для фильтрации запроса.

Примечание

Принимается только один объект.

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

Объект для фильтрации элементов в списке сущностей.

Примечание

Это структура помеченного объединения. Можно установить только один из следующих ключевых слов верхнего уровня: parentEntityId, componentTypeId, externalId.

parentEntityId -> (строка)

Родитель сущностей в списке.

componentTypeId -> (строка)

Идентификатор типа компонента в сущностях списка.

externalId -> (строка)

Свойство external-Id компонента. Свойство external-Id — это первичный ключ внешней системы хранения.

Краткая запись:

parentEntityId=string,componentTypeId=string,externalId=string ...

Синтаксис JSON:

[
  {
    "parentEntityId": "string",
    "componentTypeId": "string",
    "externalId": "string"
  }
  ...
]

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

Максимальное количество результатов, возвращаемых за один раз. По умолчанию 25.

Допустимый диапазон: Минимальное значение 1. Максимальное значение 250.

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

Вывод

entitySummaries -> (список)

Список объектов, содержащих информацию о сущностях.

(структура)

Объект, содержащий информацию о сущности.

entityId -> (строка)

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

entityName -> (строка)

Имя сущности.

arn -> (строка)

ARN сущности.

parentEntityId -> (строка)

Идентификатор родительской сущности.

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

Текущее состояние сущности.

state -> (строка)

Текущее состояние сущности, компонента, типа компонента или рабочей области.

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

Сообщение об ошибке.

code -> (строка)

Код ошибки.

message -> (строка)

Сообщение об ошибке.

description -> (строка)

Описание сущности.

hasChildEntities -> (логическое значение)

В конечном итоге логическое значение, указывающее, есть ли у сущности дочерние сущности.

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

Дата и время создания сущности.

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

Последняя дата и время обновления сущности.

nextToken -> (строка)

Строка, определяющая следующую страницу результатов.

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

Spec-Zone.ru

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