DescribeVocabulary - Amazon Connect


Describes the specified vocabulary.

Request Syntax

GET /vocabulary/InstanceId/VocabularyId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes


The identifier of the custom vocabulary.

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Vocabulary": { "Arn": "string", "Content": "string", "FailureReason": "string", "Id": "string", "LanguageCode": "string", "LastModifiedTime": number, "Name": "string", "State": "string", "Tags": { "string" : "string" } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


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.

Type: Vocabulary object


For information about the errors that are common to all actions, see Common Errors.


You do not have sufficient permissions to perform this action.

HTTP Status Code: 403


Request processing failed because of an error or failure with the service.

HTTP Status Code: 500


The request is not valid.

HTTP Status Code: 400


The specified resource was not found.

HTTP Status Code: 404


The throttling limit has been exceeded.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: