Spec-Zone.ru › AWS CLI v2

[ aws . redshift-serverless ]

get-workgroup

Описание

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

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

Синтаксис

  get-workgroup
--workgroup-name <value>
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

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

Имя рабочей группы, для которой требуется информация.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята дословно. Это не может быть указано вместе с --cli-input-yaml.

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

Вывод

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

Возвращаемый объект рабочей группы.

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

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

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

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 для обработки запросов. Максимальная емкость указана в RPU.

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 доступна в документации `Versions of Amazon Redshift clusters` __ .

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

Spec-Zone.ru

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