2026/02/03 - Amazon Kinesis - 34 updated api methods
Changes Adds StreamId parameter to AWS Kinesis Data Streams APIs that is reserved for future use.
{'StreamId': 'string'}
Adds or updates tags for the specified Kinesis data stream. You can assign up to 50 tags to a data stream.
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.
See also: AWS API Documentation
Request Syntax
client.add_tags_to_stream(
StreamName='string',
Tags={
'string': 'string'
},
StreamARN='string',
StreamId='string'
)
string
The name of the stream.
dict
[REQUIRED]
A set of up to 50 key-value pairs to use to create the tags. A tag consists of a required key and an optional value. You can add up to 50 tags per resource.
(string) --
(string) --
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
None
{'StreamId': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.decrease_stream_retention_period(
StreamName='string',
RetentionPeriodHours=123,
StreamARN='string',
StreamId='string'
)
string
The name of the stream to modify.
integer
[REQUIRED]
The new retention period of the stream, in hours. Must be less than the current retention period.
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
None
{'StreamId': 'string'}
Delete a policy for the specified data stream or consumer. Request patterns can be one of the following:
Data stream pattern: arn:aws.*:kinesis:.*:\d{12}:.*stream/\S+
Consumer pattern: ^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+
See also: AWS API Documentation
Request Syntax
client.delete_resource_policy(
ResourceARN='string',
StreamId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the data stream or consumer.
string
Not Implemented. Reserved for future use.
None
{'StreamId': 'string'}
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 DescribeStreamSummary operation to check the state of the stream, which is returned in StreamStatus.
DeleteStream has a limit of five transactions per second per account.
See also: AWS API Documentation
Request Syntax
client.delete_stream(
StreamName='string',
EnforceConsumerDeletion=True|False,
StreamARN='string',
StreamId='string'
)
string
The name of the stream to delete.
boolean
If this parameter is unset ( null) or if you set it to false, and the stream has registered consumers, the call to DeleteStream fails with a ResourceInUseException.
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
None
{'StreamId': 'string'}
To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its name and ARN.
This operation has a limit of five transactions per second per stream.
See also: AWS API Documentation
Request Syntax
client.deregister_stream_consumer(
StreamARN='string',
ConsumerName='string',
ConsumerARN='string',
StreamId='string'
)
string
The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
string
The name that you gave to the consumer.
string
The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.
string
Not Implemented. Reserved for future use.
None
{'StreamId': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.describe_stream(
StreamName='string',
Limit=123,
ExclusiveStartShardId='string',
StreamARN='string',
StreamId='string'
)
string
The name of the stream to describe.
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 results are returned.
string
The shard ID of the shard to start with.
Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID immediately follows ExclusiveStartShardId.
If you don't specify this parameter, the default behavior for DescribeStream is to describe the stream starting with the first shard in the stream.
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
dict
Response Syntax
{
'StreamDescription': {
'StreamName': 'string',
'StreamARN': 'string',
'StreamStatus': 'CREATING'|'DELETING'|'ACTIVE'|'UPDATING',
'StreamModeDetails': {
'StreamMode': 'PROVISIONED'|'ON_DEMAND'
},
'Shards': [
{
'ShardId': 'string',
'ParentShardId': 'string',
'AdjacentParentShardId': 'string',
'HashKeyRange': {
'StartingHashKey': 'string',
'EndingHashKey': 'string'
},
'SequenceNumberRange': {
'StartingSequenceNumber': 'string',
'EndingSequenceNumber': 'string'
}
},
],
'HasMoreShards': True|False,
'RetentionPeriodHours': 123,
'StreamCreationTimestamp': datetime(2015, 1, 1),
'EnhancedMonitoring': [
{
'ShardLevelMetrics': [
'IncomingBytes'|'IncomingRecords'|'OutgoingBytes'|'OutgoingRecords'|'WriteProvisionedThroughputExceeded'|'ReadProvisionedThroughputExceeded'|'IteratorAgeMilliseconds'|'ALL',
]
},
],
'EncryptionType': 'NONE'|'KMS',
'KeyId': 'string'
}
}
Response Structure
(dict) --
Represents the output for DescribeStream.
StreamDescription (dict) --
The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the stream, and whether there are more shards available.
StreamName (string) --
The name of the stream being described.
StreamARN (string) --
The Amazon Resource Name (ARN) for the stream being described.
StreamStatus (string) --
The current status of the stream being described. The stream status is one of the following states:
CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.
DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.
ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.
UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.
StreamModeDetails (dict) --
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
StreamMode (string) --
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
Shards (list) --
The shards that comprise the stream.
(dict) --
A uniquely identified group of data records in a Kinesis data stream.
ShardId (string) --
The unique identifier of the shard within the stream.
ParentShardId (string) --
The shard ID of the shard's parent.
AdjacentParentShardId (string) --
The shard ID of the shard adjacent to the shard's parent.
HashKeyRange (dict) --
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
StartingHashKey (string) --
The starting hash key of the hash key range.
EndingHashKey (string) --
The ending hash key of the hash key range.
SequenceNumberRange (dict) --
The range of possible sequence numbers for the shard.
StartingSequenceNumber (string) --
The starting sequence number for the range.
EndingSequenceNumber (string) --
The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.
HasMoreShards (boolean) --
If set to true, more shards in the stream are available to describe.
RetentionPeriodHours (integer) --
The current retention period, in hours. Minimum value of 24. Maximum value of 168.
StreamCreationTimestamp (datetime) --
The approximate time that the stream was created.
EnhancedMonitoring (list) --
Represents the current enhanced monitoring settings of the stream.
(dict) --
Represents enhanced metrics types.
ShardLevelMetrics (list) --
List of shard-level metrics.
The following are the valid shard-level metrics. The value " ALL" enhances 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.
(string) --
EncryptionType (string) --
The server-side encryption type used on the stream. This parameter can be one of the following values:
NONE: Do not encrypt the records in the stream.
KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.
KeyId (string) --
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally unique identifier, a fully specified 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
{'StreamId': 'string'}
To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to describe, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream.
This operation has a limit of 20 transactions per second per stream.
See also: AWS API Documentation
Request Syntax
client.describe_stream_consumer(
StreamARN='string',
ConsumerName='string',
ConsumerARN='string',
StreamId='string'
)
string
The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
string
The name that you gave to the consumer.
string
The ARN returned by Kinesis Data Streams when you registered the consumer.
string
Not Implemented. Reserved for future use.
dict
Response Syntax
{
'ConsumerDescription': {
'ConsumerName': 'string',
'ConsumerARN': 'string',
'ConsumerStatus': 'CREATING'|'DELETING'|'ACTIVE',
'ConsumerCreationTimestamp': datetime(2015, 1, 1),
'StreamARN': 'string'
}
}
Response Structure
(dict) --
ConsumerDescription (dict) --
An object that represents the details of the consumer.
ConsumerName (string) --
The name of the consumer is something you choose when you register the consumer.
ConsumerARN (string) --
When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.
If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.
ConsumerStatus (string) --
A consumer can't read data while in the CREATING or DELETING states.
ConsumerCreationTimestamp (datetime) --
StreamARN (string) --
The ARN of the stream with which you registered the consumer.
{'StreamId': 'string'}
Response {'StreamDescriptionSummary': {'StreamId': 'string'}}
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.
DescribeStreamSummary has a limit of 20 transactions per second per account.
See also: AWS API Documentation
Request Syntax
client.describe_stream_summary(
StreamName='string',
StreamARN='string',
StreamId='string'
)
string
The name of the stream to describe.
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
dict
Response Syntax
{
'StreamDescriptionSummary': {
'StreamName': 'string',
'StreamARN': 'string',
'StreamId': 'string',
'StreamStatus': 'CREATING'|'DELETING'|'ACTIVE'|'UPDATING',
'StreamModeDetails': {
'StreamMode': 'PROVISIONED'|'ON_DEMAND'
},
'RetentionPeriodHours': 123,
'StreamCreationTimestamp': datetime(2015, 1, 1),
'EnhancedMonitoring': [
{
'ShardLevelMetrics': [
'IncomingBytes'|'IncomingRecords'|'OutgoingBytes'|'OutgoingRecords'|'WriteProvisionedThroughputExceeded'|'ReadProvisionedThroughputExceeded'|'IteratorAgeMilliseconds'|'ALL',
]
},
],
'EncryptionType': 'NONE'|'KMS',
'KeyId': 'string',
'OpenShardCount': 123,
'ConsumerCount': 123,
'WarmThroughput': {
'TargetMiBps': 123,
'CurrentMiBps': 123
},
'MaxRecordSizeInKiB': 123
}
}
Response Structure
(dict) --
StreamDescriptionSummary (dict) --
A StreamDescriptionSummary containing information about the stream.
StreamName (string) --
The name of the stream being described.
StreamARN (string) --
The Amazon Resource Name (ARN) for the stream being described.
StreamId (string) --
Not Implemented. Reserved for future use.
StreamStatus (string) --
The current status of the stream being described. The stream status is one of the following states:
CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.
DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.
ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.
UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.
StreamModeDetails (dict) --
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand ycapacity mode and a provisioned capacity mode for your data streams.
StreamMode (string) --
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
RetentionPeriodHours (integer) --
The current retention period, in hours.
StreamCreationTimestamp (datetime) --
The approximate time that the stream was created.
EnhancedMonitoring (list) --
Represents the current enhanced monitoring settings of the stream.
(dict) --
Represents enhanced metrics types.
ShardLevelMetrics (list) --
List of shard-level metrics.
The following are the valid shard-level metrics. The value " ALL" enhances 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.
(string) --
EncryptionType (string) --
The encryption type used. This value is one of the following:
KMS
NONE
KeyId (string) --
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally unique identifier, a fully specified 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
OpenShardCount (integer) --
The number of open shards in the stream.
ConsumerCount (integer) --
The number of enhanced fan-out consumers registered with the stream.
WarmThroughput (dict) --
The warm throughput in MB/s for the stream. This represents the throughput capacity that will be immediately available for write operations.
TargetMiBps (integer) --
The target warm throughput value on the stream. This indicates that the stream is currently scaling towards this target value.
CurrentMiBps (integer) --
The current warm throughput value on the stream. This is the write throughput in MiBps that the stream is currently scaled to handle.
MaxRecordSizeInKiB (integer) --
The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.
{'StreamId': 'string'}
Disables enhanced monitoring.
See also: AWS API Documentation
Request Syntax
client.disable_enhanced_monitoring(
StreamName='string',
ShardLevelMetrics=[
'IncomingBytes'|'IncomingRecords'|'OutgoingBytes'|'OutgoingRecords'|'WriteProvisionedThroughputExceeded'|'ReadProvisionedThroughputExceeded'|'IteratorAgeMilliseconds'|'ALL',
],
StreamARN='string',
StreamId='string'
)
string
The name of the Kinesis data stream for which to disable enhanced monitoring.
list
[REQUIRED]
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.
(string) --
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
dict
Response Syntax
{
'StreamName': 'string',
'CurrentShardLevelMetrics': [
'IncomingBytes'|'IncomingRecords'|'OutgoingBytes'|'OutgoingRecords'|'WriteProvisionedThroughputExceeded'|'ReadProvisionedThroughputExceeded'|'IteratorAgeMilliseconds'|'ALL',
],
'DesiredShardLevelMetrics': [
'IncomingBytes'|'IncomingRecords'|'OutgoingBytes'|'OutgoingRecords'|'WriteProvisionedThroughputExceeded'|'ReadProvisionedThroughputExceeded'|'IteratorAgeMilliseconds'|'ALL',
],
'StreamARN': 'string'
}
Response Structure
(dict) --
Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.
StreamName (string) --
The name of the Kinesis data stream.
CurrentShardLevelMetrics (list) --
Represents the current state of the metrics that are in the enhanced state before the operation.
(string) --
DesiredShardLevelMetrics (list) --
Represents the list of all the metrics that would be in the enhanced state after the operation.
(string) --
StreamARN (string) --
The ARN of the stream.
{'StreamId': 'string'}
Enables enhanced Kinesis data stream monitoring for shard-level metrics.
See also: AWS API Documentation
Request Syntax
client.enable_enhanced_monitoring(
StreamName='string',
ShardLevelMetrics=[
'IncomingBytes'|'IncomingRecords'|'OutgoingBytes'|'OutgoingRecords'|'WriteProvisionedThroughputExceeded'|'ReadProvisionedThroughputExceeded'|'IteratorAgeMilliseconds'|'ALL',
],
StreamARN='string',
StreamId='string'
)
string
The name of the stream for which to enable enhanced monitoring.
list
[REQUIRED]
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.
(string) --
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
dict
Response Syntax
{
'StreamName': 'string',
'CurrentShardLevelMetrics': [
'IncomingBytes'|'IncomingRecords'|'OutgoingBytes'|'OutgoingRecords'|'WriteProvisionedThroughputExceeded'|'ReadProvisionedThroughputExceeded'|'IteratorAgeMilliseconds'|'ALL',
],
'DesiredShardLevelMetrics': [
'IncomingBytes'|'IncomingRecords'|'OutgoingBytes'|'OutgoingRecords'|'WriteProvisionedThroughputExceeded'|'ReadProvisionedThroughputExceeded'|'IteratorAgeMilliseconds'|'ALL',
],
'StreamARN': 'string'
}
Response Structure
(dict) --
Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.
StreamName (string) --
The name of the Kinesis data stream.
CurrentShardLevelMetrics (list) --
Represents the current state of the metrics that are in the enhanced state before the operation.
(string) --
DesiredShardLevelMetrics (list) --
Represents the list of all the metrics that would be in the enhanced state after the operation.
(string) --
StreamARN (string) --
The ARN of the stream.
{'StreamId': 'string'}
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 MiB in size, and each shard can read up to 2 MiB 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 maximum number of records that can be returned per call is 10,000.
The size of the data returned by GetRecords varies depending on the utilization of the shard. It is recommended that consumer applications retrieve records via the GetRecords command using the 5 TPS limit to remain caught up. Retrieving records less frequently can lead to consumer applications falling behind. The maximum size of data that GetRecords can return is 10 MiB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next 1 second throw ProvisionedThroughputExceededException. GetRecords doesn't return any data when it throws an exception. For this reason, we recommend that you wait 1 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.
This operation has a limit of five transactions per second per shard.
See also: AWS API Documentation
Request Syntax
client.get_records(
ShardIterator='string',
Limit=123,
StreamARN='string',
StreamId='string'
)
string
[REQUIRED]
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.
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. The default value is 10,000.
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
dict
Response Syntax
{
'Records': [
{
'SequenceNumber': 'string',
'ApproximateArrivalTimestamp': datetime(2015, 1, 1),
'Data': b'bytes',
'PartitionKey': 'string',
'EncryptionType': 'NONE'|'KMS'
},
],
'NextShardIterator': 'string',
'MillisBehindLatest': 123,
'ChildShards': [
{
'ShardId': 'string',
'ParentShards': [
'string',
],
'HashKeyRange': {
'StartingHashKey': 'string',
'EndingHashKey': 'string'
}
},
]
}
Response Structure
(dict) --
Represents the output for GetRecords.
Records (list) --
The data records retrieved from the shard.
(dict) --
The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.
SequenceNumber (string) --
The unique identifier of the record within its shard.
ApproximateArrivalTimestamp (datetime) --
The approximate time that the record was inserted into the stream.
Data (bytes) --
The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. 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 MiB).
PartitionKey (string) --
Identifies which shard in the stream the data record is assigned to.
EncryptionType (string) --
The encryption type used on the record. This parameter can be one of the following values:
NONE: Do not encrypt the records in the stream.
KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.
NextShardIterator (string) --
The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.
MillisBehindLatest (integer) --
The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.
ChildShards (list) --
The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.
(dict) --
Output parameter of the GetRecords API. The existing child shard of the current shard.
ShardId (string) --
The shard ID of the existing child shard of the current shard.
ParentShards (list) --
The current shard that is the parent of the existing child shard.
(string) --
HashKeyRange (dict) --
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
StartingHashKey (string) --
The starting hash key of the hash key range.
EndingHashKey (string) --
The ending hash key of the hash key range.
{'StreamId': 'string'}
Returns a policy attached to the specified data stream or consumer. Request patterns can be one of the following:
Data stream pattern: arn:aws.*:kinesis:.*:\d{12}:.*stream/\S+
Consumer pattern: ^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+
See also: AWS API Documentation
Request Syntax
client.get_resource_policy(
ResourceARN='string',
StreamId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the data stream or consumer.
string
Not Implemented. Reserved for future use.
dict
Response Syntax
{
'Policy': 'string'
}
Response Structure
(dict) --
Policy (string) --
Details of the resource policy. This is formatted as a JSON string.
{'StreamId': 'string'}
Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 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.
See also: AWS API Documentation
Request Syntax
client.get_shard_iterator(
StreamName='string',
ShardId='string',
ShardIteratorType='AT_SEQUENCE_NUMBER'|'AFTER_SEQUENCE_NUMBER'|'TRIM_HORIZON'|'LATEST'|'AT_TIMESTAMP',
StartingSequenceNumber='string',
Timestamp=datetime(2015, 1, 1),
StreamARN='string',
StreamId='string'
)
string
The name of the Amazon Kinesis data stream.
string
[REQUIRED]
The shard ID of the Kinesis Data Streams shard to get the iterator for.
string
[REQUIRED]
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.
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.
datetime
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).
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
dict
Response Syntax
{
'ShardIterator': 'string'
}
Response Structure
(dict) --
Represents the output for GetShardIterator.
ShardIterator (string) --
The position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard.
{'StreamId': 'string'}
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 8760 hours (365 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.
See also: AWS API Documentation
Request Syntax
client.increase_stream_retention_period(
StreamName='string',
RetentionPeriodHours=123,
StreamARN='string',
StreamId='string'
)
string
The name of the stream to modify.
integer
[REQUIRED]
The new retention period of the stream, in hours. Must be more than the current retention period.
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
None
{'StreamId': 'string'}
Lists the shards in a stream and provides information about each shard. This operation has a limit of 1000 transactions per second per data stream.
This action does not list expired shards. For information about expired shards, see Data Routing, Data Persistence, and Shard State after a Reshard.
See also: AWS API Documentation
Request Syntax
client.list_shards(
StreamName='string',
NextToken='string',
ExclusiveStartShardId='string',
MaxResults=123,
StreamCreationTimestamp=datetime(2015, 1, 1),
ShardFilter={
'Type': 'AFTER_SHARD_ID'|'AT_TRIM_HORIZON'|'FROM_TRIM_HORIZON'|'AT_LATEST'|'AT_TIMESTAMP'|'FROM_TIMESTAMP',
'ShardId': 'string',
'Timestamp': datetime(2015, 1, 1)
},
StreamARN='string',
StreamId='string'
)
string
The name of the data stream whose shards you want to list.
You cannot specify this parameter if you specify the NextToken parameter.
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.
string
Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately follows ExclusiveStartShardId.
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.
integer
The maximum number of shards to return in a single call to ListShards. The maximum number of shards to return in a single call. The default value is 1000. If you specify a value greater than 1000, at most 1000 results are returned.
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.
datetime
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.
dict
Enables you to filter out the response of the ListShards API. You can only specify one filter at a time.
If you use the ShardFilter parameter when invoking the ListShards API, the Type is the required property and must be specified. If you specify the AT_TRIM_HORIZON, FROM_TRIM_HORIZON, or AT_LATEST types, you do not need to specify either the ShardId or the Timestamp optional properties.
If you specify the AFTER_SHARD_ID type, you must also provide the value for the optional ShardId property. The ShardId property is identical in fuctionality to the ExclusiveStartShardId parameter of the ListShards API. When ShardId property is specified, the response includes the shards starting with the shard whose ID immediately follows the ShardId that you provided.
If you specify the AT_TIMESTAMP or FROM_TIMESTAMP_ID type, you must also provide the value for the optional Timestamp property. If you specify the AT_TIMESTAMP type, then all shards that were open at the provided timestamp are returned. If you specify the FROM_TIMESTAMP type, then all shards starting from the provided timestamp to TIP are returned.
Type (string) -- [REQUIRED]
The shard type specified in the ShardFilter parameter. This is a required property of the ShardFilter parameter.
You can specify the following valid values:
AFTER_SHARD_ID - the response includes all the shards, starting with the shard whose ID immediately follows the ShardId that you provided.
AT_TRIM_HORIZON - the response includes all the shards that were open at TRIM_HORIZON.
FROM_TRIM_HORIZON - (default), the response includes all the shards within the retention period of the data stream (trim to tip).
AT_LATEST - the response includes only the currently open shards of the data stream.
AT_TIMESTAMP - the response includes all shards whose start timestamp is less than or equal to the given timestamp and end timestamp is greater than or equal to the given timestamp or still open.
FROM_TIMESTAMP - the response incldues all closed shards whose end timestamp is greater than or equal to the given timestamp and also all open shards. Corrected to TRIM_HORIZON of the data stream if FROM_TIMESTAMP is less than the TRIM_HORIZON value.
ShardId (string) --
The exclusive start shardID speified in the ShardFilter parameter. This property can only be used if the AFTER_SHARD_ID shard type is specified.
Timestamp (datetime) --
The timestamps specified in the ShardFilter parameter. A timestamp is a Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. This property can only be used if FROM_TIMESTAMP or AT_TIMESTAMP shard types are specified.
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
dict
Response Syntax
{
'Shards': [
{
'ShardId': 'string',
'ParentShardId': 'string',
'AdjacentParentShardId': 'string',
'HashKeyRange': {
'StartingHashKey': 'string',
'EndingHashKey': 'string'
},
'SequenceNumberRange': {
'StartingSequenceNumber': 'string',
'EndingSequenceNumber': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Shards (list) --
An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.
(dict) --
A uniquely identified group of data records in a Kinesis data stream.
ShardId (string) --
The unique identifier of the shard within the stream.
ParentShardId (string) --
The shard ID of the shard's parent.
AdjacentParentShardId (string) --
The shard ID of the shard adjacent to the shard's parent.
HashKeyRange (dict) --
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
StartingHashKey (string) --
The starting hash key of the hash key range.
EndingHashKey (string) --
The ending hash key of the hash key range.
SequenceNumberRange (dict) --
The range of possible sequence numbers for the shard.
StartingSequenceNumber (string) --
The starting sequence number for the range.
EndingSequenceNumber (string) --
The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.
NextToken (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. For more information about the use of this pagination token when calling the ListShards operation, see ListShardsInput$NextToken.
{'StreamId': 'string'}
Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer.
This operation has a limit of 5 transactions per second per stream.
See also: AWS API Documentation
Request Syntax
client.list_stream_consumers(
StreamARN='string',
NextToken='string',
MaxResults=123,
StreamCreationTimestamp=datetime(2015, 1, 1),
StreamId='string'
)
string
[REQUIRED]
The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
string
When the number of consumers that are registered with 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 consumers that are registered with the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers.
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 consumers 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 ListStreamConsumers operation to list the next set of consumers.
integer
The maximum number of consumers that you want a single call of ListStreamConsumers to return. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.
datetime
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 consumers for.
You can't specify this parameter if you specify the NextToken parameter.
string
Not Implemented. Reserved for future use.
dict
Response Syntax
{
'Consumers': [
{
'ConsumerName': 'string',
'ConsumerARN': 'string',
'ConsumerStatus': 'CREATING'|'DELETING'|'ACTIVE',
'ConsumerCreationTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Consumers (list) --
An array of JSON objects. Each object represents one registered consumer.
(dict) --
An object that represents the details of the consumer you registered. This type of object is returned by RegisterStreamConsumer.
ConsumerName (string) --
The name of the consumer is something you choose when you register the consumer.
ConsumerARN (string) --
When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.
If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.
ConsumerStatus (string) --
A consumer can't read data while in the CREATING or DELETING states.
ConsumerCreationTimestamp (datetime) --
NextToken (string) --
When the number of consumers that are registered with 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 registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.
{'StreamId': 'string'}
List all tags added to the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources.
For more information about tagging Kinesis resources, see Tag your Amazon Kinesis Data Streams resources.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceARN='string',
StreamId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Kinesis resource for which to list tags.
string
Not Implemented. Reserved for future use.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Tags (list) --
An array of tags associated with the specified Kinesis resource.
(dict) --
Metadata assigned to the stream or consumer, consisting of a key-value pair.
Key (string) --
A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
Value (string) --
An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
{'StreamId': 'string'}
Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_stream(
StreamName='string',
ExclusiveStartTagKey='string',
Limit=123,
StreamARN='string',
StreamId='string'
)
string
The name of the stream.
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.
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.
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'HasMoreTags': True|False
}
Response Structure
(dict) --
Represents the output for ListTagsForStream.
Tags (list) --
A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.
(dict) --
Metadata assigned to the stream or consumer, consisting of a key-value pair.
Key (string) --
A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
Value (string) --
An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @
HasMoreTags (boolean) --
If set to true, more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.
{'StreamId': 'string'}
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. This API is only supported for the data streams with the provisioned capacity mode. 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.
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 DescribeStreamSummary 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 DescribeStreamSummary and the ListShards APIs 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.
See also: AWS API Documentation
Request Syntax
client.merge_shards(
StreamName='string',
ShardToMerge='string',
AdjacentShardToMerge='string',
StreamARN='string',
StreamId='string'
)
string
The name of the stream for the merge.
string
[REQUIRED]
The shard ID of the shard to combine with the adjacent shard for the merge.
string
[REQUIRED]
The shard ID of the adjacent shard for the merge.
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
None
{'StreamId': 'string'}
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 10 MiB 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.
See also: AWS API Documentation
Request Syntax
client.put_record(
StreamName='string',
Data=b'bytes',
PartitionKey='string',
ExplicitHashKey='string',
SequenceNumberForOrdering='string',
StreamARN='string',
StreamId='string'
)
string
The name of the stream to put the data record into.
bytes
[REQUIRED]
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 (10 MiB).
string
[REQUIRED]
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.
string
The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
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.
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
dict
Response Syntax
{
'ShardId': 'string',
'SequenceNumber': 'string',
'EncryptionType': 'NONE'|'KMS'
}
Response Structure
(dict) --
Represents the output for PutRecord.
ShardId (string) --
The shard ID of the shard where the data record was placed.
SequenceNumber (string) --
The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.
EncryptionType (string) --
The encryption type to use on the record. This parameter can be one of the following values:
NONE: Do not encrypt the records in the stream.
KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.
{'StreamId': 'string'}
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 10 MiB, up to a limit of 10 MiB 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. As a result, PutRecords doesn't guarantee the ordering of records. If you need to read records in the same order they are written to the stream, use PutRecord instead of PutRecords, and write to the same shard.
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.
See also: AWS API Documentation
Request Syntax
client.put_records(
Records=[
{
'Data': b'bytes',
'ExplicitHashKey': 'string',
'PartitionKey': 'string'
},
],
StreamName='string',
StreamARN='string',
StreamId='string'
)
list
[REQUIRED]
The records associated with the request.
(dict) --
Represents the output for PutRecords.
Data (bytes) -- [REQUIRED]
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 (10 MiB).
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) -- [REQUIRED]
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.
string
The stream name associated with the request.
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
dict
Response Syntax
{
'FailedRecordCount': 123,
'Records': [
{
'SequenceNumber': 'string',
'ShardId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
],
'EncryptionType': 'NONE'|'KMS'
}
Response Structure
(dict) --
PutRecords results.
FailedRecordCount (integer) --
The number of unsuccessfully processed records in a PutRecords request.
Records (list) --
An array of successfully and unsuccessfully processed record results. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to a stream includes ErrorCode and ErrorMessage in the result.
(dict) --
Represents the result of an individual record from a PutRecords request. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to the stream includes ErrorCode and ErrorMessage in the result.
SequenceNumber (string) --
The sequence number for an individual record result.
ShardId (string) --
The shard ID for an individual record result.
ErrorCode (string) --
The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.
ErrorMessage (string) --
The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".
EncryptionType (string) --
The encryption type used on the records. This parameter can be one of the following values:
NONE: Do not encrypt the records.
KMS: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key.
{'StreamId': 'string'}
Attaches a resource-based policy to a data stream or registered consumer. If you are using an identity other than the root user of the Amazon Web Services account that owns the resource, the calling identity must have the PutResourcePolicy permissions on the specified Kinesis Data Streams resource and belong to the owner's account in order to use this operation. If you don't have PutResourcePolicy permissions, Amazon Kinesis Data Streams returns a 403 Access Denied error. If you receive a ResourceNotFoundException, check to see if you passed a valid stream or consumer resource.
Request patterns can be one of the following:
Data stream pattern: arn:aws.*:kinesis:.*:\d{12}:.*stream/\S+
Consumer pattern: ^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+
For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.
See also: AWS API Documentation
Request Syntax
client.put_resource_policy(
ResourceARN='string',
StreamId='string',
Policy='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the data stream or consumer.
string
Not Implemented. Reserved for future use.
string
[REQUIRED]
Details of the resource policy. It must include the identity of the principal and the actions allowed on this resource. This is formatted as a JSON string.
None
{'StreamId': 'string'}
Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.
You can add tags to the registered consumer when making a RegisterStreamConsumer request by setting the Tags parameter. If you pass the Tags parameter, in addition to having the kinesis:RegisterStreamConsumer permission, you must also have the kinesis:TagResource permission for the consumer that will be registered. Tags will take effect from the CREATING status of the consumer.
With On-demand Advantage streams, you can register up to 50 consumers per stream to use Enhanced Fan-out. With On-demand Standard and Provisioned streams, you can register up to 20 consumers per stream to use Enhanced Fan-out. A given consumer can only be registered with one stream at a time.
For an example of how to use this operation, see Enhanced Fan-Out Using the Kinesis Data Streams API.
The use of this operation has a limit of five transactions per second per account. Also, only 5 consumers can be created simultaneously. In other words, you cannot have more than 5 consumers in a CREATING status at the same time. Registering a 6th consumer while there are 5 in a CREATING status results in a LimitExceededException.
See also: AWS API Documentation
Request Syntax
client.register_stream_consumer(
StreamARN='string',
ConsumerName='string',
StreamId='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The ARN of the Kinesis data stream that you want to register the consumer with. For more info, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
string
[REQUIRED]
For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.
string
Not Implemented. Reserved for future use.
dict
A set of up to 50 key-value pairs. A tag consists of a required key and an optional value.
(string) --
(string) --
dict
Response Syntax
{
'Consumer': {
'ConsumerName': 'string',
'ConsumerARN': 'string',
'ConsumerStatus': 'CREATING'|'DELETING'|'ACTIVE',
'ConsumerCreationTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Consumer (dict) --
An object that represents the details of the consumer you registered. When you register a consumer, it gets an ARN that is generated by Kinesis Data Streams.
ConsumerName (string) --
The name of the consumer is something you choose when you register the consumer.
ConsumerARN (string) --
When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.
If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.
ConsumerStatus (string) --
A consumer can't read data while in the CREATING or DELETING states.
ConsumerCreationTimestamp (datetime) --
{'StreamId': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.remove_tags_from_stream(
StreamName='string',
TagKeys=[
'string',
],
StreamARN='string',
StreamId='string'
)
string
The name of the stream.
list
[REQUIRED]
A list of tag keys. Each corresponding tag is removed from the stream.
(string) --
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
None
{'StreamId': 'string'}
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. This API is only supported for the data streams with the provisioned capacity mode.
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 DescribeStreamSummary and the ListShards APIs 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 DescribeStreamSummary 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 the specified stream does not exist, DescribeStreamSummary 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 Amazon Web Services account, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services 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.
See also: AWS API Documentation
Request Syntax
client.split_shard(
StreamName='string',
ShardToSplit='string',
NewStartingHashKey='string',
StreamARN='string',
StreamId='string'
)
string
The name of the stream for the shard split.
string
[REQUIRED]
The shard ID of the shard to split.
string
[REQUIRED]
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.
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
None
{'StreamId': 'string'}
Enables or updates server-side encryption using an Amazon Web Services 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 Amazon Web Services KMS key for server-side encryption 25 times in a rolling 24-hour period.
Note: It can take up to 5 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.
See also: AWS API Documentation
Request Syntax
client.start_stream_encryption(
StreamName='string',
EncryptionType='NONE'|'KMS',
KeyId='string',
StreamARN='string',
StreamId='string'
)
string
The name of the stream for which to start encrypting records.
string
[REQUIRED]
The encryption type to use. The only valid value is KMS.
string
[REQUIRED]
The GUID for the customer-managed Amazon Web Services 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
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
None
{'StreamId': 'string'}
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 5 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.
See also: AWS API Documentation
Request Syntax
client.stop_stream_encryption(
StreamName='string',
EncryptionType='NONE'|'KMS',
KeyId='string',
StreamARN='string',
StreamId='string'
)
string
The name of the stream on which to stop encrypting records.
string
[REQUIRED]
The encryption type. The only valid value is KMS.
string
[REQUIRED]
The GUID for the customer-managed Amazon Web Services 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
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
None
{'StreamId': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.subscribe_to_shard(
ConsumerARN='string',
StreamId='string',
ShardId='string',
StartingPosition={
'Type': 'AT_SEQUENCE_NUMBER'|'AFTER_SEQUENCE_NUMBER'|'TRIM_HORIZON'|'LATEST'|'AT_TIMESTAMP',
'SequenceNumber': 'string',
'Timestamp': datetime(2015, 1, 1)
}
)
string
[REQUIRED]
For this parameter, use the value you obtained when you called RegisterStreamConsumer.
string
Not Implemented. Reserved for future use.
string
[REQUIRED]
The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.
dict
[REQUIRED]
The starting position in the data stream from which to start streaming.
Type (string) -- [REQUIRED]
You can set the starting position to one of the following values:
AT_SEQUENCE_NUMBER: Start streaming from the position denoted by the sequence number specified in the SequenceNumber field.
AFTER_SEQUENCE_NUMBER: Start streaming right after the position denoted by the sequence number specified in the SequenceNumber field.
AT_TIMESTAMP: Start streaming from the position denoted by the time stamp specified in the Timestamp field.
TRIM_HORIZON: Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.
LATEST: Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.
SequenceNumber (string) --
The sequence number of the data record in the shard from which to start streaming. To specify a sequence number, set StartingPosition to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.
Timestamp (datetime) --
The time stamp of the data record from which to start reading. To specify a time stamp, set StartingPosition to 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, records will be streamed from the next (later) record. If the time stamp is older than the current trim horizon, records will be streamed from the oldest untrimmed data record ( TRIM_HORIZON).
dict
The response of this operation contains an :class:`.EventStream` member. When iterated the :class:`.EventStream` will yield events based on the structure below, where only one of the top level keys will be present for any given event.
Response Syntax
{
'EventStream': EventStream({
'SubscribeToShardEvent': {
'Records': [
{
'SequenceNumber': 'string',
'ApproximateArrivalTimestamp': datetime(2015, 1, 1),
'Data': b'bytes',
'PartitionKey': 'string',
'EncryptionType': 'NONE'|'KMS'
},
],
'ContinuationSequenceNumber': 'string',
'MillisBehindLatest': 123,
'ChildShards': [
{
'ShardId': 'string',
'ParentShards': [
'string',
],
'HashKeyRange': {
'StartingHashKey': 'string',
'EndingHashKey': 'string'
}
},
]
},
'ResourceNotFoundException': {
'message': 'string'
},
'ResourceInUseException': {
'message': 'string'
},
'KMSDisabledException': {
'message': 'string'
},
'KMSInvalidStateException': {
'message': 'string'
},
'KMSAccessDeniedException': {
'message': 'string'
},
'KMSNotFoundException': {
'message': 'string'
},
'KMSOptInRequired': {
'message': 'string'
},
'KMSThrottlingException': {
'message': 'string'
},
'InternalFailureException': {
'message': 'string'
}
})
}
Response Structure
(dict) --
EventStream (:class:`.EventStream`) --
The event stream that your consumer can use to read records from the shard.
SubscribeToShardEvent (dict) --
After you call SubscribeToShard, Kinesis Data Streams sends events of this type to your consumer. For an example of how to handle these events, see Enhanced Fan-Out Using the Kinesis Data Streams API.
Records (list) --
(dict) --
The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.
SequenceNumber (string) --
The unique identifier of the record within its shard.
ApproximateArrivalTimestamp (datetime) --
The approximate time that the record was inserted into the stream.
Data (bytes) --
The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. 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 MiB).
PartitionKey (string) --
Identifies which shard in the stream the data record is assigned to.
EncryptionType (string) --
The encryption type used on the record. This parameter can be one of the following values:
NONE: Do not encrypt the records in the stream.
KMS: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.
ContinuationSequenceNumber (string) --
Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.
MillisBehindLatest (integer) --
The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.
ChildShards (list) --
The list of the child shards of the current shard, returned only at the end of the current shard.
(dict) --
Output parameter of the GetRecords API. The existing child shard of the current shard.
ShardId (string) --
The shard ID of the existing child shard of the current shard.
ParentShards (list) --
The current shard that is the parent of the existing child shard.
(string) --
HashKeyRange (dict) --
The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
StartingHashKey (string) --
The starting hash key of the hash key range.
EndingHashKey (string) --
The ending hash key of the hash key range.
ResourceNotFoundException (dict) --
The requested resource could not be found. The stream might not be specified correctly.
message (string) --
A message that provides information about the error.
ResourceInUseException (dict) --
The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.
message (string) --
A message that provides information about the error.
KMSDisabledException (dict) --
The request was rejected because the specified customer master key (CMK) isn't enabled.
message (string) --
A message that provides information about the error.
KMSInvalidStateException (dict) --
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 Amazon Web Services Key Management Service Developer Guide.
message (string) --
A message that provides information about the error.
KMSAccessDeniedException (dict) --
The ciphertext references a key that doesn't exist or that you don't have access to.
message (string) --
A message that provides information about the error.
KMSNotFoundException (dict) --
The request was rejected because the specified entity or resource can't be found.
message (string) --
A message that provides information about the error.
KMSOptInRequired (dict) --
The Amazon Web Services access key ID needs a subscription for the service.
message (string) --
A message that provides information about the error.
KMSThrottlingException (dict) --
The request was denied due to request throttling. For more information about throttling, see Limits in the Amazon Web Services Key Management Service Developer Guide.
message (string) --
A message that provides information about the error.
InternalFailureException (dict) --
The processing of the request failed because of an unknown error, exception, or failure.
message (string) --
{'StreamId': 'string'}
Adds or updates tags for the specified Kinesis resource. Each tag is a label consisting of a user-defined key and value. Tags can help you manage, identify, organize, search for, and filter resources. You can assign up to 50 tags to a Kinesis resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
Tags={
'string': 'string'
},
ResourceARN='string',
StreamId='string'
)
dict
[REQUIRED]
An array of tags to be added to the Kinesis resource. A tag consists of a required key and an optional value. You can add up to 50 tags per resource.
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
(string) --
(string) --
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Kinesis resource to which to add tags.
string
Not Implemented. Reserved for future use.
None
{'StreamId': 'string'}
Removes tags from the specified Kinesis resource. Removed tags are deleted and can't be recovered after this operation completes successfully.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
TagKeys=[
'string',
],
ResourceARN='string',
StreamId='string'
)
list
[REQUIRED]
A list of tag key-value pairs. Existing tags of the resource whose keys are members of this list will be removed from the Kinesis resource.
(string) --
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Kinesis resource from which to remove tags.
string
Not Implemented. Reserved for future use.
None
{'StreamId': 'string'}
This allows you to update the MaxRecordSize of a single record that you can write to, and read from a stream. You can ingest and digest single records up to 10240 KiB.
See also: AWS API Documentation
Request Syntax
client.update_max_record_size(
StreamARN='string',
StreamId='string',
MaxRecordSizeInKiB=123
)
string
The Amazon Resource Name (ARN) of the stream for the MaxRecordSize update.
string
Not Implemented. Reserved for future use.
integer
[REQUIRED]
The maximum record size of a single record in KiB that you can write to, and read from a stream. Specify a value between 1024 and 10240 KiB (1 to 10 MiB). If you specify a value that is out of this range, UpdateMaxRecordSize sends back an ValidationException message.
None
{'StreamId': 'string'}
Updates the shard count of the specified stream to the specified number of shards. This API is only supported for the data streams with the provisioned capacity mode.
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. These short-lived shards count towards your total shard limit for your account in the Region.
When using this operation, we recommend that you specify a target shard count that is a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling action might take longer to complete.
This operation has the following default limits. By default, you cannot do the following:
Scale more than ten times 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 10000 shards in a stream
Scale a stream with more than 10000 shards down unless the result is less than 10000 shards
Scale up to more than the shard limit for your account
Make over 10 TPS. TPS over 10 will trigger the LimitExceededException
For the default limits for an Amazon Web Services 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.
See also: AWS API Documentation
Request Syntax
client.update_shard_count(
StreamName='string',
TargetShardCount=123,
ScalingType='UNIFORM_SCALING',
StreamARN='string',
StreamId='string'
)
string
The name of the stream.
integer
[REQUIRED]
The new number of shards. This value has the following default limits. By default, you cannot do the following:
Set this value to more than double your current shard count for a stream.
Set this value below half your current shard count for a stream.
Set this value to more than 10000 shards in a stream (the default limit for shard count per stream is 10000 per account per region), unless you request a limit increase.
Scale a stream with more than 10000 shards down unless you set this value to less than 10000 shards.
string
[REQUIRED]
The scaling type. Uniform scaling creates shards of equal size.
string
The ARN of the stream.
string
Not Implemented. Reserved for future use.
dict
Response Syntax
{
'StreamName': 'string',
'CurrentShardCount': 123,
'TargetShardCount': 123,
'StreamARN': 'string'
}
Response Structure
(dict) --
StreamName (string) --
The name of the stream.
CurrentShardCount (integer) --
The current number of shards.
TargetShardCount (integer) --
The updated number of shards.
StreamARN (string) --
The ARN of the stream.
{'StreamId': 'string'}
Updates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data stream.
If you'd still like to proactively scale your on-demand data stream’s capacity, you can unlock the warm throughput feature for on-demand data streams by enabling MinimumThroughputBillingCommitment for your account. Once your account has MinimumThroughputBillingCommitment enabled, you can specify the warm throughput in MiB per second that your stream can support in writes.
See also: AWS API Documentation
Request Syntax
client.update_stream_mode(
StreamARN='string',
StreamId='string',
StreamModeDetails={
'StreamMode': 'PROVISIONED'|'ON_DEMAND'
},
WarmThroughputMiBps=123
)
string
[REQUIRED]
Specifies the ARN of the data stream whose capacity mode you want to update.
string
Not Implemented. Reserved for future use.
dict
[REQUIRED]
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
StreamMode (string) -- [REQUIRED]
Specifies the capacity mode to which you want to set your data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.
integer
The target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations. This field is only valid when the stream mode is being updated to on-demand.
None
{'StreamId': 'string'}
Updates the warm throughput configuration for the specified Amazon Kinesis Data Streams on-demand data stream. This operation allows you to proactively scale your on-demand data stream to a specified throughput level, enabling better performance for sudden traffic spikes.
Updating the warm throughput 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.
This operation is only supported for data streams with the on-demand capacity mode in accounts that have MinimumThroughputBillingCommitment enabled. Provisioned capacity mode streams do not support warm throughput configuration.
This operation has the following default limits. By default, you cannot do the following:
Scale to more than 10 GiBps for an on-demand stream.
This API has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. TPS over 5 will initiate the LimitExceededException.
For the default limits for an Amazon Web Services 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.
See also: AWS API Documentation
Request Syntax
client.update_stream_warm_throughput(
StreamARN='string',
StreamName='string',
StreamId='string',
WarmThroughputMiBps=123
)
string
The ARN of the stream to be updated.
string
The name of the stream to be updated.
string
Not Implemented. Reserved for future use.
integer
[REQUIRED]
The target warm throughput in MB/s that the stream should be scaled to handle. This represents the throughput capacity that will be immediately available for write operations.
dict
Response Syntax
{
'StreamARN': 'string',
'StreamName': 'string',
'WarmThroughput': {
'TargetMiBps': 123,
'CurrentMiBps': 123
}
}
Response Structure
(dict) --
StreamARN (string) --
The ARN of the stream that was updated.
StreamName (string) --
The name of the stream that was updated.
WarmThroughput (dict) --
Specifies the updated warm throughput configuration for your data stream.
TargetMiBps (integer) --
The target warm throughput value on the stream. This indicates that the stream is currently scaling towards this target value.
CurrentMiBps (integer) --
The current warm throughput value on the stream. This is the write throughput in MiBps that the stream is currently scaled to handle.