Skip to content

ListInsightsRequest

Source code in docs_src/capo_opensearch/types/list_insights_request.py 
17
18
19
20
21
22
23
24
25
26
27
class ListInsightsRequest(TypedDict, closed=True):
    entity: "capo_opensearch.types.insight_entity.InsightEntity"
    """<p>The entity for which to list insights. Specifies the type and value of the entity, such as a domain name or Amazon Web Services account ID.</p>"""
    time_range: NotRequired["capo_opensearch.types.insight_time_range.InsightTimeRange"]
    """<p>The time range for filtering insights, specified as epoch millisecond timestamps.</p>"""
    sort_order: NotRequired["capo_opensearch.types.insight_sort_order.InsightSortOrder"]
    """<p>The sort order for the results. Possible values are <code>ASC</code> (ascending) and <code>DESC</code> (descending).</p>"""
    max_results: NotRequired["capo_opensearch.types.insight_page_size.InsightPageSize"]
    """<p>An optional parameter that specifies the maximum number of results to return. You can use <code>NextToken</code> to get the next page of results. Valid values are 1 to 500.</p>"""
    next_token: NotRequired["capo_opensearch.types.string.String"]
    """<p>If your initial <code>ListInsights</code> operation returns a <code>NextToken</code>, include the returned <code>NextToken</code> in subsequent <code>ListInsights</code> operations to retrieve the next page of results.</p>"""

entity instance-attribute 

entity: InsightEntity

The entity for which to list insights. Specifies the type and value of the entity, such as a domain name or Amazon Web Services account ID.

max_results instance-attribute 

max_results: NotRequired[InsightPageSize]

An optional parameter that specifies the maximum number of results to return. You can use NextToken to get the next page of results. Valid values are 1 to 500.

next_token instance-attribute 

next_token: NotRequired[String]

If your initial ListInsights operation returns a NextToken, include the returned NextToken in subsequent ListInsights operations to retrieve the next page of results.

sort_order instance-attribute 

sort_order: NotRequired[InsightSortOrder]

The sort order for the results. Possible values are ASC (ascending) and DESC (descending).

time_range instance-attribute 

time_range: NotRequired[InsightTimeRange]

The time range for filtering insights, specified as epoch millisecond timestamps.