Skip to content

RequestWidget

Source code in docs_src/capo_cloudtrail/types/request_widget.py 
15
16
17
18
19
20
21
22
23
class RequestWidget(TypedDict, closed=True):
    query_statement: "capo_cloudtrail.types.query_statement.QueryStatement"
    """<p> The query statement for the widget. For custom dashboard widgets, you can query across multiple event data stores as long as all event data stores exist in your account. </p> <note> <p>When a query uses <code>?</code> with <code>eventTime</code>, <code>?</code> must be surrounded by single quotes as follows: <code>'?'</code>.</p> </note>"""
    query_parameters: NotRequired[
        "capo_cloudtrail.types.query_parameters.QueryParameters"
    ]
    """<p> The optional query parameters. The following query parameters are valid: <code>$StartTime$</code>, <code>$EndTime$</code>, and <code>$Period$</code>. </p>"""
    view_properties: "capo_cloudtrail.types.view_properties_map.ViewPropertiesMap"
    """<p> The view properties for the widget. For more information about view properties, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-widget-properties.html"> View properties for widgets </a> in the <i>CloudTrail User Guide</i>. </p>"""

query_parameters instance-attribute 

query_parameters: NotRequired[QueryParameters]

The optional query parameters. The following query parameters are valid: $StartTime$, $EndTime$, and $Period$.

query_statement instance-attribute 

query_statement: QueryStatement

The query statement for the widget. For custom dashboard widgets, you can query across multiple event data stores as long as all event data stores exist in your account.

When a query uses ? with eventTime, ? must be surrounded by single quotes as follows: '?'.

view_properties instance-attribute 

view_properties: ViewPropertiesMap

The view properties for the widget. For more information about view properties, see View properties for widgets in the CloudTrail User Guide.