Spec-Zone.ru › AWS CLI v2

[ aws . athena ]

batch-get-query-execution

Описание

Возвращает детали выполнения одной запроса или список до 50 запросов, которые вы предоставляете в виде массива строк идентификаторов выполнения запросов. Требуется доступ к рабочей группе, в которой выполнялись запросы. Чтобы получить список идентификаторов выполнения запросов, используйте ListQueryExecutionsInput$WorkGroup. Выполнения запросов отличаются от именованных (сохранённых) запросов. Используйте BatchGetNamedQueryInput, чтобы получить информацию об именованных запросах.

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

Синтаксис

  batch-get-query-execution
--query-execution-ids <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-ids (список)

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

(строка)

Синтаксис:

"string" "string" ...

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

Примеры

Примечание

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

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

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

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

aws athena batch-get-query-execution \
    --query-execution-ids a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 a1b2c3d4-5678-90ab-cdef-EXAMPLE22222

Вывод:

{
    "QueryExecutions": [
        {
            "QueryExecutionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "Query": "create database if not exists webdata",
            "StatementType": "DDL",
            "ResultConfiguration": {
                "OutputLocation": "s3://amzn-s3-demo-bucket/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.txt"
            },
            "QueryExecutionContext": {},
            "Status": {
                "State": "SUCCEEDED",
                "SubmissionDateTime": 1593470720.592,
                "CompletionDateTime": 1593470720.902
            },
            "Statistics": {
                "EngineExecutionTimeInMillis": 232,
                "DataScannedInBytes": 0,
                "TotalExecutionTimeInMillis": 310,
            "ResultConfiguration": {

                "QueryQueueTimeInMillis": 50,
                "ServiceProcessingTimeInMillis": 28
            },
            "WorkGroup": "AthenaAdmin"
        },
        {
            "QueryExecutionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "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-EXAMPLE22222.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"
        }
    ],
    "UnprocessedQueryExecutionIds": []
}

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

Вывод

QueryExecutions -> (список)

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

(структура)

Информация об одном экземпляре выполнения запроса.

QueryExecutionId -> (строка)

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

Query -> (строка)

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

StatementType -> (строка)

Тип оператора запроса, который был выполнен. DDL указывает на операторы запросов DDL. DML указывает на операторы запросов DML (Data Manipulation Language), такие как 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 к указанному расположению вывода. Если ExpectedBucketOwner идентификатор учетной записи Amazon Web Services не совпадает с фактическим владельцем ведра Amazon S3, вызов завершается ошибкой доступа.

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

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

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

S3AclOption -> (строка)

Стандартная настройка доступа Amazon S3, которую Athena должна использовать при сохранении результатов запроса, включая файлы данных, вставленные Athena в результате операторов, таких как CTAS или INSERT INTO. В настоящее время поддерживается только стандартная настройка доступа BUCKET_OWNER_FULL_CONTROL. Если запрос выполняется в рабочей группе, и рабочая группа переопределяет параметры на стороне клиента, то стандартная настройка доступа Amazon S3, указанная в параметрах рабочей группы, используется для всех запросов, выполняемых в рабочей группе. Дополнительную информацию о стандартных настройках доступа Amazon S3 см. в разделе Стандартные настройки доступа в Руководстве пользователя 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 -> (строка)

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

ExecutionParameters -> (список)

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

(строка)

SubstatementType -> (строка)

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

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

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

EnableS3AccessGrants -> (булево)

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

CreateUserLevelPrefix -> (булево)

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

AuthenticationType -> (строка)

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

UnprocessedQueryExecutionIds -> (список)

Информация о запросах, которые не были выполнены.

(структура)

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

QueryExecutionId -> (строка)

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

ErrorCode -> (строка)

Код ошибки, возвращенный при сбое обработки запроса (применимо).

ErrorMessage -> (строка)

Сообщение об ошибке, возвращенное при сбое обработки запроса (применимо).

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

Spec-Zone.ru

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