Questa documentazione è valida AWS CLI solo per la versione 1. Per la documentazione relativa alla versione 2 di AWS CLI, consulta la Guida per l'utente della versione 2.
Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Esempi di Kinesis che utilizzano AWS CLI
I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface con Kinesis.
Le operazioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Mentre le azioni mostrano come richiamare le singole funzioni di servizio, puoi vedere le azioni nel loro contesto negli scenari correlati.
Ogni esempio include un collegamento al codice sorgente completo, in cui è possibile trovare istruzioni su come configurare ed eseguire il codice nel contesto.
Argomenti
Azioni
Il seguente esempio di codice mostra come utilizzareadd-tags-to-stream
.
- AWS CLI
-
Per aggiungere tag a un flusso di dati
L'
add-tags-to-stream
esempio seguente assegna un tag con la chiavesamplekey
e il valoreexample
allo stream specificato.aws kinesis add-tags-to-stream \ --stream-name
samplestream
\ --tagssamplekey=example
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Tagging Your Streams nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta AddTagsToStream
Command Reference.AWS CLI
-
Il seguente esempio di codice mostra come utilizzarecreate-stream
.
- AWS CLI
-
Per creare un flusso di dati
L'
create-stream
esempio seguente crea un flusso di dati denominato samplestream con 3 shard.aws kinesis create-stream \ --stream-name
samplestream
\ --shard-count3
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Creating a Stream nella Amazon Kinesis Data Streams Developer Guide.
-
Per API i dettagli, consulta AWS CLI Command CreateStream
Reference.
-
Il seguente esempio di codice mostra come utilizzaredecrease-stream-retention-period
.
- AWS CLI
-
Per ridurre il periodo di conservazione del flusso di dati
L'
decrease-stream-retention-period
esempio seguente riduce il periodo di conservazione (il periodo di tempo in cui i record di dati sono accessibili dopo essere stati aggiunti allo stream) di uno stream denominato samplestream a 48 ore.aws kinesis decrease-stream-retention-period \ --stream-name
samplestream
\ --retention-period-hours48
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Modifica del periodo di conservazione dei dati nella Amazon Kinesis Data Streams Developer Guide.
-
Per API i dettagli, consulta AWS CLI Command DecreaseStreamRetentionPeriod
Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-stream
.
- AWS CLI
-
Per eliminare un flusso di dati
L'
delete-stream
esempio seguente elimina il flusso di dati specificato.aws kinesis delete-stream \ --stream-name
samplestream
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Eliminazione di uno stream nella Amazon Kinesis Data Streams Developer Guide.
-
Per API i dettagli, consulta Command DeleteStream
Reference AWS CLI .
-
Il seguente esempio di codice mostra come utilizzarederegister-stream-consumer
.
- AWS CLI
-
Per annullare la registrazione di un consumatore di flussi di dati
L'
deregister-stream-consumer
esempio seguente annulla la registrazione del consumatore specificato dal flusso di dati specificato.aws kinesis deregister-stream-consumer \ --stream-arn
arn:aws:kinesis:us-west-2:123456789012:stream/samplestream
\ --consumer-nameKinesisConsumerApplication
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Developing Consumer with Enhanced Fan-Out Using the Kinesis Data Streams nella Amazon Kinesis Data API Streams Developer Guide.
-
Per i API dettagli, consulta Command Reference. DeregisterStreamConsumer
AWS CLI
-
Il seguente esempio di codice mostra come utilizzaredescribe-limits
.
- AWS CLI
-
Per descrivere i limiti degli shard
L'
describe-limits
esempio seguente mostra i limiti e l'utilizzo degli shard per l'account corrente AWS .aws kinesis describe-limits
Output:
{ "ShardLimit": 500, "OpenShardCount": 29 }
Per ulteriori informazioni, consulta Resharding a Stream nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta DescribeLimits
Command Reference.AWS CLI
-
Il seguente esempio di codice mostra come utilizzaredescribe-stream-consumer
.
- AWS CLI
-
Per descrivere un consumatore di flussi di dati
L'
describe-stream-consumer
esempio seguente restituisce la descrizione del consumatore specificato, registrato con il flusso di dati specificato.aws kinesis describe-stream-consumer \ --stream-arn
arn:aws:kinesis:us-west-2:012345678912:stream/samplestream
\ --consumer-nameKinesisConsumerApplication
Output:
{ "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" } }
Per ulteriori informazioni, consulta la sezione Lettura dei dati da Amazon Kinesis Data Streams nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta DescribeStreamConsumer
Command Reference.AWS CLI
-
Il seguente esempio di codice mostra come utilizzaredescribe-stream-summary
.
- AWS CLI
-
Per descrivere un riepilogo del flusso di dati
L'
describe-stream-summary
esempio seguente fornisce una descrizione riepilogativa (senza l'elenco degli shard) del flusso di dati specificato.aws kinesis describe-stream-summary \ --stream-name
samplestream
Output:
{ "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 } }
Per ulteriori informazioni, consulta Creating and Managing Streams nella Amazon Kinesis Data Streams Developer Guide.
-
Per API i dettagli, consulta Command DescribeStreamSummary
Reference AWS CLI .
-
Il seguente esempio di codice mostra come utilizzaredescribe-stream
.
- AWS CLI
-
Per descrivere un flusso di dati
L'
describe-stream
esempio seguente restituisce i dettagli del flusso di dati specificato.aws kinesis describe-stream \ --stream-name
samplestream
Output:
{ "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 } }
Per ulteriori informazioni, consulta Creating and Managing Streams nella Amazon Kinesis Data Streams Developer Guide.
-
Per API i dettagli, consulta Command DescribeStream
Reference AWS CLI .
-
Il seguente esempio di codice mostra come utilizzaredisable-enhanced-monitoring
.
- AWS CLI
-
Per disabilitare il monitoraggio avanzato per le metriche a livello di shard
L'
disable-enhanced-monitoring
esempio seguente disabilita il monitoraggio avanzato del flusso di dati Kinesis per le metriche a livello di shard.aws kinesis disable-enhanced-monitoring \ --stream-name
samplestream
--shard-level-metricsALL
Output:
{ "StreamName": "samplestream", "CurrentShardLevelMetrics": [ "IncomingBytes", "OutgoingRecords", "IteratorAgeMilliseconds", "IncomingRecords", "ReadProvisionedThroughputExceeded", "WriteProvisionedThroughputExceeded", "OutgoingBytes" ], "DesiredShardLevelMetrics": [] }
Per ulteriori informazioni, consulta Monitoring Streams in Amazon Kinesis Data Streams nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta Command Reference. DisableEnhancedMonitoring
AWS CLI
-
Il seguente esempio di codice mostra come utilizzareenable-enhanced-monitoring
.
- AWS CLI
-
Per abilitare il monitoraggio avanzato delle metriche a livello di shard
L'
enable-enhanced-monitoring
esempio seguente abilita il monitoraggio avanzato del flusso di dati Kinesis per le metriche a livello di shard.aws kinesis enable-enhanced-monitoring \ --stream-name
samplestream
\ --shard-level-metricsALL
Output:
{ "StreamName": "samplestream", "CurrentShardLevelMetrics": [], "DesiredShardLevelMetrics": [ "IncomingBytes", "OutgoingRecords", "IteratorAgeMilliseconds", "IncomingRecords", "ReadProvisionedThroughputExceeded", "WriteProvisionedThroughputExceeded", "OutgoingBytes" ] }
Per ulteriori informazioni, consulta Monitoring Streams in Amazon Kinesis Data Streams nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta Command Reference. EnableEnhancedMonitoring
AWS CLI
-
Il seguente esempio di codice mostra come utilizzareget-records
.
- AWS CLI
-
Per ottenere record da un frammento
L'
get-records
esempio seguente ottiene i record di dati dallo shard di un flusso di dati Kinesis utilizzando l'iteratore shard specificato.aws kinesis get-records \ --shard-iterator
AAAAAAAAAAF7/0mWD7IuHj1yGv/TKuNgx2ukD5xipCY4cy4gU96orWwZwcSXh3K9tAmGYeOZyLZrvzzeOFVf9iN99hUPw/w/b0YWYeehfNvnf1DYt5XpDJghLKr3DzgznkTmMymDP3R+3wRKeuEw6/kdxY2yKJH0veaiekaVc4N2VwK/GvaGP2Hh9Fg7N++q0Adg6fIDQPt4p8RpavDbk+A4sL9SWGE1
Output:
{ "Records": [], "MillisBehindLatest": 80742000 }
Per ulteriori informazioni, consulta Developing Consumer Using the Kinesis API Data Streams AWS SDK with the for Java nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta GetRecords
Command Reference.AWS CLI
-
Il seguente esempio di codice mostra come utilizzareget-shard-iterator
.
- AWS CLI
-
Per ottenere un iteratore shard
L'
get-shard-iterator
esempio seguente utilizza il tipoAT_SEQUENCE_NUMBER
shard iterator e genera un iteratore shard per iniziare a leggere i record di dati esattamente dalla posizione indicata dal numero di sequenza specificato.aws kinesis get-shard-iterator \ --stream-name
samplestream
\ --shard-idshardId-000000000001
\ --shard-iterator-typeLATEST
Output:
{ "ShardIterator": "AAAAAAAAAAFEvJjIYI+3jw/4aqgH9FifJ+n48XWTh/IFIsbILP6o5eDueD39NXNBfpZ10WL5K6ADXk8w+5H+Qhd9cFA9k268CPXCz/kebq1TGYI7Vy+lUkA9BuN3xvATxMBGxRY3zYK05gqgvaIRn94O8SqeEqwhigwZxNWxID3Ej7YYYcxQi8Q/fIrCjGAy/n2r5Z9G864YpWDfN9upNNQAR/iiOWKs" }
Per ulteriori informazioni, consulta Developing Consumer Using the Kinesis API Data Streams AWS SDK with the for Java nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta GetShardIterator
Command Reference.AWS CLI
-
Il seguente esempio di codice mostra come utilizzareincrease-stream-retention-period
.
- AWS CLI
-
Per aumentare il periodo di conservazione del flusso di dati
L'
increase-stream-retention-period
esempio seguente aumenta il periodo di conservazione (il periodo di tempo in cui i record di dati sono accessibili dopo essere stati aggiunti allo stream) del flusso specificato a 168 ore.aws kinesis increase-stream-retention-period \ --stream-name
samplestream
\ --retention-period-hours168
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Modifica del periodo di conservazione dei dati nella Amazon Kinesis Data Streams Developer Guide.
-
Per API i dettagli, consulta AWS CLI Command IncreaseStreamRetentionPeriod
Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-shards
.
- AWS CLI
-
Per elencare gli shard in un flusso di dati
L'
list-shards
esempio seguente elenca tutti gli shard nello stream specificato a partire dallo shard il cui ID segue immediatamente quello specificato di.exclusive-start-shard-id
shardId-000000000000
aws kinesis list-shards \ --stream-name
samplestream
\ --exclusive-start-shard-idshardId-000000000000
Output:
{ "Shards": [ { "ShardId": "shardId-000000000001", "HashKeyRange": { "StartingHashKey": "113427455640312821154458202477256070485", "EndingHashKey": "226854911280625642308916404954512140969" }, "SequenceNumberRange": { "StartingSequenceNumber": "49600871682979337187563555549332609155523708941634633746" } }, { "ShardId": "shardId-000000000002", "HashKeyRange": { "StartingHashKey": "226854911280625642308916404954512140970", "EndingHashKey": "340282366920938463463374607431768211455" }, "SequenceNumberRange": { "StartingSequenceNumber": "49600871683001637932762086172474144873796357303140614178" } } ] }
Per ulteriori informazioni, consulta Listing Shards nella Amazon Kinesis Data Streams Developer Guide.
-
Per API i dettagli, consulta Command ListShards
Reference AWS CLI .
-
Il seguente esempio di codice mostra come utilizzarelist-streams
.
- AWS CLI
-
Per elencare i flussi di dati
L'
list-streams
esempio seguente elenca tutti i flussi di dati attivi nell'account e nella regione correnti.aws kinesis list-streams
Output:
{ "StreamNames": [ "samplestream", "samplestream1" ] }
Per ulteriori informazioni, consulta Listing Streams nella Amazon Kinesis Data Streams Developer Guide.
-
Per API i dettagli, consulta Command ListStreams
Reference AWS CLI .
-
Il seguente esempio di codice mostra come utilizzarelist-tags-for-stream
.
- AWS CLI
-
Per elencare i tag per un flusso di dati
L'
list-tags-for-stream
esempio seguente elenca i tag allegati al flusso di dati specificato.aws kinesis list-tags-for-stream \ --stream-name
samplestream
Output:
{ "Tags": [ { "Key": "samplekey", "Value": "example" } ], "HasMoreTags": false }
Per ulteriori informazioni, consulta Tagging Your Streams nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta ListTagsForStream
Command Reference.AWS CLI
-
Il seguente esempio di codice mostra come utilizzaremerge-shards
.
- AWS CLI
-
Per unire frammenti
L'
merge-shards
esempio seguente unisce due shard adiacenti con shardId -000000000000 e shardId -000000000001 nel flusso IDs di dati specificato e li combina in un unico shard.aws kinesis merge-shards \ --stream-name
samplestream
\ --shard-to-mergeshardId-000000000000
\ --adjacent-shard-to-mergeshardId-000000000001
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Merging Two Shards nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta MergeShards
Command Reference.AWS CLI
-
Il seguente esempio di codice mostra come utilizzareput-record
.
- AWS CLI
-
Per scrivere un record in un flusso di dati
L'
put-record
esempio seguente scrive un singolo record di dati nel flusso di dati specificato utilizzando la chiave di partizione specificata.aws kinesis put-record \ --stream-name
samplestream
\ --datasampledatarecord
\ --partition-keysamplepartitionkey
Output:
{ "ShardId": "shardId-000000000009", "SequenceNumber": "49600902273357540915989931256901506243878407835297513618", "EncryptionType": "KMS" }
Per ulteriori informazioni, consulta Developing Producers Using the Amazon Kinesis API Data Streams AWS SDK with the for Java nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta PutRecord
Command Reference.AWS CLI
-
Il seguente esempio di codice mostra come utilizzareput-records
.
- AWS CLI
-
Per scrivere più record in un flusso di dati
L'
put-records
esempio seguente scrive un record di dati utilizzando la chiave di partizione specificata e un altro record di dati utilizzando una chiave di partizione diversa in una singola chiamata.aws kinesis put-records \ --stream-name
samplestream
\ --recordsData=blob1,PartitionKey=partitionkey1
Data=blob2,PartitionKey=partitionkey2
Output:
{ "FailedRecordCount": 0, "Records": [ { "SequenceNumber": "49600883331171471519674795588238531498465399900093808706", "ShardId": "shardId-000000000004" }, { "SequenceNumber": "49600902273357540915989931256902715169698037101720764562", "ShardId": "shardId-000000000009" } ], "EncryptionType": "KMS" }
Per ulteriori informazioni, consulta Developing Producers Using the Amazon Kinesis API Data Streams AWS SDK with the for Java nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta PutRecords
Command Reference.AWS CLI
-
Il seguente esempio di codice mostra come utilizzareregister-stream-consumer
.
- AWS CLI
-
Per registrare un consumatore di flussi di dati
L'
register-stream-consumer
esempio seguente registra un consumatore chiamatoKinesisConsumerApplication
con il flusso di dati specificato.aws kinesis register-stream-consumer \ --stream-arn
arn:aws:kinesis:us-west-2:012345678912:stream/samplestream
\ --consumer-nameKinesisConsumerApplication
Output:
{ "Consumer": { "ConsumerName": "KinesisConsumerApplication", "ConsumerARN": "arn:aws:kinesis:us-west-2: 123456789012:stream/samplestream/consumer/KinesisConsumerApplication:1572383852", "ConsumerStatus": "CREATING", "ConsumerCreationTimestamp": 1572383852.0 } }
Per ulteriori informazioni, consulta Developing Consumer with Enhanced Fan-Out Using the Kinesis Data Streams nella Amazon Kinesis Data API Streams Developer Guide.
-
Per i API dettagli, consulta Command Reference. RegisterStreamConsumer
AWS CLI
-
Il seguente esempio di codice mostra come utilizzareremove-tags-from-stream
.
- AWS CLI
-
Per rimuovere i tag da un flusso di dati
L'
remove-tags-from-stream
esempio seguente rimuove il tag con la chiave specificata dal flusso di dati specificato.aws kinesis remove-tags-from-stream \ --stream-name
samplestream
\ --tag-keyssamplekey
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Tagging Your Streams nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta RemoveTagsFromStream
Command Reference.AWS CLI
-
Il seguente esempio di codice mostra come utilizzaresplit-shard
.
- AWS CLI
-
Per dividere i frammenti
L'
split-shard
esempio seguente divide lo shard specificato in due nuovi shard utilizzando una nuova chiave hash iniziale pari a 10.aws kinesis split-shard \ --stream-name
samplestream
\ --shard-to-splitshardId-000000000000
\ --new-starting-hash-key10
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Splitting a Shard nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta SplitShard
Command Reference.AWS CLI
-
Il seguente esempio di codice mostra come utilizzarestart-stream-encryption
.
- AWS CLI
-
Per abilitare la crittografia del flusso di dati
L'
start-stream-encryption
esempio seguente abilita la crittografia lato server per il flusso specificato, utilizzando la chiave specificata 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
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta la sezione Protezione dei dati in Amazon Kinesis Data Streams nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta StartStreamEncryption
Command Reference.AWS CLI
-
Il seguente esempio di codice mostra come utilizzarestop-stream-encryption
.
- AWS CLI
-
Per disabilitare la crittografia del flusso di dati
L'
stop-stream-encryption
esempio seguente disattiva la crittografia lato server per il flusso specificato, utilizzando la chiave specificata. AWS KMSaws kinesis start-stream-encryption \ --encryption-type
KMS
\ --key-idarn:aws:kms:us-west-2:012345678912:key/a3c4a7cd-728b-45dd-b334-4d3eb496e452
\ --stream-namesamplestream
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta la sezione Protezione dei dati in Amazon Kinesis Data Streams nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta StopStreamEncryption
Command Reference.AWS CLI
-
Il seguente esempio di codice mostra come utilizzareupdate-shard-count
.
- AWS CLI
-
Per aggiornare il conteggio degli shard in un flusso di dati
L'
update-shard-count
esempio seguente aggiorna il conteggio degli shard del flusso di dati specificato a 6. Questo esempio utilizza un ridimensionamento uniforme, che crea frammenti di dimensioni uguali.aws kinesis update-shard-count \ --stream-name
samplestream
\ --scaling-typeUNIFORM_SCALING
\ --target-shard-count6
Output:
{ "StreamName": "samplestream", "CurrentShardCount": 3, "TargetShardCount": 6 }
Per ulteriori informazioni, consulta Resharding a Stream nella Amazon Kinesis Data Streams Developer Guide.
-
Per i API dettagli, consulta UpdateShardCount
Command Reference.AWS CLI
-