Interface CreateVocabularyFilterRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateVocabularyFilterRequest.Builder,
,CreateVocabularyFilterRequest> SdkBuilder<CreateVocabularyFilterRequest.Builder,
,CreateVocabularyFilterRequest> SdkPojo
,SdkRequest.Builder
,TranscribeRequest.Builder
- Enclosing class:
CreateVocabularyFilterRequest
-
Method Summary
Modifier and TypeMethodDescriptiondataAccessRoleArn
(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).languageCode
(String languageCode) The language code that represents the language of the entries in your vocabulary filter.languageCode
(LanguageCode languageCode) The language code that represents the language of the entries in your vocabulary filter.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.tags
(Collection<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.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 filter at the time you create this new vocabulary filter.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.vocabularyFilterFileUri
(String vocabularyFilterFileUri) The Amazon S3 location of the text file that contains your custom vocabulary filter terms.vocabularyFilterName
(String vocabularyFilterName) A unique name, chosen by you, for your new custom vocabulary filter.Use this parameter if you want to create your custom vocabulary filter by including all desired terms, as comma-separated values, within your request.words
(Collection<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.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.transcribe.model.TranscribeRequest.Builder
build
-
Method Details
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 useVocabularyFilterFileUri
; 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:
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 theVocabularyFilterFileUri
parameter.Note that if you include
Words
in your request, you cannot useVocabularyFilterFileUri
; 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.
-
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 useVocabularyFilterFileUri
; 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:
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 theVocabularyFilterFileUri
parameter.Note that if you include
Words
in your request, you cannot useVocabularyFilterFileUri
; 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.
-
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 useWords
; you must choose one or the other.- Parameters:
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 useWords
; you must choose one or the other.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- 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 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:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateVocabularyFilterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateVocabularyFilterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-