Class: Aws::Polly::AsyncClient

Inherits:

Seahorse::Client::AsyncBase

Object
Seahorse::Client::AsyncBase
Aws::Polly::AsyncClient

show all

Includes:: AsyncClientStubs

Defined in:: lib/aws-sdk-polly/async_client.rb

Overview

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

async_client = Aws::Polly::AsyncClient.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

.identifier ⇒ Object readonly private

API Operations collapse

#start_speech_synthesis_stream(params = {}) ⇒ Types::StartSpeechSynthesisStreamOutput

Synthesizes UTF-8 input, plain text, or SSML over a bidirectional streaming connection.

Class Method Summary collapse

.errors_module ⇒ Object private

Instance Method Summary collapse

#build_request(operation_name, params = {}) ⇒ Object private
#initialize(options) ⇒ AsyncClient constructor

A new instance of AsyncClient.

Constructor Details

#initialize(options) ⇒ `AsyncClient`

Returns a new instance of AsyncClient.

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`
- The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.
- ‘ENV`, `ENV`, `ENV`, and `ENV`.
- ‘~/.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` 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`
- ‘ENV`
- ‘ENV`
- ‘ENV`
- ‘~/.aws/credentials`
- ‘~/.aws/config`
:access_key_id (String)
:account_id (String)
: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` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.
: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.
:defaults_mode (String) — default: "legacy" —

See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
: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'
```
: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.
: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 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: "legacy" —
Specifies which retry algorithm to use. Values are:
- ‘legacy` - The pre-existing retry behavior. This is the default value if no retry mode is provided.
- ‘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.
- ‘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`
- ‘ENV`
- ‘~/.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`.
:connection_read_timeout (Integer) — default: 60 —

Connection read timeout in seconds, defaults to 60 sec.
:connection_timeout (Integer) — default: 60 —

Connection timeout in seconds, defaults to 60 sec.
:enable_alpn (Boolean) — default: true —

Set to ‘false` to disable ALPN in HTTP2 over TLS. ALPN requires Openssl version >= 1.0.2. Note: RFC7540 requires HTTP2 to use ALPN over TLS but some services may not fully support ALPN and require setting this to `false`.
:http_wire_trace (Boolean) — default: false —

When ‘true`, HTTP2 debug output will be sent to the `:logger`.
:max_concurrent_streams (Integer) — default: 100 —

Maximum concurrent streams used in HTTP2 connection, defaults to 100. Note that server may send back :settings_max_concurrent_streams value which will take priority when initializing new streams.
:raise_response_errors (Boolean) — default: true —

Defaults to ‘true`, raises errors if exist when #wait or #join! is called upon async response.
:read_chunk_size (Integer) — default: 1024
: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_directory` or `:ssl_ca_bundle` 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 system default will be used if available.
:ssl_ca_store (String)
:ssl_verify_peer (Boolean) — default: true —

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

# File 'lib/aws-sdk-polly/async_client.rb', line 403

def initialize(*args)
  unless Kernel.const_defined?("HTTP2")
    raise "Must include http/2 gem to use AsyncClient instances."
  end
  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.



680
681
682

# File 'lib/aws-sdk-polly/async_client.rb', line 680

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.



683
684
685

# File 'lib/aws-sdk-polly/async_client.rb', line 683

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: {})

# File 'lib/aws-sdk-polly/async_client.rb', line 643

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::Polly')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    http_response: Seahorse::Client::Http::AsyncResponse.new,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-polly'
  context[:gem_version] = '1.125.0'
  Seahorse::Client::Request.new(handlers, context)
end

#start_speech_synthesis_stream(params = {}) ⇒ `Types::StartSpeechSynthesisStreamOutput`

Synthesizes UTF-8 input, plain text, or SSML over a bidirectional streaming connection. Specify synthesis parameters in HTTP/2 headers, send text incrementally as events on the input stream, and receive synthesized audio as it becomes available.

This operation serves as a bidirectional counterpart to ‘SynthesizeSpeech`:

SynthesizeSpeech][1

[1]: docs.aws.amazon.com/polly/latest/API/API_SynthesizeSpeech.html

Examples:

Bi-directional EventStream Operation Example

# You can signal input events after the initial request is established. Events
# will be sent to the stream immediately once the stream connection is
# established successfully.

# To signal events, you can call the #signal methods from an
# Aws::Polly::EventStreams::StartSpeechSynthesisStreamActionStream object.
# You must signal events before calling #wait or #join! on the async response.
input_stream = Aws::Polly::EventStreams::StartSpeechSynthesisStreamActionStream.new

async_resp = client.start_speech_synthesis_stream(
  # params input
  input_event_stream_handler: input_stream
) do |out_stream|
  # register callbacks for events
  out_stream.on_audio_event_event do |event|
    event # => Aws::Polly::Types::AudioEvent
  end
  out_stream.on_stream_closed_event_event do |event|
    event # => Aws::Polly::Types::StreamClosedEvent
  end
  out_stream.on_validation_exception_event do |event|
    event # => Aws::Polly::Types::ValidationException
  end
  out_stream.on_service_quota_exceeded_exception_event do |event|
    event # => Aws::Polly::Types::ServiceQuotaExceededException
  end
  out_stream.on_service_failure_exception_event do |event|
    event # => Aws::Polly::Types::ServiceFailureException
  end
  out_stream.on_throttling_exception_event do |event|
    event # => Aws::Polly::Types::ThrottlingException
  end
end
# => Aws::Seahorse::Client::AsyncResponse

# signal events
input_stream.signal_text_event_event(
  # ...
)
input_stream.signal_close_stream_event_event(
  # ...
)

# make sure to signal :end_stream at the end
input_stream.signal_end_stream

# wait until stream is closed before finalizing the sync response
resp = async_resp.wait

# Or close the stream and finalize sync response immediately
resp = async_resp.join!

# You can also provide an Aws::Polly::EventStreams::StartSpeechSynthesisStreamEventStream object
# to register callbacks before initializing the request instead of processing
# from the request block.
output_stream = Aws::Polly::EventStreams::StartSpeechSynthesisStreamEventStream.new

# register callbacks for output events
output_stream.on_audio_event_event do |event|
  event # => Aws::Polly::Types::AudioEvent
end
output_stream.on_stream_closed_event_event do |event|
  event # => Aws::Polly::Types::StreamClosedEvent
end
output_stream.on_validation_exception_event do |event|
  event # => Aws::Polly::Types::ValidationException
end
output_stream.on_service_quota_exceeded_exception_event do |event|
  event # => Aws::Polly::Types::ServiceQuotaExceededException
end
output_stream.on_service_failure_exception_event do |event|
  event # => Aws::Polly::Types::ServiceFailureException
end
output_stream.on_throttling_exception_event do |event|
  event # => Aws::Polly::Types::ThrottlingException
end
output_stream.on_error_event do |event|
  # catch unmodeled error event in the stream
  raise event
  # => Aws::Errors::EventError
  # event.event_type => :error
  # event.error_code => String
  # event.error_message => String
end

async_resp = client.start_speech_synthesis_stream(
  # params input
  input_event_stream_handler: input_stream,
  output_event_stream_handler: output_stream
)
resp = async_resp.join!

# You can also iterate through events after the response is complete.
# Events are available at
resp.event_stream # => Enumerator

Request syntax with placeholder values


async_resp = async_client.start_speech_synthesis_stream({
  engine: "standard", # required, 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",
  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
  input_event_stream_hander: EventStreams::StartSpeechSynthesisStreamActionStream.new,
})
# => Seahorse::Client::AsyncResponse
async_resp.wait
# => Seahorse::Client::Response
# Or use async_resp.join!

Response structure


# All events are available at resp.event_stream:
resp.event_stream #=> Enumerator
resp.event_stream.event_types #=> [:audio_event, :stream_closed_event, :validation_exception, :service_quota_exceeded_exception, :service_failure_exception, :throttling_exception]

# For :audio_event event available at #on_audio_event_event callback and response eventstream enumerator:
event.audio_chunk #=> String

# For :stream_closed_event event available at #on_stream_closed_event_event callback and response eventstream enumerator:
event.request_characters #=> Integer

# For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
event.message #=> String
event.reason #=> String, one of "unsupportedOperation", "fieldValidationFailed", "other", "invalidInboundEvent"
event.fields #=> Array
event.fields[0].name #=> String
event.fields[0].message #=> String

# For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
event.message #=> String
event.quota_code #=> String, one of "input-stream-inbound-event-timeout", "input-stream-timeout"
event.service_code #=> String, one of "polly"

# For :service_failure_exception event available at #on_service_failure_exception_event callback and response eventstream enumerator:
event.message #=> String

# For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
event.message #=> String
event.throttling_reasons #=> Array
event.throttling_reasons[0].reason #=> String
event.throttling_reasons[0].resource #=> String

Parameters:

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

({})

Options Hash (params):

:engine (required, String) —

Specifies the engine for Amazon Polly to use when processing input text for speech synthesis. Currently, only the ‘generative` engine is supported. If you specify a voice that the selected engine doesn’t support, Amazon Polly returns an error.
:language_code (String) —

An optional parameter that sets the language code for the speech synthesis request. Specify this parameter only when using a bilingual voice. If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice.
:lexicon_names (Array<String>) —

The names of one or more pronunciation lexicons for the service to apply during synthesis. Amazon Polly applies lexicons only when the lexicon language matches the voice language.
:output_format (required, String) —

The audio format for the synthesized speech. Currently, Amazon Polly does not support JSON speech marks.
:sample_rate (String) —

The audio frequency, specified in Hz.
:voice_id (required, String) —

The voice to use in synthesis. To get a list of available voice IDs, use the [DescribeVoices] operation.

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

Yields:

(output_event_stream_handler)

Returns:

(Types::StartSpeechSynthesisStreamOutput) —
Returns a response object which responds to the following methods:
- #event_stream => Types::StartSpeechSynthesisStreamEventStream

Class: Aws::Polly::AsyncClient

Overview

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ AsyncClient

Class Attribute Details

.identifier ⇒ Object (readonly)

Class Method Details

.errors_module ⇒ Object

Instance Method Details

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

#start_speech_synthesis_stream(params = {}) ⇒ Types::StartSpeechSynthesisStreamOutput

Examples:

Bi-directional EventStream Operation Example

Request syntax with placeholder values

Response structure

#initialize(options) ⇒ `AsyncClient`

.identifier ⇒ `Object` (readonly)

.errors_module ⇒ `Object`

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

#start_speech_synthesis_stream(params = {}) ⇒ `Types::StartSpeechSynthesisStreamOutput`