SearchVocabularies
Searches for vocabularies within a specific Amazon Connect instance using
State, NameStartsWith, and LanguageCode.
Request Syntax
POST /vocabulary-summary/InstanceId HTTP/1.1
Content-type: application/json
{
"LanguageCode": "string",
"MaxResults": number,
"NameStartsWith": "string",
"NextToken": "string",
"State": "string"
}URI Request Parameters
The request uses the following URI parameters.
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- LanguageCode
-
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
Type: String
Valid Values:
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 | ca-ES | da-DK | fi-FI | id-ID | ms-MY | nl-NL | no-NO | pl-PL | sv-SE | tl-PHRequired: No
- MaxResults
-
The maximum number of results to return per page.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NameStartsWith
-
The starting pattern of the name of the vocabulary.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 140.
Pattern:
^[0-9a-zA-Z._-]+Required: No
- NextToken
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131070.
Pattern:
.*\S.*Required: No
- State
-
The current state of the custom vocabulary.
Type: String
Valid Values:
CREATION_IN_PROGRESS | ACTIVE | CREATION_FAILED | DELETE_IN_PROGRESSRequired: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"VocabularySummaryList": [
{
"Arn": "string",
"FailureReason": "string",
"Id": "string",
"LanguageCode": "string",
"LastModifiedTime": number,
"Name": "string",
"State": "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.
- NextToken
-
If there are additional results, this is the token for the next set of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 131070.
Pattern:
.*\S.* - VocabularySummaryList
-
The list of the available custom vocabularies.
Type: Array of VocabularySummary objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ThrottlingException
-
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:
