Kinesis / Client / start_stream_encryption
Enables or updates server-side encryption using an Amazon Web Services 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
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
ACTIVEstatus 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
When invoking this API, it is recommended you use the
StreamARNinput parameter rather than the
See also: AWS API Documentation
response = client.start_stream_encryption( StreamName='string', EncryptionType='NONE'|'KMS', KeyId='string', StreamARN='string' )
StreamName (string) – The name of the stream for which to start encrypting records.
EncryptionType (string) –
The encryption type to use. The only valid value is
KeyId (string) –
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by “alias/”.You can also use a master key owned by Kinesis Data Streams by specifying the alias
Key ARN example:
Alias ARN example:
Globally unique key ID example:
Alias name example:
Master key owned by Kinesis Data Streams:
StreamARN (string) – The ARN of the stream.