AWS Doc SDK Examples
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
を使用した Kinesis の例 AWS CLI
次のコード例は、Kinesis AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には、完全なソースコードへのリンクが含まれています。ここでは、コンテキストでコードを設定および実行する方法の手順を確認できます。
トピック
アクション
次のコード例は、add-tags-to-stream
を使用する方法を示しています。
- AWS CLI
-
データストリームにタグを追加するには
次の
add-tags-to-stream
例では、キーsamplekey
と値を持つタグを指定されたストリームexample
に割り当てます。aws kinesis add-tags-to-stream \ --stream-name
samplestream
\ --tagssamplekey=example
このコマンドでは何も出力されません。
詳細については、「Amazon Kinesis Data Streams デベロッパーガイド」の「ストリームのタグ付け」を参照してください。 Amazon Kinesis
-
API 詳細については、AWS CLI 「 コマンドリファレンスAddTagsToStream
」の「」を参照してください。
-
次の例は、create-stream
を使用する方法を説明しています。
- AWS CLI
-
データストリームを作成するには
次の
create-stream
の例は、3 つのシャードを含む samplestream という名前のデータストリームを作成します。aws kinesis create-stream \ --stream-name
samplestream
\ --shard-count3
このコマンドでは何も出力されません。
詳細については、「Amazon Kinesis Data Streams ディベロッパーガイド」の「API を使用したストリームの作成」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスCreateStream
」の「」を参照してください。
-
次の例は、decrease-stream-retention-period
を使用する方法を説明しています。
- AWS CLI
-
データストリームの保持期間を短縮するには
次の
decrease-stream-retention-period
例では、サンプルストリームという名前のストリームの保持期間 (データレコードがストリームに追加されてからアクセス可能になる期間) を 48 時間に短縮します。aws kinesis decrease-stream-retention-period \ --stream-name
samplestream
\ --retention-period-hours48
このコマンドでは何も出力されません。
詳細については、Amazon Kinesis Data Streams デベロッパーガイド」の「データ保持期間の変更」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDecreaseStreamRetentionPeriod
」の「」を参照してください。
-
次の例は、delete-stream
を使用する方法を説明しています。
- AWS CLI
-
データストリームを削除するには
次の
delete-stream
の例は、指定されたデータストリームを削除します。aws kinesis delete-stream \ --stream-name
samplestream
このコマンドでは何も出力されません。
詳細については、「Amazon Kinesis Data Streams ディベロッパーガイド」の「ストリームを削除する」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeleteStream
」の「」を参照してください。
-
次のコード例は、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-nameKinesisConsumerApplication
このコマンドでは何も出力されません。
詳細については、「Amazon Kinesis Data Streams デベロッパーガイド」の「Kinesis Data Streams を使用した拡張ファンアウトによるコンシューマーAPIの開発」を参照してください。 Amazon Kinesis
-
API 詳細については、AWS CLI 「 コマンドリファレンスDeregisterStreamConsumer
」の「」を参照してください。
-
次のコード例は、describe-limits
を使用する方法を示しています。
- AWS CLI
-
シャード制限を記述するには
次の
describe-limits
例は、現在の AWS アカウントのシャード制限と使用状況を示しています。aws kinesis describe-limits
出力:
{ "ShardLimit": 500, "OpenShardCount": 29 }
詳細については、「Amazon Kinesis Data Streams デベロッパーガイド」の「ストリームの再シャーディング」を参照してください。 Amazon Kinesis
-
API 詳細については、AWS CLI 「 コマンドリファレンスDescribeLimits
」の「」を参照してください。
-
次のコード例は、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-nameKinesisConsumerApplication
出力:
{ "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 詳細については、AWS CLI 「 コマンドリファレンスDescribeStreamConsumer
」の「」を参照してください。
-
次の例は、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 詳細については、AWS CLI 「 コマンドリファレンスDescribeStreamSummary
」の「」を参照してください。
-
次の例は、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 詳細については、AWS CLI 「 コマンドリファレンスDescribeStream
」の「」を参照してください。
-
次の例は、disable-enhanced-monitoring
を使用する方法を説明しています。
- AWS CLI
-
シャードレベルのメトリクスの拡張モニタリングを無効にするには
次の
disable-enhanced-monitoring
例では、シャードレベルのメトリクスの拡張 Kinesis データストリームモニタリングを無効にします。aws kinesis disable-enhanced-monitoring \ --stream-name
samplestream
--shard-level-metricsALL
出力:
{ "StreamName": "samplestream", "CurrentShardLevelMetrics": [ "IncomingBytes", "OutgoingRecords", "IteratorAgeMilliseconds", "IncomingRecords", "ReadProvisionedThroughputExceeded", "WriteProvisionedThroughputExceeded", "OutgoingBytes" ], "DesiredShardLevelMetrics": [] }
詳細については、Amazon Kinesis Data Streams デベロッパーガイド」の「Amazon Kinesis Data Streams でのストリームのモニタリング」を参照してください。 Amazon Kinesis
-
API 詳細については、AWS CLI 「 コマンドリファレンスDisableEnhancedMonitoring
」の「」を参照してください。
-
次のコード例は、enable-enhanced-monitoring
を使用する方法を示しています。
- AWS CLI
-
シャードレベルのメトリクスの拡張モニタリングを有効にするには
次の
enable-enhanced-monitoring
例では、シャードレベルのメトリクスの拡張 Kinesis データストリームモニタリングを有効にします。aws kinesis enable-enhanced-monitoring \ --stream-name
samplestream
\ --shard-level-metricsALL
出力:
{ "StreamName": "samplestream", "CurrentShardLevelMetrics": [], "DesiredShardLevelMetrics": [ "IncomingBytes", "OutgoingRecords", "IteratorAgeMilliseconds", "IncomingRecords", "ReadProvisionedThroughputExceeded", "WriteProvisionedThroughputExceeded", "OutgoingBytes" ] }
詳細については、Amazon Kinesis Data Streams デベロッパーガイド」の「Amazon Kinesis Data Streams でのストリームのモニタリング」を参照してください。 Amazon Kinesis
-
API 詳細については、AWS CLI 「 コマンドリファレンスEnableEnhancedMonitoring
」の「」を参照してください。
-
次の例は、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 デベロッパーガイド」の「 for Java APIでの AWS SDK Kinesis Data Streams を使用したコンシューマーの開発」を参照してください。 Amazon Kinesis
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetRecords
」の「」を参照してください。
-
次の例は、get-shard-iterator
を使用する方法を説明しています。
- AWS CLI
-
シャードイテレータを取得するには
次の
get-shard-iterator
例ではAT_SEQUENCE_NUMBER
、シャードイテレータタイプを使用してシャードイテレータを生成し、指定されたシーケンス番号で示される位置からデータレコードの読み取りを正確に開始します。aws kinesis get-shard-iterator \ --stream-name
samplestream
\ --shard-idshardId-000000000001
\ --shard-iterator-typeLATEST
出力:
{ "ShardIterator": "AAAAAAAAAAFEvJjIYI+3jw/4aqgH9FifJ+n48XWTh/IFIsbILP6o5eDueD39NXNBfpZ10WL5K6ADXk8w+5H+Qhd9cFA9k268CPXCz/kebq1TGYI7Vy+lUkA9BuN3xvATxMBGxRY3zYK05gqgvaIRn94O8SqeEqwhigwZxNWxID3Ej7YYYcxQi8Q/fIrCjGAy/n2r5Z9G864YpWDfN9upNNQAR/iiOWKs" }
詳細については、「Amazon Kinesis Data Streams デベロッパーガイド」の「 for Java APIでの AWS SDK Kinesis Data Streams を使用したコンシューマーの開発」を参照してください。 Amazon Kinesis
-
API 詳細については、AWS CLI 「 コマンドリファレンスGetShardIterator
」の「」を参照してください。
-
次のコード例は、increase-stream-retention-period
を使用する方法を示しています。
- AWS CLI
-
データストリームの保持期間を延長するには
次の
increase-stream-retention-period
例では、指定されたストリームの保持期間 (データレコードがストリームに追加されてからアクセス可能になる時間) を 168 時間に延長します。aws kinesis increase-stream-retention-period \ --stream-name
samplestream
\ --retention-period-hours168
このコマンドでは何も出力されません。
詳細については、Amazon Kinesis Data Streams デベロッパーガイド」の「データ保持期間の変更」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスIncreaseStreamRetentionPeriod
」の「」を参照してください。
-
次の例は、list-shards
を使用する方法を説明しています。
- AWS CLI
-
データストリーム内のシャードを一覧表示するには
次の
list-shards
例では、指定されたストリーム内のすべてのシャードを一覧表示します。これは、ID がexclusive-start-shard-id
の指定された直後のシャードから始まりますshardId-000000000000
。aws kinesis list-shards \ --stream-name
samplestream
\ --exclusive-start-shard-idshardId-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 詳細については、AWS CLI 「 コマンドリファレンスListShards
」の「」を参照してください。
-
次のコード例は、list-streams
を使用する方法を示しています。
- AWS CLI
-
データストリームを一覧表示するには
次の
list-streams
の例は、現在のアカウントとリージョンのすべてのアクティブなデータストリームを一覧表示します。aws kinesis list-streams
出力:
{ "StreamNames": [ "samplestream", "samplestream1" ] }
詳細については、「Amazon Kinesis Data Streams ディベロッパーガイド」の「ストリームのリスト」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスListStreams
」の「」を参照してください。
-
次のコード例は、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 詳細については、AWS CLI 「 コマンドリファレンスListTagsForStream
」の「」を参照してください。
-
次のコード例は、merge-shards
を使用する方法を示しています。
- AWS CLI
-
シャードをマージするには
次の
merge-shards
例では、指定されたデータストリームで 2 つの隣接するシャードを IDs shardId-000000000000 と shardId-000000000001 にマージし、それらを 1 つのシャードに結合します。aws kinesis merge-shards \ --stream-name
samplestream
\ --shard-to-mergeshardId-000000000000
\ --adjacent-shard-to-mergeshardId-000000000001
このコマンドでは何も出力されません。
詳細については、「Amazon Kinesis Data Streams デベロッパーガイド」の「2 つのシャードのマージ」を参照してください。 Amazon Kinesis
-
API 詳細については、AWS CLI 「 コマンドリファレンスMergeShards
」の「」を参照してください。
-
次の例は、put-record
を使用する方法を説明しています。
- AWS CLI
-
データストリームにデータレコードを書き込むには
次の
put-record
の例は、指定されたパーティションキーを使用して、指定されたデータストリームに単一のデータレコードを書き込みます。aws kinesis put-record \ --stream-name
samplestream
\ --datasampledatarecord
\ --partition-keysamplepartitionkey
出力:
{ "ShardId": "shardId-000000000009", "SequenceNumber": "49600902273357540915989931256901506243878407835297513618", "EncryptionType": "KMS" }
詳細については、Amazon Kinesis Data Streams デベロッパーガイド」の「 for Java APIでの AWS SDK Amazon Kinesis Data Streams を使用したプロデューサーの開発」を参照してください。 Amazon Kinesis
-
API 詳細については、AWS CLI 「 コマンドリファレンスPutRecord
」の「」を参照してください。
-
次の例は、put-records
を使用する方法を説明しています。
- AWS CLI
-
データストリームに複数のレコードを書き込むには
次の
put-records
例では、指定されたパーティションキーを使用してデータレコードを書き込み、1 回の呼び出しで別のパーティションキーを使用して別のデータレコードを書き込みます。aws kinesis put-records \ --stream-name
samplestream
\ --recordsData=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 詳細については、AWS CLI 「 コマンドリファレンスPutRecords
」の「」を参照してください。
-
次の例は、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-nameKinesisConsumerApplication
出力:
{ "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 詳細については、AWS CLI 「 コマンドリファレンスRegisterStreamConsumer
」の「」を参照してください。
-
次の例は、remove-tags-from-stream
を使用する方法を説明しています。
- AWS CLI
-
データストリームからタグを削除するには
次の
remove-tags-from-stream
例では、指定されたキーを持つ タグを指定されたデータストリームから削除します。aws kinesis remove-tags-from-stream \ --stream-name
samplestream
\ --tag-keyssamplekey
このコマンドでは何も出力されません。
詳細については、「Amazon Kinesis Data Streams デベロッパーガイド」の「ストリームのタグ付けAmazon Kinesis」を参照してください。
-
API 詳細については、AWS CLI 「 コマンドリファレンスRemoveTagsFromStream
」の「」を参照してください。
-
次の例は、split-shard
を使用する方法を説明しています。
- AWS CLI
-
シャードを分割するには
次の
split-shard
例では、新しい開始ハッシュキー 10 を使用して、指定されたシャードを 2 つの新しいシャードに分割します。aws kinesis split-shard \ --stream-name
samplestream
\ --shard-to-splitshardId-000000000000
\ --new-starting-hash-key10
このコマンドでは何も出力されません。
詳細については、「Amazon Kinesis Data Streams デベロッパーガイド」の「シャードの分割」を参照してください。 Amazon Kinesis
-
API 詳細については、AWS CLI 「 コマンドリファレンスSplitShard
」の「」を参照してください。
-
次のコード例は、start-stream-encryption
を使用する方法を示しています。
- AWS CLI
-
データストリーム暗号化を有効にするには
次の
start-stream-encryption
例では、指定されたキーを使用して、指定された AWS KMSストリームのサーバー側の暗号化を有効にします。aws kinesis start-stream-encryption \ --encryption-type
KMS
\ --key-idarn:aws:kms:us-west-2:012345678912:key/a3c4a7cd-728b-45dd-b334-4d3eb496e452
\ --stream-namesamplestream
このコマンドでは何も出力されません。
詳細については、Amazon Kinesis Data Streams デベロッパーガイド」の「Amazon Kinesis Data Streams でのデータ保護」を参照してください。 Amazon Kinesis
-
API 詳細については、AWS CLI 「 コマンドリファレンスStartStreamEncryption
」の「」を参照してください。
-
次のコード例は、stop-stream-encryption
を使用する方法を示しています。
- AWS CLI
-
データストリームの暗号化を無効にするには
次の
stop-stream-encryption
例では、指定されたキーを使用して、指定された AWS KMSストリームのサーバー側の暗号化を無効にします。aws kinesis start-stream-encryption \ --encryption-type
KMS
\ --key-idarn:aws:kms:us-west-2:012345678912:key/a3c4a7cd-728b-45dd-b334-4d3eb496e452
\ --stream-namesamplestream
このコマンドでは何も出力されません。
詳細については、Amazon Kinesis Data Streams デベロッパーガイド」の「Amazon Kinesis Data Streams でのデータ保護」を参照してください。 Amazon Kinesis
-
API 詳細については、AWS CLI 「 コマンドリファレンスStopStreamEncryption
」の「」を参照してください。
-
次のコード例は、update-shard-count
を使用する方法を示しています。
- AWS CLI
-
データストリームのシャード数を更新するには
次の
update-shard-count
例では、指定されたデータストリームのシャード数を 6 に更新します。この例では、均一なスケーリングを使用して、同じサイズのシャードを作成します。aws kinesis update-shard-count \ --stream-name
samplestream
\ --scaling-typeUNIFORM_SCALING
\ --target-shard-count6
出力:
{ "StreamName": "samplestream", "CurrentShardCount": 3, "TargetShardCount": 6 }
詳細については、「Amazon Kinesis Data Streams デベロッパーガイド」の「ストリームの再シャーディング」を参照してください。 Amazon Kinesis
-
API 詳細については、AWS CLI 「 コマンドリファレンスUpdateShardCount
」の「」を参照してください。
-