public class AmazonKinesisClient extends AmazonWebServiceClient implements AmazonKinesis
Amazon Kinesis Service API Reference
Amazon Kinesis is a managed service that scales elastically for real time processing of streaming big data.
| Modifier and Type | Field and Description |
|---|---|
protected java.util.List<JsonErrorUnmarshaller> |
jsonErrorUnmarshallers
List of exception unmarshallers for all AmazonKinesis exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset| Constructor and Description |
|---|
AmazonKinesisClient()
Constructs a new client to invoke service methods on
AmazonKinesis.
|
AmazonKinesisClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonKinesis using the specified AWS account credentials.
|
AmazonKinesisClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonKinesis using the specified AWS account credentials
and client configuration options.
|
AmazonKinesisClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonKinesis using the specified AWS account credentials provider.
|
AmazonKinesisClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonKinesis using the specified AWS account credentials
provider and client configuration options.
|
AmazonKinesisClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on
AmazonKinesis using the specified AWS account credentials
provider, client configuration options and request metric collector.
|
AmazonKinesisClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonKinesis.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addTagsToStream(AddTagsToStreamRequest addTagsToStreamRequest)
Adds or updates tags for the specified Amazon Kinesis stream.
|
void |
createStream(CreateStreamRequest createStreamRequest)
Creates a Amazon Kinesis stream.
|
void |
createStream(java.lang.String streamName,
java.lang.Integer shardCount)
Creates a Amazon Kinesis stream.
|
void |
deleteStream(DeleteStreamRequest deleteStreamRequest)
Deletes a stream and all its shards and data.
|
void |
deleteStream(java.lang.String streamName)
Deletes a stream and all its shards and data.
|
DescribeStreamResult |
describeStream(DescribeStreamRequest describeStreamRequest)
Describes the specified stream.
|
DescribeStreamResult |
describeStream(java.lang.String streamName)
Describes the specified stream.
|
DescribeStreamResult |
describeStream(java.lang.String streamName,
java.lang.Integer limit,
java.lang.String exclusiveStartShardId)
Describes the specified stream.
|
DescribeStreamResult |
describeStream(java.lang.String streamName,
java.lang.String exclusiveStartShardId)
Describes the specified stream.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for
debugging issues where a service isn't acting as expected.
|
GetRecordsResult |
getRecords(GetRecordsRequest getRecordsRequest)
Gets data records from a shard.
|
GetShardIteratorResult |
getShardIterator(GetShardIteratorRequest getShardIteratorRequest)
Gets a shard iterator.
|
GetShardIteratorResult |
getShardIterator(java.lang.String streamName,
java.lang.String shardId,
java.lang.String shardIteratorType)
Gets a shard iterator.
|
GetShardIteratorResult |
getShardIterator(java.lang.String streamName,
java.lang.String shardId,
java.lang.String shardIteratorType,
java.lang.String startingSequenceNumber)
Gets a shard iterator.
|
ListStreamsResult |
listStreams()
Lists your streams.
|
ListStreamsResult |
listStreams(java.lang.Integer limit,
java.lang.String exclusiveStartStreamName)
Lists your streams.
|
ListStreamsResult |
listStreams(ListStreamsRequest listStreamsRequest)
Lists your streams.
|
ListStreamsResult |
listStreams(java.lang.String exclusiveStartStreamName)
Lists your streams.
|
ListTagsForStreamResult |
listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest)
Lists the tags for the specified Amazon Kinesis stream.
|
void |
mergeShards(MergeShardsRequest 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.
|
void |
mergeShards(java.lang.String streamName,
java.lang.String shardToMerge,
java.lang.String adjacentShardToMerge)
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.
|
PutRecordResult |
putRecord(PutRecordRequest putRecordRequest)
Puts (writes) a single data record from a producer into an Amazon
Kinesis stream.
|
PutRecordResult |
putRecord(java.lang.String streamName,
java.nio.ByteBuffer data,
java.lang.String partitionKey)
Puts (writes) a single data record from a producer into an Amazon
Kinesis stream.
|
PutRecordResult |
putRecord(java.lang.String streamName,
java.nio.ByteBuffer data,
java.lang.String partitionKey,
java.lang.String sequenceNumberForOrdering)
Puts (writes) a single data record from a producer into an Amazon
Kinesis stream.
|
PutRecordsResult |
putRecords(PutRecordsRequest putRecordsRequest)
Puts (writes) multiple data records from a producer into an Amazon
Kinesis stream in a single call (also referred to as a
PutRecords request). |
void |
removeTagsFromStream(RemoveTagsFromStreamRequest removeTagsFromStreamRequest)
Deletes tags from the specified Amazon Kinesis stream.
|
void |
setEndpoint(java.lang.String endpoint)
Overrides the default endpoint for this client.
|
void |
setEndpoint(java.lang.String endpoint,
java.lang.String serviceName,
java.lang.String regionId)
An internal method that is not expected to be normally
called except for AWS internal development purposes.
|
void |
splitShard(SplitShardRequest splitShardRequest)
Splits a shard into two new shards in the stream, to increase the
stream's capacity to ingest and transport data.
|
void |
splitShard(java.lang.String streamName,
java.lang.String shardToSplit,
java.lang.String newStartingHashKey)
Splits a shard into two new shards in the stream, to increase the
stream's capacity to ingest and transport data.
|
addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetRegion, shutdownprotected java.util.List<JsonErrorUnmarshaller> jsonErrorUnmarshallers
public AmazonKinesisClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic AmazonKinesisClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this
client connects to AmazonKinesis
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic AmazonKinesisClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonKinesisClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this
client connects to AmazonKinesis
(ex: proxy settings, retry counts, etc.).public AmazonKinesisClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonKinesisClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this
client connects to AmazonKinesis
(ex: proxy settings, retry counts, etc.).public AmazonKinesisClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this
client connects to AmazonKinesis
(ex: proxy settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic void addTagsToStream(AddTagsToStreamRequest 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,
AddTagsToStream overwrites any existing tags that
correspond to the specified tag keys.
addTagsToStream in interface AmazonKinesisaddTagsToStreamRequest - Container for the necessary parameters
to execute the AddTagsToStream service method on AmazonKinesis.LimitExceededExceptionResourceInUseExceptionInvalidArgumentExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public PutRecordResult putRecord(PutRecordRequest putRecordRequest)
Puts (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 up
to 1000 records written per second, up to a maximum total of 1 MB data
written 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 bytes. 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
Partition Key
in the Amazon Kinesis 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 generally increase over time. To guarantee strictly
increasing ordering, use the SequenceNumberForOrdering
parameter. For more information, see
Sequence Number
in the Amazon Kinesis Developer Guide .
If a PutRecord request cannot be processed because of
insufficient provisioned throughput on the shard involved in the
request, PutRecord throws
ProvisionedThroughputExceededException .
Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.
putRecord in interface AmazonKinesisputRecordRequest - Container for the necessary parameters to
execute the PutRecord service method on AmazonKinesis.ProvisionedThroughputExceededExceptionInvalidArgumentExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public void createStream(CreateStreamRequest 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 open shard can support up to 5 read transactions per second, up to a maximum total of 2 MB of data read per second. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written 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.
CreateStream is an asynchronous operation. Upon
receiving a CreateStream request, Amazon Kinesis
immediately returns and sets the stream status to
CREATING . After the stream is created, Amazon Kinesis
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 if you try to do one of the
following:
CREATING state at
any point in time.The default limit for an AWS account is 10 shards per stream. If you need to create a stream with more than 10 shards, contact AWS Support to increase the limit on your account.
You can use DescribeStream to check the stream status,
which is returned in StreamStatus .
CreateStream has a limit of 5 transactions per second
per account.
createStream in interface AmazonKinesiscreateStreamRequest - Container for the necessary parameters to
execute the CreateStream service method on AmazonKinesis.LimitExceededExceptionResourceInUseExceptionInvalidArgumentExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public void deleteStream(DeleteStreamRequest 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 ACTIVE state, you can delete it.
After a DeleteStream request, the specified stream is in
the DELETING state until Amazon Kinesis completes the
deletion.
Note: Amazon Kinesis 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 DescribeStream operation to check the state of the
stream, which is returned in StreamStatus .
DeleteStream has a limit of 5 transactions per second
per account.
deleteStream in interface AmazonKinesisdeleteStreamRequest - Container for the necessary parameters to
execute the DeleteStream service method on AmazonKinesis.LimitExceededExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public void mergeShards(MergeShardsRequest 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.
MergeShards is called when there is a need to reduce the
overall capacity of a stream because of excess capacity that is not
being used. You must specify the shard to be merged and the adjacent
shard for a stream. For more information about merging shards, see
Merge Two Shards
in the Amazon Kinesis Developer Guide .
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 DescribeStream to check the state of the stream, which is
returned in StreamStatus .
MergeShards is an asynchronous operation. Upon receiving
a MergeShards request, Amazon Kinesis immediately returns
a response and sets the StreamStatus to
UPDATING . After the operation is completed, Amazon
Kinesis sets the StreamStatus to ACTIVE .
Read and write operations continue to work while the stream is in the
UPDATING state.
You use DescribeStream 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 will receive a LimitExceededException .
MergeShards has limit of 5 transactions per second per
account.
mergeShards in interface AmazonKinesismergeShardsRequest - Container for the necessary parameters to
execute the MergeShards service method on AmazonKinesis.LimitExceededExceptionResourceInUseExceptionInvalidArgumentExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public PutRecordsResult putRecords(PutRecordsRequest putRecordsRequest)
Puts (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 real-time ingestion
and processing. Each shard can support up to 1000 records written per
second, up to a maximum total of 1 MB data written 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 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 Partition Key in the Amazon Kinesis 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 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. Amazon Kinesis attempts to
process all records in each PutRecords request. A single
record failure does not stop the processing of subsequent records.
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.
Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.
putRecords in interface AmazonKinesisputRecordsRequest - Container for the necessary parameters to
execute the PutRecords service method on AmazonKinesis.ProvisionedThroughputExceededExceptionInvalidArgumentExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public DescribeStreamResult describeStream(DescribeStreamRequest 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
Limit parameter. The number of shards in a stream may be
too large to return from a single call to DescribeStream
. You can detect this by using the HasMoreShards flag in
the returned output. HasMoreShards is set to
true when there is more data available.
DescribeStream is a paginated operation. If there are
more shards available, you can request them using the shard ID of the
last shard returned. Specify this ID in the
ExclusiveStartShardId parameter in a subsequent request
to DescribeStream .
DescribeStream has a limit of 10 transactions per second
per account.
describeStream in interface AmazonKinesisdescribeStreamRequest - Container for the necessary parameters to
execute the DescribeStream service method on AmazonKinesis.LimitExceededExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public GetShardIteratorResult getShardIterator(GetShardIteratorRequest 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 ShardIteratorType parameter to read exactly from the
position denoted by a specific sequence number by using the
AT_SEQUENCE_NUMBER shard iterator type, or 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. You can
specify the shard iterator type TRIM_HORIZON in the
request to cause ShardIterator to point to the last
untrimmed record in the shard in the system, which is the oldest data
record in the shard. Or you can point to just after the most recent
record in the shard, by using the shard iterator type
LATEST , so that you always read the most recent data in
the shard.
When you repeatedly read from an Amazon Kinesis stream use a
GetShardIterator request to get the first shard iterator to to use in
your first GetRecords request and then use the shard
iterator returned by the GetRecords request in
NextShardIterator for subsequent reads. 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.
If the shard is closed, the iterator can't return more data, and
GetShardIterator returns null for its
ShardIterator . A shard can be closed using SplitShard or
MergeShards.
GetShardIterator has a limit of 5 transactions per
second per account per open shard.
getShardIterator in interface AmazonKinesisgetShardIteratorRequest - Container for the necessary parameters
to execute the GetShardIterator service method on AmazonKinesis.ProvisionedThroughputExceededExceptionInvalidArgumentExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public ListTagsForStreamResult listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest)
Lists the tags for the specified Amazon Kinesis stream.
listTagsForStream in interface AmazonKinesislistTagsForStreamRequest - Container for the necessary parameters
to execute the ListTagsForStream service method on AmazonKinesis.LimitExceededExceptionInvalidArgumentExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public GetRecordsResult getRecords(GetRecordsRequest getRecordsRequest)
Gets data records from a 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. Note that it
might take multiple calls to get to a portion of the shard that
contains records.
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
NextShardIterator . Specify the shard iterator returned
in NextShardIterator in subsequent calls to
GetRecords . Note that 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 50 KB 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 Limit
parameter to specify the maximum number of records that
GetRecords can return. Consider your average record size
when determining this limit. For example, if your average record size
is 40 KB, you can limit the data returned to about 1 MB per call by
specifying 25 as the limit.
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 10
MB of data, subsequent calls made within the next 5 seconds throw
ProvisionedThroughputExceededException . If there is
insufficient provisioned throughput on the shard, subsequent calls
made within the next 1 second throw
ProvisionedThroughputExceededException . Note that
GetRecords won't return any data when it throws an
exception. For this reason, we recommend that you wait one 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,
add a timestamp to your records and note how long it takes to process
them. You can also monitor how much data is in a stream using the
CloudWatch metrics for write operations ( PutRecord and
PutRecords ). For more information, see
Monitoring Amazon Kinesis with Amazon CloudWatch
in the Amazon Kinesis Developer Guide .
getRecords in interface AmazonKinesisgetRecordsRequest - Container for the necessary parameters to
execute the GetRecords service method on AmazonKinesis.ProvisionedThroughputExceededExceptionExpiredIteratorExceptionInvalidArgumentExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public void splitShard(SplitShardRequest 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 SplitShard when a shard appears to be
approaching its maximum utilization, for example, when the set of
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
Amazon Kinesis 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 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 ShardToSplit and
NewStartingHashKey parameters that are specified in the
SplitShard request.
SplitShard is an asynchronous operation. Upon receiving
a SplitShard request, Amazon Kinesis immediately returns
a response and sets the stream status to UPDATING . After
the operation is completed, Amazon Kinesis sets the stream status to
ACTIVE . Read and write operations continue to work while
the stream is in the UPDATING state.
You can use DescribeStream 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 a stream is in CREATING or
UPDATING or DELETING states,
DescribeStream returns a
ResourceInUseException .
If the specified stream does not exist, DescribeStream
returns a ResourceNotFoundException . If you try to
create more shards than are authorized for your account, you receive a
LimitExceededException .
The default limit for an AWS account is 10 shards per stream. If you need to create a stream with more than 10 shards, contact AWS Support to increase the limit on your account.
If you try to operate on too many streams in parallel using
CreateStream, DeleteStream, MergeShards or SplitShard, you receive a
LimitExceededException .
SplitShard has limit of 5 transactions per second per
account.
splitShard in interface AmazonKinesissplitShardRequest - Container for the necessary parameters to
execute the SplitShard service method on AmazonKinesis.LimitExceededExceptionResourceInUseExceptionInvalidArgumentExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public void removeTagsFromStream(RemoveTagsFromStreamRequest removeTagsFromStreamRequest)
Deletes tags from the specified Amazon Kinesis stream.
If you specify a tag that does not exist, it is ignored.
removeTagsFromStream in interface AmazonKinesisremoveTagsFromStreamRequest - Container for the necessary
parameters to execute the RemoveTagsFromStream service method on
AmazonKinesis.LimitExceededExceptionResourceInUseExceptionInvalidArgumentExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public ListStreamsResult listStreams(ListStreamsRequest listStreamsRequest)
Lists your streams.
The number of streams may be too large to return from a single call
to ListStreams . You can limit the number of returned
streams using the Limit parameter. If you do not specify
a value for the Limit parameter, Amazon Kinesis uses the
default limit, which is currently 10.
You can detect if there are more streams available to list by using
the HasMoreStreams flag from the returned output. If
there are more streams available, you can request more streams by
using the name of the last stream returned by the
ListStreams request in the
ExclusiveStartStreamName parameter in a subsequent
request to ListStreams . The group of stream names
returned by the subsequent request is then added to the list. You can
continue this process until all the stream names have been collected
in the list.
ListStreams has a limit of 5 transactions per second per
account.
listStreams in interface AmazonKinesislistStreamsRequest - Container for the necessary parameters to
execute the ListStreams service method on AmazonKinesis.LimitExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public ListStreamsResult listStreams() throws AmazonServiceException, AmazonClientException
Lists your streams.
The number of streams may be too large to return from a single call
to ListStreams . You can limit the number of returned
streams using the Limit parameter. If you do not specify
a value for the Limit parameter, Amazon Kinesis uses the
default limit, which is currently 10.
You can detect if there are more streams available to list by using
the HasMoreStreams flag from the returned output. If
there are more streams available, you can request more streams by
using the name of the last stream returned by the
ListStreams request in the
ExclusiveStartStreamName parameter in a subsequent
request to ListStreams . The group of stream names
returned by the subsequent request is then added to the list. You can
continue this process until all the stream names have been collected
in the list.
ListStreams has a limit of 5 transactions per second per
account.
listStreams in interface AmazonKinesisLimitExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public PutRecordResult putRecord(java.lang.String streamName, java.nio.ByteBuffer data, java.lang.String partitionKey) throws AmazonServiceException, AmazonClientException
Puts (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 up
to 1000 records written per second, up to a maximum total of 1 MB data
written 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 bytes. 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
Partition Key
in the Amazon Kinesis 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 generally increase over time. To guarantee strictly
increasing ordering, use the SequenceNumberForOrdering
parameter. For more information, see
Sequence Number
in the Amazon Kinesis Developer Guide .
If a PutRecord request cannot be processed because of
insufficient provisioned throughput on the shard involved in the
request, PutRecord throws
ProvisionedThroughputExceededException .
Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.
putRecord in interface AmazonKinesisstreamName - The name of the stream to put the data record into.data - The data blob to put into the record, which is
base64-encoded when the blob is serialized. The maximum size of the
data blob (the payload before base64-encoding) is 50 kilobytes (KB)partitionKey - Determines which shard in the stream the data
record is assigned to. Partition keys are Unicode strings with a
maximum length limit of 256 bytes. Amazon Kinesis 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 will map to
the same shard within the stream.ProvisionedThroughputExceededExceptionInvalidArgumentExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public PutRecordResult putRecord(java.lang.String streamName, java.nio.ByteBuffer data, java.lang.String partitionKey, java.lang.String sequenceNumberForOrdering) throws AmazonServiceException, AmazonClientException
Puts (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 up
to 1000 records written per second, up to a maximum total of 1 MB data
written 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 bytes. 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
Partition Key
in the Amazon Kinesis 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 generally increase over time. To guarantee strictly
increasing ordering, use the SequenceNumberForOrdering
parameter. For more information, see
Sequence Number
in the Amazon Kinesis Developer Guide .
If a PutRecord request cannot be processed because of
insufficient provisioned throughput on the shard involved in the
request, PutRecord throws
ProvisionedThroughputExceededException .
Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.
putRecord in interface AmazonKinesisstreamName - The name of the stream to put the data record into.data - The data blob to put into the record, which is
base64-encoded when the blob is serialized. The maximum size of the
data blob (the payload before base64-encoding) is 50 kilobytes (KB)partitionKey - Determines which shard in the stream the data
record is assigned to. Partition keys are Unicode strings with a
maximum length limit of 256 bytes. Amazon Kinesis 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 will map to
the same shard within the stream.sequenceNumberForOrdering - 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 PutRecordResult when putting record
n-1). If this parameter is not set, records will be coarsely
ordered based on arrival time.ProvisionedThroughputExceededExceptionInvalidArgumentExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public void createStream(java.lang.String streamName,
java.lang.Integer shardCount)
throws AmazonServiceException,
AmazonClientException
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 open shard can support up to 5 read transactions per second, up to a maximum total of 2 MB of data read per second. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written 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.
CreateStream is an asynchronous operation. Upon
receiving a CreateStream request, Amazon Kinesis
immediately returns and sets the stream status to
CREATING . After the stream is created, Amazon Kinesis
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 if you try to do one of the
following:
CREATING state at
any point in time.The default limit for an AWS account is 10 shards per stream. If you need to create a stream with more than 10 shards, contact AWS Support to increase the limit on your account.
You can use DescribeStream to check the stream status,
which is returned in StreamStatus .
CreateStream has a limit of 5 transactions per second
per account.
createStream in interface AmazonKinesisstreamName - 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 region. That is, two streams in two
different AWS accounts can have the same name, and two streams in the
same AWS account, but in two different regions, can have the same
name.shardCount - 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.
Note: The default limit for an AWS account is 10 shards per stream. If you need to create a stream with more than 10 shards, contact AWS Support to increase the limit on your account.
LimitExceededExceptionResourceInUseExceptionInvalidArgumentExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public void deleteStream(java.lang.String streamName)
throws AmazonServiceException,
AmazonClientException
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 ACTIVE state, you can delete it.
After a DeleteStream request, the specified stream is in
the DELETING state until Amazon Kinesis completes the
deletion.
Note: Amazon Kinesis 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 DescribeStream operation to check the state of the
stream, which is returned in StreamStatus .
DeleteStream has a limit of 5 transactions per second
per account.
deleteStream in interface AmazonKinesisstreamName - The name of the stream to delete.LimitExceededExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public void mergeShards(java.lang.String streamName,
java.lang.String shardToMerge,
java.lang.String adjacentShardToMerge)
throws AmazonServiceException,
AmazonClientException
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.
MergeShards is called when there is a need to reduce the
overall capacity of a stream because of excess capacity that is not
being used. You must specify the shard to be merged and the adjacent
shard for a stream. For more information about merging shards, see
Merge Two Shards
in the Amazon Kinesis Developer Guide .
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 DescribeStream to check the state of the stream, which is
returned in StreamStatus .
MergeShards is an asynchronous operation. Upon receiving
a MergeShards request, Amazon Kinesis immediately returns
a response and sets the StreamStatus to
UPDATING . After the operation is completed, Amazon
Kinesis sets the StreamStatus to ACTIVE .
Read and write operations continue to work while the stream is in the
UPDATING state.
You use DescribeStream 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 will receive a LimitExceededException .
MergeShards has limit of 5 transactions per second per
account.
mergeShards in interface AmazonKinesisstreamName - The name of the stream for the merge.shardToMerge - The shard ID of the shard to combine with the
adjacent shard for the merge.adjacentShardToMerge - The shard ID of the adjacent shard for the
merge.LimitExceededExceptionResourceInUseExceptionInvalidArgumentExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public DescribeStreamResult describeStream(java.lang.String streamName) throws AmazonServiceException, AmazonClientException
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
Limit parameter. The number of shards in a stream may be
too large to return from a single call to DescribeStream
. You can detect this by using the HasMoreShards flag in
the returned output. HasMoreShards is set to
true when there is more data available.
DescribeStream is a paginated operation. If there are
more shards available, you can request them using the shard ID of the
last shard returned. Specify this ID in the
ExclusiveStartShardId parameter in a subsequent request
to DescribeStream .
DescribeStream has a limit of 10 transactions per second
per account.
describeStream in interface AmazonKinesisstreamName - The name of the stream to describe.LimitExceededExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public DescribeStreamResult describeStream(java.lang.String streamName, java.lang.String exclusiveStartShardId) throws AmazonServiceException, AmazonClientException
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
Limit parameter. The number of shards in a stream may be
too large to return from a single call to DescribeStream
. You can detect this by using the HasMoreShards flag in
the returned output. HasMoreShards is set to
true when there is more data available.
DescribeStream is a paginated operation. If there are
more shards available, you can request them using the shard ID of the
last shard returned. Specify this ID in the
ExclusiveStartShardId parameter in a subsequent request
to DescribeStream .
DescribeStream has a limit of 10 transactions per second
per account.
describeStream in interface AmazonKinesisstreamName - The name of the stream to describe.exclusiveStartShardId - The shard ID of the shard to start with.LimitExceededExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public DescribeStreamResult describeStream(java.lang.String streamName, java.lang.Integer limit, java.lang.String exclusiveStartShardId) throws AmazonServiceException, AmazonClientException
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
Limit parameter. The number of shards in a stream may be
too large to return from a single call to DescribeStream
. You can detect this by using the HasMoreShards flag in
the returned output. HasMoreShards is set to
true when there is more data available.
DescribeStream is a paginated operation. If there are
more shards available, you can request them using the shard ID of the
last shard returned. Specify this ID in the
ExclusiveStartShardId parameter in a subsequent request
to DescribeStream .
DescribeStream has a limit of 10 transactions per second
per account.
describeStream in interface AmazonKinesisstreamName - The name of the stream to describe.limit - The maximum number of shards to return.exclusiveStartShardId - The shard ID of the shard to start with.LimitExceededExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public GetShardIteratorResult getShardIterator(java.lang.String streamName, java.lang.String shardId, java.lang.String shardIteratorType) throws AmazonServiceException, AmazonClientException
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 ShardIteratorType parameter to read exactly from the
position denoted by a specific sequence number by using the
AT_SEQUENCE_NUMBER shard iterator type, or 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. You can
specify the shard iterator type TRIM_HORIZON in the
request to cause ShardIterator to point to the last
untrimmed record in the shard in the system, which is the oldest data
record in the shard. Or you can point to just after the most recent
record in the shard, by using the shard iterator type
LATEST , so that you always read the most recent data in
the shard.
When you repeatedly read from an Amazon Kinesis stream use a
GetShardIterator request to get the first shard iterator to to use in
your first GetRecords request and then use the shard
iterator returned by the GetRecords request in
NextShardIterator for subsequent reads. 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.
If the shard is closed, the iterator can't return more data, and
GetShardIterator returns null for its
ShardIterator . A shard can be closed using SplitShard or
MergeShards.
GetShardIterator has a limit of 5 transactions per
second per account per open shard.
getShardIterator in interface AmazonKinesisstreamName - The name of the stream.shardId - The shard ID of the shard to get the iterator for.shardIteratorType - Determines how the shard iterator is used to
start reading data records from the shard. The following are the valid shard iterator types:
ProvisionedThroughputExceededExceptionInvalidArgumentExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public GetShardIteratorResult getShardIterator(java.lang.String streamName, java.lang.String shardId, java.lang.String shardIteratorType, java.lang.String startingSequenceNumber) throws AmazonServiceException, AmazonClientException
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 ShardIteratorType parameter to read exactly from the
position denoted by a specific sequence number by using the
AT_SEQUENCE_NUMBER shard iterator type, or 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. You can
specify the shard iterator type TRIM_HORIZON in the
request to cause ShardIterator to point to the last
untrimmed record in the shard in the system, which is the oldest data
record in the shard. Or you can point to just after the most recent
record in the shard, by using the shard iterator type
LATEST , so that you always read the most recent data in
the shard.
When you repeatedly read from an Amazon Kinesis stream use a
GetShardIterator request to get the first shard iterator to to use in
your first GetRecords request and then use the shard
iterator returned by the GetRecords request in
NextShardIterator for subsequent reads. 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.
If the shard is closed, the iterator can't return more data, and
GetShardIterator returns null for its
ShardIterator . A shard can be closed using SplitShard or
MergeShards.
GetShardIterator has a limit of 5 transactions per
second per account per open shard.
getShardIterator in interface AmazonKinesisstreamName - The name of the stream.shardId - The shard ID of the shard to get the iterator for.shardIteratorType - Determines how the shard iterator is used to
start reading data records from the shard. The following are the valid shard iterator types:
startingSequenceNumber - The sequence number of the data record
in the shard from which to start reading from.ProvisionedThroughputExceededExceptionInvalidArgumentExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public void splitShard(java.lang.String streamName,
java.lang.String shardToSplit,
java.lang.String newStartingHashKey)
throws AmazonServiceException,
AmazonClientException
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 SplitShard when a shard appears to be
approaching its maximum utilization, for example, when the set of
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
Amazon Kinesis 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 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 ShardToSplit and
NewStartingHashKey parameters that are specified in the
SplitShard request.
SplitShard is an asynchronous operation. Upon receiving
a SplitShard request, Amazon Kinesis immediately returns
a response and sets the stream status to UPDATING . After
the operation is completed, Amazon Kinesis sets the stream status to
ACTIVE . Read and write operations continue to work while
the stream is in the UPDATING state.
You can use DescribeStream 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 a stream is in CREATING or
UPDATING or DELETING states,
DescribeStream returns a
ResourceInUseException .
If the specified stream does not exist, DescribeStream
returns a ResourceNotFoundException . If you try to
create more shards than are authorized for your account, you receive a
LimitExceededException .
The default limit for an AWS account is 10 shards per stream. If you need to create a stream with more than 10 shards, contact AWS Support to increase the limit on your account.
If you try to operate on too many streams in parallel using
CreateStream, DeleteStream, MergeShards or SplitShard, you receive a
LimitExceededException .
SplitShard has limit of 5 transactions per second per
account.
splitShard in interface AmazonKinesisstreamName - The name of the stream for the shard split.shardToSplit - The shard ID of the shard to split.newStartingHashKey - 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.LimitExceededExceptionResourceInUseExceptionInvalidArgumentExceptionResourceNotFoundExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public ListStreamsResult listStreams(java.lang.String exclusiveStartStreamName) throws AmazonServiceException, AmazonClientException
Lists your streams.
The number of streams may be too large to return from a single call
to ListStreams . You can limit the number of returned
streams using the Limit parameter. If you do not specify
a value for the Limit parameter, Amazon Kinesis uses the
default limit, which is currently 10.
You can detect if there are more streams available to list by using
the HasMoreStreams flag from the returned output. If
there are more streams available, you can request more streams by
using the name of the last stream returned by the
ListStreams request in the
ExclusiveStartStreamName parameter in a subsequent
request to ListStreams . The group of stream names
returned by the subsequent request is then added to the list. You can
continue this process until all the stream names have been collected
in the list.
ListStreams has a limit of 5 transactions per second per
account.
listStreams in interface AmazonKinesisexclusiveStartStreamName - The name of the stream to start the
list with.LimitExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public ListStreamsResult listStreams(java.lang.Integer limit, java.lang.String exclusiveStartStreamName) throws AmazonServiceException, AmazonClientException
Lists your streams.
The number of streams may be too large to return from a single call
to ListStreams . You can limit the number of returned
streams using the Limit parameter. If you do not specify
a value for the Limit parameter, Amazon Kinesis uses the
default limit, which is currently 10.
You can detect if there are more streams available to list by using
the HasMoreStreams flag from the returned output. If
there are more streams available, you can request more streams by
using the name of the last stream returned by the
ListStreams request in the
ExclusiveStartStreamName parameter in a subsequent
request to ListStreams . The group of stream names
returned by the subsequent request is then added to the list. You can
continue this process until all the stream names have been collected
in the list.
ListStreams has a limit of 5 transactions per second per
account.
listStreams in interface AmazonKinesislimit - The maximum number of streams to list.exclusiveStartStreamName - The name of the stream to start the
list with.LimitExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonKinesis indicating
either a problem with the data in the request, or a server side issue.public void setEndpoint(java.lang.String endpoint)
AmazonWebServiceClientThis method is not threadsafe. Endpoints should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit.
Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full
URL, including the protocol (ex: "https://ec2.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
setEndpoint in interface AmazonKinesissetEndpoint in class AmazonWebServiceClientendpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL,
including the protocol (ex: "https://ec2.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.public void setEndpoint(java.lang.String endpoint,
java.lang.String serviceName,
java.lang.String regionId)
throws java.lang.IllegalArgumentException
AmazonWebServiceClientOverrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.
Callers can pass in just the endpoint (ex:
"dynamodb.us-east-1.amazonaws.com/") or a full URL, including the
protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
setEndpoint in class AmazonWebServiceClientendpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a
full URL, including the protocol (ex:
"http://dynamodb.us-east-1.amazonaws.com/") of the region
specific AWS endpoint this client will communicate with.serviceName - This parameter is ignored.regionId - The ID of the region in which this service resides AND the
overriding region for signing purposes.java.lang.IllegalArgumentException - If any problems are detected with the specified endpoint.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonKinesisrequest - The originally executed request