使用 Tools for PowerShell V4 的 Kinesis 示例 - AWS Tools for PowerShell（版本 4）
操作

AWS Tools for PowerShell 版本 5（V5）已经发布！

要开始使用新版本的工具，请参阅《AWS Tools for PowerShell 用户指南（V5）》，特别是关于迁移到 V5 的主题。

使用 Tools for PowerShell V4 的 Kinesis 示例

以下代码示例演示了如何将 AWS Tools for PowerShell V4 与 Kinesis 结合使用，来执行操作和实现常见场景。

操作是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。

每个示例都包含一个指向完整源代码的链接，您可以从中找到有关如何在上下文中设置和运行代码的说明。

主题

操作

以下代码示例演示了如何使用 Get-KINRecord。

Tools for PowerShell V4

示例 1：此示例将展示如何从一条或多条记录中返回和提取数据。提供给 Get-KINRecord 的迭代器将确定要返回的记录的起始位置，在本例中，这些记录会被捕获到变量 $records 中。然后，可以通过对 $records 集合进行索引来访问每条记录。假设记录中的数据是 UTF-8 编码的文本，则最后一个命令显示如何从对象的 MemoryStream 中提取数据并将其作为文本返回到控制台。

$records
$records = Get-KINRecord -ShardIterator "AAAAAAAAAAGIc....9VnbiRNaP"

输出：

MillisBehindLatest NextShardIterator            Records
------------------ -----------------            -------
0                  AAAAAAAAAAERNIq...uDn11HuUs  {Key1, Key2}
$records.Records[0]

输出：

ApproximateArrivalTimestamp Data                   PartitionKey SequenceNumber
--------------------------- ----                   ------------ --------------
3/7/2016 5:14:33 PM         System.IO.MemoryStream Key1         4955986459776...931586
[Text.Encoding]::UTF8.GetString($records.Records[0].Data.ToArray())

输出：

test data from string

  • 有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet Reference (V4)》中的 GetRecords。

以下代码示例演示了如何使用 Get-KINShardIterator。

Tools for PowerShell V4

示例 1：返回指定分片和起始位置的分片迭代器。通过引用返回的流对象的分片集合，可以从 Get-KINStream cmdlet 的输出中获取分片标识符和序列号的详细信息。返回的迭代器可以与 Get-KINRecord cmdlet 搭配使用，用于在分片中提取数据记录。

Get-KINShardIterator -StreamName "mystream" -ShardId "shardId-000000000000" -ShardIteratorType AT_SEQUENCE_NUMBER -StartingSequenceNumber "495598645..."

输出：

AAAAAAAAAAGIc....9VnbiRNaP

  • 有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet Reference (V4)》中的 GetShardIterator。

以下代码示例演示了如何使用 Get-KINStream。

Tools for PowerShell V4

示例 1：返回指定流的详细信息。

Get-KINStream -StreamName "mystream"

输出：

HasMoreShards        : False
RetentionPeriodHours : 24
Shards               : {}
StreamARN            : arn:aws:kinesis:us-west-2:123456789012:stream/mystream
StreamName           : mystream
StreamStatus         : ACTIVE

  • 有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet Reference (V4)》中的 DescribeStream。

以下代码示例演示了如何使用 New-KINStream。

Tools for PowerShell V4

示例 1：创建新流。此 cmdlet 默认不返回任何输出，因此添加了 -PassThru 开关以返回提供给 -streamName 参数的值以供日后使用。

$streamName = New-KINStream -StreamName "mystream" -ShardCount 1 -PassThru

  • 有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet Reference (V4)》中的 CreateStream。

以下代码示例演示了如何使用 Remove-KINStream。

Tools for PowerShell V4

示例 1：删除指定的流。在命令执行之前，系统会提示您进行确认。要取消确认提示，请使用 -Force 开关。

Remove-KINStream -StreamName "mystream"

  • 有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet Reference (V4)》中的 DeleteStream。

以下代码示例演示了如何使用 Write-KINRecord。

Tools for PowerShell V4

示例 1：写入一条包含提供给 -Text 参数的字符串的记录。

Write-KINRecord -Text "test data from string" -StreamName "mystream" -PartitionKey "Key1"

示例 2：写入包含指定文件所包含数据的记录。该文件被视为字节序列，因此，如果它包含文本，则在将其与此 cmdlet 搭配使用之前，应使用任何必要的编码进行编写。

Write-KINRecord -FilePath "C:\TestData.txt" -StreamName "mystream" -PartitionKey "Key2"

  • 有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet Reference (V4)》中的 PutRecord。