Interface CreateVoiceRequest.Builder

  • Method Details

    • name

      The name of the voice. Use the name to identify the voice in your application. The name can contain letters, digits, hyphens, and underscores, and can be up to 64 characters long. The name doesn't have to be unique. The name isn't the voice ID, which Amazon Polly assigns.

      Parameters:
      name - The name of the voice. Use the name to identify the voice in your application. The name can contain letters, digits, hyphens, and underscores, and can be up to 64 characters long. The name doesn't have to be unique. The name isn't the voice ID, which Amazon Polly assigns.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • languageCode

      CreateVoiceRequest.Builder languageCode(String languageCode)

      The language of the recordings, for example, en-US. Amazon Polly doesn't detect the language from the recordings.

      Parameters:
      languageCode - The language of the recordings, for example, en-US. Amazon Polly doesn't detect the language from the recordings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • languageCode

      The language of the recordings, for example, en-US. Amazon Polly doesn't detect the language from the recordings.

      Parameters:
      languageCode - The language of the recordings, for example, en-US. Amazon Polly doesn't detect the language from the recordings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • termsAccepted

      CreateVoiceRequest.Builder termsAccepted(Boolean termsAccepted)

      Confirms the following two statements:

      • "I confirm that I have obtained all necessary consents required under any applicable laws and regulations, including biometric privacy laws, from the owner of this voice to clone these voice samples."

      • "I confirm that I will not use the generated content for any illegal, fraudulent, or harmful purpose and reaffirm my obligation to abide by the AWS Service Terms, Biometric Notice and Consent Terms, AWS Responsible AI Policy, and AWS Acceptable Use Policy."

      You can read the AWS Service Terms, the Biometric Notice and Consent Terms, the AWS Responsible AI Policy, and the AWS Acceptable Use Policy on the Amazon Web Services website.

      You must set this parameter to true to create a voice. Otherwise, the request fails with ValidationException.

      Parameters:
      termsAccepted - Confirms the following two statements:

      • "I confirm that I have obtained all necessary consents required under any applicable laws and regulations, including biometric privacy laws, from the owner of this voice to clone these voice samples."

      • "I confirm that I will not use the generated content for any illegal, fraudulent, or harmful purpose and reaffirm my obligation to abide by the AWS Service Terms, Biometric Notice and Consent Terms, AWS Responsible AI Policy, and AWS Acceptable Use Policy."

      You can read the AWS Service Terms, the Biometric Notice and Consent Terms, the AWS Responsible AI Policy, and the AWS Acceptable Use Policy on the Amazon Web Services website.

      You must set this parameter to true to create a voice. Otherwise, the request fails with ValidationException.

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

      CreateVoiceRequest.Builder voiceCreationData(VoiceCreationData voiceCreationData)

      The recordings that Amazon Polly uses to create the voice.

      Parameters:
      voiceCreationData - The recordings that Amazon Polly uses to create the voice.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • voiceCreationData

      default CreateVoiceRequest.Builder voiceCreationData(Consumer<VoiceCreationData.Builder> voiceCreationData)

      The recordings that Amazon Polly uses to create the voice.

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

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

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

      CreateVoiceRequest.Builder customerManagedEncryption(CustomerManagedEncryption customerManagedEncryption)

      The customer managed key that you want Amazon Polly to encrypt the voice with. If you omit this parameter, Amazon Polly encrypts the voice with an Amazon Web Services owned key.

      Parameters:
      customerManagedEncryption - The customer managed key that you want Amazon Polly to encrypt the voice with. If you omit this parameter, Amazon Polly encrypts the voice with an Amazon Web Services owned key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • customerManagedEncryption

      default CreateVoiceRequest.Builder customerManagedEncryption(Consumer<CustomerManagedEncryption.Builder> customerManagedEncryption)

      The customer managed key that you want Amazon Polly to encrypt the voice with. If you omit this parameter, Amazon Polly encrypts the voice with an Amazon Web Services owned key.

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

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

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

      The tags that you apply to the voice to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.

      Parameters:
      tags - The tags that you apply to the voice to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • clientToken

      CreateVoiceRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDKs generate one for you. If you retry a request that succeeded with the same client token and the same parameters, Amazon Polly returns the voice that the first request created and doesn't create a second voice.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDKs generate one for you. If you retry a request that succeeded with the same client token and the same parameters, Amazon Polly returns the voice that the first request created and doesn't create a second voice.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

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

      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.