Amazon Kinesis Data Streams Service API Reference API Version 2013-12-02

(1)

Amazon Kinesis Data Streams Service

API Reference

API Version 2013-12-02

(2)

Amazon Kinesis Data Streams Service: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.

This document was last published on March 6, 2022.

(9)

Actions

The following actions are supported:

• AddTagsToStream (p. 3)

• CreateStream (p. 6)

• DecreaseStreamRetentionPeriod (p. 9)

• DeleteStream (p. 12)

• DeregisterStreamConsumer (p. 15)

• DescribeLimits (p. 17)

• DescribeStream (p. 19)

• DescribeStreamConsumer (p. 24)

• DescribeStreamSummary (p. 27)

• DisableEnhancedMonitoring (p. 29)

• EnableEnhancedMonitoring (p. 33)

• GetRecords (p. 37)

• GetShardIterator (p. 42)

• IncreaseStreamRetentionPeriod (p. 46)

• ListShards (p. 49)

• ListStreamConsumers (p. 55)

• ListStreams (p. 59)

• ListTagsForStream (p. 62)

• MergeShards (p. 65)

• PutRecord (p. 68)

• PutRecords (p. 73)

• RegisterStreamConsumer (p. 79)

• RemoveTagsFromStream (p. 82)

• SplitShard (p. 85)

• StartStreamEncryption (p. 89)

• StopStreamEncryption (p. 92)

• SubscribeToShard (p. 95)

• UpdateShardCount (p. 99)

• UpdateStreamMode (p. 103)

(10)

AddTagsToStream

Adds or updates tags for the speciﬁed 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 speciﬁed tag keys.

AddTagsToStream (p. 3) has a limit of ﬁve transactions per second per account.

Request Syntax

{

"StreamName": "string", "Tags": {

"string" : "string"

}}

Request Parameters

The request accepts the following data in JSON format.

StreamName (p. 3)

The name of the stream.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes Tags (p. 3)

A set of up to 10 key-value pairs to use to create the tags.

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 135).

(11)

Examples

InvalidArgumentException

A speciﬁed parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

HTTP Status Code: 400 LimitExceededException

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

HTTP Status Code: 400 ResourceInUseException

The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

HTTP Status Code: 400 ResourceNotFoundException

The requested resource could not be found. The stream might not be speciﬁed correctly.

HTTP Status Code: 400

Examples

To add tags to a stream

The following JSON example adds two tags to the speciﬁed stream.

Sample Request

POST / HTTP/1.1

Host: kinesis.<region>.<domain>

Content-Length: <PayloadSizeBytes>

User-Agent: <UserAgentString>

Content-Type: application/x-amz-json-1.1 Authorization: <AuthParams>

Connection: Keep-Alive X-Amz-Date: <Date>

X-Amz-Target: Kinesis_20131202.AddTagsToStream { "StreamName": "exampleStreamName",

"Tags": {

"Project" : "myProject", "Environment" : "Production"

}}

Sample Response

HTTP/1.1 200 OK

x-amzn-RequestId: <RequestId>

Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes>

Date: <Date>

(12)

See Also

CreateStream

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

You can create your data stream using either on-demand or provisioned capacity mode. Data streams with an on-demand mode require no capacity planning and automatically scale to handle gigabytes of write and read throughput per minute. With the on-demand mode, Kinesis Data Streams automatically manages the shards in order to provide the necessary throughput. For the data streams with a

provisioned mode, you must specify the number of shards for the data stream. Each shard can support reads up to ﬁve transactions per second, up to a maximum data read total of 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. If the amount of data input increases or decreases, you can add or remove shards.

The stream name identiﬁes the stream. The name is scoped to the AWS account used by the application.

It is also scoped by AWS Region. That is, two streams in two diﬀerent accounts can have the same name, and two streams in the same account, but in two diﬀerent Regions, can have the same name.

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

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

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

• Create more shards than are authorized for your account.

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

You can use DescribeStreamSummary (p. 27) to check the stream status, which is returned in StreamStatus.

CreateStream (p. 6) has a limit of ﬁve transactions per second per account.

Request Syntax

{

"ShardCount": number, "StreamModeDetails": { "StreamMode": "string"

},

"StreamName": "string"

}

Request Parameters

ShardCount (p. 6)

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

(14)

Response Elements

Type: Integer

Valid Range: Minimum value of 1.

Required: No

StreamModeDetails (p. 6)

Indicates 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 streams.

Type: StreamModeDetails (p. 130) object Required: No

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

Type: String

Required: Yes

Response Elements

Errors

(15)

Examples

To create a stream

The following JSON example creates a stream with three shards.

Sample Request

POST / HTTP/1.1

X-Amz-Target: Kinesis_20131202.CreateStream {

"StreamName": "exampleStreamName", }

Sample Response

HTTP/1.1 200 OK

Date: <Date>

DecreaseStreamRetentionPeriod

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.

Request Syntax

{ "RetentionPeriodHours": number, "StreamName": "string"

}

Request Parameters

RetentionPeriodHours (p. 9)

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

Type: Integer Required: Yes StreamName (p. 9)

The name of the stream to modify.

Type: String

Required: Yes

Response Elements

Errors

(17)

Examples

LimitExceededException

Examples

To decrease stream retention period

The following JSON example decreases a stream's retention period.

Sample Request

POST / HTTP/1.1

X-Amz-Target: Kinesis_20131202.DecreaseStreamRetentionPeriod {

"RetentionPeriodInHours": "24", "StreamName": "examplestream"

}

Sample Response

HTTP/1.1 200 OK

Date: <Date>

DeleteStream

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 speciﬁed 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 (p. 68), PutRecords (p. 73), and GetRecords (p. 37), 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 (p. 27) operation to check the state of the stream, which is returned in StreamStatus.

DeleteStream (p. 12) has a limit of ﬁve transactions per second per account.

Request Syntax

{ "EnforceConsumerDeletion": boolean, "StreamName": "string"

}

Request Parameters

EnforceConsumerDeletion (p. 12)

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.

Type: Boolean Required: No StreamName (p. 12)

The name of the stream to delete.

Type: String

Required: Yes

Response Elements

(20)

Errors

Examples

To delete a stream

The following JSON example deletes the speciﬁed stream.

Sample Request

POST / HTTP/1.1

X-Amz-Target: Kinesis_20131202.DeleteStream { "StreamName":"exampleStreamName"

}

Sample Response

HTTP/1.1 200 OK

Date: <Date>

DeregisterStreamConsumer

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 conﬂict 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 (p. 55) 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 ﬁve transactions per second per stream.

Request Syntax

{

"ConsumerARN": "string", "ConsumerName": "string", "StreamARN": "string"

}

Request Parameters

ConsumerARN (p. 15)

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.

Type: String

Pattern: ^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/

[a-zA-Z0-9_.-]+:[0-9]+

Required: No ConsumerName (p. 15)

The name that you gave to the consumer.

Type: String

Required: No StreamARN (p. 15)

The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Type: String

(23)

Response Elements

Pattern: arn:aws.*:kinesis:.*:\d{12}:stream/.+

Required: No

Response Elements

Errors

DescribeLimits

Describes the shard limits and usage for the account.

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

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

Response Syntax

{ "OnDemandStreamCount": number, "OnDemandStreamCountLimit": number, "OpenShardCount": number,

"ShardLimit": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

OnDemandStreamCount (p. 17)

Indicates the number of data streams with the on-demand capacity mode.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000000.

OnDemandStreamCountLimit (p. 17)

The maximum number of data streams with the on-demand capacity mode.

Type: Integer

OpenShardCount (p. 17) The number of open shards.

Type: Integer

ShardLimit (p. 17)

The maximum number of shards.

Type: Integer

Errors

(25)

Examples

To display the shard limits for the account

The following example displays the shard limits for the account.

Sample Request

POST / HTTP/1.1

X-Amz-Target: Kinesis_20131202.DescribeLimits

Sample Response

HTTP/1.1 200 OK

Date: <Date>

{ "OpenShardCount": 20, "ShardLimit": 70 }

DescribeStream

Describes the speciﬁed Kinesis data stream.

Note

This API has been revised. It's highly recommended that you use the

DescribeStreamSummary (p. 27) API to get a summarized description of the speciﬁed Kinesis data stream and the ListShards (p. 49) API to list the shards in a speciﬁed data stream and obtain information about each shard.

The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric conﬁguration, 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 identiﬁed 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.

Request Syntax

{ "ExclusiveStartShardId": "string", "Limit": number,

"StreamName": "string"

}

Request Parameters

ExclusiveStartShardId (p. 19)

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 ﬁrst shard in the stream.

Type: String

Pattern: shardId-[0-9]{12}

Required: No Limit (p. 19)

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.

(27)

Response Syntax

Type: Integer

Required: No StreamName (p. 19)

The name of the stream to describe.

Type: String

Required: Yes

Response Syntax

{

"StreamDescription": { "EncryptionType": "string", "EnhancedMonitoring": [ {

"ShardLevelMetrics": [ "string" ] }

],

"HasMoreShards": boolean, "KeyId": "string",

"RetentionPeriodHours": number, "Shards": [

{

"AdjacentParentShardId": "string", "HashKeyRange": {

"EndingHashKey": "string", "StartingHashKey": "string"

},

"ParentShardId": "string", "SequenceNumberRange": {

"EndingSequenceNumber": "string", "StartingSequenceNumber": "string"

},

"ShardId": "string"

} ],

"StreamARN": "string",

"StreamCreationTimestamp": number, "StreamModeDetails": {

"StreamMode": "string"

},

"StreamName": "string", "StreamStatus": "string"

}}

Response Elements

(28)

Errors

StreamDescription (p. 20)

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.

Type: StreamDescription (p. 124) object

Errors

Examples

To get information about a stream

The following JSON example describes the speciﬁed stream.

Sample Request

POST / HTTP/1.1

X-Amz-Target: Kinesis_20131202.DescribeStream { "StreamName":"exampleStreamName"

}

Sample Response

HTTP/1.1 200 OK

Date: <Date>

{ "StreamDescription": { "EnhancedMonitoring":[

{

"ShardLevelMetrics":[

(29)

See Also

"IncomingBytes", "OutgoingRecords"

] } ],

"HasMoreShards": false, "RetentionPeriodHours": 24,

"StreamCreationTimestamp": 1.468346745E9, "Shards": [

{

"HashKeyRange": {

"EndingHashKey": "113427455640312821154458202477256070484", "StartingHashKey": "0"

},

"SequenceNumberRange": {

"EndingSequenceNumber": "21269319989741826081360214168359141376", "StartingSequenceNumber": "21267647932558653966460912964485513216"

},

"ShardId": "shardId-000000000000"

}, {

"HashKeyRange": {

},

"StartingSequenceNumber": "21267647932558653966460912964485513217"

},

}, {

"HashKeyRange": {

},

"StartingSequenceNumber": "21267647932558653966460912964485513218"

},

} ],

"StreamARN": "arn:aws:kinesis:us-east-1:111122223333:exampleStreamName", "StreamName": "exampleStreamName",

"StreamStatus": "ACTIVE"

}}

DescribeStreamConsumer

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 conﬂict 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 (p. 55) 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.

Request Syntax

{ "ConsumerARN": "string", "ConsumerName": "string", "StreamARN": "string"

}

Request Parameters

ConsumerARN (p. 24)

The ARN returned by Kinesis Data Streams when you registered the consumer.

Type: String

Pattern: ^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/

[a-zA-Z0-9_.-]+:[0-9]+

Required: No ConsumerName (p. 24)

The name that you gave to the consumer.

Type: String

Required: No StreamARN (p. 24)

The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Type: String

Pattern: arn:aws.*:kinesis:.*:\d{12}:stream/.+

(32)

Response Syntax

Required: No

Response Syntax

{

"ConsumerDescription": { "ConsumerARN": "string",

"ConsumerCreationTimestamp": number, "ConsumerName": "string",

"ConsumerStatus": "string", "StreamARN": "string"

}}

Response Elements

ConsumerDescription (p. 25)

An object that represents the details of the consumer.

Type: ConsumerDescription (p. 109) object

Errors

DescribeStreamSummary

Provides a summarized description of the speciﬁed 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 (p. 27) has a limit of 20 transactions per second per account.

Request Syntax

{ "StreamName": "string"

}

Request Parameters

The name of the stream to describe.

Type: String

Required: Yes

Response Syntax

{

"StreamDescriptionSummary": { "ConsumerCount": number, "EncryptionType": "string", "EnhancedMonitoring": [ {

"ShardLevelMetrics": [ "string" ] }

],

"KeyId": "string",

"OpenShardCount": number, "RetentionPeriodHours": number, "StreamARN": "string",

"StreamCreationTimestamp": number, "StreamModeDetails": {

"StreamMode": "string"

},

"StreamName": "string", "StreamStatus": "string"

}}

(35)

Response Elements

StreamDescriptionSummary (p. 27)

A StreamDescriptionSummary (p. 127) containing information about the stream.

Type: StreamDescriptionSummary (p. 127) object

Errors

DisableEnhancedMonitoring

Disables enhanced monitoring.

Request Syntax

{ "ShardLevelMetrics": [ "string" ], "StreamName": "string"

}

Request Parameters

ShardLevelMetrics (p. 29)

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 7 items.

Valid Values: IncomingBytes | IncomingRecords | OutgoingBytes | OutgoingRecords

| WriteProvisionedThroughputExceeded | ReadProvisionedThroughputExceeded | IteratorAgeMilliseconds | ALL

Required: Yes StreamName (p. 29)

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

Type: String

Required: Yes

(37)

Response Syntax

{ "CurrentShardLevelMetrics": [ "string" ], "DesiredShardLevelMetrics": [ "string" ], "StreamName": "string"

}

Response Elements

CurrentShardLevelMetrics (p. 30)

Represents the current state of the metrics that are in the enhanced state before the operation.

DesiredShardLevelMetrics (p. 30)

Represents the list of all the metrics that would be in the enhanced state after the operation.

The name of the Kinesis data stream.

Type: String

Errors

(38)

Examples

To disable enhanced monitoring

The following JSON example disables enhanced monitoring for IncomingBytes and OutgoingRecords shard level metrics.

Sample Request

POST / HTTP/1.1

X-Amz-Target: Kinesis_20131202.DisableEnhancedMonitoring { "ShardLevelMetrics": [

],

"StreamName": "exampleStreamName"

}

Sample Response

HTTP/1.1 200 OK

Date: <Date>

{ "StreamName": "exampleStreamName", "CurrentShardLevelMetrics": [ "IncomingBytes",

"OutgoingRecords"

],

"DesiredShardLevelMetrics": []

}

(39)

See Also

EnableEnhancedMonitoring

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

Request Syntax

{ "ShardLevelMetrics": [ "string" ], "StreamName": "string"

}

Request Parameters

ShardLevelMetrics (p. 33)

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.

Required: Yes StreamName (p. 33)

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

Type: String

Required: Yes

(41)

Response Syntax

{ "CurrentShardLevelMetrics": [ "string" ], "DesiredShardLevelMetrics": [ "string" ], "StreamName": "string"

}

Response Elements

CurrentShardLevelMetrics (p. 34)

Represents the current state of the metrics that are in the enhanced state before the operation.

DesiredShardLevelMetrics (p. 34)

Represents the list of all the metrics that would be in the enhanced state after the operation.

The name of the Kinesis data stream.

Type: String

Errors

(42)

Examples

To enable enhanced monitoring

The following JSON example enables enhanced monitoring for IncomingBytes and OutgoingRecords shard level metrics.

Sample Request

POST / HTTP/1.1

X-Amz-Target: Kinesis_20131202.EnableEnhancedMonitoring { "ShardLevelMetrics": [

],

"StreamName": "exampleStreamName"

}

Sample Response

HTTP/1.1 200 OK

Date: <Date>

{ "StreamName": "exampleStreamName", "CurrentShardLevelMetrics": [], "DesiredShardLevelMetrics": [ "IncomingBytes",

"OutgoingRecords"

] }

(43)

See Also

GetRecords

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

Specify a shard iterator using the ShardIterator parameter. The shard iterator speciﬁes 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 (p. 37) 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 (p. 37) in a loop. Use GetShardIterator (p. 42) to get the shard iterator to specify in the ﬁrst GetRecords (p. 37) call. GetRecords (p. 37) returns a new shard iterator in NextShardIterator. Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords (p. 37). If the shard has been closed, the shard iterator can't return more data and GetRecords (p. 37) 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 (p. 37) 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 (p. 37) 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 (p. 37) 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 insuﬃcient provisioned throughput on the stream, subsequent calls made within the next 1 second throw ProvisionedThroughputExceededException. GetRecords (p. 37) doesn't return any data when it throws an exception. For this reason, we recommend that you wait 1 second between calls to GetRecords (p. 37). 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 (p. 73)). 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 ﬁve transactions per second per shard.

Request Syntax

{

"Limit": number,

"ShardIterator": "string"

(45)

Request Parameters

}

Request Parameters

Limit (p. 37)

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 (p. 37) throws InvalidArgumentException. The default value is 10,000.

Type: Integer

Required: No ShardIterator (p. 37)

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

Type: String

Required: Yes

Response Syntax

{ "ChildShards": [ {

"HashKeyRange": {

"EndingHashKey": "string", "StartingHashKey": "string"

},

"ParentShards": [ "string" ], "ShardId": "string"

} ],

"MillisBehindLatest": number, "NextShardIterator": "string", "Records": [

{

"ApproximateArrivalTimestamp": number, "Data": blob,

"EncryptionType": "string", "PartitionKey": "string", "SequenceNumber": "string"

} ] }

Response Elements

(46)

Errors

ChildShards (p. 38)

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.

Type: Array of ChildShard (p. 106) objects MillisBehindLatest (p. 38)

The number of milliseconds the GetRecords (p. 37) 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.

Type: Long

Valid Range: Minimum value of 0.

NextShardIterator (p. 38)

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.

Type: String

Records (p. 38)

The data records retrieved from the shard.

Type: Array of Record (p. 115) objects

Errors

ExpiredIteratorException

The provided iterator exceeds the maximum age allowed.

HTTP Status Code: 400 InvalidArgumentException

HTTP Status Code: 400 KMSAccessDeniedException

The ciphertext references a key that doesn't exist or that you don't have access to.

HTTP Status Code: 400 KMSDisabledException

The request was rejected because the speciﬁed customer master key (CMK) isn't enabled.

(47)

Examples

KMSInvalidStateException

The request was rejected because the state of the speciﬁed resource isn't valid for this request.

For more information, see How Key State Aﬀects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

HTTP Status Code: 400 KMSNotFoundException

The request was rejected because the speciﬁed entity or resource can't be found.

HTTP Status Code: 400 KMSOptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 400 KMSThrottlingException

The request was denied due to request throttling. For more information about throttling, see Limits in the AWS Key Management Service Developer Guide.

ProvisionedThroughputExceededException

The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoﬀ in AWS in the AWS General Reference.

Examples

To get data from the shards in a stream

The following JSON example gets data from the shards in a stream.

Sample Request

POST / HTTP/1.1

X-Amz-Target: Kinesis_20131202.GetRecords {

"ShardIterator": "AAAAAAAAAAETYyAYzd665+8e0X7JTsASDM/

Hr2rSwc0X2qz93iuA3udrjTH+ikQvpQk/1ZcMMLzRdAesqwBGPnsthzU0/CBlM/

(48)

See Also

U8/8oEqGwX3pKw0XyeDNRAAZyXBo3MqkQtCpXhr942BRTjvWKhFz7OmCb2Ncfr8Tl2cBktooi6kJhr +djN5WYkB38Rr3akRgCl9qaU4dY=",

"Limit": 25 }

Sample Response

HTTP/1.1 200 OK

Date: <Date>

{ "MillisBehindLatest": 2100,

"NextShardIterator": "AAAAAAAAAAHsW8zCWf9164uy8Epue6WS3w6wmj4a4USt+CNvMd6uXQ

+HL5vAJMznqqC0DLKsIjuoiTi1BpT6nW0LN2M2D56zM5H8anHm30Gbri9ua+qaGgj+3XTyvbhpERfrezgLHbPB/

rIcVpykJbaSj5tmcXYRmFnqZBEyHwtZYFmh6hvWVFkIwLuMZLMrpWhG5r5hzkE=", "Records": [

{

"Data": "XzxkYXRhPl8w",

"PartitionKey": "partitionKey",

"ApproximateArrivalTimestamp": 1.441215410867E9,

"SequenceNumber": "21269319989652663814458848515492872193"

} ] }

GetShardIterator

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 speciﬁc 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 (p. 68), PutRecords (p. 73), GetRecords (p. 37), or DescribeStream (p. 19). 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 (p. 42) request to get the ﬁrst shard iterator for use in your ﬁrst GetRecords (p. 37) request and for subsequent reads use the shard iterator returned by the GetRecords (p. 37) request in NextShardIterator. A new shard iterator is returned by every GetRecords (p. 37) request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords (p. 37) request.

If a GetShardIterator (p. 42) request is made too often, you receive a

ProvisionedThroughputExceededException. For more information about throughput limits, see GetRecords (p. 37), and Streams Limits in the Amazon Kinesis Data Streams Developer Guide.

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

GetShardIterator (p. 42) has a limit of ﬁve transactions per second per account per open shard.

Request Syntax

{

"ShardId": "string",

"ShardIteratorType": "string", "StartingSequenceNumber": "string", "StreamName": "string",

"Timestamp": number }

Request Parameters

ShardId (p. 42)

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

Type: String

Pattern: shardId-[0-9]{12}

Required: Yes

Amazon Kinesis Data Streams Service API Reference API Version 2013-12-02

Amazon Kinesis Data Streams Service

API Reference

API Version 2013-12-02

Amazon Kinesis Data Streams Service: API Reference

Table of Contents

Welcome

Actions

AddTagsToStream

Request Syntax

Request Parameters

Response Elements

Errors

Examples

To add tags to a stream

Sample Request

Sample Response

See Also

CreateStream

Request Syntax

Request Parameters

Response Elements

Errors

Examples

To create a stream

Sample Request

Sample Response

See Also

DecreaseStreamRetentionPeriod

Request Syntax

Request Parameters

Response Elements

Errors

Examples

To decrease stream retention period

Sample Request

Sample Response

See Also

DeleteStream

Request Syntax

Request Parameters

Response Elements

Errors

Examples

To delete a stream

Sample Request

Sample Response

See Also

DeregisterStreamConsumer

Request Syntax

Request Parameters

Response Elements

Errors

See Also

DescribeLimits

Response Syntax

Response Elements

Errors

Examples

To display the shard limits for the account

Sample Request

Sample Response

See Also

DescribeStream

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

To get information about a stream

Sample Request

Sample Response

See Also

DescribeStreamConsumer

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors