Class: Aws::Polly::Client

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

Overview

An API client for Polly. To construct a client, you need to configure a :region and :credentials.

client = Aws::Polly::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

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

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

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

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

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

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

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

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

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

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :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 searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_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.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :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_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :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.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. Takes effect only when disable_clock_skew_correction is not set.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
    'https://example.com'
    'http://example.com:123'
    
  • :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.

  • :event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :input_event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it can be used for sending events for the event stream.

  • :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.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes. Defaults to 3, except for DynamoDB and DynamoDB Streams, which default to 4.

  • :output_event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.

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

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

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

    @see https://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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "standard" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make. This is the default value if no retry mode is provided.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::Polly::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Polly::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



490
491
492
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 490

def initialize(*args)
  super
end

Instance Method Details

#create_voice(params = {}) ⇒ Types::CreateVoiceOutput

Creates a custom voice from recordings of a speaker and returns it in pending status. Use GetVoice to check the status. When the status is active, you can use the voice ID in SynthesizeSpeech, StartSpeechSynthesisTask, and StartSpeechSynthesisStream.

The custom-voice-max-count service quota limits the number of custom voices in your account in each Region. If you reach the quota, the request fails with ServiceQuotaExceededException.

This operation requires permissions to perform the polly:CreateVoice action. You also need s3:GetObject permission on each recording that you specify by S3Url. If you specify a customer managed key, you also need kms:DescribeKey, kms:GenerateDataKey, and kms:Decrypt permissions on the key. If you specify Tags, you also need the polly:TagResource permission.

Examples:

Request syntax with placeholder values


resp = client.create_voice({
  name: "CustomVoiceName", # required
  language_code: "de-DE", # required, accepts de-DE, en-US, es-US, fr-FR, hi-IN, it-IT, pt-BR
  terms_accepted: false, # required
  voice_creation_data: { # required
    recordings: [ # required
      {
        format: "wav", # required, accepts wav, flac, ogg_vorbis, mp3
        data: { # required
          s3_url: "S3Url",
          bytes: "data",
        },
      },
    ],
  },
  customer_managed_encryption: {
    kms_key_arn: "KmsKeyArn", # required
    encryption_context: {
      "EncryptionContextKey" => "EncryptionContextValue",
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken",
})

Response structure


resp.voice.arn #=> String
resp.voice.gender #=> String, one of "Female", "Male"
resp.voice.id #=> String, one of "Aditi", "Amy", "Astrid", "Bianca", "Brian", "Camila", "Carla", "Carmen", "Celine", "Chantal", "Conchita", "Cristiano", "Dora", "Emma", "Enrique", "Ewa", "Filiz", "Gabrielle", "Geraint", "Giorgio", "Gwyneth", "Hans", "Ines", "Ivy", "Jacek", "Jan", "Joanna", "Joey", "Justin", "Karl", "Kendra", "Kevin", "Kimberly", "Lea", "Liv", "Lotte", "Lucia", "Lupe", "Mads", "Maja", "Marlene", "Mathieu", "Matthew", "Maxim", "Mia", "Miguel", "Mizuki", "Naja", "Nicole", "Olivia", "Penelope", "Raveena", "Ricardo", "Ruben", "Russell", "Salli", "Seoyeon", "Takumi", "Tatyana", "Vicki", "Vitoria", "Zeina", "Zhiyu", "Aria", "Ayanda", "Arlet", "Hannah", "Arthur", "Daniel", "Liam", "Pedro", "Kajal", "Hiujin", "Laura", "Elin", "Ida", "Suvi", "Ola", "Hala", "Andres", "Sergio", "Remi", "Adriano", "Thiago", "Ruth", "Stephen", "Kazuha", "Tomoko", "Niamh", "Sofie", "Lisa", "Isabelle", "Zayd", "Danielle", "Gregory", "Burcu", "Jitka", "Sabrina", "Jasmine", "Jihye", "Ambre", "Beatrice", "Florian", "Lennart", "Lorenzo", "Tiffany", "Arjun", "Carlos", "Carolina", "Curtis", "Hyunduk", "Kenneth", "Kiara", "Leo", "Nate", "Tina"
resp.voice.language_code #=> String, one of "arb", "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", "en-NZ", "en-ZA", "ca-ES", "de-AT", "yue-CN", "ar-AE", "fi-FI", "en-IE", "nl-BE", "fr-BE", "cs-CZ", "de-CH", "en-SG"
resp.voice.language_name #=> String
resp.voice.name #=> String
resp.voice.origin #=> String, one of "aws", "customer"
resp.voice.status #=> String, one of "pending", "active", "failed"
resp.voice.status_reason #=> String
resp.voice.additional_language_codes #=> Array
resp.voice.additional_language_codes[0] #=> String, one of "arb", "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", "en-NZ", "en-ZA", "ca-ES", "de-AT", "yue-CN", "ar-AE", "fi-FI", "en-IE", "nl-BE", "fr-BE", "cs-CZ", "de-CH", "en-SG"
resp.voice.supported_engines #=> Array
resp.voice.supported_engines[0] #=> String, one of "standard", "neural", "long-form", "generative"
resp.voice.voice_creation_data.recordings #=> Array
resp.voice.voice_creation_data.recordings[0].format #=> String, one of "wav", "flac", "ogg_vorbis", "mp3"
resp.voice.voice_creation_data.recordings[0].data.s3_url #=> String
resp.voice.voice_creation_data.recordings[0].data.bytes #=> String
resp.voice.customer_managed_encryption.kms_key_arn #=> String
resp.voice.customer_managed_encryption.encryption_context #=> Hash
resp.voice.customer_managed_encryption.encryption_context["EncryptionContextKey"] #=> String
resp.voice.creation_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :language_code (required, String) —

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

  • :terms_accepted (required, Boolean) —

    Confirms the following two statements:

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

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

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

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

  • :voice_creation_data (required, Types::VoiceCreationData) —

    The recordings that Amazon Polly uses to create the voice.

  • :customer_managed_encryption (Types::CustomerManagedEncryption) —

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

  • :tags (Hash<String,String>) —

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

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

See Also:



635
636
637
638
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 635

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

#delete_lexicon(params = {}) ⇒ Struct

Deletes the specified pronunciation lexicon stored in an Amazon Web Services 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.

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:



680
681
682
683
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 680

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

#delete_voice(params = {}) ⇒ Struct

Deletes a custom voice. DescribeVoices and GetVoice stop returning the voice immediately. You can't restore a deleted voice.

You can delete a voice in active or failed status. If the voice is in pending status, the request fails with ConflictException. If no custom voice with the specified ID exists in your account and Region, the request fails with ResourceNotFoundException. You can delete the voice even if you disabled its Amazon Web Services KMS key or scheduled it for deletion.

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

Examples:

Request syntax with placeholder values


resp = client.delete_voice({
  voice_id: "CustomVoiceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :voice_id (required, String) —

    The ID of the custom voice to delete, for example, vc-9a8fa85dd3. You can't specify the ARN of the voice.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



714
715
716
717
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 714

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

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

Returns the list of voices: the voices that Amazon Polly provides and the custom voices in your account. Each voice speaks a specified language and is identified by an ID. A voice that Amazon Polly provides is either male or female, and its ID 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, your news reader application reads news in a specific language, and you want to give users the option to choose the voice. With the DescribeVoices operation, you can provide a list of available voices for users to choose 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.

The list includes custom voices in every status. For each voice, Origin indicates whether Amazon Polly provides the voice or you created it. You can use a custom voice for synthesis only when its status is active. A voice in failed status stays in the list until you delete it.

For a custom voice, DescribeVoices returns Origin, Id, Name, Status, LanguageCode, LanguageName, SupportedEngines, and CreationTime. To get Arn, StatusReason, VoiceCreationData, and CustomerManagedEncryption, use GetVoice.

The LanguageCode and Engine filters apply to custom voices in the same way as to voices that Amazon Polly provides.

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({
  engine: "standard", # accepts standard, neural, long-form, generative
  language_code: "arb", # accepts arb, 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, en-NZ, en-ZA, ca-ES, de-AT, yue-CN, ar-AE, fi-FI, en-IE, nl-BE, fr-BE, cs-CZ, de-CH, en-SG
  include_additional_language_codes: false,
  next_token: "NextToken",
})

Response structure


resp.voices #=> Array
resp.voices[0].arn #=> String
resp.voices[0].gender #=> String, one of "Female", "Male"
resp.voices[0].id #=> String, one of "Aditi", "Amy", "Astrid", "Bianca", "Brian", "Camila", "Carla", "Carmen", "Celine", "Chantal", "Conchita", "Cristiano", "Dora", "Emma", "Enrique", "Ewa", "Filiz", "Gabrielle", "Geraint", "Giorgio", "Gwyneth", "Hans", "Ines", "Ivy", "Jacek", "Jan", "Joanna", "Joey", "Justin", "Karl", "Kendra", "Kevin", "Kimberly", "Lea", "Liv", "Lotte", "Lucia", "Lupe", "Mads", "Maja", "Marlene", "Mathieu", "Matthew", "Maxim", "Mia", "Miguel", "Mizuki", "Naja", "Nicole", "Olivia", "Penelope", "Raveena", "Ricardo", "Ruben", "Russell", "Salli", "Seoyeon", "Takumi", "Tatyana", "Vicki", "Vitoria", "Zeina", "Zhiyu", "Aria", "Ayanda", "Arlet", "Hannah", "Arthur", "Daniel", "Liam", "Pedro", "Kajal", "Hiujin", "Laura", "Elin", "Ida", "Suvi", "Ola", "Hala", "Andres", "Sergio", "Remi", "Adriano", "Thiago", "Ruth", "Stephen", "Kazuha", "Tomoko", "Niamh", "Sofie", "Lisa", "Isabelle", "Zayd", "Danielle", "Gregory", "Burcu", "Jitka", "Sabrina", "Jasmine", "Jihye", "Ambre", "Beatrice", "Florian", "Lennart", "Lorenzo", "Tiffany", "Arjun", "Carlos", "Carolina", "Curtis", "Hyunduk", "Kenneth", "Kiara", "Leo", "Nate", "Tina"
resp.voices[0].language_code #=> String, one of "arb", "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", "en-NZ", "en-ZA", "ca-ES", "de-AT", "yue-CN", "ar-AE", "fi-FI", "en-IE", "nl-BE", "fr-BE", "cs-CZ", "de-CH", "en-SG"
resp.voices[0].language_name #=> String
resp.voices[0].name #=> String
resp.voices[0].origin #=> String, one of "aws", "customer"
resp.voices[0].status #=> String, one of "pending", "active", "failed"
resp.voices[0].status_reason #=> String
resp.voices[0].additional_language_codes #=> Array
resp.voices[0].additional_language_codes[0] #=> String, one of "arb", "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", "en-NZ", "en-ZA", "ca-ES", "de-AT", "yue-CN", "ar-AE", "fi-FI", "en-IE", "nl-BE", "fr-BE", "cs-CZ", "de-CH", "en-SG"
resp.voices[0].supported_engines #=> Array
resp.voices[0].supported_engines[0] #=> String, one of "standard", "neural", "long-form", "generative"
resp.voices[0].voice_creation_data.recordings #=> Array
resp.voices[0].voice_creation_data.recordings[0].format #=> String, one of "wav", "flac", "ogg_vorbis", "mp3"
resp.voices[0].voice_creation_data.recordings[0].data.s3_url #=> String
resp.voices[0].voice_creation_data.recordings[0].data.bytes #=> String
resp.voices[0].customer_managed_encryption.kms_key_arn #=> String
resp.voices[0].customer_managed_encryption.encryption_context #=> Hash
resp.voices[0].customer_managed_encryption.encryption_context["EncryptionContextKey"] #=> String
resp.voices[0].creation_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :engine (String) —

    Specifies the engine (standard, neural, long-form or generative) used by Amazon Polly when processing input text for speech synthesis.

  • :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:



859
860
861
862
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 859

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 Amazon Web Services Region. For more information, see Managing Lexicons.

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 "arb", "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", "en-NZ", "en-ZA", "ca-ES", "de-AT", "yue-CN", "ar-AE", "fi-FI", "en-IE", "nl-BE", "fr-BE", "cs-CZ", "de-CH", "en-SG"
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:



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

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.engine #=> String, one of "standard", "neural", "long-form", "generative"
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_opus", "ogg_vorbis", "pcm", "mulaw", "alaw"
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 "Aditi", "Amy", "Astrid", "Bianca", "Brian", "Camila", "Carla", "Carmen", "Celine", "Chantal", "Conchita", "Cristiano", "Dora", "Emma", "Enrique", "Ewa", "Filiz", "Gabrielle", "Geraint", "Giorgio", "Gwyneth", "Hans", "Ines", "Ivy", "Jacek", "Jan", "Joanna", "Joey", "Justin", "Karl", "Kendra", "Kevin", "Kimberly", "Lea", "Liv", "Lotte", "Lucia", "Lupe", "Mads", "Maja", "Marlene", "Mathieu", "Matthew", "Maxim", "Mia", "Miguel", "Mizuki", "Naja", "Nicole", "Olivia", "Penelope", "Raveena", "Ricardo", "Ruben", "Russell", "Salli", "Seoyeon", "Takumi", "Tatyana", "Vicki", "Vitoria", "Zeina", "Zhiyu", "Aria", "Ayanda", "Arlet", "Hannah", "Arthur", "Daniel", "Liam", "Pedro", "Kajal", "Hiujin", "Laura", "Elin", "Ida", "Suvi", "Ola", "Hala", "Andres", "Sergio", "Remi", "Adriano", "Thiago", "Ruth", "Stephen", "Kazuha", "Tomoko", "Niamh", "Sofie", "Lisa", "Isabelle", "Zayd", "Danielle", "Gregory", "Burcu", "Jitka", "Sabrina", "Jasmine", "Jihye", "Ambre", "Beatrice", "Florian", "Lennart", "Lorenzo", "Tiffany", "Arjun", "Carlos", "Carolina", "Curtis", "Hyunduk", "Kenneth", "Kiara", "Leo", "Nate", "Tina"
resp.synthesis_task.language_code #=> String, one of "arb", "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", "en-NZ", "en-ZA", "ca-ES", "de-AT", "yue-CN", "ar-AE", "fi-FI", "en-IE", "nl-BE", "fr-BE", "cs-CZ", "de-CH", "en-SG"

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:



973
974
975
976
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 973

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

#get_voice(params = {}) ⇒ Types::GetVoiceOutput

Returns the status and properties of a custom voice. Use this operation after CreateVoice to check whether the status of the voice is active or failed. Unlike DescribeVoices, GetVoice also returns Arn, VoiceCreationData, CustomerManagedEncryption, and StatusReason. If no custom voice with the specified ID exists in your account and Region, the request fails with ResourceNotFoundException.

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

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • voice_active

Examples:

Request syntax with placeholder values


resp = client.get_voice({
  voice_id: "CustomVoiceId", # required
})

Response structure


resp.voice.arn #=> String
resp.voice.gender #=> String, one of "Female", "Male"
resp.voice.id #=> String, one of "Aditi", "Amy", "Astrid", "Bianca", "Brian", "Camila", "Carla", "Carmen", "Celine", "Chantal", "Conchita", "Cristiano", "Dora", "Emma", "Enrique", "Ewa", "Filiz", "Gabrielle", "Geraint", "Giorgio", "Gwyneth", "Hans", "Ines", "Ivy", "Jacek", "Jan", "Joanna", "Joey", "Justin", "Karl", "Kendra", "Kevin", "Kimberly", "Lea", "Liv", "Lotte", "Lucia", "Lupe", "Mads", "Maja", "Marlene", "Mathieu", "Matthew", "Maxim", "Mia", "Miguel", "Mizuki", "Naja", "Nicole", "Olivia", "Penelope", "Raveena", "Ricardo", "Ruben", "Russell", "Salli", "Seoyeon", "Takumi", "Tatyana", "Vicki", "Vitoria", "Zeina", "Zhiyu", "Aria", "Ayanda", "Arlet", "Hannah", "Arthur", "Daniel", "Liam", "Pedro", "Kajal", "Hiujin", "Laura", "Elin", "Ida", "Suvi", "Ola", "Hala", "Andres", "Sergio", "Remi", "Adriano", "Thiago", "Ruth", "Stephen", "Kazuha", "Tomoko", "Niamh", "Sofie", "Lisa", "Isabelle", "Zayd", "Danielle", "Gregory", "Burcu", "Jitka", "Sabrina", "Jasmine", "Jihye", "Ambre", "Beatrice", "Florian", "Lennart", "Lorenzo", "Tiffany", "Arjun", "Carlos", "Carolina", "Curtis", "Hyunduk", "Kenneth", "Kiara", "Leo", "Nate", "Tina"
resp.voice.language_code #=> String, one of "arb", "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", "en-NZ", "en-ZA", "ca-ES", "de-AT", "yue-CN", "ar-AE", "fi-FI", "en-IE", "nl-BE", "fr-BE", "cs-CZ", "de-CH", "en-SG"
resp.voice.language_name #=> String
resp.voice.name #=> String
resp.voice.origin #=> String, one of "aws", "customer"
resp.voice.status #=> String, one of "pending", "active", "failed"
resp.voice.status_reason #=> String
resp.voice.additional_language_codes #=> Array
resp.voice.additional_language_codes[0] #=> String, one of "arb", "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", "en-NZ", "en-ZA", "ca-ES", "de-AT", "yue-CN", "ar-AE", "fi-FI", "en-IE", "nl-BE", "fr-BE", "cs-CZ", "de-CH", "en-SG"
resp.voice.supported_engines #=> Array
resp.voice.supported_engines[0] #=> String, one of "standard", "neural", "long-form", "generative"
resp.voice.voice_creation_data.recordings #=> Array
resp.voice.voice_creation_data.recordings[0].format #=> String, one of "wav", "flac", "ogg_vorbis", "mp3"
resp.voice.voice_creation_data.recordings[0].data.s3_url #=> String
resp.voice.voice_creation_data.recordings[0].data.bytes #=> String
resp.voice.customer_managed_encryption.kms_key_arn #=> String
resp.voice.customer_managed_encryption.encryption_context #=> Hash
resp.voice.customer_managed_encryption.encryption_context["EncryptionContextKey"] #=> String
resp.voice.creation_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :voice_id (required, String) —

    The ID of the custom voice that CreateVoice returned, for example, vc-9a8fa85dd3. You can't specify the ARN of the voice.

Returns:

See Also:



1036
1037
1038
1039
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 1036

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

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

Returns a list of pronunciation lexicons stored in an Amazon Web Services Region. For more information, see Managing Lexicons.

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 "arb", "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", "en-NZ", "en-ZA", "ca-ES", "de-AT", "yue-CN", "ar-AE", "fi-FI", "en-IE", "nl-BE", "fr-BE", "cs-CZ", "de-CH", "en-SG"
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:



1105
1106
1107
1108
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 1105

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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].engine #=> String, one of "standard", "neural", "long-form", "generative"
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_opus", "ogg_vorbis", "pcm", "mulaw", "alaw"
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 "Aditi", "Amy", "Astrid", "Bianca", "Brian", "Camila", "Carla", "Carmen", "Celine", "Chantal", "Conchita", "Cristiano", "Dora", "Emma", "Enrique", "Ewa", "Filiz", "Gabrielle", "Geraint", "Giorgio", "Gwyneth", "Hans", "Ines", "Ivy", "Jacek", "Jan", "Joanna", "Joey", "Justin", "Karl", "Kendra", "Kevin", "Kimberly", "Lea", "Liv", "Lotte", "Lucia", "Lupe", "Mads", "Maja", "Marlene", "Mathieu", "Matthew", "Maxim", "Mia", "Miguel", "Mizuki", "Naja", "Nicole", "Olivia", "Penelope", "Raveena", "Ricardo", "Ruben", "Russell", "Salli", "Seoyeon", "Takumi", "Tatyana", "Vicki", "Vitoria", "Zeina", "Zhiyu", "Aria", "Ayanda", "Arlet", "Hannah", "Arthur", "Daniel", "Liam", "Pedro", "Kajal", "Hiujin", "Laura", "Elin", "Ida", "Suvi", "Ola", "Hala", "Andres", "Sergio", "Remi", "Adriano", "Thiago", "Ruth", "Stephen", "Kazuha", "Tomoko", "Niamh", "Sofie", "Lisa", "Isabelle", "Zayd", "Danielle", "Gregory", "Burcu", "Jitka", "Sabrina", "Jasmine", "Jihye", "Ambre", "Beatrice", "Florian", "Lennart", "Lorenzo", "Tiffany", "Arjun", "Carlos", "Carolina", "Curtis", "Hyunduk", "Kenneth", "Kiara", "Leo", "Nate", "Tina"
resp.synthesis_tasks[0].language_code #=> String, one of "arb", "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", "en-NZ", "en-ZA", "ca-ES", "de-AT", "yue-CN", "ar-AE", "fi-FI", "en-IE", "nl-BE", "fr-BE", "cs-CZ", "de-CH", "en-SG"

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:



1165
1166
1167
1168
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 1165

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

Lists the tags for an Amazon Polly resource.

Examples:

Example: To list the tags on a lexicon


# The following example lists the tags associated with a pronunciation lexicon.

resp = client.list_tags_for_resource({
  resource_arn: "arn:aws:polly:us-east-1:111122223333:lexicon/example", 
})

resp.to_h outputs the following:
{
  tags: {
    "Environment" => "Production", 
    "Project" => "Narration", 
  }, 
}

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to list the tags for. You can tag Amazon Polly lexicons and custom voices.

Returns:

See Also:



1212
1213
1214
1215
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 1212

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

#put_lexicon(params = {}) ⇒ Struct

Stores a pronunciation lexicon in an Amazon Web Services 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.

Overwriting a lexicon keeps its existing tags. You can specify tags only when you create a lexicon. If you specify tags for a lexicon that already exists, the request fails with a ValidationException. To change the tags of an existing lexicon, use TagResource and UntagResource.

For more information, see Managing Lexicons.

Examples:

Example: To save a lexicon


# Stores a pronunciation lexicon in an AWS Region.

resp = client.put_lexicon({
  content: "<Lexicon Content>", 
  name: "W3C", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    Name of the lexicon. The name must follow the regular expression 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.

  • :tags (Hash<String,String>) —

    The metadata that you apply to the lexicon to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. You can't replace the tags of an existing lexicon by overwriting it with PutLexicon.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1281
1282
1283
1284
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 1281

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

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

Starts an asynchronous synthesis task by creating 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). After Amazon Polly creates the synthesis task, the operation returns a SpeechSynthesisTask object that includes an identifier for the task and its current status. The SpeechSynthesisTask object is available for 72 hours after you start the asynchronous synthesis task.

To use a custom voice, specify its ID in VoiceId. The voice must be in active status. If the voice is in pending or failed status, the request fails with ConflictException. If no custom voice with the specified ID exists in your account and Region, the request fails with ResourceNotFoundException. If the custom voice uses a customer managed key, you need kms:Decrypt permission on the key. If you disable the key or schedule it for deletion before the task runs, the task fails and TaskStatusReason describes the cause.

Examples:

Request syntax with placeholder values


resp = client.start_speech_synthesis_task({
  engine: "standard", # accepts standard, neural, long-form, generative
  language_code: "arb", # accepts arb, 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, en-NZ, en-ZA, ca-ES, de-AT, yue-CN, ar-AE, fi-FI, en-IE, nl-BE, fr-BE, cs-CZ, de-CH, en-SG
  lexicon_names: ["LexiconName"],
  output_format: "json", # required, accepts json, mp3, ogg_opus, ogg_vorbis, pcm, mulaw, alaw
  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: "Aditi", # required, accepts Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal, Hiujin, Laura, Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth, Stephen, Kazuha, Tomoko, Niamh, Sofie, Lisa, Isabelle, Zayd, Danielle, Gregory, Burcu, Jitka, Sabrina, Jasmine, Jihye, Ambre, Beatrice, Florian, Lennart, Lorenzo, Tiffany, Arjun, Carlos, Carolina, Curtis, Hyunduk, Kenneth, Kiara, Leo, Nate, Tina
})

Response structure


resp.synthesis_task.engine #=> String, one of "standard", "neural", "long-form", "generative"
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_opus", "ogg_vorbis", "pcm", "mulaw", "alaw"
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 "Aditi", "Amy", "Astrid", "Bianca", "Brian", "Camila", "Carla", "Carmen", "Celine", "Chantal", "Conchita", "Cristiano", "Dora", "Emma", "Enrique", "Ewa", "Filiz", "Gabrielle", "Geraint", "Giorgio", "Gwyneth", "Hans", "Ines", "Ivy", "Jacek", "Jan", "Joanna", "Joey", "Justin", "Karl", "Kendra", "Kevin", "Kimberly", "Lea", "Liv", "Lotte", "Lucia", "Lupe", "Mads", "Maja", "Marlene", "Mathieu", "Matthew", "Maxim", "Mia", "Miguel", "Mizuki", "Naja", "Nicole", "Olivia", "Penelope", "Raveena", "Ricardo", "Ruben", "Russell", "Salli", "Seoyeon", "Takumi", "Tatyana", "Vicki", "Vitoria", "Zeina", "Zhiyu", "Aria", "Ayanda", "Arlet", "Hannah", "Arthur", "Daniel", "Liam", "Pedro", "Kajal", "Hiujin", "Laura", "Elin", "Ida", "Suvi", "Ola", "Hala", "Andres", "Sergio", "Remi", "Adriano", "Thiago", "Ruth", "Stephen", "Kazuha", "Tomoko", "Niamh", "Sofie", "Lisa", "Isabelle", "Zayd", "Danielle", "Gregory", "Burcu", "Jitka", "Sabrina", "Jasmine", "Jihye", "Ambre", "Beatrice", "Florian", "Lennart", "Lorenzo", "Tiffany", "Arjun", "Carlos", "Carolina", "Curtis", "Hyunduk", "Kenneth", "Kiara", "Leo", "Nate", "Tina"
resp.synthesis_task.language_code #=> String, one of "arb", "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", "en-NZ", "en-ZA", "ca-ES", "de-AT", "yue-CN", "ar-AE", "fi-FI", "en-IE", "nl-BE", "fr-BE", "cs-CZ", "de-CH", "en-SG"

Parameters:

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

    ({})

Options Hash (params):

  • :engine (String) —

    Specifies the engine (standard, neural, long-form or generative) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

  • :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 uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

  • :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, ogg_opus, mu-law, a-law, 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", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".

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

    Valid value for ogg_opus is "48000".

    Valid value for mu-law and a-law is "8000".

  • :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) —

    The voice ID to use for the synthesis. To use a custom voice, specify the voice ID that CreateVoice returned, for example, vc-9a8fa85dd3. You can't specify the ARN of a voice.

Returns:

See Also:



1424
1425
1426
1427
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 1424

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.

To use a custom voice, specify its ID in VoiceId. The voice must be in active status. If the voice is in pending or failed status, the request fails with ConflictException. If no custom voice with the specified ID exists in your account and Region, the request fails with ResourceNotFoundException.

If the custom voice uses a customer managed key, you need kms:Decrypt permission on the key. If you disabled the key or scheduled it for deletion, the request fails with ValidationException. If you don't have permission to use the key, the request fails with AccessDeniedException. If Amazon Web Services KMS throttles Amazon Polly's request to use the key, the request fails with ThrottlingException.

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({
  engine: "standard", # accepts standard, neural, long-form, generative
  language_code: "arb", # accepts arb, 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, en-NZ, en-ZA, ca-ES, de-AT, yue-CN, ar-AE, fi-FI, en-IE, nl-BE, fr-BE, cs-CZ, de-CH, en-SG
  lexicon_names: ["LexiconName"],
  output_format: "json", # required, accepts json, mp3, ogg_opus, ogg_vorbis, pcm, mulaw, alaw
  sample_rate: "SampleRate",
  speech_mark_types: ["sentence"], # accepts sentence, ssml, viseme, word
  text: "Text", # required
  text_type: "ssml", # accepts ssml, text
  voice_id: "Aditi", # required, accepts Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal, Hiujin, Laura, Elin, Ida, Suvi, Ola, Hala, Andres, Sergio, Remi, Adriano, Thiago, Ruth, Stephen, Kazuha, Tomoko, Niamh, Sofie, Lisa, Isabelle, Zayd, Danielle, Gregory, Burcu, Jitka, Sabrina, Jasmine, Jihye, Ambre, Beatrice, Florian, Lennart, Lorenzo, Tiffany, Arjun, Carlos, Carolina, Curtis, Hyunduk, Kenneth, Kiara, Leo, Nate, Tina
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :engine (String) —

    Specifies the engine (standard, neural, long-form, or generative) for Amazon Polly to use when processing input text for speech synthesis. Provide an engine that is supported by the voice you select. If you don't provide an engine, the standard engine is selected by default. If a chosen voice isn't supported by the standard engine, this will result in an error. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.

  • :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 uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

  • :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.

  • :output_format (required, String) —

    The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, ogg_opus, mu-law, a-law 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", "22050", "24000", "44100" and "48000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000". The default value for generative voices is "24000".

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

    Valid value for ogg_opus is "48000".

    Valid value for mu-law and a-law is "8000".

  • :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.

  • :voice_id (required, String) —

    The voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation. To use a custom voice, specify the voice ID that CreateVoice returned, for example, vc-9a8fa85dd3. You can't specify the ARN of a voice.

Returns:

See Also:



1595
1596
1597
1598
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 1595

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

#tag_resource(params = {}) ⇒ Struct

Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters. If you specify a tag key that already exists on the resource, the value in the request replaces the existing value.

Examples:

Example: To add tags to a lexicon


# The following example adds the specified tags to a pronunciation lexicon.

resp = client.tag_resource({
  resource_arn: "arn:aws:polly:us-east-1:111122223333:lexicon/example", 
  tags: {
    "Environment" => "Production", 
    "Project" => "Narration", 
  }, 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to add tags to. You can tag Amazon Polly lexicons and custom voices.

  • :tags (required, Hash<String,String>) —

    The tags to add to the resource, as key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1646
1647
1648
1649
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 1646

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

#untag_resource(params = {}) ⇒ Struct

Deletes specified tags from a resource.

Examples:

Example: To remove tags from a lexicon


# The following example removes the tags with the specified keys from a pronunciation lexicon.

resp = client.untag_resource({
  resource_arn: "arn:aws:polly:us-east-1:111122223333:lexicon/example", 
  tag_keys: [
    "Environment", 
  ], 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to remove tags from. You can tag Amazon Polly lexicons and custom voices.

  • :tag_keys (required, Array<String>) —

    The keys of the tags to be removed.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1689
1690
1691
1692
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 1689

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

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
voice_active #get_voice 15 480

Parameters:

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

    ({})

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

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



1804
1805
1806
1807
1808
# File 'gems/aws-sdk-polly/lib/aws-sdk-polly/client.rb', line 1804

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end