本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
CreateScheduledQuery
创建一个计划查询,该查询将按照配置的计划代表您运行。Timestream 担任执行角色(作为 ScheduledQueryExecutionRoleArn
参数的一部分提供)以运行查询。您可以使用 NotificationConfiguration
参数为计划的查询操作配置通知。
请求语法
{
"ClientToken": "string
",
"ErrorReportConfiguration": {
"S3Configuration": {
"BucketName": "string
",
"EncryptionOption": "string
",
"ObjectKeyPrefix": "string
"
}
},
"KmsKeyId": "string
",
"Name": "string
",
"NotificationConfiguration": {
"SnsConfiguration": {
"TopicArn": "string
"
}
},
"QueryString": "string
",
"ScheduleConfiguration": {
"ScheduleExpression": "string
"
},
"ScheduledQueryExecutionRoleArn": "string
",
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
],
"TargetConfiguration": {
"TimestreamConfiguration": {
"DatabaseName": "string
",
"DimensionMappings": [
{
"DimensionValueType": "string
",
"Name": "string
"
}
],
"MeasureNameColumn": "string
",
"MixedMeasureMappings": [
{
"MeasureName": "string
",
"MeasureValueType": "string
",
"MultiMeasureAttributeMappings": [
{
"MeasureValueType": "string
",
"SourceColumn": "string
",
"TargetMultiMeasureAttributeName": "string
"
}
],
"SourceColumn": "string
",
"TargetMeasureName": "string
"
}
],
"MultiMeasureMappings": {
"MultiMeasureAttributeMappings": [
{
"MeasureValueType": "string
",
"SourceColumn": "string
",
"TargetMultiMeasureAttributeName": "string
"
}
],
"TargetMultiMeasureName": "string
"
},
"TableName": "string
",
"TimeColumn": "string
"
}
}
}
请求参数
有关所有操作的通用参数的信息,请参阅常用参数。
请求接受采用 JSON 格式的以下数据。
- ClientToken
-
使用 a ClientToken 会调用 CreateScheduledQuery idempotent,换句话说,重复发出相同的请求将产生相同的结果。发出多个相同的 CreateScheduledQuery 请求与发出单个请求的效果相同。
-
如果 CreateScheduledQuery 调用时不带有
ClientToken
,则 Query SDK 会ClientToken
代表您生成。 -
8 小时后,具有相同
ClientToken
的任何请求都将视为新请求。
类型:字符串
长度限制:最小长度为 32。最大长度为 128。
必需:否
-
- ErrorReportConfiguration
-
错误报告的配置。如果写入查询结果时遇到问题,将生成错误报告。
类型:ErrorReportConfiguration 对象
必需:是
- KmsKeyId
-
用于静态加密计划查询资源的 Amazon KMS 密钥。如果未指定 Amazon KMS 密钥,则计划查询资源将使用 Timestream 拥有的 Amazon KMS 密钥进行加密。要指定 KMS 密钥,请使用密钥 ID、密钥 ARN、别名名称或别名 ARN。使用别名时,应为名称加上 alias/前缀
如果
SSE_KMS
用作加密类型,则 ErrorReportConfiguration 使用相同的 KmsKeyId 加密类型对错误报告进行静态加密。类型:字符串
长度限制:最小长度为 0。最大长度为 2048。
必需:否
- Name
-
计划查询的名称。
类型:字符串
长度限制:长度下限为 1。长度上限为 64。
模式:
[a-zA-Z0-9|!\-_*'\(\)]([a-zA-Z0-9]|[!\-_*'\(\)\/.])+
必需:是
- NotificationConfiguration
-
计划查询的通知配置。查询运行完成、状态更新或您将其删除时,Timestream 将发送通知。
类型:NotificationConfiguration 对象
必需:是
- QueryString
-
要运行的查询字符串。参数名称可以采用查询字符串
@
字符后跟标识符的形式指定。指定的参数@scheduled_runtime
将保留,并可在查询中使用,以获取查询计划运行的时间。根据 ScheduleConfiguration 参数计算的时间戳将是每次查询运行的 p
@scheduled_runtime
aramater 的值。例如,考虑在 2021-12-01 00:00:00 执行的计划查询的实例。对于此实例,@scheduled_runtime
参数在调用查询时初始化的时间戳为 2021-12-01 00:00:00。类型:字符串
长度限制:长度下限为 1。长度上限为 262144。
必需:是
- ScheduleConfiguration
-
查询的计划配置。
类型:ScheduleConfiguration 对象
必需:是
- ScheduledQueryExecutionRoleArn
-
Timestream 在运行计划查询时将担任的 IAM 角色的 ARN。
类型:字符串
长度限制:最小长度为 0。最大长度为 2048。
必需:是
- Tags
-
用于标记计划查询的键值对列表。
类型:Tag 对象数组
数组成员:最少 0 个物品。最多 200 项。
必需:否
- TargetConfiguration
-
用于写入查询结果的配置。
类型:TargetConfiguration 对象
必需:否
响应语法
{
"Arn": "string"
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- Arn
-
已创建的计划查询的 ARN。
类型:字符串
长度限制:最小长度为 0。最大长度为 2048。
错误
有关所有操作的常见错误的信息,请参阅常见错误。
- AccessDeniedException
-
您没有访问账户设置所需的权限。
HTTP 状态代码:400
- ConflictException
-
无法对已取消的查询进行轮询结果。
HTTP 状态代码:400
- InternalServerException
-
处理请求时出现内部服务器错误。
HTTP 状态代码:400
- InvalidEndpointException
-
请求的端点无效。
HTTP 状态代码:400
- ServiceQuotaExceededException
-
您已超过服务配额。
HTTP 状态代码:400
- ThrottlingException
-
由于请求过多,请求受到限制。
HTTP 状态代码:400
- ValidationException
-
请求无效或格式错误。
HTTP 状态代码:400
另请参阅
有关以特定语言之一使用此 API 的更多信息 Amazon SDKs,请参阅以下内容: