amazonka-transcribe-2.0: Amazon Transcribe Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Transcribe.UpdateVocabulary

Description

Updates an existing custom 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 UpdateVocabulary Source #

See: newUpdateVocabulary smart constructor.

Constructors

UpdateVocabulary' 

Fields

  • phrases :: Maybe [Text]

    Use this parameter if you want to update your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter.

    Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other.

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

  • vocabularyFileUri :: Maybe Text

    The Amazon S3 location of the text file that contains your custom 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

    Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.

  • vocabularyName :: Text

    The name of the custom vocabulary you want to update. Custom 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. Each custom vocabulary must contain terms in only one language.

    A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.

    For a list of supported languages and their associated language codes, refer to the Supported languages table.

Instances

Instances details
ToJSON UpdateVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

ToHeaders UpdateVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

ToPath UpdateVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

ToQuery UpdateVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

AWSRequest UpdateVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

Associated Types

type AWSResponse UpdateVocabulary #

Generic UpdateVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

Associated Types

type Rep UpdateVocabulary :: Type -> Type #

Read UpdateVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

Show UpdateVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

NFData UpdateVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

Methods

rnf :: UpdateVocabulary -> () #

Eq UpdateVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

Hashable UpdateVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

type AWSResponse UpdateVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

type Rep UpdateVocabulary Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

type Rep UpdateVocabulary = D1 ('MetaData "UpdateVocabulary" "Amazonka.Transcribe.UpdateVocabulary" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "UpdateVocabulary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "phrases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: 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))))

newUpdateVocabulary Source #

Create a value of UpdateVocabulary 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:phrases:UpdateVocabulary', updateVocabulary_phrases - Use this parameter if you want to update your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter.

Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other.

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

$sel:vocabularyFileUri:UpdateVocabulary', updateVocabulary_vocabularyFileUri - The Amazon S3 location of the text file that contains your custom 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

Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.

UpdateVocabulary, updateVocabulary_vocabularyName - The name of the custom vocabulary you want to update. Custom vocabulary names are case sensitive.

UpdateVocabulary, updateVocabulary_languageCode - The language code that represents the language of the entries in the custom vocabulary you want to update. Each custom vocabulary must contain terms in only one language.

A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

Request Lenses

updateVocabulary_phrases :: Lens' UpdateVocabulary (Maybe [Text]) Source #

Use this parameter if you want to update your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter.

Note that if you include Phrases in your request, you cannot use VocabularyFileUri; you must choose one or the other.

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

updateVocabulary_vocabularyFileUri :: Lens' UpdateVocabulary (Maybe Text) Source #

The Amazon S3 location of the text file that contains your custom 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

Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.

updateVocabulary_vocabularyName :: Lens' UpdateVocabulary Text Source #

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

updateVocabulary_languageCode :: Lens' UpdateVocabulary LanguageCode Source #

The language code that represents the language of the entries in the custom vocabulary you want to update. Each custom vocabulary must contain terms in only one language.

A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English (en-US), you can only apply this custom vocabulary to files that contain English audio.

For a list of supported languages and their associated language codes, refer to the Supported languages table.

Destructuring the Response

data UpdateVocabularyResponse Source #

See: newUpdateVocabularyResponse smart constructor.

Constructors

UpdateVocabularyResponse' 

Fields

  • languageCode :: Maybe LanguageCode

    The language code you selected for your custom vocabulary.

  • lastModifiedTime :: Maybe POSIX

    The date and time the specified custom 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 vocabulary.

  • vocabularyState :: Maybe VocabularyState

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic UpdateVocabularyResponse Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

Associated Types

type Rep UpdateVocabularyResponse :: Type -> Type #

Read UpdateVocabularyResponse Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

Show UpdateVocabularyResponse Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

NFData UpdateVocabularyResponse Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

Eq UpdateVocabularyResponse Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

type Rep UpdateVocabularyResponse Source # 
Instance details

Defined in Amazonka.Transcribe.UpdateVocabulary

type Rep UpdateVocabularyResponse = D1 ('MetaData "UpdateVocabularyResponse" "Amazonka.Transcribe.UpdateVocabulary" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "UpdateVocabularyResponse'" '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)))))

newUpdateVocabularyResponse Source #

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

UpdateVocabulary, updateVocabularyResponse_languageCode - The language code you selected for your custom vocabulary.

UpdateVocabularyResponse, updateVocabularyResponse_lastModifiedTime - The date and time the specified custom 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.

UpdateVocabulary, updateVocabularyResponse_vocabularyName - The name of the updated custom vocabulary.

UpdateVocabularyResponse, updateVocabularyResponse_vocabularyState - The processing state of your custom vocabulary. If the state is READY, you can use the custom vocabulary in a StartTranscriptionJob request.

$sel:httpStatus:UpdateVocabularyResponse', updateVocabularyResponse_httpStatus - The response's http status code.

Response Lenses

updateVocabularyResponse_languageCode :: Lens' UpdateVocabularyResponse (Maybe LanguageCode) Source #

The language code you selected for your custom vocabulary.

updateVocabularyResponse_lastModifiedTime :: Lens' UpdateVocabularyResponse (Maybe UTCTime) Source #

The date and time the specified custom 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.

updateVocabularyResponse_vocabularyState :: Lens' UpdateVocabularyResponse (Maybe VocabularyState) Source #

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