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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

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

Synopsis

Creating a Request

data ListMedicalVocabularies Source #

See: newListMedicalVocabularies smart constructor.

Constructors

ListMedicalVocabularies'

Fields

maxResults :: Maybe Natural
The maximum number of custom medical 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 medical vocabularies that contain the specified string. The search is not case sensitive.
nextToken :: Maybe Text
If your ListMedicalVocabularies 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 medical vocabularies with the specified state. Custom 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 ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods toJSON :: ListMedicalVocabularies -> Value # toEncoding :: ListMedicalVocabularies -> Encoding # toJSONList :: [ListMedicalVocabularies] -> Value # toEncodingList :: [ListMedicalVocabularies] -> Encoding #
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 #
AWSRequest ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Associated Types type AWSResponse ListMedicalVocabularies # Methods request :: (Service -> Service) -> ListMedicalVocabularies -> Request ListMedicalVocabularies # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListMedicalVocabularies -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListMedicalVocabularies))) #
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 #
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 #
NFData ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods rnf :: ListMedicalVocabularies -> () #
Eq ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods (==) :: ListMedicalVocabularies -> ListMedicalVocabularies -> Bool # (/=) :: ListMedicalVocabularies -> ListMedicalVocabularies -> Bool #
Hashable ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods hashWithSalt :: Int -> ListMedicalVocabularies -> Int # hash :: ListMedicalVocabularies -> Int #
type AWSResponse ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies type AWSResponse ListMedicalVocabularies = ListMedicalVocabulariesResponse
type Rep ListMedicalVocabularies Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies type Rep ListMedicalVocabularies = D1 ('MetaData "ListMedicalVocabularies" "Amazonka.Transcribe.ListMedicalVocabularies" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "ListMedicalVocabularies'" '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)))))

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

ListMedicalVocabularies, listMedicalVocabularies_nextToken - If your ListMedicalVocabularies 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:ListMedicalVocabularies', listMedicalVocabularies_stateEquals - Returns only custom medical vocabularies with the specified state. Custom 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

listMedicalVocabularies_maxResults :: Lens' ListMedicalVocabularies (Maybe Natural) Source #

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

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

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

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

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

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

Returns only custom medical vocabularies with the specified state. Custom 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 ListMedicalVocabulariesResponse Source #

See: newListMedicalVocabulariesResponse smart constructor.

Constructors

ListMedicalVocabulariesResponse'

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

Instances

Instances details

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 #
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 #
NFData ListMedicalVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods rnf :: ListMedicalVocabulariesResponse -> () #
Eq ListMedicalVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies Methods (==) :: ListMedicalVocabulariesResponse -> ListMedicalVocabulariesResponse -> Bool # (/=) :: ListMedicalVocabulariesResponse -> ListMedicalVocabulariesResponse -> Bool #
type Rep ListMedicalVocabulariesResponse Source #
Instance details Defined in Amazonka.Transcribe.ListMedicalVocabularies type Rep ListMedicalVocabulariesResponse = D1 ('MetaData "ListMedicalVocabulariesResponse" "Amazonka.Transcribe.ListMedicalVocabularies" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "ListMedicalVocabulariesResponse'" '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))))

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:

ListMedicalVocabularies, listMedicalVocabulariesResponse_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:ListMedicalVocabulariesResponse', listMedicalVocabulariesResponse_status - Lists all custom medical vocabularies that have the status specified in your request. Custom vocabularies are ordered by creation date, with the newest vocabulary first.

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

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

Response Lenses

listMedicalVocabulariesResponse_nextToken :: Lens' ListMedicalVocabulariesResponse (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.

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

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

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

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

listMedicalVocabulariesResponse_httpStatus :: Lens' ListMedicalVocabulariesResponse Int Source #

The response's http status code.