Spec-Zone.ru › AWS CLI v2

[ aws . proton ]

list-components

Описание

Список компонентов с краткими данными. Вы можете отфильтровать список результатов по среде, сервису или отдельной инстанции сервиса.

Дополнительную информацию о компонентах см. в руководстве пользователя Proton в разделе «Компоненты Proton».

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

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

Синтаксис

  list-components
[--environment-name <value>]
[--service-instance-name <value>]
[--service-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]

Параметры

--environment-name (строка)

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

--service-instance-name (строка)

Имя инстанции сервиса для фильтрации списка результатов. Proton возвращает компонент, подключенный к инстанции сервиса, если таковой имеется.

--service-name (строка)

Имя сервиса для фильтрации списка результатов. Proton возвращает компоненты, подключенные к инстанциям сервисов данного сервиса.

--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
  • таблица
  • 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.

Вывод

components -> (список)

Массив компонентов с краткими данными.

(структура)

Сводные данные ресурса компонента Proton.

Дополнительную информацию о компонентах см. в руководстве пользователя Proton в разделе «Компоненты Proton».

arn -> (строка)

Amazon Resource Name (ARN) компонента.

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

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

deploymentStatus -> (строка)

Статус развертывания компонента.

deploymentStatusMessage -> (строка)

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

environmentName -> (строка)

Имя среды Proton, с которой связан этот компонент.

lastAttemptedDeploymentId -> (строка)

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

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

Время последней попытки развертывания компонента.

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

Время последнего успешного развертывания компонента.

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

Время последнего изменения компонента.

lastSucceededDeploymentId -> (строка)

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

name -> (строка)

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

serviceInstanceName -> (строка)

Имя инстанции сервиса, к которой подключен этот компонент. Предоставляется при подключении компонента к инстанции сервиса.

serviceName -> (строка)

Имя сервиса, с которым serviceInstanceName связан. Предоставляется при подключении компонента к инстанции сервиса.

nextToken -> (строка)

Маркер, который указывает расположение следующего компонента в массиве компонентов после текущего запрошенного списка компонентов.

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

Spec-Zone.ru

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