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 { DeleteStreamInput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DeleteStreamCommand}. */ export interface DeleteStreamCommandInput extends DeleteStreamInput { } /** * @public * * The output of {@link DeleteStreamCommand}. */ export interface DeleteStreamCommandOutput extends __MetadataBearer { } declare const DeleteStreamCommand_base: { new (input: DeleteStreamCommandInput): import("@smithy/smithy-client").CommandImpl; new (...[input]: [] | [DeleteStreamCommandInput]): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Deletes a Kinesis data stream and all its shards and data. You must shut down any * applications that are operating on the stream before you delete the stream. If an * application attempts to operate on a deleted stream, it receives the exception * ResourceNotFoundException.

* *

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.

*
*

If the stream is in the ACTIVE state, you can delete it. After a * DeleteStream request, the specified stream is in the * DELETING state until Kinesis Data Streams completes the * deletion.

*

* Note: Kinesis Data Streams might continue to accept * data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the * DELETING state until the stream deletion is complete.

*

When you delete a stream, any shards in that stream are also deleted, and any tags are * dissociated from the stream.

*

You can use the DescribeStreamSummary operation to check the state * of the stream, which is returned in StreamStatus.

*

* DeleteStream has a limit of five transactions per second per * account.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { KinesisClient, DeleteStreamCommand } from "@aws-sdk/client-kinesis"; // ES Modules import * // const { KinesisClient, DeleteStreamCommand } = 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 = { // DeleteStreamInput * StreamName: "STRING_VALUE", * EnforceConsumerDeletion: true || false, * StreamARN: "STRING_VALUE", * StreamId: "STRING_VALUE", * }; * const command = new DeleteStreamCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param DeleteStreamCommandInput - {@link DeleteStreamCommandInput} * @returns {@link DeleteStreamCommandOutput} * @see {@link DeleteStreamCommandInput} for command's `input` shape. * @see {@link DeleteStreamCommandOutput} 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 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 DeleteStreamCommand extends DeleteStreamCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DeleteStreamInput; output: {}; }; sdk: { input: DeleteStreamCommandInput; output: DeleteStreamCommandOutput; }; }; }