Struct aws_sdk_transcribe::client::fluent_builders::UpdateVocabulary

pub struct UpdateVocabulary { /* private fields */ }

Fluent builder constructing a request to UpdateVocabulary.

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

Implementations

impl UpdateVocabulary

pub async fn customize(
    self
) -> Result<CustomizableOperation<UpdateVocabulary, AwsResponseRetryClassifier>, SdkError<UpdateVocabularyError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<UpdateVocabularyOutput, SdkError<UpdateVocabularyError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn vocabulary_name(self, input: impl Into<String>) -> Self

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

pub fn set_vocabulary_name(self, input: Option<String>) -> Self

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

pub fn language_code(self, input: LanguageCode) -> Self

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

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

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

pub fn set_language_code(self, input: Option<LanguageCode>) -> Self

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

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

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

pub fn phrases(self, input: impl Into<String>) -> Self

Appends an item to Phrases.

To override the contents of this collection use set_phrases.

Use this parameter if you want to update your vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your 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 vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

pub fn set_phrases(self, input: Option<Vec<String>>) -> Self

Use this parameter if you want to update your vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your 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 vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

pub fn vocabulary_file_uri(self, input: impl Into<String>) -> Self

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.

pub fn set_vocabulary_file_uri(self, input: Option<String>) -> Self

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.

Trait Implementations

impl Clone for UpdateVocabulary

fn clone(&self) -> UpdateVocabulary

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateVocabulary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.