Struct aws_sdk_transcribe::input::UpdateVocabularyInput

#[non_exhaustive]
pub struct UpdateVocabularyInput { /* private fields */ }

Implementations

impl UpdateVocabularyInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<UpdateVocabulary, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<UpdateVocabulary>

Examples found in repository

src/client.rs (line 4941)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::UpdateVocabulary,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::UpdateVocabularyError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// 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](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::UpdateVocabularyOutput,
            aws_smithy_http::result::SdkError<crate::error::UpdateVocabularyError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

pub fn builder() -> Builder

Creates a new builder-style object to manufacture UpdateVocabularyInput.

impl UpdateVocabularyInput

pub fn vocabulary_name(&self) -> Option<&str>

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

pub fn language_code(&self) -> Option<&LanguageCode>

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) -> Option<&[String]>

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) -> Option<&str>

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 UpdateVocabularyInput

fn clone(&self) -> UpdateVocabularyInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateVocabularyInput

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

Formats the value using the given formatter.

impl PartialEq<UpdateVocabularyInput> for UpdateVocabularyInput

fn eq(&self, other: &UpdateVocabularyInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateVocabularyInput