import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { KinesisClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KinesisClient"; import type { StartStreamEncryptionInput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link StartStreamEncryptionCommand}. */ export interface StartStreamEncryptionCommandInput extends StartStreamEncryptionInput { } /** * @public * * The output of {@link StartStreamEncryptionCommand}. */ export interface StartStreamEncryptionCommandOutput extends __MetadataBearer { } declare const StartStreamEncryptionCommand_base: { new (input: StartStreamEncryptionCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: StartStreamEncryptionCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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

* *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { KinesisClient, StartStreamEncryptionCommand } from "@aws-sdk/client-kinesis"; // ES Modules import * // const { KinesisClient, StartStreamEncryptionCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import * // import type { KinesisClientConfig } from "@aws-sdk/client-kinesis"; * const config = {}; // type is KinesisClientConfig * const client = new KinesisClient(config); * const input = { // StartStreamEncryptionInput * StreamName: "STRING_VALUE", * EncryptionType: "NONE" || "KMS", // required * KeyId: "STRING_VALUE", // required * StreamARN: "STRING_VALUE", * StreamId: "STRING_VALUE", * }; * const command = new StartStreamEncryptionCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param StartStreamEncryptionCommandInput - {@link StartStreamEncryptionCommandInput} * @returns {@link StartStreamEncryptionCommandOutput} * @see {@link StartStreamEncryptionCommandInput} for command's `input` shape. * @see {@link StartStreamEncryptionCommandOutput} for command's `response` shape. * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

Specifies that you do not have the permissions required to perform this * operation.

* * @throws {@link InvalidArgumentException} (client fault) *

A specified parameter exceeds its restrictions, is not supported, or can't be used. * For more information, see the returned message.

* * @throws {@link KMSAccessDeniedException} (client fault) *

The ciphertext references a key that doesn't exist or that you don't have access * to.

* * @throws {@link KMSDisabledException} (client fault) *

The request was rejected because the specified customer master key (CMK) isn't * enabled.

* * @throws {@link KMSInvalidStateException} (client fault) *

The request was rejected because the state of the specified resource isn't valid for * this request. For more information, see How Key State Affects Use of a * Customer Master Key in the Amazon Web Services Key Management * Service Developer Guide.

* * @throws {@link KMSNotFoundException} (client fault) *

The request was rejected because the specified entity or resource can't be * found.

* * @throws {@link KMSOptInRequired} (client fault) *

The Amazon Web Services access key ID needs a subscription for the service.

* * @throws {@link KMSThrottlingException} (client fault) *

The request was denied due to request throttling. For more information about * throttling, see Limits in * the Amazon Web Services Key Management Service Developer * Guide.

* * @throws {@link LimitExceededException} (client fault) *

The requested resource exceeds the maximum number allowed, or the number of concurrent * stream requests exceeds the maximum number allowed.

* * @throws {@link ResourceInUseException} (client fault) *

The resource is not available for this operation. For successful operation, the * resource must be in the ACTIVE state.

* * @throws {@link ResourceNotFoundException} (client fault) *

The requested resource could not be found. The stream might not be specified * correctly.

* * @throws {@link KinesisServiceException} *

Base exception class for all service exceptions from Kinesis service.

* * * @public */ export declare class StartStreamEncryptionCommand extends StartStreamEncryptionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartStreamEncryptionInput; output: {}; }; sdk: { input: StartStreamEncryptionCommandInput; output: StartStreamEncryptionCommandOutput; }; }; }