import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { UpdateStreamModeInput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link UpdateStreamModeCommand}. */ export interface UpdateStreamModeCommandInput extends UpdateStreamModeInput { } /** * @public * * The output of {@link UpdateStreamModeCommand}. */ export interface UpdateStreamModeCommandOutput extends __MetadataBearer { } declare const UpdateStreamModeCommand_base: { new (input: UpdateStreamModeCommandInput): import("@smithy/core/client").CommandImpl; new (input: UpdateStreamModeCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Updates the capacity mode of the data stream. Currently, in Kinesis Data Streams, you * can choose between an on-demand capacity mode and a * provisioned capacity mode for your data stream. *

*

If you'd still like to proactively scale your on-demand data stream’s capacity, you can unlock the warm throughput feature for on-demand data streams by enabling MinimumThroughputBillingCommitment for your account. Once your account has MinimumThroughputBillingCommitment enabled, you can specify the warm throughput in MiB per second that your stream can support in writes.

*

You can't switch a data stream from on-demand to provisioned capacity mode while the stream has one or more queues. Delete the queues with DeleteQueue before you change the capacity mode.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { KinesisClient, UpdateStreamModeCommand } from "@aws-sdk/client-kinesis"; // ES Modules import * // const { KinesisClient, UpdateStreamModeCommand } = 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 = { // UpdateStreamModeInput * StreamARN: "STRING_VALUE", // required * StreamId: "STRING_VALUE", * StreamModeDetails: { // StreamModeDetails * StreamMode: "PROVISIONED" || "ON_DEMAND", // required * }, * WarmThroughputMiBps: Number("int"), * }; * const command = new UpdateStreamModeCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param UpdateStreamModeCommandInput - {@link UpdateStreamModeCommandInput} * @returns {@link UpdateStreamModeCommandOutput} * @see {@link UpdateStreamModeCommandInput} for command's `input` shape. * @see {@link UpdateStreamModeCommandOutput} for command's `response` shape. * @see {@link KinesisClientResolvedConfig | config} for KinesisClient's `config` shape. * * @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 ValidationException} (client fault) *

The request failed validation. For example, a parameter value is not valid, a * combination of parameters is not supported, or the operation is not supported for the * stream's capacity mode. The error message describes the specific reason.

* * @throws {@link KinesisServiceException} *

Base exception class for all service exceptions from Kinesis service.

* * * @public */ export declare class UpdateStreamModeCommand extends UpdateStreamModeCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateStreamModeInput; output: {}; }; sdk: { input: UpdateStreamModeCommandInput; output: UpdateStreamModeCommandOutput; }; }; }