Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Searches for vocabularies within a specific Amazon Connect instance
using State
, NameStartsWith
, and LanguageCode
.
This operation returns paginated results.
Synopsis
- data SearchVocabularies = SearchVocabularies' {}
- newSearchVocabularies :: Text -> SearchVocabularies
- searchVocabularies_languageCode :: Lens' SearchVocabularies (Maybe VocabularyLanguageCode)
- searchVocabularies_maxResults :: Lens' SearchVocabularies (Maybe Natural)
- searchVocabularies_nameStartsWith :: Lens' SearchVocabularies (Maybe Text)
- searchVocabularies_nextToken :: Lens' SearchVocabularies (Maybe Text)
- searchVocabularies_state :: Lens' SearchVocabularies (Maybe VocabularyState)
- searchVocabularies_instanceId :: Lens' SearchVocabularies Text
- data SearchVocabulariesResponse = SearchVocabulariesResponse' {}
- newSearchVocabulariesResponse :: Int -> SearchVocabulariesResponse
- searchVocabulariesResponse_nextToken :: Lens' SearchVocabulariesResponse (Maybe Text)
- searchVocabulariesResponse_vocabularySummaryList :: Lens' SearchVocabulariesResponse (Maybe [VocabularySummary])
- searchVocabulariesResponse_httpStatus :: Lens' SearchVocabulariesResponse Int
Creating a Request
data SearchVocabularies Source #
See: newSearchVocabularies
smart constructor.
SearchVocabularies' | |
|
Instances
newSearchVocabularies Source #
Create a value of SearchVocabularies
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SearchVocabularies
, searchVocabularies_languageCode
- The language code of the vocabulary entries. For a list of languages and
their corresponding language codes, see
What is Amazon Transcribe?
$sel:maxResults:SearchVocabularies'
, searchVocabularies_maxResults
- The maximum number of results to return per page.
$sel:nameStartsWith:SearchVocabularies'
, searchVocabularies_nameStartsWith
- The starting pattern of the name of the vocabulary.
SearchVocabularies
, searchVocabularies_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.
SearchVocabularies
, searchVocabularies_state
- The current state of the custom vocabulary.
SearchVocabularies
, searchVocabularies_instanceId
- The identifier of the Amazon Connect instance. You can find the
instanceId in the ARN of the instance.
Request Lenses
searchVocabularies_languageCode :: Lens' SearchVocabularies (Maybe VocabularyLanguageCode) Source #
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
searchVocabularies_maxResults :: Lens' SearchVocabularies (Maybe Natural) Source #
The maximum number of results to return per page.
searchVocabularies_nameStartsWith :: Lens' SearchVocabularies (Maybe Text) Source #
The starting pattern of the name of the vocabulary.
searchVocabularies_nextToken :: Lens' SearchVocabularies (Maybe Text) Source #
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.
searchVocabularies_state :: Lens' SearchVocabularies (Maybe VocabularyState) Source #
The current state of the custom vocabulary.
searchVocabularies_instanceId :: Lens' SearchVocabularies Text Source #
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
Destructuring the Response
data SearchVocabulariesResponse Source #
See: newSearchVocabulariesResponse
smart constructor.
SearchVocabulariesResponse' | |
|
Instances
newSearchVocabulariesResponse Source #
Create a value of SearchVocabulariesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SearchVocabularies
, searchVocabulariesResponse_nextToken
- If there are additional results, this is the token for the next set of
results.
$sel:vocabularySummaryList:SearchVocabulariesResponse'
, searchVocabulariesResponse_vocabularySummaryList
- The list of the available custom vocabularies.
$sel:httpStatus:SearchVocabulariesResponse'
, searchVocabulariesResponse_httpStatus
- The response's http status code.
Response Lenses
searchVocabulariesResponse_nextToken :: Lens' SearchVocabulariesResponse (Maybe Text) Source #
If there are additional results, this is the token for the next set of results.
searchVocabulariesResponse_vocabularySummaryList :: Lens' SearchVocabulariesResponse (Maybe [VocabularySummary]) Source #
The list of the available custom vocabularies.
searchVocabulariesResponse_httpStatus :: Lens' SearchVocabulariesResponse Int Source #
The response's http status code.