Documentation ¶
Overview ¶
Package dynamodbstreams provides a client for Amazon DynamoDB Streams.
Index ¶
- Constants
- type DescribeStreamInput
- type DescribeStreamOutput
- type DynamoDBStreams
- func (c *DynamoDBStreams) DescribeStream(input *DescribeStreamInput) (*DescribeStreamOutput, error)
- func (c *DynamoDBStreams) DescribeStreamRequest(input *DescribeStreamInput) (req *request.Request, output *DescribeStreamOutput)
- func (c *DynamoDBStreams) GetRecords(input *GetRecordsInput) (*GetRecordsOutput, error)
- func (c *DynamoDBStreams) GetRecordsRequest(input *GetRecordsInput) (req *request.Request, output *GetRecordsOutput)
- func (c *DynamoDBStreams) GetShardIterator(input *GetShardIteratorInput) (*GetShardIteratorOutput, error)
- func (c *DynamoDBStreams) GetShardIteratorRequest(input *GetShardIteratorInput) (req *request.Request, output *GetShardIteratorOutput)
- func (c *DynamoDBStreams) ListStreams(input *ListStreamsInput) (*ListStreamsOutput, error)
- func (c *DynamoDBStreams) ListStreamsRequest(input *ListStreamsInput) (req *request.Request, output *ListStreamsOutput)
- type GetRecordsInput
- type GetRecordsOutput
- type GetShardIteratorInput
- type GetShardIteratorOutput
- type ListStreamsInput
- type ListStreamsOutput
- type Record
- type SequenceNumberRange
- type Shard
- type Stream
- type StreamDescription
- type StreamRecord
Examples ¶
Constants ¶
const ( // @enum KeyType KeyTypeHash = "HASH" // @enum KeyType KeyTypeRange = "RANGE" )
const ( // @enum OperationType OperationTypeInsert = "INSERT" // @enum OperationType OperationTypeModify = "MODIFY" // @enum OperationType OperationTypeRemove = "REMOVE" )
const ( // @enum ShardIteratorType ShardIteratorTypeTrimHorizon = "TRIM_HORIZON" // @enum ShardIteratorType ShardIteratorTypeLatest = "LATEST" // @enum ShardIteratorType ShardIteratorTypeAtSequenceNumber = "AT_SEQUENCE_NUMBER" // @enum ShardIteratorType ShardIteratorTypeAfterSequenceNumber = "AFTER_SEQUENCE_NUMBER" )
const ( // @enum StreamStatus StreamStatusEnabling = "ENABLING" // @enum StreamStatus StreamStatusEnabled = "ENABLED" // @enum StreamStatus StreamStatusDisabling = "DISABLING" // @enum StreamStatus StreamStatusDisabled = "DISABLED" )
const ( // @enum StreamViewType StreamViewTypeNewImage = "NEW_IMAGE" // @enum StreamViewType StreamViewTypeOldImage = "OLD_IMAGE" // @enum StreamViewType StreamViewTypeNewAndOldImages = "NEW_AND_OLD_IMAGES" // @enum StreamViewType StreamViewTypeKeysOnly = "KEYS_ONLY" )
const ServiceName = "streams.dynamodb"
A ServiceName is the name of the service the client will make API calls to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DescribeStreamInput ¶
type DescribeStreamInput struct { // The shard ID of the first item that this operation will evaluate. Use the // value that was returned for LastEvaluatedShardId in the previous operation. ExclusiveStartShardId *string `min:"28" type:"string"` // The maximum number of shard objects to return. The upper limit is 100. Limit *int64 `min:"1" type:"integer"` // The Amazon Resource Name (ARN) for the stream. StreamArn *string `min:"37" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a DescribeStream operation.
func (DescribeStreamInput) GoString ¶
func (s DescribeStreamInput) GoString() string
GoString returns the string representation
func (DescribeStreamInput) String ¶
func (s DescribeStreamInput) String() string
String returns the string representation
func (*DescribeStreamInput) Validate ¶ added in v1.1.21
func (s *DescribeStreamInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeStreamOutput ¶
type DescribeStreamOutput struct { // A complete description of the stream, including its creation date and time, // the DynamoDB table associated with the stream, the shard IDs within the stream, // and the beginning and ending sequence numbers of stream records within the // shards. StreamDescription *StreamDescription `type:"structure"` // contains filtered or unexported fields }
Represents the output of a DescribeStream operation.
func (DescribeStreamOutput) GoString ¶
func (s DescribeStreamOutput) GoString() string
GoString returns the string representation
func (DescribeStreamOutput) String ¶
func (s DescribeStreamOutput) String() string
String returns the string representation
type DynamoDBStreams ¶
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 (http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html) in the Amazon DynamoDB Developer Guide.
The following are short descriptions of each low-level DynamoDB Streams action:
DescribeStream - Returns detailed information about a particular stream. GetRecords - Retrieves the stream records from within a shard. GetShardIterator - Returns information on how to retrieve the streams
record from a shard with a given shard ID.
ListStreams - Returns a list of all the streams associated with the current
AWS account and endpoint. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *DynamoDBStreams
New creates a new instance of the DynamoDBStreams client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a DynamoDBStreams client from just a session. svc := dynamodbstreams.New(mySession) // Create a DynamoDBStreams client with additional configuration svc := dynamodbstreams.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*DynamoDBStreams) DescribeStream ¶
func (c *DynamoDBStreams) DescribeStream(input *DescribeStreamInput) (*DescribeStreamOutput, error)
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.
func (*DynamoDBStreams) DescribeStreamRequest ¶
func (c *DynamoDBStreams) DescribeStreamRequest(input *DescribeStreamInput) (req *request.Request, output *DescribeStreamOutput)
DescribeStreamRequest generates a request for the DescribeStream operation.
func (*DynamoDBStreams) GetRecords ¶
func (c *DynamoDBStreams) GetRecords(input *GetRecordsInput) (*GetRecordsOutput, error)
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.
func (*DynamoDBStreams) GetRecordsRequest ¶
func (c *DynamoDBStreams) GetRecordsRequest(input *GetRecordsInput) (req *request.Request, output *GetRecordsOutput)
GetRecordsRequest generates a request for the GetRecords operation.
func (*DynamoDBStreams) GetShardIterator ¶
func (c *DynamoDBStreams) GetShardIterator(input *GetShardIteratorInput) (*GetShardIteratorOutput, error)
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.
func (*DynamoDBStreams) GetShardIteratorRequest ¶
func (c *DynamoDBStreams) GetShardIteratorRequest(input *GetShardIteratorInput) (req *request.Request, output *GetShardIteratorOutput)
GetShardIteratorRequest generates a request for the GetShardIterator operation.
func (*DynamoDBStreams) ListStreams ¶
func (c *DynamoDBStreams) ListStreams(input *ListStreamsInput) (*ListStreamsOutput, error)
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.
func (*DynamoDBStreams) ListStreamsRequest ¶
func (c *DynamoDBStreams) ListStreamsRequest(input *ListStreamsInput) (req *request.Request, output *ListStreamsOutput)
ListStreamsRequest generates a request for the ListStreams operation.
type GetRecordsInput ¶
type GetRecordsInput struct { // The maximum number of records to return from the shard. The upper limit is // 1000. Limit *int64 `min:"1" type:"integer"` // A shard iterator that was retrieved from a previous GetShardIterator operation. // This iterator can be used to access the stream records in this shard. ShardIterator *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a GetRecords operation.
func (GetRecordsInput) GoString ¶
func (s GetRecordsInput) GoString() string
GoString returns the string representation
func (GetRecordsInput) String ¶
func (s GetRecordsInput) String() string
String returns the string representation
func (*GetRecordsInput) Validate ¶ added in v1.1.21
func (s *GetRecordsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetRecordsOutput ¶
type GetRecordsOutput struct { // The next position in the shard from which to start sequentially reading stream // records. If set to null, the shard has been closed and the requested iterator // will not return any more data. NextShardIterator *string `min:"1" type:"string"` // The stream records from the shard, which were retrieved using the shard iterator. Records []*Record `type:"list"` // contains filtered or unexported fields }
Represents the output of a GetRecords operation.
func (GetRecordsOutput) GoString ¶
func (s GetRecordsOutput) GoString() string
GoString returns the string representation
func (GetRecordsOutput) String ¶
func (s GetRecordsOutput) String() string
String returns the string representation
type GetShardIteratorInput ¶
type GetShardIteratorInput struct { // The sequence number of a stream record in the shard from which to start reading. SequenceNumber *string `min:"21" type:"string"` // The identifier of the shard. The iterator will be returned for this shard // ID. ShardId *string `min:"28" type:"string" required:"true"` // Determines how the shard iterator is used to start reading stream records // from the shard: // // AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted // by a specific sequence number. // // AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted // by a specific sequence number. // // TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which // is the oldest record in the 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. // // LATEST - Start reading just after the most recent stream record in the // shard, so that you always read the most recent data in the shard. ShardIteratorType *string `type:"string" required:"true" enum:"ShardIteratorType"` // The Amazon Resource Name (ARN) for the stream. StreamArn *string `min:"37" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a GetShardIterator operation.
func (GetShardIteratorInput) GoString ¶
func (s GetShardIteratorInput) GoString() string
GoString returns the string representation
func (GetShardIteratorInput) String ¶
func (s GetShardIteratorInput) String() string
String returns the string representation
func (*GetShardIteratorInput) Validate ¶ added in v1.1.21
func (s *GetShardIteratorInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetShardIteratorOutput ¶
type GetShardIteratorOutput struct { // The position in the shard from which to start reading stream records sequentially. // A shard iterator specifies this position using the sequence number of a stream // record in a shard. ShardIterator *string `min:"1" type:"string"` // contains filtered or unexported fields }
Represents the output of a GetShardIterator operation.
func (GetShardIteratorOutput) GoString ¶
func (s GetShardIteratorOutput) GoString() string
GoString returns the string representation
func (GetShardIteratorOutput) String ¶
func (s GetShardIteratorOutput) String() string
String returns the string representation
type ListStreamsInput ¶
type ListStreamsInput struct { // The ARN (Amazon Resource Name) of the first item that this operation will // evaluate. Use the value that was returned for LastEvaluatedStreamArn in the // previous operation. ExclusiveStartStreamArn *string `min:"37" type:"string"` // The maximum number of streams to return. The upper limit is 100. Limit *int64 `min:"1" type:"integer"` // If this parameter is provided, then only the streams associated with this // table name are returned. TableName *string `min:"3" type:"string"` // contains filtered or unexported fields }
Represents the input of a ListStreams operation.
func (ListStreamsInput) GoString ¶
func (s ListStreamsInput) GoString() string
GoString returns the string representation
func (ListStreamsInput) String ¶
func (s ListStreamsInput) String() string
String returns the string representation
func (*ListStreamsInput) Validate ¶ added in v1.1.21
func (s *ListStreamsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListStreamsOutput ¶
type ListStreamsOutput struct { // The stream ARN of the item where the operation stopped, inclusive of the // previous result set. Use this value to start a new operation, excluding this // value in the new request. // // If LastEvaluatedStreamArn is empty, then the "last page" of results has // been processed and there is no more data to be retrieved. // // If LastEvaluatedStreamArn is not empty, it does not necessarily mean that // there is more data in the result set. The only way to know when you have // reached the end of the result set is when LastEvaluatedStreamArn is empty. LastEvaluatedStreamArn *string `min:"37" type:"string"` // A list of stream descriptors associated with the current account and endpoint. Streams []*Stream `type:"list"` // contains filtered or unexported fields }
Represents the output of a ListStreams operation.
func (ListStreamsOutput) GoString ¶
func (s ListStreamsOutput) GoString() string
GoString returns the string representation
func (ListStreamsOutput) String ¶
func (s ListStreamsOutput) String() string
String returns the string representation
type Record ¶
type Record struct { // The region in which the GetRecords request was received. AwsRegion *string `locationName:"awsRegion" type:"string"` // The main body of the stream record, containing all of the DynamoDB-specific // fields. Dynamodb *StreamRecord `locationName:"dynamodb" type:"structure"` // A globally unique identifier for the event that was recorded in this stream // record. EventID *string `locationName:"eventID" type:"string"` // The type of data modification that was performed on the DynamoDB table: // // INSERT - a new item was added to the table. // // MODIFY - one or more of an existing item's attributes were modified. // // REMOVE - the item was deleted from the table EventName *string `locationName:"eventName" type:"string" enum:"OperationType"` // The AWS service from which the stream record originated. For DynamoDB Streams, // this is aws:dynamodb. EventSource *string `locationName:"eventSource" type:"string"` // The version number of the stream record format. This number is updated whenever // the structure of Record is modified. // // Client applications must not assume that eventVersion will remain at a particular // value, as this number is subject to change at any time. In general, eventVersion // will only increase as the low-level DynamoDB Streams API evolves. EventVersion *string `locationName:"eventVersion" type:"string"` // contains filtered or unexported fields }
A description of a unique event within a stream.
type SequenceNumberRange ¶
type SequenceNumberRange struct { // The last sequence number. EndingSequenceNumber *string `min:"21" type:"string"` // The first sequence number. StartingSequenceNumber *string `min:"21" type:"string"` // contains filtered or unexported fields }
The beginning and ending sequence numbers for the stream records contained within a shard.
func (SequenceNumberRange) GoString ¶
func (s SequenceNumberRange) GoString() string
GoString returns the string representation
func (SequenceNumberRange) String ¶
func (s SequenceNumberRange) String() string
String returns the string representation
type Shard ¶
type Shard struct { // The shard ID of the current shard's parent. ParentShardId *string `min:"28" type:"string"` // The range of possible sequence numbers for the shard. SequenceNumberRange *SequenceNumberRange `type:"structure"` // The system-generated identifier for this shard. ShardId *string `min:"28" type:"string"` // contains filtered or unexported fields }
A uniquely identified group of stream records within a stream.
type Stream ¶
type Stream struct { // The Amazon Resource Name (ARN) for the stream. StreamArn *string `min:"37" type:"string"` // A timestamp, in ISO 8601 format, for this stream. // // Note that LatestStreamLabel is not a unique identifier for the stream, because // it is possible that a stream from another table might have the same timestamp. // However, the combination of the following three elements is guaranteed to // be unique: // // the AWS customer ID. // // the table name // // the StreamLabel StreamLabel *string `type:"string"` // The DynamoDB table with which the stream is associated. TableName *string `min:"3" type:"string"` // contains filtered or unexported fields }
Represents all of the data describing a particular stream.
type StreamDescription ¶
type StreamDescription struct { // The date and time when the request to create this stream was issued. CreationRequestDateTime *time.Time `type:"timestamp" timestampFormat:"unix"` // The key attribute(s) of the stream's DynamoDB table. KeySchema []*dynamodb.KeySchemaElement `min:"1" type:"list"` // The shard ID of the item where the operation stopped, inclusive of the previous // result set. Use this value to start a new operation, excluding this value // in the new request. // // If LastEvaluatedShardId is empty, then the "last page" of results has been // processed and there is currently no more data to be retrieved. // // If LastEvaluatedShardId is not empty, it does not necessarily mean that // there is more data in the result set. The only way to know when you have // reached the end of the result set is when LastEvaluatedShardId is empty. LastEvaluatedShardId *string `min:"28" type:"string"` // The shards that comprise the stream. Shards []*Shard `type:"list"` // The Amazon Resource Name (ARN) for the stream. StreamArn *string `min:"37" type:"string"` // A timestamp, in ISO 8601 format, for this stream. // // Note that LatestStreamLabel is not a unique identifier for the stream, because // it is possible that a stream from another table might have the same timestamp. // However, the combination of the following three elements is guaranteed to // be unique: // // the AWS customer ID. // // the table name // // the StreamLabel StreamLabel *string `type:"string"` // Indicates the current status of the stream: // // ENABLING - Streams is currently being enabled on the DynamoDB table. // // ENABLED - the stream is enabled. // // DISABLING - Streams is currently being disabled on the DynamoDB table. // // DISABLED - the stream is disabled. StreamStatus *string `type:"string" enum:"StreamStatus"` // Indicates the format of the records within this stream: // // KEYS_ONLY - only the key attributes of items that were modified in the // DynamoDB table. // // NEW_IMAGE - entire items from the table, as they appeared after they // were modified. // // OLD_IMAGE - entire items from the table, as they appeared before they // were modified. // // NEW_AND_OLD_IMAGES - both the new and the old images of the items from // the table. StreamViewType *string `type:"string" enum:"StreamViewType"` // The DynamoDB table with which the stream is associated. TableName *string `min:"3" type:"string"` // contains filtered or unexported fields }
Represents all of the data describing a particular stream.
func (StreamDescription) GoString ¶
func (s StreamDescription) GoString() string
GoString returns the string representation
func (StreamDescription) String ¶
func (s StreamDescription) String() string
String returns the string representation
type StreamRecord ¶
type StreamRecord struct { // The approximate date and time when the stream record was created, in UNIX // epoch time (http://www.epochconverter.com/) format. ApproximateCreationDateTime *time.Time `type:"timestamp" timestampFormat:"unix"` // The primary key attribute(s) for the DynamoDB item that was modified. Keys map[string]*dynamodb.AttributeValue `type:"map"` // The item in the DynamoDB table as it appeared after it was modified. NewImage map[string]*dynamodb.AttributeValue `type:"map"` // The item in the DynamoDB table as it appeared before it was modified. OldImage map[string]*dynamodb.AttributeValue `type:"map"` // The sequence number of the stream record. SequenceNumber *string `min:"21" type:"string"` // The size of the stream record, in bytes. SizeBytes *int64 `min:"1" type:"long"` // The type of data from the modified DynamoDB item that was captured in this // stream record: // // KEYS_ONLY - only the key attributes of the modified item. // // NEW_IMAGE - the entire item, as it appeared after it was modified. // // OLD_IMAGE - the entire item, as it appeared before it was modified. // // NEW_AND_OLD_IMAGES - both the new and the old item images of the item. StreamViewType *string `type:"string" enum:"StreamViewType"` // contains filtered or unexported fields }
A description of a single data modification that was performed on an item in a DynamoDB table.
func (StreamRecord) GoString ¶
func (s StreamRecord) GoString() string
GoString returns the string representation
func (StreamRecord) String ¶
func (s StreamRecord) String() string
String returns the string representation
Directories ¶
Path | Synopsis |
---|---|
Package dynamodbstreamsiface provides an interface for the Amazon DynamoDB Streams.
|
Package dynamodbstreamsiface provides an interface for the Amazon DynamoDB Streams. |