Class: Aws::TranscribeStreamingService::AsyncClient
- Inherits:
-
Seahorse::Client::AsyncBase
- Object
- Seahorse::Client::Base
- Seahorse::Client::AsyncBase
- Aws::TranscribeStreamingService::AsyncClient
- Includes:
- AsyncClientStubs
- Defined in:
- gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/async_client.rb
Instance Attribute Summary
Attributes inherited from Seahorse::Client::AsyncBase
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#start_call_analytics_stream_transcription(params = {}) ⇒ Types::StartCallAnalyticsStreamTranscriptionResponse
Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.
-
#start_medical_stream_transcription(params = {}) ⇒ Types::StartMedicalStreamTranscriptionResponse
Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.
-
#start_stream_transcription(params = {}) ⇒ Types::StartStreamTranscriptionResponse
Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.
Instance Method Summary collapse
-
#initialize(*args) ⇒ AsyncClient
constructor
@option options [required, Aws::CredentialProvider] :credentials Your AWS credentials.
Methods included from AsyncClientStubs
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::AsyncBase
#close_connection, #connection_errors, #new_connection, #operation_names
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(*args) ⇒ AsyncClient
@option options [required, Aws::CredentialProvider] :credentials Your AWS credentials. This can be an instance of any one of the following classes:
* `Aws::Credentials` - Used for configuring static, non-refreshing
credentials.
* `Aws::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`, and `:session_token` options.
* ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
* `~/.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::InstanceProfileCredentails` 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.
@option options [required, String] :region
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`
@option options [String] :access_key_id
@option options [Boolean] :adaptive_retry_wait_to_fill (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.
@option options [Boolean] :convert_params (true)
When true
, an attempt is made to coerce request parameters into
the required types.
@option options [Boolean] :correct_clock_skew (true)
Used only in standard
and adaptive retry modes. Specifies whether to apply
a clock skew correction and retry requests with skewed client clocks.
@option options [String] :defaults_mode ("legacy") See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
@option options [Boolean] :disable_request_compression (false) When set to 'true' the request body will not be compressed for supported operations.
@option options [String, URI::HTTPS, URI::HTTP] :endpoint
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'
@option options [Proc] :event_stream_handler 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.
@option options [Boolean] :ignore_configured_endpoint_urls Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.
@option options [Proc] :input_event_stream_handler When an EventStream or Proc object is provided, it can be used for sending events for the event stream.
@option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) The log formatter.
@option options [Symbol] :log_level (:info)
The log level to send messages to the :logger
at.
@option options [Logger] :logger The Logger instance to send log messages to. If this option is not set, logging will be disabled.
@option options [Integer] :max_attempts (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.
@option options [Proc] :output_event_stream_handler 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.
@option options [String] :profile ("default") Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.
@option options [Integer] :request_min_compression_size_bytes (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.
@option options [Proc] :retry_backoff
A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
This option is only used in the legacy
retry mode.
@option options [Float] :retry_base_delay (0.3)
The base delay in seconds used by the default backoff function. This option
is only used in the legacy
retry mode.
@option options [Symbol] :retry_jitter (: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
@option options [Integer] :retry_limit (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.
@option options [Integer] :retry_max_delay (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.
@option options [String] :retry_mode ("legacy") Specifies which retry algorithm to use. Values are:
* `legacy` - The pre-existing retry behavior. This is 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` - An experimental retry mode that includes all the
functionality of `standard` mode along with automatic client side
throttling. This is a provisional mode that may change behavior
in the future.
@option options [String] :sdk_ua_app_id 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.
@option options [String] :secret_access_key
@option options [String] :session_token
@option options [Boolean] :stub_responses (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.
@option options [Aws::TokenProvider] :token_provider A Bearer Token Provider. This can be an 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.
@option options [Boolean] :use_dualstack_endpoint
When set to true
, dualstack enabled endpoints (with .aws
TLD)
will be used if available.
@option options [Boolean] :use_fips_endpoint
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
.
@option options [Boolean] :validate_params (true)
When true
, request parameters are validated before
sending the request.
@option options [Aws::TranscribeStreamingService::EndpointProvider] :endpoint_provider
The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters)
where parameters
is a Struct similar to Aws::TranscribeStreamingService::EndpointParameters
@option options [Integer] :connection_read_timeout (60) Connection read timeout in seconds, defaults to 60 sec.
@option options [Integer] :connection_timeout (60) Connection timeout in seconds, defaults to 60 sec.
@option options [Boolean] :enable_alpn (false)
Set to true
to enable ALPN in HTTP2 over TLS. Requires Openssl version >= 1.0.2.
Defaults to false. Note: not all service HTTP2 operations supports ALPN on server
side, please refer to service documentation.
@option options [Boolean] :http_wire_trace (false)
When true
, HTTP2 debug output will be sent to the :logger
.
@option options [Integer] :max_concurrent_streams (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.
@option options [Boolean] :raise_response_errors (true)
Defaults to true
, raises errors if exist when #wait or #join! is called upon async response.
@option options [Integer] :read_chunk_size (1024)
@option options [String] :ssl_ca_bundle
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.
@option options [String] :ssl_ca_directory
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.
@option options [String] :ssl_ca_store
@option options [Boolean] :ssl_verify_peer (true)
When true
, SSL peer certificates are verified when establishing a connection.
331 332 333 334 335 336 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/async_client.rb', line 331 def initialize(*args) unless Kernel.const_defined?("HTTP2") raise "Must include http/2 gem to use AsyncClient instances." end super end |
Instance Method Details
#start_call_analytics_stream_transcription(params = {}) ⇒ Types::StartCallAnalyticsStreamTranscriptionResponse
Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application. Use this operation for Call Analytics transcriptions.
The following parameters are required:
language-code
media-encoding
sample-rate
For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.
751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/async_client.rb', line 751 def start_call_analytics_stream_transcription(params = {}, = {}, &block) params = params.dup input_event_stream_handler = _event_stream_handler( :input, params.delete(:input_event_stream_handler), EventStreams::AudioStream ) output_event_stream_handler = _event_stream_handler( :output, params.delete(:output_event_stream_handler) || params.delete(:event_stream_handler), EventStreams::CallAnalyticsTranscriptResultStream ) yield(output_event_stream_handler) if block_given? req = build_request(:start_call_analytics_stream_transcription, params) req.context[:input_event_stream_handler] = input_event_stream_handler req.handlers.add(Aws::Binary::EncodeHandler, priority: 55) req.context[:output_event_stream_handler] = output_event_stream_handler req.handlers.add(Aws::Binary::DecodeHandler, priority: 55) req.send_request(, &block) end |
#start_medical_stream_transcription(params = {}) ⇒ Types::StartMedicalStreamTranscriptionResponse
Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.
The following parameters are required:
language-code
media-encoding
sample-rate
For more information on streaming with Amazon Transcribe Medical, see Transcribing streaming audio.
1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/async_client.rb', line 1080 def start_medical_stream_transcription(params = {}, = {}, &block) params = params.dup input_event_stream_handler = _event_stream_handler( :input, params.delete(:input_event_stream_handler), EventStreams::AudioStream ) output_event_stream_handler = _event_stream_handler( :output, params.delete(:output_event_stream_handler) || params.delete(:event_stream_handler), EventStreams::MedicalTranscriptResultStream ) yield(output_event_stream_handler) if block_given? req = build_request(:start_medical_stream_transcription, params) req.context[:input_event_stream_handler] = input_event_stream_handler req.handlers.add(Aws::Binary::EncodeHandler, priority: 55) req.context[:output_event_stream_handler] = output_event_stream_handler req.handlers.add(Aws::Binary::DecodeHandler, priority: 55) req.send_request(, &block) end |
#start_stream_transcription(params = {}) ⇒ Types::StartStreamTranscriptionResponse
Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application.
The following parameters are required:
language-code
oridentify-language
oridentify-multiple-language
media-encoding
sample-rate
For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/async_client.rb', line 1685 def start_stream_transcription(params = {}, = {}, &block) params = params.dup input_event_stream_handler = _event_stream_handler( :input, params.delete(:input_event_stream_handler), EventStreams::AudioStream ) output_event_stream_handler = _event_stream_handler( :output, params.delete(:output_event_stream_handler) || params.delete(:event_stream_handler), EventStreams::TranscriptResultStream ) yield(output_event_stream_handler) if block_given? req = build_request(:start_stream_transcription, params) req.context[:input_event_stream_handler] = input_event_stream_handler req.handlers.add(Aws::Binary::EncodeHandler, priority: 55) req.context[:output_event_stream_handler] = output_event_stream_handler req.handlers.add(Aws::Binary::DecodeHandler, priority: 55) req.send_request(, &block) end |