scheduled_query

Gets an individual scheduled_query resource

Overview

Name	scheduled_query
Type	Resource
Description	scheduled_query
Id	awscc.timestream.scheduled_query

Fields

Name	Datatype	Description
arn	string
scheduled_query_name	string
query_string	string
schedule_configuration	object
notification_configuration	object
client_token	string
scheduled_query_execution_role_arn	string
target_configuration	object
error_report_configuration	object
kms_key_id	string
sq_name	string	The name of the scheduled query. Scheduled query names must be unique within each Region.
sq_query_string	string	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.
sq_schedule_configuration	string	Configuration for when the scheduled query is executed.
sq_notification_configuration	string	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.
sq_scheduled_query_execution_role_arn	string	The ARN for the IAM role that Timestream will assume when running the scheduled query.
sq_target_configuration	string	Configuration of target store where scheduled query results are written to.
sq_error_report_configuration	string	Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
sq_kms_key_id	string	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.
tags	array
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
arn,
scheduled_query_name,
query_string,
schedule_configuration,
notification_configuration,
client_token,
scheduled_query_execution_role_arn,
target_configuration,
error_report_configuration,
kms_key_id,
sq_name,
sq_query_string,
sq_schedule_configuration,
sq_notification_configuration,
sq_scheduled_query_execution_role_arn,
sq_target_configuration,
sq_error_report_configuration,
sq_kms_key_id,
tags
FROM awscc.timestream.scheduled_query
WHERE data__Identifier = '<Arn>';

Permissions

To operate on the scheduled_query resource, the following permissions are required:

Read

timestream:DescribeScheduledQuery,
timestream:ListTagsForResource,
timestream:DescribeEndpoints

Update

timestream:UpdateScheduledQuery,
timestream:TagResource,
timestream:UntagResource,
timestream:DescribeEndpoints

Delete

timestream:DeleteScheduledQuery,
timestream:DescribeEndpoints