Skip to content

ListRecommendationsRequest

Source code in docs_src/capo_sesv2/types/list_recommendations_request.py
class ListRecommendationsRequest(TypedDict, closed=True):
    filter: NotRequired[
        "capo_sesv2.types.list_recommendations_filter.ListRecommendationsFilter"
    ]
    """<p>Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of <code>STATUS</code> and <code>IMPACT</code> or <code>STATUS</code> and <code>TYPE</code> </p>"""
    next_token: NotRequired["capo_sesv2.types.next_token.NextToken"]
    """<p>A token returned from a previous call to <code>ListRecommendations</code> to indicate the position in the list of recommendations.</p>"""
    page_size: NotRequired["capo_sesv2.types.max_items.MaxItems"]
    """<p>The number of results to show in a single call to <code>ListRecommendations</code>. If the number of results is larger than the number you specified in this parameter, then the response includes a <code>NextToken</code> element, which you can use to obtain additional results.</p> <p>The value you specify has to be at least 1, and can be no more than 100.</p>"""

filter instance-attribute

filter: NotRequired[ListRecommendationsFilter]

Filters applied when retrieving recommendations. Can eiter be an individual filter, or combinations of STATUS and IMPACT or STATUS and TYPE

next_token instance-attribute

next_token: NotRequired[NextToken]

A token returned from a previous call to ListRecommendations to indicate the position in the list of recommendations.

page_size instance-attribute

page_size: NotRequired[MaxItems]

The number of results to show in a single call to ListRecommendations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

The value you specify has to be at least 1, and can be no more than 100.