View a markdown version of this page

使用 DescribeStreamSummary 用 Amazon SDK 或 CLI - Amazon Kinesis Data Streams
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

使用 DescribeStreamSummary 用 Amazon SDK 或 CLI

以下代码示例显示了如何使用 DescribeStreamSummary。

操作示例是大型程序的代码摘录,必须在上下文中运行。在以下代码示例中,您可以查看此操作的上下文:

CLI
Amazon CLI

描述数据流摘要

以下 describe-stream-summary 示例提供指定数据流的摘要描述(无分片列表)。

aws kinesis describe-stream-summary \ --stream-name samplestream

输出:

{ "StreamDescriptionSummary": { "StreamName": "samplestream", "StreamARN": "arn:aws:kinesis:us-west-2:123456789012:stream/samplestream", "StreamStatus": "ACTIVE", "RetentionPeriodHours": 48, "StreamCreationTimestamp": 1572297168.0, "EnhancedMonitoring": [ { "ShardLevelMetrics": [] } ], "EncryptionType": "NONE", "OpenShardCount": 3, "ConsumerCount": 0 } }

有关更多信息,请参阅《Amazon Kinesis Data Streams 开发人员指南》中的创建和管理流。

Python
适用于 Python 的 SDK(Boto3)
注意

还有更多关于 GitHub。在 Amazon 代码示例存储库中查找完整示例,了解如何进行设置和运行。

def describe_stream_summary(self, stream_name): """ Provides a summarized description of a Kinesis data stream. :param stream_name: The name of the stream to describe. :return: A dictionary containing the stream description summary. """ try: response = self.kinesis_client.describe_stream_summary( StreamName=stream_name ) summary = response.get("StreamDescriptionSummary", dict()) logger.info( "Described stream summary for '%s'. Status: %s.", stream_name, summary.get("StreamStatus", "UNKNOWN"), ) return summary except ClientError as err: if err.response["Error"]["Code"] == "ResourceNotFoundException": logger.error( "Stream '%s' not found. Verify the stream name.", stream_name ) raise
  • 有关 API 的详细信息,请参阅 DescribeStreamSummary 在 Amazon 适用于 Python 的 SDK (Boto3) API 参考。

如需查看完整清单 Amazon SDK 开发者指南和代码示例,请参阅 将此服务与 Amazon SDK。本主题还包括有关入门的信息以及有关先前的 SDK 版本的详细信息。