を使用した Kinesis の例 AWS CLI

データストリームにタグを追加するには

次の add-tags-to-stream の例では、キー samplekey と値 example を持つタグを指定されたストリームに割り当てます。

aws kinesis add-tags-to-stream \
    --stream-name samplestream \
    --tags samplekey=example

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

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

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

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

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

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

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

データストリームの保持期間を短縮するには

次のdecrease-stream-retention-period例では、サンプルストリームという名前のストリームの保持期間 (データレコードがストリームに追加されてからアクセス可能になる期間) を 48 時間に短縮します。

aws kinesis decrease-stream-retention-period \
    --stream-name samplestream \
    --retention-period-hours 48

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

詳細については、Amazon Kinesis Data Streams デベロッパーガイドのデータ保持期間の変更を参照してください。

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

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

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

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

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

データストリームコンシューマーの登録を解除するには

次の 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

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

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

aws kinesis describe-limits

出力:

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

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

データストリームコンシューマーを記述するには

次の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

データストリームの概要を記述するには

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

データストリームを記述するには

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

シャードレベルのメトリクスの拡張モニタリングを無効にするには

次の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

シャードレベルのメトリクスの拡張モニタリングを有効にするには

次の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

シャードからレコードを取得するには

次の 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 デベロッパーガイド」の「Word for Java APIで Kinesis Data Streams AWS SDK を使用するコンシューマーの開発」を参照してください。 Amazon Kinesis

シャードイテレータを取得するには

次の 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 デベロッパーガイド」の「Word for Java APIで Kinesis Data Streams AWS SDK を使用するコンシューマーの開発」を参照してください。 Amazon Kinesis

データストリームの保持期間を延長するには

次のincrease-stream-retention-period例では、指定されたストリームの保持期間 (データレコードがストリームに追加されてからアクセス可能になる時間) を 168 時間に延長します。

aws kinesis increase-stream-retention-period \
    --stream-name samplestream \
    --retention-period-hours 168

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

詳細については、Amazon Kinesis Data Streams デベロッパーガイドのデータ保持期間の変更を参照してください。

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

次の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 デベロッパーガイド」の「シャードの一覧表示」を参照してください。

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

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

aws kinesis list-streams

出力:

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

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

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

次の list-tags-for-stream の例では、指定されたデータストリームにアタッチされたタグを一覧表示します。

aws kinesis list-tags-for-stream \
    --stream-name samplestream

出力:

{
    "Tags": [
        {
            "Key": "samplekey",
            "Value": "example"
        }
    ],
    "HasMoreTags": false
}

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

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

次のmerge-shards例では、指定されたデータストリームで IDsshardId-000000000000 と shardId-000000000001 の 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 つのシャードのマージ」を参照してください。

データストリームにデータレコードを書き込むには

次の 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 with the AWS SDK for Java を使用したプロデューサーの開発」を参照してください。 Amazon Kinesis

複数のレコードをデータストリームに書き込むには

次の 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 with the AWS SDK for Java を使用したプロデューサーの開発」を参照してください。 Amazon Kinesis

データストリームコンシューマーを登録するには

次の 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

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

次のremove-tags-from-stream例では、指定されたキーを持つ タグを指定されたデータストリームから削除します。

aws kinesis remove-tags-from-stream \
    --stream-name samplestream \
    --tag-keys samplekey

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

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

シャードを分割するには

次の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

データストリーム暗号化を有効にするには

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

データストリームの暗号化を無効にするには

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

データストリームのシャード数を更新するには

次の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