SearchResourcesRequest ¶

class SearchResourcesRequest(TypedDict, closed=True):
    authentication_token: NotRequired[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ]
    """<p>WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>"""
    query_text: NotRequired["capo_workdocs.types.search_query_type.SearchQueryType"]
    """<p>The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.</p>"""
    query_scopes: NotRequired[
        "capo_workdocs.types.search_query_scope_type_list.SearchQueryScopeTypeList"
    ]
    """<p>Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content</p>"""
    organization_id: NotRequired["capo_workdocs.types.id_type.IdType"]
    """<p>Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.</p>"""
    additional_response_fields: NotRequired[
        "capo_workdocs.types.additional_response_fields_list.AdditionalResponseFieldsList"
    ]
    """<p>A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.</p>"""
    filters: NotRequired["capo_workdocs.types.filters.Filters"]
    """<p>Filters results based on entity metadata.</p>"""
    order_by: NotRequired[
        "capo_workdocs.types.search_result_sort_list.SearchResultSortList"
    ]
    """<p>Order by results in one or more categories.</p>"""
    limit: NotRequired[
        "capo_workdocs.types.search_results_limit_type.SearchResultsLimitType"
    ]
    """<p>Max results count per page.</p>"""
    marker: NotRequired["capo_workdocs.types.next_marker_type.NextMarkerType"]
    """<p>The marker for the next set of results.</p>"""