DynamoDBStreamsClient Class

Member Function Documentation

DynamoDBStreamsClient::DynamoDBStreamsClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a DynamoDBStreamsClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

DynamoDBStreamsClient::DynamoDBStreamsClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads DynamoDBStreamsClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] DescribeStreamResponse *DynamoDBStreamsClient::describeStream(const DescribeStreamRequest &request)

Sends request to the DynamoDBStreamsClient service, and returns a pointer to an DescribeStreamResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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> <note><p>You can call <i>DescribeStream</i> at a maximum rate of 10 times per second.</p></note>

Each shard in the stream has a <code>SequenceNumberRange</code> associated with it. If the <code>SequenceNumberRange</code> has a <code>StartingSequenceNumber</code> but no <code>EndingSequenceNumber</code>, then the shard is still open (able to receive more stream records). If both <code>StartingSequenceNumber</code> and <code>EndingSequenceNumber</code> are present, the that shared is closed and can no longer receive more

[slot] GetRecordsResponse *DynamoDBStreamsClient::getRecords(const GetRecordsRequest &request)

Sends request to the DynamoDBStreamsClient service, and returns a pointer to an GetRecordsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the stream records from a given

shard>

Specify a shard iterator using the <code>ShardIterator</code> 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, <code>GetRecords</code> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream

records> <note><p><code>GetRecords</code> can retrieve a maximum of 1 MB of data or 2000 stream records, whichever comes

[slot] GetShardIteratorResponse *DynamoDBStreamsClient::getShardIterator(const GetShardIteratorRequest &request)

Sends request to the DynamoDBStreamsClient service, and returns a pointer to an GetShardIteratorResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>GetRecords</code> request to read the stream records from the

[slot] ListStreamsResponse *DynamoDBStreamsClient::listStreams(const ListStreamsRequest &request)

Sends request to the DynamoDBStreamsClient service, and returns a pointer to an ListStreamsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Returns an array of stream ARNs associated with the current account and endpoint. If the <code>TableName</code> parameter is present, then <i>ListStreams</i> will return only the streams ARNs for that