Spec-Zone.ru › AWS CLI v2

[ aws . redshift-data ]

list-statements

Описание

Список SQL-запросов. По умолчанию отображаются только завершённые запросы. Для перехода по списку запросов возвращается маркер.

При использовании сеансов с расширенной проверкой подлинности для перечисления запросов необходимо указать параметр cluster-identifier или workgroup-name. Это гарантирует, что пользователь IdC может получить доступ только к приложениям Amazon Redshift IdC, которые ему назначены. Дополнительную информацию см. в обзоре Trusted identity propagation.

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

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

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

Синтаксис

  list-statements
[--cluster-identifier <value>]
[--database <value>]
[--role-level | --no-role-level]
[--statement-name <value>]
[--status <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 (строка)

Идентификатор кластера. Возвращаются только запросы, выполненные на этом кластере. При указании ClusterIdentifier, параметр WorkgroupName не может быть указан.

--database (строка)

Имя базы данных при перечислении запросов, выполненных против ClusterIdentifier или WorkgroupName.

--role-level | --no-role-level (булево)

Значение, которое фильтрует, какие запросы возвращать в ответе. Если true, возвращаются все запросы, выполненные ролью IAM вызывающего пользователя. Если false, возвращаются только запросы, выполненные ролью IAM вызывающего пользователя в текущем сеансе IAM. По умолчанию true.

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

Имя SQL-запроса, указанного в качестве входных данных для BatchExecuteStatement или ExecuteStatement для идентификации запроса. Вы можете перечислить несколько запросов, предоставив префикс, соответствующий началу имени запроса. Например, для перечисления myStatement1, myStatement2, myStatement3 и так далее, укажите значение myStatement. API данных выполняет чувствительный к регистру поиск имён SQL-запросов по предоставленному вами префиксу.

--status (строка)

Статус SQL-запроса для перечисления. Значения статуса определены следующим образом:

  • ABORTED - Запрос был остановлен пользователем.
  • ALL - Значение статуса, включающее все статусы запросов. Это значение может использоваться для фильтрации результатов.
  • FAILED - Запрос завершился неудачно.
  • FINISHED - Запрос завершён.
  • PICKED - Запрос выбран для выполнения.
  • STARTED - Запрос начат.
  • SUBMITTED - Запрос был отправлен, но ещё не обработан.

Возможные значения:

  • SUBMITTED
  • PICKED
  • STARTED
  • FINISHED
  • ABORTED
  • FAILED
  • ALL

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

Имя бессерверной рабочей группы или Amazon Resource Name (ARN). Возвращаются только запросы, выполненные в этой рабочей группе. При указании WorkgroupName, параметр ClusterIdentifier не может быть указан.

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

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

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно за пределами AWS CLI.

Примеры использования см. в разделе «Постраничный вывод» в руководстве пользователя AWS CLI.

--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 (int)

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

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 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 -> (строка)

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

Statements -> (список)

SQL-запросы.

(структура)

SQL-запрос для выполнения.

CreatedAt -> (временная метка)

Дата и время (UTC) создания запроса.

Id -> (строка)

Идентификатор SQL-запроса. Это значение — универсально уникальный идентификатор (UUID), сгенерированный API Amazon Redshift Data.

IsBatchStatement -> (булево)

Значение, указывающее, является ли запрос пакетным запросом.

QueryParameters -> (список)

Параметры, используемые в SQL-запросе.

(структура)

Параметр, используемый в SQL-запросе.

name -> (строка)

Имя параметра.

value -> (строка)

Значение параметра. Amazon Redshift неявно преобразует его в соответствующий тип данных. Дополнительную информацию см. в руководстве по разработке базы данных Amazon Redshift в разделе «Типы данных».

QueryString -> (строка)

SQL-запрос.

QueryStrings -> (список)

Один или несколько SQL-запросов. Каждая строка запроса в массиве соответствует одному из запросов в запросе пакетного запроса.

(строка)

ResultFormat -> (строка)

Формат данных результата SQL-запроса.

SecretArn -> (строка)

Имя или Amazon Resource Name (ARN) секрета, который обеспечивает доступ к базе данных.

SessionId -> (строка)

Идентификатор сеанса запроса.

StatementName -> (строка)

Имя SQL-запроса.

Status -> (строка)

Статус SQL-запроса. Например, что SQL-запрос завершён.

UpdatedAt -> (временная метка)

Дата и время (UTC) последнего обновления метаданных запроса.

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

Spec-Zone.ru

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