Spec-Zone.ru › AWS CLI v2

[ aws . redshift-data ]

describe-statement

Описание

Описывает детали конкретного момента выполнения запроса с помощью Amazon Redshift Data API. Информация включает время начала и завершения запроса, статус запроса, количество возвращенных строк и SQL-запрос.

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

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

Синтаксис

  describe-statement
--id <value>
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--id (строка)

Идентификатор SQL-запроса для описания. Это универсальный уникальный идентификатор (UUID), сгенерированный Amazon Redshift Data API. Суффикс указывает номер SQL-запроса. Например, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 имеет суффикс :2, указывающий на второй SQL-запрос в пакетном запросе. Этот идентификатор возвращается BatchExecuteStatment, ExecuteStatement и ListStatements.

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

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

Вывод

ClusterIdentifier -> (строка)

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

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

Дата и время (UTC) отправки SQL-запроса на выполнение.

Database -> (строка)

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

DbUser -> (строка)

Имя пользователя базы данных.

Duration -> (длинное целое число)

Количество времени в наносекундах, потраченное на выполнение запроса.

Error -> (строка)

Сообщение об ошибке из кластера, если SQL-запрос столкнулся с ошибкой во время выполнения.

HasResultSet -> (булево)

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

Id -> (строка)

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

QueryParameters -> (список)

Параметры для SQL-запроса.

(структура)

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

name -> (строка)

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

value -> (строка)

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

QueryString -> (строка)

Текст SQL-запроса.

RedshiftPid -> (длинное целое число)

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

RedshiftQueryId -> (длинное целое число)

Идентификатор запроса, сгенерированный Amazon Redshift. Эти идентификаторы также доступны в столбце query системной таблицы STL_QUERY.

ResultFormat -> (строка)

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

ResultRows -> (длинное целое число)

Количество возвращенных строк от SQL-запроса или количество затронутых строк. Если размер результата больше нуля, строки результата могут представлять количество строк, затронутых SQL-запросами, такими как INSERT, UPDATE, DELETE, COPY и другими. -1 указывает, что значение равно null.

ResultSize -> (длинное целое число)

Размер возвращенных результатов в байтах. -1 указывает, что значение равно null.

SecretArn -> (строка)

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

SessionId -> (строка)

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

Status -> (строка)

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

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

SubStatements -> (список)

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

(структура)

Информация о SQL-запросе.

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

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

Duration -> (длинное целое число)

Количество времени в наносекундах, потраченное на выполнение запроса.

Error -> (строка)

Сообщение об ошибке из кластера, если SQL-запрос столкнулся с ошибкой во время выполнения.

HasResultSet -> (булево)

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

Id -> (строка)

Идентификатор SQL-запроса. Это универсальный уникальный идентификатор (UUID), сгенерированный Amazon Redshift Data API. Суффикс указывает номер SQL-запроса. Например, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 имеет суффикс :2, указывающий на второй SQL-запрос в пакетном запросе.

QueryString -> (строка)

Текст SQL-запроса.

RedshiftQueryId -> (длинное целое число)

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

ResultRows -> (длинное целое число)

Количество возвращенных строк от SQL-запроса или количество затронутых строк. Если размер результата больше нуля, строки результата могут представлять количество строк, затронутых SQL-запросами, такими как INSERT, UPDATE, DELETE, COPY и другими. -1 указывает, что значение равно null.

ResultSize -> (длинное целое число)

Размер возвращенных результатов в байтах. -1 указывает, что значение равно null.

Status -> (строка)

Статус SQL-запроса. Пример - запрос завершен.

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

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

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

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

WorkgroupName -> (строка)

Имя или Amazon Resource Name (ARN) группы серверных рабочих процессов.

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

Spec-Zone.ru

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