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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about a medical vocabulary.

Synopsis

Creating a Request

data GetMedicalVocabulary Source #

See: newGetMedicalVocabulary smart constructor.

Constructors

GetMedicalVocabulary'
Fields vocabularyName :: Text The name of the vocabulary that you want information about. The value is case sensitive.

Instances

Instances details

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

newGetMedicalVocabulary Source #

Arguments

:: Text	`$sel:vocabularyName: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:

$sel:vocabularyName:GetMedicalVocabulary', getMedicalVocabulary_vocabularyName - The name of the vocabulary that you want information about. The value is case sensitive.

Request Lenses

getMedicalVocabulary_vocabularyName :: Lens' GetMedicalVocabulary Text Source #

The name of the vocabulary that you want information about. The value is case sensitive.

Destructuring the Response

data GetMedicalVocabularyResponse Source #

See: newGetMedicalVocabularyResponse smart constructor.

Constructors

GetMedicalVocabularyResponse'

Fields

failureReason :: Maybe Text
If the VocabularyState is FAILED, this field contains information about why the job failed.
languageCode :: Maybe LanguageCode
The valid language code for your vocabulary entries.
downloadUri :: Maybe Text
The location in Amazon S3 where the vocabulary is stored. Use this URI to get the contents of the vocabulary. You can download your vocabulary from the URI for a limited time.
vocabularyName :: Maybe Text
The name of the vocabulary returned by Amazon Transcribe Medical.
lastModifiedTime :: Maybe POSIX
The date and time that the vocabulary was last modified with a text file different from the one that was previously used.
vocabularyState :: Maybe VocabularyState
The processing state of the vocabulary. If the VocabularyState is READY then you can use it in the StartMedicalTranscriptionJob operation.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.GetMedicalVocabulary Methods (==) :: GetMedicalVocabularyResponse -> GetMedicalVocabularyResponse -> Bool # (/=) :: GetMedicalVocabularyResponse -> GetMedicalVocabularyResponse -> Bool #
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 #
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 #
NFData GetMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.GetMedicalVocabulary Methods rnf :: GetMedicalVocabularyResponse -> () #
type Rep GetMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.GetMedicalVocabulary type Rep GetMedicalVocabularyResponse = D1 ('MetaData "GetMedicalVocabularyResponse" "Amazonka.Transcribe.GetMedicalVocabulary" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "GetMedicalVocabularyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :: S1 ('MetaSel ('Just "downloadUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "vocabularyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (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:failureReason:GetMedicalVocabularyResponse', getMedicalVocabularyResponse_failureReason - If the VocabularyState is FAILED, this field contains information about why the job failed.

$sel:languageCode:GetMedicalVocabularyResponse', getMedicalVocabularyResponse_languageCode - The valid language code for your vocabulary entries.

$sel:downloadUri:GetMedicalVocabularyResponse', getMedicalVocabularyResponse_downloadUri - The location in Amazon S3 where the vocabulary is stored. Use this URI to get the contents of the vocabulary. You can download your vocabulary from the URI for a limited time.

$sel:vocabularyName:GetMedicalVocabulary', getMedicalVocabularyResponse_vocabularyName - The name of the vocabulary returned by Amazon Transcribe Medical.

$sel:lastModifiedTime:GetMedicalVocabularyResponse', getMedicalVocabularyResponse_lastModifiedTime - The date and time that the vocabulary was last modified with a text file different from the one that was previously used.

$sel:vocabularyState:GetMedicalVocabularyResponse', getMedicalVocabularyResponse_vocabularyState - The processing state of the vocabulary. If the VocabularyState is READY then you can use it in the StartMedicalTranscriptionJob operation.

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

Response Lenses

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

If the VocabularyState is FAILED, this field contains information about why the job failed.

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

The valid language code for your vocabulary entries.

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

The location in Amazon S3 where the vocabulary is stored. Use this URI to get the contents of the vocabulary. You can download your vocabulary from the URI for a limited time.

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

The name of the vocabulary returned by Amazon Transcribe Medical.

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

The date and time that the vocabulary was last modified with a text file different from the one that was previously used.

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

The processing state of the vocabulary. If the VocabularyState is READY then you can use it in the StartMedicalTranscriptionJob operation.

getMedicalVocabularyResponse_httpStatus :: Lens' GetMedicalVocabularyResponse Int Source #

The response's http status code.