Class: Aws::Polly::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-polly/client.rb

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::SharedCredentials` - Used for loading credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` to enable retries and extended timeouts.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is search for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the ‘:region` option. You should only configure an `:endpoint` when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.



202
203
204
 
# File 'lib/aws-sdk-polly/client.rb', line 202

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



928
929
930
 
# File 'lib/aws-sdk-polly/client.rb', line 928

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



931
932
933
 
# File 'lib/aws-sdk-polly/client.rb', line 931

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/aws-sdk-polly/client.rb', line 906

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-polly'
  context[:gem_version] = '1.15.0'
  Seahorse::Client::Request.new(handlers, context)
end

#delete_lexicon(params = {}) ⇒ Struct

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

[1]: docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html

Examples:

Example: To delete a lexicon


# Deletes a specified pronunciation lexicon stored in an AWS Region.

resp = client.delete_lexicon({
  name: "example", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_lexicon({
  name: "LexiconName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the lexicon to delete. Must be an existing lexicon in the region.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



248
249
250
251
 
# File 'lib/aws-sdk-polly/client.rb', line 248

def delete_lexicon(params = {}, options = {})
  req = build_request(:delete_lexicon, params)
  req.send_request(options)
end

#describe_voices(params = {}) ⇒ Types::DescribeVoicesOutput

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.

Examples:

Example: To describe available voices


# Returns the list of voices that are available for use when requesting speech synthesis. Displayed languages are those
# within the specified language code. If no language code is specified, voices for all available languages are displayed.

resp = client.describe_voices({
  language_code: "en-GB", 
})

resp.to_h outputs the following:
{
  voices: [
    {
      gender: "Female", 
      id: "Emma", 
      language_code: "en-GB", 
      language_name: "British English", 
      name: "Emma", 
    }, 
    {
      gender: "Male", 
      id: "Brian", 
      language_code: "en-GB", 
      language_name: "British English", 
      name: "Brian", 
    }, 
    {
      gender: "Female", 
      id: "Amy", 
      language_code: "en-GB", 
      language_name: "British English", 
      name: "Amy", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.describe_voices({
  language_code: "cmn-CN", # accepts cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR
  include_additional_language_codes: false,
  next_token: "NextToken",
})

Response structure


resp.voices #=> Array
resp.voices[0].gender #=> String, one of "Female", "Male"
resp.voices[0].id #=> String, one of "Geraint", "Gwyneth", "Mads", "Naja", "Hans", "Marlene", "Nicole", "Russell", "Amy", "Brian", "Emma", "Raveena", "Ivy", "Joanna", "Joey", "Justin", "Kendra", "Kimberly", "Matthew", "Salli", "Conchita", "Enrique", "Miguel", "Penelope", "Chantal", "Celine", "Lea", "Mathieu", "Dora", "Karl", "Carla", "Giorgio", "Mizuki", "Liv", "Lotte", "Ruben", "Ewa", "Jacek", "Jan", "Maja", "Ricardo", "Vitoria", "Cristiano", "Ines", "Carmen", "Maxim", "Tatyana", "Astrid", "Filiz", "Vicki", "Takumi", "Seoyeon", "Aditi", "Zhiyu", "Bianca", "Lucia", "Mia"
resp.voices[0].language_code #=> String, one of "cmn-CN", "cy-GB", "da-DK", "de-DE", "en-AU", "en-GB", "en-GB-WLS", "en-IN", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "is-IS", "it-IT", "ja-JP", "hi-IN", "ko-KR", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "ru-RU", "sv-SE", "tr-TR"
resp.voices[0].language_name #=> String
resp.voices[0].name #=> String
resp.voices[0].additional_language_codes #=> Array
resp.voices[0].additional_language_codes[0] #=> String, one of "cmn-CN", "cy-GB", "da-DK", "de-DE", "en-AU", "en-GB", "en-GB-WLS", "en-IN", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "is-IS", "it-IT", "ja-JP", "hi-IN", "ko-KR", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "ru-RU", "sv-SE", "tr-TR"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :language_code (String) —

    The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don’t specify this optional parameter, all available voices are returned.

  • :include_additional_language_codes (Boolean) —

    Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify ‘yes` but not if you specify `no`.

  • :next_token (String) —

    An opaque pagination token returned from the previous ‘DescribeVoices` operation. If present, this indicates where to continue the listing.

Returns:

See Also:



358
359
360
361
 
# File 'lib/aws-sdk-polly/client.rb', line 358

def describe_voices(params = {}, options = {})
  req = build_request(:describe_voices, params)
  req.send_request(options)
end

#get_lexicon(params = {}) ⇒ Types::GetLexiconOutput

Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see [Managing Lexicons].

[1]: docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html

Examples:

Example: To retrieve a lexicon


# Returns the content of the specified pronunciation lexicon stored in an AWS Region.

resp = client.get_lexicon({
  name: "", 
})

resp.to_h outputs the following:
{
  lexicon: {
    content: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<lexicon version=\"1.0\" \r\n      xmlns=\"http://www.w3.org/2005/01/pronunciation-lexicon\"\r\n      xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" \r\n      xsi:schemaLocation=\"http://www.w3.org/2005/01/pronunciation-lexicon \r\n        http://www.w3.org/TR/2007/CR-pronunciation-lexicon-20071212/pls.xsd\"\r\n      alphabet=\"ipa\" \r\n      xml:lang=\"en-US\">\r\n  <lexeme>\r\n    <grapheme>W3C</grapheme>\r\n    <alias>World Wide Web Consortium</alias>\r\n  </lexeme>\r\n</lexicon>", 
    name: "example", 
  }, 
  lexicon_attributes: {
    alphabet: "ipa", 
    language_code: "en-US", 
    last_modified: Time.parse(1478542980.117), 
    lexemes_count: 1, 
    lexicon_arn: "arn:aws:polly:us-east-1:123456789012:lexicon/example", 
    size: 503, 
  }, 
}

Request syntax with placeholder values


resp = client.get_lexicon({
  name: "LexiconName", # required
})

Response structure


resp.lexicon.content #=> String
resp.lexicon.name #=> String
resp.lexicon_attributes.alphabet #=> String
resp.lexicon_attributes.language_code #=> String, one of "cmn-CN", "cy-GB", "da-DK", "de-DE", "en-AU", "en-GB", "en-GB-WLS", "en-IN", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "is-IS", "it-IT", "ja-JP", "hi-IN", "ko-KR", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "ru-RU", "sv-SE", "tr-TR"
resp.lexicon_attributes.last_modified #=> Time
resp.lexicon_attributes.lexicon_arn #=> String
resp.lexicon_attributes.lexemes_count #=> Integer
resp.lexicon_attributes.size #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    Name of the lexicon.

Returns:

See Also:



424
425
426
427
 
# File 'lib/aws-sdk-polly/client.rb', line 424

def get_lexicon(params = {}, options = {})
  req = build_request(:get_lexicon, params)
  req.send_request(options)
end

#get_speech_synthesis_task(params = {}) ⇒ Types::GetSpeechSynthesisTaskOutput

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.

Examples:

Request syntax with placeholder values


resp = client.get_speech_synthesis_task({
  task_id: "TaskId", # required
})

Response structure


resp.synthesis_task.task_id #=> String
resp.synthesis_task.task_status #=> String, one of "scheduled", "inProgress", "completed", "failed"
resp.synthesis_task.task_status_reason #=> String
resp.synthesis_task.output_uri #=> String
resp.synthesis_task.creation_time #=> Time
resp.synthesis_task.request_characters #=> Integer
resp.synthesis_task.sns_topic_arn #=> String
resp.synthesis_task.lexicon_names #=> Array
resp.synthesis_task.lexicon_names[0] #=> String
resp.synthesis_task.output_format #=> String, one of "json", "mp3", "ogg_vorbis", "pcm"
resp.synthesis_task.sample_rate #=> String
resp.synthesis_task.speech_mark_types #=> Array
resp.synthesis_task.speech_mark_types[0] #=> String, one of "sentence", "ssml", "viseme", "word"
resp.synthesis_task.text_type #=> String, one of "ssml", "text"
resp.synthesis_task.voice_id #=> String, one of "Geraint", "Gwyneth", "Mads", "Naja", "Hans", "Marlene", "Nicole", "Russell", "Amy", "Brian", "Emma", "Raveena", "Ivy", "Joanna", "Joey", "Justin", "Kendra", "Kimberly", "Matthew", "Salli", "Conchita", "Enrique", "Miguel", "Penelope", "Chantal", "Celine", "Lea", "Mathieu", "Dora", "Karl", "Carla", "Giorgio", "Mizuki", "Liv", "Lotte", "Ruben", "Ewa", "Jacek", "Jan", "Maja", "Ricardo", "Vitoria", "Cristiano", "Ines", "Carmen", "Maxim", "Tatyana", "Astrid", "Filiz", "Vicki", "Takumi", "Seoyeon", "Aditi", "Zhiyu", "Bianca", "Lucia", "Mia"
resp.synthesis_task.language_code #=> String, one of "cmn-CN", "cy-GB", "da-DK", "de-DE", "en-AU", "en-GB", "en-GB-WLS", "en-IN", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "is-IS", "it-IT", "ja-JP", "hi-IN", "ko-KR", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "ru-RU", "sv-SE", "tr-TR"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :task_id (required, String) —

    The Amazon Polly generated identifier for a speech synthesis task.

Returns:

See Also:



470
471
472
473
 
# File 'lib/aws-sdk-polly/client.rb', line 470

def get_speech_synthesis_task(params = {}, options = {})
  req = build_request(:get_speech_synthesis_task, params)
  req.send_request(options)
end

#list_lexicons(params = {}) ⇒ Types::ListLexiconsOutput

Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see [Managing Lexicons].

[1]: docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html

Examples:

Example: To list all lexicons in a region


# Returns a list of pronunciation lexicons stored in an AWS Region.

resp = client.list_lexicons({
})

resp.to_h outputs the following:
{
  lexicons: [
    {
      attributes: {
        alphabet: "ipa", 
        language_code: "en-US", 
        last_modified: Time.parse(1478542980.117), 
        lexemes_count: 1, 
        lexicon_arn: "arn:aws:polly:us-east-1:123456789012:lexicon/example", 
        size: 503, 
      }, 
      name: "example", 
    }, 
  ], 
}

Request syntax with placeholder values


resp = client.list_lexicons({
  next_token: "NextToken",
})

Response structure


resp.lexicons #=> Array
resp.lexicons[0].name #=> String
resp.lexicons[0].attributes.alphabet #=> String
resp.lexicons[0].attributes.language_code #=> String, one of "cmn-CN", "cy-GB", "da-DK", "de-DE", "en-AU", "en-GB", "en-GB-WLS", "en-IN", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "is-IS", "it-IT", "ja-JP", "hi-IN", "ko-KR", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "ru-RU", "sv-SE", "tr-TR"
resp.lexicons[0].attributes.last_modified #=> Time
resp.lexicons[0].attributes.lexicon_arn #=> String
resp.lexicons[0].attributes.lexemes_count #=> Integer
resp.lexicons[0].attributes.size #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    An opaque pagination token returned from previous ‘ListLexicons` operation. If present, indicates where to continue the list of lexicons.

Returns:

See Also:



539
540
541
542
 
# File 'lib/aws-sdk-polly/client.rb', line 539

def list_lexicons(params = {}, options = {})
  req = build_request(:list_lexicons, params)
  req.send_request(options)
end

#list_speech_synthesis_tasks(params = {}) ⇒ Types::ListSpeechSynthesisTasksOutput

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.

Examples:

Request syntax with placeholder values


resp = client.list_speech_synthesis_tasks({
  max_results: 1,
  next_token: "NextToken",
  status: "scheduled", # accepts scheduled, inProgress, completed, failed
})

Response structure


resp.next_token #=> String
resp.synthesis_tasks #=> Array
resp.synthesis_tasks[0].task_id #=> String
resp.synthesis_tasks[0].task_status #=> String, one of "scheduled", "inProgress", "completed", "failed"
resp.synthesis_tasks[0].task_status_reason #=> String
resp.synthesis_tasks[0].output_uri #=> String
resp.synthesis_tasks[0].creation_time #=> Time
resp.synthesis_tasks[0].request_characters #=> Integer
resp.synthesis_tasks[0].sns_topic_arn #=> String
resp.synthesis_tasks[0].lexicon_names #=> Array
resp.synthesis_tasks[0].lexicon_names[0] #=> String
resp.synthesis_tasks[0].output_format #=> String, one of "json", "mp3", "ogg_vorbis", "pcm"
resp.synthesis_tasks[0].sample_rate #=> String
resp.synthesis_tasks[0].speech_mark_types #=> Array
resp.synthesis_tasks[0].speech_mark_types[0] #=> String, one of "sentence", "ssml", "viseme", "word"
resp.synthesis_tasks[0].text_type #=> String, one of "ssml", "text"
resp.synthesis_tasks[0].voice_id #=> String, one of "Geraint", "Gwyneth", "Mads", "Naja", "Hans", "Marlene", "Nicole", "Russell", "Amy", "Brian", "Emma", "Raveena", "Ivy", "Joanna", "Joey", "Justin", "Kendra", "Kimberly", "Matthew", "Salli", "Conchita", "Enrique", "Miguel", "Penelope", "Chantal", "Celine", "Lea", "Mathieu", "Dora", "Karl", "Carla", "Giorgio", "Mizuki", "Liv", "Lotte", "Ruben", "Ewa", "Jacek", "Jan", "Maja", "Ricardo", "Vitoria", "Cristiano", "Ines", "Carmen", "Maxim", "Tatyana", "Astrid", "Filiz", "Vicki", "Takumi", "Seoyeon", "Aditi", "Zhiyu", "Bianca", "Lucia", "Mia"
resp.synthesis_tasks[0].language_code #=> String, one of "cmn-CN", "cy-GB", "da-DK", "de-DE", "en-AU", "en-GB", "en-GB-WLS", "en-IN", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "is-IS", "it-IT", "ja-JP", "hi-IN", "ko-KR", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "ru-RU", "sv-SE", "tr-TR"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Maximum number of speech synthesis tasks returned in a List operation.

  • :next_token (String) —

    The pagination token to use in the next request to continue the listing of speech synthesis tasks.

  • :status (String) —

    Status of the speech synthesis tasks returned in a List operation

Returns:

See Also:



596
597
598
599
 
# File 'lib/aws-sdk-polly/client.rb', line 596

def list_speech_synthesis_tasks(params = {}, options = {})
  req = build_request(:list_speech_synthesis_tasks, params)
  req.send_request(options)
end

#put_lexicon(params = {}) ⇒ Struct

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

[1]: docs.aws.amazon.com/polly/latest/dg/managing-lexicons.html

Examples:

Example: To save a lexicon


# Stores a pronunciation lexicon in an AWS Region.

resp = client.put_lexicon({
  content: "file://example.pls", 
  name: "W3C", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.put_lexicon({
  name: "LexiconName", # required
  content: "LexiconContent", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    Name of the lexicon. The name must follow the regular express format [0-9A-Za-z]{1,20\}. That is, the name is a case-sensitive alphanumeric string up to 20 characters long.

  • :content (required, String) —

    Content of the PLS lexicon as string data.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



648
649
650
651
 
# File 'lib/aws-sdk-polly/client.rb', line 648

def put_lexicon(params = {}, options = {})
  req = build_request(:put_lexicon, params)
  req.send_request(options)
end

#start_speech_synthesis_task(params = {}) ⇒ Types::StartSpeechSynthesisTaskOutput

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.

Examples:

Request syntax with placeholder values


resp = client.start_speech_synthesis_task({
  lexicon_names: ["LexiconName"],
  output_format: "json", # required, accepts json, mp3, ogg_vorbis, pcm
  output_s3_bucket_name: "OutputS3BucketName", # required
  output_s3_key_prefix: "OutputS3KeyPrefix",
  sample_rate: "SampleRate",
  sns_topic_arn: "SnsTopicArn",
  speech_mark_types: ["sentence"], # accepts sentence, ssml, viseme, word
  text: "Text", # required
  text_type: "ssml", # accepts ssml, text
  voice_id: "Geraint", # required, accepts Geraint, Gwyneth, Mads, Naja, Hans, Marlene, Nicole, Russell, Amy, Brian, Emma, Raveena, Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Matthew, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Lea, Mathieu, Dora, Karl, Carla, Giorgio, Mizuki, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz, Vicki, Takumi, Seoyeon, Aditi, Zhiyu, Bianca, Lucia, Mia
  language_code: "cmn-CN", # accepts cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR
})

Response structure


resp.synthesis_task.task_id #=> String
resp.synthesis_task.task_status #=> String, one of "scheduled", "inProgress", "completed", "failed"
resp.synthesis_task.task_status_reason #=> String
resp.synthesis_task.output_uri #=> String
resp.synthesis_task.creation_time #=> Time
resp.synthesis_task.request_characters #=> Integer
resp.synthesis_task.sns_topic_arn #=> String
resp.synthesis_task.lexicon_names #=> Array
resp.synthesis_task.lexicon_names[0] #=> String
resp.synthesis_task.output_format #=> String, one of "json", "mp3", "ogg_vorbis", "pcm"
resp.synthesis_task.sample_rate #=> String
resp.synthesis_task.speech_mark_types #=> Array
resp.synthesis_task.speech_mark_types[0] #=> String, one of "sentence", "ssml", "viseme", "word"
resp.synthesis_task.text_type #=> String, one of "ssml", "text"
resp.synthesis_task.voice_id #=> String, one of "Geraint", "Gwyneth", "Mads", "Naja", "Hans", "Marlene", "Nicole", "Russell", "Amy", "Brian", "Emma", "Raveena", "Ivy", "Joanna", "Joey", "Justin", "Kendra", "Kimberly", "Matthew", "Salli", "Conchita", "Enrique", "Miguel", "Penelope", "Chantal", "Celine", "Lea", "Mathieu", "Dora", "Karl", "Carla", "Giorgio", "Mizuki", "Liv", "Lotte", "Ruben", "Ewa", "Jacek", "Jan", "Maja", "Ricardo", "Vitoria", "Cristiano", "Ines", "Carmen", "Maxim", "Tatyana", "Astrid", "Filiz", "Vicki", "Takumi", "Seoyeon", "Aditi", "Zhiyu", "Bianca", "Lucia", "Mia"
resp.synthesis_task.language_code #=> String, one of "cmn-CN", "cy-GB", "da-DK", "de-DE", "en-AU", "en-GB", "en-GB-WLS", "en-IN", "en-US", "es-ES", "es-MX", "es-US", "fr-CA", "fr-FR", "is-IS", "it-IT", "ja-JP", "hi-IN", "ko-KR", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "ru-RU", "sv-SE", "tr-TR"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :lexicon_names (Array<String>) —

    List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

  • :output_format (required, String) —

    The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

  • :output_s3_bucket_name (required, String) —

    Amazon S3 bucket name to which the output file will be saved.

  • :output_s3_key_prefix (String) —

    The Amazon S3 key prefix for the output speech file.

  • :sample_rate (String) —

    The audio frequency specified in Hz.

    The valid values for mp3 and ogg_vorbis are “8000”, “16000”, and “22050”. The default value is “22050”.

    Valid values for pcm are “8000” and “16000” The default value is “16000”.

  • :sns_topic_arn (String) —

    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

  • :speech_mark_types (Array<String>) —

    The type of speech marks returned for the input text.

  • :text (required, String) —

    The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

  • :text_type (String) —

    Specifies whether the input text is plain text or SSML. The default value is plain text.

  • :voice_id (required, String) —

    Voice ID to use for the synthesis.

  • :language_code (String) —

    Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

    If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. The default language for any voice is the one returned by the

    DescribeVoices][1

    operation for the ‘LanguageCode` parameter. For

    example, if no language code is specified, Aditi will use Indian English rather than Hindi.

    [1]: docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html

Returns:

See Also:



764
765
766
767
 
# File 'lib/aws-sdk-polly/client.rb', line 764

def start_speech_synthesis_task(params = {}, options = {})
  req = build_request(:start_speech_synthesis_task, params)
  req.send_request(options)
end

#synthesize_speech(params = {}) ⇒ Types::SynthesizeSpeechOutput

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

[1]: docs.aws.amazon.com/polly/latest/dg/how-text-to-speech-works.html

Examples:

Example: To synthesize speech


# Synthesizes plain text or SSML into a file of human-like speech.

resp = client.synthesize_speech({
  lexicon_names: [
    "example", 
  ], 
  output_format: "mp3", 
  sample_rate: "8000", 
  text: "All Gaul is divided into three parts", 
  text_type: "text", 
  voice_id: "Joanna", 
})

resp.to_h outputs the following:
{
  audio_stream: "TEXT", 
  content_type: "audio/mpeg", 
  request_characters: 37, 
}

Request syntax with placeholder values


resp = client.synthesize_speech({
  lexicon_names: ["LexiconName"],
  output_format: "json", # required, accepts json, mp3, ogg_vorbis, pcm
  sample_rate: "SampleRate",
  speech_mark_types: ["sentence"], # accepts sentence, ssml, viseme, word
  text: "Text", # required
  text_type: "ssml", # accepts ssml, text
  voice_id: "Geraint", # required, accepts Geraint, Gwyneth, Mads, Naja, Hans, Marlene, Nicole, Russell, Amy, Brian, Emma, Raveena, Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Matthew, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Lea, Mathieu, Dora, Karl, Carla, Giorgio, Mizuki, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz, Vicki, Takumi, Seoyeon, Aditi, Zhiyu, Bianca, Lucia, Mia
  language_code: "cmn-CN", # accepts cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR
})

Response structure


resp.audio_stream #=> IO
resp.content_type #=> String
resp.request_characters #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :lexicon_names (Array<String>) —

    List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see [PutLexicon].

    [1]: docs.aws.amazon.com/polly/latest/dg/API_PutLexicon.html

  • :output_format (required, String) —

    The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

    When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

  • :sample_rate (String) —

    The audio frequency specified in Hz.

    The valid values for ‘mp3` and `ogg_vorbis` are “8000”, “16000”, and “22050”. The default value is “22050”.

    Valid values for ‘pcm` are “8000” and “16000” The default value is “16000”.

  • :speech_mark_types (Array<String>) —

    The type of speech marks returned for the input text.

  • :text (required, String) —

    Input text to synthesize. If you specify ‘ssml` as the `TextType`, follow the SSML format for the input text.

  • :text_type (String) —

    Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see [Using SSML].

    [1]: docs.aws.amazon.com/polly/latest/dg/ssml.html

  • :voice_id (required, String) —

    Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the [DescribeVoices] operation.

    [1]: docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html

  • :language_code (String) —

    Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

    If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. The default language for any voice is the one returned by the

    DescribeVoices][1

    operation for the ‘LanguageCode` parameter. For

    example, if no language code is specified, Aditi will use Indian English rather than Hindi.

    [1]: docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html

Returns:

See Also:



897
898
899
900
 
# File 'lib/aws-sdk-polly/client.rb', line 897

def synthesize_speech(params = {}, options = {}, &block)
  req = build_request(:synthesize_speech, params)
  req.send_request(options, &block)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


921
922
923
 
# File 'lib/aws-sdk-polly/client.rb', line 921

def waiter_names
  []
end