// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT. // Package dynamodbstreams provides a client for Amazon DynamoDB Streams. package dynamodbstreams import ( "time" "github.com/aws/aws-sdk-go/aws/awsutil" "github.com/aws/aws-sdk-go/aws/request" "github.com/aws/aws-sdk-go/service/dynamodb" ) const opDescribeStream = "DescribeStream" // DescribeStreamRequest generates a "aws/request.Request" representing the // client's request for the DescribeStream operation. The "output" return // value can be used to capture response data after the request's "Send" method // is called. // // Creating a request object using this method should be used when you want to inject // custom logic into the request's lifecycle using a custom handler, or if you want to // access properties on the request object before or after sending the request. If // you just want the service response, call the DescribeStream method directly // instead. // // Note: You must call the "Send" method on the returned request object in order // to execute the request. // // // Example sending a request using the DescribeStreamRequest method. // req, resp := client.DescribeStreamRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // func (c *DynamoDBStreams) DescribeStreamRequest(input *DescribeStreamInput) (req *request.Request, output *DescribeStreamOutput) { op := &request.Operation{ Name: opDescribeStream, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { input = &DescribeStreamInput{} } req = c.newRequest(op, input, output) output = &DescribeStreamOutput{} req.Data = output return } // 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 (c *DynamoDBStreams) DescribeStream(input *DescribeStreamInput) (*DescribeStreamOutput, error) { req, out := c.DescribeStreamRequest(input) err := req.Send() return out, err } const opGetRecords = "GetRecords" // GetRecordsRequest generates a "aws/request.Request" representing the // client's request for the GetRecords operation. The "output" return // value can be used to capture response data after the request's "Send" method // is called. // // Creating a request object using this method should be used when you want to inject // custom logic into the request's lifecycle using a custom handler, or if you want to // access properties on the request object before or after sending the request. If // you just want the service response, call the GetRecords method directly // instead. // // Note: You must call the "Send" method on the returned request object in order // to execute the request. // // // Example sending a request using the GetRecordsRequest method. // req, resp := client.GetRecordsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // func (c *DynamoDBStreams) GetRecordsRequest(input *GetRecordsInput) (req *request.Request, output *GetRecordsOutput) { op := &request.Operation{ Name: opGetRecords, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { input = &GetRecordsInput{} } req = c.newRequest(op, input, output) output = &GetRecordsOutput{} req.Data = output return } // 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 (c *DynamoDBStreams) GetRecords(input *GetRecordsInput) (*GetRecordsOutput, error) { req, out := c.GetRecordsRequest(input) err := req.Send() return out, err } const opGetShardIterator = "GetShardIterator" // GetShardIteratorRequest generates a "aws/request.Request" representing the // client's request for the GetShardIterator operation. The "output" return // value can be used to capture response data after the request's "Send" method // is called. // // Creating a request object using this method should be used when you want to inject // custom logic into the request's lifecycle using a custom handler, or if you want to // access properties on the request object before or after sending the request. If // you just want the service response, call the GetShardIterator method directly // instead. // // Note: You must call the "Send" method on the returned request object in order // to execute the request. // // // Example sending a request using the GetShardIteratorRequest method. // req, resp := client.GetShardIteratorRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // func (c *DynamoDBStreams) GetShardIteratorRequest(input *GetShardIteratorInput) (req *request.Request, output *GetShardIteratorOutput) { op := &request.Operation{ Name: opGetShardIterator, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { input = &GetShardIteratorInput{} } req = c.newRequest(op, input, output) output = &GetShardIteratorOutput{} req.Data = output return } // 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 (c *DynamoDBStreams) GetShardIterator(input *GetShardIteratorInput) (*GetShardIteratorOutput, error) { req, out := c.GetShardIteratorRequest(input) err := req.Send() return out, err } const opListStreams = "ListStreams" // ListStreamsRequest generates a "aws/request.Request" representing the // client's request for the ListStreams operation. The "output" return // value can be used to capture response data after the request's "Send" method // is called. // // Creating a request object using this method should be used when you want to inject // custom logic into the request's lifecycle using a custom handler, or if you want to // access properties on the request object before or after sending the request. If // you just want the service response, call the ListStreams method directly // instead. // // Note: You must call the "Send" method on the returned request object in order // to execute the request. // // // Example sending a request using the ListStreamsRequest method. // req, resp := client.ListStreamsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // func (c *DynamoDBStreams) ListStreamsRequest(input *ListStreamsInput) (req *request.Request, output *ListStreamsOutput) { op := &request.Operation{ Name: opListStreams, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { input = &ListStreamsInput{} } req = c.newRequest(op, input, output) output = &ListStreamsOutput{} req.Data = output return } // 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 (c *DynamoDBStreams) ListStreams(input *ListStreamsInput) (*ListStreamsOutput, error) { req, out := c.ListStreamsRequest(input) err := req.Send() return out, err } // Represents the input of a DescribeStream operation. type DescribeStreamInput struct { _ struct{} `type:"structure"` // 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"` } // String returns the string representation func (s DescribeStreamInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation func (s DescribeStreamInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. func (s *DescribeStreamInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "DescribeStreamInput"} if s.ExclusiveStartShardId != nil && len(*s.ExclusiveStartShardId) < 28 { invalidParams.Add(request.NewErrParamMinLen("ExclusiveStartShardId", 28)) } if s.Limit != nil && *s.Limit < 1 { invalidParams.Add(request.NewErrParamMinValue("Limit", 1)) } if s.StreamArn == nil { invalidParams.Add(request.NewErrParamRequired("StreamArn")) } if s.StreamArn != nil && len(*s.StreamArn) < 37 { invalidParams.Add(request.NewErrParamMinLen("StreamArn", 37)) } if invalidParams.Len() > 0 { return invalidParams } return nil } // Represents the output of a DescribeStream operation. type DescribeStreamOutput struct { _ struct{} `type:"structure"` // 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"` } // String returns the string representation func (s DescribeStreamOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation func (s DescribeStreamOutput) GoString() string { return s.String() } // Represents the input of a GetRecords operation. type GetRecordsInput struct { _ struct{} `type:"structure"` // 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"` } // String returns the string representation func (s GetRecordsInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation func (s GetRecordsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. func (s *GetRecordsInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "GetRecordsInput"} if s.Limit != nil && *s.Limit < 1 { invalidParams.Add(request.NewErrParamMinValue("Limit", 1)) } if s.ShardIterator == nil { invalidParams.Add(request.NewErrParamRequired("ShardIterator")) } if s.ShardIterator != nil && len(*s.ShardIterator) < 1 { invalidParams.Add(request.NewErrParamMinLen("ShardIterator", 1)) } if invalidParams.Len() > 0 { return invalidParams } return nil } // Represents the output of a GetRecords operation. type GetRecordsOutput struct { _ struct{} `type:"structure"` // 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"` } // String returns the string representation func (s GetRecordsOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation func (s GetRecordsOutput) GoString() string { return s.String() } // Represents the input of a GetShardIterator operation. type GetShardIteratorInput struct { _ struct{} `type:"structure"` // 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"` } // String returns the string representation func (s GetShardIteratorInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation func (s GetShardIteratorInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. func (s *GetShardIteratorInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "GetShardIteratorInput"} if s.SequenceNumber != nil && len(*s.SequenceNumber) < 21 { invalidParams.Add(request.NewErrParamMinLen("SequenceNumber", 21)) } if s.ShardId == nil { invalidParams.Add(request.NewErrParamRequired("ShardId")) } if s.ShardId != nil && len(*s.ShardId) < 28 { invalidParams.Add(request.NewErrParamMinLen("ShardId", 28)) } if s.ShardIteratorType == nil { invalidParams.Add(request.NewErrParamRequired("ShardIteratorType")) } if s.StreamArn == nil { invalidParams.Add(request.NewErrParamRequired("StreamArn")) } if s.StreamArn != nil && len(*s.StreamArn) < 37 { invalidParams.Add(request.NewErrParamMinLen("StreamArn", 37)) } if invalidParams.Len() > 0 { return invalidParams } return nil } // Represents the output of a GetShardIterator operation. type GetShardIteratorOutput struct { _ struct{} `type:"structure"` // 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"` } // String returns the string representation func (s GetShardIteratorOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation func (s GetShardIteratorOutput) GoString() string { return s.String() } // Represents the input of a ListStreams operation. type ListStreamsInput struct { _ struct{} `type:"structure"` // 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"` } // String returns the string representation func (s ListStreamsInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation func (s ListStreamsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. func (s *ListStreamsInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ListStreamsInput"} if s.ExclusiveStartStreamArn != nil && len(*s.ExclusiveStartStreamArn) < 37 { invalidParams.Add(request.NewErrParamMinLen("ExclusiveStartStreamArn", 37)) } if s.Limit != nil && *s.Limit < 1 { invalidParams.Add(request.NewErrParamMinValue("Limit", 1)) } if s.TableName != nil && len(*s.TableName) < 3 { invalidParams.Add(request.NewErrParamMinLen("TableName", 3)) } if invalidParams.Len() > 0 { return invalidParams } return nil } // Represents the output of a ListStreams operation. type ListStreamsOutput struct { _ struct{} `type:"structure"` // 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"` } // String returns the string representation func (s ListStreamsOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation func (s ListStreamsOutput) GoString() string { return s.String() } // A description of a unique event within a stream. type Record struct { _ struct{} `type:"structure"` // 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"` } // String returns the string representation func (s Record) String() string { return awsutil.Prettify(s) } // GoString returns the string representation func (s Record) GoString() string { return s.String() } // The beginning and ending sequence numbers for the stream records contained // within a shard. type SequenceNumberRange struct { _ struct{} `type:"structure"` // The last sequence number. EndingSequenceNumber *string `min:"21" type:"string"` // The first sequence number. StartingSequenceNumber *string `min:"21" type:"string"` } // String returns the string representation func (s SequenceNumberRange) String() string { return awsutil.Prettify(s) } // GoString returns the string representation func (s SequenceNumberRange) GoString() string { return s.String() } // A uniquely identified group of stream records within a stream. type Shard struct { _ struct{} `type:"structure"` // 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"` } // String returns the string representation func (s Shard) String() string { return awsutil.Prettify(s) } // GoString returns the string representation func (s Shard) GoString() string { return s.String() } // Represents all of the data describing a particular stream. type Stream struct { _ struct{} `type:"structure"` // 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"` } // String returns the string representation func (s Stream) String() string { return awsutil.Prettify(s) } // GoString returns the string representation func (s Stream) GoString() string { return s.String() } // Represents all of the data describing a particular stream. type StreamDescription struct { _ struct{} `type:"structure"` // 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"` } // String returns the string representation func (s StreamDescription) String() string { return awsutil.Prettify(s) } // GoString returns the string representation func (s StreamDescription) GoString() string { return s.String() } // A description of a single data modification that was performed on an item // in a DynamoDB table. type StreamRecord struct { _ struct{} `type:"structure"` // 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"` } // String returns the string representation func (s StreamRecord) String() string { return awsutil.Prettify(s) } // GoString returns the string representation func (s StreamRecord) GoString() string { return s.String() } 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" )