SearchCasesRequest ¶

class SearchCasesRequest(TypedDict, closed=True):
    domain_id: "capo_connectcases.types.domain_id.DomainId"
    """<p>The unique identifier of the Cases domain. </p>"""
    max_results: NotRequired["int"]
    """<p>The maximum number of cases to return. When no value is provided, 25 is the default.</p>"""
    next_token: NotRequired["capo_connectcases.types.next_token.NextToken"]
    """<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>"""
    search_term: NotRequired["str"]
    """<p>A word or phrase used to perform a quick search.</p>"""
    filter: NotRequired["capo_connectcases.types.case_filter.CaseFilter"]
    """<p>A list of filter objects.</p>"""
    sorts: NotRequired["capo_connectcases.types.sort_list.SortList"]
    """<p>A list of sorts where each sort specifies a field and their sort order to be applied to the results. </p>"""
    fields: NotRequired[
        "capo_connectcases.types.field_identifier_list.FieldIdentifierList"
    ]
    """<p>The list of field identifiers to be returned as part of the response.</p>"""