[ aws . redshift-data ]
list-schemas
Описание
Отображает схемы в базе данных. Возвращается маркер для перехода к следующей странице списка схем. В зависимости от метода авторизации используйте одну из следующих комбинаций параметров запроса:
- 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.
- При подключении к серверной группе без состояния укажите имя группы без состояния и имя базы данных. Имя пользователя базы данных определяется по идентификатору IAM. Например,
Дополнительную информацию об API Amazon Redshift Data и примерах использования командной строки см. в разделе Использование API Amazon Redshift Data в руководстве Amazon Redshift Management Guide.
См. также: Документация API AWS
list-schemas — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом аргумент --query должен извлекать данные из результатов следующих выражений запросов: Schemas
Синтаксис
list-schemas
[--cluster-identifier <value>]
[--connected-database <value>]
--database <value>
[--db-user <value>]
[--schema-pattern <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 (строка)
--connected-database (строка)
--database (строка)
ConnectedDatabase не указан, это также база данных для подключения с помощью ваших учетных данных для аутентификации.--db-user (строка)
--schema-pattern (строка)
--secret-arn (строка)
--workgroup-name (строка)
--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 -> (строка)
Schemas -> (список)
Схемы, соответствующие шаблону запроса.
(строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.