# AWS CLI を使用する Kinesis の例
次のコード例は、Kinesis で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。
**Topics**
+ [アクション](#actions)
## アクション
### `add-tags-to-stream`
次のコード例は、`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 Developer Guide*」の「[Tagging Your 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`
次のコード例は、`create-stream` を使用する方法を示しています。
**AWS CLI**
**データストリームを作成するには**
次の `create-stream` の例は、3 つのシャードを含む samplestream という名前のデータストリームを作成します。
```
aws kinesis create-stream \
--stream-name samplestream \
--shard-count 3
```
このコマンドは何も出力しません。
詳細については、「Amazon Kinesis Data Streams ディベロッパーガイド」の「[API を使用したストリームの作成](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`
次のコード例は、`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`
次のコード例は、`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`
次のコード例は、`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 Developer Guide*」の「[Developing Consumers with Enhanced Fan-Out Using the 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`
次のコード例は、`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`
次のコード例は、`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 デベロッパーガイド*」の「[Reading Data from 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`
次のコード例は、`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`
次のコード例は、`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`
次のコード例は、`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 デベロッパーガイド*」の「[Monitoring Streams in 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`
次のコード例は、`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 デベロッパーガイド*」の「[Monitoring Streams in 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`
次のコード例は、`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 を使用した共有スループットでのカスタムコンシューマーの開発](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`
次のコード例は、`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 を使用した共有スループットでのカスタムコンシューマーの開発](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`
次のコード例は、`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`
次のコード例は、`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`
次のコード例は、`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`
次のコード例は、`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`
次のコード例は、`merge-shards` を使用する方法を示しています。
**AWS CLI**
**シャードをマージするには**
次の `merge-shards` の例では、指定されたデータストリーム内の 2 つの隣接するシャード (ID が shardId-000000000000 と shardId-000000000001) をマージし、1 つのシャードに結合します。
```
aws kinesis merge-shards \
--stream-name samplestream \
--shard-to-merge shardId-000000000000 \
--adjacent-shard-to-merge shardId-000000000001
```
このコマンドは何も出力しません。
詳細については、「*Amazon Kinesis Data Streams デベロッパーガイド*」の「[2 つのシャードを結合する](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`
次のコード例は、`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 ディベロッパーガイド」の「[Amazon Kinesis Data Streams API と AWS SDK for Java を使用したプロデューサーの開発](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`
次のコード例は、`put-records` を使用する方法を示しています。
**AWS CLI**
**複数のレコードをデータストリームに書き込むには**
次の `put-records` の例では、指定されたパーティションキーを使用してデータレコードを書き込み、1 回の呼び出しで別のパーティションキーを使用して別のデータレコードを書き込みます。
```
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 ディベロッパーガイド」の「[Amazon Kinesis Data Streams API と AWS SDK for Java を使用したプロデューサーの開発](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`
次のコード例は、`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 API リファレンス*」の「[RegisterStreamConsumer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/register-stream-consumer.html)」を参照してください。
### `remove-tags-from-stream`
次のコード例は、`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`
次のコード例は、`split-shard` を使用する方法を示しています。
**AWS CLI**
**シャードを分割するには**
次の `split-shard` の例では、新しい開始ハッシュキー 10 を使用して、指定されたシャードを 2 つの新しいシャードに分割します。
```
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`
次のコード例は、`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 Developer Guide*」の「[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`
次のコード例は、`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 Developer Guide*」の「[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`
次のコード例は、`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)」を参照してください。