Spec-Zone.ru › AWS CLI v2

[ aws . redshift-серверлесс ]

list-workgroups

Описание

Возвращает информацию о списке указанных рабочих групп.

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

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

Синтаксис

  list-workgroups
[--owner-account <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]

Параметры

--owner-account (строка)

Владелец учетной записи Amazon Web Services для рабочей группы Amazon Redshift Serverless.

--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.

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

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

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

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

Вывод

nextToken -> (строка)

Если возвращается nextToken, доступно больше результатов. Значение nextToken — это уникальный токен постраничной навигации для каждой страницы. Чтобы получить следующую страницу, снова выполните вызов с возвращенным токеном.

workgroups -> (список)

Возвращаемый массив рабочих групп.

(структура)

Коллекция вычислительных ресурсов, из которых создается конечная точка.

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

Базовая емкость хранилища данных рабочей группы в Redshift Processing Units (RPUs).

configParameters -> (список)

Массив параметров для настройки расширенного управления базой данных. Доступные параметры: auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl и метрики мониторинга запросов, которые позволяют определять граничные значения производительности. Дополнительную информацию о правилах мониторинга запросов и доступных метриках см. в разделе Метрики мониторинга запросов для Amazon Redshift Serverless.

(структура)

Массив пар ключ-значение для настройки расширенного управления Amazon Redshift Serverless.

parameterKey -> (строка)

Ключ параметра. Доступные параметры: auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl и метрики мониторинга запросов, которые позволяют определять граничные значения производительности. Дополнительную информацию о правилах мониторинга запросов и доступных метриках см. в разделе Метрики мониторинга запросов для Amazon Redshift Serverless.

parameterValue -> (строка)

Значение настраиваемого параметра.

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

Дата создания рабочей группы.

crossAccountVpcs -> (список)

Список VPC. Каждый элемент — уникальный идентификатор виртуальной частной облачной сети с доступом к Amazon Redshift Serverless. Если все VPC для уполномоченного лица разрешены, отображается звездочка.

(строка)

customDomainCertificateArn -> (строка)

Amazon Resource Name (ARN) сертификата настраиваемого доменного имени.

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

Дата истечения срока действия сертификата.

customDomainName -> (строка)

Настраиваемое доменное имя, связанное с рабочей группой.

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

Конечная точка, созданная из рабочей группы.

address -> (строка)

DNS-адрес VPC-конечной точки.

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

Порт, на котором Amazon Redshift Serverless прослушивает соединения.

vpcEndpoints -> (список)

Массив объектов VpcEndpoint.

(структура)

Конечная точка подключения к Amazon Redshift Serverless через прокси.

networkInterfaces -> (список)

Один или несколько сетевых интерфейсов конечной точки. Также известны как интерфейсные конечные точки.

(структура)

Содержит информацию о сетевом интерфейсе в управляемой VPC-конечной точке Amazon Redshift Serverless.

availabilityZone -> (строка)

Зона доступности.

ipv6Address -> (строка)

IPv6-адрес сетевого интерфейса в подсети.

networkInterfaceId -> (строка)

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

privateIpAddress -> (строка)

IPv4-адрес сетевого интерфейса в подсети.

subnetId -> (строка)

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

vpcEndpointId -> (строка)

Идентификатор конечной точки подключения к Amazon Redshift Serverless.

vpcId -> (строка)

Идентификатор VPC, с которым связана конечная точка.

enhancedVpcRouting -> (булево)

Значение, указывающее, нужно ли включить расширенное маршрутизацию VPC, что заставляет Amazon Redshift Serverless маршрутизировать трафик через вашу VPC.

ipAddressType -> (строка)

Тип IP-адреса, поддерживаемый рабочей группой. Возможные значения: ipv4 и dualstack.

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

Максимальная емкость хранилища данных, которую Amazon Redshift Serverless использует для обработки запросов. Максимальная емкость указана в RPUs.

namespaceName -> (строка)

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

patchVersion -> (строка)

Версия исправления вашей рабочей группы Amazon Redshift Serverless. Дополнительную информацию о версиях исправления см. в разделе Версии кластеров для Amazon Redshift.

pendingTrackName -> (строка)

Имя трека, которое вы хотите назначить рабочей группе. При изменении трека рабочая группа переключается на последнюю версию рабочей группы, доступную для трека. На этом этапе имя трека применяется.

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

Настраиваемый порт для подключения к рабочей группе. Допустимый диапазон портов — 5431-5455 и 8191-8215. По умолчанию используется 5439.

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

Объект, представляющий параметры целевого соотношения цены и производительности для рабочей группы.

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

Целевой уровень соотношения цены и производительности для рабочей группы. Допустимые значения: 1, 25, 50, 75 и 100. Они соответствуют уровням соотношения цены и производительности LOW_COST, ECONOMICAL, BALANCED, RESOURCEFUL и HIGH_PERFORMANCE.

status -> (строка)

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

publiclyAccessible -> (булево)

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

securityGroupIds -> (список)

Массив идентификаторов групп безопасности для ассоциации с рабочей группой.

(строка)

status -> (строка)

Статус рабочей группы.

subnetIds -> (список)

Массив идентификаторов подсетей, с которыми связана рабочая группа.

(строка)

trackName -> (строка)

Имя трека для рабочей группы.

workgroupArn -> (строка)

Amazon Resource Name (ARN), связанный с рабочей группой.

workgroupId -> (строка)

Уникальный идентификатор рабочей группы.

workgroupName -> (строка)

Имя рабочей группы.

workgroupVersion -> (строка)

Версия Amazon Redshift Serverless вашей рабочей группы. Дополнительную информацию о версиях Amazon Redshift Serverless см. в разделе `Версии кластеров для Amazon Redshift <https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html>`__.

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

Spec-Zone.ru

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