import { DynamoDBStreamsClient } from "./DynamoDBStreamsClient"; import { DescribeStreamInput } from "./types/DescribeStreamInput"; import { DescribeStreamOutput } from "./types/DescribeStreamOutput"; import { GetRecordsInput } from "./types/GetRecordsInput"; import { GetRecordsOutput } from "./types/GetRecordsOutput"; import { GetShardIteratorInput } from "./types/GetShardIteratorInput"; import { GetShardIteratorOutput } from "./types/GetShardIteratorOutput"; import { ListStreamsInput } from "./types/ListStreamsInput"; import { ListStreamsOutput } from "./types/ListStreamsOutput"; export declare class DynamoDBStreams extends DynamoDBStreamsClient { /** *

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 StartingSequenceNumber and EndingSequenceNumber are present, then that shard is closed and can no longer receive more data.

* * This operation may fail with one of the following errors: * - {ResourceNotFoundException}

The operation tried to access a nonexistent stream.

* - {InternalServerError}

An error occurred on the server side.

* - {Error} An error originating from the SDK or customizations rather than the service */ describeStream(args: DescribeStreamInput): Promise; describeStream(args: DescribeStreamInput, cb: (err: any, data?: DescribeStreamOutput) => void): void; /** *

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.

* * This operation may fail with one of the following errors: * - {ResourceNotFoundException}

The operation tried to access a nonexistent stream.

* - {LimitExceededException}

Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

* - {InternalServerError}

An error occurred on the server side.

* - {ExpiredIteratorException}

The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the GetShardIterator action.

* - {TrimmedDataAccessException}

The operation attempted to read past the oldest stream record in a shard.

In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:

* - {Error} An error originating from the SDK or customizations rather than the service */ getRecords(args: GetRecordsInput): Promise; getRecords(args: GetRecordsInput, cb: (err: any, data?: GetRecordsOutput) => void): void; /** *

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.

* * This operation may fail with one of the following errors: * - {ResourceNotFoundException}

The operation tried to access a nonexistent stream.

* - {InternalServerError}

An error occurred on the server side.

* - {TrimmedDataAccessException}

The operation attempted to read past the oldest stream record in a shard.

In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:

* - {Error} An error originating from the SDK or customizations rather than the service */ getShardIterator(args: GetShardIteratorInput): Promise; getShardIterator(args: GetShardIteratorInput, cb: (err: any, data?: GetShardIteratorOutput) => void): void; /** *

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.

* * This operation may fail with one of the following errors: * - {ResourceNotFoundException}

The operation tried to access a nonexistent stream.

* - {InternalServerError}

An error occurred on the server side.

* - {Error} An error originating from the SDK or customizations rather than the service */ listStreams(args: ListStreamsInput): Promise; listStreams(args: ListStreamsInput, cb: (err: any, data?: ListStreamsOutput) => void): void; }