NAME

Paws::Polly - Perl Interface to AWS Amazon Polly

SYNOPSIS

  use Paws;

  my $obj = Paws->service('Polly');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Amazon Polly is a web service that makes it easy to synthesize speech from text.

The Amazon Polly service provides API operations for synthesizing high-quality speech from plain text and Speech Synthesis Markup Language (SSML), along with managing pronunciations lexicons that enable you to get the best results for your application domain.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10

METHODS

DeleteLexicon

Name => Str

Each argument is described in detail in: Paws::Polly::DeleteLexicon

Returns: a Paws::Polly::DeleteLexiconOutput instance

Deletes the specified pronunciation lexicon stored in an AWS Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or ListLexicon APIs.

For more information, see Managing Lexicons (http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html).

DescribeVoices

[IncludeAdditionalLanguageCodes => Bool]
[LanguageCode => Str]
[NextToken => Str]

Each argument is described in detail in: Paws::Polly::DescribeVoices

Returns: a Paws::Polly::DescribeVoicesOutput instance

Returns the list of voices that are available for use when requesting speech synthesis. Each voice speaks a specified language, is either male or female, and is identified by an ID, which is the ASCII version of the voice name.

When synthesizing speech ( SynthesizeSpeech ), you provide the voice ID for the voice you want from the list of voices returned by DescribeVoices.

For example, you want your news reader application to read news in a specific language, but giving a user the option to choose the voice. Using the DescribeVoices operation you can provide the user with a list of available voices to select from.

You can optionally specify a language code to filter the available voices. For example, if you specify en-US, the operation returns a list of all available US English voices.

This operation requires permissions to perform the polly:DescribeVoices action.

GetLexicon

Name => Str

Each argument is described in detail in: Paws::Polly::GetLexicon

Returns: a Paws::Polly::GetLexiconOutput instance

Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons (http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html).

GetSpeechSynthesisTask

TaskId => Str

Each argument is described in detail in: Paws::Polly::GetSpeechSynthesisTask

Returns: a Paws::Polly::GetSpeechSynthesisTaskOutput instance

Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task.

ListLexicons

[NextToken => Str]

Each argument is described in detail in: Paws::Polly::ListLexicons

Returns: a Paws::Polly::ListLexiconsOutput instance

Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons (http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html).

ListSpeechSynthesisTasks

[MaxResults => Int]
[NextToken => Str]
[Status => Str]

Each argument is described in detail in: Paws::Polly::ListSpeechSynthesisTasks

Returns: a Paws::Polly::ListSpeechSynthesisTasksOutput instance

Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed.

PutLexicon

Content => Str
Name => Str

Each argument is described in detail in: Paws::Polly::PutLexicon

Returns: a Paws::Polly::PutLexiconOutput instance

Stores a pronunciation lexicon in an AWS Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation.

For more information, see Managing Lexicons (http://docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html).

StartSpeechSynthesisTask

OutputFormat => Str
OutputS3BucketName => Str
Text => Str
VoiceId => Str
[LanguageCode => Str]
[LexiconNames => ArrayRef[Str|Undef]]
[OutputS3KeyPrefix => Str]
[SampleRate => Str]
[SnsTopicArn => Str]
[SpeechMarkTypes => ArrayRef[Str|Undef]]
[TextType => Str]

Each argument is described in detail in: Paws::Polly::StartSpeechSynthesisTask

Returns: a Paws::Polly::StartSpeechSynthesisTaskOutput instance

Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status.

SynthesizeSpeech

OutputFormat => Str
Text => Str
VoiceId => Str
[LanguageCode => Str]
[LexiconNames => ArrayRef[Str|Undef]]
[SampleRate => Str]
[SpeechMarkTypes => ArrayRef[Str|Undef]]
[TextType => Str]

Each argument is described in detail in: Paws::Polly::SynthesizeSpeech

Returns: a Paws::Polly::SynthesizeSpeechOutput instance

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works (http://docs.aws.amazon.com/polly/latest/dg/how-text-to-speech-works.html).

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

DescribeAllVoices(sub { },[IncludeAdditionalLanguageCodes => Bool, LanguageCode => Str, NextToken => Str])

DescribeAllVoices([IncludeAdditionalLanguageCodes => Bool, LanguageCode => Str, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Voices, passing the object as the first parameter, and the string 'Voices' as the second parameter 

If not, it will return a a Paws::Polly::DescribeVoicesOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllLexicons(sub { },[NextToken => Str])

ListAllLexicons([NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Lexicons, passing the object as the first parameter, and the string 'Lexicons' as the second parameter 

If not, it will return a a Paws::Polly::ListLexiconsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllSpeechSynthesisTasks(sub { },[MaxResults => Int, NextToken => Str, Status => Str])

ListAllSpeechSynthesisTasks([MaxResults => Int, NextToken => Str, Status => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - SynthesisTasks, passing the object as the first parameter, and the string 'SynthesisTasks' as the second parameter 

If not, it will return a a Paws::Polly::ListSpeechSynthesisTasksOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues