Skip to content

DescribeQueryResponse

Source code in docs_src/capo_iotsitewise/types/describe_query_response.py
class DescribeQueryResponse(TypedDict, closed=True):
    query_id: "capo_iotsitewise.types.query_id.QueryId"
    """<p>The unique identifier for the query execution.</p>"""
    status: "capo_iotsitewise.types.query_status.QueryStatus"
    """<p>The current query status.</p>"""
    submitted_at: "datetime.datetime"
    """<p>The date and time when the query was submitted, in Unix epoch time.</p>"""
    completed_at: NotRequired["datetime.datetime"]
    """<p>The date and time when the query reached a terminal state, in Unix epoch time. This field is present when the query status is COMPLETED, FAILED, or CANCELED.</p>"""
    statistics: NotRequired["capo_iotsitewise.types.query_statistics.QueryStatistics"]
    """<p>The query execution statistics. This field is present when the query status is COMPLETED.</p>"""
    error_message: NotRequired[
        "capo_iotsitewise.types.query_error_message.QueryErrorMessage"
    ]
    """<p>A human-readable error description. This field is present when the query status is FAILED.</p>"""

completed_at instance-attribute

completed_at: NotRequired[datetime]

The date and time when the query reached a terminal state, in Unix epoch time. This field is present when the query status is COMPLETED, FAILED, or CANCELED.

error_message instance-attribute

error_message: NotRequired[QueryErrorMessage]

A human-readable error description. This field is present when the query status is FAILED.

query_id instance-attribute

query_id: QueryId

The unique identifier for the query execution.

statistics instance-attribute

statistics: NotRequired[QueryStatistics]

The query execution statistics. This field is present when the query status is COMPLETED.

status instance-attribute

status: QueryStatus

The current query status.

submitted_at instance-attribute

submitted_at: datetime

The date and time when the query was submitted, in Unix epoch time.