Skip to content

SearchVocabulariesRequest

Source code in docs_src/capo_connect/types/search_vocabularies_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class SearchVocabulariesRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer 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>"""
    max_results: NotRequired["capo_connect.types.max_result100.MaxResult100"]
    """<p>The maximum number of results to return per page.</p>"""
    next_token: NotRequired[
        "capo_connect.types.vocabulary_next_token.VocabularyNextToken"
    ]
    """<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>"""
    state: NotRequired["capo_connect.types.vocabulary_state.VocabularyState"]
    """<p>The current state of the custom vocabulary.</p>"""
    name_starts_with: NotRequired["capo_connect.types.vocabulary_name.VocabularyName"]
    """<p>The starting pattern of the name of the vocabulary.</p>"""
    language_code: NotRequired[
        "capo_connect.types.vocabulary_language_code.VocabularyLanguageCode"
    ]
    """<p>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a> </p>"""

instance_id instance-attribute 

instance_id: InstanceId

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

language_code instance-attribute 

language_code: NotRequired[VocabularyLanguageCode]

The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?

max_results instance-attribute 

max_results: NotRequired[MaxResult100]

The maximum number of results to return per page.

name_starts_with instance-attribute 

name_starts_with: NotRequired[VocabularyName]

The starting pattern of the name of the vocabulary.

next_token instance-attribute 

next_token: NotRequired[VocabularyNextToken]

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.

state instance-attribute 

state: NotRequired[VocabularyState]

The current state of the custom vocabulary.