StopDeliveryStreamEncryptionCommand

Suggest an Edit

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 to DISABLED. You can continue to read and write data to your stream while its status is DISABLING. It can take up to 5 seconds after the encryption status changes to DISABLED 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 and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per Firehose stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same Firehose stream in a 24-hour period.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { FirehoseClient, StopDeliveryStreamEncryptionCommand } from "@aws-sdk/client-firehose"; // ES Modules import
// const { FirehoseClient, StopDeliveryStreamEncryptionCommand } = require("@aws-sdk/client-firehose"); // CommonJS import
const client = new FirehoseClient(config);
const input = { // StopDeliveryStreamEncryptionInput
  DeliveryStreamName: "STRING_VALUE", // required
};
const command = new StopDeliveryStreamEncryptionCommand(input);
const response = await client.send(command);
// {};

StopDeliveryStreamEncryptionCommand Input

See StopDeliveryStreamEncryptionCommandInput for more details

Parameter
Type
Description
DeliveryStreamName
Required
string | undefined

The name of the Firehose stream for which you want to disable server-side encryption (SSE).

StopDeliveryStreamEncryptionCommand Output

See StopDeliveryStreamEncryptionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
InvalidArgumentException
client

The specified input parameter has a value that is not valid.

LimitExceededException
client

You have already reached the limit for a requested resource.

ResourceInUseException
client

The resource is already in use and not available for this operation.

ResourceNotFoundException
client

The specified resource could not be found.

FirehoseServiceException
Base exception class for all service exceptions from Firehose service.