AmazonKinesisAsyncClient (AWS Java SDK for Amazon Kinesis 1.9.25 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.kinesis.AmazonKinesisClient
  - - com.amazonaws.services.kinesis.AmazonKinesisAsyncClient

All Implemented Interfaces:

AmazonKinesis, AmazonKinesisAsync
```
public class AmazonKinesisAsyncClient
extends AmazonKinesisClient
implements AmazonKinesisAsync
```
Asynchronous client for accessing AmazonKinesis. All asynchronous calls made using this client are non-blocking. Callers could either process the result and handle the exceptions in the worker thread by providing a callback handler when making the call, or use the returned Future object to check the result of the call in the calling thread. Amazon Kinesis Service API Reference
Amazon Kinesis is a managed service that scales elastically for real time processing of streaming big data.

Field Summary
- Fields inherited from class com.amazonaws.services.kinesis.AmazonKinesisClient
  jsonErrorUnmarshallers
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors
Constructor and Description
`AmazonKinesisAsyncClient()` Constructs a new asynchronous client to invoke service methods on AmazonKinesis.
`AmazonKinesisAsyncClient(AWSCredentials awsCredentials)` Constructs a new asynchronous client to invoke service methods on AmazonKinesis using the specified AWS account credentials.
`AmazonKinesisAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on AmazonKinesis using the specified AWS account credentials, executor service, and client configuration options.
`AmazonKinesisAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on AmazonKinesis using the specified AWS account credentials and executor service.
`AmazonKinesisAsyncClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new asynchronous client to invoke service methods on AmazonKinesis using the specified AWS account credentials provider.
`AmazonKinesisAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new asynchronous client to invoke service methods on AmazonKinesis using the specified AWS account credentials provider and client configuration options.
`AmazonKinesisAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on AmazonKinesis using the specified AWS account credentials provider, executor service, and client configuration options.
`AmazonKinesisAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)` Constructs a new asynchronous client to invoke service methods on AmazonKinesis using the specified AWS account credentials provider and executor service.
`AmazonKinesisAsyncClient(ClientConfiguration clientConfiguration)` Constructs a new asynchronous client to invoke service methods on AmazonKinesis.

Method Summary

Methods
Modifier and Type	Method and Description
`Future<Void>`	`addTagsToStreamAsync(AddTagsToStreamRequest addTagsToStreamRequest)` Adds or updates tags for the specified Amazon Kinesis stream.
`Future<Void>`	`addTagsToStreamAsync(AddTagsToStreamRequest addTagsToStreamRequest, AsyncHandler<AddTagsToStreamRequest,Void> asyncHandler)` Adds or updates tags for the specified Amazon Kinesis stream.
`Future<Void>`	`createStreamAsync(CreateStreamRequest createStreamRequest)` Creates a Amazon Kinesis stream.
`Future<Void>`	`createStreamAsync(CreateStreamRequest createStreamRequest, AsyncHandler<CreateStreamRequest,Void> asyncHandler)` Creates a Amazon Kinesis stream.
`Future<Void>`	`deleteStreamAsync(DeleteStreamRequest deleteStreamRequest)` Deletes a stream and all its shards and data.
`Future<Void>`	`deleteStreamAsync(DeleteStreamRequest deleteStreamRequest, AsyncHandler<DeleteStreamRequest,Void> asyncHandler)` Deletes a stream and all its shards and data.
`Future<DescribeStreamResult>`	`describeStreamAsync(DescribeStreamRequest describeStreamRequest)` Describes the specified stream.
`Future<DescribeStreamResult>`	`describeStreamAsync(DescribeStreamRequest describeStreamRequest, AsyncHandler<DescribeStreamRequest,DescribeStreamResult> asyncHandler)` Describes the specified stream.
`ExecutorService`	`getExecutorService()` Returns the executor service used by this async client to execute requests.
`Future<GetRecordsResult>`	`getRecordsAsync(GetRecordsRequest getRecordsRequest)` Gets data records from a shard.
`Future<GetRecordsResult>`	`getRecordsAsync(GetRecordsRequest getRecordsRequest, AsyncHandler<GetRecordsRequest,GetRecordsResult> asyncHandler)` Gets data records from a shard.
`Future<GetShardIteratorResult>`	`getShardIteratorAsync(GetShardIteratorRequest getShardIteratorRequest)` Gets a shard iterator.
`Future<GetShardIteratorResult>`	`getShardIteratorAsync(GetShardIteratorRequest getShardIteratorRequest, AsyncHandler<GetShardIteratorRequest,GetShardIteratorResult> asyncHandler)` Gets a shard iterator.
`Future<ListStreamsResult>`	`listStreamsAsync(ListStreamsRequest listStreamsRequest)` Lists your streams.
`Future<ListStreamsResult>`	`listStreamsAsync(ListStreamsRequest listStreamsRequest, AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)` Lists your streams.
`Future<ListTagsForStreamResult>`	`listTagsForStreamAsync(ListTagsForStreamRequest listTagsForStreamRequest)` Lists the tags for the specified Amazon Kinesis stream.
`Future<ListTagsForStreamResult>`	`listTagsForStreamAsync(ListTagsForStreamRequest listTagsForStreamRequest, AsyncHandler<ListTagsForStreamRequest,ListTagsForStreamResult> asyncHandler)` Lists the tags for the specified Amazon Kinesis stream.
`Future<Void>`	`mergeShardsAsync(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.
`Future<Void>`	`mergeShardsAsync(MergeShardsRequest mergeShardsRequest, AsyncHandler<MergeShardsRequest,Void> asyncHandler)` 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.
`Future<PutRecordResult>`	`putRecordAsync(PutRecordRequest putRecordRequest)` Puts (writes) a single data record from a producer into an Amazon Kinesis stream.
`Future<PutRecordResult>`	`putRecordAsync(PutRecordRequest putRecordRequest, AsyncHandler<PutRecordRequest,PutRecordResult> asyncHandler)` Puts (writes) a single data record from a producer into an Amazon Kinesis stream.
`Future<PutRecordsResult>`	`putRecordsAsync(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).
`Future<PutRecordsResult>`	`putRecordsAsync(PutRecordsRequest putRecordsRequest, AsyncHandler<PutRecordsRequest,PutRecordsResult> asyncHandler)` Puts (writes) multiple data records from a producer into an Amazon Kinesis stream in a single call (also referred to as a `PutRecords` request).
`Future<Void>`	`removeTagsFromStreamAsync(RemoveTagsFromStreamRequest removeTagsFromStreamRequest)` Deletes tags from the specified Amazon Kinesis stream.
`Future<Void>`	`removeTagsFromStreamAsync(RemoveTagsFromStreamRequest removeTagsFromStreamRequest, AsyncHandler<RemoveTagsFromStreamRequest,Void> asyncHandler)` Deletes tags from the specified Amazon Kinesis stream.
`void`	`shutdown()` Shuts down the client, releasing all managed resources.
`Future<Void>`	`splitShardAsync(SplitShardRequest splitShardRequest)` Splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data.
`Future<Void>`	`splitShardAsync(SplitShardRequest splitShardRequest, AsyncHandler<SplitShardRequest,Void> asyncHandler)` Splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data.

Methods inherited from class com.amazonaws.services.kinesis.AmazonKinesisClient
addTagsToStream, createStream, createStream, deleteStream, deleteStream, describeStream, describeStream, describeStream, describeStream, getCachedResponseMetadata, getRecords, getShardIterator, getShardIterator, getShardIterator, listStreams, listStreams, listStreams, listStreams, listTagsForStream, mergeShards, mergeShards, putRecord, putRecord, putRecord, putRecords, removeTagsFromStream, setEndpoint, setEndpoint, splitShard, splitShard

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.kinesis.AmazonKinesis
addTagsToStream, createStream, createStream, deleteStream, deleteStream, describeStream, describeStream, describeStream, describeStream, getCachedResponseMetadata, getRecords, getShardIterator, getShardIterator, getShardIterator, listStreams, listStreams, listStreams, listStreams, listTagsForStream, mergeShards, mergeShards, putRecord, putRecord, putRecord, putRecords, removeTagsFromStream, setEndpoint, setRegion, splitShard, splitShard

- Constructor Detail
  - AmazonKinesisAsyncClient
```
public AmazonKinesisAsyncClient()
```
    Constructs a new asynchronous client to invoke service methods on AmazonKinesis. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    DefaultAWSCredentialsProviderChain
  - AmazonKinesisAsyncClient
```
public AmazonKinesisAsyncClient(ClientConfiguration clientConfiguration)
```
    Constructs a new asynchronous client to invoke service methods on AmazonKinesis. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    clientConfiguration - The client configuration options controlling how this client connects to AmazonKinesis (ex: proxy settings, retry counts, etc.).
    See Also:
    DefaultAWSCredentialsProviderChain
  - AmazonKinesisAsyncClient
```
public AmazonKinesisAsyncClient(AWSCredentials awsCredentials)
```
    Constructs a new asynchronous client to invoke service methods on AmazonKinesis using the specified AWS account credentials. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.
    All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
    
    Parameters:
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AmazonKinesisAsyncClient
```
public AmazonKinesisAsyncClient(AWSCredentials awsCredentials,
                        ExecutorService executorService)
```
    Constructs a new asynchronous client to invoke service methods on AmazonKinesis using the specified AWS account credentials and executor service. Default client settings will be used.
    All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
    
    Parameters:
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    executorService - The executor service by which all asynchronous requests will be executed.
  - AmazonKinesisAsyncClient
```
public AmazonKinesisAsyncClient(AWSCredentials awsCredentials,
                        ClientConfiguration clientConfiguration,
                        ExecutorService executorService)
```
    Constructs a new asynchronous client to invoke service methods on AmazonKinesis using the specified AWS account credentials, executor service, and client configuration options.
    All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
    
    Parameters:
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
    executorService - The executor service by which all asynchronous requests will be executed.
  - AmazonKinesisAsyncClient
```
public AmazonKinesisAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Constructs a new asynchronous client to invoke service methods on AmazonKinesis using the specified AWS account credentials provider. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.
    All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AmazonKinesisAsyncClient
```
public AmazonKinesisAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                        ExecutorService executorService)
```
    Constructs a new asynchronous client to invoke service methods on AmazonKinesis using the specified AWS account credentials provider and executor service. Default client settings will be used.
    All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    executorService - The executor service by which all asynchronous requests will be executed.
  - AmazonKinesisAsyncClient
```
public AmazonKinesisAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                        ClientConfiguration clientConfiguration)
```
    Constructs a new asynchronous client to invoke service methods on AmazonKinesis using the specified AWS account credentials provider and client configuration options.
    All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
  - AmazonKinesisAsyncClient
```
public AmazonKinesisAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                        ClientConfiguration clientConfiguration,
                        ExecutorService executorService)
```
    Constructs a new asynchronous client to invoke service methods on AmazonKinesis using the specified AWS account credentials provider, executor service, and client configuration options.
    All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
    executorService - The executor service by which all asynchronous requests will be executed.
- Method Detail
  - getExecutorService
```
public ExecutorService getExecutorService()
```
    Returns the executor service used by this async client to execute requests.
    
    Returns:
    The executor service used by this async client to execute requests.
  - shutdown
```
public void shutdown()
```
    Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.
    
    Specified by:
    
    shutdown in interface AmazonKinesis
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient
  - addTagsToStreamAsync
```
public Future<Void> addTagsToStreamAsync(AddTagsToStreamRequest addTagsToStreamRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException
```
    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.
    
    Specified by:
    
    addTagsToStreamAsync in interface AmazonKinesisAsync
    
    Parameters:
    addTagsToStreamRequest - Container for the necessary parameters to execute the AddTagsToStream operation on AmazonKinesis.
    
    Returns:
    A Java Future object containing the response from the AddTagsToStream service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - addTagsToStreamAsync
```
public Future<Void> addTagsToStreamAsync(AddTagsToStreamRequest addTagsToStreamRequest,
                                AsyncHandler<AddTagsToStreamRequest,Void> asyncHandler)
                                  throws AmazonServiceException,
                                         AmazonClientException
```
    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.
    
    Specified by:
    
    addTagsToStreamAsync in interface AmazonKinesisAsync
    
    Parameters:
    addTagsToStreamRequest - Container for the necessary parameters to execute the AddTagsToStream operation on AmazonKinesis.
    asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
    
    Returns:
    A Java Future object containing the response from the AddTagsToStream service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - putRecordAsync
```
public Future<PutRecordResult> putRecordAsync(PutRecordRequest putRecordRequest)
                                       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.
    
    Specified by:
    
    putRecordAsync in interface AmazonKinesisAsync
    
    Parameters:
    putRecordRequest - Container for the necessary parameters to execute the PutRecord operation on AmazonKinesis.
    
    Returns:
    A Java Future object containing the response from the PutRecord service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - putRecordAsync
```
public Future<PutRecordResult> putRecordAsync(PutRecordRequest putRecordRequest,
                                     AsyncHandler<PutRecordRequest,PutRecordResult> asyncHandler)
                                       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.
    
    Specified by:
    
    putRecordAsync in interface AmazonKinesisAsync
    
    Parameters:
    putRecordRequest - Container for the necessary parameters to execute the PutRecord operation on AmazonKinesis.
    asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
    
    Returns:
    A Java Future object containing the response from the PutRecord service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - createStreamAsync
```
public Future<Void> createStreamAsync(CreateStreamRequest createStreamRequest)
                               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:
    - Have more than five streams in the CREATING state at any point in time.
    - Create more shards than are authorized for your account.
    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.
    Specified by:
    
    createStreamAsync in interface AmazonKinesisAsync
    
    Parameters:
    createStreamRequest - Container for the necessary parameters to execute the CreateStream operation on AmazonKinesis.
    
    Returns:
    A Java Future object containing the response from the CreateStream service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - createStreamAsync
```
public Future<Void> createStreamAsync(CreateStreamRequest createStreamRequest,
                             AsyncHandler<CreateStreamRequest,Void> asyncHandler)
                               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:
    - Have more than five streams in the CREATING state at any point in time.
    - Create more shards than are authorized for your account.
    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.
    Specified by:
    
    createStreamAsync in interface AmazonKinesisAsync
    
    Parameters:
    createStreamRequest - Container for the necessary parameters to execute the CreateStream operation on AmazonKinesis.
    asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
    
    Returns:
    A Java Future object containing the response from the CreateStream service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - deleteStreamAsync
```
public Future<Void> deleteStreamAsync(DeleteStreamRequest deleteStreamRequest)
                               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.
    
    Specified by:
    
    deleteStreamAsync in interface AmazonKinesisAsync
    
    Parameters:
    deleteStreamRequest - Container for the necessary parameters to execute the DeleteStream operation on AmazonKinesis.
    
    Returns:
    A Java Future object containing the response from the DeleteStream service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - deleteStreamAsync
```
public Future<Void> deleteStreamAsync(DeleteStreamRequest deleteStreamRequest,
                             AsyncHandler<DeleteStreamRequest,Void> asyncHandler)
                               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.
    
    Specified by:
    
    deleteStreamAsync in interface AmazonKinesisAsync
    
    Parameters:
    deleteStreamRequest - Container for the necessary parameters to execute the DeleteStream operation on AmazonKinesis.
    asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
    
    Returns:
    A Java Future object containing the response from the DeleteStream service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - mergeShardsAsync
```
public Future<Void> mergeShardsAsync(MergeShardsRequest mergeShardsRequest)
                              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.
    
    Specified by:
    
    mergeShardsAsync in interface AmazonKinesisAsync
    
    Parameters:
    mergeShardsRequest - Container for the necessary parameters to execute the MergeShards operation on AmazonKinesis.
    
    Returns:
    A Java Future object containing the response from the MergeShards service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - mergeShardsAsync
```
public Future<Void> mergeShardsAsync(MergeShardsRequest mergeShardsRequest,
                            AsyncHandler<MergeShardsRequest,Void> asyncHandler)
                              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.
    
    Specified by:
    
    mergeShardsAsync in interface AmazonKinesisAsync
    
    Parameters:
    mergeShardsRequest - Container for the necessary parameters to execute the MergeShards operation on AmazonKinesis.
    asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
    
    Returns:
    A Java Future object containing the response from the MergeShards service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - putRecordsAsync
```
public Future<PutRecordsResult> putRecordsAsync(PutRecordsRequest putRecordsRequest)
                                         throws AmazonServiceException,
                                                AmazonClientException
```
    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.
    
    Specified by:
    
    putRecordsAsync in interface AmazonKinesisAsync
    
    Parameters:
    putRecordsRequest - Container for the necessary parameters to execute the PutRecords operation on AmazonKinesis.
    
    Returns:
    A Java Future object containing the response from the PutRecords service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - putRecordsAsync
```
public Future<PutRecordsResult> putRecordsAsync(PutRecordsRequest putRecordsRequest,
                                       AsyncHandler<PutRecordsRequest,PutRecordsResult> asyncHandler)
                                         throws AmazonServiceException,
                                                AmazonClientException
```
    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.
    
    Specified by:
    
    putRecordsAsync in interface AmazonKinesisAsync
    
    Parameters:
    putRecordsRequest - Container for the necessary parameters to execute the PutRecords operation on AmazonKinesis.
    asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
    
    Returns:
    A Java Future object containing the response from the PutRecords service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - describeStreamAsync
```
public Future<DescribeStreamResult> describeStreamAsync(DescribeStreamRequest describeStreamRequest)
                                                 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.
    
    Specified by:
    
    describeStreamAsync in interface AmazonKinesisAsync
    
    Parameters:
    describeStreamRequest - Container for the necessary parameters to execute the DescribeStream operation on AmazonKinesis.
    
    Returns:
    A Java Future object containing the response from the DescribeStream service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - describeStreamAsync
```
public Future<DescribeStreamResult> describeStreamAsync(DescribeStreamRequest describeStreamRequest,
                                               AsyncHandler<DescribeStreamRequest,DescribeStreamResult> asyncHandler)
                                                 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.
    
    Specified by:
    
    describeStreamAsync in interface AmazonKinesisAsync
    
    Parameters:
    describeStreamRequest - Container for the necessary parameters to execute the DescribeStream operation on AmazonKinesis.
    asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
    
    Returns:
    A Java Future object containing the response from the DescribeStream service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - getShardIteratorAsync
```
public Future<GetShardIteratorResult> getShardIteratorAsync(GetShardIteratorRequest getShardIteratorRequest)
                                                     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.
    
    Specified by:
    
    getShardIteratorAsync in interface AmazonKinesisAsync
    
    Parameters:
    getShardIteratorRequest - Container for the necessary parameters to execute the GetShardIterator operation on AmazonKinesis.
    
    Returns:
    A Java Future object containing the response from the GetShardIterator service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - getShardIteratorAsync
```
public Future<GetShardIteratorResult> getShardIteratorAsync(GetShardIteratorRequest getShardIteratorRequest,
                                                   AsyncHandler<GetShardIteratorRequest,GetShardIteratorResult> asyncHandler)
                                                     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.
    
    Specified by:
    
    getShardIteratorAsync in interface AmazonKinesisAsync
    
    Parameters:
    getShardIteratorRequest - Container for the necessary parameters to execute the GetShardIterator operation on AmazonKinesis.
    asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
    
    Returns:
    A Java Future object containing the response from the GetShardIterator service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - listTagsForStreamAsync
```
public Future<ListTagsForStreamResult> listTagsForStreamAsync(ListTagsForStreamRequest listTagsForStreamRequest)
                                                       throws AmazonServiceException,
                                                              AmazonClientException
```
    Lists the tags for the specified Amazon Kinesis stream.
    
    Specified by:
    
    listTagsForStreamAsync in interface AmazonKinesisAsync
    
    Parameters:
    listTagsForStreamRequest - Container for the necessary parameters to execute the ListTagsForStream operation on AmazonKinesis.
    
    Returns:
    A Java Future object containing the response from the ListTagsForStream service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - listTagsForStreamAsync
```
public Future<ListTagsForStreamResult> listTagsForStreamAsync(ListTagsForStreamRequest listTagsForStreamRequest,
                                                     AsyncHandler<ListTagsForStreamRequest,ListTagsForStreamResult> asyncHandler)
                                                       throws AmazonServiceException,
                                                              AmazonClientException
```
    Lists the tags for the specified Amazon Kinesis stream.
    
    Specified by:
    
    listTagsForStreamAsync in interface AmazonKinesisAsync
    
    Parameters:
    listTagsForStreamRequest - Container for the necessary parameters to execute the ListTagsForStream operation on AmazonKinesis.
    asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
    
    Returns:
    A Java Future object containing the response from the ListTagsForStream service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - getRecordsAsync
```
public Future<GetRecordsResult> getRecordsAsync(GetRecordsRequest getRecordsRequest)
                                         throws AmazonServiceException,
                                                AmazonClientException
```
    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 .
    
    Specified by:
    
    getRecordsAsync in interface AmazonKinesisAsync
    
    Parameters:
    getRecordsRequest - Container for the necessary parameters to execute the GetRecords operation on AmazonKinesis.
    
    Returns:
    A Java Future object containing the response from the GetRecords service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - getRecordsAsync
```
public Future<GetRecordsResult> getRecordsAsync(GetRecordsRequest getRecordsRequest,
                                       AsyncHandler<GetRecordsRequest,GetRecordsResult> asyncHandler)
                                         throws AmazonServiceException,
                                                AmazonClientException
```
    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 .
    
    Specified by:
    
    getRecordsAsync in interface AmazonKinesisAsync
    
    Parameters:
    getRecordsRequest - Container for the necessary parameters to execute the GetRecords operation on AmazonKinesis.
    asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
    
    Returns:
    A Java Future object containing the response from the GetRecords service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - splitShardAsync
```
public Future<Void> splitShardAsync(SplitShardRequest splitShardRequest)
                             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.
    
    Specified by:
    
    splitShardAsync in interface AmazonKinesisAsync
    
    Parameters:
    splitShardRequest - Container for the necessary parameters to execute the SplitShard operation on AmazonKinesis.
    
    Returns:
    A Java Future object containing the response from the SplitShard service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - splitShardAsync
```
public Future<Void> splitShardAsync(SplitShardRequest splitShardRequest,
                           AsyncHandler<SplitShardRequest,Void> asyncHandler)
                             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.
    
    Specified by:
    
    splitShardAsync in interface AmazonKinesisAsync
    
    Parameters:
    splitShardRequest - Container for the necessary parameters to execute the SplitShard operation on AmazonKinesis.
    asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
    
    Returns:
    A Java Future object containing the response from the SplitShard service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - removeTagsFromStreamAsync
```
public Future<Void> removeTagsFromStreamAsync(RemoveTagsFromStreamRequest removeTagsFromStreamRequest)
                                       throws AmazonServiceException,
                                              AmazonClientException
```
    Deletes tags from the specified Amazon Kinesis stream.
    
    If you specify a tag that does not exist, it is ignored.
    
    Specified by:
    
    removeTagsFromStreamAsync in interface AmazonKinesisAsync
    
    Parameters:
    removeTagsFromStreamRequest - Container for the necessary parameters to execute the RemoveTagsFromStream operation on AmazonKinesis.
    
    Returns:
    A Java Future object containing the response from the RemoveTagsFromStream service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - removeTagsFromStreamAsync
```
public Future<Void> removeTagsFromStreamAsync(RemoveTagsFromStreamRequest removeTagsFromStreamRequest,
                                     AsyncHandler<RemoveTagsFromStreamRequest,Void> asyncHandler)
                                       throws AmazonServiceException,
                                              AmazonClientException
```
    Deletes tags from the specified Amazon Kinesis stream.
    
    If you specify a tag that does not exist, it is ignored.
    
    Specified by:
    
    removeTagsFromStreamAsync in interface AmazonKinesisAsync
    
    Parameters:
    removeTagsFromStreamRequest - Container for the necessary parameters to execute the RemoveTagsFromStream operation on AmazonKinesis.
    asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
    
    Returns:
    A Java Future object containing the response from the RemoveTagsFromStream service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - listStreamsAsync
```
public Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest listStreamsRequest)
                                           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.
    
    Specified by:
    
    listStreamsAsync in interface AmazonKinesisAsync
    
    Parameters:
    listStreamsRequest - Container for the necessary parameters to execute the ListStreams operation on AmazonKinesis.
    
    Returns:
    A Java Future object containing the response from the ListStreams service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.
  - listStreamsAsync
```
public Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest listStreamsRequest,
                                         AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)
                                           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.
    
    Specified by:
    
    listStreamsAsync in interface AmazonKinesisAsync
    
    Parameters:
    listStreamsRequest - Container for the necessary parameters to execute the ListStreams operation on AmazonKinesis.
    asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
    
    Returns:
    A Java Future object containing the response from the ListStreams service method, as returned by AmazonKinesis.
    
    Throws:
    
    AmazonClientException - 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.

Class AmazonKinesisAsyncClient

Field Summary

Fields inherited from class com.amazonaws.services.kinesis.AmazonKinesisClient

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.services.kinesis.AmazonKinesisClient

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.kinesis.AmazonKinesis

Constructor Detail

AmazonKinesisAsyncClient

AmazonKinesisAsyncClient

AmazonKinesisAsyncClient

AmazonKinesisAsyncClient

AmazonKinesisAsyncClient

AmazonKinesisAsyncClient

AmazonKinesisAsyncClient

AmazonKinesisAsyncClient

AmazonKinesisAsyncClient

Method Detail

getExecutorService

shutdown

addTagsToStreamAsync

addTagsToStreamAsync

putRecordAsync

putRecordAsync

createStreamAsync

createStreamAsync

deleteStreamAsync

deleteStreamAsync

mergeShardsAsync

mergeShardsAsync

putRecordsAsync

putRecordsAsync

describeStreamAsync

describeStreamAsync

getShardIteratorAsync

getShardIteratorAsync

listTagsForStreamAsync

listTagsForStreamAsync

getRecordsAsync

getRecordsAsync

splitShardAsync

splitShardAsync

removeTagsFromStreamAsync

removeTagsFromStreamAsync

listStreamsAsync

listStreamsAsync