

# 使用 AWS CLI 的 Kinesis 示例
<a name="cli_kinesis_code_examples"></a>

以下代码示例演示如何通过将 AWS Command Line Interface与 Kinesis 结合使用，来执行操作和实现常见场景。

*操作是大型程序的代码摘录*，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。

每个示例都包含一个指向完整源代码的链接，您可以从中找到有关如何在上下文中设置和运行代码的说明。

**Topics**
+ [操作](#actions)

## 操作
<a name="actions"></a>

### `add-tags-to-stream`
<a name="kinesis_AddTagsToStream_cli_topic"></a>

以下代码示例演示了如何使用 `add-tags-to-stream`。

**AWS CLI**  
**为数据流添加标签**  
以下 `add-tags-to-stream` 示例将键为 `samplekey` 且值为 `example` 的标签分配给指定流。  

```
aws kinesis add-tags-to-stream \
    --stream-name samplestream \
    --tags samplekey=example
```
此命令不生成任何输出。  
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[标记流](https://docs.aws.amazon.com/streams/latest/dev/tagging.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [AddTagsToStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/add-tags-to-stream.html)。

### `create-stream`
<a name="kinesis_CreateStream_cli_topic"></a>

以下代码示例演示了如何使用 `create-stream`。

**AWS CLI**  
**创建数据流**  
以下 `create-stream` 示例创建一个名为 samplestream 的数据流，其中包含 3 个分片。  

```
aws kinesis create-stream \
    --stream-name samplestream \
    --shard-count 3
```
此命令不生成任何输出。  
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[创建流](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-create-stream.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [CreateStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/create-stream.html)。

### `decrease-stream-retention-period`
<a name="kinesis_DecreaseStreamRetentionPeriod_cli_topic"></a>

以下代码示例演示了如何使用 `decrease-stream-retention-period`。

**AWS CLI**  
**缩短数据流保留期**  
以下 `decrease-stream-retention-period` 示例将名为 samplestream 的数据流的保留期（数据记录在添加到流中后可供访问的时间长度）缩短到 48 小时。  

```
aws kinesis decrease-stream-retention-period \
    --stream-name samplestream \
    --retention-period-hours 48
```
此命令不生成任何输出。  
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[更改数据留存期](https://docs.aws.amazon.com/streams/latest/dev/kinesis-extended-retention.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [DecreaseStreamRetentionPeriod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/decrease-stream-retention-period.html)。

### `delete-stream`
<a name="kinesis_DeleteStream_cli_topic"></a>

以下代码示例演示了如何使用 `delete-stream`。

**AWS CLI**  
**删除数据流**  
以下 `delete-stream` 示例删除指定的数据流。  

```
aws kinesis delete-stream \
    --stream-name samplestream
```
此命令不生成任何输出。  
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[删除流](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-delete-stream.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [DeleteStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/delete-stream.html)。

### `deregister-stream-consumer`
<a name="kinesis_DeregisterStreamConsumer_cli_topic"></a>

以下代码示例演示了如何使用 `deregister-stream-consumer`。

**AWS CLI**  
**注销数据流消费端**  
以下 `deregister-stream-consumer` 示例注销指定数据流的指定消费端。  

```
aws kinesis deregister-stream-consumer \
    --stream-arn arn:aws:kinesis:us-west-2:123456789012:stream/samplestream \
    --consumer-name KinesisConsumerApplication
```
此命令不生成任何输出。  
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》中的[使用 Kinesis Data Streams API 开发具有增强型扇出功能的消费端](https://docs.aws.amazon.com/streams/latest/dev/building-enhanced-consumers-api.html)**。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [DeregisterStreamConsumer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/deregister-stream-consumer.html)。

### `describe-limits`
<a name="kinesis_DescribeLimits_cli_topic"></a>

以下代码示例演示了如何使用 `describe-limits`。

**AWS CLI**  
**描述分片限制**  
以下 `describe-limits` 示例显示当前 AWS 账户的分片限制和用量。  

```
aws kinesis describe-limits
```
输出：  

```
{
    "ShardLimit": 500,
    "OpenShardCount": 29
}
```
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》中的[重新对流进行分片](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-resharding.html)**。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 [DescribeLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/describe-limits.html)**。

### `describe-stream-consumer`
<a name="kinesis_DescribeStreamConsumer_cli_topic"></a>

以下代码示例演示了如何使用 `describe-stream-consumer`。

**AWS CLI**  
**描述数据流消费端**  
以下 `describe-stream-consumer` 示例返回在指定数据流中注册的指定消费端的描述。  

```
aws kinesis describe-stream-consumer \
    --stream-arn arn:aws:kinesis:us-west-2:012345678912:stream/samplestream \
    --consumer-name KinesisConsumerApplication
```
输出：  

```
{
    "ConsumerDescription": {
        "ConsumerName": "KinesisConsumerApplication",
        "ConsumerARN": "arn:aws:kinesis:us-west-2:123456789012:stream/samplestream/consumer/KinesisConsumerApplication:1572383852",
        "ConsumerStatus": "ACTIVE",
        "ConsumerCreationTimestamp": 1572383852.0,
        "StreamARN": "arn:aws:kinesis:us-west-2:123456789012:stream/samplestream"
    }
}
```
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》中的[从 Amazon Kinesis Data Streams 读取数据](https://docs.aws.amazon.com/streams/latest/dev/building-consumers.html)。**  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [DescribeStreamConsumer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/describe-stream-consumer.html)。

### `describe-stream-summary`
<a name="kinesis_DescribeStreamSummary_cli_topic"></a>

以下代码示例演示了如何使用 `describe-stream-summary`。

**AWS 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 开发人员指南》**中的[创建和管理流](https://docs.aws.amazon.com/streams/latest/dev/working-with-streams.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [DescribeStreamSummary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/describe-stream-summary.html)。

### `describe-stream`
<a name="kinesis_DescribeStream_cli_topic"></a>

以下代码示例演示了如何使用 `describe-stream`。

**AWS CLI**  
**描述数据流**  
以下 `describe-stream` 示例返回指定数据流的详细信息。  

```
aws kinesis describe-stream \
    --stream-name samplestream
```
输出：  

```
{
    "StreamDescription": {
        "Shards": [
            {
                "ShardId": "shardId-000000000000",
                "HashKeyRange": {
                    "StartingHashKey": "0",
                    "EndingHashKey": "113427455640312821154458202477256070484"
                },
                "SequenceNumberRange": {
                    "StartingSequenceNumber": "49600871682957036442365024926191073437251060580128653314"
                }
            },
            {
                "ShardId": "shardId-000000000001",
                "HashKeyRange": {
                    "StartingHashKey": "113427455640312821154458202477256070485",
                    "EndingHashKey": "226854911280625642308916404954512140969"
                },
                "SequenceNumberRange": {
                    "StartingSequenceNumber": "49600871682979337187563555549332609155523708941634633746"
                }
            },
            {
                "ShardId": "shardId-000000000002",
                "HashKeyRange": {
                    "StartingHashKey": "226854911280625642308916404954512140970",
                    "EndingHashKey": "340282366920938463463374607431768211455"
                },
                "SequenceNumberRange": {
                    "StartingSequenceNumber": "49600871683001637932762086172474144873796357303140614178"
                }
            }
        ],
        "StreamARN": "arn:aws:kinesis:us-west-2:123456789012:stream/samplestream",
        "StreamName": "samplestream",
        "StreamStatus": "ACTIVE",
        "RetentionPeriodHours": 24,
        "EnhancedMonitoring": [
            {
                "ShardLevelMetrics": []
            }
        ],
        "EncryptionType": "NONE",
        "KeyId": null,
        "StreamCreationTimestamp": 1572297168.0
    }
}
```
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[创建和管理流](https://docs.aws.amazon.com/streams/latest/dev/working-with-streams.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [DescribeStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/describe-stream.html)。

### `disable-enhanced-monitoring`
<a name="kinesis_DisableEnhancedMonitoring_cli_topic"></a>

以下代码示例演示了如何使用 `disable-enhanced-monitoring`。

**AWS CLI**  
**禁用对分片级别指标进行增强型监控**  
以下 `disable-enhanced-monitoring` 示例禁用对分片级别指标进行增强型 Kinesis 数据流监控。  

```
aws kinesis disable-enhanced-monitoring \
    --stream-name samplestream --shard-level-metrics ALL
```
输出：  

```
{
    "StreamName": "samplestream",
    "CurrentShardLevelMetrics": [
        "IncomingBytes",
        "OutgoingRecords",
        "IteratorAgeMilliseconds",
        "IncomingRecords",
        "ReadProvisionedThroughputExceeded",
        "WriteProvisionedThroughputExceeded",
        "OutgoingBytes"
    ],
    "DesiredShardLevelMetrics": []
}
```
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[在 Amazon Kinesis Data Streams 中监控流](https://docs.aws.amazon.com/streams/latest/dev/monitoring.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [DisableEnhancedMonitoring](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/disable-enhanced-monitoring.html)。

### `enable-enhanced-monitoring`
<a name="kinesis_EnableEnhancedMonitoring_cli_topic"></a>

以下代码示例演示了如何使用 `enable-enhanced-monitoring`。

**AWS CLI**  
**启用对分片级别指标进行增强型监控**  
以下 `enable-enhanced-monitoring` 示例启用对分片级别指标进行增强型 Kinesis 数据流监控。  

```
aws kinesis enable-enhanced-monitoring \
    --stream-name samplestream \
    --shard-level-metrics ALL
```
输出：  

```
{
    "StreamName": "samplestream",
    "CurrentShardLevelMetrics": [],
    "DesiredShardLevelMetrics": [
        "IncomingBytes",
        "OutgoingRecords",
        "IteratorAgeMilliseconds",
        "IncomingRecords",
        "ReadProvisionedThroughputExceeded",
        "WriteProvisionedThroughputExceeded",
        "OutgoingBytes"
    ]
}
```
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[在 Amazon Kinesis Data Streams 中监控流](https://docs.aws.amazon.com/streams/latest/dev/monitoring.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [EnableEnhancedMonitoring](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/enable-enhanced-monitoring.html)。

### `get-records`
<a name="kinesis_GetRecords_cli_topic"></a>

以下代码示例演示了如何使用 `get-records`。

**AWS CLI**  
**获取分片中的记录**  
以下 `get-records` 示例使用指定分片迭代器从 Kinesis 数据流的分片中获取数据记录。  

```
aws kinesis get-records \
    --shard-iterator AAAAAAAAAAF7/0mWD7IuHj1yGv/TKuNgx2ukD5xipCY4cy4gU96orWwZwcSXh3K9tAmGYeOZyLZrvzzeOFVf9iN99hUPw/w/b0YWYeehfNvnf1DYt5XpDJghLKr3DzgznkTmMymDP3R+3wRKeuEw6/kdxY2yKJH0veaiekaVc4N2VwK/GvaGP2Hh9Fg7N++q0Adg6fIDQPt4p8RpavDbk+A4sL9SWGE1
```
输出：  

```
{
    "Records": [],
    "MillisBehindLatest": 80742000
}
```
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[通过 AWS SDK for Java 使用 Kinesis Data Streams API 开发消费端](https://docs.aws.amazon.com/streams/latest/dev/developing-consumers-with-sdk.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [GetRecords](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/get-records.html)。

### `get-shard-iterator`
<a name="kinesis_GetShardIterator_cli_topic"></a>

以下代码示例演示了如何使用 `get-shard-iterator`。

**AWS CLI**  
**获取分片迭代器**  
以下 `get-shard-iterator` 示例使用 `AT_SEQUENCE_NUMBER` 分片迭代器类型并生成分片迭代器，以便从指定序列号所表示的位置开始精确读取数据记录。  

```
aws kinesis get-shard-iterator \
    --stream-name samplestream \
    --shard-id shardId-000000000001 \
    --shard-iterator-type LATEST
```
输出：  

```
{
    "ShardIterator": "AAAAAAAAAAFEvJjIYI+3jw/4aqgH9FifJ+n48XWTh/IFIsbILP6o5eDueD39NXNBfpZ10WL5K6ADXk8w+5H+Qhd9cFA9k268CPXCz/kebq1TGYI7Vy+lUkA9BuN3xvATxMBGxRY3zYK05gqgvaIRn94O8SqeEqwhigwZxNWxID3Ej7YYYcxQi8Q/fIrCjGAy/n2r5Z9G864YpWDfN9upNNQAR/iiOWKs"
}
```
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[通过 AWS SDK for Java 使用 Kinesis Data Streams API 开发消费端](https://docs.aws.amazon.com/streams/latest/dev/developing-consumers-with-sdk.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [GetShardIterator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/get-shard-iterator.html)。

### `increase-stream-retention-period`
<a name="kinesis_IncreaseStreamRetentionPeriod_cli_topic"></a>

以下代码示例演示了如何使用 `increase-stream-retention-period`。

**AWS CLI**  
**延长数据流保留期**  
以下 `increase-stream-retention-period` 示例将指定数据流的保留期（数据记录在添加到流中后可供访问的时间长度）延长到 168 小时。  

```
aws kinesis increase-stream-retention-period \
    --stream-name samplestream \
    --retention-period-hours 168
```
此命令不生成任何输出。  
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[更改数据留存期](https://docs.aws.amazon.com/streams/latest/dev/kinesis-extended-retention.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [IncreaseStreamRetentionPeriod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/increase-stream-retention-period.html)。

### `list-shards`
<a name="kinesis_ListShards_cli_topic"></a>

以下代码示例演示了如何使用 `list-shards`。

**AWS CLI**  
**列出数据流中的分片**  
以下 `list-shards` 示例列出指定流中从 ID 紧接指定 `exclusive-start-shard-id` 的 `shardId-000000000000` 后的分片开始的所有分片。  

```
aws kinesis list-shards \
    --stream-name samplestream \
    --exclusive-start-shard-id shardId-000000000000
```
输出：  

```
{
    "Shards": [
        {
            "ShardId": "shardId-000000000001",
            "HashKeyRange": {
                "StartingHashKey": "113427455640312821154458202477256070485",
                "EndingHashKey": "226854911280625642308916404954512140969"
            },
            "SequenceNumberRange": {
                "StartingSequenceNumber": "49600871682979337187563555549332609155523708941634633746"
            }
        },
        {
            "ShardId": "shardId-000000000002",
            "HashKeyRange": {
                "StartingHashKey": "226854911280625642308916404954512140970",
                "EndingHashKey": "340282366920938463463374607431768211455"
            },
            "SequenceNumberRange": {
                "StartingSequenceNumber": "49600871683001637932762086172474144873796357303140614178"
            }
        }
    ]
}
```
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[列出分片](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-list-shards.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 [ListShards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/list-shards.html)**。

### `list-streams`
<a name="kinesis_ListStreams_cli_topic"></a>

以下代码示例演示了如何使用 `list-streams`。

**AWS CLI**  
**列出数据流**  
以下 `list-streams` 示例列出了当前账户和区域中的所有活动数据流。  

```
aws kinesis list-streams
```
输出：  

```
{
    "StreamNames": [
        "samplestream",
        "samplestream1"
    ]
}
```
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[列出流](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-list-streams.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [ListStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/list-streams.html)。

### `list-tags-for-stream`
<a name="kinesis_ListTagsForStream_cli_topic"></a>

以下代码示例演示了如何使用 `list-tags-for-stream`。

**AWS CLI**  
**列出数据流的标签**  
以下 `list-tags-for-stream` 示例列出附加到指定数据流的标签：  

```
aws kinesis list-tags-for-stream \
    --stream-name samplestream
```
输出：  

```
{
    "Tags": [
        {
            "Key": "samplekey",
            "Value": "example"
        }
    ],
    "HasMoreTags": false
}
```
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[标记流](https://docs.aws.amazon.com/streams/latest/dev/tagging.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [ListTagsForStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/list-tags-for-stream.html)。

### `merge-shards`
<a name="kinesis_MergeShards_cli_topic"></a>

以下代码示例演示了如何使用 `merge-shards`。

**AWS CLI**  
**合并分片**  
以下 `merge-shards` 示例将指定数据流中两个相邻的且 ID 分别为 shardId-000000000000 和 shardId-000000000001 的分片合并成一个分片。  

```
aws kinesis merge-shards \
    --stream-name samplestream \
    --shard-to-merge shardId-000000000000 \
    --adjacent-shard-to-merge shardId-000000000001
```
此命令不生成任何输出。  
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[合并两个分片](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-resharding-merge.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [MergeShards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/merge-shards.html)。

### `put-record`
<a name="kinesis_PutRecord_cli_topic"></a>

以下代码示例演示了如何使用 `put-record`。

**AWS CLI**  
**将记录写入数据流**  
以下 `put-record` 示例使用指定的分区键将单个数据记录写入指定的数据流。  

```
aws kinesis put-record \
    --stream-name samplestream \
    --data sampledatarecord \
    --partition-key samplepartitionkey
```
输出：  

```
{
    "ShardId": "shardId-000000000009",
    "SequenceNumber": "49600902273357540915989931256901506243878407835297513618",
    "EncryptionType": "KMS"
}
```
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[通过 AWS SDK for Java 使用 Amazon Kinesis Data Streams API 开发创建器](https://docs.aws.amazon.com/streams/latest/dev/developing-producers-with-sdk.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [PutRecord](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/put-record.html)。

### `put-records`
<a name="kinesis_PutRecords_cli_topic"></a>

以下代码示例演示了如何使用 `put-records`。

**AWS CLI**  
**将多条记录写入一个数据流中**  
以下 `put-records` 示例在一次调用中使用指定的分区键写入一条数据记录，并使用不同的分区键写入另一条数据记录。  

```
aws kinesis put-records \
    --stream-name samplestream \
    --records Data=blob1,PartitionKey=partitionkey1 Data=blob2,PartitionKey=partitionkey2
```
输出：  

```
{
    "FailedRecordCount": 0,
    "Records": [
        {
            "SequenceNumber": "49600883331171471519674795588238531498465399900093808706",
            "ShardId": "shardId-000000000004"
        },
        {
            "SequenceNumber": "49600902273357540915989931256902715169698037101720764562",
            "ShardId": "shardId-000000000009"
        }
    ],
    "EncryptionType": "KMS"
}
```
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[通过 AWS SDK for Java 使用 Amazon Kinesis Data Streams API 开发创建器](https://docs.aws.amazon.com/streams/latest/dev/developing-producers-with-sdk.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [PutRecords](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/put-records.html)。

### `register-stream-consumer`
<a name="kinesis_RegisterStreamConsumer_cli_topic"></a>

以下代码示例演示了如何使用 `register-stream-consumer`。

**AWS CLI**  
**注册数据流消费端**  
以下 `register-stream-consumer` 示例将名为 `KinesisConsumerApplication` 的消费端注册到指定数据流。  

```
aws kinesis register-stream-consumer \
    --stream-arn arn:aws:kinesis:us-west-2:012345678912:stream/samplestream \
    --consumer-name KinesisConsumerApplication
```
输出：  

```
{
    "Consumer": {
        "ConsumerName": "KinesisConsumerApplication",
        "ConsumerARN": "arn:aws:kinesis:us-west-2: 123456789012:stream/samplestream/consumer/KinesisConsumerApplication:1572383852",
        "ConsumerStatus": "CREATING",
        "ConsumerCreationTimestamp": 1572383852.0
    }
}
```
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》中的[使用 Kinesis Data Streams API 开发具有增强型扇出功能的消费端](https://docs.aws.amazon.com/streams/latest/dev/building-enhanced-consumers-api.html)**。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [RegisterStreamConsumer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/register-stream-consumer.html)。

### `remove-tags-from-stream`
<a name="kinesis_RemoveTagsFromStream_cli_topic"></a>

以下代码示例演示了如何使用 `remove-tags-from-stream`。

**AWS CLI**  
**从数据流移除标签**  
以下 `remove-tags-from-stream` 示例从指定数据流中移除具有指定键的标签。  

```
aws kinesis remove-tags-from-stream \
    --stream-name samplestream \
    --tag-keys samplekey
```
此命令不生成任何输出。  
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[标记流](https://docs.aws.amazon.com/streams/latest/dev/tagging.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [RemoveTagsFromStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/remove-tags-from-stream.html)。

### `split-shard`
<a name="kinesis_SplitShard_cli_topic"></a>

以下代码示例演示了如何使用 `split-shard`。

**AWS CLI**  
**拆分分片**  
以下 `split-shard` 示例使用新的起始哈希键 10 将指定分片拆分为两个新分片。  

```
aws kinesis split-shard \
    --stream-name samplestream \
    --shard-to-split shardId-000000000000 \
    --new-starting-hash-key 10
```
此命令不生成任何输出。  
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的[拆分分片](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-resharding-split.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 [SplitShard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/split-shard.html)**。

### `start-stream-encryption`
<a name="kinesis_StartStreamEncryption_cli_topic"></a>

以下代码示例演示了如何使用 `start-stream-encryption`。

**AWS CLI**  
**启用数据流加密**  
以下 `start-stream-encryption` 示例使用指定 AWS KMS 密钥为指定流的服务器端加密。  

```
aws kinesis start-stream-encryption \
    --encryption-type KMS \
    --key-id arn:aws:kms:us-west-2:012345678912:key/a3c4a7cd-728b-45dd-b334-4d3eb496e452 \
    --stream-name samplestream
```
此命令不生成任何输出。  
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的 [Amazon Kinesis Data Streams 中的数据保护](https://docs.aws.amazon.com/streams/latest/dev/server-side-encryption.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [StartStreamEncryption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/start-stream-encryption.html)。

### `stop-stream-encryption`
<a name="kinesis_StopStreamEncryption_cli_topic"></a>

以下代码示例演示了如何使用 `stop-stream-encryption`。

**AWS CLI**  
**禁用数据流加密**  
以下 `stop-stream-encryption` 示例禁止使用指定 AWS KMS 密钥为指定流的服务器端加密。  

```
aws kinesis start-stream-encryption \
    --encryption-type KMS \
    --key-id arn:aws:kms:us-west-2:012345678912:key/a3c4a7cd-728b-45dd-b334-4d3eb496e452 \
    --stream-name samplestream
```
此命令不生成任何输出。  
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》**中的 [Amazon Kinesis Data Streams 中的数据保护](https://docs.aws.amazon.com/streams/latest/dev/server-side-encryption.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [StopStreamEncryption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/stop-stream-encryption.html)。

### `update-shard-count`
<a name="kinesis_UpdateShardCount_cli_topic"></a>

以下代码示例演示了如何使用 `update-shard-count`。

**AWS CLI**  
**更新数据流中的分片计数**  
以下 `update-shard-count` 示例将指定数据流的分片计数更新为 6。此示例使用统一缩放，创建同等大小的分片。  

```
aws kinesis update-shard-count \
    --stream-name samplestream \
    --scaling-type UNIFORM_SCALING \
    --target-shard-count 6
```
输出：  

```
{
    "StreamName": "samplestream",
    "CurrentShardCount": 3,
    "TargetShardCount": 6
}
```
有关更多信息，请参阅《Amazon Kinesis Data Streams 开发人员指南》中的[重新对流进行分片](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-resharding.html)**。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [UpdateShardCount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/update-shard-count.html)。