Create Scheduled Query

timestreamquery_create_scheduled_query

R Documentation

Create a scheduled query that will be run on your behalf at the configured schedule

Description

Create a scheduled query that will be run on your behalf at the configured schedule. Timestream assumes the execution role provided as part of the ScheduledQueryExecutionRoleArn parameter to run the query. You can use the NotificationConfiguration parameter to configure notification for your scheduled query operations.

Usage

timestreamquery_create_scheduled_query(Name, QueryString,
  ScheduleConfiguration, NotificationConfiguration, TargetConfiguration,
  ClientToken, ScheduledQueryExecutionRoleArn, Tags, KmsKeyId,
  ErrorReportConfiguration)

Arguments

Name

[required] Name of the scheduled query.

QueryString

[required] The query string to run. Parameter names can be specified in the query string @ character followed by an identifier. The named Parameter ⁠@scheduled_runtime⁠ is reserved and can be used in the query to get the time at which the query is scheduled to run.

The timestamp calculated according to the ScheduleConfiguration parameter, will be the value of ⁠@scheduled_runtime⁠ paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the ⁠@scheduled_runtime⁠ parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query.

ScheduleConfiguration

[required] The schedule configuration for the query.

NotificationConfiguration

[required] Notification configuration for the scheduled query. A notification is sent by Timestream when a query run finishes, when the state is updated or when you delete it.

TargetConfiguration

Configuration used for writing the result of a query.

ClientToken

Using a ClientToken makes the call to CreateScheduledQuery idempotent, in other words, making the same request repeatedly will produce the same result. Making multiple identical CreateScheduledQuery requests has the same effect as making a single request.

• If CreateScheduledQuery is called without a ClientToken, the Query SDK generates a ClientToken on your behalf.

• After 8 hours, any request with the same ClientToken is treated as a new request.

ScheduledQueryExecutionRoleArn

[required] The ARN for the IAM role that Timestream will assume when running the scheduled query.

Tags

A list of key-value pairs to label the scheduled query.

KmsKeyId

The Amazon KMS key used to encrypt the scheduled query resource, at-rest. If the Amazon KMS key is not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with alias/

If ErrorReportConfiguration uses SSE_KMS as encryption type, the same KmsKeyId is used to encrypt the error report at rest.

ErrorReportConfiguration

[required] Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.

Value

A list with the following syntax:

list(
  Arn = "string"
)

Request syntax

svc$create_scheduled_query(
  Name = "string",
  QueryString = "string",
  ScheduleConfiguration = list(
    ScheduleExpression = "string"
  ),
  NotificationConfiguration = list(
    SnsConfiguration = list(
      TopicArn = "string"
    )
  ),
  TargetConfiguration = list(
    TimestreamConfiguration = list(
      DatabaseName = "string",
      TableName = "string",
      TimeColumn = "string",
      DimensionMappings = list(
        list(
          Name = "string",
          DimensionValueType = "VARCHAR"
        )
      ),
      MultiMeasureMappings = list(
        TargetMultiMeasureName = "string",
        MultiMeasureAttributeMappings = list(
          list(
            SourceColumn = "string",
            TargetMultiMeasureAttributeName = "string",
            MeasureValueType = "BIGINT"|"BOOLEAN"|"DOUBLE"|"VARCHAR"|"TIMESTAMP"
          )
        )
      ),
      MixedMeasureMappings = list(
        list(
          MeasureName = "string",
          SourceColumn = "string",
          TargetMeasureName = "string",
          MeasureValueType = "BIGINT"|"BOOLEAN"|"DOUBLE"|"VARCHAR"|"MULTI",
          MultiMeasureAttributeMappings = list(
            list(
              SourceColumn = "string",
              TargetMultiMeasureAttributeName = "string",
              MeasureValueType = "BIGINT"|"BOOLEAN"|"DOUBLE"|"VARCHAR"|"TIMESTAMP"
            )
          )
        )
      ),
      MeasureNameColumn = "string"
    )
  ),
  ClientToken = "string",
  ScheduledQueryExecutionRoleArn = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  KmsKeyId = "string",
  ErrorReportConfiguration = list(
    S3Configuration = list(
      BucketName = "string",
      ObjectKeyPrefix = "string",
      EncryptionOption = "SSE_S3"|"SSE_KMS"
    )
  )
)