---
title: "GET /vocabulary/{InstanceId}/{VocabularyId}"
method: GET
path: "/vocabulary/{InstanceId}/{VocabularyId}"
---

# GET /vocabulary/{InstanceId}/{VocabularyId}

`GET /vocabulary/{InstanceId}/{VocabularyId}`

Describes the specified vocabulary.

## Path parameters

- `InstanceId` string, required
- `VocabularyId` string, required

## Response `200`

Success

- DescribeVocabularyResponse
  - `Vocabulary` object, required — A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.
    - `Name` string, required — A unique name of the custom vocabulary.
    - `Id` string, required — The identifier of the custom vocabulary.
    - `Arn` string, required — The Amazon Resource Name (ARN) of the custom 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', required — 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>
    - `State` 'CREATION_IN_PROGRESS' | 'ACTIVE' | 'CREATION_FAILED' | 'DELETE_IN_PROGRESS', required — The current state of the custom vocabulary.
    - `LastModifiedTime` string, date-time, required — The timestamp when the custom vocabulary was last modified.
    - `FailureReason` string — The reason why the custom vocabulary was not created.
    - `Content` string — The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with <code>Phrase</code>, <code>IPA</code>, <code>SoundsLike</code>, and <code>DisplayAs</code> fields. Separate the fields with TAB characters. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table">Create a custom vocabulary using a table</a>.
    - `Tags` object — The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

## Other responses

- `480` — InvalidRequestException
- `481` — ResourceNotFoundException
- `482` — InternalServiceException
- `483` — ThrottlingException
- `484` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/connect.md) · [All operations](https://skmtc.net/aws/apis/connect/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/connect/versions/fbcf0a4faed2/schema)