list-kx-environments
Описание
Возвращает список созданных в учетной записи сред kdb.
См. также: Документацию API AWS
list-kx-environments является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: environments
Синтаксис
list-kx-environments
[--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]
Параметры
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения перепишут значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью JSON-предоставленного значения, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Маркер для указания места начала постраничного вывода. Это NextToken из ранее урезанного ответа.
Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS CLI.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS CLI.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS CLI.
--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
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/окружения.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- on
- off
- auto
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл с набором сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться в блокирующем режиме и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 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.
Вывод
environments -> (список)
Список сред в аккаунте.
(структура)
Подробная информация о среде kdb.
name -> (строка)
environmentId -> (строка)
awsAccountId -> (строка)
status -> (строка)
Статус создания среды.
- CREATE_REQUESTED – Запрос на создание среды.
- CREATING – Среда в процессе создания.
- FAILED_CREATION – Создание среды не удалось.
- CREATED – Среда успешно создана и активна.
- DELETE REQUESTED – Запрос на удаление среды.
- DELETING – Среда в процессе удаления.
- RETRY_DELETION – Первоначальное удаление среды не удалось, система пытается повторно удалить.
- DELETED – Среда удалена.
- FAILED_DELETION – Удаление среды не удалось.
tgwStatus -> (строка)
dnsStatus -> (строка)
errorMessage -> (строка)
description -> (строка)
environmentArn -> (строка)
kmsKeyId -> (строка)
dedicatedServiceAccountId -> (строка)
transitGatewayConfiguration -> (структура)
Указывает транзитный шлюз и конфигурацию сети для подключения среды kdb к внутренней сети.
transitGatewayID -> (строка)
routableCIDRSpace -> (строка)
attachmentNetworkAclConfiguration -> (список)
Правила, определяющие, как управлять исходящим трафиком из сети kdb в вашу внутреннюю сеть.
(структура)
Список правил списка управления доступом к сети (ACL) — это необязательный уровень безопасности для вашей VPC, который действует как брандмауэр для управления трафиком в и из одного или нескольких подсетей. Элемент содержит набор пронумерованных правил для входного и выходного трафика, определяющих, разрешен ли пакет для входа или выхода из подсети, связанной с ACL. Мы обрабатываем записи в ACL в соответствии с номерами правил в порядке возрастания.
ruleNumber -> (целое число)
protocol -> (строка)
ruleAction -> (строка)
portRange -> (структура)
Диапазон портов, на который распространяется правило.
from -> (целое число)
to -> (целое число)
icmpTypeCode -> (структура)
Определяет протокол ICMP, состоящий из типа и кода ICMP.
type -> (целое число)
code -> (целое число)
cidrBlock -> (строка)
172.16.0.0/24. Мы изменяем указанный CIDR-блок на его каноническую форму. Например, если вы укажете 100.68.0.18/18, мы изменим его на 100.68.0.0/18.customDNSConfiguration -> (список)
Список имен и IP-адресов DNS-серверов. Используется для настройки внешних разрешителей Route-53.
(структура)
Список имен и IP-адресов DNS-серверов. Используется для настройки внешних разрешителей Route-53.
customDNSServerName -> (строка)
customDNSServerIP -> (строка)
creationTimestamp -> (отметка времени)
updateTimestamp -> (отметка времени)
availabilityZoneIds -> (список)
Идентификатор доступных зон, где создаются подсети для среды.
(строка)
certificateAuthorityArn -> (строка)
nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.