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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates an existing custom medical vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.

Synopsis

Creating a Request

data UpdateMedicalVocabulary Source #

See: newUpdateMedicalVocabulary smart constructor.

Constructors

UpdateMedicalVocabulary'

Fields

vocabularyName :: Text
The name of the custom medical vocabulary you want to update. Custom medical vocabulary names are case sensitive.
languageCode :: LanguageCode
The language code that represents the language of the entries in the custom vocabulary you want to update. US English (en-US) is the only language supported with Amazon Transcribe Medical.
vocabularyFileUri :: Text
The Amazon S3 location of the text file that contains your custom medical vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.
Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

Instances

Instances details

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

newUpdateMedicalVocabulary Source #

Arguments

:: Text	`UpdateMedicalVocabulary`
-> LanguageCode	`UpdateMedicalVocabulary`
-> Text	`$sel:vocabularyFileUri:UpdateMedicalVocabulary'`
-> UpdateMedicalVocabulary

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

UpdateMedicalVocabulary, updateMedicalVocabulary_vocabularyName - The name of the custom medical vocabulary you want to update. Custom medical vocabulary names are case sensitive.

UpdateMedicalVocabulary, updateMedicalVocabulary_languageCode - The language code that represents the language of the entries in the custom vocabulary you want to update. US English (en-US) is the only language supported with Amazon Transcribe Medical.

$sel:vocabularyFileUri:UpdateMedicalVocabulary', updateMedicalVocabulary_vocabularyFileUri - The Amazon S3 location of the text file that contains your custom medical vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

Request Lenses

updateMedicalVocabulary_vocabularyName :: Lens' UpdateMedicalVocabulary Text Source #

The name of the custom medical vocabulary you want to update. Custom medical vocabulary names are case sensitive.

updateMedicalVocabulary_languageCode :: Lens' UpdateMedicalVocabulary LanguageCode Source #

The language code that represents the language of the entries in the custom vocabulary you want to update. US English (en-US) is the only language supported with Amazon Transcribe Medical.

updateMedicalVocabulary_vocabularyFileUri :: Lens' UpdateMedicalVocabulary Text Source #

The Amazon S3 location of the text file that contains your custom medical vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

Destructuring the Response

data UpdateMedicalVocabularyResponse Source #

See: newUpdateMedicalVocabularyResponse smart constructor.

Constructors

UpdateMedicalVocabularyResponse'

Fields

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 updated.
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 updated custom medical vocabulary.
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 UpdateMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.UpdateMedicalVocabulary Associated Types type Rep UpdateMedicalVocabularyResponse :: Type -> Type # Methods from :: UpdateMedicalVocabularyResponse -> Rep UpdateMedicalVocabularyResponse x # to :: Rep UpdateMedicalVocabularyResponse x -> UpdateMedicalVocabularyResponse #
Read UpdateMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.UpdateMedicalVocabulary Methods readsPrec :: Int -> ReadS UpdateMedicalVocabularyResponse # readList :: ReadS [UpdateMedicalVocabularyResponse] # readPrec :: ReadPrec UpdateMedicalVocabularyResponse # readListPrec :: ReadPrec [UpdateMedicalVocabularyResponse] #
Show UpdateMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.UpdateMedicalVocabulary Methods showsPrec :: Int -> UpdateMedicalVocabularyResponse -> ShowS # show :: UpdateMedicalVocabularyResponse -> String # showList :: [UpdateMedicalVocabularyResponse] -> ShowS #
NFData UpdateMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.UpdateMedicalVocabulary Methods rnf :: UpdateMedicalVocabularyResponse -> () #
Eq UpdateMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.UpdateMedicalVocabulary Methods (==) :: UpdateMedicalVocabularyResponse -> UpdateMedicalVocabularyResponse -> Bool # (/=) :: UpdateMedicalVocabularyResponse -> UpdateMedicalVocabularyResponse -> Bool #
type Rep UpdateMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.UpdateMedicalVocabulary type Rep UpdateMedicalVocabularyResponse = D1 ('MetaData "UpdateMedicalVocabularyResponse" "Amazonka.Transcribe.UpdateMedicalVocabulary" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "UpdateMedicalVocabularyResponse'" 'PrefixI 'True) ((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)))))

newUpdateMedicalVocabularyResponse Source #

Arguments

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

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

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

UpdateMedicalVocabularyResponse, updateMedicalVocabularyResponse_lastModifiedTime - The date and time the specified custom medical vocabulary was last updated.

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.

UpdateMedicalVocabulary, updateMedicalVocabularyResponse_vocabularyName - The name of the updated custom medical vocabulary.

UpdateMedicalVocabularyResponse, updateMedicalVocabularyResponse_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:UpdateMedicalVocabularyResponse', updateMedicalVocabularyResponse_httpStatus - The response's http status code.

Response Lenses

updateMedicalVocabularyResponse_languageCode :: Lens' UpdateMedicalVocabularyResponse (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.

updateMedicalVocabularyResponse_lastModifiedTime :: Lens' UpdateMedicalVocabularyResponse (Maybe UTCTime) Source #

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

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.

updateMedicalVocabularyResponse_vocabularyName :: Lens' UpdateMedicalVocabularyResponse (Maybe Text) Source #

The name of the updated custom medical vocabulary.

updateMedicalVocabularyResponse_vocabularyState :: Lens' UpdateMedicalVocabularyResponse (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.

updateMedicalVocabularyResponse_httpStatus :: Lens' UpdateMedicalVocabularyResponse Int Source #

The response's http status code.