Skip to content

SearchViewsRequest

Source code in docs_src/capo_connect/types/search_views_request.py
class SearchViewsRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id_or_arn.InstanceIdOrArn"
    """<p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"""
    next_token: NotRequired["capo_connect.types.next_token2500.NextToken2500"]
    """<p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>"""
    max_results: NotRequired["capo_connect.types.max_result100.MaxResult100"]
    """<p>The maximum number of results to return per page.</p>"""
    search_filter: NotRequired["capo_connect.types.view_search_filter.ViewSearchFilter"]
    """<p>Filters to apply to the search, such as tag-based filters.</p>"""
    search_criteria: NotRequired[
        "capo_connect.types.view_search_criteria.ViewSearchCriteria"
    ]
    """<p>The search criteria, including field names and comparison types.</p>"""

instance_id instance-attribute

instance_id: InstanceIdOrArn

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

max_results instance-attribute

max_results: NotRequired[MaxResult100]

The maximum number of results to return per page.

next_token instance-attribute

next_token: NotRequired[NextToken2500]

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

search_criteria instance-attribute

search_criteria: NotRequired[ViewSearchCriteria]

The search criteria, including field names and comparison types.

search_filter instance-attribute

search_filter: NotRequired[ViewSearchFilter]

Filters to apply to the search, such as tag-based filters.