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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of vocabularies that match the specified criteria. If you don't enter a value in any of the request parameters, returns the entire list of vocabularies.

Synopsis

Creating a Request

data ListMedicalVocabularies Source #

See: newListMedicalVocabularies smart constructor.

Constructors

ListMedicalVocabularies'

Fields

nameContains :: Maybe Text
Returns vocabularies whose names contain the specified string. The search is not case sensitive. ListMedicalVocabularies returns both "vocabularyname" and "VocabularyName".
nextToken :: Maybe Text
If the result of your previous request to ListMedicalVocabularies was truncated, include the NextToken to fetch the next set of vocabularies.
stateEquals :: Maybe VocabularyState
When specified, returns only vocabularies with the VocabularyState equal to the specified vocabulary state. Use this field to see which vocabularies are ready for your medical transcription jobs.
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 ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods (==) :: ListMedicalVocabularies -> ListMedicalVocabularies -> Bool # (/=) :: ListMedicalVocabularies -> ListMedicalVocabularies -> Bool #
Read ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods readsPrec :: Int -> ReadS ListMedicalVocabularies # readList :: ReadS [ListMedicalVocabularies] # readPrec :: ReadPrec ListMedicalVocabularies # readListPrec :: ReadPrec [ListMedicalVocabularies] #
Show ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods showsPrec :: Int -> ListMedicalVocabularies -> ShowS # show :: ListMedicalVocabularies -> String # showList :: [ListMedicalVocabularies] -> ShowS #
Generic ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Associated Types type Rep ListMedicalVocabularies :: Type -> Type # Methods from :: ListMedicalVocabularies -> Rep ListMedicalVocabularies x # to :: Rep ListMedicalVocabularies x -> ListMedicalVocabularies #
NFData ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods rnf :: ListMedicalVocabularies -> () #
Hashable ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods hashWithSalt :: Int -> ListMedicalVocabularies -> Int # hash :: ListMedicalVocabularies -> Int #
ToJSON ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods toJSON :: ListMedicalVocabularies -> Value # toEncoding :: ListMedicalVocabularies -> Encoding # toJSONList :: [ListMedicalVocabularies] -> Value # toEncodingList :: [ListMedicalVocabularies] -> Encoding #
AWSRequest ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Associated Types type AWSResponse ListMedicalVocabularies # Methods request :: ListMedicalVocabularies -> Request ListMedicalVocabularies # response :: MonadResource m => Logger -> Service -> Proxy ListMedicalVocabularies -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListMedicalVocabularies))) #
ToHeaders ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods toHeaders :: ListMedicalVocabularies -> [Header] #
ToPath ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods toPath :: ListMedicalVocabularies -> ByteString #
ToQuery ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods toQuery :: ListMedicalVocabularies -> QueryString #
type Rep ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies type Rep ListMedicalVocabularies = D1 ('MetaData "ListMedicalVocabularies" "Amazonka.Transcribe.ListMedicalVocabularies" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "ListMedicalVocabularies'" '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 ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies type AWSResponse ListMedicalVocabularies = ListMedicalVocabulariesResponse

newListMedicalVocabularies :: ListMedicalVocabularies Source #

Create a value of ListMedicalVocabularies 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:ListMedicalVocabularies', listMedicalVocabularies_nameContains - Returns vocabularies whose names contain the specified string. The search is not case sensitive. ListMedicalVocabularies returns both "vocabularyname" and "VocabularyName".

$sel:nextToken:ListMedicalVocabularies', listMedicalVocabularies_nextToken - If the result of your previous request to ListMedicalVocabularies was truncated, include the NextToken to fetch the next set of vocabularies.

$sel:stateEquals:ListMedicalVocabularies', listMedicalVocabularies_stateEquals - When specified, returns only vocabularies with the VocabularyState equal to the specified vocabulary state. Use this field to see which vocabularies are ready for your medical transcription jobs.

$sel:maxResults:ListMedicalVocabularies', listMedicalVocabularies_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

listMedicalVocabularies_nameContains :: Lens' ListMedicalVocabularies (Maybe Text) Source #

Returns vocabularies whose names contain the specified string. The search is not case sensitive. ListMedicalVocabularies returns both "vocabularyname" and "VocabularyName".

listMedicalVocabularies_nextToken :: Lens' ListMedicalVocabularies (Maybe Text) Source #

If the result of your previous request to ListMedicalVocabularies was truncated, include the NextToken to fetch the next set of vocabularies.

listMedicalVocabularies_stateEquals :: Lens' ListMedicalVocabularies (Maybe VocabularyState) Source #

When specified, returns only vocabularies with the VocabularyState equal to the specified vocabulary state. Use this field to see which vocabularies are ready for your medical transcription jobs.

listMedicalVocabularies_maxResults :: Lens' ListMedicalVocabularies (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 ListMedicalVocabulariesResponse Source #

See: newListMedicalVocabulariesResponse smart constructor.

Constructors

ListMedicalVocabulariesResponse'

Fields

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

Instances

Instances details

Eq ListMedicalVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods (==) :: ListMedicalVocabulariesResponse -> ListMedicalVocabulariesResponse -> Bool # (/=) :: ListMedicalVocabulariesResponse -> ListMedicalVocabulariesResponse -> Bool #
Read ListMedicalVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods readsPrec :: Int -> ReadS ListMedicalVocabulariesResponse # readList :: ReadS [ListMedicalVocabulariesResponse] # readPrec :: ReadPrec ListMedicalVocabulariesResponse # readListPrec :: ReadPrec [ListMedicalVocabulariesResponse] #
Show ListMedicalVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods showsPrec :: Int -> ListMedicalVocabulariesResponse -> ShowS # show :: ListMedicalVocabulariesResponse -> String # showList :: [ListMedicalVocabulariesResponse] -> ShowS #
Generic ListMedicalVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Associated Types type Rep ListMedicalVocabulariesResponse :: Type -> Type # Methods from :: ListMedicalVocabulariesResponse -> Rep ListMedicalVocabulariesResponse x # to :: Rep ListMedicalVocabulariesResponse x -> ListMedicalVocabulariesResponse #
NFData ListMedicalVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods rnf :: ListMedicalVocabulariesResponse -> () #
type Rep ListMedicalVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies type Rep ListMedicalVocabulariesResponse = D1 ('MetaData "ListMedicalVocabulariesResponse" "Amazonka.Transcribe.ListMedicalVocabularies" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "ListMedicalVocabulariesResponse'" '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))))

newListMedicalVocabulariesResponse Source #

Arguments

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

Create a value of ListMedicalVocabulariesResponse 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:ListMedicalVocabulariesResponse', listMedicalVocabulariesResponse_vocabularies - A list of objects that describe the vocabularies that match your search criteria.

$sel:status:ListMedicalVocabulariesResponse', listMedicalVocabulariesResponse_status - The requested vocabulary state.

$sel:nextToken:ListMedicalVocabularies', listMedicalVocabulariesResponse_nextToken - The ListMedicalVocabularies operation returns a page of vocabularies at a time. You set the maximum number of vocabularies to return on a page with the MaxResults parameter. If there are more jobs in the list will fit on a page, Amazon Transcribe Medical returns the NextPage token. To return the next page of vocabularies, include the token in the next request to the ListMedicalVocabularies operation .

$sel:httpStatus:ListMedicalVocabulariesResponse', listMedicalVocabulariesResponse_httpStatus - The response's http status code.

Response Lenses

listMedicalVocabulariesResponse_vocabularies :: Lens' ListMedicalVocabulariesResponse (Maybe [VocabularyInfo]) Source #

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

listMedicalVocabulariesResponse_status :: Lens' ListMedicalVocabulariesResponse (Maybe VocabularyState) Source #

The requested vocabulary state.

listMedicalVocabulariesResponse_nextToken :: Lens' ListMedicalVocabulariesResponse (Maybe Text) Source #

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

listMedicalVocabulariesResponse_httpStatus :: Lens' ListMedicalVocabulariesResponse Int Source #

The response's http status code.