| 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 |
Amazonka.Transcribe.ListVocabularyFilters
Description
Provides a list of custom vocabulary filters that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.
To get detailed information about a specific custom vocabulary filter, use the operation.
Synopsis
- data ListVocabularyFilters = ListVocabularyFilters' {}
- newListVocabularyFilters :: ListVocabularyFilters
- listVocabularyFilters_maxResults :: Lens' ListVocabularyFilters (Maybe Natural)
- listVocabularyFilters_nameContains :: Lens' ListVocabularyFilters (Maybe Text)
- listVocabularyFilters_nextToken :: Lens' ListVocabularyFilters (Maybe Text)
- data ListVocabularyFiltersResponse = ListVocabularyFiltersResponse' {}
- newListVocabularyFiltersResponse :: Int -> ListVocabularyFiltersResponse
- listVocabularyFiltersResponse_nextToken :: Lens' ListVocabularyFiltersResponse (Maybe Text)
- listVocabularyFiltersResponse_vocabularyFilters :: Lens' ListVocabularyFiltersResponse (Maybe [VocabularyFilterInfo])
- listVocabularyFiltersResponse_httpStatus :: Lens' ListVocabularyFiltersResponse Int
Creating a Request
data ListVocabularyFilters Source #
See: newListVocabularyFilters smart constructor.
Constructors
| ListVocabularyFilters' | |
Fields
| |
Instances
newListVocabularyFilters :: ListVocabularyFilters Source #
Create a value of ListVocabularyFilters 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:
$sel:maxResults:ListVocabularyFilters', listVocabularyFilters_maxResults - The maximum number of custom vocabulary filters to return in each page
of results. If there are fewer results than the value that you specify,
only the actual results are returned. If you don't specify a value, a
default of 5 is used.
$sel:nameContains:ListVocabularyFilters', listVocabularyFilters_nameContains - Returns only the custom vocabulary filters that contain the specified
string. The search is not case sensitive.
ListVocabularyFilters, listVocabularyFilters_nextToken - If your ListVocabularyFilters request returns more results than can be
displayed, NextToken is displayed in the response with an associated
string. To get the next page of results, copy this string and repeat
your request, including NextToken with the value of the copied string.
Repeat as needed to view all your results.
Request Lenses
listVocabularyFilters_maxResults :: Lens' ListVocabularyFilters (Maybe Natural) Source #
The maximum number of custom vocabulary filters to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
listVocabularyFilters_nameContains :: Lens' ListVocabularyFilters (Maybe Text) Source #
Returns only the custom vocabulary filters that contain the specified string. The search is not case sensitive.
listVocabularyFilters_nextToken :: Lens' ListVocabularyFilters (Maybe Text) Source #
If your ListVocabularyFilters request returns more results than can be
displayed, NextToken is displayed in the response with an associated
string. To get the next page of results, copy this string and repeat
your request, including NextToken with the value of the copied string.
Repeat as needed to view all your results.
Destructuring the Response
data ListVocabularyFiltersResponse Source #
See: newListVocabularyFiltersResponse smart constructor.
Constructors
| ListVocabularyFiltersResponse' | |
Fields
| |
Instances
newListVocabularyFiltersResponse Source #
Create a value of ListVocabularyFiltersResponse 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:
ListVocabularyFilters, listVocabularyFiltersResponse_nextToken - If NextToken is present in your response, it indicates that not all
results are displayed. To view the next set of results, copy the string
associated with the NextToken parameter in your results output, then
run your request again including NextToken with the value of the
copied string. Repeat as needed to view all your results.
$sel:vocabularyFilters:ListVocabularyFiltersResponse', listVocabularyFiltersResponse_vocabularyFilters - Provides information about the custom vocabulary filters that match the
criteria specified in your request.
$sel:httpStatus:ListVocabularyFiltersResponse', listVocabularyFiltersResponse_httpStatus - The response's http status code.
Response Lenses
listVocabularyFiltersResponse_nextToken :: Lens' ListVocabularyFiltersResponse (Maybe Text) Source #
If NextToken is present in your response, it indicates that not all
results are displayed. To view the next set of results, copy the string
associated with the NextToken parameter in your results output, then
run your request again including NextToken with the value of the
copied string. Repeat as needed to view all your results.
listVocabularyFiltersResponse_vocabularyFilters :: Lens' ListVocabularyFiltersResponse (Maybe [VocabularyFilterInfo]) Source #
Provides information about the custom vocabulary filters that match the criteria specified in your request.
listVocabularyFiltersResponse_httpStatus :: Lens' ListVocabularyFiltersResponse Int Source #
The response's http status code.