Class AmazonKinesisAsyncClient

All Implemented Interfaces:
AmazonKinesis, AmazonKinesisAsync

@ThreadSafe public class AmazonKinesisAsyncClient extends AmazonKinesisClient implements AmazonKinesisAsync
Interface for accessing Kinesis asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Amazon Kinesis Streams Service API Reference

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

  • Constructor Details

    • AmazonKinesisAsyncClient

      public AmazonKinesisAsyncClient()
      Constructs a new asynchronous client to invoke service methods on Kinesis. 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
      • Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
      • Instance profile credentials delivered through the Amazon EC2 metadata service

      Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

      See Also:
    • AmazonKinesisAsyncClient

      public AmazonKinesisAsyncClient(ClientConfiguration clientConfiguration)
      Constructs a new asynchronous client to invoke service methods on Kinesis. 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
      • Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
      • Instance profile credentials delivered through the Amazon EC2 metadata service

      Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

      Parameters:
      clientConfiguration - The client configuration options controlling how this client connects to Kinesis (ex: proxy settings, retry counts, etc).
      See Also:
    • AmazonKinesisAsyncClient

      public AmazonKinesisAsyncClient(AWSCredentials awsCredentials)
      Constructs a new asynchronous client to invoke service methods on Kinesis using the specified AWS account credentials.

      Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

      Parameters:
      awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
      See Also:
    • AmazonKinesisAsyncClient

      public AmazonKinesisAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
      Constructs a new asynchronous client to invoke service methods on Kinesis using the specified AWS account credentials and executor service. Default client settings will be used.
      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 Kinesis using the specified AWS account credentials, executor service, and client configuration options.
      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 Kinesis using the specified AWS account credentials provider. Default client settings will be used.

      Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

      Parameters:
      awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
      See Also:
    • AmazonKinesisAsyncClient

      public AmazonKinesisAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
      Constructs a new asynchronous client to invoke service methods on Kinesis using the provided AWS account credentials provider and client configuration options.

      Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

      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).
      See Also:
    • AmazonKinesisAsyncClient

      public AmazonKinesisAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
      Constructs a new asynchronous client to invoke service methods on Kinesis using the specified AWS account credentials provider and executor service. Default client settings will be used.
      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, ExecutorService executorService)
      Constructs a new asynchronous client to invoke service methods on Kinesis using the specified AWS account credentials provider, executor service, and client configuration options.
      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 Details

    • getExecutorService

      public ExecutorService getExecutorService()
      Returns the executor service used by this client to execute async requests.
      Returns:
      The executor service used by this client to execute async requests.
    • addTagsToStreamAsync

      public Future<AddTagsToStreamResult> addTagsToStreamAsync(AddTagsToStreamRequest request)
      Description copied from interface: AmazonKinesisAsync

      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:
      request - Represents the input for AddTagsToStream.
      Returns:
      A Java Future containing the result of the AddTagsToStream operation returned by the service.
    • addTagsToStreamAsync

      Description copied from interface: AmazonKinesisAsync

      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:
      request - Represents the input for AddTagsToStream.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the AddTagsToStream operation returned by the service.
    • createStreamAsync

      public Future<CreateStreamResult> createStreamAsync(CreateStreamRequest request)
      Description copied from interface: AmazonKinesisAsync

      Creates an Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.

      You specify and control the number of shards that a stream is composed of. Each shard can support reads up to 5 transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases.

      The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name.

      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.

      For the default shard limit for an AWS account, see Streams Limits in the Amazon Kinesis Streams Developer Guide. If you need to increase this limit, contact AWS Support.

      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:
      request - Represents the input for CreateStream.
      Returns:
      A Java Future containing the result of the CreateStream operation returned by the service.
    • createStreamAsync

      Description copied from interface: AmazonKinesisAsync

      Creates an Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.

      You specify and control the number of shards that a stream is composed of. Each shard can support reads up to 5 transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases.

      The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name.

      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.

      For the default shard limit for an AWS account, see Streams Limits in the Amazon Kinesis Streams Developer Guide. If you need to increase this limit, contact AWS Support.

      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:
      request - Represents the input for CreateStream.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the CreateStream operation returned by the service.
    • createStreamAsync

      public Future<CreateStreamResult> createStreamAsync(String streamName, Integer shardCount)
      Simplified method form for invoking the CreateStream operation.
      Specified by:
      createStreamAsync in interface AmazonKinesisAsync
      See Also:
    • createStreamAsync

      public Future<CreateStreamResult> createStreamAsync(String streamName, Integer shardCount, AsyncHandler<CreateStreamRequest,CreateStreamResult> asyncHandler)
      Simplified method form for invoking the CreateStream operation with an AsyncHandler.
      Specified by:
      createStreamAsync in interface AmazonKinesisAsync
      See Also:
    • decreaseStreamRetentionPeriodAsync

      public Future<DecreaseStreamRetentionPeriodResult> decreaseStreamRetentionPeriodAsync(DecreaseStreamRetentionPeriodRequest request)
      Description copied from interface: AmazonKinesisAsync

      Decreases the Amazon Kinesis stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.

      This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.

      Specified by:
      decreaseStreamRetentionPeriodAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for DecreaseStreamRetentionPeriod.
      Returns:
      A Java Future containing the result of the DecreaseStreamRetentionPeriod operation returned by the service.
    • decreaseStreamRetentionPeriodAsync

      Description copied from interface: AmazonKinesisAsync

      Decreases the Amazon Kinesis stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.

      This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.

      Specified by:
      decreaseStreamRetentionPeriodAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for DecreaseStreamRetentionPeriod.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the DecreaseStreamRetentionPeriod operation returned by the service.
    • deleteStreamAsync

      public Future<DeleteStreamResult> deleteStreamAsync(DeleteStreamRequest request)
      Description copied from interface: AmazonKinesisAsync

      Deletes an Amazon Kinesis 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:
      request - Represents the input for DeleteStream.
      Returns:
      A Java Future containing the result of the DeleteStream operation returned by the service.
    • deleteStreamAsync

      Description copied from interface: AmazonKinesisAsync

      Deletes an Amazon Kinesis 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:
      request - Represents the input for DeleteStream.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the DeleteStream operation returned by the service.
    • deleteStreamAsync

      public Future<DeleteStreamResult> deleteStreamAsync(String streamName)
      Simplified method form for invoking the DeleteStream operation.
      Specified by:
      deleteStreamAsync in interface AmazonKinesisAsync
      See Also:
    • deleteStreamAsync

      public Future<DeleteStreamResult> deleteStreamAsync(String streamName, AsyncHandler<DeleteStreamRequest,DeleteStreamResult> asyncHandler)
      Simplified method form for invoking the DeleteStream operation with an AsyncHandler.
      Specified by:
      deleteStreamAsync in interface AmazonKinesisAsync
      See Also:
    • describeStreamAsync

      public Future<DescribeStreamResult> describeStreamAsync(DescribeStreamRequest request)
      Description copied from interface: AmazonKinesisAsync

      Describes the specified Amazon Kinesis 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 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.

      There are no guarantees about the chronological order shards returned in DescribeStream results. If you want to process shards in chronological order, use ParentShardId to track lineage to the oldest shard.

      DescribeStream has a limit of 10 transactions per second per account.

      Specified by:
      describeStreamAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for DescribeStream.
      Returns:
      A Java Future containing the result of the DescribeStream operation returned by the service.
    • describeStreamAsync

      Description copied from interface: AmazonKinesisAsync

      Describes the specified Amazon Kinesis 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 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.

      There are no guarantees about the chronological order shards returned in DescribeStream results. If you want to process shards in chronological order, use ParentShardId to track lineage to the oldest shard.

      DescribeStream has a limit of 10 transactions per second per account.

      Specified by:
      describeStreamAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for DescribeStream.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the DescribeStream operation returned by the service.
    • describeStreamAsync

      public Future<DescribeStreamResult> describeStreamAsync(String streamName)
      Simplified method form for invoking the DescribeStream operation.
      Specified by:
      describeStreamAsync in interface AmazonKinesisAsync
      See Also:
    • describeStreamAsync

      public Future<DescribeStreamResult> describeStreamAsync(String streamName, AsyncHandler<DescribeStreamRequest,DescribeStreamResult> asyncHandler)
      Simplified method form for invoking the DescribeStream operation with an AsyncHandler.
      Specified by:
      describeStreamAsync in interface AmazonKinesisAsync
      See Also:
    • describeStreamAsync

      public Future<DescribeStreamResult> describeStreamAsync(String streamName, String exclusiveStartShardId)
      Simplified method form for invoking the DescribeStream operation.
      Specified by:
      describeStreamAsync in interface AmazonKinesisAsync
      See Also:
    • describeStreamAsync

      public Future<DescribeStreamResult> describeStreamAsync(String streamName, String exclusiveStartShardId, AsyncHandler<DescribeStreamRequest,DescribeStreamResult> asyncHandler)
      Simplified method form for invoking the DescribeStream operation with an AsyncHandler.
      Specified by:
      describeStreamAsync in interface AmazonKinesisAsync
      See Also:
    • describeStreamAsync

      public Future<DescribeStreamResult> describeStreamAsync(String streamName, Integer limit, String exclusiveStartShardId)
      Simplified method form for invoking the DescribeStream operation.
      Specified by:
      describeStreamAsync in interface AmazonKinesisAsync
      See Also:
    • describeStreamAsync

      public Future<DescribeStreamResult> describeStreamAsync(String streamName, Integer limit, String exclusiveStartShardId, AsyncHandler<DescribeStreamRequest,DescribeStreamResult> asyncHandler)
      Simplified method form for invoking the DescribeStream operation with an AsyncHandler.
      Specified by:
      describeStreamAsync in interface AmazonKinesisAsync
      See Also:
    • disableEnhancedMonitoringAsync

      public Future<DisableEnhancedMonitoringResult> disableEnhancedMonitoringAsync(DisableEnhancedMonitoringRequest request)
      Description copied from interface: AmazonKinesisAsync

      Disables enhanced monitoring.

      Specified by:
      disableEnhancedMonitoringAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for DisableEnhancedMonitoring.
      Returns:
      A Java Future containing the result of the DisableEnhancedMonitoring operation returned by the service.
    • disableEnhancedMonitoringAsync

      Description copied from interface: AmazonKinesisAsync

      Disables enhanced monitoring.

      Specified by:
      disableEnhancedMonitoringAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for DisableEnhancedMonitoring.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the DisableEnhancedMonitoring operation returned by the service.
    • enableEnhancedMonitoringAsync

      public Future<EnableEnhancedMonitoringResult> enableEnhancedMonitoringAsync(EnableEnhancedMonitoringRequest request)
      Description copied from interface: AmazonKinesisAsync

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

      Specified by:
      enableEnhancedMonitoringAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for EnableEnhancedMonitoring.
      Returns:
      A Java Future containing the result of the EnableEnhancedMonitoring operation returned by the service.
    • enableEnhancedMonitoringAsync

      Description copied from interface: AmazonKinesisAsync

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

      Specified by:
      enableEnhancedMonitoringAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for EnableEnhancedMonitoring.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the EnableEnhancedMonitoring operation returned by the service.
    • getRecordsAsync

      public Future<GetRecordsResult> getRecordsAsync(GetRecordsRequest request)
      Description copied from interface: AmazonKinesisAsync

      Gets data records from an Amazon Kinesis stream's 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 per stream while considering service limits (for more information, see Streams Limits in the Amazon Kinesis Streams Developer Guide). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords 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 1 MB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit.

      The size of the data returned by GetRecords varies depending on the utilization of the shard. The maximum size of data that GetRecords can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw 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, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon Kinesis Streams Developer Guide).

      Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side timestamp, whereas a client-side timestamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with PutRecords). The timestamp has millisecond precision. There are no guarantees about the timestamp accuracy, or that the timestamp is always increasing. For example, records in a shard or across a stream might have timestamps that are out of order.

      Specified by:
      getRecordsAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for GetRecords.
      Returns:
      A Java Future containing the result of the GetRecords operation returned by the service.
    • getRecordsAsync

      public Future<GetRecordsResult> getRecordsAsync(GetRecordsRequest request, AsyncHandler<GetRecordsRequest,GetRecordsResult> asyncHandler)
      Description copied from interface: AmazonKinesisAsync

      Gets data records from an Amazon Kinesis stream's 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 per stream while considering service limits (for more information, see Streams Limits in the Amazon Kinesis Streams Developer Guide). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords 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 1 MB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit.

      The size of the data returned by GetRecords varies depending on the utilization of the shard. The maximum size of data that GetRecords can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw 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, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon Kinesis Streams Developer Guide).

      Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side timestamp, whereas a client-side timestamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with PutRecords). The timestamp has millisecond precision. There are no guarantees about the timestamp accuracy, or that the timestamp is always increasing. For example, records in a shard or across a stream might have timestamps that are out of order.

      Specified by:
      getRecordsAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for GetRecords.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the GetRecords operation returned by the service.
    • getShardIteratorAsync

      public Future<GetShardIteratorResult> getShardIteratorAsync(GetShardIteratorRequest request)
      Description copied from interface: AmazonKinesisAsync

      Gets an Amazon Kinesis shard iterator. A shard iterator expires five minutes after it is returned to the requester.

      A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.

      You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a 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. In the request, you can specify the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST so that you always read the most recent data in the shard.

      When you read repeatedly from a stream, use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. 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, and Streams Limits in the Amazon Kinesis Streams Developer Guide.

      If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. Note that a shard can be closed as a result of 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:
      request - Represents the input for GetShardIterator.
      Returns:
      A Java Future containing the result of the GetShardIterator operation returned by the service.
    • getShardIteratorAsync

      Description copied from interface: AmazonKinesisAsync

      Gets an Amazon Kinesis shard iterator. A shard iterator expires five minutes after it is returned to the requester.

      A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.

      You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a 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. In the request, you can specify the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST so that you always read the most recent data in the shard.

      When you read repeatedly from a stream, use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. 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, and Streams Limits in the Amazon Kinesis Streams Developer Guide.

      If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. Note that a shard can be closed as a result of 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:
      request - Represents the input for GetShardIterator.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the GetShardIterator operation returned by the service.
    • getShardIteratorAsync

      public Future<GetShardIteratorResult> getShardIteratorAsync(String streamName, String shardId, String shardIteratorType)
      Simplified method form for invoking the GetShardIterator operation.
      Specified by:
      getShardIteratorAsync in interface AmazonKinesisAsync
      See Also:
    • getShardIteratorAsync

      public Future<GetShardIteratorResult> getShardIteratorAsync(String streamName, String shardId, String shardIteratorType, AsyncHandler<GetShardIteratorRequest,GetShardIteratorResult> asyncHandler)
      Simplified method form for invoking the GetShardIterator operation with an AsyncHandler.
      Specified by:
      getShardIteratorAsync in interface AmazonKinesisAsync
      See Also:
    • getShardIteratorAsync

      public Future<GetShardIteratorResult> getShardIteratorAsync(String streamName, String shardId, String shardIteratorType, String startingSequenceNumber)
      Simplified method form for invoking the GetShardIterator operation.
      Specified by:
      getShardIteratorAsync in interface AmazonKinesisAsync
      See Also:
    • getShardIteratorAsync

      public Future<GetShardIteratorResult> getShardIteratorAsync(String streamName, String shardId, String shardIteratorType, String startingSequenceNumber, AsyncHandler<GetShardIteratorRequest,GetShardIteratorResult> asyncHandler)
      Simplified method form for invoking the GetShardIterator operation with an AsyncHandler.
      Specified by:
      getShardIteratorAsync in interface AmazonKinesisAsync
      See Also:
    • increaseStreamRetentionPeriodAsync

      public Future<IncreaseStreamRetentionPeriodResult> increaseStreamRetentionPeriodAsync(IncreaseStreamRetentionPeriodRequest request)
      Description copied from interface: AmazonKinesisAsync

      Increases the Amazon Kinesis stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours (7 days).

      Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours will remain inaccessible to consumer applications.

      Specified by:
      increaseStreamRetentionPeriodAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for IncreaseStreamRetentionPeriod.
      Returns:
      A Java Future containing the result of the IncreaseStreamRetentionPeriod operation returned by the service.
    • increaseStreamRetentionPeriodAsync

      Description copied from interface: AmazonKinesisAsync

      Increases the Amazon Kinesis stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours (7 days).

      Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours will remain inaccessible to consumer applications.

      Specified by:
      increaseStreamRetentionPeriodAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for IncreaseStreamRetentionPeriod.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the IncreaseStreamRetentionPeriod operation returned by the service.
    • listStreamsAsync

      public Future<ListStreamsResult> listStreamsAsync(ListStreamsRequest request)
      Description copied from interface: AmazonKinesisAsync

      Lists your Amazon Kinesis 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:
      request - Represents the input for ListStreams.
      Returns:
      A Java Future containing the result of the ListStreams operation returned by the service.
    • listStreamsAsync

      Description copied from interface: AmazonKinesisAsync

      Lists your Amazon Kinesis 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:
      request - Represents the input for ListStreams.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the ListStreams operation returned by the service.
    • listStreamsAsync

      public Future<ListStreamsResult> listStreamsAsync()
      Simplified method form for invoking the ListStreams operation.
      Specified by:
      listStreamsAsync in interface AmazonKinesisAsync
      See Also:
    • listStreamsAsync

      public Future<ListStreamsResult> listStreamsAsync(AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)
      Simplified method form for invoking the ListStreams operation with an AsyncHandler.
      Specified by:
      listStreamsAsync in interface AmazonKinesisAsync
      See Also:
    • listStreamsAsync

      public Future<ListStreamsResult> listStreamsAsync(String exclusiveStartStreamName)
      Simplified method form for invoking the ListStreams operation.
      Specified by:
      listStreamsAsync in interface AmazonKinesisAsync
      See Also:
    • listStreamsAsync

      public Future<ListStreamsResult> listStreamsAsync(String exclusiveStartStreamName, AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)
      Simplified method form for invoking the ListStreams operation with an AsyncHandler.
      Specified by:
      listStreamsAsync in interface AmazonKinesisAsync
      See Also:
    • listStreamsAsync

      public Future<ListStreamsResult> listStreamsAsync(Integer limit, String exclusiveStartStreamName)
      Simplified method form for invoking the ListStreams operation.
      Specified by:
      listStreamsAsync in interface AmazonKinesisAsync
      See Also:
    • listStreamsAsync

      public Future<ListStreamsResult> listStreamsAsync(Integer limit, String exclusiveStartStreamName, AsyncHandler<ListStreamsRequest,ListStreamsResult> asyncHandler)
      Simplified method form for invoking the ListStreams operation with an AsyncHandler.
      Specified by:
      listStreamsAsync in interface AmazonKinesisAsync
      See Also:
    • listTagsForStreamAsync

      public Future<ListTagsForStreamResult> listTagsForStreamAsync(ListTagsForStreamRequest request)
      Description copied from interface: AmazonKinesisAsync

      Lists the tags for the specified Amazon Kinesis stream.

      Specified by:
      listTagsForStreamAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for ListTagsForStream.
      Returns:
      A Java Future containing the result of the ListTagsForStream operation returned by the service.
    • listTagsForStreamAsync

      Description copied from interface: AmazonKinesisAsync

      Lists the tags for the specified Amazon Kinesis stream.

      Specified by:
      listTagsForStreamAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for ListTagsForStream.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the ListTagsForStream operation returned by the service.
    • mergeShardsAsync

      public Future<MergeShardsResult> mergeShardsAsync(MergeShardsRequest request)
      Description copied from interface: AmazonKinesisAsync

      Merges two adjacent shards in an Amazon Kinesis 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 Streams 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:
      request - Represents the input for MergeShards.
      Returns:
      A Java Future containing the result of the MergeShards operation returned by the service.
    • mergeShardsAsync

      Description copied from interface: AmazonKinesisAsync

      Merges two adjacent shards in an Amazon Kinesis 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 Streams 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:
      request - Represents the input for MergeShards.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the MergeShards operation returned by the service.
    • mergeShardsAsync

      public Future<MergeShardsResult> mergeShardsAsync(String streamName, String shardToMerge, String adjacentShardToMerge)
      Simplified method form for invoking the MergeShards operation.
      Specified by:
      mergeShardsAsync in interface AmazonKinesisAsync
      See Also:
    • mergeShardsAsync

      public Future<MergeShardsResult> mergeShardsAsync(String streamName, String shardToMerge, String adjacentShardToMerge, AsyncHandler<MergeShardsRequest,MergeShardsResult> asyncHandler)
      Simplified method form for invoking the MergeShards operation with an AsyncHandler.
      Specified by:
      mergeShardsAsync in interface AmazonKinesisAsync
      See Also:
    • putRecordAsync

      public Future<PutRecordResult> putRecordAsync(PutRecordRequest request)
      Description copied from interface: AmazonKinesisAsync

      Writes a single data record into an Amazon Kinesis stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

      You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.

      The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

      The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to.

      Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Streams 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 increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Streams 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 a stream.

      Specified by:
      putRecordAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for PutRecord.
      Returns:
      A Java Future containing the result of the PutRecord operation returned by the service.
    • putRecordAsync

      public Future<PutRecordResult> putRecordAsync(PutRecordRequest request, AsyncHandler<PutRecordRequest,PutRecordResult> asyncHandler)
      Description copied from interface: AmazonKinesisAsync

      Writes a single data record into an Amazon Kinesis stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

      You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.

      The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

      The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to.

      Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Streams 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 increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Streams 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 a stream.

      Specified by:
      putRecordAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for PutRecord.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the PutRecord operation returned by the service.
    • putRecordAsync

      public Future<PutRecordResult> putRecordAsync(String streamName, ByteBuffer data, String partitionKey)
      Simplified method form for invoking the PutRecord operation.
      Specified by:
      putRecordAsync in interface AmazonKinesisAsync
      See Also:
    • putRecordAsync

      public Future<PutRecordResult> putRecordAsync(String streamName, ByteBuffer data, String partitionKey, AsyncHandler<PutRecordRequest,PutRecordResult> asyncHandler)
      Simplified method form for invoking the PutRecord operation with an AsyncHandler.
      Specified by:
      putRecordAsync in interface AmazonKinesisAsync
      See Also:
    • putRecordAsync

      public Future<PutRecordResult> putRecordAsync(String streamName, ByteBuffer data, String partitionKey, String sequenceNumberForOrdering)
      Simplified method form for invoking the PutRecord operation.
      Specified by:
      putRecordAsync in interface AmazonKinesisAsync
      See Also:
    • putRecordAsync

      public Future<PutRecordResult> putRecordAsync(String streamName, ByteBuffer data, String partitionKey, String sequenceNumberForOrdering, AsyncHandler<PutRecordRequest,PutRecordResult> asyncHandler)
      Simplified method form for invoking the PutRecord operation with an AsyncHandler.
      Specified by:
      putRecordAsync in interface AmazonKinesisAsync
      See Also:
    • putRecordsAsync

      public Future<PutRecordsResult> putRecordsAsync(PutRecordsRequest request)
      Description copied from interface: AmazonKinesisAsync

      Writes multiple data records into an Amazon Kinesis stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the stream for data ingestion and processing.

      Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

      You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the 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 Adding Data to a Stream in the Amazon Kinesis Streams 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 Streams 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. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Streams Developer Guide.

      By default, data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream. This retention period can be modified using the DecreaseStreamRetentionPeriod and IncreaseStreamRetentionPeriod operations.

      Specified by:
      putRecordsAsync in interface AmazonKinesisAsync
      Parameters:
      request - A PutRecords request.
      Returns:
      A Java Future containing the result of the PutRecords operation returned by the service.
    • putRecordsAsync

      public Future<PutRecordsResult> putRecordsAsync(PutRecordsRequest request, AsyncHandler<PutRecordsRequest,PutRecordsResult> asyncHandler)
      Description copied from interface: AmazonKinesisAsync

      Writes multiple data records into an Amazon Kinesis stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the stream for data ingestion and processing.

      Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

      You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the 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 Adding Data to a Stream in the Amazon Kinesis Streams 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 Streams 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. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Streams Developer Guide.

      By default, data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream. This retention period can be modified using the DecreaseStreamRetentionPeriod and IncreaseStreamRetentionPeriod operations.

      Specified by:
      putRecordsAsync in interface AmazonKinesisAsync
      Parameters:
      request - A PutRecords request.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the PutRecords operation returned by the service.
    • removeTagsFromStreamAsync

      public Future<RemoveTagsFromStreamResult> removeTagsFromStreamAsync(RemoveTagsFromStreamRequest request)
      Description copied from interface: AmazonKinesisAsync

      Removes tags from the specified Amazon Kinesis stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.

      If you specify a tag that does not exist, it is ignored.

      Specified by:
      removeTagsFromStreamAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for RemoveTagsFromStream.
      Returns:
      A Java Future containing the result of the RemoveTagsFromStream operation returned by the service.
    • removeTagsFromStreamAsync

      Description copied from interface: AmazonKinesisAsync

      Removes tags from the specified Amazon Kinesis stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.

      If you specify a tag that does not exist, it is ignored.

      Specified by:
      removeTagsFromStreamAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for RemoveTagsFromStream.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the RemoveTagsFromStream operation returned by the service.
    • splitShardAsync

      public Future<SplitShardResult> splitShardAsync(SplitShardRequest request)
      Description copied from interface: AmazonKinesisAsync

      Splits a shard into two new shards in the Amazon Kinesis 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 a 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, the 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 Streams 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.

      For the default shard limit for an AWS account, see Streams Limits in the Amazon Kinesis Streams Developer Guide. If you need to increase this limit, contact AWS Support.

      If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException.

      SplitShard has limit of 5 transactions per second per account.

      Specified by:
      splitShardAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for SplitShard.
      Returns:
      A Java Future containing the result of the SplitShard operation returned by the service.
    • splitShardAsync

      public Future<SplitShardResult> splitShardAsync(SplitShardRequest request, AsyncHandler<SplitShardRequest,SplitShardResult> asyncHandler)
      Description copied from interface: AmazonKinesisAsync

      Splits a shard into two new shards in the Amazon Kinesis 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 a 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, the 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 Streams 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.

      For the default shard limit for an AWS account, see Streams Limits in the Amazon Kinesis Streams Developer Guide. If you need to increase this limit, contact AWS Support.

      If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException.

      SplitShard has limit of 5 transactions per second per account.

      Specified by:
      splitShardAsync in interface AmazonKinesisAsync
      Parameters:
      request - Represents the input for SplitShard.
      asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
      Returns:
      A Java Future containing the result of the SplitShard operation returned by the service.
    • splitShardAsync

      public Future<SplitShardResult> splitShardAsync(String streamName, String shardToSplit, String newStartingHashKey)
      Simplified method form for invoking the SplitShard operation.
      Specified by:
      splitShardAsync in interface AmazonKinesisAsync
      See Also:
    • splitShardAsync

      public Future<SplitShardResult> splitShardAsync(String streamName, String shardToSplit, String newStartingHashKey, AsyncHandler<SplitShardRequest,SplitShardResult> asyncHandler)
      Simplified method form for invoking the SplitShard operation with an AsyncHandler.
      Specified by:
      splitShardAsync in interface AmazonKinesisAsync
      See Also:
    • 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