package types

import "github.com/aws/aws-sdk-go-v2/service/dynamodbstreams/types"

Index

Types

type AttributeValue

type AttributeValue struct {
	// A Boolean data type.
	BOOL *bool
	// A Map data type.
	M map[string]*AttributeValue
	// A List data type.
	L []*AttributeValue
	// A String data type.
	S *string
	// A Binary data type.
	B []byte
	// A Number Set data type.
	NS []*string
	// A Null data type.
	NULL *bool
	// A Number data type.
	N *string
	// A Binary Set data type.
	BS [][]byte
	// A String Set data type.
	SS []*string
}

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.

type ExpiredIteratorException

type ExpiredIteratorException struct {
	Message *string
}

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.

func (*ExpiredIteratorException) Error

func (e *ExpiredIteratorException) Error() string

func (*ExpiredIteratorException) ErrorCode

func (e *ExpiredIteratorException) ErrorCode() string

func (*ExpiredIteratorException) ErrorFault

func (e *ExpiredIteratorException) ErrorFault() smithy.ErrorFault

func (*ExpiredIteratorException) ErrorMessage

func (e *ExpiredIteratorException) ErrorMessage() string

func (*ExpiredIteratorException) GetMessage

func (e *ExpiredIteratorException) GetMessage() string

func (*ExpiredIteratorException) HasMessage

func (e *ExpiredIteratorException) HasMessage() bool

type Identity

type Identity struct {
	// The type of the identity. For Time To Live, the type is "Service".
	Type *string
	// A unique identifier for the entity that made the call. For Time To Live, the
	// principalId is "dynamodb.amazonaws.com".
	PrincipalId *string
}

Contains details about the type of identity that made the request.

type InternalServerError

type InternalServerError struct {
	Message *string
}

An error occurred on the server side.

func (*InternalServerError) Error

func (e *InternalServerError) Error() string

func (*InternalServerError) ErrorCode

func (e *InternalServerError) ErrorCode() string

func (*InternalServerError) ErrorFault

func (e *InternalServerError) ErrorFault() smithy.ErrorFault

func (*InternalServerError) ErrorMessage

func (e *InternalServerError) ErrorMessage() string

func (*InternalServerError) GetMessage

func (e *InternalServerError) GetMessage() string

func (*InternalServerError) HasMessage

func (e *InternalServerError) HasMessage() bool

type KeySchemaElement

type KeySchemaElement struct {
	// The attribute data, consisting of the data type and the attribute value itself.
	KeyType KeyType
	// The name of a key attribute.
	AttributeName *string
}

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.

type KeyType

type KeyType string
const (
	KeyTypeHash  KeyType = "HASH"
	KeyTypeRange KeyType = "RANGE"
)

Enum values for KeyType

type LimitExceededException

type LimitExceededException struct {
	Message *string
}

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 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#APIRetries) in the Amazon DynamoDB Developer Guide.

func (*LimitExceededException) Error

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage

func (e *LimitExceededException) ErrorMessage() string

func (*LimitExceededException) GetMessage

func (e *LimitExceededException) GetMessage() string

func (*LimitExceededException) HasMessage

func (e *LimitExceededException) HasMessage() bool

type OperationType

type OperationType string
const (
	OperationTypeInsert OperationType = "INSERT"
	OperationTypeModify OperationType = "MODIFY"
	OperationTypeRemove OperationType = "REMOVE"
)

Enum values for OperationType

type Record

type Record struct {
	// The main body of the stream record, containing all of the DynamoDB-specific
	// fields.
	Dynamodb *StreamRecord
	// The region in which the GetRecords request was received.
	AwsRegion *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 OperationType
	// The AWS service from which the stream record originated. For DynamoDB Streams,
	// this is aws:dynamodb.
	EventSource *string
	// Items that are deleted by the Time to Live process after expiration have the
	// following fields:
	//
	//     * Records[].userIdentity.type "Service"
	//
	//     *
	// Records[].userIdentity.principalId "dynamodb.amazonaws.com"
	UserIdentity *Identity
	// 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
	// A globally unique identifier for the event that was recorded in this stream
	// record.
	EventID *string
}

A description of a unique event within a stream.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string
}

The operation tried to access a nonexistent stream.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

func (*ResourceNotFoundException) GetMessage

func (e *ResourceNotFoundException) GetMessage() string

func (*ResourceNotFoundException) HasMessage

func (e *ResourceNotFoundException) HasMessage() bool

type SequenceNumberRange

type SequenceNumberRange struct {
	// The last sequence number.
	EndingSequenceNumber *string
	// The first sequence number.
	StartingSequenceNumber *string
}

The beginning and ending sequence numbers for the stream records contained within a shard.

type Shard

type Shard struct {
	// The shard ID of the current shard's parent.
	ParentShardId *string
	// The system-generated identifier for this shard.
	ShardId *string
	// The range of possible sequence numbers for the shard.
	SequenceNumberRange *SequenceNumberRange
}

A uniquely identified group of stream records within a stream.

type ShardIteratorType

type ShardIteratorType string
const (
	ShardIteratorTypeTrim_horizon          ShardIteratorType = "TRIM_HORIZON"
	ShardIteratorTypeLatest                ShardIteratorType = "LATEST"
	ShardIteratorTypeAt_sequence_number    ShardIteratorType = "AT_SEQUENCE_NUMBER"
	ShardIteratorTypeAfter_sequence_number ShardIteratorType = "AFTER_SEQUENCE_NUMBER"
)

Enum values for ShardIteratorType

type Stream

type Stream struct {
	// 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
	// The DynamoDB table with which the stream is associated.
	TableName *string
	// The Amazon Resource Name (ARN) for the stream.
	StreamArn *string
}

Represents all of the data describing a particular stream.

type StreamDescription

type StreamDescription struct {
	// 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
	// The key attribute(s) of the stream's DynamoDB table.
	KeySchema []*KeySchemaElement
	// 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 StreamViewType
	// The Amazon Resource Name (ARN) for the stream.
	StreamArn *string
	// The shards that comprise the stream.
	Shards []*Shard
	// 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
	// The date and time when the request to create this stream was issued.
	CreationRequestDateTime *time.Time
	// 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 StreamStatus
	// The DynamoDB table with which the stream is associated.
	TableName *string
}

Represents all of the data describing a particular stream.

type StreamRecord

type StreamRecord struct {
	// The sequence number of the stream record.
	SequenceNumber *string
	// 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 StreamViewType
	// The item in the DynamoDB table as it appeared before it was modified.
	OldImage map[string]*AttributeValue
	// The approximate date and time when the stream record was created, in UNIX epoch
	// time (http://www.epochconverter.com/) format.
	ApproximateCreationDateTime *time.Time
	// The primary key attribute(s) for the DynamoDB item that was modified.
	Keys map[string]*AttributeValue
	// The size of the stream record, in bytes.
	SizeBytes *int64
	// The item in the DynamoDB table as it appeared after it was modified.
	NewImage map[string]*AttributeValue
}

A description of a single data modification that was performed on an item in a DynamoDB table.

type StreamStatus

type StreamStatus string
const (
	StreamStatusEnabling  StreamStatus = "ENABLING"
	StreamStatusEnabled   StreamStatus = "ENABLED"
	StreamStatusDisabling StreamStatus = "DISABLING"
	StreamStatusDisabled  StreamStatus = "DISABLED"
)

Enum values for StreamStatus

type StreamViewType

type StreamViewType string
const (
	StreamViewTypeNew_image          StreamViewType = "NEW_IMAGE"
	StreamViewTypeOld_image          StreamViewType = "OLD_IMAGE"
	StreamViewTypeNew_and_old_images StreamViewType = "NEW_AND_OLD_IMAGES"
	StreamViewTypeKeys_only          StreamViewType = "KEYS_ONLY"
)

Enum values for StreamViewType

type TrimmedDataAccessException

type TrimmedDataAccessException struct {
	Message *string
}

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:

iterator with a sequence number older than the trim point (24 hours).

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.

func (*TrimmedDataAccessException) Error

func (*TrimmedDataAccessException) ErrorCode

func (e *TrimmedDataAccessException) ErrorCode() string

func (*TrimmedDataAccessException) ErrorFault

func (*TrimmedDataAccessException) ErrorMessage

func (e *TrimmedDataAccessException) ErrorMessage() string

func (*TrimmedDataAccessException) GetMessage

func (e *TrimmedDataAccessException) GetMessage() string

func (*TrimmedDataAccessException) HasMessage

func (e *TrimmedDataAccessException) HasMessage() bool

Source Files

enums.go errors.go types.go

Version
v0.1.0
Published
Sep 29, 2020
Platform
darwin/amd64
Imports
4 packages
Last checked
2 seconds ago

Tools for package owners.