DescribeStreamSummaryCommand

Suggest an Edit

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 Syntax

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

import { KinesisClient, DescribeStreamSummaryCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
// const { KinesisClient, DescribeStreamSummaryCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
const client = new KinesisClient(config);
const input = { // DescribeStreamSummaryInput
  StreamName: "STRING_VALUE",
  StreamARN: "STRING_VALUE",
};
const command = new DescribeStreamSummaryCommand(input);
const response = await client.send(command);
// { // DescribeStreamSummaryOutput
//   StreamDescriptionSummary: { // StreamDescriptionSummary
//     StreamName: "STRING_VALUE", // required
//     StreamARN: "STRING_VALUE", // required
//     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"),
//   },
// };

DescribeStreamSummaryCommand Input

See DescribeStreamSummaryCommandInput for more details

Parameter
Type
Description
StreamARN
string | undefined

The ARN of the stream.

StreamName
string | undefined

The name of the stream to describe.

DescribeStreamSummaryCommand Output

See DescribeStreamSummaryCommandOutput for details

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

A StreamDescriptionSummary containing information about the stream.

Throws

Name
Fault
Details
AccessDeniedException
client

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

InvalidArgumentException
client

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

LimitExceededException
client

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

ResourceNotFoundException
client

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

KinesisServiceException
Base exception class for all service exceptions from Kinesis service.