Skip to content

QueryStatistics

Source code in docs_src/capo_cloudwatch_logs/types/query_statistics.py
class QueryStatistics(TypedDict, closed=True):
    records_matched: "capo_cloudwatch_logs.types.stats_value.StatsValue"
    """<p>The number of log events that matched the query string.</p>"""
    records_scanned: "capo_cloudwatch_logs.types.stats_value.StatsValue"
    """<p>The total number of log events scanned during the query.</p>"""
    estimated_records_skipped: "capo_cloudwatch_logs.types.stats_value.StatsValue"
    """<p>An estimate of the number of log events that were skipped when processing this query, because the query contained an indexed field. Skipping these entries lowers query costs and improves the query performance time. For more information about field indexes, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html">PutIndexPolicy</a>.</p>"""
    bytes_scanned: "capo_cloudwatch_logs.types.stats_value.StatsValue"
    """<p>The total number of bytes in the log events scanned during the query.</p>"""
    estimated_bytes_skipped: "capo_cloudwatch_logs.types.stats_value.StatsValue"
    """<p>An estimate of the number of bytes in the log events that were skipped when processing this query, because the query contained an indexed field. Skipping these entries lowers query costs and improves the query performance time. For more information about field indexes, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html">PutIndexPolicy</a>.</p>"""
    log_groups_scanned: "capo_cloudwatch_logs.types.stats_value.StatsValue"
    """<p>The number of log groups that were scanned by this query.</p>"""
    result_count: "capo_cloudwatch_logs.types.stats_value.StatsValue"
    """<p>The number of rows in the final query result set. This value represents the total number of output rows across all pages. For queries that include post-aggregation filters (such as <code>stats count(*) by field | filter count > threshold</code>), this value might be less than <code>recordsMatched</code>. It reflects only the rows that survived all operations in the query.</p>"""

bytes_scanned instance-attribute

bytes_scanned: StatsValue

The total number of bytes in the log events scanned during the query.

estimated_bytes_skipped instance-attribute

estimated_bytes_skipped: StatsValue

An estimate of the number of bytes in the log events that were skipped when processing this query, because the query contained an indexed field. Skipping these entries lowers query costs and improves the query performance time. For more information about field indexes, see PutIndexPolicy.

estimated_records_skipped instance-attribute

estimated_records_skipped: StatsValue

An estimate of the number of log events that were skipped when processing this query, because the query contained an indexed field. Skipping these entries lowers query costs and improves the query performance time. For more information about field indexes, see PutIndexPolicy.

log_groups_scanned instance-attribute

log_groups_scanned: StatsValue

The number of log groups that were scanned by this query.

records_matched instance-attribute

records_matched: StatsValue

The number of log events that matched the query string.

records_scanned instance-attribute

records_scanned: StatsValue

The total number of log events scanned during the query.

result_count instance-attribute

result_count: StatsValue

The number of rows in the final query result set. This value represents the total number of output rows across all pages. For queries that include post-aggregation filters (such as stats count(*) by field | filter count > threshold), this value might be less than recordsMatched. It reflects only the rows that survived all operations in the query.