dynamodbstreams/aws.sdk.kotlin.services.dynamodbstreams/DynamoDbStreamsClient

DynamoDbStreamsClient

interface DynamoDbStreamsClient : SdkClient

Amazon DynamoDB

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<DynamoDbStreamsClient.Config, DynamoDbStreamsClient.Config.Builder, DynamoDbStreamsClient>

Companion

object Companion : AbstractAwsSdkClientFactory<DynamoDbStreamsClient.Config, DynamoDbStreamsClient.Config.Builder, DynamoDbStreamsClient, DynamoDbStreamsClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: DynamoDbStreamsClient.Config

DynamoDbStreamsClient's configuration

Functions

describeStream

abstract suspend fun describeStream(input: DescribeStreamRequest): DescribeStreamResponse

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.

getRecords

abstract suspend fun getRecords(input: GetRecordsRequest): GetRecordsResponse

Retrieves the stream records from a given shard.

getShardIterator

abstract suspend fun getShardIterator(input: GetShardIteratorRequest): GetShardIteratorResponse

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.

listStreams

abstract suspend fun listStreams(input: ListStreamsRequest = ListStreamsRequest { }): ListStreamsResponse

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.

Inherited functions

expect abstract fun close()

describeStream

inline suspend fun DynamoDbStreamsClient.describeStream(crossinline block: DescribeStreamRequest.Builder.() -> Unit): DescribeStreamResponse

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.

getRecords

inline suspend fun DynamoDbStreamsClient.getRecords(crossinline block: GetRecordsRequest.Builder.() -> Unit): GetRecordsResponse

Retrieves the stream records from a given shard.

getShardIterator

inline suspend fun DynamoDbStreamsClient.getShardIterator(crossinline block: GetShardIteratorRequest.Builder.() -> Unit): GetShardIteratorResponse

listStreams

inline suspend fun DynamoDbStreamsClient.listStreams(crossinline block: ListStreamsRequest.Builder.() -> Unit): ListStreamsResponse

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.

withConfig

fun DynamoDbStreamsClient.withConfig(block: DynamoDbStreamsClient.Config.Builder.() -> Unit): DynamoDbStreamsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.