[ aws . timestream-query ]
создать-планируемый-запрос
Описание
Создайте запланированный запрос, который будет выполняться от вашего имени по заданному расписанию. Timestream предполагает роль выполнения, предоставленную в качестве части параметра ScheduledQueryExecutionRoleArn, для выполнения запроса. Вы можете использовать параметр NotificationConfiguration для настройки уведомлений для ваших операций по запланированному запросу.
См. также: Документация API AWS
Синтаксис
create-scheduled-query
--name <value>
--query-string <value>
--schedule-configuration <value>
--notification-configuration <value>
[--target-configuration <value>]
[--client-token <value>]
--scheduled-query-execution-role-arn <value>
[--tags <value>]
[--kms-key-id <value>]
--error-report-configuration <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]
Параметры
--name (строка)
--query-string (строка)
Строка запроса для выполнения. Имена параметров можно указать в строке запроса, используя символ @, за которым следует идентификатор. Имя параметра @scheduled_runtime зарезервировано и может использоваться в запросе для получения времени, на которое запланирован запрос.
Маркировка времени, вычисленная в соответствии с параметром ScheduleConfiguration, будет значением параметра @scheduled_runtime для каждого запуска запроса. Например, рассмотрим случай, когда запланированный запрос выполняется 01.12.2021 00:00:00. В этом случае параметр @scheduled_runtime инициализируется отметкой времени 01.12.2021 00:00:00 при вызове запроса.
--schedule-configuration (структура)
Настройка расписания для запроса.
ScheduleExpression -> (строка)
Краткая запись:
ScheduleExpression=string
Синтаксис JSON:
{
"ScheduleExpression": "string"
}
--notification-configuration (структура)
Настройка уведомлений для запланированного запроса. Уведомление отправляется Timestream, когда запрос завершается, когда состояние обновляется или когда вы его удаляете.
SnsConfiguration -> (структура)
Подробная информация о настройке Amazon Simple Notification Service (SNS). Этот параметр виден только при предоставлении темы SNS при обновлении настроек аккаунта.
TopicArn -> (строка)
Краткая запись:
SnsConfiguration={TopicArn=string}
Синтаксис JSON:
{
"SnsConfiguration": {
"TopicArn": "string"
}
}
--target-configuration (структура)
Настройка для записи результата запроса.
TimestreamConfiguration -> (структура)
Настройка, необходимая для записи данных в базу данных Timestream и таблицу.
DatabaseName -> (строка)
TableName -> (строка)
TimeColumn -> (строка)
DimensionMappings -> (список)
Это позволяет сопоставлять столбец(ы) из результата запроса с измерением в целевой таблице.
(структура)
Этот тип используется для сопоставления столбца(ов) из результата запроса с измерением в целевой таблице.
Name -> (строка)
DimensionValueType -> (строка)
MultiMeasureMappings -> (структура)
Сопоставления нескольких измерений.
TargetMultiMeasureName -> (строка)
MultiMeasureAttributeMappings -> (список)
Обязательно. Сопоставления атрибутов для сопоставления результатов запроса с данными для атрибутов нескольких измерений.
(структура)
Сопоставление атрибутов для мер с несколькими значениями.
SourceColumn -> (строка)
TargetMultiMeasureAttributeName -> (строка)
MeasureValueType -> (строка)
MixedMeasureMappings -> (список)
Указывает, как сопоставить метрики с записями нескольких измерений.
(структура)
MixedMeasureMappings - это сопоставления, которые могут использоваться для загрузки данных в смесь узких и многомерных измерений в производной таблице.
MeasureName -> (строка)
SourceColumn -> (строка)
TargetMeasureName -> (строка)
MeasureValueType -> (строка)
MultiMeasureAttributeMappings -> (список)
Требуется, когда measureValueType является MULTI. Сопоставления атрибутов для мер с несколькими значениями.
(структура)
Сопоставление атрибутов для мер с несколькими значениями.
SourceColumn -> (строка)
TargetMultiMeasureAttributeName -> (строка)
MeasureValueType -> (строка)
MeasureNameColumn -> (строка)
Синтаксис JSON:
{
"TimestreamConfiguration": {
"DatabaseName": "string",
"TableName": "string",
"TimeColumn": "string",
"DimensionMappings": [
{
"Name": "string",
"DimensionValueType": "VARCHAR"
}
...
],
"MultiMeasureMappings": {
"TargetMultiMeasureName": "string",
"MultiMeasureAttributeMappings": [
{
"SourceColumn": "string",
"TargetMultiMeasureAttributeName": "string",
"MeasureValueType": "BIGINT"|"BOOLEAN"|"DOUBLE"|"VARCHAR"|"TIMESTAMP"
}
...
]
},
"MixedMeasureMappings": [
{
"MeasureName": "string",
"SourceColumn": "string",
"TargetMeasureName": "string",
"MeasureValueType": "BIGINT"|"BOOLEAN"|"DOUBLE"|"VARCHAR"|"MULTI",
"MultiMeasureAttributeMappings": [
{
"SourceColumn": "string",
"TargetMultiMeasureAttributeName": "string",
"MeasureValueType": "BIGINT"|"BOOLEAN"|"DOUBLE"|"VARCHAR"|"TIMESTAMP"
}
...
]
}
...
],
"MeasureNameColumn": "string"
}
}
--client-token (строка)
Использование ClientToken делает вызов CreateScheduledQuery идемпотентным, другими словами, многократный вызов одного и того же запроса приведет к одному и тому же результату. Выполнение нескольких идентичных запросов CreateScheduledQuery имеет тот же эффект, что и выполнение одного запроса.
- Если CreateScheduledQuery вызывается без
ClientToken, Query SDK генерируетClientTokenот вашего имени. - Через 8 часов любой запрос с тем же
ClientTokenобрабатывается как новый запрос.
--scheduled-query-execution-role-arn (строка)
--tags (список)
Список пар ключ-значение для маркировки запланированного запроса.
(структура)
Тег — это метка, которую вы назначаете базе данных и/или таблице Timestream. Каждый тег состоит из ключа и необязательного значения, которые вы определяете. Теги позволяют категоризировать базы данных и/или таблицы, например, по назначению, владельцу или среде.
Key -> (строка)
Value -> (строка)
Краткая запись:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--kms-key-id (строка)
Ключ Amazon KMS, используемый для шифрования ресурса запланированного запроса в состоянии покоя. Если ключ Amazon KMS не указан, ресурс запланированного запроса будет зашифрован с помощью ключа Amazon KMS, принадлежащего Timestream. Для указания ключа KMS используйте идентификатор ключа, ARN ключа, имя псевдонима или ARN псевдонима. При использовании имени псевдонима префикс перед именем должен быть alias/
Если ErrorReportConfiguration использует SSE_KMS в качестве типа шифрования, тот же KmsKeyId используется для шифрования отчета об ошибках в состоянии покоя.
--error-report-configuration (структура)
Настройка для отчета об ошибках. Отчеты об ошибках будут генерироваться при возникновении проблем при записи результатов запроса.
S3Configuration -> (структура)
Настройка S3 для отчетов об ошибках.
BucketName -> (строка)
ObjectKeyPrefix -> (строка)
EncryptionOption -> (строка)
Краткая запись:
S3Configuration={BucketName=string,ObjectKeyPrefix=string,EncryptionOption=string}
Синтаксис JSON:
{
"S3Configuration": {
"BucketName": "string",
"ObjectKeyPrefix": "string",
"EncryptionOption": "SSE_S3"|"SSE_KMS"
}
}
--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 (boolean)
Включить отладочную запись в журнал.
--endpoint-url (string)
Переопределить URL по умолчанию команды указанным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение по умолчанию по проверке SSL-сертификатов.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определённый профиль из файла учетных данных.
--region (string)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (string)
Отобразить версию этого инструмента.
--color (string)
Включить/отключить цветной вывод.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (string)
Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (string)
Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запроса параметров ввода CLI.
Вывод
Arn -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.