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

Class CreateVocabularyFilterRequest

    • Method Detail

      • vocabularyFilterName

        public final String vocabularyFilterName()

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

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

      • languageCode

        public final LanguageCode languageCode()

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

        A custom vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a custom 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.

        If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

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

        A custom vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a custom 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.

        See Also:
        LanguageCode

      • languageCodeAsString

        public final String languageCodeAsString()

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

        A custom vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a custom 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.

        If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

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

        A custom vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a custom 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.

        See Also:
        LanguageCode

      • hasWords

        public final boolean hasWords()
        For responses, this returns true if the service returned a value for the Words property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • words

        public final List<String> words()

        Use this parameter if you want to create your custom 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 custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWords() method.

        Returns:
        Use this parameter if you want to create your custom 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 custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

      • vocabularyFilterFileUri

        public final String vocabularyFilterFileUri()

        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.

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

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<Tag> tags()

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

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        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 vocabulary filter.

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

      • dataAccessRoleArn

        public final 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 filter). 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:
        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 filter). 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.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object