Copyright	(c) 2013-2021 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

Amazonka.Transcribe.ListVocabularies

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

Synopsis

data ListVocabularies = ListVocabularies' {
- nameContains :: Maybe Text
- nextToken :: Maybe Text
- stateEquals :: Maybe VocabularyState
- maxResults :: Maybe Natural
}
newListVocabularies :: ListVocabularies
listVocabularies_nameContains :: Lens' ListVocabularies (Maybe Text)
listVocabularies_nextToken :: Lens' ListVocabularies (Maybe Text)
listVocabularies_stateEquals :: Lens' ListVocabularies (Maybe VocabularyState)
listVocabularies_maxResults :: Lens' ListVocabularies (Maybe Natural)
data ListVocabulariesResponse = ListVocabulariesResponse' {
- vocabularies :: Maybe [VocabularyInfo]
- status :: Maybe VocabularyState
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListVocabulariesResponse :: Int -> ListVocabulariesResponse
listVocabulariesResponse_vocabularies :: Lens' ListVocabulariesResponse (Maybe [VocabularyInfo])
listVocabulariesResponse_status :: Lens' ListVocabulariesResponse (Maybe VocabularyState)
listVocabulariesResponse_nextToken :: Lens' ListVocabulariesResponse (Maybe Text)
listVocabulariesResponse_httpStatus :: Lens' ListVocabulariesResponse Int

Creating a Request

data ListVocabularies Source #

See: newListVocabularies smart constructor.

Constructors

ListVocabularies'

Fields

nameContains :: Maybe Text
When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is not case sensitive, ListVocabularies returns both "vocabularyname" and "VocabularyName" in the response list.
nextToken :: Maybe Text
If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.
stateEquals :: Maybe VocabularyState
When specified, only returns vocabularies with the VocabularyState field equal to the specified state.
maxResults :: Maybe Natural
The maximum number of vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Instances

Instances details

Eq ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods (==) :: ListVocabularies -> ListVocabularies -> Bool # (/=) :: ListVocabularies -> ListVocabularies -> Bool #
Read ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods readsPrec :: Int -> ReadS ListVocabularies # readList :: ReadS [ListVocabularies] # readPrec :: ReadPrec ListVocabularies # readListPrec :: ReadPrec [ListVocabularies] #
Show ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods showsPrec :: Int -> ListVocabularies -> ShowS # show :: ListVocabularies -> String # showList :: [ListVocabularies] -> ShowS #
Generic ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Associated Types type Rep ListVocabularies :: Type -> Type # Methods from :: ListVocabularies -> Rep ListVocabularies x # to :: Rep ListVocabularies x -> ListVocabularies #
NFData ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods rnf :: ListVocabularies -> () #
Hashable ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods hashWithSalt :: Int -> ListVocabularies -> Int # hash :: ListVocabularies -> Int #
ToJSON ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods toJSON :: ListVocabularies -> Value # toEncoding :: ListVocabularies -> Encoding # toJSONList :: [ListVocabularies] -> Value # toEncodingList :: [ListVocabularies] -> Encoding #
AWSRequest ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Associated Types type AWSResponse ListVocabularies # Methods request :: ListVocabularies -> Request ListVocabularies # response :: MonadResource m => Logger -> Service -> Proxy ListVocabularies -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListVocabularies))) #
ToHeaders ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods toHeaders :: ListVocabularies -> [Header] #
ToPath ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods toPath :: ListVocabularies -> ByteString #
ToQuery ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods toQuery :: ListVocabularies -> QueryString #
type Rep ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies type Rep ListVocabularies = D1 ('MetaData "ListVocabularies" "Amazonka.Transcribe.ListVocabularies" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "ListVocabularies'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "stateEquals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VocabularyState)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies type AWSResponse ListVocabularies = ListVocabulariesResponse

newListVocabularies :: ListVocabularies Source #

Create a value of ListVocabularies 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:nameContains:ListVocabularies', listVocabularies_nameContains - When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is not case sensitive, ListVocabularies returns both "vocabularyname" and "VocabularyName" in the response list.

$sel:nextToken:ListVocabularies', listVocabularies_nextToken - If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.

$sel:stateEquals:ListVocabularies', listVocabularies_stateEquals - When specified, only returns vocabularies with the VocabularyState field equal to the specified state.

$sel:maxResults:ListVocabularies', listVocabularies_maxResults - The maximum number of vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Request Lenses

listVocabularies_nameContains :: 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 not case sensitive, ListVocabularies returns both "vocabularyname" and "VocabularyName" in the response list.

listVocabularies_nextToken :: 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.

listVocabularies_stateEquals :: Lens' ListVocabularies (Maybe VocabularyState) Source #

When specified, only returns vocabularies with the VocabularyState field equal to the specified state.

listVocabularies_maxResults :: Lens' ListVocabularies (Maybe Natural) Source #

The maximum number of vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Destructuring the Response

data ListVocabulariesResponse Source #

See: newListVocabulariesResponse smart constructor.

Constructors

ListVocabulariesResponse'

Fields

vocabularies :: Maybe [VocabularyInfo]
A list of objects that describe the vocabularies that match the search criteria in the request.
status :: Maybe VocabularyState
The requested vocabulary state.
nextToken :: Maybe Text
The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set in the MaxResults parameter. If there are more jobs in the list than will fit on the page, Amazon Transcribe returns the NextPage token. To return in the next page of jobs, include the token in the next request to the ListVocabularies operation.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods (==) :: ListVocabulariesResponse -> ListVocabulariesResponse -> Bool # (/=) :: ListVocabulariesResponse -> ListVocabulariesResponse -> Bool #
Read ListVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods readsPrec :: Int -> ReadS ListVocabulariesResponse # readList :: ReadS [ListVocabulariesResponse] # readPrec :: ReadPrec ListVocabulariesResponse # readListPrec :: ReadPrec [ListVocabulariesResponse] #
Show ListVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods showsPrec :: Int -> ListVocabulariesResponse -> ShowS # show :: ListVocabulariesResponse -> String # showList :: [ListVocabulariesResponse] -> ShowS #
Generic ListVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Associated Types type Rep ListVocabulariesResponse :: Type -> Type # Methods from :: ListVocabulariesResponse -> Rep ListVocabulariesResponse x # to :: Rep ListVocabulariesResponse x -> ListVocabulariesResponse #
NFData ListVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods rnf :: ListVocabulariesResponse -> () #
type Rep ListVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies type Rep ListVocabulariesResponse = D1 ('MetaData "ListVocabulariesResponse" "Amazonka.Transcribe.ListVocabularies" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "ListVocabulariesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "vocabularies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VocabularyInfo])) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VocabularyState))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListVocabulariesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListVocabulariesResponse'`
-> ListVocabulariesResponse

Create a value of ListVocabulariesResponse 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:vocabularies:ListVocabulariesResponse', listVocabulariesResponse_vocabularies - A list of objects that describe the vocabularies that match the search criteria in the request.

$sel:status:ListVocabulariesResponse', listVocabulariesResponse_status - The requested vocabulary state.

$sel:nextToken:ListVocabularies', listVocabulariesResponse_nextToken - The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set in the MaxResults parameter. If there are more jobs in the list than will fit on the page, Amazon Transcribe returns the NextPage token. To return in the next page of jobs, include the token in the next request to the ListVocabularies operation.

$sel:httpStatus:ListVocabulariesResponse', listVocabulariesResponse_httpStatus - The response's http status code.

Response Lenses

listVocabulariesResponse_vocabularies :: Lens' ListVocabulariesResponse (Maybe [VocabularyInfo]) Source #

A list of objects that describe the vocabularies that match the search criteria in the request.

listVocabulariesResponse_status :: Lens' ListVocabulariesResponse (Maybe VocabularyState) Source #

The requested vocabulary state.

listVocabulariesResponse_nextToken :: Lens' ListVocabulariesResponse (Maybe Text) Source #

The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set in the MaxResults parameter. If there are more jobs in the list than will fit on the page, Amazon Transcribe returns the NextPage token. To return in the next page of jobs, include the token in the next request to the ListVocabularies operation.

listVocabulariesResponse_httpStatus :: Lens' ListVocabulariesResponse Int Source #

The response's http status code.