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_scribe_stream(params = {}) ⇒ Types::StartMedicalScribeStreamResponse
Starts a bidirectional HTTP/2 stream, where audio is streamed to Amazon Web Services HealthScribe 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`, `: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.
@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 [String] :account_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 [String] :request_checksum_calculation ("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.
@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 [String] :response_checksum_validation ("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`.
@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 [Array] :sigv4a_signing_region_set
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`
@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::Telemetry::TelemetryProviderBase] :telemetry_provider (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.
@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.
379 380 381 382 383 384 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/async_client.rb', line 379 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-codemedia-encodingsample-rate
For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/async_client.rb', line 799 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_scribe_stream(params = {}) ⇒ Types::StartMedicalScribeStreamResponse
Starts a bidirectional HTTP/2 stream, where audio is streamed to Amazon Web Services HealthScribe and the transcription results are streamed to your application.
When you start a stream, you first specify the stream configuration in
a MedicalScribeConfigurationEvent. This event includes channel
definitions, encryption settings, and post-stream analytics settings,
such as the output configuration for aggregated transcript and
clinical note generation. These are additional streaming session
configurations beyond those provided in your initial start request
headers. Whether you are starting a new session or resuming an
existing session, your first event must be a
MedicalScribeConfigurationEvent.
After you send a MedicalScribeConfigurationEvent, you start
AudioEvents and Amazon Web Services HealthScribe responds with
real-time transcription results. When you are finished, to start
processing the results with the post-stream analytics, send a
MedicalScribeSessionControlEvent with a Type of END_OF_SESSION
and Amazon Web Services HealthScribe starts the analytics.
You can pause or resume streaming. To pause streaming, complete the
input stream without sending the MedicalScribeSessionControlEvent.
To resume streaming, call the StartMedicalScribeStream and specify
the same SessionId you used to start the stream.
The following parameters are required:
language-codemedia-encodingmedia-sample-rate-hertz
For more information on streaming with Amazon Web Services HealthScribe, see Amazon Web Services HealthScribe.
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/async_client.rb', line 1061 def start_medical_scribe_stream(params = {}, = {}, &block) params = params.dup input_event_stream_handler = _event_stream_handler( :input, params.delete(:input_event_stream_handler), EventStreams::MedicalScribeInputStream ) output_event_stream_handler = _event_stream_handler( :output, params.delete(:output_event_stream_handler) || params.delete(:event_stream_handler), EventStreams::MedicalScribeResultStream ) yield(output_event_stream_handler) if block_given? req = build_request(:start_medical_scribe_stream, 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-codemedia-encodingsample-rate
For more information on streaming with Amazon Transcribe Medical, see Transcribing streaming audio.
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/async_client.rb', line 1396 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-codeoridentify-languageoridentify-multiple-languagemedia-encodingsample-rate
For more information on streaming with Amazon Transcribe, see Transcribing streaming audio.
2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 |
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/async_client.rb', line 2009 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 |