Service object for interacting with AWS DynamoDBStreams service.
public struct DynamoDBStreams: AWSService
Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see Capturing Table Activity with DynamoDB Streams in the Amazon DynamoDB Developer Guide.
Initialize the DynamoDBStreams client
public init(client: AWSClient, region: SotoCore.Region? = nil, partition: AWSPartition = .aws, endpoint: String? = nil, timeout: TimeAmount? = nil, byteBufferAllocator: ByteBufferAllocator = ByteBufferAllocator(), options: AWSServiceConfig.Options = )
- client: AWSClient used to process requests
- region: Region of server you want to communicate with. This will override the partition parameter.
- partition: AWS partition where service resides, standard (.aws), china (.awscn), government (.awsusgov).
- endpoint: Custom endpoint URL to use instead of standard AWS servers
- timeout: Timeout value for HTTP requests
Initializer required by
AWSService.with(middlewares:timeout:byteBufferAllocator:options). You are not able to use this initializer directly as there are no public initializers for
AWSServiceConfig.Patch. Please use
public init(from: DynamoDBStreams, patch: AWSServiceConfig.Patch)
Client used for communication with AWS
let client: AWSClient
let config: AWSServiceConfig
public func describeStream(_ input: DescribeStreamInput, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<DescribeStreamOutput>
Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.
You can call
DescribeStream at a maximum rate of 10 times per second.
Each shard in the stream has a
SequenceNumberRange associated with it. If the
SequenceNumberRange has a
StartingSequenceNumber but no
EndingSequenceNumber, then the shard is still open (able to receive more stream records). If both
EndingSequenceNumber are present, then that shard is closed and can no longer receive more data.
public func getRecords(_ input: GetRecordsInput, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetRecordsOutput>
Retrieves the stream records from a given shard.
Specify a shard iterator using the
ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to,
GetRecords returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records.
GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first.
public func getShardIterator(_ input: GetShardIteratorInput, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<GetShardIteratorOutput>
Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent
GetRecords request to read the stream records from the shard.
A shard iterator expires 15 minutes after it is returned to the requester.
public func listStreams(_ input: ListStreamsInput, logger: Logger = AWSClient.loggingDisabled, on eventLoop: EventLoop? = nil) -> EventLoopFuture<ListStreamsOutput>
Returns an array of stream ARNs associated with the current account and endpoint. If the
TableName parameter is present, then
ListStreams will return only the streams ARNs for that table.
You can call
ListStreams at a maximum rate of 5 times per second.