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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a vocabulary with new values that you provide in a different text file from the one you used to create the vocabulary. The UpdateMedicalVocabulary operation overwrites all of the existing information with the values that you provide in the request.

Synopsis

Creating a Request

data UpdateMedicalVocabulary Source #

See: newUpdateMedicalVocabulary smart constructor.

Constructors

UpdateMedicalVocabulary'

Fields

vocabularyFileUri :: Maybe Text
The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you are calling. The following is the format for a URI:
```
 https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
```
For example:
```
https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt
```
For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.
For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.
vocabularyName :: Text
The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a vocabulary you've already made, you get a ConflictException error.
languageCode :: LanguageCode
The language code of the language used for the entries in the updated vocabulary. US English (en-US) is the only valid language code in Amazon Transcribe Medical.

Instances

Instances details

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

newUpdateMedicalVocabulary Source #

Arguments

:: Text	`$sel:vocabularyName:UpdateMedicalVocabulary'`
-> LanguageCode	`$sel:languageCode: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:

$sel:vocabularyFileUri:UpdateMedicalVocabulary', updateMedicalVocabulary_vocabularyFileUri - The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you are calling. The following is the format for a URI:

 https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

For example:

https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt

For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.

For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.

$sel:vocabularyName:UpdateMedicalVocabulary', updateMedicalVocabulary_vocabularyName - The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a vocabulary you've already made, you get a ConflictException error.

$sel:languageCode:UpdateMedicalVocabulary', updateMedicalVocabulary_languageCode - The language code of the language used for the entries in the updated vocabulary. US English (en-US) is the only valid language code in Amazon Transcribe Medical.

Request Lenses

updateMedicalVocabulary_vocabularyFileUri :: Lens' UpdateMedicalVocabulary (Maybe Text) Source #

The location in Amazon S3 of the text file that contains your custom vocabulary. The URI must be in the same Amazon Web Services Region as the resource that you are calling. The following is the format for a URI:

 https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

For example:

https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt

For more information about Amazon S3 object names, see Object Keys in the Amazon S3 Developer Guide.

For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.

updateMedicalVocabulary_vocabularyName :: Lens' UpdateMedicalVocabulary Text Source #

The name of the vocabulary to update. The name is case sensitive. If you try to update a vocabulary with the same name as a vocabulary you've already made, you get a ConflictException error.

updateMedicalVocabulary_languageCode :: Lens' UpdateMedicalVocabulary LanguageCode Source #

The language code of the language used for the entries in the updated vocabulary. US English (en-US) is the only valid language code in Amazon Transcribe Medical.

Destructuring the Response

data UpdateMedicalVocabularyResponse Source #

See: newUpdateMedicalVocabularyResponse smart constructor.

Constructors

UpdateMedicalVocabularyResponse'

Fields

languageCode :: Maybe LanguageCode
The language code for the language of the text file used to update the custom vocabulary. US English (en-US) is the only language supported in Amazon Transcribe Medical.
vocabularyName :: Maybe Text
The name of the updated vocabulary.
lastModifiedTime :: Maybe POSIX
The date and time that the vocabulary was updated.
vocabularyState :: Maybe VocabularyState
The processing state of the update to the vocabulary. When the VocabularyState field is READY, the vocabulary is ready to be used in a StartMedicalTranscriptionJob request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq UpdateMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.UpdateMedicalVocabulary Methods (==) :: UpdateMedicalVocabularyResponse -> UpdateMedicalVocabularyResponse -> Bool # (/=) :: UpdateMedicalVocabularyResponse -> UpdateMedicalVocabularyResponse -> Bool #
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 #
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 #
NFData UpdateMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.UpdateMedicalVocabulary Methods rnf :: UpdateMedicalVocabularyResponse -> () #
type Rep UpdateMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.UpdateMedicalVocabulary type Rep UpdateMedicalVocabularyResponse = D1 ('MetaData "UpdateMedicalVocabularyResponse" "Amazonka.Transcribe.UpdateMedicalVocabulary" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "UpdateMedicalVocabularyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "languageCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LanguageCode)) :: 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)))))

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:

$sel:languageCode:UpdateMedicalVocabulary', updateMedicalVocabularyResponse_languageCode - The language code for the language of the text file used to update the custom vocabulary. US English (en-US) is the only language supported in Amazon Transcribe Medical.

$sel:vocabularyName:UpdateMedicalVocabulary', updateMedicalVocabularyResponse_vocabularyName - The name of the updated vocabulary.

$sel:lastModifiedTime:UpdateMedicalVocabularyResponse', updateMedicalVocabularyResponse_lastModifiedTime - The date and time that the vocabulary was updated.

$sel:vocabularyState:UpdateMedicalVocabularyResponse', updateMedicalVocabularyResponse_vocabularyState - The processing state of the update to the vocabulary. When the VocabularyState field is READY, the vocabulary is ready to be used 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 for the language of the text file used to update the custom vocabulary. US English (en-US) is the only language supported in Amazon Transcribe Medical.

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

The name of the updated vocabulary.

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

The date and time that the vocabulary was updated.

updateMedicalVocabularyResponse_vocabularyState :: Lens' UpdateMedicalVocabularyResponse (Maybe VocabularyState) Source #

The processing state of the update to the vocabulary. When the VocabularyState field is READY, the vocabulary is ready to be used in a StartMedicalTranscriptionJob request.

updateMedicalVocabularyResponse_httpStatus :: Lens' UpdateMedicalVocabularyResponse Int Source #

The response's http status code.