Skip to content

ScheduledQueryDescription

Source code in docs_src/capo_timestream_query/types/scheduled_query_description.py
class ScheduledQueryDescription(TypedDict, closed=True):
    arn: "capo_timestream_query.types.amazon_resource_name.AmazonResourceName"
    """<p>Scheduled query ARN.</p>"""
    name: "capo_timestream_query.types.scheduled_query_name.ScheduledQueryName"
    """<p>Name of the scheduled query.</p>"""
    query_string: "capo_timestream_query.types.query_string.QueryString"
    """<p>The query to be run.</p>"""
    creation_time: NotRequired["capo_timestream_query.types.time.Time"]
    """<p>Creation time of the scheduled query.</p>"""
    state: "capo_timestream_query.types.scheduled_query_state.ScheduledQueryState"
    """<p>State of the scheduled query. </p>"""
    previous_invocation_time: NotRequired["capo_timestream_query.types.time.Time"]
    """<p>Last time the query was run.</p>"""
    next_invocation_time: NotRequired["capo_timestream_query.types.time.Time"]
    """<p>The next time the scheduled query is scheduled to run.</p>"""
    schedule_configuration: (
        "capo_timestream_query.types.schedule_configuration.ScheduleConfiguration"
    )
    """<p>Schedule configuration.</p>"""
    notification_configuration: "capo_timestream_query.types.notification_configuration.NotificationConfiguration"
    """<p>Notification configuration.</p>"""
    target_configuration: NotRequired[
        "capo_timestream_query.types.target_configuration.TargetConfiguration"
    ]
    """<p>Scheduled query target store configuration.</p>"""
    scheduled_query_execution_role_arn: NotRequired[
        "capo_timestream_query.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>IAM role that Timestream uses to run the schedule query.</p>"""
    kms_key_id: NotRequired[
        "capo_timestream_query.types.string_value2048.StringValue2048"
    ]
    """<p>A customer provided KMS key used to encrypt the scheduled query resource.</p>"""
    error_report_configuration: NotRequired[
        "capo_timestream_query.types.error_report_configuration.ErrorReportConfiguration"
    ]
    """<p>Error-reporting configuration for the scheduled query.</p>"""
    last_run_summary: NotRequired[
        "capo_timestream_query.types.scheduled_query_run_summary.ScheduledQueryRunSummary"
    ]
    """<p>Runtime summary for the last scheduled query run. </p>"""
    recently_failed_runs: NotRequired[
        "capo_timestream_query.types.scheduled_query_run_summary_list.ScheduledQueryRunSummaryList"
    ]
    """<p>Runtime summary for the last five failed scheduled query runs.</p>"""

arn instance-attribute

Scheduled query ARN.

creation_time instance-attribute

creation_time: NotRequired[Time]

Creation time of the scheduled query.

error_report_configuration instance-attribute

error_report_configuration: NotRequired[ErrorReportConfiguration]

Error-reporting configuration for the scheduled query.

kms_key_id instance-attribute

kms_key_id: NotRequired[StringValue2048]

A customer provided KMS key used to encrypt the scheduled query resource.

last_run_summary instance-attribute

last_run_summary: NotRequired[ScheduledQueryRunSummary]

Runtime summary for the last scheduled query run.

name instance-attribute

Name of the scheduled query.

next_invocation_time instance-attribute

next_invocation_time: NotRequired[Time]

The next time the scheduled query is scheduled to run.

notification_configuration instance-attribute

notification_configuration: NotificationConfiguration

Notification configuration.

previous_invocation_time instance-attribute

previous_invocation_time: NotRequired[Time]

Last time the query was run.

query_string instance-attribute

query_string: QueryString

The query to be run.

recently_failed_runs instance-attribute

recently_failed_runs: NotRequired[ScheduledQueryRunSummaryList]

Runtime summary for the last five failed scheduled query runs.

schedule_configuration instance-attribute

schedule_configuration: ScheduleConfiguration

Schedule configuration.

scheduled_query_execution_role_arn instance-attribute

scheduled_query_execution_role_arn: NotRequired[AmazonResourceName]

IAM role that Timestream uses to run the schedule query.

state instance-attribute

State of the scheduled query.

target_configuration instance-attribute

target_configuration: NotRequired[TargetConfiguration]

Scheduled query target store configuration.