Skip to content

You can use this API to run a scheduled query manually

Description

You can use this API to run a scheduled query manually.

If you enabled QueryInsights, this API also returns insights and metrics related to the query that you executed as part of an Amazon SNS notification. QueryInsights helps with performance tuning of your query. For more information about QueryInsights, see Using query insights to optimize queries in Amazon Timestream.

Usage

timestreamquery_execute_scheduled_query(ScheduledQueryArn,
  InvocationTime, ClientToken, QueryInsights)

Arguments

  • ScheduledQueryArn

    [required] ARN of the scheduled query.

  • InvocationTime

    [required] The timestamp in UTC. Query will be run as if it was invoked at this timestamp.

  • ClientToken

    Not used.

  • QueryInsights

    Encapsulates settings for enabling QueryInsights.

    Enabling QueryInsights returns insights and metrics as a part of the Amazon SNS notification for the query that you executed. You can use QueryInsights to tune your query performance and cost.

Value

An empty list.

Request syntax

svc$execute_scheduled_query(
  ScheduledQueryArn = "string",
  InvocationTime = as.POSIXct(
    "2015-01-01"
  ),
  ClientToken = "string",
  QueryInsights = list(
    Mode = "ENABLED_WITH_RATE_CONTROL"|"DISABLED"
  )
)