Spec-Zone.ru › AWS CLI v2

[ aws . redshift ]

describe-cluster-parameter-groups

Описание

Возвращает список групп параметров Amazon Redshift, включая группы параметров, созданные вами, и параметр по умолчанию. Для каждой группы параметров в ответе содержится имя группы параметров, описание и имя семейства группы параметров. Вы можете необязательно указать имя для получения описания конкретной группы параметров.

Дополнительную информацию о параметрах и группах параметров см. в разделе «Группы параметров Amazon Redshift» в Руководстве по управлению кластерами Amazon Redshift.

Если вы укажете и ключи тегов, и значения тегов в одном запросе, Amazon Redshift возвращает все группы параметров, которые соответствуют любой комбинации указанных ключей и значений. Например, если у вас есть owner и environment в качестве ключей тегов, а admin и test в качестве значений тегов, возвращаются все группы параметров, которые имеют любую комбинацию этих значений.

Если оба ключа тегов и значения опущены из запроса, группы параметров возвращаются независимо от того, есть ли у них связанные с ними ключи или значения тегов.

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

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

Синтаксис

  describe-cluster-parameter-groups
[--parameter-group-name <value>]
[--tag-keys <value>]
[--tag-values <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]

Параметры

--parameter-group-name (строка)

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

--tag-keys (список)

Ключ или ключи тегов, для которых вы хотите вернуть все соответствующие группы параметров кластера, связанные с указанным ключом или ключами. Например, предположим, что у вас есть группы параметров, помеченные ключами owner и environment. Если вы укажете оба эти ключа тегов в запросе, Amazon Redshift возвращает ответ с группами параметров, которым назначены любой из этих ключей тегов.

(строка)

Синтаксис:

"string" "string" ...

--tag-values (список)

Значение или значения тегов, для которых вы хотите вернуть все соответствующие группы параметров кластера, связанные с указанным значением или значениями тегов. Например, предположим, что у вас есть группы параметров, помеченные значениями admin и test. Если вы укажете оба эти значения тегов в запросе, Amazon Redshift возвращает ответ с группами параметров, которым назначены любой из этих значений тегов.

(строка)

Синтаксис:

"string" "string" ...

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

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования, похожие на Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. использование кавычек со строками в Руководстве пользователя AWS CLI.

Получение описания всех групп параметров кластера

Этот пример возвращает описание всех групп параметров кластера для учетной записи с заголовками столбцов. По умолчанию вывод находится в формате JSON.

Команда:

aws redshift describe-cluster-parameter-groups

Результат:

{
   "ParameterGroups": [
      {
         "ParameterGroupFamily": "redshift-1.0",
         "Description": "My first cluster parameter group",
         "ParameterGroupName": "myclusterparametergroup"
      } ],
   "ResponseMetadata": {
      "RequestId": "8ceb8f6f-64cc-11e2-bea9-49e0ce183f07"
   }
}

Вы также можете получить ту же информацию в текстовом формате с помощью параметра --output text.

Команда:

aws redshift describe-cluster-parameter-groups --output text

Результат:

redshift-1.0        My first cluster parameter group        myclusterparametergroup
RESPONSEMETADATA    9e665a36-64cc-11e2-8f7d-3b939af52818

Вывод

Marker -> (строка)

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

ParameterGroups -> (список)

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

(структура)

Описывает группу параметров.

ParameterGroupName -> (строка)

Имя группы параметров кластера.

ParameterGroupFamily -> (строка)

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

Description -> (строка)

Описание группы параметров.

Tags -> (список)

Список тегов для группы параметров кластера.

(структура)

Тег, состоящий из пары «имя/значение» для ресурса.

Key -> (строка)

Ключ или имя тега ресурса.

Value -> (строка)

Значение тега ресурса.

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

Spec-Zone.ru

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