Skip to content

ScheduledQueryRunSummary

Source code in docs_src/capo_timestream_query/types/scheduled_query_run_summary.py
class ScheduledQueryRunSummary(TypedDict, closed=True):
    invocation_time: NotRequired["capo_timestream_query.types.time.Time"]
    """<p>InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter <code>@scheduled_runtime</code> can be used in the query to get the value. </p>"""
    trigger_time: NotRequired["capo_timestream_query.types.time.Time"]
    """<p>The actual time when the query was run.</p>"""
    run_status: NotRequired[
        "capo_timestream_query.types.scheduled_query_run_status.ScheduledQueryRunStatus"
    ]
    """<p>The status of a scheduled query run.</p>"""
    execution_stats: NotRequired[
        "capo_timestream_query.types.execution_stats.ExecutionStats"
    ]
    """<p>Runtime statistics for a scheduled run.</p>"""
    query_insights_response: NotRequired[
        "capo_timestream_query.types.scheduled_query_insights_response.ScheduledQueryInsightsResponse"
    ]
    """<p>Provides various insights and metrics related to the run summary of the scheduled query.</p>"""
    error_report_location: NotRequired[
        "capo_timestream_query.types.error_report_location.ErrorReportLocation"
    ]
    """<p>S3 location for error report.</p>"""
    failure_reason: NotRequired[
        "capo_timestream_query.types.error_message.ErrorMessage"
    ]
    """<p>Error message for the scheduled query in case of failure. You might have to look at the error report to get more detailed error reasons. </p>"""

error_report_location instance-attribute

error_report_location: NotRequired[ErrorReportLocation]

S3 location for error report.

execution_stats instance-attribute

execution_stats: NotRequired[ExecutionStats]

Runtime statistics for a scheduled run.

failure_reason instance-attribute

failure_reason: NotRequired[ErrorMessage]

Error message for the scheduled query in case of failure. You might have to look at the error report to get more detailed error reasons.

invocation_time instance-attribute

invocation_time: NotRequired[Time]

InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter @scheduled_runtime can be used in the query to get the value.

query_insights_response instance-attribute

query_insights_response: NotRequired[ScheduledQueryInsightsResponse]

Provides various insights and metrics related to the run summary of the scheduled query.

run_status instance-attribute

run_status: NotRequired[ScheduledQueryRunStatus]

The status of a scheduled query run.

trigger_time instance-attribute

trigger_time: NotRequired[Time]

The actual time when the query was run.