Class Fog::AWS::Kinesis::Real
In: lib/fog/aws/requests/kinesis/delete_stream.rb
lib/fog/aws/requests/kinesis/add_tags_to_stream.rb
lib/fog/aws/requests/kinesis/remove_tags_from_stream.rb
lib/fog/aws/requests/kinesis/create_stream.rb
lib/fog/aws/requests/kinesis/split_shard.rb
lib/fog/aws/requests/kinesis/get_shard_iterator.rb
lib/fog/aws/requests/kinesis/merge_shards.rb
lib/fog/aws/requests/kinesis/put_records.rb
lib/fog/aws/requests/kinesis/describe_stream.rb
lib/fog/aws/requests/kinesis/list_tags_for_stream.rb
lib/fog/aws/requests/kinesis/list_streams.rb
lib/fog/aws/requests/kinesis/get_records.rb
lib/fog/aws/requests/kinesis/put_record.rb
lib/fog/aws/kinesis.rb
Parent: Object

Methods

add_tags_to_stream   create_stream   delete_stream   describe_stream   get_records   get_shard_iterator   list_streams   list_tags_for_stream   merge_shards   new   put_record   put_records   remove_tags_from_stream   split_shard  

Included Modules

Fog::AWS::CredentialFetcher::ConnectionMethods

Public Class methods

Public Instance methods

add_tags_to_stream(options={})

Adds or updates tags for the specified Amazon Kinesis stream.

Options

  • StreamName<~String>: The name of the stream.
  • Tags<~Hash>: The set of key-value pairs to use to create the tags.

Returns

  • response<~Excon::Response>:

See Also

docs.aws.amazon.com/kinesis/latest/APIReference/API_AddTagsToStream.html

create_stream(options={})

Creates a Amazon Kinesis stream.

Options

  • ShardCount<~Number>: The number of shards that the stream will use.
  • StreamName<~String>: A name to identify the stream.

Returns

  • response<~Excon::Response>:

See Also

docs.aws.amazon.com/kinesis/latest/APIReference/API_CreateStream.html

delete_stream(options={})

Deletes a stream and all its shards and data.

Options

  • StreamName<~String>: A name to identify the stream.

Returns

  • response<~Excon::Response>:

See Also

docs.aws.amazon.com/kinesis/latest/APIReference/API_DeleteStream.html

describe_stream(options={})

Describes the specified stream.

Options

  • ExclusiveStartShardId<~String>: The shard ID of the shard to start with.
  • Limit<~Number>: The maximum number of shards to return.
  • StreamName<~String>: The name of the stream to describe.

Returns

  • response<~Excon::Response>:

See Also

docs.aws.amazon.com/kinesis/latest/APIReference/API_DescribeStream.html

get_records(options={})

Gets data records from a shard.

Options

  • Limit<~Number>: The maximum number of records to return.
  • ShardIterator<~String>: The position in the shard from which you want to start sequentially reading data records.

Returns

  • response<~Excon::Response>:

See Also

docs.aws.amazon.com/kinesis/latest/APIReference/API_GetRecords.html

get_shard_iterator(options={})

Gets a shard iterator.

Options

  • ShardId<~String>: The shard ID of the shard to get the iterator for.
  • ShardIteratorType<~String>: Determines how the shard iterator is used to start reading data records from the shard.
  • StartingSequenceNumber<~String>: The sequence number of the data record in the shard from which to start reading from.
  • StreamName<~String>: A name to identify the stream.

Returns

  • response<~Excon::Response>:

See Also

docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html

list_streams(options={})

List availabe streams

Options

  • ExclusiveStartStreamName<~String>: The name of the stream to start the list with.
  • Limit<~Number>: The maximum number of streams to list.

Returns

  • response<~Excon::Response>:

See Also

docs.aws.amazon.com/kinesis/latest/APIReference/API_ListStreams.html

list_tags_for_stream(options={})

Lists the tags for the specified Amazon Kinesis stream.

Options

  • ExclusiveStartTagKey<~String>: The key to use as the starting point for the list of tags.
  • Limit<~Number>: The number of tags to return.
  • StreamName<~String>: The name of the stream.

Returns

  • response<~Excon::Response>:

See Also

docs.aws.amazon.com/kinesis/latest/APIReference/API_ListTagsForStream.html

merge_shards(options={})

Merges two adjacent shards in a stream and combines them into a single shard to reduce the stream‘s capacity to ingest and transport data.

Options

  • AdjacentShardToMerge<~String>: The shard ID of the adjacent shard for the merge.
  • ShardToMerge<~String>: The shard ID of the shard to combine with the adjacent shard for the merge.
  • StreamName<~String>: The name of the stream for the merge.

Returns

  • response<~Excon::Response>:

See Also

docs.aws.amazon.com/kinesis/latest/APIReference/API_MergeShards.html

put_record(options={})

Writes a single data record from a producer into an Amazon Kinesis stream.

Options

  • Data<~Blob>: The data blob to put into the record, which is base64-encoded when the blob is serialized.
  • ExplicitHashKey<~String>: The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
  • PartitionKey<~String>: Determines which shard in the stream the data record is assigned to.
  • SequenceNumberForOrdering<~String>: Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key.
  • StreamName<~String>: The stream name associated with the request.

Returns

  • response<~Excon::Response>:

See Also

docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html

put_records(options={})

Writes multiple data records from a producer into an Amazon Kinesis stream in a single call (also referred to as a PutRecords request).

Options

  • Records<~Array>: The records associated with the request.
    • Record<~Hash>: A record.
      • Data<~Blob>: The data blob to put into the record, which is base64-encoded when the blob is serialized.
      • ExplicitHashKey<~String>: The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.
      • PartitionKey<~String>: Determines which shard in the stream the data record is assigned to.
  • StreamName<~String>: The stream name associated with the request.

Returns

  • response<~Excon::Response>:

See Also

docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecords.html

remove_tags_from_stream(options={})

Deletes tags from the specified Amazon Kinesis stream.

Options

  • StreamName<~String>: The name of the stream.
  • TagKeys<~Array>: A list of tag keys.

Returns

  • response<~Excon::Response>:

See Also

docs.aws.amazon.com/kinesis/latest/APIReference/API_RemoveTagsFromStream.html

split_shard(options={})

Splits a shard into two new shards in the stream, to increase the stream‘s capacity to ingest and transport data.

Options

  • NewStartingHashKey<~String>: A hash key value for the starting hash key of one of the child shards created by the split.
  • ShardToSplit<~String>: The shard ID of the shard to split.
  • StreamName<~String>: The name of the stream for the shard split.

Returns

  • response<~Excon::Response>:

See Also

docs.aws.amazon.com/kinesis/latest/APIReference/API_SplitShard.html

[Validate]