AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Enables or updates server-side encryption using an AWS KMS key for a specified stream.
Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis
Data Streams returns immediately and sets the status of the stream to
After the update is complete, Kinesis Data Streams sets the status of the stream back
ACTIVE. 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 is
UPDATING. Once the status of the stream is
ACTIVE, encryption begins for records written to the stream.
API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period.
Note: It can take up to five seconds after the stream is in an
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 from
For .NET Core, PCL and Unity this operation is only available in asynchronous form. Please refer to StartStreamEncryptionAsync.
public abstract StartStreamEncryptionResponse StartStreamEncryption( StartStreamEncryptionRequest request )
Container for the necessary parameters to execute the StartStreamEncryption service method.
|InvalidArgumentException||A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.|
|KMSAccessDeniedException||The ciphertext references a key that doesn't exist or that you don't have access to.|
|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 AWS Key Management Service Developer Guide.|
|KMSNotFoundException||The request was rejected because the specified entity or resource can't be found.|
|KMSOptInRequiredException||The AWS 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 AWS Key Management Service Developer Guide.|
|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 the ACTIVE state.|
|ResourceNotFoundException||The requested resource could not be found. The stream might not be specified correctly.|
Supported in: 4.5, 4.0, 3.5
Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone