Spec-Zone.ru › AWS CLI v2

[ aws . finspace ]

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 -> (строка)

Название среды kdb.

environmentId -> (строка)

Уникальный идентификатор среды kdb.

awsAccountId -> (строка)

Уникальный идентификатор AWS аккаунта, в котором создана среда kdb.

status -> (строка)

Статус создания среды.

  • CREATE_REQUESTED – Запрос на создание среды.
  • CREATING – Среда в процессе создания.
  • FAILED_CREATION – Создание среды не удалось.
  • CREATED – Среда успешно создана и активна.
  • DELETE REQUESTED – Запрос на удаление среды.
  • DELETING – Среда в процессе удаления.
  • RETRY_DELETION – Первоначальное удаление среды не удалось, система пытается повторно удалить.
  • DELETED – Среда удалена.
  • FAILED_DELETION – Удаление среды не удалось.

tgwStatus -> (строка)

Статус сетевой конфигурации.

dnsStatus -> (строка)

Статус конфигурации DNS.

errorMessage -> (строка)

Содержит сообщение об ошибке, если поток завершился неудачно.

description -> (строка)

Описание среды kdb.

environmentArn -> (строка)

Amazon Resource Name (ARN) вашей среды kdb.

kmsKeyId -> (строка)

Уникальный идентификатор ключа KMS.

dedicatedServiceAccountId -> (строка)

Уникальный идентификатор AWS аккаунта инфраструктуры среды.

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

Указывает транзитный шлюз и конфигурацию сети для подключения среды kdb к внутренней сети.

transitGatewayID -> (строка)

Идентификатор транзитного шлюза, созданного клиентом для подключения исходящего трафика из сети kdb к вашей внутренней сети.

routableCIDRSpace -> (строка)

CIDR-диапазон маршрутизации от имени среды kdb. Может быть любым диапазоном «/26» в пространстве CIDR 100.64.0.0. После указания он будет добавлен в таблицу маршрутизации транзитного шлюза клиента, чтобы трафик мог быть перенаправлен в сеть kdb.

attachmentNetworkAclConfiguration -> (список)

Правила, определяющие, как управлять исходящим трафиком из сети kdb в вашу внутреннюю сеть.

(структура)

Список правил списка управления доступом к сети (ACL) — это необязательный уровень безопасности для вашей VPC, который действует как брандмауэр для управления трафиком в и из одного или нескольких подсетей. Элемент содержит набор пронумерованных правил для входного и выходного трафика, определяющих, разрешен ли пакет для входа или выхода из подсети, связанной с ACL. Мы обрабатываем записи в ACL в соответствии с номерами правил в порядке возрастания.

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

Номер правила записи. Например, 100. Все записи списка ACL обрабатываются в порядке возрастания номера правила.

protocol -> (строка)

Номер протокола. Значение -1 означает все протоколы.

ruleAction -> (строка)

Указывает, разрешить или запретить трафик, соответствующий правилу.

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

Диапазон портов, на который распространяется правило.

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

Первый порт в диапазоне.

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

Последний порт в диапазоне.

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

Определяет протокол ICMP, состоящий из типа и кода ICMP.

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

Тип ICMP. Значение -1 означает все типы.

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

Код ICMP. Значение -1 означает все коды для указанного типа ICMP.

cidrBlock -> (строка)

Диапазон IPv4-сетей для разрешения или запрещения в формате CIDR. Например, 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 -> (строка)

Имя DNS-сервера.

customDNSServerIP -> (строка)

IP-адрес DNS-сервера.

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

Отметка времени создания среды kdb в FinSpace. Значение определяется как время эпохи в миллисекундах. Например, значение для понедельника, 1 ноября 2021 года, 12:00:00 по UTC указано как 1635768000000.

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

Отметка времени изменения среды kdb в FinSpace. Значение определяется как время эпохи в миллисекундах. Например, значение для понедельника, 1 ноября 2021 года, 12:00:00 по UTC указано как 1635768000000.

availabilityZoneIds -> (список)

Идентификатор доступных зон, где создаются подсети для среды.

(строка)

certificateAuthorityArn -> (строка)

Amazon Resource Name (ARN) центра сертификации:

nextToken -> (строка)

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

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

Spec-Zone.ru

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