describe-table

Описание

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

• 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 «Использование API Amazon Redshift Data».

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

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

Синтаксис

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

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

--table (строка)

--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
• text
• table
• yaml
• yaml-stream

--query (строка)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет параметры конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

• on
• off
• auto

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

Вывод

ColumnList -> (список)

NextToken -> (строка)

TableName -> (строка)