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 |
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
- data UpdateVocabulary = UpdateVocabulary' {}
- newUpdateVocabulary :: Text -> LanguageCode -> UpdateVocabulary
- updateVocabulary_phrases :: Lens' UpdateVocabulary (Maybe [Text])
- updateVocabulary_vocabularyFileUri :: Lens' UpdateVocabulary (Maybe Text)
- updateVocabulary_vocabularyName :: Lens' UpdateVocabulary Text
- updateVocabulary_languageCode :: Lens' UpdateVocabulary LanguageCode
- data UpdateVocabularyResponse = UpdateVocabularyResponse' {}
- newUpdateVocabularyResponse :: Int -> UpdateVocabularyResponse
- updateVocabularyResponse_languageCode :: Lens' UpdateVocabularyResponse (Maybe LanguageCode)
- updateVocabularyResponse_lastModifiedTime :: Lens' UpdateVocabularyResponse (Maybe UTCTime)
- updateVocabularyResponse_vocabularyName :: Lens' UpdateVocabularyResponse (Maybe Text)
- updateVocabularyResponse_vocabularyState :: Lens' UpdateVocabularyResponse (Maybe VocabularyState)
- updateVocabularyResponse_httpStatus :: Lens' UpdateVocabularyResponse Int
Creating a Request
data UpdateVocabulary Source #
See: newUpdateVocabulary
smart constructor.
UpdateVocabulary' | |
|
Instances
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.
UpdateVocabularyResponse' | |
|
Instances
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_vocabularyName :: Lens' UpdateVocabularyResponse (Maybe Text) Source #
The name of the updated custom vocabulary.
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.
updateVocabularyResponse_httpStatus :: Lens' UpdateVocabularyResponse Int Source #
The response's http status code.