Class: Aws::Kinesis::AsyncClient
- Inherits:
-
Seahorse::Client::AsyncBase
- Object
- Seahorse::Client::Base
- Seahorse::Client::AsyncBase
- Aws::Kinesis::AsyncClient
- Includes:
- AsyncClientStubs
- Defined in:
- gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/async_client.rb
Instance Attribute Summary
Attributes inherited from Seahorse::Client::AsyncBase
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#subscribe_to_shard(params = {}) ⇒ Types::SubscribeToShardOutput
This operation establishes an HTTP/2 connection between the consumer you specify in the
ConsumerARN
parameter and the shard you specify in theShardId
parameter.
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] :endpoint
The client endpoint is normally constructed from the :region
option. You should only configure an :endpoint
when connecting
to test or custom endpoints. This should be a valid HTTP(S) URI.
@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/
@option options [String] :secret_access_key
@option options [String] :session_token
@option options [Boolean] :simple_json (false) Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.
When `:simple_json` is enabled, the request parameters hash must
be formatted exactly as the DynamoDB API expects.
@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::Kinesis::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::Kinesis::EndpointParameters
295 296 297 298 299 300 |
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/async_client.rb', line 295 def initialize(*args) unless Kernel.const_defined?("HTTP2") raise "Must include http/2 gem to use AsyncClient instances." end super end |
Instance Method Details
#subscribe_to_shard(params = {}) ⇒ Types::SubscribeToShardOutput
This operation establishes an HTTP/2 connection between the consumer
you specify in the ConsumerARN
parameter and the shard you specify
in the ShardId
parameter. After the connection is successfully
established, Kinesis Data Streams pushes records from the shard to the
consumer over this connection. Before you call this operation, call
RegisterStreamConsumer to register the consumer with Kinesis Data
Streams.
When the SubscribeToShard
call succeeds, your consumer starts
receiving events of type SubscribeToShardEvent over the HTTP/2
connection for up to 5 minutes, after which time you need to call
SubscribeToShard
again to renew the subscription if you want to
continue to receive records.
You can make one call to SubscribeToShard
per second per registered
consumer per shard. For example, if you have a 4000 shard stream and
two registered stream consumers, you can make one SubscribeToShard
request per second for each combination of shard and registered
consumer, allowing you to subscribe both consumers to all 4000 shards
in one second.
If you call SubscribeToShard
again with the same ConsumerARN
and
ShardId
within 5 seconds of a successful call, you'll get a
ResourceInUseException
. If you call SubscribeToShard
5 seconds or
more after a successful call, the second call takes over the
subscription and the previous connection expires or fails with a
ResourceInUseException
.
For an example of how to use this operations, see Enhanced Fan-Out Using the Kinesis Data Streams API.
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 |
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/async_client.rb', line 586 def subscribe_to_shard(params = {}, = {}) params = params.dup output_event_stream_handler = _event_stream_handler( :output, params.delete(:output_event_stream_handler) || params.delete(:event_stream_handler), EventStreams::SubscribeToShardEventStream ) yield(output_event_stream_handler) if block_given? req = build_request(:subscribe_to_shard, params) req.context[:output_event_stream_handler] = output_event_stream_handler req.handlers.add(Aws::Binary::DecodeHandler, priority: 55) req.send_request() end |