Interface KinesisClient
-
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface KinesisClient extends AwsClient
Service client for accessing Kinesis. This can be created using the staticbuilder()
method.Amazon Kinesis Data Streams Service API Reference Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.
-
-
Field Summary
Fields Modifier and Type Field Description static String
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.static String
SERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default AddTagsToStreamResponse
addTagsToStream(Consumer<AddTagsToStreamRequest.Builder> addTagsToStreamRequest)
Adds or updates tags for the specified Kinesis data stream.default AddTagsToStreamResponse
addTagsToStream(AddTagsToStreamRequest addTagsToStreamRequest)
Adds or updates tags for the specified Kinesis data stream.static KinesisClientBuilder
builder()
Create a builder that can be used to configure and create aKinesisClient
.static KinesisClient
create()
Create aKinesisClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateStreamResponse
createStream(Consumer<CreateStreamRequest.Builder> createStreamRequest)
Creates a Kinesis data stream.default CreateStreamResponse
createStream(CreateStreamRequest createStreamRequest)
Creates a Kinesis data stream.default DecreaseStreamRetentionPeriodResponse
decreaseStreamRetentionPeriod(Consumer<DecreaseStreamRetentionPeriodRequest.Builder> decreaseStreamRetentionPeriodRequest)
Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream.default DecreaseStreamRetentionPeriodResponse
decreaseStreamRetentionPeriod(DecreaseStreamRetentionPeriodRequest decreaseStreamRetentionPeriodRequest)
Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream.default DeleteResourcePolicyResponse
deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)
Delete a policy for the specified data stream or consumer.default DeleteResourcePolicyResponse
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Delete a policy for the specified data stream or consumer.default DeleteStreamResponse
deleteStream(Consumer<DeleteStreamRequest.Builder> deleteStreamRequest)
Deletes a Kinesis data stream and all its shards and data.default DeleteStreamResponse
deleteStream(DeleteStreamRequest deleteStreamRequest)
Deletes a Kinesis data stream and all its shards and data.default DeregisterStreamConsumerResponse
deregisterStreamConsumer(Consumer<DeregisterStreamConsumerRequest.Builder> deregisterStreamConsumerRequest)
To deregister a consumer, provide its ARN.default DeregisterStreamConsumerResponse
deregisterStreamConsumer(DeregisterStreamConsumerRequest deregisterStreamConsumerRequest)
To deregister a consumer, provide its ARN.default DescribeLimitsResponse
describeLimits()
Describes the shard limits and usage for the account.default DescribeLimitsResponse
describeLimits(Consumer<DescribeLimitsRequest.Builder> describeLimitsRequest)
Describes the shard limits and usage for the account.default DescribeLimitsResponse
describeLimits(DescribeLimitsRequest describeLimitsRequest)
Describes the shard limits and usage for the account.default DescribeStreamResponse
describeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest)
Describes the specified Kinesis data stream.default DescribeStreamResponse
describeStream(DescribeStreamRequest describeStreamRequest)
Describes the specified Kinesis data stream.default DescribeStreamConsumerResponse
describeStreamConsumer(Consumer<DescribeStreamConsumerRequest.Builder> describeStreamConsumerRequest)
To get the description of a registered consumer, provide the ARN of the consumer.default DescribeStreamConsumerResponse
describeStreamConsumer(DescribeStreamConsumerRequest describeStreamConsumerRequest)
To get the description of a registered consumer, provide the ARN of the consumer.default DescribeStreamSummaryResponse
describeStreamSummary(Consumer<DescribeStreamSummaryRequest.Builder> describeStreamSummaryRequest)
Provides a summarized description of the specified Kinesis data stream without the shard list.default DescribeStreamSummaryResponse
describeStreamSummary(DescribeStreamSummaryRequest describeStreamSummaryRequest)
Provides a summarized description of the specified Kinesis data stream without the shard list.default DisableEnhancedMonitoringResponse
disableEnhancedMonitoring(Consumer<DisableEnhancedMonitoringRequest.Builder> disableEnhancedMonitoringRequest)
Disables enhanced monitoring.default DisableEnhancedMonitoringResponse
disableEnhancedMonitoring(DisableEnhancedMonitoringRequest disableEnhancedMonitoringRequest)
Disables enhanced monitoring.default EnableEnhancedMonitoringResponse
enableEnhancedMonitoring(Consumer<EnableEnhancedMonitoringRequest.Builder> enableEnhancedMonitoringRequest)
Enables enhanced Kinesis data stream monitoring for shard-level metrics.default EnableEnhancedMonitoringResponse
enableEnhancedMonitoring(EnableEnhancedMonitoringRequest enableEnhancedMonitoringRequest)
Enables enhanced Kinesis data stream monitoring for shard-level metrics.default GetRecordsResponse
getRecords(Consumer<GetRecordsRequest.Builder> getRecordsRequest)
Gets data records from a Kinesis data stream's shard.default GetRecordsResponse
getRecords(GetRecordsRequest getRecordsRequest)
Gets data records from a Kinesis data stream's shard.default GetResourcePolicyResponse
getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest)
Returns a policy attached to the specified data stream or consumer.default GetResourcePolicyResponse
getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
Returns a policy attached to the specified data stream or consumer.default GetShardIteratorResponse
getShardIterator(Consumer<GetShardIteratorRequest.Builder> getShardIteratorRequest)
Gets an Amazon Kinesis shard iterator.default GetShardIteratorResponse
getShardIterator(GetShardIteratorRequest getShardIteratorRequest)
Gets an Amazon Kinesis shard iterator.default IncreaseStreamRetentionPeriodResponse
increaseStreamRetentionPeriod(Consumer<IncreaseStreamRetentionPeriodRequest.Builder> increaseStreamRetentionPeriodRequest)
Increases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream.default IncreaseStreamRetentionPeriodResponse
increaseStreamRetentionPeriod(IncreaseStreamRetentionPeriodRequest increaseStreamRetentionPeriodRequest)
Increases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream.default ListShardsResponse
listShards(Consumer<ListShardsRequest.Builder> listShardsRequest)
Lists the shards in a stream and provides information about each shard.default ListShardsResponse
listShards(ListShardsRequest listShardsRequest)
Lists the shards in a stream and provides information about each shard.default ListStreamConsumersResponse
listStreamConsumers(Consumer<ListStreamConsumersRequest.Builder> listStreamConsumersRequest)
Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer.default ListStreamConsumersResponse
listStreamConsumers(ListStreamConsumersRequest listStreamConsumersRequest)
Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer.default ListStreamConsumersIterable
listStreamConsumersPaginator(Consumer<ListStreamConsumersRequest.Builder> listStreamConsumersRequest)
This is a variant oflistStreamConsumers(software.amazon.awssdk.services.kinesis.model.ListStreamConsumersRequest)
operation.default ListStreamConsumersIterable
listStreamConsumersPaginator(ListStreamConsumersRequest listStreamConsumersRequest)
This is a variant oflistStreamConsumers(software.amazon.awssdk.services.kinesis.model.ListStreamConsumersRequest)
operation.default ListStreamsResponse
listStreams()
Lists your Kinesis data streams.default ListStreamsResponse
listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
Lists your Kinesis data streams.default ListStreamsResponse
listStreams(ListStreamsRequest listStreamsRequest)
Lists your Kinesis data streams.default ListStreamsIterable
listStreamsPaginator()
This is a variant oflistStreams(software.amazon.awssdk.services.kinesis.model.ListStreamsRequest)
operation.default ListStreamsIterable
listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest)
This is a variant oflistStreams(software.amazon.awssdk.services.kinesis.model.ListStreamsRequest)
operation.default ListStreamsIterable
listStreamsPaginator(ListStreamsRequest listStreamsRequest)
This is a variant oflistStreams(software.amazon.awssdk.services.kinesis.model.ListStreamsRequest)
operation.default ListTagsForStreamResponse
listTagsForStream(Consumer<ListTagsForStreamRequest.Builder> listTagsForStreamRequest)
Lists the tags for the specified Kinesis data stream.default ListTagsForStreamResponse
listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest)
Lists the tags for the specified Kinesis data stream.default MergeShardsResponse
mergeShards(Consumer<MergeShardsRequest.Builder> mergeShardsRequest)
Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data.default MergeShardsResponse
mergeShards(MergeShardsRequest mergeShardsRequest)
Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data.default PutRecordResponse
putRecord(Consumer<PutRecordRequest.Builder> putRecordRequest)
Writes a single data record into an Amazon Kinesis data stream.default PutRecordResponse
putRecord(PutRecordRequest putRecordRequest)
Writes a single data record into an Amazon Kinesis data stream.default PutRecordsResponse
putRecords(Consumer<PutRecordsRequest.Builder> putRecordsRequest)
Writes multiple data records into a Kinesis data stream in a single call (also referred to as aPutRecords
request).default PutRecordsResponse
putRecords(PutRecordsRequest putRecordsRequest)
Writes multiple data records into a Kinesis data stream in a single call (also referred to as aPutRecords
request).default PutResourcePolicyResponse
putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)
Attaches a resource-based policy to a data stream or registered consumer.default PutResourcePolicyResponse
putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Attaches a resource-based policy to a data stream or registered consumer.default RegisterStreamConsumerResponse
registerStreamConsumer(Consumer<RegisterStreamConsumerRequest.Builder> registerStreamConsumerRequest)
Registers a consumer with a Kinesis data stream.default RegisterStreamConsumerResponse
registerStreamConsumer(RegisterStreamConsumerRequest registerStreamConsumerRequest)
Registers a consumer with a Kinesis data stream.default RemoveTagsFromStreamResponse
removeTagsFromStream(Consumer<RemoveTagsFromStreamRequest.Builder> removeTagsFromStreamRequest)
Removes tags from the specified Kinesis data stream.default RemoveTagsFromStreamResponse
removeTagsFromStream(RemoveTagsFromStreamRequest removeTagsFromStreamRequest)
Removes tags from the specified Kinesis data stream.default KinesisServiceClientConfiguration
serviceClientConfiguration()
static ServiceMetadata
serviceMetadata()
default SplitShardResponse
splitShard(Consumer<SplitShardRequest.Builder> splitShardRequest)
Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data.default SplitShardResponse
splitShard(SplitShardRequest splitShardRequest)
Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data.default StartStreamEncryptionResponse
startStreamEncryption(Consumer<StartStreamEncryptionRequest.Builder> startStreamEncryptionRequest)
Enables or updates server-side encryption using an Amazon Web Services KMS key for a specified stream.default StartStreamEncryptionResponse
startStreamEncryption(StartStreamEncryptionRequest startStreamEncryptionRequest)
Enables or updates server-side encryption using an Amazon Web Services KMS key for a specified stream.default StopStreamEncryptionResponse
stopStreamEncryption(Consumer<StopStreamEncryptionRequest.Builder> stopStreamEncryptionRequest)
Disables server-side encryption for a specified stream.default StopStreamEncryptionResponse
stopStreamEncryption(StopStreamEncryptionRequest stopStreamEncryptionRequest)
Disables server-side encryption for a specified stream.default UpdateShardCountResponse
updateShardCount(Consumer<UpdateShardCountRequest.Builder> updateShardCountRequest)
Updates the shard count of the specified stream to the specified number of shards.default UpdateShardCountResponse
updateShardCount(UpdateShardCountRequest updateShardCountRequest)
Updates the shard count of the specified stream to the specified number of shards.default UpdateStreamModeResponse
updateStreamMode(Consumer<UpdateStreamModeRequest.Builder> updateStreamModeRequest)
Updates the capacity mode of the data stream.default UpdateStreamModeResponse
updateStreamMode(UpdateStreamModeRequest updateStreamModeRequest)
Updates the capacity mode of the data stream.default KinesisWaiter
waiter()
Create an instance ofKinesisWaiter
using this client.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
- Constant Field Values
-
-
Method Detail
-
addTagsToStream
default AddTagsToStreamResponse addTagsToStream(AddTagsToStreamRequest addTagsToStreamRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Adds or updates tags for the specified Kinesis data stream. You can assign up to 50 tags to a data stream.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.If tags have already been assigned to the stream,
AddTagsToStream
overwrites any existing tags that correspond to the specified tag keys.AddTagsToStream has a limit of five transactions per second per account.
- Parameters:
addTagsToStreamRequest
- Represents the input forAddTagsToStream
.- Returns:
- Result of the AddTagsToStream operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
addTagsToStream
default AddTagsToStreamResponse addTagsToStream(Consumer<AddTagsToStreamRequest.Builder> addTagsToStreamRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Adds or updates tags for the specified Kinesis data stream. You can assign up to 50 tags to a data stream.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.If tags have already been assigned to the stream,
AddTagsToStream
overwrites any existing tags that correspond to the specified tag keys.AddTagsToStream has a limit of five transactions per second per account.
This is a convenience which creates an instance of the
AddTagsToStreamRequest.Builder
avoiding the need to create one manually viaAddTagsToStreamRequest.builder()
- Parameters:
addTagsToStreamRequest
- AConsumer
that will call methods onAddTagsToStreamRequest.Builder
to create a request. Represents the input forAddTagsToStream
.- Returns:
- Result of the AddTagsToStream operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
createStream
default CreateStreamResponse createStream(CreateStreamRequest createStreamRequest) throws ResourceInUseException, LimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisException
Creates a Kinesis data 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 can create your data stream using either on-demand or provisioned capacity mode. Data streams with an on-demand mode require no capacity planning and automatically scale to handle gigabytes of write and read throughput per minute. With the on-demand mode, Kinesis Data Streams automatically manages the shards in order to provide the necessary throughput. For the data streams with a provisioned mode, you must specify the number of shards for the data stream. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. If the amount of data input increases or decreases, you can add or remove shards.
The stream name identifies the stream. The name is scoped to the Amazon Web Services account used by the application. It is also scoped by Amazon Web Services 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 aCreateStream
request, Kinesis Data Streams immediately returns and sets the stream status toCREATING
. After the stream is created, Kinesis Data Streams sets the stream status toACTIVE
. You should perform read and write operations only on anACTIVE
stream.You receive a
LimitExceededException
when making aCreateStream
request when 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 Amazon Web Services account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services Support.
You can use DescribeStreamSummary to check the stream status, which is returned in
StreamStatus
.CreateStream has a limit of five transactions per second per account.
- Parameters:
createStreamRequest
- Represents the input forCreateStream
.- Returns:
- Result of the CreateStream operation returned by the service.
- Throws:
ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
createStream
default CreateStreamResponse createStream(Consumer<CreateStreamRequest.Builder> createStreamRequest) throws ResourceInUseException, LimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisException
Creates a Kinesis data 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 can create your data stream using either on-demand or provisioned capacity mode. Data streams with an on-demand mode require no capacity planning and automatically scale to handle gigabytes of write and read throughput per minute. With the on-demand mode, Kinesis Data Streams automatically manages the shards in order to provide the necessary throughput. For the data streams with a provisioned mode, you must specify the number of shards for the data stream. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MiB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MiB per second. If the amount of data input increases or decreases, you can add or remove shards.
The stream name identifies the stream. The name is scoped to the Amazon Web Services account used by the application. It is also scoped by Amazon Web Services 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 aCreateStream
request, Kinesis Data Streams immediately returns and sets the stream status toCREATING
. After the stream is created, Kinesis Data Streams sets the stream status toACTIVE
. You should perform read and write operations only on anACTIVE
stream.You receive a
LimitExceededException
when making aCreateStream
request when 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 Amazon Web Services account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services Support.
You can use DescribeStreamSummary to check the stream status, which is returned in
StreamStatus
.CreateStream has a limit of five transactions per second per account.
This is a convenience which creates an instance of the
CreateStreamRequest.Builder
avoiding the need to create one manually viaCreateStreamRequest.builder()
- Parameters:
createStreamRequest
- AConsumer
that will call methods onCreateStreamRequest.Builder
to create a request. Represents the input forCreateStream
.- Returns:
- Result of the CreateStream operation returned by the service.
- Throws:
ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
decreaseStreamRetentionPeriod
default DecreaseStreamRetentionPeriodResponse decreaseStreamRetentionPeriod(DecreaseStreamRetentionPeriodRequest decreaseStreamRetentionPeriodRequest) throws ResourceInUseException, ResourceNotFoundException, LimitExceededException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Decreases the Kinesis data 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.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.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.
- Parameters:
decreaseStreamRetentionPeriodRequest
- Represents the input for DecreaseStreamRetentionPeriod.- Returns:
- Result of the DecreaseStreamRetentionPeriod operation returned by the service.
- Throws:
ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
decreaseStreamRetentionPeriod
default DecreaseStreamRetentionPeriodResponse decreaseStreamRetentionPeriod(Consumer<DecreaseStreamRetentionPeriodRequest.Builder> decreaseStreamRetentionPeriodRequest) throws ResourceInUseException, ResourceNotFoundException, LimitExceededException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Decreases the Kinesis data 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.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.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.
This is a convenience which creates an instance of the
DecreaseStreamRetentionPeriodRequest.Builder
avoiding the need to create one manually viaDecreaseStreamRetentionPeriodRequest.builder()
- Parameters:
decreaseStreamRetentionPeriodRequest
- AConsumer
that will call methods onDecreaseStreamRetentionPeriodRequest.Builder
to create a request. Represents the input for DecreaseStreamRetentionPeriod.- Returns:
- Result of the DecreaseStreamRetentionPeriod operation returned by the service.
- Throws:
ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteResourcePolicy
default DeleteResourcePolicyResponse deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) throws AccessDeniedException, ResourceNotFoundException, LimitExceededException, InvalidArgumentException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisException
Delete a policy for the specified data stream or consumer. Request patterns can be one of the following:
-
Data stream pattern:
arn:aws.*:kinesis:.*:\d{12}:.*stream/\S+
-
Consumer pattern:
^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+
- Parameters:
deleteResourcePolicyRequest
-- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- Throws:
AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
deleteResourcePolicy
default DeleteResourcePolicyResponse deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) throws AccessDeniedException, ResourceNotFoundException, LimitExceededException, InvalidArgumentException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisException
Delete a policy for the specified data stream or consumer. Request patterns can be one of the following:
-
Data stream pattern:
arn:aws.*:kinesis:.*:\d{12}:.*stream/\S+
-
Consumer pattern:
^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+
This is a convenience which creates an instance of the
DeleteResourcePolicyRequest.Builder
avoiding the need to create one manually viaDeleteResourcePolicyRequest.builder()
- Parameters:
deleteResourcePolicyRequest
- AConsumer
that will call methods onDeleteResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteResourcePolicy operation returned by the service.
- Throws:
AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
deleteStream
default DeleteStreamResponse deleteStream(DeleteStreamRequest deleteStreamRequest) throws ResourceNotFoundException, LimitExceededException, ResourceInUseException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Deletes a Kinesis data 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 receives the exception
ResourceNotFoundException
.When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.If the stream is in the
ACTIVE
state, you can delete it. After aDeleteStream
request, the specified stream is in theDELETING
state until Kinesis Data Streams completes the deletion.Note: Kinesis Data Streams 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 DescribeStreamSummary operation to check the state of the stream, which is returned in
StreamStatus
.DeleteStream has a limit of five transactions per second per account.
- Parameters:
deleteStreamRequest
- Represents the input for DeleteStream.- Returns:
- Result of the DeleteStream operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deleteStream
default DeleteStreamResponse deleteStream(Consumer<DeleteStreamRequest.Builder> deleteStreamRequest) throws ResourceNotFoundException, LimitExceededException, ResourceInUseException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Deletes a Kinesis data 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 receives the exception
ResourceNotFoundException
.When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.If the stream is in the
ACTIVE
state, you can delete it. After aDeleteStream
request, the specified stream is in theDELETING
state until Kinesis Data Streams completes the deletion.Note: Kinesis Data Streams 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 DescribeStreamSummary operation to check the state of the stream, which is returned in
StreamStatus
.DeleteStream has a limit of five transactions per second per account.
This is a convenience which creates an instance of the
DeleteStreamRequest.Builder
avoiding the need to create one manually viaDeleteStreamRequest.builder()
- Parameters:
deleteStreamRequest
- AConsumer
that will call methods onDeleteStreamRequest.Builder
to create a request. Represents the input for DeleteStream.- Returns:
- Result of the DeleteStream operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deregisterStreamConsumer
default DeregisterStreamConsumerResponse deregisterStreamConsumer(DeregisterStreamConsumerRequest deregisterStreamConsumerRequest) throws LimitExceededException, ResourceNotFoundException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisException
To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its name and ARN.
This operation has a limit of five transactions per second per stream.
- Parameters:
deregisterStreamConsumerRequest
-- Returns:
- Result of the DeregisterStreamConsumer operation returned by the service.
- Throws:
LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
deregisterStreamConsumer
default DeregisterStreamConsumerResponse deregisterStreamConsumer(Consumer<DeregisterStreamConsumerRequest.Builder> deregisterStreamConsumerRequest) throws LimitExceededException, ResourceNotFoundException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisException
To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its name and ARN.
This operation has a limit of five transactions per second per stream.
This is a convenience which creates an instance of the
DeregisterStreamConsumerRequest.Builder
avoiding the need to create one manually viaDeregisterStreamConsumerRequest.builder()
- Parameters:
deregisterStreamConsumerRequest
- AConsumer
that will call methods onDeregisterStreamConsumerRequest.Builder
to create a request.- Returns:
- Result of the DeregisterStreamConsumer operation returned by the service.
- Throws:
LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeLimits
default DescribeLimitsResponse describeLimits(DescribeLimitsRequest describeLimitsRequest) throws LimitExceededException, AwsServiceException, SdkClientException, KinesisException
Describes the shard limits and usage for the account.
If you update your account limits, the old limits might be returned for a few minutes.
This operation has a limit of one transaction per second per account.
- Parameters:
describeLimitsRequest
-- Returns:
- Result of the DescribeLimits operation returned by the service.
- Throws:
LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeLimits
default DescribeLimitsResponse describeLimits(Consumer<DescribeLimitsRequest.Builder> describeLimitsRequest) throws LimitExceededException, AwsServiceException, SdkClientException, KinesisException
Describes the shard limits and usage for the account.
If you update your account limits, the old limits might be returned for a few minutes.
This operation has a limit of one transaction per second per account.
This is a convenience which creates an instance of the
DescribeLimitsRequest.Builder
avoiding the need to create one manually viaDescribeLimitsRequest.builder()
- Parameters:
describeLimitsRequest
- AConsumer
that will call methods onDescribeLimitsRequest.Builder
to create a request.- Returns:
- Result of the DescribeLimits operation returned by the service.
- Throws:
LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeLimits
default DescribeLimitsResponse describeLimits() throws LimitExceededException, AwsServiceException, SdkClientException, KinesisException
Describes the shard limits and usage for the account.
If you update your account limits, the old limits might be returned for a few minutes.
This operation has a limit of one transaction per second per account.
- Returns:
- Result of the DescribeLimits operation returned by the service.
- Throws:
LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
describeLimits(DescribeLimitsRequest)
, AWS API Documentation
-
describeStream
default DescribeStreamResponse describeStream(DescribeStreamRequest describeStreamRequest) throws ResourceNotFoundException, LimitExceededException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Describes the specified Kinesis data stream.
This API has been revised. It's highly recommended that you use the DescribeStreamSummary API to get a summarized description of the specified Kinesis data stream and the ListShards API to list the shards in a specified data stream and obtain information about each shard.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is 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. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.
You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams Developer Guide.
There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.
This operation has a limit of 10 transactions per second per account.
- Parameters:
describeStreamRequest
- Represents the input forDescribeStream
.- Returns:
- Result of the DescribeStream operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeStream
default DescribeStreamResponse describeStream(Consumer<DescribeStreamRequest.Builder> describeStreamRequest) throws ResourceNotFoundException, LimitExceededException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Describes the specified Kinesis data stream.
This API has been revised. It's highly recommended that you use the DescribeStreamSummary API to get a summarized description of the specified Kinesis data stream and the ListShards API to list the shards in a specified data stream and obtain information about each shard.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is 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. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.
You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams Developer Guide.
There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.
This operation has a limit of 10 transactions per second per account.
This is a convenience which creates an instance of the
DescribeStreamRequest.Builder
avoiding the need to create one manually viaDescribeStreamRequest.builder()
- Parameters:
describeStreamRequest
- AConsumer
that will call methods onDescribeStreamRequest.Builder
to create a request. Represents the input forDescribeStream
.- Returns:
- Result of the DescribeStream operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeStreamConsumer
default DescribeStreamConsumerResponse describeStreamConsumer(DescribeStreamConsumerRequest describeStreamConsumerRequest) throws LimitExceededException, ResourceNotFoundException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisException
To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to describe, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream.
This operation has a limit of 20 transactions per second per stream.
When making a cross-account call with
DescribeStreamConsumer
, make sure to provide the ARN of the consumer.- Parameters:
describeStreamConsumerRequest
-- Returns:
- Result of the DescribeStreamConsumer operation returned by the service.
- Throws:
LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeStreamConsumer
default DescribeStreamConsumerResponse describeStreamConsumer(Consumer<DescribeStreamConsumerRequest.Builder> describeStreamConsumerRequest) throws LimitExceededException, ResourceNotFoundException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisException
To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to describe, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream.
This operation has a limit of 20 transactions per second per stream.
When making a cross-account call with
DescribeStreamConsumer
, make sure to provide the ARN of the consumer.
This is a convenience which creates an instance of the
DescribeStreamConsumerRequest.Builder
avoiding the need to create one manually viaDescribeStreamConsumerRequest.builder()
- Parameters:
describeStreamConsumerRequest
- AConsumer
that will call methods onDescribeStreamConsumerRequest.Builder
to create a request.- Returns:
- Result of the DescribeStreamConsumer operation returned by the service.
- Throws:
LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeStreamSummary
default DescribeStreamSummaryResponse describeStreamSummary(DescribeStreamSummaryRequest describeStreamSummaryRequest) throws ResourceNotFoundException, LimitExceededException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Provides a summarized description of the specified Kinesis data stream without the shard list.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count.
DescribeStreamSummary has a limit of 20 transactions per second per account.
- Parameters:
describeStreamSummaryRequest
-- Returns:
- Result of the DescribeStreamSummary operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
describeStreamSummary
default DescribeStreamSummaryResponse describeStreamSummary(Consumer<DescribeStreamSummaryRequest.Builder> describeStreamSummaryRequest) throws ResourceNotFoundException, LimitExceededException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Provides a summarized description of the specified Kinesis data stream without the shard list.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count.
DescribeStreamSummary has a limit of 20 transactions per second per account.
This is a convenience which creates an instance of the
DescribeStreamSummaryRequest.Builder
avoiding the need to create one manually viaDescribeStreamSummaryRequest.builder()
- Parameters:
describeStreamSummaryRequest
- AConsumer
that will call methods onDescribeStreamSummaryRequest.Builder
to create a request.- Returns:
- Result of the DescribeStreamSummary operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
disableEnhancedMonitoring
default DisableEnhancedMonitoringResponse disableEnhancedMonitoring(DisableEnhancedMonitoringRequest disableEnhancedMonitoringRequest) throws InvalidArgumentException, LimitExceededException, ResourceInUseException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Disables enhanced monitoring.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.- Parameters:
disableEnhancedMonitoringRequest
- Represents the input for DisableEnhancedMonitoring.- Returns:
- Result of the DisableEnhancedMonitoring operation returned by the service.
- Throws:
InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
disableEnhancedMonitoring
default DisableEnhancedMonitoringResponse disableEnhancedMonitoring(Consumer<DisableEnhancedMonitoringRequest.Builder> disableEnhancedMonitoringRequest) throws InvalidArgumentException, LimitExceededException, ResourceInUseException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Disables enhanced monitoring.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.
This is a convenience which creates an instance of the
DisableEnhancedMonitoringRequest.Builder
avoiding the need to create one manually viaDisableEnhancedMonitoringRequest.builder()
- Parameters:
disableEnhancedMonitoringRequest
- AConsumer
that will call methods onDisableEnhancedMonitoringRequest.Builder
to create a request. Represents the input for DisableEnhancedMonitoring.- Returns:
- Result of the DisableEnhancedMonitoring operation returned by the service.
- Throws:
InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
enableEnhancedMonitoring
default EnableEnhancedMonitoringResponse enableEnhancedMonitoring(EnableEnhancedMonitoringRequest enableEnhancedMonitoringRequest) throws InvalidArgumentException, LimitExceededException, ResourceInUseException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Enables enhanced Kinesis data stream monitoring for shard-level metrics.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.- Parameters:
enableEnhancedMonitoringRequest
- Represents the input for EnableEnhancedMonitoring.- Returns:
- Result of the EnableEnhancedMonitoring operation returned by the service.
- Throws:
InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
enableEnhancedMonitoring
default EnableEnhancedMonitoringResponse enableEnhancedMonitoring(Consumer<EnableEnhancedMonitoringRequest.Builder> enableEnhancedMonitoringRequest) throws InvalidArgumentException, LimitExceededException, ResourceInUseException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Enables enhanced Kinesis data stream monitoring for shard-level metrics.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.
This is a convenience which creates an instance of the
EnableEnhancedMonitoringRequest.Builder
avoiding the need to create one manually viaEnableEnhancedMonitoringRequest.builder()
- Parameters:
enableEnhancedMonitoringRequest
- AConsumer
that will call methods onEnableEnhancedMonitoringRequest.Builder
to create a request. Represents the input for EnableEnhancedMonitoring.- Returns:
- Result of the EnableEnhancedMonitoring operation returned by the service.
- Throws:
InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getRecords
default GetRecordsResponse getRecords(GetRecordsRequest getRecordsRequest) throws ResourceNotFoundException, InvalidArgumentException, ProvisionedThroughputExceededException, ExpiredIteratorException, KmsDisabledException, KmsInvalidStateException, KmsAccessDeniedException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Gets data records from a Kinesis data stream's shard.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.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. 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 Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data 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 inNextShardIterator
in subsequent calls to GetRecords. If the shard has been closed, the shard iterator can't return more data and GetRecords returnsnull
inNextShardIterator
. 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 MiB in size, and each shard can read up to 2 MiB 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 maximum number of records that can be returned per call is 10,000.The size of the data returned by GetRecords varies depending on the utilization of the shard. It is recommended that consumer applications retrieve records via the
GetRecords
command using the 5 TPS limit to remain caught up. Retrieving records less frequently can lead to consumer applications falling behind. The maximum size of data that GetRecords can return is 10 MiB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throwProvisionedThroughputExceededException
. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next 1 second throwProvisionedThroughputExceededException
. GetRecords doesn't return any data when it throws an exception. For this reason, we recommend that you wait 1 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 Data 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 time stamp, whereas a client-side time stamp 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 time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order.This operation has a limit of five transactions per second per shard.
- Parameters:
getRecordsRequest
- Represents the input for GetRecords.- Returns:
- Result of the GetRecords operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.ProvisionedThroughputExceededException
- The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in Amazon Web Services in the Amazon Web Services General Reference.ExpiredIteratorException
- The provided iterator exceeds the maximum age allowed.KmsDisabledException
- The request was rejected because the specified customer master key (CMK) isn't enabled.KmsInvalidStateException
- The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the Amazon Web Services Key Management Service Developer Guide.KmsAccessDeniedException
- The ciphertext references a key that doesn't exist or that you don't have access to.KmsNotFoundException
- The request was rejected because the specified entity or resource can't be found.KmsOptInRequiredException
- The Amazon Web Services access key ID needs a subscription for the service.KmsThrottlingException
- The request was denied due to request throttling. For more information about throttling, see Limits in the Amazon Web Services Key Management Service Developer Guide.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getRecords
default GetRecordsResponse getRecords(Consumer<GetRecordsRequest.Builder> getRecordsRequest) throws ResourceNotFoundException, InvalidArgumentException, ProvisionedThroughputExceededException, ExpiredIteratorException, KmsDisabledException, KmsInvalidStateException, KmsAccessDeniedException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Gets data records from a Kinesis data stream's shard.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.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. 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 Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data 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 inNextShardIterator
in subsequent calls to GetRecords. If the shard has been closed, the shard iterator can't return more data and GetRecords returnsnull
inNextShardIterator
. 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 MiB in size, and each shard can read up to 2 MiB 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 maximum number of records that can be returned per call is 10,000.The size of the data returned by GetRecords varies depending on the utilization of the shard. It is recommended that consumer applications retrieve records via the
GetRecords
command using the 5 TPS limit to remain caught up. Retrieving records less frequently can lead to consumer applications falling behind. The maximum size of data that GetRecords can return is 10 MiB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throwProvisionedThroughputExceededException
. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next 1 second throwProvisionedThroughputExceededException
. GetRecords doesn't return any data when it throws an exception. For this reason, we recommend that you wait 1 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 Data 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 time stamp, whereas a client-side time stamp 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 time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order.This operation has a limit of five transactions per second per shard.
This is a convenience which creates an instance of the
GetRecordsRequest.Builder
avoiding the need to create one manually viaGetRecordsRequest.builder()
- Parameters:
getRecordsRequest
- AConsumer
that will call methods onGetRecordsRequest.Builder
to create a request. Represents the input for GetRecords.- Returns:
- Result of the GetRecords operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.ProvisionedThroughputExceededException
- The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in Amazon Web Services in the Amazon Web Services General Reference.ExpiredIteratorException
- The provided iterator exceeds the maximum age allowed.KmsDisabledException
- The request was rejected because the specified customer master key (CMK) isn't enabled.KmsInvalidStateException
- The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the Amazon Web Services Key Management Service Developer Guide.KmsAccessDeniedException
- The ciphertext references a key that doesn't exist or that you don't have access to.KmsNotFoundException
- The request was rejected because the specified entity or resource can't be found.KmsOptInRequiredException
- The Amazon Web Services access key ID needs a subscription for the service.KmsThrottlingException
- The request was denied due to request throttling. For more information about throttling, see Limits in the Amazon Web Services Key Management Service Developer Guide.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getResourcePolicy
default GetResourcePolicyResponse getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest) throws AccessDeniedException, ResourceNotFoundException, LimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisException
Returns a policy attached to the specified data stream or consumer. Request patterns can be one of the following:
-
Data stream pattern:
arn:aws.*:kinesis:.*:\d{12}:.*stream/\S+
-
Consumer pattern:
^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+
- Parameters:
getResourcePolicyRequest
-- Returns:
- Result of the GetResourcePolicy operation returned by the service.
- Throws:
AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
getResourcePolicy
default GetResourcePolicyResponse getResourcePolicy(Consumer<GetResourcePolicyRequest.Builder> getResourcePolicyRequest) throws AccessDeniedException, ResourceNotFoundException, LimitExceededException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisException
Returns a policy attached to the specified data stream or consumer. Request patterns can be one of the following:
-
Data stream pattern:
arn:aws.*:kinesis:.*:\d{12}:.*stream/\S+
-
Consumer pattern:
^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+
This is a convenience which creates an instance of the
GetResourcePolicyRequest.Builder
avoiding the need to create one manually viaGetResourcePolicyRequest.builder()
- Parameters:
getResourcePolicyRequest
- AConsumer
that will call methods onGetResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the GetResourcePolicy operation returned by the service.
- Throws:
AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
getShardIterator
default GetShardIteratorResponse getShardIterator(GetShardIteratorRequest getShardIteratorRequest) throws ResourceNotFoundException, InvalidArgumentException, ProvisionedThroughputExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.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 theAT_SEQUENCE_NUMBER
shard iterator type. Alternatively, the parameter can read right after the sequence number by using theAFTER_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 typeAT_TIMESTAMP
to read records from an arbitrary point in time,TRIM_HORIZON
to causeShardIterator
to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), orLATEST
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 inNextShardIterator
, which you use in theShardIterator
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 Data Streams Developer Guide.If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using SplitShard or MergeShards.
GetShardIterator has a limit of five transactions per second per account per open shard.
- Parameters:
getShardIteratorRequest
- Represents the input forGetShardIterator
.- Returns:
- Result of the GetShardIterator operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.ProvisionedThroughputExceededException
- The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in Amazon Web Services in the Amazon Web Services General Reference.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
getShardIterator
default GetShardIteratorResponse getShardIterator(Consumer<GetShardIteratorRequest.Builder> getShardIteratorRequest) throws ResourceNotFoundException, InvalidArgumentException, ProvisionedThroughputExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.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 theAT_SEQUENCE_NUMBER
shard iterator type. Alternatively, the parameter can read right after the sequence number by using theAFTER_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 typeAT_TIMESTAMP
to read records from an arbitrary point in time,TRIM_HORIZON
to causeShardIterator
to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), orLATEST
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 inNextShardIterator
, which you use in theShardIterator
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 Data Streams Developer Guide.If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using SplitShard or MergeShards.
GetShardIterator has a limit of five transactions per second per account per open shard.
This is a convenience which creates an instance of the
GetShardIteratorRequest.Builder
avoiding the need to create one manually viaGetShardIteratorRequest.builder()
- Parameters:
getShardIteratorRequest
- AConsumer
that will call methods onGetShardIteratorRequest.Builder
to create a request. Represents the input forGetShardIterator
.- Returns:
- Result of the GetShardIterator operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.ProvisionedThroughputExceededException
- The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in Amazon Web Services in the Amazon Web Services General Reference.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
increaseStreamRetentionPeriod
default IncreaseStreamRetentionPeriodResponse increaseStreamRetentionPeriod(IncreaseStreamRetentionPeriodRequest increaseStreamRetentionPeriodRequest) throws ResourceInUseException, ResourceNotFoundException, LimitExceededException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Increases the Kinesis data 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 8760 hours (365 days).
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (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 remains inaccessible to consumer applications.
- Parameters:
increaseStreamRetentionPeriodRequest
- Represents the input for IncreaseStreamRetentionPeriod.- Returns:
- Result of the IncreaseStreamRetentionPeriod operation returned by the service.
- Throws:
ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
increaseStreamRetentionPeriod
default IncreaseStreamRetentionPeriodResponse increaseStreamRetentionPeriod(Consumer<IncreaseStreamRetentionPeriodRequest.Builder> increaseStreamRetentionPeriodRequest) throws ResourceInUseException, ResourceNotFoundException, LimitExceededException, InvalidArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Increases the Kinesis data 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 8760 hours (365 days).
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (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 remains inaccessible to consumer applications.
This is a convenience which creates an instance of the
IncreaseStreamRetentionPeriodRequest.Builder
avoiding the need to create one manually viaIncreaseStreamRetentionPeriodRequest.builder()
- Parameters:
increaseStreamRetentionPeriodRequest
- AConsumer
that will call methods onIncreaseStreamRetentionPeriodRequest.Builder
to create a request. Represents the input for IncreaseStreamRetentionPeriod.- Returns:
- Result of the IncreaseStreamRetentionPeriod operation returned by the service.
- Throws:
ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listShards
default ListShardsResponse listShards(ListShardsRequest listShardsRequest) throws ResourceNotFoundException, InvalidArgumentException, LimitExceededException, ExpiredNextTokenException, ResourceInUseException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Lists the shards in a stream and provides information about each shard. This operation has a limit of 1000 transactions per second per data stream.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.This action does not list expired shards. For information about expired shards, see Data Routing, Data Persistence, and Shard State after a Reshard.
This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.
- Parameters:
listShardsRequest
-- Returns:
- Result of the ListShards operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ExpiredNextTokenException
- The pagination token passed to the operation is expired.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listShards
default ListShardsResponse listShards(Consumer<ListShardsRequest.Builder> listShardsRequest) throws ResourceNotFoundException, InvalidArgumentException, LimitExceededException, ExpiredNextTokenException, ResourceInUseException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Lists the shards in a stream and provides information about each shard. This operation has a limit of 1000 transactions per second per data stream.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.This action does not list expired shards. For information about expired shards, see Data Routing, Data Persistence, and Shard State after a Reshard.
This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.
This is a convenience which creates an instance of the
ListShardsRequest.Builder
avoiding the need to create one manually viaListShardsRequest.builder()
- Parameters:
listShardsRequest
- AConsumer
that will call methods onListShardsRequest.Builder
to create a request.- Returns:
- Result of the ListShards operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ExpiredNextTokenException
- The pagination token passed to the operation is expired.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listStreamConsumers
default ListStreamConsumersResponse listStreamConsumers(ListStreamConsumersRequest listStreamConsumersRequest) throws ResourceNotFoundException, InvalidArgumentException, LimitExceededException, ExpiredNextTokenException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisException
Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer.
This operation has a limit of 5 transactions per second per stream.
- Parameters:
listStreamConsumersRequest
-- Returns:
- Result of the ListStreamConsumers operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ExpiredNextTokenException
- The pagination token passed to the operation is expired.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listStreamConsumers
default ListStreamConsumersResponse listStreamConsumers(Consumer<ListStreamConsumersRequest.Builder> listStreamConsumersRequest) throws ResourceNotFoundException, InvalidArgumentException, LimitExceededException, ExpiredNextTokenException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisException
Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer.
This operation has a limit of 5 transactions per second per stream.
This is a convenience which creates an instance of the
ListStreamConsumersRequest.Builder
avoiding the need to create one manually viaListStreamConsumersRequest.builder()
- Parameters:
listStreamConsumersRequest
- AConsumer
that will call methods onListStreamConsumersRequest.Builder
to create a request.- Returns:
- Result of the ListStreamConsumers operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ExpiredNextTokenException
- The pagination token passed to the operation is expired.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listStreamConsumersPaginator
default ListStreamConsumersIterable listStreamConsumersPaginator(ListStreamConsumersRequest listStreamConsumersRequest) throws ResourceNotFoundException, InvalidArgumentException, LimitExceededException, ExpiredNextTokenException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisException
This is a variant of
listStreamConsumers(software.amazon.awssdk.services.kinesis.model.ListStreamConsumersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.kinesis.paginators.ListStreamConsumersIterable responses = client.listStreamConsumersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.kinesis.paginators.ListStreamConsumersIterable responses = client .listStreamConsumersPaginator(request); for (software.amazon.awssdk.services.kinesis.model.ListStreamConsumersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.kinesis.paginators.ListStreamConsumersIterable responses = client.listStreamConsumersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreamConsumers(software.amazon.awssdk.services.kinesis.model.ListStreamConsumersRequest)
operation.- Parameters:
listStreamConsumersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ExpiredNextTokenException
- The pagination token passed to the operation is expired.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listStreamConsumersPaginator
default ListStreamConsumersIterable listStreamConsumersPaginator(Consumer<ListStreamConsumersRequest.Builder> listStreamConsumersRequest) throws ResourceNotFoundException, InvalidArgumentException, LimitExceededException, ExpiredNextTokenException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisException
This is a variant of
listStreamConsumers(software.amazon.awssdk.services.kinesis.model.ListStreamConsumersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.kinesis.paginators.ListStreamConsumersIterable responses = client.listStreamConsumersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.kinesis.paginators.ListStreamConsumersIterable responses = client .listStreamConsumersPaginator(request); for (software.amazon.awssdk.services.kinesis.model.ListStreamConsumersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.kinesis.paginators.ListStreamConsumersIterable responses = client.listStreamConsumersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreamConsumers(software.amazon.awssdk.services.kinesis.model.ListStreamConsumersRequest)
operation.
This is a convenience which creates an instance of the
ListStreamConsumersRequest.Builder
avoiding the need to create one manually viaListStreamConsumersRequest.builder()
- Parameters:
listStreamConsumersRequest
- AConsumer
that will call methods onListStreamConsumersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ExpiredNextTokenException
- The pagination token passed to the operation is expired.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listStreams
default ListStreamsResponse listStreams(ListStreamsRequest listStreamsRequest) throws LimitExceededException, ExpiredNextTokenException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisException
Lists your Kinesis data 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 theLimit
parameter. If you do not specify a value for theLimit
parameter, Kinesis Data Streams uses the default limit, which is currently 100.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 theListStreams
request in theExclusiveStartStreamName
parameter in a subsequent request toListStreams
. 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 five transactions per second per account.
- Parameters:
listStreamsRequest
- Represents the input forListStreams
.- Returns:
- Result of the ListStreams operation returned by the service.
- Throws:
LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ExpiredNextTokenException
- The pagination token passed to the operation is expired.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listStreams
default ListStreamsResponse listStreams(Consumer<ListStreamsRequest.Builder> listStreamsRequest) throws LimitExceededException, ExpiredNextTokenException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisException
Lists your Kinesis data 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 theLimit
parameter. If you do not specify a value for theLimit
parameter, Kinesis Data Streams uses the default limit, which is currently 100.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 theListStreams
request in theExclusiveStartStreamName
parameter in a subsequent request toListStreams
. 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 five transactions per second per account.
This is a convenience which creates an instance of the
ListStreamsRequest.Builder
avoiding the need to create one manually viaListStreamsRequest.builder()
- Parameters:
listStreamsRequest
- AConsumer
that will call methods onListStreamsRequest.Builder
to create a request. Represents the input forListStreams
.- Returns:
- Result of the ListStreams operation returned by the service.
- Throws:
LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ExpiredNextTokenException
- The pagination token passed to the operation is expired.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listStreams
default ListStreamsResponse listStreams() throws LimitExceededException, ExpiredNextTokenException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisException
Lists your Kinesis data 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 theLimit
parameter. If you do not specify a value for theLimit
parameter, Kinesis Data Streams uses the default limit, which is currently 100.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 theListStreams
request in theExclusiveStartStreamName
parameter in a subsequent request toListStreams
. 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 five transactions per second per account.
- Returns:
- Result of the ListStreams operation returned by the service.
- Throws:
LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ExpiredNextTokenException
- The pagination token passed to the operation is expired.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listStreams(ListStreamsRequest)
, AWS API Documentation
-
listStreamsPaginator
default ListStreamsIterable listStreamsPaginator() throws LimitExceededException, ExpiredNextTokenException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisException
This is a variant of
listStreams(software.amazon.awssdk.services.kinesis.model.ListStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.kinesis.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.kinesis.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); for (software.amazon.awssdk.services.kinesis.model.ListStreamsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.kinesis.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.kinesis.model.ListStreamsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ExpiredNextTokenException
- The pagination token passed to the operation is expired.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
listStreamsPaginator(ListStreamsRequest)
, AWS API Documentation
-
listStreamsPaginator
default ListStreamsIterable listStreamsPaginator(ListStreamsRequest listStreamsRequest) throws LimitExceededException, ExpiredNextTokenException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisException
This is a variant of
listStreams(software.amazon.awssdk.services.kinesis.model.ListStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.kinesis.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.kinesis.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); for (software.amazon.awssdk.services.kinesis.model.ListStreamsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.kinesis.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.kinesis.model.ListStreamsRequest)
operation.- Parameters:
listStreamsRequest
- Represents the input forListStreams
.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ExpiredNextTokenException
- The pagination token passed to the operation is expired.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listStreamsPaginator
default ListStreamsIterable listStreamsPaginator(Consumer<ListStreamsRequest.Builder> listStreamsRequest) throws LimitExceededException, ExpiredNextTokenException, InvalidArgumentException, AwsServiceException, SdkClientException, KinesisException
This is a variant of
listStreams(software.amazon.awssdk.services.kinesis.model.ListStreamsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.kinesis.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.kinesis.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); for (software.amazon.awssdk.services.kinesis.model.ListStreamsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.kinesis.paginators.ListStreamsIterable responses = client.listStreamsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStreams(software.amazon.awssdk.services.kinesis.model.ListStreamsRequest)
operation.
This is a convenience which creates an instance of the
ListStreamsRequest.Builder
avoiding the need to create one manually viaListStreamsRequest.builder()
- Parameters:
listStreamsRequest
- AConsumer
that will call methods onListStreamsRequest.Builder
to create a request. Represents the input forListStreams
.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ExpiredNextTokenException
- The pagination token passed to the operation is expired.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTagsForStream
default ListTagsForStreamResponse listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest) throws ResourceNotFoundException, InvalidArgumentException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.- Parameters:
listTagsForStreamRequest
- Represents the input forListTagsForStream
.- Returns:
- Result of the ListTagsForStream operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
listTagsForStream
default ListTagsForStreamResponse listTagsForStream(Consumer<ListTagsForStreamRequest.Builder> listTagsForStreamRequest) throws ResourceNotFoundException, InvalidArgumentException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.
This is a convenience which creates an instance of the
ListTagsForStreamRequest.Builder
avoiding the need to create one manually viaListTagsForStreamRequest.builder()
- Parameters:
listTagsForStreamRequest
- AConsumer
that will call methods onListTagsForStreamRequest.Builder
to create a request. Represents the input forListTagsForStream
.- Returns:
- Result of the ListTagsForStream operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
mergeShards
default MergeShardsResponse mergeShards(MergeShardsRequest mergeShardsRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, LimitExceededException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. This API is only supported for the data streams with the provisioned capacity mode. 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.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.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 Data Streams Developer Guide.If the stream is in the
ACTIVE
state, you can callMergeShards
. If a stream is in theCREATING
,UPDATING
, orDELETING
state,MergeShards
returns aResourceInUseException
. If the specified stream does not exist,MergeShards
returns aResourceNotFoundException
.You can use DescribeStreamSummary to check the state of the stream, which is returned in
StreamStatus
.MergeShards
is an asynchronous operation. Upon receiving aMergeShards
request, Amazon Kinesis Data Streams immediately returns a response and sets theStreamStatus
toUPDATING
. After the operation is completed, Kinesis Data Streams sets theStreamStatus
toACTIVE
. Read and write operations continue to work while the stream is in theUPDATING
state.You use DescribeStreamSummary and the ListShards APIs 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 receive aLimitExceededException
.MergeShards
has a limit of five transactions per second per account.- Parameters:
mergeShardsRequest
- Represents the input forMergeShards
.- Returns:
- Result of the MergeShards operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ValidationException
- Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
mergeShards
default MergeShardsResponse mergeShards(Consumer<MergeShardsRequest.Builder> mergeShardsRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, LimitExceededException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. This API is only supported for the data streams with the provisioned capacity mode. 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.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.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 Data Streams Developer Guide.If the stream is in the
ACTIVE
state, you can callMergeShards
. If a stream is in theCREATING
,UPDATING
, orDELETING
state,MergeShards
returns aResourceInUseException
. If the specified stream does not exist,MergeShards
returns aResourceNotFoundException
.You can use DescribeStreamSummary to check the state of the stream, which is returned in
StreamStatus
.MergeShards
is an asynchronous operation. Upon receiving aMergeShards
request, Amazon Kinesis Data Streams immediately returns a response and sets theStreamStatus
toUPDATING
. After the operation is completed, Kinesis Data Streams sets theStreamStatus
toACTIVE
. Read and write operations continue to work while the stream is in theUPDATING
state.You use DescribeStreamSummary and the ListShards APIs 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 receive aLimitExceededException
.MergeShards
has a limit of five transactions per second per account.
This is a convenience which creates an instance of the
MergeShardsRequest.Builder
avoiding the need to create one manually viaMergeShardsRequest.builder()
- Parameters:
mergeShardsRequest
- AConsumer
that will call methods onMergeShardsRequest.Builder
to create a request. Represents the input forMergeShards
.- Returns:
- Result of the MergeShards operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ValidationException
- Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
putRecord
default PutRecordResponse putRecord(PutRecordRequest putRecordRequest) throws ResourceNotFoundException, InvalidArgumentException, ProvisionedThroughputExceededException, KmsDisabledException, KmsInvalidStateException, KmsAccessDeniedException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Writes a single data record into an Amazon Kinesis data 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 MiB per second.When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.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 Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs.
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 Data 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 Data Streams Developer Guide.After you write a record to a stream, you cannot modify that record or its order within the stream.
If a
PutRecord
request cannot be processed because of insufficient provisioned throughput on the shard involved in the request,PutRecord
throwsProvisionedThroughputExceededException
.By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
- Parameters:
putRecordRequest
- Represents the input forPutRecord
.- Returns:
- Result of the PutRecord operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.ProvisionedThroughputExceededException
- The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in Amazon Web Services in the Amazon Web Services General Reference.KmsDisabledException
- The request was rejected because the specified customer master key (CMK) isn't enabled.KmsInvalidStateException
- The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the Amazon Web Services Key Management Service Developer Guide.KmsAccessDeniedException
- The ciphertext references a key that doesn't exist or that you don't have access to.KmsNotFoundException
- The request was rejected because the specified entity or resource can't be found.KmsOptInRequiredException
- The Amazon Web Services access key ID needs a subscription for the service.KmsThrottlingException
- The request was denied due to request throttling. For more information about throttling, see Limits in the Amazon Web Services Key Management Service Developer Guide.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
putRecord
default PutRecordResponse putRecord(Consumer<PutRecordRequest.Builder> putRecordRequest) throws ResourceNotFoundException, InvalidArgumentException, ProvisionedThroughputExceededException, KmsDisabledException, KmsInvalidStateException, KmsAccessDeniedException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Writes a single data record into an Amazon Kinesis data 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 MiB per second.When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.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 Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs.
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 Data 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 Data Streams Developer Guide.After you write a record to a stream, you cannot modify that record or its order within the stream.
If a
PutRecord
request cannot be processed because of insufficient provisioned throughput on the shard involved in the request,PutRecord
throwsProvisionedThroughputExceededException
.By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
This is a convenience which creates an instance of the
PutRecordRequest.Builder
avoiding the need to create one manually viaPutRecordRequest.builder()
- Parameters:
putRecordRequest
- AConsumer
that will call methods onPutRecordRequest.Builder
to create a request. Represents the input forPutRecord
.- Returns:
- Result of the PutRecord operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.ProvisionedThroughputExceededException
- The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in Amazon Web Services in the Amazon Web Services General Reference.KmsDisabledException
- The request was rejected because the specified customer master key (CMK) isn't enabled.KmsInvalidStateException
- The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the Amazon Web Services Key Management Service Developer Guide.KmsAccessDeniedException
- The ciphertext references a key that doesn't exist or that you don't have access to.KmsNotFoundException
- The request was rejected because the specified entity or resource can't be found.KmsOptInRequiredException
- The Amazon Web Services access key ID needs a subscription for the service.KmsThrottlingException
- The request was denied due to request throttling. For more information about throttling, see Limits in the Amazon Web Services Key Management Service Developer Guide.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
putRecords
default PutRecordsResponse putRecords(PutRecordsRequest putRecordsRequest) throws ResourceNotFoundException, InvalidArgumentException, ProvisionedThroughputExceededException, KmsDisabledException, KmsInvalidStateException, KmsAccessDeniedException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Writes multiple data records into a Kinesis data 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.When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.Each
PutRecords
request can support up to 500 records. Each record in the request can be as large as 1 MiB, up to a limit of 5 MiB 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 MiB 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 Kinesis Data Streams 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 Data 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 Data Streams Developer Guide.The
PutRecords
response includes an array of responseRecords
. 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 responseRecords
array always includes the same number of records as the request array.The response
Records
array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in eachPutRecords
request. A single record failure does not stop the processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering of records. If you need to read records in the same order they are written to the stream, use PutRecord instead ofPutRecords
, and write to the same shard.A successfully processed record includes
ShardId
andSequenceNumber
values. TheShardId
parameter identifies the shard in the stream where the record is stored. TheSequenceNumber
parameter is an identifier assigned to the put record, unique to all records in the stream.An unsuccessfully processed record includes
ErrorCode
andErrorMessage
values.ErrorCode
reflects the type of error and can be one of the following values:ProvisionedThroughputExceededException
orInternalFailure
.ErrorMessage
provides more detailed information about theProvisionedThroughputExceededException
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 Data Streams Developer Guide.After you write a record to a stream, you cannot modify that record or its order within the stream.
By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
- Parameters:
putRecordsRequest
- APutRecords
request.- Returns:
- Result of the PutRecords operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.ProvisionedThroughputExceededException
- The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in Amazon Web Services in the Amazon Web Services General Reference.KmsDisabledException
- The request was rejected because the specified customer master key (CMK) isn't enabled.KmsInvalidStateException
- The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the Amazon Web Services Key Management Service Developer Guide.KmsAccessDeniedException
- The ciphertext references a key that doesn't exist or that you don't have access to.KmsNotFoundException
- The request was rejected because the specified entity or resource can't be found.KmsOptInRequiredException
- The Amazon Web Services access key ID needs a subscription for the service.KmsThrottlingException
- The request was denied due to request throttling. For more information about throttling, see Limits in the Amazon Web Services Key Management Service Developer Guide.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
putRecords
default PutRecordsResponse putRecords(Consumer<PutRecordsRequest.Builder> putRecordsRequest) throws ResourceNotFoundException, InvalidArgumentException, ProvisionedThroughputExceededException, KmsDisabledException, KmsInvalidStateException, KmsAccessDeniedException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Writes multiple data records into a Kinesis data 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.When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.Each
PutRecords
request can support up to 500 records. Each record in the request can be as large as 1 MiB, up to a limit of 5 MiB 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 MiB 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 Kinesis Data Streams 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 Data 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 Data Streams Developer Guide.The
PutRecords
response includes an array of responseRecords
. 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 responseRecords
array always includes the same number of records as the request array.The response
Records
array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in eachPutRecords
request. A single record failure does not stop the processing of subsequent records. As a result, PutRecords doesn't guarantee the ordering of records. If you need to read records in the same order they are written to the stream, use PutRecord instead ofPutRecords
, and write to the same shard.A successfully processed record includes
ShardId
andSequenceNumber
values. TheShardId
parameter identifies the shard in the stream where the record is stored. TheSequenceNumber
parameter is an identifier assigned to the put record, unique to all records in the stream.An unsuccessfully processed record includes
ErrorCode
andErrorMessage
values.ErrorCode
reflects the type of error and can be one of the following values:ProvisionedThroughputExceededException
orInternalFailure
.ErrorMessage
provides more detailed information about theProvisionedThroughputExceededException
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 Data Streams Developer Guide.After you write a record to a stream, you cannot modify that record or its order within the stream.
By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
This is a convenience which creates an instance of the
PutRecordsRequest.Builder
avoiding the need to create one manually viaPutRecordsRequest.builder()
- Parameters:
putRecordsRequest
- AConsumer
that will call methods onPutRecordsRequest.Builder
to create a request. APutRecords
request.- Returns:
- Result of the PutRecords operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.ProvisionedThroughputExceededException
- The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in Amazon Web Services in the Amazon Web Services General Reference.KmsDisabledException
- The request was rejected because the specified customer master key (CMK) isn't enabled.KmsInvalidStateException
- The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the Amazon Web Services Key Management Service Developer Guide.KmsAccessDeniedException
- The ciphertext references a key that doesn't exist or that you don't have access to.KmsNotFoundException
- The request was rejected because the specified entity or resource can't be found.KmsOptInRequiredException
- The Amazon Web Services access key ID needs a subscription for the service.KmsThrottlingException
- The request was denied due to request throttling. For more information about throttling, see Limits in the Amazon Web Services Key Management Service Developer Guide.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
putResourcePolicy
default PutResourcePolicyResponse putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) throws AccessDeniedException, ResourceNotFoundException, LimitExceededException, InvalidArgumentException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisException
Attaches a resource-based policy to a data stream or registered consumer. If you are using an identity other than the root user of the Amazon Web Services account that owns the resource, the calling identity must have the
PutResourcePolicy
permissions on the specified Kinesis Data Streams resource and belong to the owner's account in order to use this operation. If you don't havePutResourcePolicy
permissions, Amazon Kinesis Data Streams returns a403 Access Denied error
. If you receive aResourceNotFoundException
, check to see if you passed a valid stream or consumer resource.Request patterns can be one of the following:
-
Data stream pattern:
arn:aws.*:kinesis:.*:\d{12}:.*stream/\S+
-
Consumer pattern:
^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+
For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.
- Parameters:
putResourcePolicyRequest
-- Returns:
- Result of the PutResourcePolicy operation returned by the service.
- Throws:
AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
putResourcePolicy
default PutResourcePolicyResponse putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) throws AccessDeniedException, ResourceNotFoundException, LimitExceededException, InvalidArgumentException, ResourceInUseException, AwsServiceException, SdkClientException, KinesisException
Attaches a resource-based policy to a data stream or registered consumer. If you are using an identity other than the root user of the Amazon Web Services account that owns the resource, the calling identity must have the
PutResourcePolicy
permissions on the specified Kinesis Data Streams resource and belong to the owner's account in order to use this operation. If you don't havePutResourcePolicy
permissions, Amazon Kinesis Data Streams returns a403 Access Denied error
. If you receive aResourceNotFoundException
, check to see if you passed a valid stream or consumer resource.Request patterns can be one of the following:
-
Data stream pattern:
arn:aws.*:kinesis:.*:\d{12}:.*stream/\S+
-
Consumer pattern:
^(arn):aws.*:kinesis:.*:\d{12}:.*stream\/[a-zA-Z0-9_.-]+\/consumer\/[a-zA-Z0-9_.-]+:[0-9]+
For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.
This is a convenience which creates an instance of the
PutResourcePolicyRequest.Builder
avoiding the need to create one manually viaPutResourcePolicyRequest.builder()
- Parameters:
putResourcePolicyRequest
- AConsumer
that will call methods onPutResourcePolicyRequest.Builder
to create a request.- Returns:
- Result of the PutResourcePolicy operation returned by the service.
- Throws:
AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
registerStreamConsumer
default RegisterStreamConsumerResponse registerStreamConsumer(RegisterStreamConsumerRequest registerStreamConsumerRequest) throws InvalidArgumentException, LimitExceededException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, KinesisException
Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.
You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time.
For an example of how to use this operations, see Enhanced Fan-Out Using the Kinesis Data Streams API.
The use of this operation has a limit of five transactions per second per account. Also, only 5 consumers can be created simultaneously. In other words, you cannot have more than 5 consumers in a
CREATING
status at the same time. Registering a 6th consumer while there are 5 in aCREATING
status results in aLimitExceededException
.- Parameters:
registerStreamConsumerRequest
-- Returns:
- Result of the RegisterStreamConsumer operation returned by the service.
- Throws:
InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
registerStreamConsumer
default RegisterStreamConsumerResponse registerStreamConsumer(Consumer<RegisterStreamConsumerRequest.Builder> registerStreamConsumerRequest) throws InvalidArgumentException, LimitExceededException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, KinesisException
Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can then call SubscribeToShard to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream.
You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time.
For an example of how to use this operations, see Enhanced Fan-Out Using the Kinesis Data Streams API.
The use of this operation has a limit of five transactions per second per account. Also, only 5 consumers can be created simultaneously. In other words, you cannot have more than 5 consumers in a
CREATING
status at the same time. Registering a 6th consumer while there are 5 in aCREATING
status results in aLimitExceededException
.
This is a convenience which creates an instance of the
RegisterStreamConsumerRequest.Builder
avoiding the need to create one manually viaRegisterStreamConsumerRequest.builder()
- Parameters:
registerStreamConsumerRequest
- AConsumer
that will call methods onRegisterStreamConsumerRequest.Builder
to create a request.- Returns:
- Result of the RegisterStreamConsumer operation returned by the service.
- Throws:
InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
removeTagsFromStream
default RemoveTagsFromStreamResponse removeTagsFromStream(RemoveTagsFromStreamRequest removeTagsFromStreamRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.If you specify a tag that does not exist, it is ignored.
RemoveTagsFromStream has a limit of five transactions per second per account.
- Parameters:
removeTagsFromStreamRequest
- Represents the input forRemoveTagsFromStream
.- Returns:
- Result of the RemoveTagsFromStream operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
removeTagsFromStream
default RemoveTagsFromStreamResponse removeTagsFromStream(Consumer<RemoveTagsFromStreamRequest.Builder> removeTagsFromStreamRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.If you specify a tag that does not exist, it is ignored.
RemoveTagsFromStream has a limit of five transactions per second per account.
This is a convenience which creates an instance of the
RemoveTagsFromStreamRequest.Builder
avoiding the need to create one manually viaRemoveTagsFromStreamRequest.builder()
- Parameters:
removeTagsFromStreamRequest
- AConsumer
that will call methods onRemoveTagsFromStreamRequest.Builder
to create a request. Represents the input forRemoveTagsFromStream
.- Returns:
- Result of the RemoveTagsFromStream operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
splitShard
default SplitShardResponse splitShard(SplitShardRequest splitShardRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, LimitExceededException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Splits a shard into two new shards in the Kinesis data 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. This API is only supported for the data streams with the provisioned capacity mode.When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.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 callSplitShard
to increase stream capacity, so that more Kinesis Data Streams 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 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, see Split a Shard in the Amazon Kinesis Data Streams Developer Guide.
You can use DescribeStreamSummary and the ListShards APIs to determine the shard ID and hash key values for the
ShardToSplit
andNewStartingHashKey
parameters that are specified in theSplitShard
request.SplitShard
is an asynchronous operation. Upon receiving aSplitShard
request, Kinesis Data Streams immediately returns a response and sets the stream status toUPDATING
. After the operation is completed, Kinesis Data Streams sets the stream status toACTIVE
. Read and write operations continue to work while the stream is in theUPDATING
state.You can use DescribeStreamSummary to check the status of the stream, which is returned in
StreamStatus
. If the stream is in theACTIVE
state, you can callSplitShard
.If the specified stream does not exist, DescribeStreamSummary returns a
ResourceNotFoundException
. If you try to create more shards than are authorized for your account, you receive aLimitExceededException
.For the default shard limit for an Amazon Web Services account, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services Support.
If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a
LimitExceededException
.SplitShard
has a limit of five transactions per second per account.- Parameters:
splitShardRequest
- Represents the input forSplitShard
.- Returns:
- Result of the SplitShard operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ValidationException
- Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
splitShard
default SplitShardResponse splitShard(Consumer<SplitShardRequest.Builder> splitShardRequest) throws ResourceNotFoundException, ResourceInUseException, InvalidArgumentException, LimitExceededException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Splits a shard into two new shards in the Kinesis data 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. This API is only supported for the data streams with the provisioned capacity mode.When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.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 callSplitShard
to increase stream capacity, so that more Kinesis Data Streams 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 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, see Split a Shard in the Amazon Kinesis Data Streams Developer Guide.
You can use DescribeStreamSummary and the ListShards APIs to determine the shard ID and hash key values for the
ShardToSplit
andNewStartingHashKey
parameters that are specified in theSplitShard
request.SplitShard
is an asynchronous operation. Upon receiving aSplitShard
request, Kinesis Data Streams immediately returns a response and sets the stream status toUPDATING
. After the operation is completed, Kinesis Data Streams sets the stream status toACTIVE
. Read and write operations continue to work while the stream is in theUPDATING
state.You can use DescribeStreamSummary to check the status of the stream, which is returned in
StreamStatus
. If the stream is in theACTIVE
state, you can callSplitShard
.If the specified stream does not exist, DescribeStreamSummary returns a
ResourceNotFoundException
. If you try to create more shards than are authorized for your account, you receive aLimitExceededException
.For the default shard limit for an Amazon Web Services account, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact Amazon Web Services Support.
If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a
LimitExceededException
.SplitShard
has a limit of five transactions per second per account.
This is a convenience which creates an instance of the
SplitShardRequest.Builder
avoiding the need to create one manually viaSplitShardRequest.builder()
- Parameters:
splitShardRequest
- AConsumer
that will call methods onSplitShardRequest.Builder
to create a request. Represents the input forSplitShard
.- Returns:
- Result of the SplitShard operation returned by the service.
- Throws:
ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ValidationException
- Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startStreamEncryption
default StartStreamEncryptionResponse startStreamEncryption(StartStreamEncryptionRequest startStreamEncryptionRequest) throws InvalidArgumentException, LimitExceededException, ResourceInUseException, ResourceNotFoundException, KmsDisabledException, KmsInvalidStateException, KmsAccessDeniedException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Enables or updates server-side encryption using an Amazon Web Services KMS key for a specified stream.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to
UPDATING
. After the update is complete, Kinesis Data Streams sets the status of the stream back toACTIVE
. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status isUPDATING
. Once the status of the stream isACTIVE
, encryption begins for records written to the stream.API Limits: You can successfully apply a new Amazon Web Services KMS key for server-side encryption 25 times in a rolling 24-hour period.
Note: It can take up to 5 seconds after the stream is in an
ACTIVE
status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response fromPutRecord
orPutRecords
.- Parameters:
startStreamEncryptionRequest
-- Returns:
- Result of the StartStreamEncryption operation returned by the service.
- Throws:
InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.KmsDisabledException
- The request was rejected because the specified customer master key (CMK) isn't enabled.KmsInvalidStateException
- The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the Amazon Web Services Key Management Service Developer Guide.KmsAccessDeniedException
- The ciphertext references a key that doesn't exist or that you don't have access to.KmsNotFoundException
- The request was rejected because the specified entity or resource can't be found.KmsOptInRequiredException
- The Amazon Web Services access key ID needs a subscription for the service.KmsThrottlingException
- The request was denied due to request throttling. For more information about throttling, see Limits in the Amazon Web Services Key Management Service Developer Guide.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
startStreamEncryption
default StartStreamEncryptionResponse startStreamEncryption(Consumer<StartStreamEncryptionRequest.Builder> startStreamEncryptionRequest) throws InvalidArgumentException, LimitExceededException, ResourceInUseException, ResourceNotFoundException, KmsDisabledException, KmsInvalidStateException, KmsAccessDeniedException, KmsNotFoundException, KmsOptInRequiredException, KmsThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Enables or updates server-side encryption using an Amazon Web Services KMS key for a specified stream.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to
UPDATING
. After the update is complete, Kinesis Data Streams sets the status of the stream back toACTIVE
. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status isUPDATING
. Once the status of the stream isACTIVE
, encryption begins for records written to the stream.API Limits: You can successfully apply a new Amazon Web Services KMS key for server-side encryption 25 times in a rolling 24-hour period.
Note: It can take up to 5 seconds after the stream is in an
ACTIVE
status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response fromPutRecord
orPutRecords
.
This is a convenience which creates an instance of the
StartStreamEncryptionRequest.Builder
avoiding the need to create one manually viaStartStreamEncryptionRequest.builder()
- Parameters:
startStreamEncryptionRequest
- AConsumer
that will call methods onStartStreamEncryptionRequest.Builder
to create a request.- Returns:
- Result of the StartStreamEncryption operation returned by the service.
- Throws:
InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.KmsDisabledException
- The request was rejected because the specified customer master key (CMK) isn't enabled.KmsInvalidStateException
- The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the Amazon Web Services Key Management Service Developer Guide.KmsAccessDeniedException
- The ciphertext references a key that doesn't exist or that you don't have access to.KmsNotFoundException
- The request was rejected because the specified entity or resource can't be found.KmsOptInRequiredException
- The Amazon Web Services access key ID needs a subscription for the service.KmsThrottlingException
- The request was denied due to request throttling. For more information about throttling, see Limits in the Amazon Web Services Key Management Service Developer Guide.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopStreamEncryption
default StopStreamEncryptionResponse stopStreamEncryption(StopStreamEncryptionRequest stopStreamEncryptionRequest) throws InvalidArgumentException, LimitExceededException, ResourceInUseException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Disables server-side encryption for a specified stream.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to
UPDATING
. After the update is complete, Kinesis Data Streams sets the status of the stream back toACTIVE
. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status isUPDATING
. Once the status of the stream isACTIVE
, records written to the stream are no longer encrypted by Kinesis Data Streams.API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period.
Note: It can take up to 5 seconds after the stream is in an
ACTIVE
status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response fromPutRecord
orPutRecords
.- Parameters:
stopStreamEncryptionRequest
-- Returns:
- Result of the StopStreamEncryption operation returned by the service.
- Throws:
InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
stopStreamEncryption
default StopStreamEncryptionResponse stopStreamEncryption(Consumer<StopStreamEncryptionRequest.Builder> stopStreamEncryptionRequest) throws InvalidArgumentException, LimitExceededException, ResourceInUseException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Disables server-side encryption for a specified stream.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to
UPDATING
. After the update is complete, Kinesis Data Streams sets the status of the stream back toACTIVE
. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status isUPDATING
. Once the status of the stream isACTIVE
, records written to the stream are no longer encrypted by Kinesis Data Streams.API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period.
Note: It can take up to 5 seconds after the stream is in an
ACTIVE
status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response fromPutRecord
orPutRecords
.
This is a convenience which creates an instance of the
StopStreamEncryptionRequest.Builder
avoiding the need to create one manually viaStopStreamEncryptionRequest.builder()
- Parameters:
stopStreamEncryptionRequest
- AConsumer
that will call methods onStopStreamEncryptionRequest.Builder
to create a request.- Returns:
- Result of the StopStreamEncryption operation returned by the service.
- Throws:
InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateShardCount
default UpdateShardCountResponse updateShardCount(UpdateShardCountRequest updateShardCountRequest) throws InvalidArgumentException, LimitExceededException, ResourceInUseException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Updates the shard count of the specified stream to the specified number of shards. This API is only supported for the data streams with the provisioned capacity mode.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to
UPDATING
. After the update is complete, Kinesis Data Streams sets the status of the stream back toACTIVE
. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status isUPDATING
.To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. These short-lived shards count towards your total shard limit for your account in the Region.
When using this operation, we recommend that you specify a target shard count that is a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling action might take longer to complete.
This operation has the following default limits. By default, you cannot do the following:
-
Scale more than ten times per rolling 24-hour period per stream
-
Scale up to more than double your current shard count for a stream
-
Scale down below half your current shard count for a stream
-
Scale up to more than 10000 shards in a stream
-
Scale a stream with more than 10000 shards down unless the result is less than 10000 shards
-
Scale up to more than the shard limit for your account
-
Make over 10 TPS. TPS over 10 will trigger the LimitExceededException
For the default limits for an Amazon Web Services account, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the limits form.
- Parameters:
updateShardCountRequest
-- Returns:
- Result of the UpdateShardCount operation returned by the service.
- Throws:
InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.ValidationException
- Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
updateShardCount
default UpdateShardCountResponse updateShardCount(Consumer<UpdateShardCountRequest.Builder> updateShardCountRequest) throws InvalidArgumentException, LimitExceededException, ResourceInUseException, ResourceNotFoundException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, KinesisException
Updates the shard count of the specified stream to the specified number of shards. This API is only supported for the data streams with the provisioned capacity mode.
When invoking this API, you must use either the
StreamARN
or theStreamName
parameter, or both. It is recommended that you use theStreamARN
input parameter when you invoke this API.Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to
UPDATING
. After the update is complete, Kinesis Data Streams sets the status of the stream back toACTIVE
. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status isUPDATING
.To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. These short-lived shards count towards your total shard limit for your account in the Region.
When using this operation, we recommend that you specify a target shard count that is a multiple of 25% (25%, 50%, 75%, 100%). You can specify any target value within your shard limit. However, if you specify a target that isn't a multiple of 25%, the scaling action might take longer to complete.
This operation has the following default limits. By default, you cannot do the following:
-
Scale more than ten times per rolling 24-hour period per stream
-
Scale up to more than double your current shard count for a stream
-
Scale down below half your current shard count for a stream
-
Scale up to more than 10000 shards in a stream
-
Scale a stream with more than 10000 shards down unless the result is less than 10000 shards
-
Scale up to more than the shard limit for your account
-
Make over 10 TPS. TPS over 10 will trigger the LimitExceededException
For the default limits for an Amazon Web Services account, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the limits form.
This is a convenience which creates an instance of the
UpdateShardCountRequest.Builder
avoiding the need to create one manually viaUpdateShardCountRequest.builder()
- Parameters:
updateShardCountRequest
- AConsumer
that will call methods onUpdateShardCountRequest.Builder
to create a request.- Returns:
- Result of the UpdateShardCount operation returned by the service.
- Throws:
InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.ValidationException
- Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode.AccessDeniedException
- Specifies that you do not have the permissions required to perform this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
-
updateStreamMode
default UpdateStreamModeResponse updateStreamMode(UpdateStreamModeRequest updateStreamModeRequest) throws InvalidArgumentException, LimitExceededException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, KinesisException
Updates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data stream.
- Parameters:
updateStreamModeRequest
-- Returns:
- Result of the UpdateStreamMode operation returned by the service.
- Throws:
InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
updateStreamMode
default UpdateStreamModeResponse updateStreamMode(Consumer<UpdateStreamModeRequest.Builder> updateStreamModeRequest) throws InvalidArgumentException, LimitExceededException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, KinesisException
Updates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data stream.
This is a convenience which creates an instance of the
UpdateStreamModeRequest.Builder
avoiding the need to create one manually viaUpdateStreamModeRequest.builder()
- Parameters:
updateStreamModeRequest
- AConsumer
that will call methods onUpdateStreamModeRequest.Builder
to create a request.- Returns:
- Result of the UpdateStreamMode operation returned by the service.
- Throws:
InvalidArgumentException
- A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.LimitExceededException
- The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.ResourceInUseException
- The resource is not available for this operation. For successful operation, the resource must be in theACTIVE
state.ResourceNotFoundException
- The requested resource could not be found. The stream might not be specified correctly.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.KinesisException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
- See Also:
- AWS API Documentation
-
waiter
default KinesisWaiter waiter()
Create an instance ofKinesisWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
KinesisWaiter
-
create
static KinesisClient create()
Create aKinesisClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.
-
builder
static KinesisClientBuilder builder()
Create a builder that can be used to configure and create aKinesisClient
.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default KinesisServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
-
-