paws.database (version 0.1.5)

dynamodbstreams: Amazon DynamoDB Streams

Description

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.

Usage

dynamodbstreams(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- dynamodbstreams(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

describe_stream	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
get_records	Retrieves the stream records from a given shard
get_shard_iterator	Returns a shard iterator

Examples

# NOT RUN {
# The following example describes a stream with a given stream ARN.
# }
# NOT RUN {
svc <- dynamodbstreams()
svc$describe_stream(
  StreamArn = "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:1..."
)
# }
# NOT RUN {
# }