AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Module: Aws::Kinesis

Defined in:


This module provides a client for making API requests to Amazon Kinesis.


The Client class provides one-to-one mapping for each API operation.

kinesis = 'us-east-1')
#=> [:add_tags_to_stream, :create_stream, :decrease_stream_retention_period, :delete_stream, ...]

Each API operation method accepts a hash of request parameters and returns a response object.

resp = kinesis.add_tags_to_stream(params)

See Client for more information.


Errors returned from Amazon Kinesis are defined in the Errors module and extend Errors::ServiceError.

  # do stuff
rescue Aws::Kinesis::Errors::ServiceError
  # rescues all errors returned by Amazon Kinesis

See Errors for more information.

Defined Under Namespace

Modules: Errors, Types Classes: Client