Spec-Zone.ru › AWS CLI v2

[ aws . supplychain ]

list-instances

Описание

Список всех экземпляров Amazon Web Services Supply Chain для конкретного аккаунта. Позволяет программно перечислить все экземпляры Amazon Web Services Supply Chain на основе их идентификатора аккаунта, имени экземпляра и состояния экземпляра (активный или удалённый).

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

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

Синтаксис

  list-instances
[--instance-name-filter <value>]
[--instance-state-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]

Параметры

--instance-name-filter (список)

Фильтр для ListInstances на основе их имён.

(строка)

Синтаксис:

"string" "string" ...

--instance-state-filter (список)

Фильтр для ListInstances на основе их состояния.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  Initializing
  Active
  CreateFailed
  DeleteFailed
  Deleting
  Deleted

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

Вывод

экземпляры -> (список)

Список деталей ресурсов данных экземпляров.

(структура)

Подробности экземпляра.

instanceId -> (строка)

Идентификатор экземпляра Amazon Web Services Supply Chain.

awsAccountId -> (строка)

Идентификатор учетной записи Amazon Web Services, которой принадлежит экземпляр.

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

Состояние экземпляра.

errorMessage -> (строка)

Сообщение об ошибке экземпляра Amazon Web Services Supply Chain. Если экземпляр имеет нездоровое состояние, пользователи должны проверить сообщение об ошибке, удалить текущий экземпляр и создать новый на основе устранения неполадок из сообщения об ошибке.

webAppDnsDomain -> (строка)

Имя домена DNS WebApp экземпляра.

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

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

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

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

instanceName -> (строка)

Имя экземпляра Amazon Web Services Supply Chain.

instanceDescription -> (строка)

Описание экземпляра Amazon Web Services Supply Chain.

kmsKeyArn -> (строка)

ARN (Amazon Resource Name) ключа службы управления ключами (KMS), который вы необязательно предоставили для шифрования. Если вы ничего не предоставили, AWS Supply Chain использует ключ KMS, принадлежащий Amazon Web Services, и ничего не возвращается.

versionNumber -> (двойное число)

Номер версии экземпляра.

nextToken -> (строка)

Токен постраничной загрузки для получения следующей страницы экземпляров.

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

Spec-Zone.ru

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