Package software.amazon.awssdk.services.transcribe.model

Interface CreateVocabularyRequest.Builder

    • Method Detail

      • vocabularyName

        CreateVocabularyRequest.Builder vocabularyName​(String vocabularyName)

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

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

        Parameters:
        vocabularyName - A unique name, chosen by you, for your new custom vocabulary.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • languageCode

        CreateVocabularyRequest.Builder languageCode​(String languageCode)

        The language code that represents the language of the entries in your custom vocabulary. 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.

        Parameters:
        languageCode - The language code that represents the language of the entries in your custom vocabulary. 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LanguageCode, LanguageCode

      • languageCode

        CreateVocabularyRequest.Builder languageCode​(LanguageCode languageCode)

        The language code that represents the language of the entries in your custom vocabulary. 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.

        Parameters:
        languageCode - The language code that represents the language of the entries in your custom vocabulary. 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        LanguageCode, LanguageCode

      • phrases

        CreateVocabularyRequest.Builder phrases​(Collection<String> phrases)

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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • phrases

        CreateVocabularyRequest.Builder phrases​(String... phrases)

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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vocabularyFileUri

        CreateVocabularyRequest.Builder vocabularyFileUri​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateVocabularyRequest.Builder tags​(Collection<Tag> tags)

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

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

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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateVocabularyRequest.Builder tags​(Tag... tags)

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

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

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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateVocabularyRequest.Builder tags​(Consumer<Tag.Builder>... tags)

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

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

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • dataAccessRoleArn

        CreateVocabularyRequest.Builder dataAccessRoleArn​(String dataAccessRoleArn)

        The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

        IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

        For more information, see IAM ARNs.

        Parameters:
        dataAccessRoleArn - The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

        IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

        For more information, see IAM ARNs.

        Returns:
        Returns a reference to this object so that method calls can be chained together.