Skip to content

ListReferencesRequest

Source code in docs_src/capo_omics/types/list_references_request.py 
13
14
15
16
17
18
19
20
21
class ListReferencesRequest(TypedDict, closed=True):
    reference_store_id: "capo_omics.types.reference_store_id.ReferenceStoreId"
    """<p>The references' reference store ID.</p>"""
    max_results: NotRequired["int"]
    """<p>The maximum number of references to return in one page of results.</p>"""
    next_token: NotRequired["capo_omics.types.next_token.NextToken"]
    """<p>Specify the pagination token from a previous request to retrieve the next page of results.</p>"""
    filter: NotRequired["capo_omics.types.reference_filter.ReferenceFilter"]
    """<p>A filter to apply to the list.</p>"""

filter instance-attribute 

filter: NotRequired[ReferenceFilter]

A filter to apply to the list.

max_results instance-attribute 

max_results: NotRequired[int]

The maximum number of references to return in one page of results.

next_token instance-attribute 

next_token: NotRequired[NextToken]

Specify the pagination token from a previous request to retrieve the next page of results.

reference_store_id instance-attribute 

reference_store_id: ReferenceStoreId

The references' reference store ID.