Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14171791756.1 KB

Searches for vocabularies within a specific Amazon Connect instance using <code>State</code>, <code>NameStartsWith</code>, and <code>LanguageCode</code>.

post/vocabulary-summary/{InstanceId}

Path parameters

InstanceIdstring required

The identifier of the Amazon Connect 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.

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Request body

MaxResultsinteger

The maximum number of results to return per page.

NextTokenstring

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'CREATION_IN_PROGRESS' | 'ACTIVE' | 'CREATION_FAILED' | 'DELETE_IN_PROGRESS'

The current state of the custom vocabulary.

NameStartsWithstring

The starting pattern of the name of the vocabulary.

LanguageCode'ar-AE' | 'de-CH' | 'de-DE' | 'en-AB' | 'en-AU' | 'en-GB' | 'en-IE' | 'en-IN' | 'en-US' | 'en-WL' | 'es-ES' | 'es-US' | 'fr-CA' | 'fr-FR' | 'hi-IN' | 'it-IT' | 'ja-JP' | 'ko-KR' | 'pt-BR' | 'pt-PT' | 'zh-CN' | 'en-NZ' | 'en-ZA'

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>

Response

Success

NextTokenstring

If there are additional results, this is the token for the next set of results.