Spec-Zone.ru › AWS CLI v2

[ aws . timestream-запрос ]

запрос

Описание

Query — это синхронная операция, которая позволяет выполнить запрос к данным Amazon Timestream.

Если вы включили QueryInsights, этот API также возвращает сведения и метрики, связанные с выполненным запросом. QueryInsights помогает настроить производительность вашего запроса. Дополнительную информацию о QueryInsights см. в разделе Использование сведений о запросах для оптимизации запросов в Amazon Timestream.

Примечание

Максимальное количество Query запросов API, которые вы можете выполнить с включенным QueryInsights, составляет 1 запрос в секунду (QPS). Если вы превысите эту скорость запросов, это может привести к ограничению.

Query будет ожидать истечения времени после 60 секунд. Вам необходимо обновить значение по умолчанию для таймаута в SDK, чтобы поддерживать таймаут в 60 секунд. Подробнее см. пример кода.

Ваш запрос запроса завершится ошибкой в следующих случаях:

  • Если вы отправите запрос Query с тем же токеном клиента за пределами окна идемпотентности в 5 минут.
  • Если вы отправите запрос Query с тем же токеном клиента, но измените другие параметры, в пределах окна идемпотентности в 5 минут.
  • Если размер строки (включая метаданные запроса) превышает 1 МБ, запрос завершится с сообщением об ошибке: Query aborted as max page response size has been exceeded by the output result row
  • Если IAM-принципал инициатора запроса и читателя результата не совпадают и/или инициатор запроса и читатель результата не имеют одинаковой строки запроса в запросах запроса, запрос завершится с ошибкой Invalid pagination token.

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

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

Синтаксис

  query
--query-string <value>
[--client-token <value>]
[--query-insights <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]

Параметры

--query-string (строка)

Запрос, который должен быть выполнен Timestream.

--client-token (строка)

Уникальная, регистрозависимая строка длиной до 64 ASCII-символов, указанная при выполнении запроса Query. Указание ClientToken делает вызов Query идемпотентным . Это означает, что повторное выполнение одного и того же запроса приведет к одному и тому же результату. Другими словами, отправка нескольких идентичных запросов Query эквивалентна отправке одного запроса. При использовании ClientToken в запросе обратите внимание на следующее:

  • Если API-интерфейс запроса инициализирован без ClientToken, SDK для запросов генерирует ClientToken от вашего имени.
  • Если вызов Query содержит только ClientToken, но не включает NextToken, этот вызов Query считается новым запуском запроса.
  • Если вызов содержит NextToken, этот вызов считается последующим вызовом предыдущего вызова API-интерфейса запроса, и возвращается набор результатов.
  • По истечении 4 часов любой запрос с тем же ClientToken рассматривается как новый запрос.

--query-insights (структура)

Содержит настройки для включения QueryInsights.

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

Режим -> (строка)

Предоставляет следующие режимы для включения QueryInsights:

  • ENABLED_WITH_RATE_CONTROL — Включает QueryInsights для обрабатываемых запросов. Этот режим также включает механизм управления скоростью, который ограничивает функцию QueryInsights до 1 запроса в секунду (QPS).
  • DISABLED — Отключает QueryInsights.

Упрощенный синтаксис:

Mode=string

Синтаксис JSON:

{
  "Mode": "ENABLED_WITH_RATE_CONTROL"|"DISABLED"
}

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

--starting-token (строка)

Токен для указания места начала постраничной загрузки. Это NextToken из ранее усеченного ответа.

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

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить сбой вызовов AWS-сервиса из-за таймаута.

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

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

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

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

--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 (строка)

Файл с сертификатом корневого центра, используемый для проверки сертификатов 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-auto-prompt (логическое значение)

Автоматически запрашивать параметры командной строки.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическую запрос параметров командной строки.

Вывод

QueryId -> (строка)

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

NextToken -> (строка)

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

Rows -> (список)

Строки набора результатов, возвращенные запросом.

(структура)

Представляет собой отдельную строку в результатах запроса.

Data -> (список)

Список точек данных в одной строке набора результатов.

(структура)

Datum представляет собой отдельную точку данных в результате запроса.

ScalarValue -> (строка)

Указывает, является ли точка данных скалярным значением, таким как целое число, строка, двойное значение или булево значение.

TimeSeriesValue -> (список)

Указывает, является ли точка данных временным рядом.

(структура)

Тип данных временного ряда представляет значения измерения во времени. Временной ряд — это массив строк со значениями временных меток и значений измерений, отсортированных в порядке возрастания времени. TimeSeriesDataPoint — это отдельная точка данных в временном ряду. Она представляет собой кортеж (время, значение измерения) во временном ряду.

Time -> (строка)

Временная метка, когда было собрано значение измерения.

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

Значение измерения для точки данных.

ScalarValue -> (строка)

Указывает, является ли точка данных скалярным значением, таким как целое число, строка, двойное значение или булево значение.

TimeSeriesValue -> (список)

Указывает, является ли точка данных временным рядом.

(структура)

Тип данных временного ряда представляет значения измерения во времени. Временной ряд — это массив строк со значениями временных меток и значений измерений, отсортированных в порядке возрастания времени. TimeSeriesDataPoint — это отдельная точка данных в временном ряду. Она представляет собой кортеж (время, значение измерения) во временном ряду.

Time -> (строка)

Временная метка, когда было собрано значение измерения.

(… рекурсивно …)

ArrayValue -> (список)

Указывает, является ли точка данных массивом.

(… рекурсивно …)

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

Указывает, является ли точка данных строкой.

Data -> (список)

Список точек данных в одной строке набора результатов.

(… рекурсивно …)

NullValue -> (булево)

Указывает, является ли точка данных пустой.

ArrayValue -> (список)

Указывает, является ли точка данных массивом.

(структура)

Datum представляет собой отдельную точку данных в результате запроса.

ScalarValue -> (строка)

Указывает, является ли точка данных скалярным значением, таким как целое число, строка, двойное значение или булево значение.

TimeSeriesValue -> (список)

Указывает, является ли точка данных временным рядом.

(структура)

Тип данных временного ряда представляет значения измерения во времени. Временной ряд — это массив строк со значениями временных меток и значений измерений, отсортированных в порядке возрастания времени. TimeSeriesDataPoint — это отдельная точка данных в временном ряду. Она представляет собой кортеж (время, значение измерения) во временном ряду.

Time -> (строка)

Временная метка, когда было собрано значение измерения.

(… рекурсивно …)

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

Указывает, является ли точка данных строкой.

NullValue -> (булево)

Указывает, является ли точка данных пустой.

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

Указывает, является ли точка данных строкой.

Data -> (список)

Список точек данных в одной строке набора результатов.

(структура)

Datum представляет собой отдельную точку данных в результате запроса.

ScalarValue -> (строка)

Указывает, является ли точка данных скалярным значением, таким как целое число, строка, двойное значение или булево значение.

TimeSeriesValue -> (список)

Указывает, является ли точка данных временным рядом.

(структура)

Тип данных временного ряда представляет значения измерения во времени. Временной ряд — это массив строк со значениями временных меток и значений измерений, отсортированных в порядке возрастания времени. TimeSeriesDataPoint — это отдельная точка данных в временном ряду. Она представляет собой кортеж (время, значение измерения) во временном ряду.

Time -> (строка)

Временная метка, когда было собрано значение измерения.

(… рекурсивно …)

(… рекурсивно …)NullValue -> (булево)

Указывает, является ли точка данных пустой.

NullValue -> (булево)

Указывает, является ли точка данных пустой.

ColumnInfo -> (список)

Типы данных столбцов возвращаемого набора результатов.

(структура)

Содержит метаданные результатов запроса, такие как имена столбцов, типы данных и другие атрибуты.

Name -> (строка)

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

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

Тип данных столбца набора результатов. Тип данных может быть скалярным или сложным. Скалярные типы данных — это целые числа, строки, двойные значения, булевы значения и другие. Сложные типы данных — это типы, такие как массивы, строки и другие.

ScalarType -> (строка)

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

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

Указывает, является ли столбец массивом.

Name -> (строка)

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

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

Тип данных столбца набора результатов. Тип данных может быть скалярным или сложным. Скалярные типы данных — это целые числа, строки, двойные значения, булевы значения и другие. Сложные типы данных — это типы, такие как массивы, строки и другие.

ScalarType -> (строка)

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

(… рекурсивно …)(… рекурсивно …)RowColumnInfo -> (список)

Указывает, является ли столбец строкой.

(… рекурсивно …)

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

Указывает, является ли столбец временным рядом.

Name -> (строка)

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

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

Тип данных столбца набора результатов. Тип данных может быть скалярным или сложным. Скалярные типы данных — это целые числа, строки, двойные значения, булевы значения и другие. Сложные типы данных — это типы, такие как массивы, строки и другие.

ScalarType -> (строка)

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

(… рекурсивно …)(… рекурсивно …)RowColumnInfo -> (список)

Указывает, является ли столбец строкой.

(… рекурсивно …)

RowColumnInfo -> (список)

Указывает, является ли столбец строкой.

(структура)

Содержит метаданные результатов запроса, такие как имена столбцов, типы данных и другие атрибуты.

Name -> (строка)

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

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

Тип данных столбца набора результатов. Тип данных может быть скалярным или сложным. Скалярные типы данных — это целые числа, строки, двойные значения, булевы значения и другие. Сложные типы данных — это типы, такие как массивы, строки и другие.

ScalarType -> (строка)

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

(… рекурсивно …)(… рекурсивно …)

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

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

ProgressPercentage -> (двойное значение)

Прогресс запроса, выраженный в процентах.

CumulativeBytesScanned -> (целое число с длинной арифметикой)

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

CumulativeBytesMetered -> (целое число с длинной арифметикой)

Объем данных, просканированных запросом, в байтах, за который вы будете платить. Это кумулятивная сумма, которая представляет собой общее количество данных, за которые вы будете платить с момента начала запроса. Плата взимается только один раз и взимается либо при завершении работы запроса, либо при его отмене.

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

Оборачивает QueryInsights, содержащие сведения и метрики, относящиеся к запросу, который вы выполнили.

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

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

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

Предоставляет информацию о пространственном охвате выполненного запроса и таблице с наименее эффективным пространственным прореживанием.

  • Value – Максимальное соотношение пространственного охвата.
  • TableArn – Amazon Resource Name (ARN) таблицы с неэффективным пространственным прореживанием.
  • PartitionKey – Ключ разбиения, используемый для разбиения, который может быть стандартным measure_name или CDPK.

Value -> (двойное значение)

Максимальное соотношение пространственного охвата.

TableArn -> (строка)

Amazon Resource Name (ARN) таблицы с наименее эффективным пространственным прореживанием.

PartitionKey -> (список)

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

(строка)

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

Предоставляет информацию о временном диапазоне запроса, включая таблицу с наибольшим (максимальным) временным диапазоном. Ниже приведены некоторые потенциальные варианты оптимизации временного прореживания:

  • Добавить недостающие временные предикаты.
  • Удалить функции вокруг временных предикатов.
  • Добавить временные предикаты ко всем подзапросам.

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

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

  • Value – Максимальная длительность в наносекундах между началом и концом запроса.
  • TableArn – Amazon Resource Name (ARN) таблицы, к которой применяется запрос с наибольшим временным диапазоном.

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

Максимальная длительность в наносекундах между началом и концом запроса.

TableArn -> (строка)

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

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

Указывает количество таблиц в запросе.

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

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

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

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

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

Указывает разбиения, созданные операцией Unload.

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

Указывает количество строк, записанных запросом Unload.

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

Указывает размер, в байтах, записанный операцией Unload.

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

Spec-Zone.ru

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