scheduled_queries_list_only

Lists scheduled_queries in a region or regions, for all properties use scheduled_queries

Overview

Name	scheduled_queries_list_only
Type	Resource
Description	The AWS::Timestream::ScheduledQuery resource creates a Timestream Scheduled Query.
Id	aws.timestream.scheduled_queries_list_only

Fields

Name	Datatype	Description
arn	string	Amazon Resource Name of the scheduled query that is generated upon creation.
scheduled_query_name	string	The name of the scheduled query. Scheduled query names must be unique within each Region.
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.
schedule_configuration	object	Configuration for when the scheduled query is executed.
notification_configuration	object	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.
client_token	string	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.
scheduled_query_execution_role_arn	string	The ARN for the IAM role that Timestream will assume when running the scheduled query.
target_configuration	object	Configuration of target store where scheduled query results are written to.
error_report_configuration	object	Configuration for error reporting. Error reports will be generated when a problem is encountered when writing the query results.
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.
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	A list of key-value pairs to label the scheduled query.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all scheduled_queries in a region.

SELECT
region,
arn
FROM aws.timestream.scheduled_queries_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the scheduled_queries_list_only resource, see scheduled_queries