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

Provides a summarized description of the specified Kinesis data stream without the * shard list.

* *

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.

*
*

The information returned includes the stream name, Amazon Resource Name (ARN), status, * record retention period, approximate creation time, monitoring, encryption details, and * open shard count.

*

* DescribeStreamSummary has a limit of 20 transactions per second per * account.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { KinesisClient, DescribeStreamSummaryCommand } from "@aws-sdk/client-kinesis"; // ES Modules import * // const { KinesisClient, DescribeStreamSummaryCommand } = 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 = { // DescribeStreamSummaryInput * StreamName: "STRING_VALUE", * StreamARN: "STRING_VALUE", * StreamId: "STRING_VALUE", * }; * const command = new DescribeStreamSummaryCommand(input); * const response = await client.send(command); * // { // DescribeStreamSummaryOutput * // StreamDescriptionSummary: { // StreamDescriptionSummary * // StreamName: "STRING_VALUE", // required * // StreamARN: "STRING_VALUE", // required * // StreamId: "STRING_VALUE", * // StreamStatus: "CREATING" || "DELETING" || "ACTIVE" || "UPDATING", // required * // StreamModeDetails: { // StreamModeDetails * // StreamMode: "PROVISIONED" || "ON_DEMAND", // required * // }, * // RetentionPeriodHours: Number("int"), // required * // StreamCreationTimestamp: new Date("TIMESTAMP"), // required * // EnhancedMonitoring: [ // EnhancedMonitoringList // required * // { // EnhancedMetrics * // ShardLevelMetrics: [ // MetricsNameList * // "IncomingBytes" || "IncomingRecords" || "OutgoingBytes" || "OutgoingRecords" || "WriteProvisionedThroughputExceeded" || "ReadProvisionedThroughputExceeded" || "IteratorAgeMilliseconds" || "ALL", * // ], * // }, * // ], * // EncryptionType: "NONE" || "KMS", * // KeyId: "STRING_VALUE", * // OpenShardCount: Number("int"), // required * // ConsumerCount: Number("int"), * // WarmThroughput: { // WarmThroughputObject * // TargetMiBps: Number("int"), * // CurrentMiBps: Number("int"), * // }, * // MaxRecordSizeInKiB: Number("int"), * // }, * // }; * * ``` * * @param DescribeStreamSummaryCommandInput - {@link DescribeStreamSummaryCommandInput} * @returns {@link DescribeStreamSummaryCommandOutput} * @see {@link DescribeStreamSummaryCommandInput} for command's `input` shape. * @see {@link DescribeStreamSummaryCommandOutput} 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 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 DescribeStreamSummaryCommand extends DescribeStreamSummaryCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeStreamSummaryInput; output: DescribeStreamSummaryOutput; }; sdk: { input: DescribeStreamSummaryCommandInput; output: DescribeStreamSummaryCommandOutput; }; }; }