Skip to content

DescribeQueryResponse

Source code in docs_src/capo_cloudtrail/types/describe_query_response.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class DescribeQueryResponse(TypedDict, closed=True):
    query_id: NotRequired["capo_cloudtrail.types.uuid.UUID"]
    """<p>The ID of the query.</p>"""
    query_string: NotRequired["capo_cloudtrail.types.query_statement.QueryStatement"]
    """<p>The SQL code of a query.</p>"""
    query_status: NotRequired["capo_cloudtrail.types.query_status.QueryStatus"]
    """<p>The status of a query. Values for <code>QueryStatus</code> include <code>QUEUED</code>, <code>RUNNING</code>, <code>FINISHED</code>, <code>FAILED</code>, <code>TIMED_OUT</code>, or <code>CANCELLED</code> </p>"""
    query_statistics: NotRequired[
        "capo_cloudtrail.types.query_statistics_for_describe_query.QueryStatisticsForDescribeQuery"
    ]
    """<p>Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.</p>"""
    error_message: NotRequired["capo_cloudtrail.types.error_message.ErrorMessage"]
    """<p>The error message returned if a query failed.</p>"""
    delivery_s3_uri: NotRequired["capo_cloudtrail.types.delivery_s3_uri.DeliveryS3Uri"]
    """<p>The URI for the S3 bucket where CloudTrail delivered query results, if applicable.</p>"""
    delivery_status: NotRequired["capo_cloudtrail.types.delivery_status.DeliveryStatus"]
    """<p>The delivery status.</p>"""
    prompt: NotRequired["capo_cloudtrail.types.prompt.Prompt"]
    """<p> The prompt used for a generated query. For information about generated queries, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-query-generator.html">Create CloudTrail Lake queries from natural language prompts</a> in the <i>CloudTrail </i> user guide. </p>"""
    event_data_store_owner_account_id: NotRequired[
        "capo_cloudtrail.types.account_id.AccountId"
    ]
    """<p> The account ID of the event data store owner. </p>"""

delivery_s3_uri instance-attribute 

delivery_s3_uri: NotRequired[DeliveryS3Uri]

The URI for the S3 bucket where CloudTrail delivered query results, if applicable.

delivery_status instance-attribute 

delivery_status: NotRequired[DeliveryStatus]

The delivery status.

error_message instance-attribute 

error_message: NotRequired[ErrorMessage]

The error message returned if a query failed.

event_data_store_owner_account_id instance-attribute 

event_data_store_owner_account_id: NotRequired[AccountId]

The account ID of the event data store owner.

prompt instance-attribute 

prompt: NotRequired[Prompt]

The prompt used for a generated query. For information about generated queries, see Create CloudTrail Lake queries from natural language prompts in the CloudTrail user guide.

query_id instance-attribute 

query_id: NotRequired[UUID]

The ID of the query.

query_statistics instance-attribute 

query_statistics: NotRequired[QueryStatisticsForDescribeQuery]

Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.

query_status instance-attribute 

query_status: NotRequired[QueryStatus]

The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED

query_string instance-attribute 

query_string: NotRequired[QueryStatement]

The SQL code of a query.