View a markdown version of this page

使用适用于 V4 的工具的 Kinesis 示例 PowerShell - Amazon Tools for PowerShell (版本 4)
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

Amazon Tools for PowerShell V4 的支持已到期。

我们建议您迁移到 Amazon Tools for PowerShell V5 。有关如何迁移的更多详细信息和信息,请参阅我们的终止支持公告

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

使用适用于 V4 的工具的 Kinesis 示例 PowerShell

以下代码示例向您展示了如何使用带有 Kinesis 的 Amazon Tools for PowerShell V4 来执行操作和实现常见场景。

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

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

主题

操作

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

适用于 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 的详细信息,请参阅 Amazon Tools for PowerShell Cmdlet 参考 (V 4) GetRecords中的。

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

适用于 PowerShell V4 的工具

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

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

输出

AAAAAAAAAAGIc....9VnbiRNaP
  • 有关 API 的详细信息,请参阅 Amazon Tools for PowerShell Cmdlet 参考 (V 4) GetShardIterator中的。

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

适用于 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 的详细信息,请参阅 Amazon Tools for PowerShell Cmdlet 参考 (V 4) DescribeStream中的。

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

适用于 PowerShell V4 的工具

示例 1:创建新流。默认情况下,此 cmdlet 不返回任何输出,因此添加-PassThru 开关以返回提供给-StreamName 参数的值以供日后使用。

$streamName = New-KINStream -StreamName "mystream" -ShardCount 1 -PassThru
  • 有关 API 的详细信息,请参阅 Amazon Tools for PowerShell Cmdlet 参考 (V 4) CreateStream中的。

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

适用于 PowerShell V4 的工具

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

Remove-KINStream -StreamName "mystream"
  • 有关 API 的详细信息,请参阅 Amazon Tools for PowerShell Cmdlet 参考 (V 4) DeleteStream中的。

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

适用于 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 的详细信息,请参阅 Amazon Tools for PowerShell Cmdlet 参考 (V 4) PutRecord中的。