Spec-Zone.ru › AWS CLI v2

[ aws . athena ]

get-query-execution

Описание

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

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

Синтаксис

  get-query-execution
--query-execution-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]

Параметры

--query-execution-id (строка)

Уникальный идентификатор выполнения запроса.

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. использование кавычек со строками в руководстве пользователя AWS CLI .

Чтобы вернуть информацию об выполнении запроса

Следующий get-query-execution пример возвращает информацию о запросе, у которого указан идентификатор запроса.

aws athena get-query-execution \
    --query-execution-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Вывод:

{
    "QueryExecution": {
        "QueryExecutionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "Query": "select date, location, browser, uri, status from cloudfront_logs where method = 'GET
' and status = 200 and location like 'SFO%' limit 10",
        "StatementType": "DML",
        "ResultConfiguration": {
            "OutputLocation": "s3://amzn-s3-demo-bucket/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.csv"
        },
        "QueryExecutionContext": {
            "Database": "mydatabase",
            "Catalog": "awsdatacatalog"
        },
        "Status": {
            "State": "SUCCEEDED",
            "SubmissionDateTime": 1593469842.665,
            "CompletionDateTime": 1593469846.486
        },
        "Statistics": {
            "EngineExecutionTimeInMillis": 3600,
            "DataScannedInBytes": 203089,
            "TotalExecutionTimeInMillis": 3821,
            "QueryQueueTimeInMillis": 267,
            "QueryPlanningTimeInMillis": 1175
        },
        "WorkGroup": "AthenaAdmin"
    }
}

Для получения дополнительной информации см. Выполнение SQL-запросов с помощью Amazon Athena в руководстве пользователя Amazon Athena.

Вывод

QueryExecution -> (структура)

Информация об исполнении запроса.

QueryExecutionId -> (строка)

Уникальный идентификатор каждого выполнения запроса.

Query -> (строка)

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

StatementType -> (строка)

Тип SQL-запроса, который выполнялся. DDL указывает на запросы DDL. DML указывает на запросы DML (язык манипулирования данными), такие как CREATE TABLE AS SELECT . UTILITY указывает на запросы, отличные от DDL и DML, такие как SHOW CREATE TABLE , EXPLAIN , DESCRIBE или SHOW TABLES .

ResultConfiguration -> (структура)

Расположение в Amazon S3, где хранятся результаты запросов и вычислений, а также выбранный (при необходимости) метод шифрования результатов. Это параметры на стороне клиента. Если параметры рабочей группы переопределяют параметры клиента, запрос использует расположение и конфигурацию шифрования, указанные для рабочей группы.

OutputLocation -> (строка)

Расположение в Amazon S3, где хранятся результаты вашего запроса и вычислений, например, s3://path/to/query/bucket/ . Для выполнения запроса необходимо указать расположение результатов запроса одним из способов: либо для отдельных запросов с помощью этого параметра (на стороне клиента), либо в рабочей группе с помощью WorkGroupConfiguration. Если ни один из способов не указан, Athena выдаст ошибку о том, что расположение вывода не указано. Если параметры рабочей группы переопределяют параметры клиента, запрос использует параметры, указанные для рабочей группы. См. WorkGroupConfiguration$EnforceWorkGroupConfiguration.

EncryptionConfiguration -> (структура)

Если результаты запросов и вычислений зашифрованы в Amazon S3, указывается выбранный метод шифрования (например, SSE_KMS или CSE_KMS ) и информация о ключе. Это параметр на стороне клиента. Если параметры рабочей группы переопределяют параметры клиента, запрос использует конфигурацию шифрования, указанную для рабочей группы, а также расположение для хранения результатов запроса, указанное в рабочей группе. См. WorkGroupConfiguration$EnforceWorkGroupConfiguration и Переопределение параметров клиента параметрами рабочей группы.

EncryptionOption -> (строка)

Указывает, используется ли шифрование на сервере Amazon S3 с ключами Amazon S3 (SSE_S3), шифрование на сервере с ключами KMS (SSE_KMS) или клиентское шифрование с ключами KMS (CSE_KMS).

Если запрос выполняется в рабочей группе, и рабочая группа переопределяет параметры клиента, используется параметр шифрования рабочей группы. Он определяет, должны ли результаты запроса шифроваться для всех запросов, выполняемых в этой рабочей группе.

KmsKey -> (строка)

Для SSE_KMS и CSE_KMS это ARN или ID ключа KMS.

ExpectedBucketOwner -> (строка)

Идентификатор учетной записи Amazon Web Services, который вы ожидаете как владельца ведра Amazon S3, указанного в ResultConfiguration$OutputLocation. Если установлено, Athena использует это значение для ExpectedBucketOwner при выполнении вызовов Amazon S3 в указанное вами расположение вывода. Если идентификатор учетной записи Amazon Web Services ExpectedBucketOwner не соответствует фактическому владельцу ведра Amazon S3, вызов завершается ошибкой доступа.

Это параметр на стороне клиента. Если параметры рабочей группы переопределяют параметры клиента, запрос использует параметр ExpectedBucketOwner, указанный для рабочей группы, и также использует расположение для хранения результатов запроса, указанное в рабочей группе. См. WorkGroupConfiguration$EnforceWorkGroupConfiguration и Переопределение параметров клиента параметрами рабочей группы.

AclConfiguration -> (структура)

Указывает, что для управления правами собственности на сохраненные результаты запросов должна быть установлена стандартная настройка ACL Amazon S3. В настоящее время единственная поддерживаемая стандартная настройка ACL — BUCKET_OWNER_FULL_CONTROL. Это параметр на стороне клиента. Если параметры рабочей группы переопределяют параметры клиента, запрос использует конфигурацию ACL, указанную для рабочей группы, а также расположение для хранения результатов запроса, указанное в рабочей группе. Более подробная информация в WorkGroupConfiguration$EnforceWorkGroupConfiguration и Переопределение параметров клиента параметрами рабочей группы.

S3AclOption -> (строка)

Стандартная настройка ACL Amazon S3, которую Athena должна указать при сохранении результатов запроса, включая файлы данных, вставленные Athena в результате запросов, таких как CTAS или INSERT INTO. В настоящее время единственная поддерживаемая стандартная настройка ACL — BUCKET_OWNER_FULL_CONTROL. Если запрос выполняется в рабочей группе, и рабочая группа переопределяет параметры клиента, стандартная настройка ACL Amazon S3, указанная в параметрах рабочей группы, используется для всех запросов, выполняемых в рабочей группе. Дополнительную информацию о стандартных настройках ACL Amazon S3 см. в разделе Стандартные настройки ACL в Руководстве пользователя Amazon S3.

ResultReuseConfiguration -> (структура)

Указывает поведение повторного использования результатов запроса, которое использовалось для запроса.

ResultReuseByAgeConfiguration -> (структура)

Указывает, повторно используются ли предыдущие результаты запроса и, если это так, их максимальный срок действия.

Enabled -> (булево)

Истина, если предыдущие результаты запроса могут быть повторно использованы при выполнении запроса; ложь в противном случае. По умолчанию ложь.

MaxAgeInMinutes -> (целое число)

Указывает максимальный срок действия предыдущих результатов запроса, который Athena должна учитывать для повторного использования, в минутах. По умолчанию 60.

QueryExecutionContext -> (структура)

База данных, в которой произошло выполнение запроса.

Database -> (строка)

Имя базы данных, используемой при выполнении запроса. База данных должна существовать в каталоге.

Catalog -> (строка)

Имя каталога данных, используемого при выполнении запроса.

Status -> (структура)

Дата завершения, текущее состояние, время отправки и причина изменения состояния (при необходимости) для выполнения запроса.

State -> (строка)

Состояние выполнения запроса. QUEUED указывает, что запрос отправлен в службу, и Athena выполнит запрос как только станут доступны ресурсы. RUNNING указывает, что запрос находится на стадии выполнения. SUCCEEDED указывает, что запрос завершен без ошибок. FAILED указывает, что запрос столкнулся с ошибкой и не завершил обработку. CANCELLED указывает, что пользователь прервал выполнение запроса.

Примечание

Athena автоматически повторно пытается выполнить запросы в случае определенных временных ошибок. В результате вы можете увидеть переход состояния запроса из RUNNING или FAILED в QUEUED.

StateChangeReason -> (строка)

Дополнительные сведения о статусе запроса.

SubmissionDateTime -> (метка времени)

Дата и время отправки запроса.

CompletionDateTime -> (метка времени)

Дата и время завершения запроса.

AthenaError -> (структура)

Предоставляет информацию об ошибке запроса Athena.

ErrorCategory -> (целое число)

Целое число, указывающее категорию ошибки сбоя запроса. Следующий список показывает категорию для каждого целого значения.

1 - Система

2 - Пользователь

3 - Другое

ErrorType -> (целое число)

Целое число, предоставляющее конкретную информацию об ошибке запроса Athena. Для значения конкретных значений см. Справочник по типам ошибок в Руководстве пользователя Amazon Athena.

Retryable -> (булево)

Истина, если запрос может быть успешно повторен.

ErrorMessage -> (строка)

Содержит краткое описание произошедшей ошибки.

Statistics -> (структура)

Статистические данные выполнения запроса, такие как объем просканированных данных, время выполнения запроса и тип выполненного запроса.

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

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

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

Количество байтов просканированных данных.

DataManifestLocation -> (строка)

Расположение и имя файла манифеста данных. Файл манифеста сохраняется в расположении результатов запроса Athena в Amazon S3. Файл манифеста отслеживает файлы, которые запрос записал в Amazon S3. Если запрос завершится ошибкой, файл манифеста также отслеживает файлы, которые запрос планировал записать. Манифест полезен для выявления незавершенных файлов, возникших в результате сбоя запроса. Дополнительные сведения см. в разделе Работа с результатами запросов, выходными файлами и историей запросов в Руководстве пользователя Amazon Athena.

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

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

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

Количество миллисекунд, в течение которых запрос находился в очереди запросов, ожидая ресурсов. Обратите внимание, что в случае временных ошибок Athena может автоматически добавить запрос в очередь.

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

Количество миллисекунд, затраченных Athena на предварительную обработку запроса перед отправкой запроса в движок запросов.

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

Количество миллисекунд, затраченное Athena на планирование потока обработки запроса. Это включает время, затраченное на извлечение табличных разделов из источника данных. Обратите внимание, что поскольку движок запросов выполняет планирование запросов, время планирования запросов является подмножеством времени обработки запроса.

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

Количество миллисекунд, затраченное Athena на завершение и публикацию результатов запроса после завершения выполнения запроса движком запросов.

ResultReuseInformation -> (структура)

Содержит информацию о том, были ли для запроса повторно использованы предыдущие результаты запроса.

ReusedPreviousResult -> (булево)

Истина, если предыдущий результат запроса был повторно использован; ложь, если результат был сгенерирован из нового выполнения запроса.

WorkGroup -> (строка)

Имя рабочей группы, в которой выполнялся запрос.

EngineVersion -> (структура)

Версия движка, которая выполнила запрос.

SelectedEngineVersion -> (строка)

Версия движка, запрошенная пользователем. Возможные значения определяются результатом ListEngineVersions, включая AUTO. По умолчанию AUTO.

EffectiveEngineVersion -> (строка)

Только для чтения. Версия движка, на которой выполняется запрос. Если пользователь запрашивает допустимую версию движка, отличную от Авто, эффективная версия движка совпадает с версией движка, запрошенной пользователем. Если пользователь запрашивает Авто, эффективная версия движка выбирается Athena. При запросе обновления версии движка операцией CreateWorkGroup или UpdateWorkGroup поле EffectiveEngineVersion игнорируется.

ExecutionParameters -> (список)

Список значений для параметров в запросе. Значения применяются последовательно к параметрам в запросе в порядке их появления. Список параметров не возвращается в ответе.

(строка)

SubstatementType -> (string)

Тип оператора запроса, который был выполнен.

QueryResultsS3AccessGrantsConfiguration -> (structure)

Указывает, включены ли разрешения доступа к Amazon S3 для результатов запроса.

EnableS3AccessGrants -> (boolean)

Указывает, включены ли разрешения доступа к Amazon S3 для результатов запроса.

CreateUserLevelPrefix -> (boolean)

При включении добавляет идентификатор пользователя в качестве префикса пути Amazon S3 к месту вывода результатов запроса.

AuthenticationType -> (string)

Тип аутентификации, используемый для разрешений доступа к Amazon S3. В настоящее время поддерживается только DIRECTORY_IDENTITY.

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

Spec-Zone.ru

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