@datafire/amazonaws_streams_dynamodb v5.0.0

@datafire/amazonaws_streams_dynamodb

Client library for Amazon DynamoDB Streams

Installation and Usage

npm install --save @datafire/amazonaws_streams_dynamodb

let amazonaws_streams_dynamodb = require('@datafire/amazonaws_streams_dynamodb').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_streams_dynamodb.DescribeStream({
  "StreamArn": ""
}).then(data => {
  console.log(data);
});

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.

Actions

DescribeStream

amazonaws_streams_dynamodb.DescribeStream({
  "StreamArn": ""
}, context)

Input

• input object
  • ExclusiveStartShardId ShardId
  • Limit PositiveIntegerObject
  • StreamArn required StreamArn

Output

• output DescribeStreamOutput

GetRecords

amazonaws_streams_dynamodb.GetRecords({
  "ShardIterator": ""
}, context)

Input

• input object
  • Limit PositiveIntegerObject
  • ShardIterator required ShardIterator

Output

• output GetRecordsOutput

GetShardIterator

amazonaws_streams_dynamodb.GetShardIterator({
  "StreamArn": "",
  "ShardId": "",
  "ShardIteratorType": ""
}, context)

Input

• input object
  • SequenceNumber SequenceNumber
  • ShardId required ShardId
  • ShardIteratorType required ShardIteratorType
  • StreamArn required StreamArn

Output

• output GetShardIteratorOutput

ListStreams

amazonaws_streams_dynamodb.ListStreams({}, context)

Input

• input object
  • ExclusiveStartStreamArn StreamArn
  • Limit PositiveIntegerObject
  • TableName TableName

Output

• output ListStreamsOutput

Definitions

AttributeMap

• AttributeMap array
  • items object
    • key AttributeName
    • value AttributeValue

AttributeName

• AttributeName string

AttributeValue

• AttributeValue object: Represents the data for an attribute. You can set one, and only one, of the elements. Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.
  • B BinaryAttributeValue
  • BOOL BooleanAttributeValue
  • BS BinarySetAttributeValue
  • L ListAttributeValue
  • M MapAttributeValue
  • N NumberAttributeValue
  • NS NumberSetAttributeValue
  • NULL NullAttributeValue
  • S StringAttributeValue
  • SS StringSetAttributeValue

BinaryAttributeValue

• BinaryAttributeValue string

BinarySetAttributeValue

• BinarySetAttributeValue array
  • items BinaryAttributeValue

BooleanAttributeValue

• BooleanAttributeValue boolean

Date

• Date string

DescribeStreamInput

• DescribeStreamInput object: Represents the input of a DescribeStream operation.
  • ExclusiveStartShardId ShardId
  • Limit PositiveIntegerObject
  • StreamArn required StreamArn

DescribeStreamOutput

• DescribeStreamOutput object: Represents the output of a DescribeStream operation.
  • StreamDescription StreamDescription

ErrorMessage

• ErrorMessage string

ExpiredIteratorException

• ExpiredIteratorException object: 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.
  • message ErrorMessage

GetRecordsInput

• GetRecordsInput object: Represents the input of a GetRecords operation.
  • Limit PositiveIntegerObject
  • ShardIterator required ShardIterator

GetRecordsOutput

• GetRecordsOutput object: Represents the output of a GetRecords operation.
  • NextShardIterator ShardIterator
  • Records RecordList

GetShardIteratorInput

• GetShardIteratorInput object: Represents the input of a GetShardIterator operation.
  • SequenceNumber SequenceNumber
  • ShardId required ShardId
  • ShardIteratorType required ShardIteratorType
  • StreamArn required StreamArn

GetShardIteratorOutput

• GetShardIteratorOutput object: Represents the output of a GetShardIterator operation.
  • ShardIterator ShardIterator

Identity

• Identity object: Contains details about the type of identity that made the request.
  • PrincipalId String
  • Type String

InternalServerError

• InternalServerError object: An error occurred on the server side.
  • message ErrorMessage

KeySchema

• KeySchema array
  • items KeySchemaElement

KeySchemaAttributeName

• KeySchemaAttributeName string

KeySchemaElement

• KeySchemaElement object: Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index. A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key (partition key) would be represented by one KeySchemaElement. A composite primary key (partition key and sort key) would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key. The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
  • AttributeName required KeySchemaAttributeName
  • KeyType required KeyType

KeyType

• KeyType string (values: HASH, RANGE)

LimitExceededException

• LimitExceededException object: 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.
  • message ErrorMessage

ListAttributeValue

• ListAttributeValue array
  • items AttributeValue

ListStreamsInput

• ListStreamsInput object: Represents the input of a ListStreams operation.
  • ExclusiveStartStreamArn StreamArn
  • Limit PositiveIntegerObject
  • TableName TableName

ListStreamsOutput

• ListStreamsOutput object: Represents the output of a ListStreams operation.
  • LastEvaluatedStreamArn StreamArn
  • Streams StreamList

MapAttributeValue

• MapAttributeValue array
  • items object
    • key AttributeName
    • value AttributeValue

NullAttributeValue

• NullAttributeValue boolean

NumberAttributeValue

• NumberAttributeValue string

NumberSetAttributeValue

• NumberSetAttributeValue array
  • items NumberAttributeValue

OperationType

• OperationType string (values: INSERT, MODIFY, REMOVE)

PositiveIntegerObject

• PositiveIntegerObject integer

PositiveLongObject

• PositiveLongObject integer

Record

• Record object: A description of a unique event within a stream.
  • awsRegion String
  • dynamodb StreamRecord
  • eventID String
  • eventName OperationType
  • eventSource String
  • eventVersion String
  • userIdentity Identity

RecordList

• RecordList array
  • items Record

ResourceNotFoundException

• ResourceNotFoundException object: The operation tried to access a nonexistent stream.
  • message ErrorMessage

SequenceNumber

• SequenceNumber string

SequenceNumberRange

• SequenceNumberRange object: The beginning and ending sequence numbers for the stream records contained within a shard.
  • EndingSequenceNumber SequenceNumber
  • StartingSequenceNumber SequenceNumber

Shard

• Shard object: A uniquely identified group of stream records within a stream.
  • ParentShardId ShardId
  • SequenceNumberRange SequenceNumberRange
  • ShardId ShardId

ShardDescriptionList

• ShardDescriptionList array
  • items Shard

ShardId

• ShardId string

ShardIterator

• ShardIterator string

ShardIteratorType

• ShardIteratorType string (values: TRIM_HORIZON, LATEST, AT_SEQUENCE_NUMBER, AFTER_SEQUENCE_NUMBER)

Stream

• Stream object: Represents all of the data describing a particular stream.
  • StreamArn StreamArn
  • StreamLabel String
  • TableName TableName

StreamArn

• StreamArn string

StreamDescription

• StreamDescription object: Represents all of the data describing a particular stream.
  • CreationRequestDateTime Date
  • KeySchema KeySchema
  • LastEvaluatedShardId ShardId
  • Shards ShardDescriptionList
  • StreamArn StreamArn
  • StreamLabel String
  • StreamStatus StreamStatus
  • StreamViewType StreamViewType
  • TableName TableName

StreamList

• StreamList array
  • items Stream

StreamRecord

• StreamRecord object: A description of a single data modification that was performed on an item in a DynamoDB table.
  • ApproximateCreationDateTime Date
  • Keys AttributeMap
  • NewImage AttributeMap
  • OldImage AttributeMap
  • SequenceNumber SequenceNumber
  • SizeBytes PositiveLongObject
  • StreamViewType StreamViewType

StreamStatus

• StreamStatus string (values: ENABLING, ENABLED, DISABLING, DISABLED)

StreamViewType

• StreamViewType string (values: NEW_IMAGE, OLD_IMAGE, NEW_AND_OLD_IMAGES, KEYS_ONLY)

String

• String string

StringAttributeValue

• StringAttributeValue string

StringSetAttributeValue

• StringSetAttributeValue array
  • items StringAttributeValue

TableName

• TableName string

TrimmedDataAccessException

• TrimmedDataAccessException object: 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: You request a shard iterator with a sequence number older than the trim point (24 hours). You obtain a shard iterator, but before you use the iterator in a GetRecords request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.
  • message ErrorMessage