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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides information about the specified custom medical vocabulary.

To view the status of the specified custom medical vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your vocabulary failed.

To get a list of your custom medical vocabularies, use the operation.

Synopsis

Creating a Request

data GetMedicalVocabulary Source #

See: newGetMedicalVocabulary smart constructor.

Constructors

GetMedicalVocabulary'
Fields vocabularyName :: Text The name of the custom medical vocabulary you want information about. Custom medical vocabulary names are case sensitive.

Instances

Instances details

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

newGetMedicalVocabulary Source #

Arguments

:: Text	`GetMedicalVocabulary`
-> GetMedicalVocabulary

Create a value of GetMedicalVocabulary 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:

GetMedicalVocabulary, getMedicalVocabulary_vocabularyName - The name of the custom medical vocabulary you want information about. Custom medical vocabulary names are case sensitive.

Request Lenses

getMedicalVocabulary_vocabularyName :: Lens' GetMedicalVocabulary Text Source #

The name of the custom medical vocabulary you want information about. Custom medical vocabulary names are case sensitive.

Destructuring the Response

data GetMedicalVocabularyResponse Source #

See: newGetMedicalVocabularyResponse smart constructor.

Constructors

GetMedicalVocabularyResponse'

Fields

downloadUri :: Maybe Text
The S3 location where the specified custom medical vocabulary is stored; use this URI to view or download the custom vocabulary.
failureReason :: Maybe Text
If VocabularyState is FAILED, FailureReason contains information about why the custom medical vocabulary request failed. See also: Common Errors.
languageCode :: Maybe LanguageCode
The language code you selected for your custom medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
lastModifiedTime :: Maybe POSIX
The date and time the specified custom medical vocabulary was last modified.
Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
vocabularyName :: Maybe Text
The name of the custom medical vocabulary you requested information about.
vocabularyState :: Maybe VocabularyState
The processing state of your custom medical vocabulary. If the state is READY, you can use the custom vocabulary in a StartMedicalTranscriptionJob request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.GetMedicalVocabulary Associated Types type Rep GetMedicalVocabularyResponse :: Type -> Type # Methods from :: GetMedicalVocabularyResponse -> Rep GetMedicalVocabularyResponse x # to :: Rep GetMedicalVocabularyResponse x -> GetMedicalVocabularyResponse #
Read GetMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.GetMedicalVocabulary Methods readsPrec :: Int -> ReadS GetMedicalVocabularyResponse # readList :: ReadS [GetMedicalVocabularyResponse] # readPrec :: ReadPrec GetMedicalVocabularyResponse # readListPrec :: ReadPrec [GetMedicalVocabularyResponse] #
Show GetMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.GetMedicalVocabulary Methods showsPrec :: Int -> GetMedicalVocabularyResponse -> ShowS # show :: GetMedicalVocabularyResponse -> String # showList :: [GetMedicalVocabularyResponse] -> ShowS #
NFData GetMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.GetMedicalVocabulary Methods rnf :: GetMedicalVocabularyResponse -> () #
Eq GetMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.GetMedicalVocabulary Methods (==) :: GetMedicalVocabularyResponse -> GetMedicalVocabularyResponse -> Bool # (/=) :: GetMedicalVocabularyResponse -> GetMedicalVocabularyResponse -> Bool #
type Rep GetMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.GetMedicalVocabulary type Rep GetMedicalVocabularyResponse = D1 ('MetaData "GetMedicalVocabularyResponse" "Amazonka.Transcribe.GetMedicalVocabulary" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "GetMedicalVocabularyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "downloadUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)))) :: ((S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "vocabularyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "vocabularyState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VocabularyState)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetMedicalVocabularyResponse Source #

Arguments

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

Create a value of GetMedicalVocabularyResponse 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:downloadUri:GetMedicalVocabularyResponse', getMedicalVocabularyResponse_downloadUri - The S3 location where the specified custom medical vocabulary is stored; use this URI to view or download the custom vocabulary.

GetMedicalVocabularyResponse, getMedicalVocabularyResponse_failureReason - If VocabularyState is FAILED, FailureReason contains information about why the custom medical vocabulary request failed. See also: Common Errors.

GetMedicalVocabularyResponse, getMedicalVocabularyResponse_languageCode - The language code you selected for your custom medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.

GetMedicalVocabularyResponse, getMedicalVocabularyResponse_lastModifiedTime - The date and time the specified custom medical vocabulary was last modified.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

GetMedicalVocabulary, getMedicalVocabularyResponse_vocabularyName - The name of the custom medical vocabulary you requested information about.

GetMedicalVocabularyResponse, getMedicalVocabularyResponse_vocabularyState - The processing state of your custom medical vocabulary. If the state is READY, you can use the custom vocabulary in a StartMedicalTranscriptionJob request.

$sel:httpStatus:GetMedicalVocabularyResponse', getMedicalVocabularyResponse_httpStatus - The response's http status code.

Response Lenses

getMedicalVocabularyResponse_downloadUri :: Lens' GetMedicalVocabularyResponse (Maybe Text) Source #

The S3 location where the specified custom medical vocabulary is stored; use this URI to view or download the custom vocabulary.

getMedicalVocabularyResponse_failureReason :: Lens' GetMedicalVocabularyResponse (Maybe Text) Source #

If VocabularyState is FAILED, FailureReason contains information about why the custom medical vocabulary request failed. See also: Common Errors.

getMedicalVocabularyResponse_languageCode :: Lens' GetMedicalVocabularyResponse (Maybe LanguageCode) Source #

The language code you selected for your custom medical vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.

getMedicalVocabularyResponse_lastModifiedTime :: Lens' GetMedicalVocabularyResponse (Maybe UTCTime) Source #

The date and time the specified custom medical vocabulary was last modified.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.

getMedicalVocabularyResponse_vocabularyName :: Lens' GetMedicalVocabularyResponse (Maybe Text) Source #

The name of the custom medical vocabulary you requested information about.

getMedicalVocabularyResponse_vocabularyState :: Lens' GetMedicalVocabularyResponse (Maybe VocabularyState) Source #

The processing state of your custom medical vocabulary. If the state is READY, you can use the custom vocabulary in a StartMedicalTranscriptionJob request.

getMedicalVocabularyResponse_httpStatus :: Lens' GetMedicalVocabularyResponse Int Source #

The response's http status code.