list-tables

Описание

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

• 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 и примерах использования командной строки см. в разделе «Использование API Amazon Redshift Data» в руководстве по администрированию Amazon Redshift.

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

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

Синтаксис

  list-tables
[--cluster-identifier <value>]
[--connected-database <value>]
--database <value>
[--db-user <value>]
[--schema-pattern <value>]
[--secret-arn <value>]
[--table-pattern <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 (строка)

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

--schema-pattern (строка)

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

--table-pattern (строка)

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

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

--starting-token (строка)

--page-size (целое число)

--max-items (целое число)

--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, чтение сокета будет выполняться блокирующим образом и не будет ожидать истечения времени.

--cli-connect-timeout (целое число)

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

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

Tables -> (список)