Class: Aws::Kinesis::AsyncClient

Inherits:
Seahorse::Client::AsyncBase
  • Object
show all
Includes:
AsyncClientStubs
Defined in:
lib/aws-sdk-kinesis/async_client.rb

Overview

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

async_client = Aws::Kinesis::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

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

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:

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

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

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.

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

    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`.

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



412
413
414
415
416
417
 
# File 'lib/aws-sdk-kinesis/async_client.rb', line 412

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. 



770
771
772
 
# File 'lib/aws-sdk-kinesis/async_client.rb', line 770

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. 



773
774
775
 
# File 'lib/aws-sdk-kinesis/async_client.rb', line 773

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


733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/aws-sdk-kinesis/async_client.rb', line 733

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::Kinesis')
  )
  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-kinesis'
  context[:gem_version] = '1.91.0'
  Seahorse::Client::Request.new(handlers, context)
end

#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 operation, see [Enhanced Fan-Out Using the Kinesis Data Streams API].

[1]: docs.aws.amazon.com/streams/latest/dev/building-enhanced-consumers-api.html

Examples:

EventStream Operation Example


# You can process the event once it arrives immediately, or wait until the
# full response is complete and iterate through the eventstream enumerator.

# To interact with event immediately, you need to register subscribe_to_shard
# with callbacks. Callbacks can be registered for specific events or for all
# events, including error events.

# Callbacks can be passed into the `:event_stream_handler` option or within a
# block statement attached to the #subscribe_to_shard call directly. Hybrid
# pattern of both is also supported.

# `:event_stream_handler` option takes in either a Proc object or
# Aws::Kinesis::EventStreams::SubscribeToShardEventStream object.

# Usage pattern a): Callbacks with a block attached to #subscribe_to_shard
# Example for registering callbacks for all event types and an error event
client.subscribe_to_shard(
  # params input
) do |stream|
  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

  stream.on_event do |event|
    # process all events arrive
    puts event.event_type
    # ...
  end
end

# Usage pattern b): Pass in `:event_stream_handler` for #subscribe_to_shard
#  1) Create a Aws::Kinesis::EventStreams::SubscribeToShardEventStream object
#  Example for registering callbacks with specific events

handler = Aws::Kinesis::EventStreams::SubscribeToShardEventStream.new
handler.on_subscribe_to_shard_event_event do |event|
  event # => Aws::Kinesis::Types::SubscribeToShardEvent
end
handler.on_resource_not_found_exception_event do |event|
  event # => Aws::Kinesis::Types::ResourceNotFoundException
end
handler.on_resource_in_use_exception_event do |event|
  event # => Aws::Kinesis::Types::ResourceInUseException
end
handler.on_kms_disabled_exception_event do |event|
  event # => Aws::Kinesis::Types::KMSDisabledException
end
handler.on_kms_invalid_state_exception_event do |event|
  event # => Aws::Kinesis::Types::KMSInvalidStateException
end
handler.on_kms_access_denied_exception_event do |event|
  event # => Aws::Kinesis::Types::KMSAccessDeniedException
end
handler.on_kms_not_found_exception_event do |event|
  event # => Aws::Kinesis::Types::KMSNotFoundException
end
handler.on_kms_opt_in_required_event do |event|
  event # => Aws::Kinesis::Types::KMSOptInRequired
end
handler.on_kms_throttling_exception_event do |event|
  event # => Aws::Kinesis::Types::KMSThrottlingException
end
handler.on_internal_failure_exception_event do |event|
  event # => Aws::Kinesis::Types::InternalFailureException
end

client.subscribe_to_shard(
  # params inputs
  event_stream_handler: handler
)

#  2) Use a Ruby Proc object
#  Example for registering callbacks with specific events
handler = Proc.new do |stream|
  stream.on_subscribe_to_shard_event_event do |event|
    event # => Aws::Kinesis::Types::SubscribeToShardEvent
  end
  stream.on_resource_not_found_exception_event do |event|
    event # => Aws::Kinesis::Types::ResourceNotFoundException
  end
  stream.on_resource_in_use_exception_event do |event|
    event # => Aws::Kinesis::Types::ResourceInUseException
  end
  stream.on_kms_disabled_exception_event do |event|
    event # => Aws::Kinesis::Types::KMSDisabledException
  end
  stream.on_kms_invalid_state_exception_event do |event|
    event # => Aws::Kinesis::Types::KMSInvalidStateException
  end
  stream.on_kms_access_denied_exception_event do |event|
    event # => Aws::Kinesis::Types::KMSAccessDeniedException
  end
  stream.on_kms_not_found_exception_event do |event|
    event # => Aws::Kinesis::Types::KMSNotFoundException
  end
  stream.on_kms_opt_in_required_event do |event|
    event # => Aws::Kinesis::Types::KMSOptInRequired
  end
  stream.on_kms_throttling_exception_event do |event|
    event # => Aws::Kinesis::Types::KMSThrottlingException
  end
  stream.on_internal_failure_exception_event do |event|
    event # => Aws::Kinesis::Types::InternalFailureException
  end
end

client.subscribe_to_shard(
  # params inputs
  event_stream_handler: handler
)

#  Usage pattern c): Hybrid pattern of a) and b)
handler = Aws::Kinesis::EventStreams::SubscribeToShardEventStream.new
handler.on_subscribe_to_shard_event_event do |event|
  event # => Aws::Kinesis::Types::SubscribeToShardEvent
end
handler.on_resource_not_found_exception_event do |event|
  event # => Aws::Kinesis::Types::ResourceNotFoundException
end
handler.on_resource_in_use_exception_event do |event|
  event # => Aws::Kinesis::Types::ResourceInUseException
end
handler.on_kms_disabled_exception_event do |event|
  event # => Aws::Kinesis::Types::KMSDisabledException
end
handler.on_kms_invalid_state_exception_event do |event|
  event # => Aws::Kinesis::Types::KMSInvalidStateException
end
handler.on_kms_access_denied_exception_event do |event|
  event # => Aws::Kinesis::Types::KMSAccessDeniedException
end
handler.on_kms_not_found_exception_event do |event|
  event # => Aws::Kinesis::Types::KMSNotFoundException
end
handler.on_kms_opt_in_required_event do |event|
  event # => Aws::Kinesis::Types::KMSOptInRequired
end
handler.on_kms_throttling_exception_event do |event|
  event # => Aws::Kinesis::Types::KMSThrottlingException
end
handler.on_internal_failure_exception_event do |event|
  event # => Aws::Kinesis::Types::InternalFailureException
end

client.subscribe_to_shard(
  # params input
  event_stream_handler: handler
) do |stream|
  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
end

# You can also iterate through events after the response complete.
# Events are available at
resp.event_stream # => Enumerator
# For parameter input example, please refer to following request syntax.

Request syntax with placeholder values


async_resp = async_client.subscribe_to_shard({
  consumer_arn: "ConsumerARN", # required
  shard_id: "ShardId", # required
  starting_position: { # required
    type: "AT_SEQUENCE_NUMBER", # required, accepts AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
    sequence_number: "SequenceNumber",
    timestamp: Time.now,
  },
})
# => 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 #=> [:subscribe_to_shard_event, :resource_not_found_exception, :resource_in_use_exception, :kms_disabled_exception, :kms_invalid_state_exception, :kms_access_denied_exception, :kms_not_found_exception, :kms_opt_in_required, :kms_throttling_exception, :internal_failure_exception]

# For :subscribe_to_shard_event event available at #on_subscribe_to_shard_event_event callback and response eventstream enumerator:
event.records #=> Array
event.records[0].sequence_number #=> String
event.records[0].approximate_arrival_timestamp #=> Time
event.records[0].data #=> String
event.records[0].partition_key #=> String
event.records[0].encryption_type #=> String, one of "NONE", "KMS"
event.continuation_sequence_number #=> String
event.millis_behind_latest #=> Integer
event.child_shards #=> Array
event.child_shards[0].shard_id #=> String
event.child_shards[0].parent_shards #=> Array
event.child_shards[0].parent_shards[0] #=> String
event.child_shards[0].hash_key_range.starting_hash_key #=> String
event.child_shards[0].hash_key_range.ending_hash_key #=> String

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

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

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

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

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

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

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

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :consumer_arn (required, String) —

    For this parameter, use the value you obtained when you called RegisterStreamConsumer.

  • :shard_id (required, String) —

    The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.

  • :starting_position (required, Types::StartingPosition) —

    The starting position in the data stream from which to start streaming.

Yields:

  • (output_event_stream_handler)

Returns:

See Also:



711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
 
# File 'lib/aws-sdk-kinesis/async_client.rb', line 711

def subscribe_to_shard(params = {}, options = {})
  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(options)
end