Interface UpdateVocabularyRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateVocabularyRequest.Builder,UpdateVocabularyRequest>, SdkBuilder<UpdateVocabularyRequest.Builder,UpdateVocabularyRequest>, SdkPojo, SdkRequest.Builder, TranscribeRequest.Builder
Enclosing class:
UpdateVocabularyRequest
@Mutable @NotThreadSafe public static interface UpdateVocabularyRequest.Builder extends TranscribeRequest.Builder, SdkPojo, CopyableBuilder<UpdateVocabularyRequest.Builder,UpdateVocabularyRequest>

  • Method Details

    • vocabularyName

      UpdateVocabularyRequest.Builder vocabularyName(String vocabularyName)

      The name of the custom vocabulary you want to update. Custom vocabulary names are case sensitive.

      Parameters:
      vocabularyName - The name of the custom vocabulary you want to update. Custom vocabulary names are case sensitive.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • languageCode

      UpdateVocabularyRequest.Builder languageCode(String languageCode)

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

      UpdateVocabularyRequest.Builder languageCode(LanguageCode languageCode)

      The language code that represents the language of the entries in the custom vocabulary you want to update. 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 the custom vocabulary you want to update. 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:

    • phrases

      UpdateVocabularyRequest.Builder phrases(Collection<String> phrases)

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

      UpdateVocabularyRequest.Builder phrases(String... phrases)

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

      UpdateVocabularyRequest.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.

    • dataAccessRoleArn

      UpdateVocabularyRequest.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 you include EncryptionConfiguration in your request, this role must also have permissions to access the specified KMS key. If the role that you specify doesn’t have the appropriate permissions, 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 you include EncryptionConfiguration in your request, this role must also have permissions to access the specified KMS key. If the role that you specify doesn’t have the appropriate permissions, 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.

    • encryptionConfiguration

      UpdateVocabularyRequest.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

      Specifies the new encryption configuration for your custom vocabulary. The vocabulary artifacts are re-encrypted in place using the specified KMS key or with an AWS-owned key if a key is not supplied.

      Parameters:
      encryptionConfiguration - Specifies the new encryption configuration for your custom vocabulary. The vocabulary artifacts are re-encrypted in place using the specified KMS key or with an AWS-owned key if a key is not supplied.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionConfiguration

      default UpdateVocabularyRequest.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)

      Specifies the new encryption configuration for your custom vocabulary. The vocabulary artifacts are re-encrypted in place using the specified KMS key or with an AWS-owned key if a key is not supplied.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionConfiguration(EncryptionConfiguration).

      Parameters:
      encryptionConfiguration - a consumer that will call methods on EncryptionConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateVocabularyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateVocabularyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.