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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new custom medical vocabulary.

Before creating a new custom medical vocabulary, you must first upload a text file that contains your new entries, phrases, and terms into an Amazon S3 bucket. Note that this differs from , where you can include a list of terms within your request using the Phrases flag; CreateMedicalVocabulary does not support the Phrases flag.

Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

For more information, see Custom vocabularies.

Synopsis

Creating a Request

data CreateMedicalVocabulary Source #

See: newCreateMedicalVocabulary smart constructor.

Constructors

CreateMedicalVocabulary'

Fields

tags :: Maybe (NonEmpty Tag)
Adds one or more custom tags, each in the form of a key:value pair, to a new custom medical vocabulary at the time you create this new custom vocabulary.
To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
vocabularyName :: Text
A unique name, chosen by you, for your new custom medical vocabulary.
This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom medical vocabulary with the same name as an existing custom medical vocabulary, you get a ConflictException error.
languageCode :: LanguageCode
The language code that represents the language of the entries in your custom vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.
vocabularyFileUri :: Text
The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary. The URI must be 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 CreateMedicalVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Methods toJSON :: CreateMedicalVocabulary -> Value # toEncoding :: CreateMedicalVocabulary -> Encoding # toJSONList :: [CreateMedicalVocabulary] -> Value # toEncodingList :: [CreateMedicalVocabulary] -> Encoding #
ToHeaders CreateMedicalVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Methods toHeaders :: CreateMedicalVocabulary -> [Header] #
ToPath CreateMedicalVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Methods toPath :: CreateMedicalVocabulary -> ByteString #
ToQuery CreateMedicalVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Methods toQuery :: CreateMedicalVocabulary -> QueryString #
AWSRequest CreateMedicalVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Associated Types type AWSResponse CreateMedicalVocabulary # Methods request :: (Service -> Service) -> CreateMedicalVocabulary -> Request CreateMedicalVocabulary # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateMedicalVocabulary -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateMedicalVocabulary))) #
Generic CreateMedicalVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Associated Types type Rep CreateMedicalVocabulary :: Type -> Type # Methods from :: CreateMedicalVocabulary -> Rep CreateMedicalVocabulary x # to :: Rep CreateMedicalVocabulary x -> CreateMedicalVocabulary #
Read CreateMedicalVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Methods readsPrec :: Int -> ReadS CreateMedicalVocabulary # readList :: ReadS [CreateMedicalVocabulary] # readPrec :: ReadPrec CreateMedicalVocabulary # readListPrec :: ReadPrec [CreateMedicalVocabulary] #
Show CreateMedicalVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Methods showsPrec :: Int -> CreateMedicalVocabulary -> ShowS # show :: CreateMedicalVocabulary -> String # showList :: [CreateMedicalVocabulary] -> ShowS #
NFData CreateMedicalVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Methods rnf :: CreateMedicalVocabulary -> () #
Eq CreateMedicalVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Methods (==) :: CreateMedicalVocabulary -> CreateMedicalVocabulary -> Bool # (/=) :: CreateMedicalVocabulary -> CreateMedicalVocabulary -> Bool #
Hashable CreateMedicalVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Methods hashWithSalt :: Int -> CreateMedicalVocabulary -> Int # hash :: CreateMedicalVocabulary -> Int #
type AWSResponse CreateMedicalVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary type AWSResponse CreateMedicalVocabulary = CreateMedicalVocabularyResponse
type Rep CreateMedicalVocabulary Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary type Rep CreateMedicalVocabulary = D1 ('MetaData "CreateMedicalVocabulary" "Amazonka.Transcribe.CreateMedicalVocabulary" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "CreateMedicalVocabulary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :: 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))))

newCreateMedicalVocabulary Source #

Arguments

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

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

CreateMedicalVocabulary, createMedicalVocabulary_tags - Adds one or more custom tags, each in the form of a key:value pair, to a new custom medical vocabulary at the time you create this new custom vocabulary.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

CreateMedicalVocabulary, createMedicalVocabulary_vocabularyName - A unique name, chosen by you, for your new custom medical vocabulary.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom medical vocabulary with the same name as an existing custom medical vocabulary, you get a ConflictException error.

CreateMedicalVocabulary, createMedicalVocabulary_languageCode - The language code that represents the language of the entries in your custom vocabulary. US English (en-US) is the only language supported with Amazon Transcribe Medical.

$sel:vocabularyFileUri:CreateMedicalVocabulary', createMedicalVocabulary_vocabularyFileUri - The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary. The URI must be 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

createMedicalVocabulary_tags :: Lens' CreateMedicalVocabulary (Maybe (NonEmpty Tag)) Source #

Adds one or more custom tags, each in the form of a key:value pair, to a new custom medical vocabulary at the time you create this new custom vocabulary.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

createMedicalVocabulary_vocabularyName :: Lens' CreateMedicalVocabulary Text Source #

A unique name, chosen by you, for your new custom medical vocabulary.

This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom medical vocabulary with the same name as an existing custom medical vocabulary, you get a ConflictException error.

createMedicalVocabulary_languageCode :: Lens' CreateMedicalVocabulary LanguageCode Source #

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

createMedicalVocabulary_vocabularyFileUri :: Lens' CreateMedicalVocabulary Text Source #

The Amazon S3 location (URI) of the text file that contains your custom medical vocabulary. The URI must be 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 CreateMedicalVocabularyResponse Source #

See: newCreateMedicalVocabularyResponse smart constructor.

Constructors

CreateMedicalVocabularyResponse'

Fields

failureReason :: Maybe Text
If VocabularyState is FAILED, FailureReason contains information about why the medical transcription job 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 you created your custom medical vocabulary.
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 you chose for your 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 CreateMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Associated Types type Rep CreateMedicalVocabularyResponse :: Type -> Type # Methods from :: CreateMedicalVocabularyResponse -> Rep CreateMedicalVocabularyResponse x # to :: Rep CreateMedicalVocabularyResponse x -> CreateMedicalVocabularyResponse #
Read CreateMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Methods readsPrec :: Int -> ReadS CreateMedicalVocabularyResponse # readList :: ReadS [CreateMedicalVocabularyResponse] # readPrec :: ReadPrec CreateMedicalVocabularyResponse # readListPrec :: ReadPrec [CreateMedicalVocabularyResponse] #
Show CreateMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Methods showsPrec :: Int -> CreateMedicalVocabularyResponse -> ShowS # show :: CreateMedicalVocabularyResponse -> String # showList :: [CreateMedicalVocabularyResponse] -> ShowS #
NFData CreateMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Methods rnf :: CreateMedicalVocabularyResponse -> () #
Eq CreateMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary Methods (==) :: CreateMedicalVocabularyResponse -> CreateMedicalVocabularyResponse -> Bool # (/=) :: CreateMedicalVocabularyResponse -> CreateMedicalVocabularyResponse -> Bool #
type Rep CreateMedicalVocabularyResponse Source #
Instance details Defined in Amazonka.Transcribe.CreateMedicalVocabulary type Rep CreateMedicalVocabularyResponse = D1 ('MetaData "CreateMedicalVocabularyResponse" "Amazonka.Transcribe.CreateMedicalVocabulary" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "CreateMedicalVocabularyResponse'" '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 "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)))))

newCreateMedicalVocabularyResponse Source #

Arguments

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

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

CreateMedicalVocabularyResponse, createMedicalVocabularyResponse_failureReason - If VocabularyState is FAILED, FailureReason contains information about why the medical transcription job request failed. See also: Common Errors.

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

CreateMedicalVocabularyResponse, createMedicalVocabularyResponse_lastModifiedTime - The date and time you created your custom medical vocabulary.

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.

CreateMedicalVocabulary, createMedicalVocabularyResponse_vocabularyName - The name you chose for your custom medical vocabulary.

CreateMedicalVocabularyResponse, createMedicalVocabularyResponse_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:CreateMedicalVocabularyResponse', createMedicalVocabularyResponse_httpStatus - The response's http status code.

Response Lenses

createMedicalVocabularyResponse_failureReason :: Lens' CreateMedicalVocabularyResponse (Maybe Text) Source #

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

createMedicalVocabularyResponse_languageCode :: Lens' CreateMedicalVocabularyResponse (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.

createMedicalVocabularyResponse_lastModifiedTime :: Lens' CreateMedicalVocabularyResponse (Maybe UTCTime) Source #

The date and time you created your custom medical vocabulary.

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.

createMedicalVocabularyResponse_vocabularyName :: Lens' CreateMedicalVocabularyResponse (Maybe Text) Source #

The name you chose for your custom medical vocabulary.

createMedicalVocabularyResponse_vocabularyState :: Lens' CreateMedicalVocabularyResponse (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.

createMedicalVocabularyResponse_httpStatus :: Lens' CreateMedicalVocabularyResponse Int Source #

The response's http status code.