Skip to content

Kinesis  >  Operations  >  start_stream_encryption

start_stream_encryption

Operation

start_stream_encryption async 

start_stream_encryption(input: StartStreamEncryptionInput, plugins: list[Plugin] | None = None) -> StartStreamEncryptionOutput

Enables or updates server-side encryption using an Amazon Web Services KMS key for a specified stream.

Note

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.

Parameters:

Name Type Description Default
input StartStreamEncryptionInput

An instance of StartStreamEncryptionInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
StartStreamEncryptionOutput

An instance of StartStreamEncryptionOutput.

Input

StartStreamEncryptionInput dataclass

Bases: _SerdeShape

Dataclass for StartStreamEncryptionInput structure.

Attributes

encryption_type class-attribute instance-attribute 
encryption_type: str | None = ...

The encryption type to use. The only valid value is KMS.

key_id class-attribute instance-attribute 
key_id: str | None = ...

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 aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

stream_arn class-attribute instance-attribute 
stream_arn: str | None = ...

The ARN of the stream.

stream_id class-attribute instance-attribute 
stream_id: str | None = ...

Not Implemented. Reserved for future use.

stream_name class-attribute instance-attribute 
stream_name: str | None = ...

The name of the stream for which to start encrypting records.

Output

StartStreamEncryptionOutput dataclass

Bases: _SerdeShape

Dataclass for StartStreamEncryptionOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.