Skip to content

GetQueryResultsResponse

Source code in docs_src/capo_cloudwatch_logs/types/get_query_results_response.py
class GetQueryResultsResponse(TypedDict, closed=True):
    query_language: NotRequired[
        "capo_cloudwatch_logs.types.query_language.QueryLanguage"
    ]
    """<p>The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData_Languages.html">Supported query languages</a>.</p>"""
    results: NotRequired["capo_cloudwatch_logs.types.query_results.QueryResults"]
    """<p>The log events that matched the query criteria during the most recent time it ran.</p> <p>The <code>results</code> value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of <code>field</code>/<code>value</code> pairs.</p>"""
    statistics: NotRequired[
        "capo_cloudwatch_logs.types.query_statistics.QueryStatistics"
    ]
    """<p>Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the scanned log events. These values reflect the full raw results of the query.</p>"""
    status: NotRequired["capo_cloudwatch_logs.types.query_status.QueryStatus"]
    """<p>The status of the most recent running of the query. Possible values are <code>Cancelled</code>, <code>Complete</code>, <code>Failed</code>, <code>Running</code>, <code>Scheduled</code>, <code>Timeout</code>, and <code>Unknown</code>.</p> <p>Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.</p>"""
    encryption_key: NotRequired[
        "capo_cloudwatch_logs.types.encryption_key.EncryptionKey"
    ]
    """<p>If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that's used to encrypt the query results when <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a> stores them.</p>"""
    next_token: NotRequired[
        "capo_cloudwatch_logs.types.get_query_results_next_token.GetQueryResultsNextToken"
    ]
    """<p>If there are more log events remaining in the results, the response includes a <code>nextToken</code>. You can use this token in a subsequent <code>GetQueryResults</code> request to get the next set of results. You can retrieve up to 100,000 log event results from a query by paginating with this token. This is only supported for Logs Insights QL and is currently not supported for PPL and SQL query languages.</p>"""

encryption_key instance-attribute

encryption_key: NotRequired[EncryptionKey]

If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that's used to encrypt the query results when StartQuery stores them.

next_token instance-attribute

next_token: NotRequired[GetQueryResultsNextToken]

If there are more log events remaining in the results, the response includes a nextToken. You can use this token in a subsequent GetQueryResults request to get the next set of results. You can retrieve up to 100,000 log event results from a query by paginating with this token. This is only supported for Logs Insights QL and is currently not supported for PPL and SQL query languages.

query_language instance-attribute

query_language: NotRequired[QueryLanguage]

The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see Supported query languages.

results instance-attribute

results: NotRequired[QueryResults]

The log events that matched the query criteria during the most recent time it ran.

The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs.

statistics instance-attribute

statistics: NotRequired[QueryStatistics]

Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the scanned log events. These values reflect the full raw results of the query.

status instance-attribute

status: NotRequired[QueryStatus]

The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown.

Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.