Amazon Kinesis Service API Reference

1 Amazon Kinesis Service APIR eferenceAPI ReferenceAPI Version 2013-12-02 Amazon Kinesis Service API Reference : API ReferenceCopyright 2013 Amazon Web services , Inc. and/or its affiliates. All rights following are trademarks of Amazon Web services , Inc.: Amazon , Amazon Web services Design, AWS, Amazon CloudFront,Cloudfront, Amazon DevPay, DynamoDB, ElastiCache, Amazon EC2, Amazon Elastic Compute Cloud, Amazon Glacier, Kindle, KindleFire, AWS Marketplace Design, Mechanical Turk, Amazon Redshift, Amazon Route 53, Amazon S3, Amazon VPC. In addition, graphics, logos, page headers, button icons, scripts, and Service names are trademarks, or trade dress of Amazon inthe and/or other countries. Amazon 's trademarks and trade dress may not be used in connection with any product or Service thatis not Amazon 's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connectedto, or sponsored by Kinesis Service API Reference API Parameters for Signature V4 Version 2013-12-023 Amazon Kinesis Service API Reference API ReferenceWelcomeAmazon Kinesis is a managed Service that scales elastically for real time processing of streaming document was last updated on March 14, Version 2013-12-021 Amazon Kinesis Service API Reference API ReferenceActionsThe following actions are supported.

2 CreateStream (p. 3) DeleteStream (p. 6) DescribeStream (p. 8) GetRecords (p. 12) GetShardIterator (p. 15) ListStreams (p. 19) MergeShards (p. 22) PutRecord (p. 25) SplitShard (p. 29)API Version 2013-12-022 Amazon Kinesis Service API Reference API ReferenceCreateStreamThis operation adds a new Amazon Kinesis stream to your AWS account. A stream captures and transportsdata records that are continuously emitted from different data sources or producers. Scale-out within anAmazon Kinesis stream is explicitly supported by means of shards, which are uniquely identified groupsof data records in an Amazon Kinesis specify and control the number of shards that a stream is composed of. Each open shard can supportup to 5 read transactions per second, up to a maximum total of 2 MB of data read per second.

3 Each shardcan support up to 1000 write transactions per second, up to a maximum total of 1 MB data written can add shards to a stream if the amount of data input increases and you can remove shardsif the amount of data input stream name identifies the name is scoped to the AWS account used by the is also scoped by is, two streams in two different accounts can have the same name, andtwo streams in the same account, but in two different regions, can have the same is an asynchronous operation. Upon receiving a CreateStream request, Amazon Kinesisimmediately returns and sets the stream status to CREATING. After the stream is created, AmazonKinesis sets the stream status to should perform read and write operations only on anACTIVE receive a LimitExceededException when making a CreateStream request if you try to do oneof the following: Have more than five streams in the CREATING state at any point in time.

4 Create more shards than are authorized for your :The default limit for an AWS account is 10 shards per stream. If you need to create a stream withmore than 10 shards, contact AWS Support to increase the limit on your can use the DescribeStream operation to check the stream status, which is returned has a limit of 5 transactions per second per Syntax{ "ShardCount": "number", "StreamName": "string"}Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p. 39).The request accepts the following data in JSON number of shards that the stream will use. The throughput of the stream is a function of thenumber of shards; more shards are required for greater provisioned Version 2013-12-023 Amazon Kinesis Service API Reference API ReferenceCreateStreamNote:The default limit for an AWS account is 10 shards per stream.

5 If you need to create a streamwith more than 10 shards, contact AWS Support to increase the limit on your : NumberRequired:YesStreamNameA name to identify the stream name is scoped to the AWS account used by the applicationthat creates the stream. It is also scoped by is, two streams in two different AWS accountscan have the same name, and two streams in the same AWS account, but in two different regions,can have the same : StringLength constraints: Minimum length of 1. Maximum length of :YesResponse ElementsIf the action is successful, the Service sends back an HTTP 200 response with an empty HTTP information about the errors that are common to all actions, see Common Errors (p. 43).InvalidArgumentExceptionHTTP Status Code: 400 LimitExceededExceptionHTTP Status Code: 400 ResourceInUseExceptionHTTP Status Code: 400 ExamplesCreate a StreamThe following is an example of an Amazon Kinesis CreateStream request and RequestPOST / : Kinesis .

6 <region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;use r-agent;x-amz-date;x-amz-target;x-amzn-r equestid, Signa ture=<Signature>User-Agent: <UserAgentString>Content-Type: : <PayloadSizeBytes>Connection: Keep-AliveX-Amz-Target: API Version 2013-12-024 Amazon Kinesis Service API Reference API ReferenceResponse Elements{ "StreamName":"exampleStreamName","ShardC ount":3}Sample 200 OKx-amzn-RequestId: <RequestId>Content-Type: : <PayloadSizeBytes>Date: <Date>API Version 2013-12-025 Amazon Kinesis Service API Reference API ReferenceExamplesDeleteStreamThis operation deletes a stream and all of its shards and must shut down any applications thatare operating on the stream before you delete the stream.

7 If an application attempts to operate on adeleted stream, it will receive the exception the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specifiedstream is in the DELETING state until Amazon Kinesis completes the : Amazon Kinesis might continue to accept data read and write operations, such as PutRecord (p. 25)and GetRecords (p. 12), on a stream in the DELETING state until the stream deletion is you delete a stream, any shards in that stream are also can use the DescribeStream (p. 8) operation to check the state of the stream, which is returned has a limit of 5 transactions per second per Syntax{ "StreamName": "string"}Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p.)

8 39).The request accepts the following data in JSON name of the stream to : StringLength constraints: Minimum length of 1. Maximum length of :YesResponse ElementsIf the action is successful, the Service sends back an HTTP 200 response with an empty HTTP information about the errors that are common to all actions, see Common Errors (p. 43).LimitExceededExceptionHTTP Status Code: 400 ResourceNotFoundExceptionHTTP Status Code: 400 API Version 2013-12-026 Amazon Kinesis Service API Reference API ReferenceDeleteStreamExamplesDelete a StreamThe following is an example of an Amazon Kinesis DeleteStream request and RequestPOST / : Kinesis .<region>.<domain>x-amz-Date: <Date>Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;use r-agent;x-amz-date;x-amz-target;x-amzn-r equestid, Signa ture=<Signature>User-Agent: <UserAgentString>Content-Type: : <PayloadSizeBytes>Connection: Keep-AliveX-Amz-Target: { "StreamName":"exampleStreamName"}Sample 200 OKx-amzn-RequestId: <RequestId>Content-Type: : <PayloadSizeBytes>Date: <Date>API Version 2013-12-027 Amazon Kinesis Service API Reference API ReferenceExamplesDescribeStreamThis operation returns the following information about the stream: the current status of the stream, thestream Amazon Resource Name (ARN), and an array of shard objects that comprise the stream.

9 Foreach shard object there is information about the hash key and sequence number ranges that the shardspans, and the IDs of any earlier shards that played in a role in a MergeShards (p. 22) or SplitShard (p. 29)operation that created the shard. A sequence number is the identifier associated with every record ingestedin the Amazon Kinesis sequence number is assigned by the Amazon Kinesis Service whena record is put into the can limit the number of returned shards using the Limit parameter. The number of shards in astream may be too large to return from a single call to DescribeStream. You can detect this by usingthe HasMoreShards flag in the returned is set to true when there is more there are more shards available, you can request more shards by using the shard ID of the last shardreturned by the DescribeStream request, in the ExclusiveStartShardId parameter in a subsequentrequest to is a paginated has a limit of 10 transactions per second per Syntax{ "ExclusiveStartShardId": "string", "Limit": "number", "StreamName": "string"}Request ParametersFor information about the common parameters that all actions use, see Common Parameters (p.)

10 39).The request accepts the following data in JSON shard ID of the shard to start with for the stream : StringLength constraints: Minimum length of 1. Maximum length of : NoLimitThe maximum number of shards to : NumberRequired: NoStreamNameThe name of the stream to : StringAPI Version 2013-12-028 Amazon Kinesis Service API Reference API ReferenceDescribeStreamLength constraints: Minimum length of 1. Maximum length of :YesResponse Syntax{ "StreamDescription": { "HasMoreShards": "boolean", "Shards": [ { "AdjacentParentShardId": "string", "HashKeyRange": { "EndingHashKey": "string", "StartingHashKey": "string" }, "ParentShardId": "string", "SequenceNumberRange": { "EndingSequenceNumber": "string", "StartingSequenceNumber": "string" }, "ShardId": "string" } ], "StreamARN": "string", "StreamName": "string", "StreamStatus".}}