Interface CreateVoiceRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateVoiceRequest.Builder,,CreateVoiceRequest> PollyRequest.Builder,SdkBuilder<CreateVoiceRequest.Builder,,CreateVoiceRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
CreateVoiceRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.default CreateVoiceRequest.BuildercustomerManagedEncryption(Consumer<CustomerManagedEncryption.Builder> customerManagedEncryption) The customer managed key that you want Amazon Polly to encrypt the voice with.customerManagedEncryption(CustomerManagedEncryption customerManagedEncryption) The customer managed key that you want Amazon Polly to encrypt the voice with.languageCode(String languageCode) The language of the recordings, for example,en-US.languageCode(CustomVoiceLanguageCode languageCode) The language of the recordings, for example,en-US.The name of the voice.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The tags that you apply to the voice to help you categorize and organize it.termsAccepted(Boolean termsAccepted) Confirms the following two statements:default CreateVoiceRequest.BuildervoiceCreationData(Consumer<VoiceCreationData.Builder> voiceCreationData) The recordings that Amazon Polly uses to create the voice.voiceCreationData(VoiceCreationData voiceCreationData) The recordings that Amazon Polly uses to create the voice.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.polly.model.PollyRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
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
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
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
trueto create a voice. Otherwise, the request fails withValidationException.- 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
trueto create a voice. Otherwise, the request fails withValidationException.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 theVoiceCreationData.Builderavoiding the need to create one manually viaVoiceCreationData.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tovoiceCreationData(VoiceCreationData).- Parameters:
voiceCreationData- a consumer that will call methods onVoiceCreationData.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 theCustomerManagedEncryption.Builderavoiding the need to create one manually viaCustomerManagedEncryption.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocustomerManagedEncryption(CustomerManagedEncryption).- Parameters:
customerManagedEncryption- a consumer that will call methods onCustomerManagedEncryption.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
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.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateVoiceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-