Firehose / Client / stop_delivery_stream_encryption
stop_delivery_stream_encryption#
- Firehose.Client.stop_delivery_stream_encryption(**kwargs)#
Disables server-side encryption (SSE) for the Firehose stream.
This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to
DISABLING
, and then toDISABLED
. You can continue to read and write data to your stream while its status isDISABLING
. It can take up to 5 seconds after the encryption status changes toDISABLED
before all records written to the Firehose stream are no longer subject to encryption. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.To check the encryption state of a Firehose stream, use DescribeDeliveryStream.
If SSE is enabled using a customer managed CMK and then you invoke
StopDeliveryStreamEncryption
, Firehose schedules the related KMS grant for retirement and then retires it after it ensures that it is finished delivering records to the destination.The
StartDeliveryStreamEncryption
andStopDeliveryStreamEncryption
operations have a combined limit of 25 calls per Firehose stream per 24 hours. For example, you reach the limit if you callStartDeliveryStreamEncryption
13 times andStopDeliveryStreamEncryption
12 times for the same Firehose stream in a 24-hour period.See also: AWS API Documentation
Request Syntax
response = client.stop_delivery_stream_encryption( DeliveryStreamName='string' )
- Parameters:
DeliveryStreamName (string) –
[REQUIRED]
The name of the Firehose stream for which you want to disable server-side encryption (SSE).
- Return type:
dict
- Returns:
Response Syntax
{}
Response Structure
(dict) –
Exceptions
Firehose.Client.exceptions.ResourceNotFoundException
Firehose.Client.exceptions.ResourceInUseException
Firehose.Client.exceptions.InvalidArgumentException
Firehose.Client.exceptions.LimitExceededException