Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.
Synopsis
- listVocabularies :: ListVocabularies
- data ListVocabularies
- lvNameContains :: Lens' ListVocabularies (Maybe Text)
- lvNextToken :: Lens' ListVocabularies (Maybe Text)
- lvStateEquals :: Lens' ListVocabularies (Maybe VocabularyState)
- lvMaxResults :: Lens' ListVocabularies (Maybe Natural)
- listVocabulariesResponse :: Int -> ListVocabulariesResponse
- data ListVocabulariesResponse
- lvrsVocabularies :: Lens' ListVocabulariesResponse [VocabularyInfo]
- lvrsStatus :: Lens' ListVocabulariesResponse (Maybe TranscriptionJobStatus)
- lvrsNextToken :: Lens' ListVocabulariesResponse (Maybe Text)
- lvrsResponseStatus :: Lens' ListVocabulariesResponse Int
Creating a Request
listVocabularies :: ListVocabularies Source #
Creates a value of ListVocabularies
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lvNameContains
- When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive,ListVocabularies
will return both "vocabularyname" and VocabularyName in the response list.lvNextToken
- If the result of the previous request toListVocabularies
was truncated, include theNextToken
to fetch the next set of jobs.lvStateEquals
- When specified, only returns vocabularies with theVocabularyState
field equal to the specified state.lvMaxResults
- The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results.
data ListVocabularies Source #
See: listVocabularies
smart constructor.
Instances
Request Lenses
lvNameContains :: Lens' ListVocabularies (Maybe Text) Source #
When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, ListVocabularies
will return both "vocabularyname" and VocabularyName in the response list.
lvNextToken :: Lens' ListVocabularies (Maybe Text) Source #
If the result of the previous request to ListVocabularies
was truncated, include the NextToken
to fetch the next set of jobs.
lvStateEquals :: Lens' ListVocabularies (Maybe VocabularyState) Source #
When specified, only returns vocabularies with the VocabularyState
field equal to the specified state.
lvMaxResults :: Lens' ListVocabularies (Maybe Natural) Source #
The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results.
Destructuring the Response
listVocabulariesResponse Source #
Creates a value of ListVocabulariesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lvrsVocabularies
- A list of objects that describe the vocabularies that match the search criteria in the request.lvrsStatus
- The requested vocabulary state.lvrsNextToken
- TheListVocabularies
operation returns a page of vocabularies at a time. The maximum size of the page is set by theMaxResults
parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns theNextPage
token. Include the token in the next request to theListVocabularies
operation to return in the next page of jobs.lvrsResponseStatus
- -- | The response status code.
data ListVocabulariesResponse Source #
See: listVocabulariesResponse
smart constructor.
Instances
Response Lenses
lvrsVocabularies :: Lens' ListVocabulariesResponse [VocabularyInfo] Source #
A list of objects that describe the vocabularies that match the search criteria in the request.
lvrsStatus :: Lens' ListVocabulariesResponse (Maybe TranscriptionJobStatus) Source #
The requested vocabulary state.
lvrsNextToken :: Lens' ListVocabulariesResponse (Maybe Text) Source #
The ListVocabularies
operation returns a page of vocabularies at a time. The maximum size of the page is set by the MaxResults
parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage
token. Include the token in the next request to the ListVocabularies
operation to return in the next page of jobs.
lvrsResponseStatus :: Lens' ListVocabulariesResponse Int Source #
- - | The response status code.