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.ListVocabularies

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a list of custom vocabularies that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.

To get detailed information about a specific custom vocabulary, use the operation.

Synopsis

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

Creating a Request

data ListVocabularies Source #

See: newListVocabularies smart constructor.

Constructors

ListVocabularies'

Fields

maxResults :: Maybe Natural
The maximum number of custom vocabularies 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.
nameContains :: Maybe Text
Returns only the custom vocabularies that contain the specified string. The search is not case sensitive.
nextToken :: Maybe Text
If your ListVocabularies 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.
stateEquals :: Maybe VocabularyState
Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies are returned.

Instances

Instances details

ToJSON ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods toJSON :: ListVocabularies -> Value # toEncoding :: ListVocabularies -> Encoding # toJSONList :: [ListVocabularies] -> Value # toEncodingList :: [ListVocabularies] -> Encoding #
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 #
AWSRequest ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Associated Types type AWSResponse ListVocabularies # Methods request :: (Service -> Service) -> ListVocabularies -> Request ListVocabularies # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListVocabularies -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListVocabularies))) #
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 #
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 #
NFData ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods rnf :: ListVocabularies -> () #
Eq ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods (==) :: ListVocabularies -> ListVocabularies -> Bool # (/=) :: ListVocabularies -> ListVocabularies -> Bool #
Hashable ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods hashWithSalt :: Int -> ListVocabularies -> Int # hash :: ListVocabularies -> Int #
type AWSResponse ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies type AWSResponse ListVocabularies = ListVocabulariesResponse
type Rep ListVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies type Rep ListVocabularies = D1 ('MetaData "ListVocabularies" "Amazonka.Transcribe.ListVocabularies" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "ListVocabularies'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: 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)))))

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:maxResults:ListVocabularies', listVocabularies_maxResults - The maximum number of custom vocabularies 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:ListVocabularies', listVocabularies_nameContains - Returns only the custom vocabularies that contain the specified string. The search is not case sensitive.

ListVocabularies, listVocabularies_nextToken - If your ListVocabularies 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.

$sel:stateEquals:ListVocabularies', listVocabularies_stateEquals - Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies are returned.

Request Lenses

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

The maximum number of custom vocabularies 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.

listVocabularies_nameContains :: Lens' ListVocabularies (Maybe Text) Source #

Returns only the custom vocabularies that contain the specified string. The search is not case sensitive.

listVocabularies_nextToken :: Lens' ListVocabularies (Maybe Text) Source #

If your ListVocabularies 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.

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

Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies are returned.

Destructuring the Response

data ListVocabulariesResponse Source #

See: newListVocabulariesResponse smart constructor.

Constructors

ListVocabulariesResponse'

Fields

nextToken :: Maybe Text
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.
status :: Maybe VocabularyState
Lists all custom vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.
vocabularies :: Maybe [VocabularyInfo]
Provides information about the custom vocabularies that match the criteria specified in your request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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 #
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 #
NFData ListVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods rnf :: ListVocabulariesResponse -> () #
Eq ListVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies Methods (==) :: ListVocabulariesResponse -> ListVocabulariesResponse -> Bool # (/=) :: ListVocabulariesResponse -> ListVocabulariesResponse -> Bool #
type Rep ListVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListVocabularies type Rep ListVocabulariesResponse = D1 ('MetaData "ListVocabulariesResponse" "Amazonka.Transcribe.ListVocabularies" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "ListVocabulariesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VocabularyState))) :: (S1 ('MetaSel ('Just "vocabularies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VocabularyInfo])) :*: 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:

ListVocabularies, listVocabulariesResponse_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:status:ListVocabulariesResponse', listVocabulariesResponse_status - Lists all custom vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.

$sel:vocabularies:ListVocabulariesResponse', listVocabulariesResponse_vocabularies - Provides information about the custom vocabularies that match the criteria specified in your request.

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

Response Lenses

listVocabulariesResponse_nextToken :: Lens' ListVocabulariesResponse (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.

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

Lists all custom vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.

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

Provides information about the custom vocabularies that match the criteria specified in your request.

listVocabulariesResponse_httpStatus :: Lens' ListVocabulariesResponse Int Source #

The response's http status code.