AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Amazon Kinesis is a managed service that scales elastically for real time processing of streaming big data.
Namespace: Amazon.Kinesis
Assembly: AWSSDK.dll
Version: (assembly version)
public class AmazonKinesisClient : AmazonServiceClient IAmazonKinesis, IDisposable
The AmazonKinesisClient type exposes the following members
Name | Description | |
---|---|---|
AmazonKinesisClient() |
Constructs AmazonKinesisClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonKinesisClient(RegionEndpoint) |
Constructs AmazonKinesisClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonKinesisClient(AmazonKinesisConfig) |
Constructs AmazonKinesisClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonKinesisClient(AWSCredentials) | Constructs AmazonKinesisClient with AWS Credentials | |
AmazonKinesisClient(AWSCredentials, RegionEndpoint) | Constructs AmazonKinesisClient with AWS Credentials | |
AmazonKinesisClient(AWSCredentials, AmazonKinesisConfig) | Constructs AmazonKinesisClient with AWS Credentials and an AmazonKinesisClient Configuration object. | |
AmazonKinesisClient(string, string) | Constructs AmazonKinesisClient with AWS Access Key ID and AWS Secret Key | |
AmazonKinesisClient(string, string, RegionEndpoint) | Constructs AmazonKinesisClient with AWS Access Key ID and AWS Secret Key | |
AmazonKinesisClient(string, string, AmazonKinesisConfig) | Constructs AmazonKinesisClient with AWS Access Key ID, AWS Secret Key and an AmazonKinesisClient Configuration object. | |
AmazonKinesisClient(string, string, string) | Constructs AmazonKinesisClient with AWS Access Key ID and AWS Secret Key | |
AmazonKinesisClient(string, string, string, RegionEndpoint) | Constructs AmazonKinesisClient with AWS Access Key ID and AWS Secret Key | |
AmazonKinesisClient(string, string, string, AmazonKinesisConfig) | Constructs AmazonKinesisClient with AWS Access Key ID, AWS Secret Key and an AmazonKinesisClient Configuration object. |
Name | Description | |
---|---|---|
AddTagsToStream(AddTagsToStreamRequest) |
Adds or updates tags for the specified Amazon Kinesis stream. Each stream can have
up to 10 tags.
If tags have already been assigned to the stream, |
|
BeginAddTagsToStream(AddTagsToStreamRequest, AsyncCallback, object) | Initiates the asynchronous execution of the AddTagsToStream operation. | |
BeginCreateStream(CreateStreamRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateStream operation. | |
BeginDecreaseStreamRetentionPeriod(DecreaseStreamRetentionPeriodRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DecreaseStreamRetentionPeriod operation. | |
BeginDeleteStream(DeleteStreamRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DeleteStream operation. | |
BeginDescribeStream(DescribeStreamRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeStream operation. | |
BeginGetRecords(GetRecordsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetRecords operation. | |
BeginGetShardIterator(GetShardIteratorRequest, AsyncCallback, object) | Initiates the asynchronous execution of the GetShardIterator operation. | |
BeginIncreaseStreamRetentionPeriod(IncreaseStreamRetentionPeriodRequest, AsyncCallback, object) | Initiates the asynchronous execution of the IncreaseStreamRetentionPeriod operation. | |
BeginListStreams(ListStreamsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListStreams operation. | |
BeginListTagsForStream(ListTagsForStreamRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ListTagsForStream operation. | |
BeginMergeShards(MergeShardsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the MergeShards operation. | |
BeginPutRecord(PutRecordRequest, AsyncCallback, object) | Initiates the asynchronous execution of the PutRecord operation. | |
BeginPutRecords(PutRecordsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the PutRecords operation. | |
BeginRemoveTagsFromStream(RemoveTagsFromStreamRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RemoveTagsFromStream operation. | |
BeginSplitShard(SplitShardRequest, AsyncCallback, object) | Initiates the asynchronous execution of the SplitShard operation. | |
CreateStream(CreateStreamRequest) |
Creates a Amazon Kinesis stream. A stream captures and transports data records that
are continuously emitted from different data sources or producers. Scale-out
within an Amazon Kinesis stream is explicitly supported by means of shards, which
are uniquely identified groups of data records in an Amazon Kinesis stream.
You specify and control the number of shards that a stream is composed of. Each shard can support reads up to 5 transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases. The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name.
You receive a
For the default shard limit for an AWS account, see Amazon Kinesis Limits. If you need to increase this limit, contact AWS Support.
You can use CreateStream has a limit of 5 transactions per second per account. |
|
DecreaseStreamRetentionPeriod(string, int) |
Decreases the 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. |
|
DecreaseStreamRetentionPeriod(DecreaseStreamRetentionPeriodRequest) |
Decreases the 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. |
|
DeleteStream(DeleteStreamRequest) |
Deletes a 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 will receive the exception ResourceNotFoundException .
If the stream is in the Note: Amazon Kinesis might continue to accept data read and write operations,
such as PutRecord, PutRecords, and GetRecords, on a stream in
the When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.
You can use the DescribeStream operation to check the state of the stream,
which is returned in DeleteStream has a limit of 5 transactions per second per account. |
|
DescribeStream(DescribeStreamRequest) |
Describes the specified stream.
The information about the stream includes its current status, its Amazon Resource Name (ARN), and an array of shard objects. For each shard object, there is information about 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. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream.
You can limit the number of returned shards using the
DescribeStream has a limit of 10 transactions per second per account. |
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
EndAddTagsToStream(IAsyncResult) | Finishes the asynchronous execution of the AddTagsToStream operation. | |
EndCreateStream(IAsyncResult) | Finishes the asynchronous execution of the CreateStream operation. | |
EndDecreaseStreamRetentionPeriod(IAsyncResult) | Finishes the asynchronous execution of the DecreaseStreamRetentionPeriod operation. | |
EndDeleteStream(IAsyncResult) | Finishes the asynchronous execution of the DeleteStream operation. | |
EndDescribeStream(IAsyncResult) | Finishes the asynchronous execution of the DescribeStream operation. | |
EndGetRecords(IAsyncResult) | Finishes the asynchronous execution of the GetRecords operation. | |
EndGetShardIterator(IAsyncResult) | Finishes the asynchronous execution of the GetShardIterator operation. | |
EndIncreaseStreamRetentionPeriod(IAsyncResult) | Finishes the asynchronous execution of the IncreaseStreamRetentionPeriod operation. | |
EndListStreams(IAsyncResult) | Finishes the asynchronous execution of the ListStreams operation. | |
EndListTagsForStream(IAsyncResult) | Finishes the asynchronous execution of the ListTagsForStream operation. | |
EndMergeShards(IAsyncResult) | Finishes the asynchronous execution of the MergeShards operation. | |
EndPutRecord(IAsyncResult) | Finishes the asynchronous execution of the PutRecord operation. | |
EndPutRecords(IAsyncResult) | Finishes the asynchronous execution of the PutRecords operation. | |
EndRemoveTagsFromStream(IAsyncResult) | Finishes the asynchronous execution of the RemoveTagsFromStream operation. | |
EndSplitShard(IAsyncResult) | Finishes the asynchronous execution of the SplitShard operation. | |
GetRecords(GetRecordsRequest) |
Gets data records from a shard.
Specify a shard iterator using the
You can scale by provisioning multiple shards. 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
Each data record can be up to 1 MB in size, and each shard can read up to 2 MB per
second. You can ensure that your calls don't exceed the maximum supported size or
throughput by using the
The size of the data returned by GetRecords will vary depending on the utilization
of the shard. The maximum size of data that GetRecords can return is 10 MB.
If a call returns this amount of data, subsequent calls made within the next 5 seconds
throw
To detect whether the application is falling behind in processing, you can use the
Each Amazon Kinesis record includes a value, |
|
GetShardIterator(GetShardIteratorRequest) |
Gets a shard iterator. A shard iterator expires five minutes after it is returned
to the requester.
A shard iterator specifies 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. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream.
You must specify the shard iterator type. For example, you can set the
When you repeatedly read from an Amazon Kinesis stream use a GetShardIterator
request to get the first shard iterator for use in your first GetRecords request
and then use the shard iterator returned by the GetRecords request in
If a GetShardIterator request is made too often, you receive a
If the shard is closed, the iterator can't return more data, and GetShardIterator
returns GetShardIterator has a limit of 5 transactions per second per account per open shard. |
|
IncreaseStreamRetentionPeriod(string, int) |
Increases the stream's retention period, which is the length of time data records
are accessible after they are added to the stream. The maximum value of a stream’s
retention period is 168 hours (7 days).
Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (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 will remain inaccessible to consumer applications. |
|
IncreaseStreamRetentionPeriod(IncreaseStreamRetentionPeriodRequest) |
Increases the stream's retention period, which is the length of time data records
are accessible after they are added to the stream. The maximum value of a stream’s
retention period is 168 hours (7 days).
Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (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 will remain inaccessible to consumer applications. |
|
ListStreams() |
Lists your streams.
The number of streams may be too large to return from a single call to
You can detect if there are more streams available to list by using the ListStreams has a limit of 5 transactions per second per account. |
|
ListStreams(ListStreamsRequest) |
Lists your streams.
The number of streams may be too large to return from a single call to
You can detect if there are more streams available to list by using the ListStreams has a limit of 5 transactions per second per account. |
|
ListTagsForStream(ListTagsForStreamRequest) | Lists the tags for the specified Amazon Kinesis stream. | |
MergeShards(MergeShardsRequest) |
Merges two adjacent shards in a stream and combines them into a single shard to reduce
the stream's capacity to ingest and transport data. Two shards are considered adjacent
if the union of the hash key ranges for the two shards form a contiguous set with
no gaps. For example, if you have two shards, one with a hash key range of 276...381
and the other with a hash key range of 382...454, then you could merge these two shards
into a single shard that would have a hash key range of 276...454. After the merge,
the single child shard receives data for all hash key values covered by the two parent
shards.
If the stream is in the
You can use DescribeStream to check the state of the stream, which is returned
in
You use DescribeStream to determine the shard IDs that are specified in the
If you try to operate on too many streams in parallel using CreateStream, DeleteStream,
|
|
PutRecord(PutRecordRequest) |
Writes a single data record from a producer into an Amazon Kinesis stream. Call PutRecord
to send data from the producer into the Amazon Kinesis stream for real-time ingestion
and subsequent processing, one record at a time. Each shard can support writes up
to 1,000 records per second, up to a maximum data write total of 1 MB per second.
You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself. The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on. The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a data stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to.
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
Sequence numbers generally increase over time. To guarantee strictly increasing ordering,
use the
If a By default, data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream. This retention period can be modified using the DecreaseStreamRetentionPeriod and IncreaseStreamRetentionPeriod operations. |
|
PutRecords(PutRecordsRequest) |
Writes multiple data records from a producer into an Amazon Kinesis stream in a single
call (also referred to as a PutRecords request). Use this operation to
send data from a data producer into the Amazon Kinesis stream for data ingestion and
processing.
Each
You must specify the name of the stream that captures, stores, and transports the
data; and an array of request 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 Amazon Kinesis 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 Developer Guide.
Each record in the
The
The response
A successfully-processed record includes
An unsuccessfully-processed record includes By default, data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream. This retention period can be modified using the DecreaseStreamRetentionPeriod and IncreaseStreamRetentionPeriod operations. |
|
RemoveTagsFromStream(RemoveTagsFromStreamRequest) |
Deletes tags from the specified Amazon Kinesis stream.
If you specify a tag that does not exist, it is ignored. |
|
SplitShard(SplitShardRequest) |
Splits a shard into two new shards in the 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 stream because of an expected increase in the
volume of data records being ingested.
You can also use 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 simply 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 about splitting shards, see Split a Shard in the Amazon Kinesis Developer Guide.
You can use DescribeStream to determine the shard ID and hash key values for
the
You can use
If the specified stream does not exist, For the default shard limit for an AWS account, see Amazon Kinesis Limits. If you need to increase this limit, contact AWS Support.
If you try to operate on too many streams in parallel using CreateStream, DeleteStream,
MergeShards or SplitShard, you receive a
|
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8