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

Class: Aws::Kinesis::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#stub_data, #stub_responses

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) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



152
153
154
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 152

def initialize(*args)
  super
end

Instance Method Details

#add_tags_to_stream(params = {}) ⇒ Struct

Adds or updates tags for the specified Kinesis data stream. Each stream can have up to 10 tags.

If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys.

AddTagsToStream has a limit of five transactions per second per account.

Examples:

Request syntax with placeholder values


resp = client.add_tags_to_stream({
  stream_name: "StreamName", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream.

  • :tags (required, Hash<String,String>)

    The set of key-value pairs to use to create the tags.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



189
190
191
192
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 189

def add_tags_to_stream(params = {}, options = {})
  req = build_request(:add_tags_to_stream, params)
  req.send_request(options)
end

#create_stream(params = {}) ⇒ Struct

Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.

You specify and control the number of shards that a stream is composed of. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. If the amount of data input increases or decreases, you can add or remove shards.

The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by AWS Region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different Regions, can have the same name.

CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Kinesis Data Streams immediately returns and sets the stream status to CREATING. After the stream is created, Kinesis Data Streams sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream.

You receive a LimitExceededException when making a CreateStream request when you try to do one of the following:

  • Have more than five streams in the CREATING state at any point in time.

  • Create more shards than are authorized for your account.

For the default shard limit for an AWS account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support.

You can use DescribeStream to check the stream status, which is returned in StreamStatus.

CreateStream has a limit of five transactions per second per account.

Examples:

Request syntax with placeholder values


resp = client.create_stream({
  stream_name: "StreamName", # required
  shard_count: 1, # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by AWS Region. That is, two streams in two different AWS accounts can have the same name. Two streams in the same AWS account but in two different Regions can also have the same name.

  • :shard_count (required, Integer)

    The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.

    DefaultShardLimit;

Returns:

  • (Struct)

    Returns an empty response.

See Also:



268
269
270
271
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 268

def create_stream(params = {}, options = {})
  req = build_request(:create_stream, params)
  req.send_request(options)
end

#decrease_stream_retention_period(params = {}) ⇒ Struct

Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.

This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.

Examples:

Request syntax with placeholder values


resp = client.decrease_stream_retention_period({
  stream_name: "StreamName", # required
  retention_period_hours: 1, # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream to modify.

  • :retention_period_hours (required, Integer)

    The new retention period of the stream, in hours. Must be less than the current retention period.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



301
302
303
304
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 301

def decrease_stream_retention_period(params = {}, options = {})
  req = build_request(:decrease_stream_retention_period, params)
  req.send_request(options)
end

#delete_stream(params = {}) ⇒ Struct

Deletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception ResourceNotFoundException.

If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

Note: Kinesis Data Streams might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING state until the stream deletion is complete.

When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.

You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus.

DeleteStream has a limit of five transactions per second per account.

Examples:

Request syntax with placeholder values


resp = client.delete_stream({
  stream_name: "StreamName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



342
343
344
345
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 342

def delete_stream(params = {}, options = {})
  req = build_request(:delete_stream, params)
  req.send_request(options)
end

#describe_limits(params = {}) ⇒ Types::DescribeLimitsOutput

Describes the shard limits and usage for the account.

If you update your account limits, the old limits might be returned for a few minutes.

This operation has a limit of one transaction per second per account.

Examples:

Response structure


resp.shard_limit #=> Integer
resp.open_shard_count #=> Integer

Parameters:

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

    ({})

Returns:

See Also:



368
369
370
371
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 368

def describe_limits(params = {}, options = {})
  req = build_request(:describe_limits, params)
  req.send_request(options)
end

#describe_stream(params = {}) ⇒ Types::DescribeStreamOutput

Describes the specified Kinesis data stream.

The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.

You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams Developer Guide.

There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.

This operation has a limit of 10 transactions per second per account.

Examples:

Request syntax with placeholder values


resp = client.describe_stream({
  stream_name: "StreamName", # required
  limit: 1,
  exclusive_start_shard_id: "ShardId",
})

Response structure


resp.stream_description.stream_name #=> String
resp.stream_description.stream_arn #=> String
resp.stream_description.stream_status #=> String, one of "CREATING", "DELETING", "ACTIVE", "UPDATING"
resp.stream_description.shards #=> Array
resp.stream_description.shards[0].shard_id #=> String
resp.stream_description.shards[0].parent_shard_id #=> String
resp.stream_description.shards[0].adjacent_parent_shard_id #=> String
resp.stream_description.shards[0].hash_key_range.starting_hash_key #=> String
resp.stream_description.shards[0].hash_key_range.ending_hash_key #=> String
resp.stream_description.shards[0].sequence_number_range.starting_sequence_number #=> String
resp.stream_description.shards[0].sequence_number_range.ending_sequence_number #=> String
resp.stream_description.has_more_shards #=> Boolean
resp.stream_description.retention_period_hours #=> Integer
resp.stream_description.stream_creation_timestamp #=> Time
resp.stream_description.enhanced_monitoring #=> Array
resp.stream_description.enhanced_monitoring[0].shard_level_metrics #=> Array
resp.stream_description.enhanced_monitoring[0].shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
resp.stream_description.encryption_type #=> String, one of "NONE", "KMS"
resp.stream_description.key_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream to describe.

  • :limit (Integer)

    The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

  • :exclusive_start_shard_id (String)

    The shard ID of the shard to start with.

Returns:

See Also:



447
448
449
450
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 447

def describe_stream(params = {}, options = {})
  req = build_request(:describe_stream, params)
  req.send_request(options)
end

#describe_stream_summary(params = {}) ⇒ Types::DescribeStreamSummaryOutput

Provides a summarized description of the specified Kinesis data stream without the shard list.

The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count.

Examples:

Request syntax with placeholder values


resp = client.describe_stream_summary({
  stream_name: "StreamName", # required
})

Response structure


resp.stream_description_summary.stream_name #=> String
resp.stream_description_summary.stream_arn #=> String
resp.stream_description_summary.stream_status #=> String, one of "CREATING", "DELETING", "ACTIVE", "UPDATING"
resp.stream_description_summary.retention_period_hours #=> Integer
resp.stream_description_summary.stream_creation_timestamp #=> Time
resp.stream_description_summary.enhanced_monitoring #=> Array
resp.stream_description_summary.enhanced_monitoring[0].shard_level_metrics #=> Array
resp.stream_description_summary.enhanced_monitoring[0].shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
resp.stream_description_summary.encryption_type #=> String, one of "NONE", "KMS"
resp.stream_description_summary.key_id #=> String
resp.stream_description_summary.open_shard_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream to describe.

Returns:

See Also:



490
491
492
493
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 490

def describe_stream_summary(params = {}, options = {})
  req = build_request(:describe_stream_summary, params)
  req.send_request(options)
end

#disable_enhanced_monitoring(params = {}) ⇒ Types::EnhancedMonitoringOutput

Disables enhanced monitoring.

Examples:

Request syntax with placeholder values


resp = client.disable_enhanced_monitoring({
  stream_name: "StreamName", # required
  shard_level_metrics: ["IncomingBytes"], # required, accepts IncomingBytes, IncomingRecords, OutgoingBytes, OutgoingRecords, WriteProvisionedThroughputExceeded, ReadProvisionedThroughputExceeded, IteratorAgeMilliseconds, ALL
})

Response structure


resp.stream_name #=> String
resp.current_shard_level_metrics #=> Array
resp.current_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
resp.desired_shard_level_metrics #=> Array
resp.desired_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the Kinesis data stream for which to disable enhanced monitoring.

  • :shard_level_metrics (required, Array<String>)

    List of shard-level metrics to disable.

    The following are the valid shard-level metrics. The value "ALL" disables every metric.

    • IncomingBytes

    • IncomingRecords

    • OutgoingBytes

    • OutgoingRecords

    • WriteProvisionedThroughputExceeded

    • ReadProvisionedThroughputExceeded

    • IteratorAgeMilliseconds

    • ALL

    For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

Returns:

See Also:



556
557
558
559
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 556

def disable_enhanced_monitoring(params = {}, options = {})
  req = build_request(:disable_enhanced_monitoring, params)
  req.send_request(options)
end

#enable_enhanced_monitoring(params = {}) ⇒ Types::EnhancedMonitoringOutput

Enables enhanced Kinesis data stream monitoring for shard-level metrics.

Examples:

Request syntax with placeholder values


resp = client.enable_enhanced_monitoring({
  stream_name: "StreamName", # required
  shard_level_metrics: ["IncomingBytes"], # required, accepts IncomingBytes, IncomingRecords, OutgoingBytes, OutgoingRecords, WriteProvisionedThroughputExceeded, ReadProvisionedThroughputExceeded, IteratorAgeMilliseconds, ALL
})

Response structure


resp.stream_name #=> String
resp.current_shard_level_metrics #=> Array
resp.current_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"
resp.desired_shard_level_metrics #=> Array
resp.desired_shard_level_metrics[0] #=> String, one of "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL"

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream for which to enable enhanced monitoring.

  • :shard_level_metrics (required, Array<String>)

    List of shard-level metrics to enable.

    The following are the valid shard-level metrics. The value "ALL" enables every metric.

    • IncomingBytes

    • IncomingRecords

    • OutgoingBytes

    • OutgoingRecords

    • WriteProvisionedThroughputExceeded

    • ReadProvisionedThroughputExceeded

    • IteratorAgeMilliseconds

    • ALL

    For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

Returns:

See Also:



622
623
624
625
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 622

def enable_enhanced_monitoring(params = {}, options = {})
  req = build_request(:enable_enhanced_monitoring, params)
  req.send_request(options)
end

#get_records(params = {}) ⇒ Types::GetRecordsOutput

Gets data records from a Kinesis data stream's shard.

Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. It might take multiple calls to get to a portion of the shard that contains records.

You can scale by provisioning multiple shards per stream while considering service limits (for more information, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in NextShardIterator. Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords. If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.

Each data record can be up to 1 MB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit.

The size of the data returned by GetRecords varies depending on the utilization of the shard. The maximum size of data that GetRecords can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next five seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next one second throw ProvisionedThroughputExceededException. GetRecords won't return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to GetRecords; however, it's possible that the application will get exceptions for longer than 1 second.

To detect whether the application is falling behind in processing, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon Kinesis Data Streams Developer Guide).

Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side time stamp, whereas a client-side time stamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order.

Examples:

Request syntax with placeholder values


resp = client.get_records({
  shard_iterator: "ShardIterator", # required
  limit: 1,
})

Response structure


resp.records #=> Array
resp.records[0].sequence_number #=> String
resp.records[0].approximate_arrival_timestamp #=> Time
resp.records[0].data #=> String
resp.records[0].partition_key #=> String
resp.records[0].encryption_type #=> String, one of "NONE", "KMS"
resp.next_shard_iterator #=> String
resp.millis_behind_latest #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :shard_iterator (required, String)

    The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

  • :limit (Integer)

    The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.

Returns:

See Also:



728
729
730
731
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 728

def get_records(params = {}, options = {})
  req = build_request(:get_records, params)
  req.send_request(options)
end

#get_shard_iterator(params = {}) ⇒ Types::GetShardIteratorOutput

Gets an Amazon Kinesis shard iterator. A shard iterator expires five minutes after it is returned to the requester.

A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.

You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type. Alternatively, the parameter can read right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls to PutRecord, PutRecords, GetRecords, or DescribeStream. In the request, you can specify the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST so that you always read the most recent data in the shard.

When you read repeatedly from a stream, use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard iterator is returned by every GetRecords request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords request.

If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException. For more information about throughput limits, see GetRecords, and Streams Limits in the Amazon Kinesis Data Streams Developer Guide.

If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using SplitShard or MergeShards.

GetShardIterator has a limit of five transactions per second per account per open shard.

Examples:

Request syntax with placeholder values


resp = client.get_shard_iterator({
  stream_name: "StreamName", # required
  shard_id: "ShardId", # required
  shard_iterator_type: "AT_SEQUENCE_NUMBER", # required, accepts AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER, TRIM_HORIZON, LATEST, AT_TIMESTAMP
  starting_sequence_number: "SequenceNumber",
  timestamp: Time.now,
})

Response structure


resp.shard_iterator #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the Amazon Kinesis data stream.

  • :shard_id (required, String)

    The shard ID of the Kinesis Data Streams shard to get the iterator for.

  • :shard_iterator_type (required, String)

    Determines how the shard iterator is used to start reading data records from the shard.

    The following are the valid Amazon Kinesis shard iterator types:

    • AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

    • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

    • AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

    • TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

    • LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

  • :starting_sequence_number (String)

    The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

  • :timestamp (Time, DateTime, Date, Integer, String)

    The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

Returns:

See Also:



847
848
849
850
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 847

def get_shard_iterator(params = {}, options = {})
  req = build_request(:get_shard_iterator, params)
  req.send_request(options)
end

#increase_stream_retention_period(params = {}) ⇒ Struct

Increases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours (7 days).

If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours remains inaccessible to consumer applications.

Examples:

Request syntax with placeholder values


resp = client.increase_stream_retention_period({
  stream_name: "StreamName", # required
  retention_period_hours: 1, # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream to modify.

  • :retention_period_hours (required, Integer)

    The new retention period of the stream, in hours. Must be more than the current retention period.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



886
887
888
889
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 886

def increase_stream_retention_period(params = {}, options = {})
  req = build_request(:increase_stream_retention_period, params)
  req.send_request(options)
end

#list_shards(params = {}) ⇒ Types::ListShardsOutput

Lists the shards in a stream and provides information about each shard.

This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.

Examples:

Request syntax with placeholder values


resp = client.list_shards({
  stream_name: "StreamName",
  next_token: "NextToken",
  exclusive_start_shard_id: "ShardId",
  max_results: 1,
  stream_creation_timestamp: Time.now,
})

Response structure


resp.shards #=> Array
resp.shards[0].shard_id #=> String
resp.shards[0].parent_shard_id #=> String
resp.shards[0].adjacent_parent_shard_id #=> String
resp.shards[0].hash_key_range.starting_hash_key #=> String
resp.shards[0].hash_key_range.ending_hash_key #=> String
resp.shards[0].sequence_number_range.starting_sequence_number #=> String
resp.shards[0].sequence_number_range.ending_sequence_number #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (String)

    The name of the data stream whose shards you want to list.

    You cannot specify this parameter if you specify the NextToken parameter.

  • :next_token (String)

    When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards.

    Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.

    You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of shards that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListShards operation.

    Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.

  • :exclusive_start_shard_id (String)

    The ID of the shard to start the list with.

    If you don't specify this parameter, the default behavior is for ListShards to list the shards starting with the first one in the stream.

    You cannot specify this parameter if you specify NextToken.

  • :max_results (Integer)

    The maximum number of shards to return in a single call to ListShards. The minimum value you can specify for this parameter is 1, and the maximum is 1,000, which is also the default.

    When the number of shards to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListShards to list the next set of shards.

  • :stream_creation_timestamp (Time, DateTime, Date, Integer, String)

    Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.

    You cannot specify this parameter if you specify the NextToken parameter.

Returns:

See Also:



994
995
996
997
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 994

def list_shards(params = {}, options = {})
  req = build_request(:list_shards, params)
  req.send_request(options)
end

#list_streams(params = {}) ⇒ Types::ListStreamsOutput

Lists your Kinesis data streams.

The number of streams may be too large to return from a single call to ListStreams. You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Kinesis Data Streams uses the default limit, which is currently 10.

You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.

ListStreams has a limit of five transactions per second per account.

Examples:

Request syntax with placeholder values


resp = client.list_streams({
  limit: 1,
  exclusive_start_stream_name: "StreamName",
})

Response structure


resp.stream_names #=> Array
resp.stream_names[0] #=> String
resp.has_more_streams #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :limit (Integer)

    The maximum number of streams to list.

  • :exclusive_start_stream_name (String)

    The name of the stream to start the list with.

Returns:

See Also:



1046
1047
1048
1049
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 1046

def list_streams(params = {}, options = {})
  req = build_request(:list_streams, params)
  req.send_request(options)
end

#list_tags_for_stream(params = {}) ⇒ Types::ListTagsForStreamOutput

Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_stream({
  stream_name: "StreamName", # required
  exclusive_start_tag_key: "TagKey",
  limit: 1,
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
resp.has_more_tags #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream.

  • :exclusive_start_tag_key (String)

    The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.

  • :limit (Integer)

    The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

Returns:

See Also:



1092
1093
1094
1095
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 1092

def list_tags_for_stream(params = {}, options = {})
  req = build_request(:list_tags_for_stream, params)
  req.send_request(options)
end

#merge_shards(params = {}) ⇒ Struct

Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.

MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards in the Amazon Kinesis Data Streams Developer Guide.

If the stream is in the ACTIVE state, you can call MergeShards. If a stream is in the CREATING, UPDATING, or DELETING state, MergeShards returns a ResourceInUseException. If the specified stream does not exist, MergeShards returns a ResourceNotFoundException.

You can use DescribeStream to check the state of the stream, which is returned in StreamStatus.

MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis Data Streams immediately returns a response and sets the StreamStatus to UPDATING. After the operation is completed, Kinesis Data Streams sets the StreamStatus to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.

You use DescribeStream to determine the shard IDs that are specified in the MergeShards request.

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards, or SplitShard, you receive a LimitExceededException.

MergeShards has a limit of five transactions per second per account.

Examples:

Request syntax with placeholder values


resp = client.merge_shards({
  stream_name: "StreamName", # required
  shard_to_merge: "ShardId", # required
  adjacent_shard_to_merge: "ShardId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream for the merge.

  • :shard_to_merge (required, String)

    The shard ID of the shard to combine with the adjacent shard for the merge.

  • :adjacent_shard_to_merge (required, String)

    The shard ID of the adjacent shard for the merge.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1167
1168
1169
1170
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 1167

def merge_shards(params = {}, options = {})
  req = build_request(:merge_shards, params)
  req.send_request(options)
end

#put_record(params = {}) ⇒ Types::PutRecordOutput

Writes a single data record into an Amazon Kinesis data stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

The partition key is used by Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs.

Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.

PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.

Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.

If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException.

By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

Examples:

Request syntax with placeholder values


resp = client.put_record({
  stream_name: "StreamName", # required
  data: "data", # required
  partition_key: "PartitionKey", # required
  explicit_hash_key: "HashKey",
  sequence_number_for_ordering: "SequenceNumber",
})

Response structure


resp.shard_id #=> String
resp.sequence_number #=> String
resp.encryption_type #=> String, one of "NONE", "KMS"

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream to put the data record into.

  • :data (required, String, IO)

    The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

  • :partition_key (required, String)

    Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

  • :explicit_hash_key (String)

    The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.

  • :sequence_number_for_ordering (String)

    Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the result when putting record n-1). If this parameter is not set, records are coarsely ordered based on arrival time.

Returns:

See Also:



1281
1282
1283
1284
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 1281

def put_record(params = {}, options = {})
  req = build_request(:put_record, params)
  req.send_request(options)
end

#put_records(params = {}) ⇒ Types::PutRecordsOutput

Writes multiple data records into a Kinesis data stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the stream for data ingestion and processing.

Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

The partition key is used by Kinesis Data Streams as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.

Each record in the Records array may include an optional parameter, ExplicitHashKey, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.

The PutRecords response includes an array of response Records. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array.

The response Records array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records.

A successfully processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream.

An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.

By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

Examples:

Request syntax with placeholder values


resp = client.put_records({
  records: [ # required
    {
      data: "data", # required
      explicit_hash_key: "HashKey",
      partition_key: "PartitionKey", # required
    },
  ],
  stream_name: "StreamName", # required
})

Response structure


resp.failed_record_count #=> Integer
resp.records #=> Array
resp.records[0].sequence_number #=> String
resp.records[0].shard_id #=> String
resp.records[0].error_code #=> String
resp.records[0].error_message #=> String
resp.encryption_type #=> String, one of "NONE", "KMS"

Parameters:

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

    ({})

Options Hash (params):

  • :records (required, Array<Types::PutRecordsRequestEntry>)

    The records associated with the request.

  • :stream_name (required, String)

    The stream name associated with the request.

Returns:

See Also:



1400
1401
1402
1403
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 1400

def put_records(params = {}, options = {})
  req = build_request(:put_records, params)
  req.send_request(options)
end

#remove_tags_from_stream(params = {}) ⇒ Struct

Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.

If you specify a tag that does not exist, it is ignored.

RemoveTagsFromStream has a limit of five transactions per second per account.

Examples:

Request syntax with placeholder values


resp = client.remove_tags_from_stream({
  stream_name: "StreamName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream.

  • :tag_keys (required, Array<String>)

    A list of tag keys. Each corresponding tag is removed from the stream.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1433
1434
1435
1436
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 1433

def remove_tags_from_stream(params = {}, options = {})
  req = build_request(:remove_tags_from_stream, params)
  req.send_request(options)
end

#split_shard(params = {}) ⇒ Struct

Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested.

You can also use SplitShard when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard to increase stream capacity, so that more Kinesis Data Streams applications can simultaneously read data from the stream for real-time processing.

You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information, see Split a Shard in the Amazon Kinesis Data Streams Developer Guide.

You can use DescribeStream to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request.

SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Kinesis Data Streams immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Kinesis Data Streams sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.

You can use DescribeStream to check the status of the stream, which is returned in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard. If a stream is in CREATING or UPDATING or DELETING states, DescribeStream returns a ResourceInUseException.

If the specified stream does not exist, DescribeStream returns a ResourceNotFoundException. If you try to create more shards than are authorized for your account, you receive a LimitExceededException.

For the default shard limit for an AWS account, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support.

If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException.

SplitShard has a limit of five transactions per second per account.

Examples:

Request syntax with placeholder values


resp = client.split_shard({
  stream_name: "StreamName", # required
  shard_to_split: "ShardId", # required
  new_starting_hash_key: "HashKey", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream for the shard split.

  • :shard_to_split (required, String)

    The shard ID of the shard to split.

  • :new_starting_hash_key (required, String)

    A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1525
1526
1527
1528
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 1525

def split_shard(params = {}, options = {})
  req = build_request(:split_shard, params)
  req.send_request(options)
end

#start_stream_encryption(params = {}) ⇒ Struct

Enables or updates server-side encryption using an AWS KMS key for a specified stream.

Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, encryption begins for records written to the stream.

API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period.

Note: It can take up to five seconds after the stream is in an ACTIVE status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from PutRecord or PutRecords.

Examples:

Request syntax with placeholder values


resp = client.start_stream_encryption({
  stream_name: "StreamName", # required
  encryption_type: "NONE", # required, accepts NONE, KMS
  key_id: "KeyId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream for which to start encrypting records.

  • :encryption_type (required, String)

    The encryption type to use. The only valid value is KMS.

  • :key_id (required, String)

    The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

    • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

    • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

    • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

    • Alias name example: alias/MyAliasName

    • Master key owned by Kinesis Data Streams: alias/aws/kinesis

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1591
1592
1593
1594
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 1591

def start_stream_encryption(params = {}, options = {})
  req = build_request(:start_stream_encryption, params)
  req.send_request(options)
end

#stop_stream_encryption(params = {}) ⇒ Struct

Disables server-side encryption for a specified stream.

Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, records written to the stream are no longer encrypted by Kinesis Data Streams.

API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period.

Note: It can take up to five seconds after the stream is in an ACTIVE status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response from PutRecord or PutRecords.

Examples:

Request syntax with placeholder values


resp = client.stop_stream_encryption({
  stream_name: "StreamName", # required
  encryption_type: "NONE", # required, accepts NONE, KMS
  key_id: "KeyId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream on which to stop encrypting records.

  • :encryption_type (required, String)

    The encryption type. The only valid value is KMS.

  • :key_id (required, String)

    The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

    • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

    • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

    • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

    • Alias name example: alias/MyAliasName

    • Master key owned by Kinesis Data Streams: alias/aws/kinesis

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1657
1658
1659
1660
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 1657

def stop_stream_encryption(params = {}, options = {})
  req = build_request(:stop_stream_encryption, params)
  req.send_request(options)
end

#update_shard_count(params = {}) ⇒ Types::UpdateShardCountOutput

Updates the shard count of the specified stream to the specified number of shards.

Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is UPDATING.

To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. We recommend that you double or halve the shard count, as this results in the fewest number of splits or merges.

This operation has the following limits. You cannot do the following:

  • Scale more than twice per rolling 24-hour period per stream

  • Scale up to more than double your current shard count for a stream

  • Scale down below half your current shard count for a stream

  • Scale up to more than 500 shards in a stream

  • Scale a stream with more than 500 shards down unless the result is less than 500 shards

  • Scale up to more than the shard limit for your account

For the default limits for an AWS account, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the limits form.

Examples:

Request syntax with placeholder values


resp = client.update_shard_count({
  stream_name: "StreamName", # required
  target_shard_count: 1, # required
  scaling_type: "UNIFORM_SCALING", # required, accepts UNIFORM_SCALING
})

Response structure


resp.stream_name #=> String
resp.current_shard_count #=> Integer
resp.target_shard_count #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :stream_name (required, String)

    The name of the stream.

  • :target_shard_count (required, Integer)

    The new number of shards.

  • :scaling_type (required, String)

    The scaling type. Uniform scaling creates shards of equal size.

Returns:

See Also:



1737
1738
1739
1740
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 1737

def update_shard_count(params = {}, options = {})
  req = build_request(:update_shard_count, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
stream_exists #describe_stream 10 18
stream_not_exists #describe_stream 10 18

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {})

    ({})

  • options (Hash) (defaults to: {})

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.



1848
1849
1850
1851
1852
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/client.rb', line 1848

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end