Class: Aws::TranscribeService::Types::UpdateVocabularyFilterRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::TranscribeService::Types::UpdateVocabularyFilterRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-transcribeservice/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#data_access_role_arn ⇒ String
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).
-
#vocabulary_filter_file_uri ⇒ String
The Amazon S3 location of the text file that contains your custom vocabulary filter terms.
-
#vocabulary_filter_name ⇒ String
The name of the custom vocabulary filter you want to update.
-
#words ⇒ Array<String>
Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as comma-separated values, within your request.
Instance Attribute Details
#data_access_role_arn ⇒ String
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].
[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
5033 5034 5035 5036 5037 5038 5039 5040 |
# File 'lib/aws-sdk-transcribeservice/types.rb', line 5033 class UpdateVocabularyFilterRequest < Struct.new( :vocabulary_filter_name, :words, :vocabulary_filter_file_uri, :data_access_role_arn) SENSITIVE = [] include Aws::Structure end |
#vocabulary_filter_file_uri ⇒ String
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.
5033 5034 5035 5036 5037 5038 5039 5040 |
# File 'lib/aws-sdk-transcribeservice/types.rb', line 5033 class UpdateVocabularyFilterRequest < Struct.new( :vocabulary_filter_name, :words, :vocabulary_filter_file_uri, :data_access_role_arn) SENSITIVE = [] include Aws::Structure end |
#vocabulary_filter_name ⇒ String
The name of the custom vocabulary filter you want to update. Custom vocabulary filter names are case sensitive.
5033 5034 5035 5036 5037 5038 5039 5040 |
# File 'lib/aws-sdk-transcribeservice/types.rb', line 5033 class UpdateVocabularyFilterRequest < Struct.new( :vocabulary_filter_name, :words, :vocabulary_filter_file_uri, :data_access_role_arn) SENSITIVE = [] include Aws::Structure end |
#words ⇒ Array<String>
Use this parameter if you want to update your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for updating 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][1
-
to get the character set
for your language.
5033 5034 5035 5036 5037 5038 5039 5040 |
# File 'lib/aws-sdk-transcribeservice/types.rb', line 5033 class UpdateVocabularyFilterRequest < Struct.new( :vocabulary_filter_name, :words, :vocabulary_filter_file_uri, :data_access_role_arn) SENSITIVE = [] include Aws::Structure end |