Spec-Zone.ru › AWS CLI v2

[ aws . redshift-data ]

list-databases

Описание

Список баз данных в кластере. Возвращается маркер для перехода по списку баз данных. В зависимости от метода авторизации используйте одну из следующих комбинаций параметров запроса:

  • Secrets Manager - при подключении к кластеру укажите secret-arn секрета, хранящегося в Secrets Manager, который имеет username и password. Указанный секрет содержит учетные данные для подключения к database, который вы указываете. При подключении к кластеру вы также указываете имя базы данных. Если вы предоставляете идентификатор кластера (dbClusterIdentifier), он должен соответствовать идентификатору кластера, хранящемуся в секрете. При подключении к бессерверной рабочей группе вы также указываете имя базы данных.
  • Временные учетные данные - при подключении к хранилищу данных выберите один из следующих вариантов:
    • При подключении к бессерверной рабочей группе укажите имя рабочей группы и имя базы данных. Имя пользователя базы данных определяется по идентификатору IAM. Например, arn:iam::123456789012:user:foo имеет имя пользователя базы данных IAM:foo. Также требуется разрешение на вызов операции redshift-serverless:GetCredentials.
    • При подключении к кластеру как идентификатору IAM укажите идентификатор кластера и имя базы данных. Имя пользователя базы данных определяется по идентификатору IAM. Например, arn:iam::123456789012:user:foo имеет имя пользователя базы данных IAM:foo. Также требуется разрешение на вызов операции redshift:GetClusterCredentialsWithIAM.
    • При подключении к кластеру как пользователю базы данных укажите идентификатор кластера, имя базы данных и имя пользователя базы данных. Также требуется разрешение на вызов операции redshift:GetClusterCredentials.

Дополнительную информацию об API Amazon Redshift Data и примерах использования командной строки см. в разделе Использование Amazon Redshift Data API в руководстве Amazon Redshift Management Guide .

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

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

Синтаксис

  list-databases
[--cluster-identifier <value>]
--database <value>
[--db-user <value>]
[--secret-arn <value>]
[--workgroup-name <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]

Параметры

--cluster-identifier (строка)

Идентификатор кластера. Этот параметр требуется при подключении к кластеру и аутентификации с помощью Secrets Manager или временных учетных данных.

--database (строка)

Имя базы данных. Этот параметр требуется при аутентификации с помощью Secrets Manager или временных учетных данных.

--db-user (строка)

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

--secret-arn (строка)

Имя или ARN секрета, предоставляющего доступ к базе данных. Этот параметр требуется при аутентификации с помощью Secrets Manager.

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

Имя бессерверной рабочей группы или Amazon Resource Name (ARN). Этот параметр требуется при подключении к бессерверной рабочей группе и аутентификации с помощью Secrets Manager или временных учетных данных.

--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. Если предоставлено значение null или строка 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-auto-prompt (булево)

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

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

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

Вывод

Базы данных -> (список)

Имена баз данных.

(строка)

NextToken -> (строка)

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

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

Spec-Zone.ru

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