There are more AWS SDK examples available in the [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub repo.
# Code examples for Amazon Polly using AWS SDKs
The following code examples show you how to use Amazon Polly with an AWS software development kit (SDK).
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
*Scenarios* are code examples that show you how to accomplish specific tasks by calling multiple functions within a service or combined with other AWS services.
**More resources**
+ **[ Amazon Polly Developer Guide](https://docs.aws.amazon.com/polly/latest/dg/what-is.html)** – More information about Amazon Polly.
+ **[Amazon Polly API Reference](https://docs.aws.amazon.com/polly/latest/dg/API_Reference.html)** – Details about all available Amazon Polly actions.
+ **[AWS Developer Center](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23polly)** – Code examples that you can filter by category or full-text search.
+ **[AWS SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples)** – GitHub repo with complete code in preferred languages. Includes instructions for setting up and running the code.
**Contents**
+ [Basics](polly_code_examples_basics.md)
+ [Actions](polly_code_examples_actions.md)
+ [`DeleteLexicon`](polly_example_polly_DeleteLexicon_section.md)
+ [`DescribeVoices`](polly_example_polly_DescribeVoices_section.md)
+ [`GetLexicon`](polly_example_polly_GetLexicon_section.md)
+ [`GetSpeechSynthesisTask`](polly_example_polly_GetSpeechSynthesisTask_section.md)
+ [`ListLexicons`](polly_example_polly_ListLexicons_section.md)
+ [`ListSpeechSynthesisTasks`](polly_example_polly_ListSpeechSynthesisTasks_section.md)
+ [`PutLexicon`](polly_example_polly_PutLexicon_section.md)
+ [`StartSpeechSynthesisTask`](polly_example_polly_StartSpeechSynthesisTask_section.md)
+ [`SynthesizeSpeech`](polly_example_polly_SynthesizeSpeech_section.md)
+ [Scenarios](polly_code_examples_scenarios.md)
+ [Convert text to speech and back to text](polly_example_cross_Telephone_section.md)
+ [Create a lip-sync application](polly_example_polly_LipSync_section.md)
+ [Create an application to analyze customer feedback](polly_example_cross_FSA_section.md)
+ [Getting started with Amazon Polly](polly_example_polly_GettingStarted_082_section.md)
# Basic examples for Amazon Polly using AWS SDKs
The following code examples show how to use the basics of Amazon Polly with AWS SDKs.
**Contents**
+ [Actions](polly_code_examples_actions.md)
+ [`DeleteLexicon`](polly_example_polly_DeleteLexicon_section.md)
+ [`DescribeVoices`](polly_example_polly_DescribeVoices_section.md)
+ [`GetLexicon`](polly_example_polly_GetLexicon_section.md)
+ [`GetSpeechSynthesisTask`](polly_example_polly_GetSpeechSynthesisTask_section.md)
+ [`ListLexicons`](polly_example_polly_ListLexicons_section.md)
+ [`ListSpeechSynthesisTasks`](polly_example_polly_ListSpeechSynthesisTasks_section.md)
+ [`PutLexicon`](polly_example_polly_PutLexicon_section.md)
+ [`StartSpeechSynthesisTask`](polly_example_polly_StartSpeechSynthesisTask_section.md)
+ [`SynthesizeSpeech`](polly_example_polly_SynthesizeSpeech_section.md)
# Actions for Amazon Polly using AWS SDKs
The following code examples demonstrate how to perform individual Amazon Polly actions with AWS SDKs. Each example includes a link to GitHub, where you can find instructions for setting up and running the code.
These excerpts call the Amazon Polly API and are code excerpts from larger programs that must be run in context. You can see actions in context in [Scenarios for Amazon Polly using AWS SDKs](polly_code_examples_scenarios.md).
The following examples include only the most commonly used actions. For a complete list, see the [Amazon Polly API Reference](https://docs.aws.amazon.com/polly/latest/dg/API_Reference.html).
**Topics**
+ [`DeleteLexicon`](polly_example_polly_DeleteLexicon_section.md)
+ [`DescribeVoices`](polly_example_polly_DescribeVoices_section.md)
+ [`GetLexicon`](polly_example_polly_GetLexicon_section.md)
+ [`GetSpeechSynthesisTask`](polly_example_polly_GetSpeechSynthesisTask_section.md)
+ [`ListLexicons`](polly_example_polly_ListLexicons_section.md)
+ [`ListSpeechSynthesisTasks`](polly_example_polly_ListSpeechSynthesisTasks_section.md)
+ [`PutLexicon`](polly_example_polly_PutLexicon_section.md)
+ [`StartSpeechSynthesisTask`](polly_example_polly_StartSpeechSynthesisTask_section.md)
+ [`SynthesizeSpeech`](polly_example_polly_SynthesizeSpeech_section.md)
# Use `DeleteLexicon` with an AWS SDK or CLI
The following code examples show how to use `DeleteLexicon`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Getting started with Amazon Polly](polly_example_polly_GettingStarted_082_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Polly#code-examples).
```
using System;
using System.Threading.Tasks;
using Amazon.Polly;
using Amazon.Polly.Model;
///
/// Deletes an existing Amazon Polly lexicon using the AWS SDK for .NET.
///
public class DeleteLexicon
{
public static async Task Main()
{
string lexiconName = "SampleLexicon";
var client = new AmazonPollyClient();
var success = await DeletePollyLexiconAsync(client, lexiconName);
if (success)
{
Console.WriteLine($"Successfully deleted {lexiconName}.");
}
else
{
Console.WriteLine($"Could not delete {lexiconName}.");
}
}
///
/// Deletes the named Amazon Polly lexicon.
///
/// The initialized Amazon Polly client object.
/// The name of the Amazon Polly lexicon to
/// delete.
/// A Boolean value indicating the success of the operation.
public static async Task DeletePollyLexiconAsync(
AmazonPollyClient client,
string lexiconName)
{
var deleteLexiconRequest = new DeleteLexiconRequest()
{
Name = lexiconName,
};
var response = await client.DeleteLexiconAsync(deleteLexiconRequest);
return response.HttpStatusCode == System.Net.HttpStatusCode.OK;
}
}
```
+ For API details, see [DeleteLexicon](https://docs.aws.amazon.com/goto/DotNetSDKV3/polly-2016-06-10/DeleteLexicon) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To delete a lexicon**
The following `delete-lexicon` example deletes the specified lexicon.
```
aws polly delete-lexicon \
--name w3c
```
This command produces no output.
For more information, see [Using the DeleteLexicon operation](https://docs.aws.amazon.com/polly/latest/dg/gs-delete-lexicon.html) in the *Amazon Polly Developer Guide*.
+ For API details, see [DeleteLexicon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/delete-lexicon.html) in *AWS CLI Command Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ply#code-examples).
```
TRY.
lo_ply->deletelexicon( iv_name ).
MESSAGE 'Lexicon deleted successfully.' TYPE 'I'.
CATCH /aws1/cx_plylexiconnotfoundex.
MESSAGE 'Lexicon not found.' TYPE 'E'.
CATCH /aws1/cx_plyservicefailureex.
MESSAGE 'Service failure occurred.' TYPE 'E'.
ENDTRY.
```
+ For API details, see [DeleteLexicon](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `DescribeVoices` with an AWS SDK
The following code examples show how to use `DescribeVoices`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Getting started with Amazon Polly](polly_example_polly_GettingStarted_082_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Polly#code-examples).
```
using System;
using System.Threading.Tasks;
using Amazon.Polly;
using Amazon.Polly.Model;
public class DescribeVoices
{
public static async Task Main()
{
var client = new AmazonPollyClient();
var allVoicesRequest = new DescribeVoicesRequest();
var enUsVoicesRequest = new DescribeVoicesRequest()
{
LanguageCode = "en-US",
};
try
{
string nextToken;
do
{
var allVoicesResponse = await client.DescribeVoicesAsync(allVoicesRequest);
nextToken = allVoicesResponse.NextToken;
allVoicesRequest.NextToken = nextToken;
Console.WriteLine("\nAll voices: ");
allVoicesResponse.Voices.ForEach(voice =>
{
DisplayVoiceInfo(voice);
});
}
while (nextToken is not null);
do
{
var enUsVoicesResponse = await client.DescribeVoicesAsync(enUsVoicesRequest);
nextToken = enUsVoicesResponse.NextToken;
enUsVoicesRequest.NextToken = nextToken;
Console.WriteLine("\nen-US voices: ");
enUsVoicesResponse.Voices.ForEach(voice =>
{
DisplayVoiceInfo(voice);
});
}
while (nextToken is not null);
}
catch (Exception ex)
{
Console.WriteLine("Exception caught: " + ex.Message);
}
}
public static void DisplayVoiceInfo(Voice voice)
{
Console.WriteLine($" Name: {voice.Name}\tGender: {voice.Gender}\tLanguageName: {voice.LanguageName}");
}
}
```
+ For API details, see [DescribeVoices](https://docs.aws.amazon.com/goto/DotNetSDKV3/polly-2016-06-10/DescribeVoices) in *AWS SDK for .NET API Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/polly#code-examples).
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.polly.PollyClient;
import software.amazon.awssdk.services.polly.model.DescribeVoicesRequest;
import software.amazon.awssdk.services.polly.model.DescribeVoicesResponse;
import software.amazon.awssdk.services.polly.model.PollyException;
import software.amazon.awssdk.services.polly.model.Voice;
import java.util.List;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class DescribeVoicesSample {
public static void main(String args[]) {
PollyClient polly = PollyClient.builder()
.region(Region.US_WEST_2)
.build();
describeVoice(polly);
polly.close();
}
public static void describeVoice(PollyClient polly) {
try {
DescribeVoicesRequest voicesRequest = DescribeVoicesRequest.builder()
.languageCode("en-US")
.build();
DescribeVoicesResponse enUsVoicesResult = polly.describeVoices(voicesRequest);
List voices = enUsVoicesResult.voices();
for (Voice myVoice : voices) {
System.out.println("The ID of the voice is " + myVoice.id());
System.out.println("The gender of the voice is " + myVoice.gender());
}
} catch (PollyException e) {
System.err.println("Exception caught: " + e);
System.exit(1);
}
}
}
```
+ For API details, see [DescribeVoices](https://docs.aws.amazon.com/goto/SdkForJavaV2/polly-2016-06-10/DescribeVoices) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/polly#code-examples).
```
class PollyWrapper:
"""Encapsulates Amazon Polly functions."""
def __init__(self, polly_client, s3_resource):
"""
:param polly_client: A Boto3 Amazon Polly client.
:param s3_resource: A Boto3 Amazon Simple Storage Service (Amazon S3) resource.
"""
self.polly_client = polly_client
self.s3_resource = s3_resource
self.voice_metadata = None
def describe_voices(self):
"""
Gets metadata about available voices.
:return: The list of voice metadata.
"""
try:
response = self.polly_client.describe_voices()
self.voice_metadata = response["Voices"]
logger.info("Got metadata about %s voices.", len(self.voice_metadata))
except ClientError:
logger.exception("Couldn't get voice metadata.")
raise
else:
return self.voice_metadata
```
+ For API details, see [DescribeVoices](https://docs.aws.amazon.com/goto/boto3/polly-2016-06-10/DescribeVoices) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Ruby ]
**SDK for Ruby**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/polly#code-examples).
```
require 'aws-sdk-polly' # In v2: require 'aws-sdk'
begin
# Create an Amazon Polly client using
# credentials from the shared credentials file ~/.aws/credentials
# and the configuration (region) from the shared configuration file ~/.aws/config
polly = Aws::Polly::Client.new
# Get US English voices
resp = polly.describe_voices(language_code: 'en-US')
resp.voices.each do |v|
puts v.name
puts " #{v.gender}"
puts
end
rescue StandardError => e
puts 'Could not get voices'
puts 'Error message:'
puts e.message
end
```
+ For API details, see [DescribeVoices](https://docs.aws.amazon.com/goto/SdkForRubyV3/polly-2016-06-10/DescribeVoices) in *AWS SDK for Ruby API Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/polly#code-examples).
```
async fn list_voices(client: &Client) -> Result<(), Error> {
let resp = client.describe_voices().send().await?;
println!("Voices:");
let voices = resp.voices();
for voice in voices {
println!(" Name: {}", voice.name().unwrap_or("No name!"));
println!(
" Language: {}",
voice.language_name().unwrap_or("No language!")
);
println!();
}
println!("Found {} voices", voices.len());
Ok(())
}
```
+ For API details, see [DescribeVoices](https://docs.rs/aws-sdk-polly/latest/aws_sdk_polly/client/struct.Client.html#method.describe_voices) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ply#code-examples).
```
TRY.
" Only pass optional parameters if they have values
IF iv_engine IS NOT INITIAL AND iv_language IS NOT INITIAL.
oo_result = lo_ply->describevoices(
iv_engine = iv_engine
iv_languagecode = iv_language ).
ELSEIF iv_engine IS NOT INITIAL.
oo_result = lo_ply->describevoices(
iv_engine = iv_engine ).
ELSEIF iv_language IS NOT INITIAL.
oo_result = lo_ply->describevoices(
iv_languagecode = iv_language ).
ELSE.
oo_result = lo_ply->describevoices( ).
ENDIF.
MESSAGE 'Retrieved voice metadata.' TYPE 'I'.
CATCH /aws1/cx_plyinvalidnexttokenex.
MESSAGE 'The NextToken is invalid.' TYPE 'E'.
CATCH /aws1/cx_plyservicefailureex.
MESSAGE 'Service failure occurred.' TYPE 'E'.
ENDTRY.
```
+ For API details, see [DescribeVoices](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `GetLexicon` with an AWS SDK or CLI
The following code examples show how to use `GetLexicon`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Getting started with Amazon Polly](polly_example_polly_GettingStarted_082_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Polly#code-examples).
```
using System;
using System.Threading.Tasks;
using Amazon.Polly;
using Amazon.Polly.Model;
///
/// Retrieves information about a specific Amazon Polly lexicon.
///
public class GetLexicon
{
public static async Task Main(string[] args)
{
string lexiconName = "SampleLexicon";
var client = new AmazonPollyClient();
await GetPollyLexiconAsync(client, lexiconName);
}
public static async Task GetPollyLexiconAsync(AmazonPollyClient client, string lexiconName)
{
var getLexiconRequest = new GetLexiconRequest()
{
Name = lexiconName,
};
try
{
var response = await client.GetLexiconAsync(getLexiconRequest);
Console.WriteLine($"Lexicon:\n Name: {response.Lexicon.Name}");
Console.WriteLine($"Content: {response.Lexicon.Content}");
}
catch (Exception ex)
{
Console.WriteLine("Error: " + ex.Message);
}
}
}
```
+ For API details, see [GetLexicon](https://docs.aws.amazon.com/goto/DotNetSDKV3/polly-2016-06-10/GetLexicon) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To retrieve the content of a lexicon**
The following `get-lexicon` example retrieves the content of the specified pronunciation lexicon.
```
aws polly get-lexicon \
--name w3c
```
Output:
```
{
"Lexicon": {
"Content": "\n\n \n W3C\n World Wide Web Consortium\n \n\n",
"Name": "w3c"
},
"LexiconAttributes": {
"Alphabet": "ipa",
"LanguageCode": "en-US",
"LastModified": 1603908910.99,
"LexiconArn": "arn:aws:polly:us-west-2:880185128111:lexicon/w3c",
"LexemesCount": 1,
"Size": 492
}
}
```
For more information, see [Using the GetLexicon operation](https://docs.aws.amazon.com/polly/latest/dg/gs-get-lexicon.html) in the *Amazon Polly Developer Guide*.
+ For API details, see [GetLexicon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/get-lexicon.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/polly#code-examples).
```
class PollyWrapper:
"""Encapsulates Amazon Polly functions."""
def __init__(self, polly_client, s3_resource):
"""
:param polly_client: A Boto3 Amazon Polly client.
:param s3_resource: A Boto3 Amazon Simple Storage Service (Amazon S3) resource.
"""
self.polly_client = polly_client
self.s3_resource = s3_resource
self.voice_metadata = None
def get_lexicon(self, name):
"""
Gets metadata and contents of an existing lexicon.
:param name: The name of the lexicon to retrieve.
:return: The retrieved lexicon.
"""
try:
response = self.polly_client.get_lexicon(Name=name)
logger.info("Got lexicon %s.", name)
except ClientError:
logger.exception("Couldn't get lexicon %s.", name)
raise
else:
return response
```
+ For API details, see [GetLexicon](https://docs.aws.amazon.com/goto/boto3/polly-2016-06-10/GetLexicon) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ply#code-examples).
```
TRY.
oo_result = lo_ply->getlexicon( iv_name ).
DATA(lo_lexicon) = oo_result->get_lexicon( ).
IF lo_lexicon IS BOUND.
DATA(lv_lex_name) = lo_lexicon->get_name( ).
MESSAGE |Retrieved lexicon: { lv_lex_name }| TYPE 'I'.
ENDIF.
CATCH /aws1/cx_plylexiconnotfoundex.
MESSAGE 'Lexicon not found.' TYPE 'E'.
CATCH /aws1/cx_plyservicefailureex.
MESSAGE 'Service failure occurred.' TYPE 'E'.
ENDTRY.
```
+ For API details, see [GetLexicon](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `GetSpeechSynthesisTask` with an AWS SDK or CLI
The following code examples show how to use `GetSpeechSynthesisTask`.
------
#### [ CLI ]
**AWS CLI**
**To get information about a speech synthesis task**
The following `get-speech-synthesis-task` example retrieves information about the specified speech synthesis task.
```
aws polly get-speech-synthesis-task \
--task-id 70b61c0f-57ce-4715-a247-cae8729dcce9
```
Output:
```
{
"SynthesisTask": {
"TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9",
"TaskStatus": "completed",
"OutputUri": "https://s3.us-west-2.amazonaws.com/amzn-s3-demo-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3",
"CreationTime": 1603911042.689,
"RequestCharacters": 1311,
"OutputFormat": "mp3",
"TextType": "text",
"VoiceId": "Joanna"
}
}
```
For more information, see [Creating long audio files](https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html) in the *Amazon Polly Developer Guide*.
+ For API details, see [GetSpeechSynthesisTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/get-speech-synthesis-task.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/polly#code-examples).
```
class PollyWrapper:
"""Encapsulates Amazon Polly functions."""
def __init__(self, polly_client, s3_resource):
"""
:param polly_client: A Boto3 Amazon Polly client.
:param s3_resource: A Boto3 Amazon Simple Storage Service (Amazon S3) resource.
"""
self.polly_client = polly_client
self.s3_resource = s3_resource
self.voice_metadata = None
def get_speech_synthesis_task(self, task_id):
"""
Gets metadata about an asynchronous speech synthesis task, such as its status.
:param task_id: The ID of the task to retrieve.
:return: Metadata about the task.
"""
try:
response = self.polly_client.get_speech_synthesis_task(TaskId=task_id)
task = response["SynthesisTask"]
logger.info("Got synthesis task. Status is %s.", task["TaskStatus"])
except ClientError:
logger.exception("Couldn't get synthesis task %s.", task_id)
raise
else:
return task
```
+ For API details, see [GetSpeechSynthesisTask](https://docs.aws.amazon.com/goto/boto3/polly-2016-06-10/GetSpeechSynthesisTask) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ply#code-examples).
```
TRY.
oo_result = lo_ply->getspeechsynthesistask( iv_task_id ).
DATA(lo_task) = oo_result->get_synthesistask( ).
IF lo_task IS BOUND.
DATA(lv_status) = lo_task->get_taskstatus( ).
MESSAGE |Task status: { lv_status }| TYPE 'I'.
ENDIF.
CATCH /aws1/cx_plyinvalidtaskidex.
MESSAGE 'Invalid task ID.' TYPE 'E'.
CATCH /aws1/cx_plyservicefailureex.
MESSAGE 'Service failure occurred.' TYPE 'E'.
CATCH /aws1/cx_plysynthesistsknotf00.
MESSAGE 'Synthesis task not found.' TYPE 'E'.
ENDTRY.
```
+ For API details, see [GetSpeechSynthesisTask](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `ListLexicons` with an AWS SDK or CLI
The following code examples show how to use `ListLexicons`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Getting started with Amazon Polly](polly_example_polly_GettingStarted_082_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Polly#code-examples).
```
using System;
using System.Threading.Tasks;
using Amazon.Polly;
using Amazon.Polly.Model;
///
/// Lists the Amazon Polly lexicons that have been defined. By default,
/// lists the lexicons that are defined in the same AWS Region as the default
/// user. To view Amazon Polly lexicons that are defined in a different AWS
/// Region, supply it as a parameter to the Amazon Polly constructor.
///
public class ListLexicons
{
public static async Task Main()
{
var client = new AmazonPollyClient();
var request = new ListLexiconsRequest();
try
{
Console.WriteLine("All voices: ");
do
{
var response = await client.ListLexiconsAsync(request);
request.NextToken = response.NextToken;
response.Lexicons.ForEach(lexicon =>
{
var attributes = lexicon.Attributes;
Console.WriteLine($"Name: {lexicon.Name}");
Console.WriteLine($"\tAlphabet: {attributes.Alphabet}");
Console.WriteLine($"\tLanguageCode: {attributes.LanguageCode}");
Console.WriteLine($"\tLastModified: {attributes.LastModified}");
Console.WriteLine($"\tLexemesCount: {attributes.LexemesCount}");
Console.WriteLine($"\tLexiconArn: {attributes.LexiconArn}");
Console.WriteLine($"\tSize: {attributes.Size}");
});
}
while (request.NextToken is not null);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
```
+ For API details, see [ListLexicons](https://docs.aws.amazon.com/goto/DotNetSDKV3/polly-2016-06-10/ListLexicons) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To list your lexicons**
The following `list-lexicons` example lists your pronunciation lexicons.
```
aws polly list-lexicons
```
Output:
```
{
"Lexicons": [
{
"Name": "w3c",
"Attributes": {
"Alphabet": "ipa",
"LanguageCode": "en-US",
"LastModified": 1603908910.99,
"LexiconArn": "arn:aws:polly:us-east-2:123456789012:lexicon/w3c",
"LexemesCount": 1,
"Size": 492
}
}
]
}
```
For more information, see [Using the ListLexicons operation](https://docs.aws.amazon.com/polly/latest/dg/gs-list-lexicons.html) in the *Amazon Polly Developer Guide*.
+ For API details, see [ListLexicons](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/list-lexicons.html) in *AWS CLI Command Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/polly#code-examples).
```
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.polly.PollyClient;
import software.amazon.awssdk.services.polly.model.ListLexiconsResponse;
import software.amazon.awssdk.services.polly.model.ListLexiconsRequest;
import software.amazon.awssdk.services.polly.model.LexiconDescription;
import software.amazon.awssdk.services.polly.model.PollyException;
import java.util.List;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class ListLexicons {
public static void main(String args[]) {
PollyClient polly = PollyClient.builder()
.region(Region.US_WEST_2)
.build();
listLexicons(polly);
polly.close();
}
public static void listLexicons(PollyClient client) {
try {
ListLexiconsRequest listLexiconsRequest = ListLexiconsRequest.builder()
.build();
ListLexiconsResponse listLexiconsResult = client.listLexicons(listLexiconsRequest);
List lexiconDescription = listLexiconsResult.lexicons();
for (LexiconDescription lexDescription : lexiconDescription) {
System.out.println("The name of the Lexicon is " + lexDescription.name());
}
} catch (PollyException e) {
System.err.println("Exception caught: " + e);
System.exit(1);
}
}
}
```
+ For API details, see [ListLexicons](https://docs.aws.amazon.com/goto/SdkForJavaV2/polly-2016-06-10/ListLexicons) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/polly#code-examples).
```
class PollyWrapper:
"""Encapsulates Amazon Polly functions."""
def __init__(self, polly_client, s3_resource):
"""
:param polly_client: A Boto3 Amazon Polly client.
:param s3_resource: A Boto3 Amazon Simple Storage Service (Amazon S3) resource.
"""
self.polly_client = polly_client
self.s3_resource = s3_resource
self.voice_metadata = None
def list_lexicons(self):
"""
Lists lexicons in the current account.
:return: The list of lexicons.
"""
try:
response = self.polly_client.list_lexicons()
lexicons = response["Lexicons"]
logger.info("Got %s lexicons.", len(lexicons))
except ClientError:
logger.exception(
"Couldn't get %s.",
)
raise
else:
return lexicons
```
+ For API details, see [ListLexicons](https://docs.aws.amazon.com/goto/boto3/polly-2016-06-10/ListLexicons) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Ruby ]
**SDK for Ruby**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/polly#code-examples).
```
require 'aws-sdk-polly' # In v2: require 'aws-sdk'
begin
# Create an Amazon Polly client using
# credentials from the shared credentials file ~/.aws/credentials
# and the configuration (region) from the shared configuration file ~/.aws/config
polly = Aws::Polly::Client.new
resp = polly.list_lexicons
resp.lexicons.each do |l|
puts l.name
puts " Alphabet:#{l.attributes.alphabet}"
puts " Language:#{l.attributes.language}"
puts
end
rescue StandardError => e
puts 'Could not get lexicons'
puts 'Error message:'
puts e.message
end
```
+ For API details, see [ListLexicons](https://docs.aws.amazon.com/goto/SdkForRubyV3/polly-2016-06-10/ListLexicons) in *AWS SDK for Ruby API Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/polly#code-examples).
```
async fn show_lexicons(client: &Client) -> Result<(), Error> {
let resp = client.list_lexicons().send().await?;
println!("Lexicons:");
let lexicons = resp.lexicons();
for lexicon in lexicons {
println!(" Name: {}", lexicon.name().unwrap_or_default());
println!(
" Language: {:?}\n",
lexicon
.attributes()
.as_ref()
.map(|attrib| attrib
.language_code
.as_ref()
.expect("languages must have language codes"))
.expect("languages must have attributes")
);
}
println!();
println!("Found {} lexicons.", lexicons.len());
println!();
Ok(())
}
```
+ For API details, see [ListLexicons](https://docs.rs/aws-sdk-polly/latest/aws_sdk_polly/client/struct.Client.html#method.list_lexicons) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ply#code-examples).
```
TRY.
oo_result = lo_ply->listlexicons( ).
DATA(lt_lexicons) = oo_result->get_lexicons( ).
DATA(lv_count) = lines( lt_lexicons ).
MESSAGE |Found { lv_count } lexicons| TYPE 'I'.
CATCH /aws1/cx_plyinvalidnexttokenex.
MESSAGE 'Invalid NextToken.' TYPE 'E'.
CATCH /aws1/cx_plyservicefailureex.
MESSAGE 'Service failure occurred.' TYPE 'E'.
ENDTRY.
```
+ For API details, see [ListLexicons](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `ListSpeechSynthesisTasks` with an AWS SDK or CLI
The following code examples show how to use `ListSpeechSynthesisTasks`.
------
#### [ CLI ]
**AWS CLI**
**To list your speech synthesis tasks**
The following `list-speech-synthesis-tasks` example lists your speech synthesis tasks.
```
aws polly list-speech-synthesis-tasks
```
Output:
```
{
"SynthesisTasks": [
{
"TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9",
"TaskStatus": "completed",
"OutputUri": "https://s3.us-west-2.amazonaws.com/amzn-s3-demo-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3",
"CreationTime": 1603911042.689,
"RequestCharacters": 1311,
"OutputFormat": "mp3",
"TextType": "text",
"VoiceId": "Joanna"
}
]
}
```
For more information, see [Creating long audio files](https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html) in the *Amazon Polly Developer Guide*.
+ For API details, see [ListSpeechSynthesisTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/list-speech-synthesis-tasks.html) in *AWS CLI Command Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ply#code-examples).
```
TRY.
" Only pass optional parameters if they have values
IF iv_max_results IS NOT INITIAL AND iv_status IS NOT INITIAL.
oo_result = lo_ply->listspeechsynthesistasks(
iv_maxresults = iv_max_results
iv_status = iv_status ).
ELSEIF iv_max_results IS NOT INITIAL.
oo_result = lo_ply->listspeechsynthesistasks(
iv_maxresults = iv_max_results ).
ELSEIF iv_status IS NOT INITIAL.
oo_result = lo_ply->listspeechsynthesistasks(
iv_status = iv_status ).
ELSE.
oo_result = lo_ply->listspeechsynthesistasks( ).
ENDIF.
DATA(lt_tasks) = oo_result->get_synthesistasks( ).
DATA(lv_count) = lines( lt_tasks ).
MESSAGE |Found { lv_count } synthesis tasks| TYPE 'I'.
CATCH /aws1/cx_plyinvalidnexttokenex.
MESSAGE 'Invalid NextToken.' TYPE 'E'.
CATCH /aws1/cx_plyservicefailureex.
MESSAGE 'Service failure occurred.' TYPE 'E'.
ENDTRY.
```
+ For API details, see [ListSpeechSynthesisTasks](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `PutLexicon` with an AWS SDK or CLI
The following code examples show how to use `PutLexicon`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Getting started with Amazon Polly](polly_example_polly_GettingStarted_082_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Polly#code-examples).
```
using System;
using System.Threading.Tasks;
using Amazon.Polly;
using Amazon.Polly.Model;
///
/// Creates a new Amazon Polly lexicon using the AWS SDK for .NET.
///
public class PutLexicon
{
public static async Task Main()
{
string lexiconContent = "" +
"" +
"test1test2" +
"";
string lexiconName = "SampleLexicon";
var client = new AmazonPollyClient();
var putLexiconRequest = new PutLexiconRequest()
{
Name = lexiconName,
Content = lexiconContent,
};
try
{
var response = await client.PutLexiconAsync(putLexiconRequest);
if (response.HttpStatusCode == System.Net.HttpStatusCode.OK)
{
Console.WriteLine($"Successfully created Lexicon: {lexiconName}.");
}
else
{
Console.WriteLine($"Could not create Lexicon: {lexiconName}.");
}
}
catch (Exception ex)
{
Console.WriteLine("Exception caught: " + ex.Message);
}
}
}
```
+ For API details, see [PutLexicon](https://docs.aws.amazon.com/goto/DotNetSDKV3/polly-2016-06-10/PutLexicon) in *AWS SDK for .NET API Reference*.
------
#### [ CLI ]
**AWS CLI**
**To store a lexicon**
The following `put-lexicon` example stores the specified pronunciation lexicon. The `example.pls` file specifies a W3C PLS-compliant lexicon.
```
aws polly put-lexicon \
--name w3c \
--content file://example.pls
```
Contents of `example.pls`
```
{
W3C
World Wide Web Consortium
}
```
This command produces no output.
For more information, see [Using the PutLexicon operation](https://docs.aws.amazon.com/polly/latest/dg/gs-put-lexicon.html) in the *Amazon Polly Developer Guide*.
+ For API details, see [PutLexicon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/put-lexicon.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/polly#code-examples).
```
class PollyWrapper:
"""Encapsulates Amazon Polly functions."""
def __init__(self, polly_client, s3_resource):
"""
:param polly_client: A Boto3 Amazon Polly client.
:param s3_resource: A Boto3 Amazon Simple Storage Service (Amazon S3) resource.
"""
self.polly_client = polly_client
self.s3_resource = s3_resource
self.voice_metadata = None
def create_lexicon(self, name, content):
"""
Creates a lexicon with the specified content. A lexicon contains custom
pronunciations.
:param name: The name of the lexicon.
:param content: The content of the lexicon.
"""
try:
self.polly_client.put_lexicon(Name=name, Content=content)
logger.info("Created lexicon %s.", name)
except ClientError:
logger.exception("Couldn't create lexicon %s.")
raise
```
+ For API details, see [PutLexicon](https://docs.aws.amazon.com/goto/boto3/polly-2016-06-10/PutLexicon) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/polly#code-examples).
```
async fn make_lexicon(client: &Client, name: &str, from: &str, to: &str) -> Result<(), Error> {
let content = format!("
{}{}
", from, to);
client
.put_lexicon()
.name(name)
.content(content)
.send()
.await?;
println!("Added lexicon");
Ok(())
}
```
+ For API details, see [PutLexicon](https://docs.rs/aws-sdk-polly/latest/aws_sdk_polly/client/struct.Client.html#method.put_lexicon) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ply#code-examples).
```
TRY.
lo_ply->putlexicon(
iv_name = iv_name
iv_content = iv_content ).
MESSAGE 'Lexicon created successfully.' TYPE 'I'.
CATCH /aws1/cx_plyinvalidlexiconex.
MESSAGE 'Invalid lexicon.' TYPE 'E'.
CATCH /aws1/cx_plylexiconsizeexcdex.
MESSAGE 'Lexicon size exceeded.' TYPE 'E'.
CATCH /aws1/cx_plymaxlexemelengthe00.
MESSAGE 'Maximum lexeme length exceeded.' TYPE 'E'.
CATCH /aws1/cx_plymaxlexiconsnoexc00.
MESSAGE 'Maximum number of lexicons exceeded.' TYPE 'E'.
CATCH /aws1/cx_plyservicefailureex.
MESSAGE 'Service failure occurred.' TYPE 'E'.
CATCH /aws1/cx_plyunsuppedplsalpha00.
MESSAGE 'Unsupported PLS alphabet.' TYPE 'E'.
CATCH /aws1/cx_plyunsuppedplslangu00.
MESSAGE 'Unsupported PLS language.' TYPE 'E'.
ENDTRY.
```
+ For API details, see [PutLexicon](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `StartSpeechSynthesisTask` with an AWS SDK or CLI
The following code examples show how to use `StartSpeechSynthesisTask`.
------
#### [ CLI ]
**AWS CLI**
**To synthesize text**
The following `start-speech-synthesis-task` example synthesizes the text in `text_file.txt` and stores the resulting MP3 file in the specified bucket.
```
aws polly start-speech-synthesis-task \
--output-format mp3 \
--output-s3-bucket-name amzn-s3-demo-bucket \
--text file://text_file.txt \
--voice-id Joanna
```
Output:
```
{
"SynthesisTask": {
"TaskId": "70b61c0f-57ce-4715-a247-cae8729dcce9",
"TaskStatus": "scheduled",
"OutputUri": "https://s3.us-east-2.amazonaws.com/amzn-s3-demo-bucket/70b61c0f-57ce-4715-a247-cae8729dcce9.mp3",
"CreationTime": 1603911042.689,
"RequestCharacters": 1311,
"OutputFormat": "mp3",
"TextType": "text",
"VoiceId": "Joanna"
}
}
```
For more information, see [Creating long audio files](https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html) in the *Amazon Polly Developer Guide*.
+ For API details, see [StartSpeechSynthesisTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/start-speech-synthesis-task.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/polly#code-examples).
```
class PollyWrapper:
"""Encapsulates Amazon Polly functions."""
def __init__(self, polly_client, s3_resource):
"""
:param polly_client: A Boto3 Amazon Polly client.
:param s3_resource: A Boto3 Amazon Simple Storage Service (Amazon S3) resource.
"""
self.polly_client = polly_client
self.s3_resource = s3_resource
self.voice_metadata = None
def do_synthesis_task(
self,
text,
engine,
voice,
audio_format,
s3_bucket,
lang_code=None,
include_visemes=False,
wait_callback=None,
):
"""
Start an asynchronous task to synthesize speech or speech marks, wait for
the task to complete, retrieve the output from Amazon S3, and return the
data.
An asynchronous task is required when the text is too long for near-real time
synthesis.
:param text: The text to synthesize.
:param engine: The kind of engine used. Can be standard or neural.
:param voice: The ID of the voice to use.
:param audio_format: The audio format to return for synthesized speech. When
speech marks are synthesized, the output format is JSON.
:param s3_bucket: The name of an existing Amazon S3 bucket that you have
write access to. Synthesis output is written to this bucket.
:param lang_code: The language code of the voice to use. This has an effect
only when a bilingual voice is selected.
:param include_visemes: When True, a second request is made to Amazon Polly
to synthesize a list of visemes, using the specified
text and voice. A viseme represents the visual position
of the face and mouth when saying part of a word.
:param wait_callback: A callback function that is called periodically during
task processing, to give the caller an opportunity to
take action, such as to display status.
:return: The audio stream that contains the synthesized speech and a list
of visemes that are associated with the speech audio.
"""
try:
kwargs = {
"Engine": engine,
"OutputFormat": audio_format,
"OutputS3BucketName": s3_bucket,
"Text": text,
"VoiceId": voice,
}
if lang_code is not None:
kwargs["LanguageCode"] = lang_code
response = self.polly_client.start_speech_synthesis_task(**kwargs)
speech_task = response["SynthesisTask"]
logger.info("Started speech synthesis task %s.", speech_task["TaskId"])
viseme_task = None
if include_visemes:
kwargs["OutputFormat"] = "json"
kwargs["SpeechMarkTypes"] = ["viseme"]
response = self.polly_client.start_speech_synthesis_task(**kwargs)
viseme_task = response["SynthesisTask"]
logger.info("Started viseme synthesis task %s.", viseme_task["TaskId"])
except ClientError:
logger.exception("Couldn't start synthesis task.")
raise
else:
bucket = self.s3_resource.Bucket(s3_bucket)
audio_stream = self._wait_for_task(
10, speech_task["TaskId"], "speech", wait_callback, bucket
)
visemes = None
if include_visemes:
viseme_data = self._wait_for_task(
10, viseme_task["TaskId"], "viseme", wait_callback, bucket
)
visemes = [
json.loads(v) for v in viseme_data.read().decode().split() if v
]
return audio_stream, visemes
```
+ For API details, see [StartSpeechSynthesisTask](https://docs.aws.amazon.com/goto/boto3/polly-2016-06-10/StartSpeechSynthesisTask) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ply#code-examples).
```
TRY.
" Only pass optional parameters if they have values
IF iv_lang_code IS NOT INITIAL AND iv_s3_key_prefix IS NOT INITIAL.
oo_result = lo_ply->startspeechsynthesistask(
iv_engine = iv_engine
iv_outputformat = iv_audio_format
iv_outputs3bucketname = iv_s3_bucket
iv_outputs3keyprefix = iv_s3_key_prefix
iv_text = iv_text
iv_voiceid = iv_voice_id
iv_languagecode = iv_lang_code ).
ELSEIF iv_lang_code IS NOT INITIAL.
oo_result = lo_ply->startspeechsynthesistask(
iv_engine = iv_engine
iv_outputformat = iv_audio_format
iv_outputs3bucketname = iv_s3_bucket
iv_text = iv_text
iv_voiceid = iv_voice_id
iv_languagecode = iv_lang_code ).
ELSEIF iv_s3_key_prefix IS NOT INITIAL.
oo_result = lo_ply->startspeechsynthesistask(
iv_engine = iv_engine
iv_outputformat = iv_audio_format
iv_outputs3bucketname = iv_s3_bucket
iv_outputs3keyprefix = iv_s3_key_prefix
iv_text = iv_text
iv_voiceid = iv_voice_id ).
ELSE.
oo_result = lo_ply->startspeechsynthesistask(
iv_engine = iv_engine
iv_outputformat = iv_audio_format
iv_outputs3bucketname = iv_s3_bucket
iv_text = iv_text
iv_voiceid = iv_voice_id ).
ENDIF.
MESSAGE 'Speech synthesis task started.' TYPE 'I'.
CATCH /aws1/cx_plyinvalids3bucketex.
MESSAGE 'Invalid S3 bucket.' TYPE 'E'.
CATCH /aws1/cx_plyinvalidssmlex.
MESSAGE 'Invalid SSML.' TYPE 'E'.
CATCH /aws1/cx_plylexiconnotfoundex.
MESSAGE 'Lexicon not found.' TYPE 'E'.
CATCH /aws1/cx_plyservicefailureex.
MESSAGE 'Service failure occurred.' TYPE 'E'.
CATCH /aws1/cx_plytextlengthexcdex.
MESSAGE 'Text length exceeded maximum.' TYPE 'E'.
ENDTRY.
```
+ For API details, see [StartSpeechSynthesisTask](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Use `SynthesizeSpeech` with an AWS SDK
The following code examples show how to use `SynthesizeSpeech`.
Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code example:
+ [Getting started with Amazon Polly](polly_example_polly_GettingStarted_082_section.md)
------
#### [ .NET ]
**SDK for .NET**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/Polly#code-examples).
```
using System;
using System.IO;
using System.Threading.Tasks;
using Amazon.Polly;
using Amazon.Polly.Model;
public class SynthesizeSpeech
{
public static async Task Main()
{
string outputFileName = "speech.mp3";
string text = "Twas brillig, and the slithy toves did gyre and gimbol in the wabe";
var client = new AmazonPollyClient();
var response = await PollySynthesizeSpeech(client, text);
WriteSpeechToStream(response.AudioStream, outputFileName);
}
///
/// Calls the Amazon Polly SynthesizeSpeechAsync method to convert text
/// to speech.
///
/// The Amazon Polly client object used to connect
/// to the Amazon Polly service.
/// The text to convert to speech.
/// A SynthesizeSpeechResponse object that includes an AudioStream
/// object with the converted text.
private static async Task PollySynthesizeSpeech(IAmazonPolly client, string text)
{
var synthesizeSpeechRequest = new SynthesizeSpeechRequest()
{
OutputFormat = OutputFormat.Mp3,
VoiceId = VoiceId.Joanna,
Text = text,
};
var synthesizeSpeechResponse =
await client.SynthesizeSpeechAsync(synthesizeSpeechRequest);
return synthesizeSpeechResponse;
}
///
/// Writes the AudioStream returned from the call to
/// SynthesizeSpeechAsync to a file in MP3 format.
///
/// The AudioStream returned from the
/// call to the SynthesizeSpeechAsync method.
/// The full path to the file in which to
/// save the audio stream.
private static void WriteSpeechToStream(Stream audioStream, string outputFileName)
{
var outputStream = new FileStream(
outputFileName,
FileMode.Create,
FileAccess.Write);
byte[] buffer = new byte[2 * 1024];
int readBytes;
while ((readBytes = audioStream.Read(buffer, 0, 2 * 1024)) > 0)
{
outputStream.Write(buffer, 0, readBytes);
}
// Flushes the buffer to avoid losing the last second or so of
// the synthesized text.
outputStream.Flush();
Console.WriteLine($"Saved {outputFileName} to disk.");
}
}
```
Synthesize speech from text using speech marks with Amazon Polly using an AWS SDK.
```
using System;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using Amazon.Polly;
using Amazon.Polly.Model;
public class SynthesizeSpeechMarks
{
public static async Task Main()
{
var client = new AmazonPollyClient();
string outputFileName = "speechMarks.json";
var synthesizeSpeechRequest = new SynthesizeSpeechRequest()
{
OutputFormat = OutputFormat.Json,
SpeechMarkTypes = new List
{
SpeechMarkType.Viseme,
SpeechMarkType.Word,
},
VoiceId = VoiceId.Joanna,
Text = "This is a sample text to be synthesized.",
};
try
{
using (var outputStream = new FileStream(outputFileName, FileMode.Create, FileAccess.Write))
{
var synthesizeSpeechResponse = await client.SynthesizeSpeechAsync(synthesizeSpeechRequest);
var buffer = new byte[2 * 1024];
int readBytes;
var inputStream = synthesizeSpeechResponse.AudioStream;
while ((readBytes = inputStream.Read(buffer, 0, 2 * 1024)) > 0)
{
outputStream.Write(buffer, 0, readBytes);
}
}
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
```
+ For API details, see [SynthesizeSpeech](https://docs.aws.amazon.com/goto/DotNetSDKV3/polly-2016-06-10/SynthesizeSpeech) in *AWS SDK for .NET API Reference*.
------
#### [ Java ]
**SDK for Java 2.x**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/polly#code-examples).
```
import javazoom.jl.decoder.JavaLayerException;
import software.amazon.awssdk.core.ResponseInputStream;
import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.polly.PollyClient;
import software.amazon.awssdk.services.polly.model.DescribeVoicesRequest;
import software.amazon.awssdk.services.polly.model.Voice;
import software.amazon.awssdk.services.polly.model.DescribeVoicesResponse;
import software.amazon.awssdk.services.polly.model.OutputFormat;
import software.amazon.awssdk.services.polly.model.PollyException;
import software.amazon.awssdk.services.polly.model.SynthesizeSpeechRequest;
import software.amazon.awssdk.services.polly.model.SynthesizeSpeechResponse;
import java.io.IOException;
import java.io.InputStream;
import javazoom.jl.player.advanced.AdvancedPlayer;
import javazoom.jl.player.advanced.PlaybackEvent;
import javazoom.jl.player.advanced.PlaybackListener;
/**
* Before running this Java V2 code example, set up your development
* environment, including your credentials.
*
* For more information, see the following documentation topic:
*
* https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
*/
public class PollyDemo {
private static final String SAMPLE = "Congratulations. You have successfully built this working demo " +
" of Amazon Polly in Java Version 2. Have fun building voice enabled apps with Amazon Polly (that's me!), and always "
+
" look at the AWS website for tips and tricks on using Amazon Polly and other great services from AWS";
public static void main(String args[]) {
PollyClient polly = PollyClient.builder()
.region(Region.US_WEST_2)
.build();
talkPolly(polly);
polly.close();
}
public static void talkPolly(PollyClient polly) {
try {
DescribeVoicesRequest describeVoiceRequest = DescribeVoicesRequest.builder()
.engine("standard")
.build();
DescribeVoicesResponse describeVoicesResult = polly.describeVoices(describeVoiceRequest);
Voice voice = describeVoicesResult.voices().stream()
.filter(v -> v.name().equals("Joanna"))
.findFirst()
.orElseThrow(() -> new RuntimeException("Voice not found"));
InputStream stream = synthesize(polly, SAMPLE, voice, OutputFormat.MP3);
AdvancedPlayer player = new AdvancedPlayer(stream,
javazoom.jl.player.FactoryRegistry.systemRegistry().createAudioDevice());
player.setPlayBackListener(new PlaybackListener() {
public void playbackStarted(PlaybackEvent evt) {
System.out.println("Playback started");
System.out.println(SAMPLE);
}
public void playbackFinished(PlaybackEvent evt) {
System.out.println("Playback finished");
}
});
// play it!
player.play();
} catch (PollyException | JavaLayerException | IOException e) {
System.err.println(e.getMessage());
System.exit(1);
}
}
public static InputStream synthesize(PollyClient polly, String text, Voice voice, OutputFormat format)
throws IOException {
SynthesizeSpeechRequest synthReq = SynthesizeSpeechRequest.builder()
.text(text)
.voiceId(voice.id())
.outputFormat(format)
.build();
ResponseInputStream synthRes = polly.synthesizeSpeech(synthReq);
return synthRes;
}
}
```
+ For API details, see [SynthesizeSpeech](https://docs.aws.amazon.com/goto/SdkForJavaV2/polly-2016-06-10/SynthesizeSpeech) in *AWS SDK for Java 2.x API Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/polly#code-examples).
```
class PollyWrapper:
"""Encapsulates Amazon Polly functions."""
def __init__(self, polly_client, s3_resource):
"""
:param polly_client: A Boto3 Amazon Polly client.
:param s3_resource: A Boto3 Amazon Simple Storage Service (Amazon S3) resource.
"""
self.polly_client = polly_client
self.s3_resource = s3_resource
self.voice_metadata = None
def synthesize(
self, text, engine, voice, audio_format, lang_code=None, include_visemes=False
):
"""
Synthesizes speech or speech marks from text, using the specified voice.
:param text: The text to synthesize.
:param engine: The kind of engine used. Can be standard or neural.
:param voice: The ID of the voice to use.
:param audio_format: The audio format to return for synthesized speech. When
speech marks are synthesized, the output format is JSON.
:param lang_code: The language code of the voice to use. This has an effect
only when a bilingual voice is selected.
:param include_visemes: When True, a second request is made to Amazon Polly
to synthesize a list of visemes, using the specified
text and voice. A viseme represents the visual position
of the face and mouth when saying part of a word.
:return: The audio stream that contains the synthesized speech and a list
of visemes that are associated with the speech audio.
"""
try:
kwargs = {
"Engine": engine,
"OutputFormat": audio_format,
"Text": text,
"VoiceId": voice,
}
if lang_code is not None:
kwargs["LanguageCode"] = lang_code
response = self.polly_client.synthesize_speech(**kwargs)
audio_stream = response["AudioStream"]
logger.info("Got audio stream spoken by %s.", voice)
visemes = None
if include_visemes:
kwargs["OutputFormat"] = "json"
kwargs["SpeechMarkTypes"] = ["viseme"]
response = self.polly_client.synthesize_speech(**kwargs)
visemes = [
json.loads(v)
for v in response["AudioStream"].read().decode().split()
if v
]
logger.info("Got %s visemes.", len(visemes))
except ClientError:
logger.exception("Couldn't get audio stream.")
raise
else:
return audio_stream, visemes
```
+ For API details, see [SynthesizeSpeech](https://docs.aws.amazon.com/goto/boto3/polly-2016-06-10/SynthesizeSpeech) in *AWS SDK for Python (Boto3) API Reference*.
------
#### [ Ruby ]
**SDK for Ruby**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/polly#code-examples).
```
require 'aws-sdk-polly' # In v2: require 'aws-sdk'
begin
# Get the filename from the command line
if ARGV.empty?
puts 'You must supply a filename'
exit 1
end
filename = ARGV[0]
# Open file and get the contents as a string
if File.exist?(filename)
contents = IO.read(filename)
else
puts "No such file: #{filename}"
exit 1
end
# Create an Amazon Polly client using
# credentials from the shared credentials file ~/.aws/credentials
# and the configuration (region) from the shared configuration file ~/.aws/config
polly = Aws::Polly::Client.new
resp = polly.synthesize_speech({
output_format: 'mp3',
text: contents,
voice_id: 'Joanna'
})
# Save output
# Get just the file name
# abc/xyz.txt -> xyx.txt
name = File.basename(filename)
# Split up name so we get just the xyz part
parts = name.split('.')
first_part = parts[0]
mp3_file = "#{first_part}.mp3"
IO.copy_stream(resp.audio_stream, mp3_file)
puts "Wrote MP3 content to: #{mp3_file}"
rescue StandardError => e
puts 'Got error:'
puts 'Error message:'
puts e.message
end
```
+ For API details, see [SynthesizeSpeech](https://docs.aws.amazon.com/goto/SdkForRubyV3/polly-2016-06-10/SynthesizeSpeech) in *AWS SDK for Ruby API Reference*.
------
#### [ Rust ]
**SDK for Rust**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rustv1/examples/polly#code-examples).
```
async fn synthesize(client: &Client, filename: &str) -> Result<(), Error> {
let content = fs::read_to_string(filename);
let resp = client
.synthesize_speech()
.output_format(OutputFormat::Mp3)
.text(content.unwrap())
.voice_id(VoiceId::Joanna)
.send()
.await?;
// Get MP3 data from response and save it
let mut blob = resp
.audio_stream
.collect()
.await
.expect("failed to read data");
let parts: Vec<&str> = filename.split('.').collect();
let out_file = format!("{}{}", String::from(parts[0]), ".mp3");
let mut file = tokio::fs::File::create(out_file)
.await
.expect("failed to create file");
file.write_all_buf(&mut blob)
.await
.expect("failed to write to file");
Ok(())
}
```
+ For API details, see [SynthesizeSpeech](https://docs.rs/aws-sdk-polly/latest/aws_sdk_polly/client/struct.Client.html#method.synthesize_speech) in *AWS SDK for Rust API reference*.
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/ply#code-examples).
```
TRY.
" Only pass optional language code if it has a value
IF iv_lang_code IS NOT INITIAL.
oo_result = lo_ply->synthesizespeech(
iv_engine = iv_engine
iv_outputformat = iv_output_fmt
iv_text = iv_text
iv_voiceid = iv_voice_id
iv_languagecode = iv_lang_code ).
ELSE.
oo_result = lo_ply->synthesizespeech(
iv_engine = iv_engine
iv_outputformat = iv_output_fmt
iv_text = iv_text
iv_voiceid = iv_voice_id ).
ENDIF.
MESSAGE 'Speech synthesized successfully.' TYPE 'I'.
CATCH /aws1/cx_plyinvalidssmlex.
MESSAGE 'Invalid SSML.' TYPE 'E'.
CATCH /aws1/cx_plylexiconnotfoundex.
MESSAGE 'Lexicon not found.' TYPE 'E'.
CATCH /aws1/cx_plyservicefailureex.
MESSAGE 'Service failure occurred.' TYPE 'E'.
CATCH /aws1/cx_plytextlengthexcdex.
MESSAGE 'Text length exceeded maximum.' TYPE 'E'.
ENDTRY.
```
+ For API details, see [SynthesizeSpeech](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
# Scenarios for Amazon Polly using AWS SDKs
The following code examples show you how to implement common scenarios in Amazon Polly with AWS SDKs. These scenarios show you how to accomplish specific tasks by calling multiple functions within Amazon Polly or combined with other AWS services. Each scenario includes a link to the complete source code, where you can find instructions on how to set up and run the code.
Scenarios target an intermediate level of experience to help you understand service actions in context.
**Topics**
+ [Convert text to speech and back to text](polly_example_cross_Telephone_section.md)
+ [Create a lip-sync application](polly_example_polly_LipSync_section.md)
+ [Create an application to analyze customer feedback](polly_example_cross_FSA_section.md)
+ [Getting started with Amazon Polly](polly_example_polly_GettingStarted_082_section.md)
# Convert text to speech and back to text using an AWS SDK
The following code example shows how to:
+ Use Amazon Polly to synthesize a plain text (UTF-8) input file to an audio file.
+ Upload the audio file to an Amazon S3 bucket.
+ Use Amazon Transcribe to convert the audio file to text.
+ Display the text.
------
#### [ Rust ]
**SDK for Rust**
Use Amazon Polly to synthesize a plain text (UTF-8) input file to an audio file, upload the audio file to an Amazon S3 bucket, use Amazon Transcribe to convert that audio file to text, and display the text.
For complete source code and instructions on how to set up and run, see the full example on [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/blob/main/rustv1/cross_service#code-examples).
**Services used in this example**
+ Amazon Polly
+ Amazon S3
+ Amazon Transcribe
------
# Create a lip-sync application with Amazon Polly using an AWS SDK
The following code example shows how to create a lip-sync application with Amazon Polly.
------
#### [ Python ]
**SDK for Python (Boto3)**
Shows how to use Amazon Polly and Tkinter to create a lip-sync application that displays an animated face speaking along with the speech synthesized by Amazon Polly. Lip-sync is accomplished by requesting a list of visemes from Amazon Polly that match up with the synthesized speech.
+ Get voice metadata from Amazon Polly and display it in a Tkinter application.
+ Get synthesized speech audio and matching viseme speech marks from Amazon Polly.
+ Play the audio with synchronized mouth movements in an animated face.
+ Submit asynchronous synthesis tasks for long texts and retrieve the output from an Amazon Simple Storage Service (Amazon S3) bucket.
For complete source code and instructions on how to set up and run, see the full example on [GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/polly#code-examples).
**Services used in this example**
+ Amazon Polly
------
# Create an application that analyzes customer feedback and synthesizes audio
The following code examples show how to create an application that analyzes customer comment cards, translates them from their original language, determines their sentiment, and generates an audio file from the translated text.
------
#### [ .NET ]
**SDK for .NET**
This example application analyzes and stores customer feedback cards. Specifically, it fulfills the need of a fictitious hotel in New York City. The hotel receives feedback from guests in various languages in the form of physical comment cards. That feedback is uploaded into the app through a web client. After an image of a comment card is uploaded, the following steps occur:
+ Text is extracted from the image using Amazon Textract.
+ Amazon Comprehend determines the sentiment of the extracted text and its language.
+ The extracted text is translated to English using Amazon Translate.
+ Amazon Polly synthesizes an audio file from the extracted text.
The full app can be deployed with the AWS CDK. For source code and deployment instructions, see the project in [ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3/cross-service/FeedbackSentimentAnalyzer).
**Services used in this example**
+ Amazon Comprehend
+ Lambda
+ Amazon Polly
+ Amazon Textract
+ Amazon Translate
------
#### [ Java ]
**SDK for Java 2.x**
This example application analyzes and stores customer feedback cards. Specifically, it fulfills the need of a fictitious hotel in New York City. The hotel receives feedback from guests in various languages in the form of physical comment cards. That feedback is uploaded into the app through a web client. After an image of a comment card is uploaded, the following steps occur:
+ Text is extracted from the image using Amazon Textract.
+ Amazon Comprehend determines the sentiment of the extracted text and its language.
+ The extracted text is translated to English using Amazon Translate.
+ Amazon Polly synthesizes an audio file from the extracted text.
The full app can be deployed with the AWS CDK. For source code and deployment instructions, see the project in [ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/usecases/creating_fsa_app).
**Services used in this example**
+ Amazon Comprehend
+ Lambda
+ Amazon Polly
+ Amazon Textract
+ Amazon Translate
------
#### [ JavaScript ]
**SDK for JavaScript (v3)**
This example application analyzes and stores customer feedback cards. Specifically, it fulfills the need of a fictitious hotel in New York City. The hotel receives feedback from guests in various languages in the form of physical comment cards. That feedback is uploaded into the app through a web client. After an image of a comment card is uploaded, the following steps occur:
+ Text is extracted from the image using Amazon Textract.
+ Amazon Comprehend determines the sentiment of the extracted text and its language.
+ The extracted text is translated to English using Amazon Translate.
+ Amazon Polly synthesizes an audio file from the extracted text.
The full app can be deployed with the AWS CDK. For source code and deployment instructions, see the project in [ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/cross-services/feedback-sentiment-analyzer). The following excerpts show how the AWS SDK for JavaScript is used inside of Lambda functions.
```
import {
ComprehendClient,
DetectDominantLanguageCommand,
DetectSentimentCommand,
} from "@aws-sdk/client-comprehend";
/**
* Determine the language and sentiment of the extracted text.
*
* @param {{ source_text: string}} extractTextOutput
*/
export const handler = async (extractTextOutput) => {
const comprehendClient = new ComprehendClient({});
const detectDominantLanguageCommand = new DetectDominantLanguageCommand({
Text: extractTextOutput.source_text,
});
// The source language is required for sentiment analysis and
// translation in the next step.
const { Languages } = await comprehendClient.send(
detectDominantLanguageCommand,
);
const languageCode = Languages[0].LanguageCode;
const detectSentimentCommand = new DetectSentimentCommand({
Text: extractTextOutput.source_text,
LanguageCode: languageCode,
});
const { Sentiment } = await comprehendClient.send(detectSentimentCommand);
return {
sentiment: Sentiment,
language_code: languageCode,
};
};
```
```
import {
DetectDocumentTextCommand,
TextractClient,
} from "@aws-sdk/client-textract";
/**
* Fetch the S3 object from the event and analyze it using Amazon Textract.
*
* @param {import("@types/aws-lambda").EventBridgeEvent<"Object Created">} eventBridgeS3Event
*/
export const handler = async (eventBridgeS3Event) => {
const textractClient = new TextractClient();
const detectDocumentTextCommand = new DetectDocumentTextCommand({
Document: {
S3Object: {
Bucket: eventBridgeS3Event.bucket,
Name: eventBridgeS3Event.object,
},
},
});
// Textract returns a list of blocks. A block can be a line, a page, word, etc.
// Each block also contains geometry of the detected text.
// For more information on the Block type, see https://docs.aws.amazon.com/textract/latest/dg/API_Block.html.
const { Blocks } = await textractClient.send(detectDocumentTextCommand);
// For the purpose of this example, we are only interested in words.
const extractedWords = Blocks.filter((b) => b.BlockType === "WORD").map(
(b) => b.Text,
);
return extractedWords.join(" ");
};
```
```
import { PollyClient, SynthesizeSpeechCommand } from "@aws-sdk/client-polly";
import { S3Client } from "@aws-sdk/client-s3";
import { Upload } from "@aws-sdk/lib-storage";
/**
* Synthesize an audio file from text.
*
* @param {{ bucket: string, translated_text: string, object: string}} sourceDestinationConfig
*/
export const handler = async (sourceDestinationConfig) => {
const pollyClient = new PollyClient({});
const synthesizeSpeechCommand = new SynthesizeSpeechCommand({
Engine: "neural",
Text: sourceDestinationConfig.translated_text,
VoiceId: "Ruth",
OutputFormat: "mp3",
});
const { AudioStream } = await pollyClient.send(synthesizeSpeechCommand);
const audioKey = `${sourceDestinationConfig.object}.mp3`;
// Store the audio file in S3.
const s3Client = new S3Client();
const upload = new Upload({
client: s3Client,
params: {
Bucket: sourceDestinationConfig.bucket,
Key: audioKey,
Body: AudioStream,
ContentType: "audio/mp3",
},
});
await upload.done();
return audioKey;
};
```
```
import {
TranslateClient,
TranslateTextCommand,
} from "@aws-sdk/client-translate";
/**
* Translate the extracted text to English.
*
* @param {{ extracted_text: string, source_language_code: string}} textAndSourceLanguage
*/
export const handler = async (textAndSourceLanguage) => {
const translateClient = new TranslateClient({});
const translateCommand = new TranslateTextCommand({
SourceLanguageCode: textAndSourceLanguage.source_language_code,
TargetLanguageCode: "en",
Text: textAndSourceLanguage.extracted_text,
});
const { TranslatedText } = await translateClient.send(translateCommand);
return { translated_text: TranslatedText };
};
```
**Services used in this example**
+ Amazon Comprehend
+ Lambda
+ Amazon Polly
+ Amazon Textract
+ Amazon Translate
------
#### [ Ruby ]
**SDK for Ruby**
This example application analyzes and stores customer feedback cards. Specifically, it fulfills the need of a fictitious hotel in New York City. The hotel receives feedback from guests in various languages in the form of physical comment cards. That feedback is uploaded into the app through a web client. After an image of a comment card is uploaded, the following steps occur:
+ Text is extracted from the image using Amazon Textract.
+ Amazon Comprehend determines the sentiment of the extracted text and its language.
+ The extracted text is translated to English using Amazon Translate.
+ Amazon Polly synthesizes an audio file from the extracted text.
The full app can be deployed with the AWS CDK. For source code and deployment instructions, see the project in [ GitHub](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/cross_service_examples/feedback_sentiment_analyzer).
**Services used in this example**
+ Amazon Comprehend
+ Lambda
+ Amazon Polly
+ Amazon Textract
+ Amazon Translate
------
# Getting started with Amazon Polly
The following code example shows how to:
+ Clean up resources
------
#### [ Bash ]
**AWS CLI with Bash script**
There's more on GitHub. Find the complete example and learn how to set up and run in the [Sample developer tutorials](https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/082-amazon-polly-gs) repository.
```
#!/bin/bash
# Amazon Polly Getting Started Script
# This script demonstrates how to use Amazon Polly with the AWS CLI
# Set up logging
LOG_FILE="polly-tutorial.log"
echo "Starting Amazon Polly tutorial at $(date)" > "$LOG_FILE"
# Function to log commands and their output
log_cmd() {
echo "Running: $1" | tee -a "$LOG_FILE"
eval "$1" 2>&1 | tee -a "$LOG_FILE"
return ${PIPESTATUS[0]}
}
# Function to check for errors
check_error() {
if echo "$1" | grep -i "error" > /dev/null; then
echo "ERROR detected in output. Exiting script." | tee -a "$LOG_FILE"
echo "$1" | tee -a "$LOG_FILE"
exit 1
fi
}
# Function to handle errors and cleanup
handle_error() {
echo "Error occurred. Attempting cleanup..." | tee -a "$LOG_FILE"
cleanup
exit 1
}
# Function to clean up resources
cleanup() {
echo "" | tee -a "$LOG_FILE"
echo "===========================================================" | tee -a "$LOG_FILE"
echo "CLEANUP PROCESS" | tee -a "$LOG_FILE"
echo "===========================================================" | tee -a "$LOG_FILE"
# Delete lexicon if it exists
if [ -n "$LEXICON_NAME" ]; then
echo "Deleting lexicon: $LEXICON_NAME" | tee -a "$LOG_FILE"
log_cmd "aws polly delete-lexicon --name $LEXICON_NAME"
fi
echo "Cleanup complete." | tee -a "$LOG_FILE"
}
# Trap errors
trap 'handle_error' ERR
# Step 1: Verify Amazon Polly is available
echo "Step 1: Verifying Amazon Polly availability" | tee -a "$LOG_FILE"
POLLY_CHECK=$(aws polly help 2>&1)
if echo "$POLLY_CHECK" | grep -i "not.*found\|invalid\|error" > /dev/null; then
echo "Amazon Polly is not available in your AWS CLI installation." | tee -a "$LOG_FILE"
echo "Please update your AWS CLI to the latest version." | tee -a "$LOG_FILE"
exit 1
else
echo "Amazon Polly is available. Proceeding with tutorial." | tee -a "$LOG_FILE"
fi
# Step 2: List available voices
echo "" | tee -a "$LOG_FILE"
echo "Step 2: Listing available voices" | tee -a "$LOG_FILE"
log_cmd "aws polly describe-voices --language-code en-US --output text --query 'Voices[0:3].[Id, LanguageCode, Gender]'"
# Step 3: Basic text-to-speech conversion
echo "" | tee -a "$LOG_FILE"
echo "Step 3: Converting text to speech" | tee -a "$LOG_FILE"
log_cmd "aws polly synthesize-speech --output-format mp3 --voice-id Joanna --text \"Hello, welcome to Amazon Polly. This is a sample text to speech conversion.\" output.mp3"
if [ -f "output.mp3" ]; then
echo "Successfully created output.mp3 file." | tee -a "$LOG_FILE"
echo "You can play this file with your preferred audio player." | tee -a "$LOG_FILE"
else
echo "Failed to create output.mp3 file." | tee -a "$LOG_FILE"
exit 1
fi
# Step 4: Using SSML for enhanced speech
echo "" | tee -a "$LOG_FILE"
echo "Step 4: Using SSML for enhanced speech" | tee -a "$LOG_FILE"
log_cmd "aws polly synthesize-speech --output-format mp3 --voice-id Matthew --text-type ssml --text \"Hello! This is a sample of SSML enhanced speech.\" ssml-output.mp3"
if [ -f "ssml-output.mp3" ]; then
echo "Successfully created ssml-output.mp3 file." | tee -a "$LOG_FILE"
echo "You can play this file with your preferred audio player." | tee -a "$LOG_FILE"
else
echo "Failed to create ssml-output.mp3 file." | tee -a "$LOG_FILE"
exit 1
fi
# Step 5: Working with lexicons
echo "" | tee -a "$LOG_FILE"
echo "Step 5: Working with lexicons" | tee -a "$LOG_FILE"
# Generate a random identifier for the lexicon (max 20 chars, alphanumeric only)
LEXICON_NAME="example$(openssl rand -hex 6)"
echo "Using lexicon name: $LEXICON_NAME" | tee -a "$LOG_FILE"
# Create a lexicon file
echo "Creating lexicon file..." | tee -a "$LOG_FILE"
cat > example.pls << 'EOF'
AWS
Amazon Web Services
EOF
# Upload the lexicon
echo "Uploading lexicon..." | tee -a "$LOG_FILE"
log_cmd "aws polly put-lexicon --name $LEXICON_NAME --content file://example.pls"
# List available lexicons
echo "Listing available lexicons..." | tee -a "$LOG_FILE"
log_cmd "aws polly list-lexicons --output text --query 'Lexicons[*].[Name]'"
# Get details about the lexicon
echo "Getting details about the lexicon..." | tee -a "$LOG_FILE"
log_cmd "aws polly get-lexicon --name $LEXICON_NAME --output text --query 'Lexicon.Name'"
# Use the lexicon when synthesizing speech
echo "Using the lexicon for speech synthesis..." | tee -a "$LOG_FILE"
log_cmd "aws polly synthesize-speech --output-format mp3 --voice-id Joanna --lexicon-names $LEXICON_NAME --text \"I work with AWS every day.\" lexicon-output.mp3"
if [ -f "lexicon-output.mp3" ]; then
echo "Successfully created lexicon-output.mp3 file." | tee -a "$LOG_FILE"
echo "You can play this file with your preferred audio player." | tee -a "$LOG_FILE"
else
echo "Failed to create lexicon-output.mp3 file." | tee -a "$LOG_FILE"
exit 1
fi
# Summary of created resources
echo "" | tee -a "$LOG_FILE"
echo "===========================================================" | tee -a "$LOG_FILE"
echo "TUTORIAL SUMMARY" | tee -a "$LOG_FILE"
echo "===========================================================" | tee -a "$LOG_FILE"
echo "Created resources:" | tee -a "$LOG_FILE"
echo "1. Lexicon: $LEXICON_NAME" | tee -a "$LOG_FILE"
echo "2. Audio files:" | tee -a "$LOG_FILE"
echo " - output.mp3" | tee -a "$LOG_FILE"
echo " - ssml-output.mp3" | tee -a "$LOG_FILE"
echo " - lexicon-output.mp3" | tee -a "$LOG_FILE"
echo "" | tee -a "$LOG_FILE"
# Prompt for cleanup
echo "" | tee -a "$LOG_FILE"
echo "===========================================================" | tee -a "$LOG_FILE"
echo "CLEANUP CONFIRMATION" | tee -a "$LOG_FILE"
echo "===========================================================" | tee -a "$LOG_FILE"
echo "Do you want to clean up all created resources? (y/n): " | tee -a "$LOG_FILE"
read -r CLEANUP_CHOICE
if [[ "$CLEANUP_CHOICE" =~ ^[Yy] ]]; then
cleanup
else
echo "Skipping cleanup. Resources will remain in your account." | tee -a "$LOG_FILE"
echo "To manually delete the lexicon later, run:" | tee -a "$LOG_FILE"
echo "aws polly delete-lexicon --name $LEXICON_NAME" | tee -a "$LOG_FILE"
fi
echo "" | tee -a "$LOG_FILE"
echo "Tutorial completed successfully!" | tee -a "$LOG_FILE"
echo "Log file: $LOG_FILE" | tee -a "$LOG_FILE"
```
+ For API details, see the following topics in *AWS CLI Command Reference*.
+ [DeleteLexicon](https://docs.aws.amazon.com/goto/aws-cli/polly-2016-06-10/DeleteLexicon)
+ [DescribeVoices](https://docs.aws.amazon.com/goto/aws-cli/polly-2016-06-10/DescribeVoices)
+ [GetLexicon](https://docs.aws.amazon.com/goto/aws-cli/polly-2016-06-10/GetLexicon)
+ [Help](https://docs.aws.amazon.com/goto/aws-cli/polly-2016-06-10/Help)
+ [ListLexicons](https://docs.aws.amazon.com/goto/aws-cli/polly-2016-06-10/ListLexicons)
+ [PutLexicon](https://docs.aws.amazon.com/goto/aws-cli/polly-2016-06-10/PutLexicon)
+ [SynthesizeSpeech](https://docs.aws.amazon.com/goto/aws-cli/polly-2016-06-10/SynthesizeSpeech)
------