Spec-Zone.ru › AWS CLI v2

[ aws . iottwinmaker ]

list-component-types

Описание

Выводит все типы компонентов в рабочем пространстве.

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

Синтаксис

  list-component-types
--workspace-id <value>
[--filters <value>]
[--next-token <value>]
[--max-results <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 (список)

Список объектов, фильтрующих запрос.

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

Объект, фильтрующий элементы в списке типов компонентов.

Примечание

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

Примечание

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

extendsFrom -> (строка)

Тип компонента, от которого наследуются типы компонентов в списке.

namespace -> (строка)

Пространство имён, к которому относятся типы компонентов в списке.

isAbstract -> (булево)

Булево значение, определяющее, являются ли типы компонентов в списке абстрактными.

Сокращённый синтаксис:

extendsFrom=string,namespace=string,isAbstract=boolean ...

Синтаксис JSON:

[
  {
    "extendsFrom": "string",
    "namespace": "string",
    "isAbstract": true|false
  }
  ...
]

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

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

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

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

Допустимый диапазон: от 1 до 250.

--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-auto-prompt (булево)

Автоматически запрашивать параметры входных данных CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическую запрос параметров входных данных CLI.

Вывод

workspaceId -> (строка)

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

componentTypeSummaries -> (список)

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

(структура)

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

arn -> (строка)

ARN типа компонента.

componentTypeId -> (строка)

Идентификатор типа компонента.

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

Дата и время создания типа компонента.

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

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

description -> (строка)

Описание типа компонента.

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

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

state -> (строка)

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

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

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

code -> (строка)

Код ошибки.

message -> (строка)

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

componentTypeName -> (строка)

Имя типа компонента.

nextToken -> (строка)

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

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

Указывает максимальное количество результатов для отображения.

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

Spec-Zone.ru

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