Struct aws_sdk_transcribe::input::CreateVocabularyFilterInput

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

Implementations

impl CreateVocabularyFilterInput

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

Consumes the builder and constructs an Operation<CreateVocabularyFilter>

Examples found in repository

src/client.rs (line 1207)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateVocabularyFilter,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateVocabularyFilterError>,
        > {
            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::CreateVocabularyFilterOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateVocabularyFilterError>,
        > {
            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 CreateVocabularyFilterInput.

impl CreateVocabularyFilterInput

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

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

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 vocabulary filter with the same name as an existing vocabulary filter, you get a ConflictException error.

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

The language code that represents the language of the entries in your vocabulary filter. Each vocabulary filter must contain terms in only one language.

A vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a vocabulary filter using US English (en-US), you can only apply this filter 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 words(&self) -> Option<&[String]>

Use this parameter if you want to create your vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary filter 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 VocabularyFilterFileUri parameter.

Note that if you include Words in your request, you cannot use VocabularyFilterFileUri; 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_filter_file_uri(&self) -> Option<&str>

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

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

pub fn tags(&self) -> Option<&[Tag]>

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

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

Trait Implementations

impl Clone for CreateVocabularyFilterInput

fn clone(&self) -> CreateVocabularyFilterInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateVocabularyFilterInput

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

Formats the value using the given formatter.

impl PartialEq<CreateVocabularyFilterInput> for CreateVocabularyFilterInput

fn eq(&self, other: &CreateVocabularyFilterInput) -> 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 CreateVocabularyFilterInput