Skip to content

ListVocabulariesRequest

Source code in docs_src/capo_transcribe/types/list_vocabularies_request.py 
14
15
16
17
18
19
20
21
22
class ListVocabulariesRequest(TypedDict, closed=True):
    next_token: NotRequired["capo_transcribe.types.next_token.NextToken"]
    """<p>If your <code>ListVocabularies</code> request returns more results than can be displayed, <code>NextToken</code> is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including <code>NextToken</code> with the value of the copied string. Repeat as needed to view all your results.</p>"""
    max_results: NotRequired["capo_transcribe.types.max_results.MaxResults"]
    """<p>The maximum number of custom vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.</p>"""
    state_equals: NotRequired["capo_transcribe.types.vocabulary_state.VocabularyState"]
    """<p>Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you do not include <code>StateEquals</code>, all custom medical vocabularies are returned.</p>"""
    name_contains: NotRequired["capo_transcribe.types.vocabulary_name.VocabularyName"]
    """<p>Returns only the custom vocabularies that contain the specified string. The search is not case sensitive.</p>"""

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of custom vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.

name_contains instance-attribute 

name_contains: NotRequired[VocabularyName]

Returns only the custom vocabularies that contain the specified string. The search is not case sensitive.

next_token instance-attribute 

next_token: NotRequired[NextToken]

If your ListVocabularies request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

state_equals instance-attribute 

state_equals: NotRequired[VocabularyState]

Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you do not include StateEquals, all custom medical vocabularies are returned.