Smaws_Client_Kinesis.StartStreamEncryptionval request :
Smaws_Lib.Context.t ->
start_stream_encryption_input ->
(unit,
[> Smaws_Lib.Protocols.AwsJson.error
| `AccessDeniedException of access_denied_exception
| `InvalidArgumentException of invalid_argument_exception
| `KMSAccessDeniedException of kms_access_denied_exception
| `KMSDisabledException of kms_disabled_exception
| `KMSInvalidStateException of kms_invalid_state_exception
| `KMSNotFoundException of kms_not_found_exception
| `KMSOptInRequired of kms_opt_in_required
| `KMSThrottlingException of kms_throttling_exception
| `LimitExceededException of limit_exceeded_exception
| `ResourceInUseException of resource_in_use_exception
| `ResourceNotFoundException of resource_not_found_exception ])
Stdlib.resultEnables 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 the StreamName parameter, or both. It is recommended that you use the StreamARN 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 to 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 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 from PutRecord or PutRecords.