を使用した Kinesis の例 AWS CLI - AWS SDK コード例

Doc AWS SDK Examples リポジトリには、他にも SDK の例があります。 AWS GitHub

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

を使用した Kinesis の例 AWS CLI

次のコード例は、Kinesis AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、関連するシナリオやサービス間の例ではアクションのコンテキストが確認できます。

「シナリオ」は、同じサービス内で複数の関数を呼び出して、特定のタスクを実行する方法を示すコード例です。

各例には、 へのリンクが含まれています。このリンクには GitHub、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

トピック

アクション

次の例は、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 デベロッパーガイド」の「ストリームにタグを付ける」を参照してください。 Amazon Kinesis

  • API の詳細については、「 コマンドリファレンスAddTagsToStream」の「」を参照してください。 AWS CLI

次の例は、create-stream を使用する方法を説明しています。

AWS CLI

データストリームを作成するには

次の create-stream の例は、3 つのシャードを含む samplestream という名前のデータストリームを作成します。

aws kinesis create-stream \ --stream-name samplestream \ --shard-count 3

このコマンドでは何も出力されません。

詳細については、「Amazon Kinesis Data Streams ディベロッパーガイド」の「API を使用したストリームの作成」を参照してください。

  • API の詳細については、「 コマンドリファレンスCreateStream」の「」を参照してください。 AWS CLI

次の例は、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 デベロッパーガイド」の「データ保持期間の変更」を参照してください。

  • API の詳細については、「 コマンドリファレンスDecreaseStreamRetentionPeriod」の「」を参照してください。 AWS CLI

次の例は、delete-stream を使用する方法を説明しています。

AWS CLI

データストリームを削除するには

次の delete-stream の例は、指定されたデータストリームを削除します。

aws kinesis delete-stream \ --stream-name samplestream

このコマンドでは何も出力されません。

詳細については、「Amazon Kinesis Data Streams ディベロッパーガイド」の「ストリームを削除する」を参照してください。

  • API の詳細については、「 コマンドリファレンスDeleteStream」の「」を参照してください。 AWS CLI

次の例は、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 を使用した拡張ファンアウトによるコンシューマーの開発Amazon Kinesis」を参照してください。

  • API の詳細については、「 コマンドリファレンスDeregisterStreamConsumer」の「」を参照してください。 AWS CLI

次の例は、describe-limits を使用する方法を説明しています。

AWS CLI

シャード制限を記述するには

次のdescribe-limits例では、現在の AWS アカウントのシャード制限と使用量を表示します。

aws kinesis describe-limits

出力:

{ "ShardLimit": 500, "OpenShardCount": 29 }

詳細については、「Amazon Kinesis Data Streams デベロッパーガイド」の「ストリームのリシャーディングAmazon Kinesis」を参照してください。

  • API の詳細については、「 コマンドリファレンスDescribeLimits」の「」を参照してください。 AWS CLI

次の例は、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 からのデータの読み取り」を参照してください。 Amazon Kinesis

  • API の詳細については、「 コマンドリファレンスDescribeStreamConsumer」の「」を参照してください。 AWS CLI

次の例は、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 ディベロッパーガイド」の「ストリームの作成と管理」を参照してください。

  • API の詳細については、「 コマンドリファレンスDescribeStreamSummary」の「」を参照してください。 AWS CLI

次の例は、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 ディベロッパーガイド」の「ストリームの作成と管理」を参照してください。

  • API の詳細については、「 コマンドリファレンスDescribeStream」の「」を参照してください。 AWS CLI

次の例は、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 でのストリームのモニタリング Amazon Kinesis」を参照してください。

  • API の詳細については、「 コマンドリファレンスDisableEnhancedMonitoring」の「」を参照してください。 AWS CLI

次の例は、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 でのストリームのモニタリング Amazon Kinesis」を参照してください。

  • API の詳細については、「 コマンドリファレンスEnableEnhancedMonitoring」の「」を参照してください。 AWS CLI

次の例は、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 を使用したコンシューマーの開発」を参照してください。 Amazon Kinesis

  • API の詳細については、「 コマンドリファレンスGetRecords」の「」を参照してください。 AWS CLI

次の例は、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 を使用したコンシューマーの開発」を参照してください。 Amazon Kinesis

  • API の詳細については、「 コマンドリファレンスGetShardIterator」の「」を参照してください。 AWS CLI

次の例は、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 デベロッパーガイド」の「データ保持期間の変更」を参照してください。

  • API の詳細については、「 コマンドリファレンスIncreaseStreamRetentionPeriod」の「」を参照してください。 AWS CLI

次の例は、list-shards を使用する方法を説明しています。

AWS CLI

データストリーム内のシャードを一覧表示するには

次のlist-shards例では、 の指定された の直後に ID を持つシャードで始まる、指定されたストリーム内のすべてのシャードを一覧表示しますexclusive-start-shard-idshardId-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 デベロッパーガイド」の「シャードの一覧表示 Amazon Kinesis」を参照してください。

  • API の詳細については、「 コマンドリファレンスListShards」の「」を参照してください。 AWS CLI

次の例は、list-streams を使用する方法を説明しています。

AWS CLI

データストリームを一覧表示するには

次の list-streams の例は、現在のアカウントとリージョンのすべてのアクティブなデータストリームを一覧表示します。

aws kinesis list-streams

出力:

{ "StreamNames": [ "samplestream", "samplestream1" ] }

詳細については、「Amazon Kinesis Data Streams ディベロッパーガイド」の「ストリームのリスト」を参照してください。

  • API の詳細については、「 コマンドリファレンスListStreams」の「」を参照してください。 AWS CLI

次の例は、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 デベロッパーガイド」の「ストリームにタグを付ける」を参照してください。 Amazon Kinesis

  • API の詳細については、「 コマンドリファレンスListTagsForStream」の「」を参照してください。 AWS CLI

次の例は、merge-shards を使用する方法を説明しています。

AWS CLI

シャードをマージするには

次のmerge-shards例では、指定されたデータストリーム内の shardId-000000000000000000000000000shardId-000000000001の IDs を持つ 2 つの隣接するシャードをマージし、それらを 1 つのシャードに結合します。

aws kinesis merge-shards \ --stream-name samplestream \ --shard-to-merge shardId-000000000000 \ --adjacent-shard-to-merge shardId-000000000001

このコマンドでは何も出力されません。

詳細については、「Amazon Kinesis Data Streams デベロッパーガイド」の「2 つのシャードのマージ」を参照してください。 Amazon Kinesis

  • API の詳細については、「 コマンドリファレンスMergeShards」の「」を参照してください。 AWS CLI

次の例は、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 Amazon Kinesis Data Streams デベロッパーガイドの「Developing Producers Using the Amazon Kinesis Data Streams API with the AWS SDK for Java」を参照してください。 Amazon Kinesis

  • API の詳細については、「 コマンドリファレンスPutRecord」の「」を参照してください。 AWS CLI

次の例は、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 を使用したプロデューサーの開発」を参照してください。 Amazon Kinesis

  • API の詳細については、「 コマンドリファレンスPutRecords」の「」を参照してください。 AWS CLI

次の例は、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 を使用した拡張ファンアウトによるコンシューマーの開発Amazon Kinesis」を参照してください。

  • API の詳細については、「 コマンドリファレンスRegisterStreamConsumer」の「」を参照してください。 AWS CLI

次の例は、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 デベロッパーガイド」の「ストリームにタグを付ける」を参照してください。 Amazon Kinesis

  • API の詳細については、「 コマンドリファレンスRemoveTagsFromStream」の「」を参照してください。 AWS CLI

次の例は、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 デベロッパーガイド」の「シャードの分割」を参照してください。 Amazon Kinesis

  • API の詳細については、「 コマンドリファレンスSplitShard」の「」を参照してください。 AWS CLI

次の例は、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 でのデータ保護」を参照してください。

  • API の詳細については、「 コマンドリファレンスStartStreamEncryption」の「」を参照してください。 AWS CLI

次の例は、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 でのデータ保護」を参照してください。

  • API の詳細については、「 コマンドリファレンスStopStreamEncryption」の「」を参照してください。 AWS CLI

次の例は、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 デベロッパーガイド」の「ストリームのリシャーディングAmazon Kinesis」を参照してください。

  • API の詳細については、「 コマンドリファレンスUpdateShardCount」の「」を参照してください。 AWS CLI