Expand description
Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.
If you’re using the service, you’re probably looking for KinesisClient and Kinesis.
Structs§
- AddTags
ToStream Input Represents the input for
AddTagsToStream.- Child
Shard - Consumer
An object that represents the details of the consumer you registered. This type of object is returned by RegisterStreamConsumer.
- Consumer
Description An object that represents the details of a registered consumer. This type of object is returned by DescribeStreamConsumer.
- Create
Stream Input Represents the input for
CreateStream.- Decrease
Stream Retention Period Input Represents the input for DecreaseStreamRetentionPeriod.
- Delete
Stream Input Represents the input for DeleteStream.
- Deregister
Stream Consumer Input - Describe
Limits Input - Describe
Limits Output - Describe
Stream Consumer Input - Describe
Stream Consumer Output - Describe
Stream Input Represents the input for
DescribeStream.- Describe
Stream Output Represents the output for
DescribeStream.- Describe
Stream Summary Input - Describe
Stream Summary Output - Disable
Enhanced Monitoring Input Represents the input for DisableEnhancedMonitoring.
- Enable
Enhanced Monitoring Input Represents the input for EnableEnhancedMonitoring.
- Enhanced
Metrics Represents enhanced metrics types.
- Enhanced
Monitoring Output Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.
- Expired
Iterator Exception The provided iterator exceeds the maximum age allowed.
- Expired
Next Token Exception The pagination token passed to the operation is expired.
- GetRecords
Input Represents the input for GetRecords.
- GetRecords
Output Represents the output for GetRecords.
- GetShard
Iterator Input Represents the input for
GetShardIterator.- GetShard
Iterator Output Represents the output for
GetShardIterator.- Hash
KeyRange The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
- Increase
Stream Retention Period Input Represents the input for IncreaseStreamRetentionPeriod.
- Internal
Failure Exception The processing of the request failed because of an unknown error, exception, or failure.
- Invalid
Argument Exception A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.
- KMSAccess
Denied Exception The ciphertext references a key that doesn't exist or that you don't have access to.
- KMSDisabled
Exception The request was rejected because the specified customer master key (CMK) isn't enabled.
- KMSInvalid
State Exception The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
- KMSNot
Found Exception The request was rejected because the specified entity or resource can't be found.
- KMSOpt
InRequired The AWS access key ID needs a subscription for the service.
- KMSThrottling
Exception The request was denied due to request throttling. For more information about throttling, see Limits in the AWS Key Management Service Developer Guide.
- Kinesis
Client - A client for the Kinesis API.
- Limit
Exceeded Exception The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
- List
Shards Input - List
Shards Output - List
Stream Consumers Input - List
Stream Consumers Output - List
Streams Input Represents the input for
ListStreams.- List
Streams Output Represents the output for
ListStreams.- List
Tags ForStream Input Represents the input for
ListTagsForStream.- List
Tags ForStream Output Represents the output for
ListTagsForStream.- Merge
Shards Input Represents the input for
MergeShards.- Provisioned
Throughput Exceeded Exception The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in AWS in the AWS General Reference.
- PutRecord
Input Represents the input for
PutRecord.- PutRecord
Output Represents the output for
PutRecord.- PutRecords
Input A
PutRecordsrequest.- PutRecords
Output PutRecordsresults.- PutRecords
Request Entry Represents the output for
PutRecords.- PutRecords
Result Entry Represents the result of an individual record from a
PutRecordsrequest. A record that is successfully added to a stream includesSequenceNumberandShardIdin the result. A record that fails to be added to the stream includesErrorCodeandErrorMessagein the result.- Record
The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.
- Register
Stream Consumer Input - Register
Stream Consumer Output - Remove
Tags From Stream Input Represents the input for
RemoveTagsFromStream.- Resource
InUse Exception The resource is not available for this operation. For successful operation, the resource must be in the
ACTIVEstate.- Resource
NotFound Exception The requested resource could not be found. The stream might not be specified correctly.
- Sequence
Number Range The range of possible sequence numbers for the shard.
- Shard
A uniquely identified group of data records in a Kinesis data stream.
- Shard
Filter - Split
Shard Input Represents the input for
SplitShard.- Start
Stream Encryption Input - Starting
Position - Stop
Stream Encryption Input - Stream
Description Represents the output for DescribeStream.
- Stream
Description Summary Represents the output for DescribeStreamSummary
- Subscribe
ToShard Event After you call SubscribeToShard, Kinesis Data Streams sends events of this type over an HTTP/2 connection to your consumer.
- Subscribe
ToShard Input - Subscribe
ToShard Output - Tag
Metadata assigned to the stream, consisting of a key-value pair.
- Update
Shard Count Input - Update
Shard Count Output
Enums§
- AddTags
ToStream Error - Errors returned by AddTagsToStream
- Create
Stream Error - Errors returned by CreateStream
- Decrease
Stream Retention Period Error - Errors returned by DecreaseStreamRetentionPeriod
- Delete
Stream Error - Errors returned by DeleteStream
- Deregister
Stream Consumer Error - Errors returned by DeregisterStreamConsumer
- Describe
Limits Error - Errors returned by DescribeLimits
- Describe
Stream Consumer Error - Errors returned by DescribeStreamConsumer
- Describe
Stream Error - Errors returned by DescribeStream
- Describe
Stream Summary Error - Errors returned by DescribeStreamSummary
- Disable
Enhanced Monitoring Error - Errors returned by DisableEnhancedMonitoring
- Enable
Enhanced Monitoring Error - Errors returned by EnableEnhancedMonitoring
- GetRecords
Error - Errors returned by GetRecords
- GetShard
Iterator Error - Errors returned by GetShardIterator
- Increase
Stream Retention Period Error - Errors returned by IncreaseStreamRetentionPeriod
- List
Shards Error - Errors returned by ListShards
- List
Stream Consumers Error - Errors returned by ListStreamConsumers
- List
Streams Error - Errors returned by ListStreams
- List
Tags ForStream Error - Errors returned by ListTagsForStream
- Merge
Shards Error - Errors returned by MergeShards
- PutRecord
Error - Errors returned by PutRecord
- PutRecords
Error - Errors returned by PutRecords
- Register
Stream Consumer Error - Errors returned by RegisterStreamConsumer
- Remove
Tags From Stream Error - Errors returned by RemoveTagsFromStream
- Split
Shard Error - Errors returned by SplitShard
- Start
Stream Encryption Error - Errors returned by StartStreamEncryption
- Stop
Stream Encryption Error - Errors returned by StopStreamEncryption
- Subscribe
ToShard Error - Errors returned by SubscribeToShard
- Subscribe
ToShard Event Stream Item This is a tagged union for all of the types of events an enhanced fan-out consumer can receive over HTTP/2 after a call to SubscribeToShard.
- Update
Shard Count Error - Errors returned by UpdateShardCount
Traits§
- Kinesis
- Trait representing the capabilities of the Kinesis API. Kinesis clients implement this trait.