stop_stream_encryption¶
Operation¶
async
¶
stop_stream_encryption(input: StopStreamEncryptionInput, plugins: list[Plugin] | None = None) -> StopStreamEncryptionOutput
Disables server-side encryption 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.
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 to ACTIVE. 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 is UPDATING. Once the status of the stream is ACTIVE,
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 from
PutRecord or PutRecords.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
StopStreamEncryptionInput
|
An instance of |
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 |
|---|---|
StopStreamEncryptionOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for StopStreamEncryptionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
encryption_type: str | None = ...
The encryption type. The only valid value is KMS.
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
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for StopStreamEncryptionOutput structure.