Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AttributeValue

type AttributeValue interface {
	// contains filtered or unexported methods
}

    Represents the data for an attribute. Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself. For more information, see Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the Amazon DynamoDB Developer Guide.

    The following types satisfy this interface:

    AttributeValueMemberS
    AttributeValueMemberN
    AttributeValueMemberB
    AttributeValueMemberSS
    AttributeValueMemberNS
    AttributeValueMemberBS
    AttributeValueMemberM
    AttributeValueMemberL
    AttributeValueMemberNULL
    AttributeValueMemberBOOL
    
    Example (OutputUsage)
    Output:
    
    

    type AttributeValueMemberB

    type AttributeValueMemberB struct {
    	Value []byte
    }

      An attribute of type Binary. For example: "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

      type AttributeValueMemberBOOL

      type AttributeValueMemberBOOL struct {
      	Value bool
      }

        An attribute of type Boolean. For example: "BOOL": true

        type AttributeValueMemberBS

        type AttributeValueMemberBS struct {
        	Value [][]byte
        }

          An attribute of type Binary Set. For example: "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

          type AttributeValueMemberL

          type AttributeValueMemberL struct {
          	Value []AttributeValue
          }

            An attribute of type List. For example: "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]

            type AttributeValueMemberM

            type AttributeValueMemberM struct {
            	Value map[string]AttributeValue
            }

              An attribute of type Map. For example: "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

              type AttributeValueMemberN

              type AttributeValueMemberN struct {
              	Value string
              }

                An attribute of type Number. For example: "N": "123.45" Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

                type AttributeValueMemberNS

                type AttributeValueMemberNS struct {
                	Value []string
                }

                  An attribute of type Number Set. For example: "NS": ["42.2", "-19", "7.5", "3.14"] Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

                  type AttributeValueMemberNULL

                  type AttributeValueMemberNULL struct {
                  	Value bool
                  }

                    An attribute of type Null. For example: "NULL": true

                    type AttributeValueMemberS

                    type AttributeValueMemberS struct {
                    	Value string
                    }

                      An attribute of type String. For example: "S": "Hello"

                      type AttributeValueMemberSS

                      type AttributeValueMemberSS struct {
                      	Value []string
                      }

                        An attribute of type String Set. For example: "SS": ["Giraffe", "Hippo" ,"Zebra"]

                        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

                          type Identity

                          type Identity struct {
                          
                          	// A unique identifier for the entity that made the call. For Time To Live, the
                          	// principalId is "dynamodb.amazonaws.com".
                          	PrincipalId *string
                          
                          	// The type of the identity. For Time To Live, the type is "Service".
                          	Type *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

                              type KeySchemaElement

                              type KeySchemaElement struct {
                              
                              	// The name of a key attribute.
                              	//
                              	// This member is required.
                              	AttributeName *string
                              
                              	// The role that this key attribute will assume:
                              	//
                              	// * HASH - partition key
                              	//
                              	// * RANGE -
                              	// 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.
                              	//
                              	// This member is required.
                              	KeyType KeyType
                              }

                                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 would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key. A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

                                type KeyType

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

                                  Enum values for KeyType

                                  func (KeyType) Values

                                  func (KeyType) Values() []KeyType

                                    Values returns all known values for KeyType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                    type LimitExceededException

                                    type LimitExceededException struct {
                                    	Message *string
                                    }

                                      There is no limit to the number of daily on-demand backups that can be taken. Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations. There is a soft account quota of 256 tables.

                                      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

                                      type OperationType

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

                                        Enum values for OperationType

                                        func (OperationType) Values

                                        func (OperationType) Values() []OperationType

                                          Values returns all known values for OperationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                          type Record

                                          type Record struct {
                                          
                                          	// The region in which the GetRecords request was received.
                                          	AwsRegion *string
                                          
                                          	// The main body of the stream record, containing all of the DynamoDB-specific
                                          	// fields.
                                          	Dynamodb *StreamRecord
                                          
                                          	// A globally unique identifier for the event that was recorded in this stream
                                          	// record.
                                          	EventID *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
                                          
                                          	// 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
                                          
                                          	// 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
                                          }

                                            A description of a unique event within a stream.

                                            type ResourceNotFoundException

                                            type ResourceNotFoundException struct {
                                            	Message *string
                                            }

                                              The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

                                              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

                                              type SequenceNumberRange

                                              type SequenceNumberRange struct {
                                              
                                              	// The last sequence number for the stream records contained within a shard. String
                                              	// contains numeric characters only.
                                              	EndingSequenceNumber *string
                                              
                                              	// The first sequence number for the stream records contained within a shard.
                                              	// String contains numeric characters only.
                                              	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 range of possible sequence numbers for the shard.
                                                	SequenceNumberRange *SequenceNumberRange
                                                
                                                	// The system-generated identifier for this shard.
                                                	ShardId *string
                                                }

                                                  A uniquely identified group of stream records within a stream.

                                                  type ShardIteratorType

                                                  type ShardIteratorType string
                                                  const (
                                                  	ShardIteratorTypeTrimHorizon         ShardIteratorType = "TRIM_HORIZON"
                                                  	ShardIteratorTypeLatest              ShardIteratorType = "LATEST"
                                                  	ShardIteratorTypeAtSequenceNumber    ShardIteratorType = "AT_SEQUENCE_NUMBER"
                                                  	ShardIteratorTypeAfterSequenceNumber ShardIteratorType = "AFTER_SEQUENCE_NUMBER"
                                                  )

                                                    Enum values for ShardIteratorType

                                                    func (ShardIteratorType) Values

                                                      Values returns all known values for ShardIteratorType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                      type Stream

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

                                                        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
                                                        
                                                        	// The key attribute(s) of the stream's DynamoDB table.
                                                        	KeySchema []KeySchemaElement
                                                        
                                                        	// 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 shards that comprise the stream.
                                                        	Shards []Shard
                                                        
                                                        	// The Amazon Resource Name (ARN) for the stream.
                                                        	StreamArn *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
                                                        
                                                        	// 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
                                                        
                                                        	// 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 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 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 item in the DynamoDB table as it appeared after it was modified.
                                                          	NewImage map[string]AttributeValue
                                                          
                                                          	// The item in the DynamoDB table as it appeared before it was modified.
                                                          	OldImage map[string]AttributeValue
                                                          
                                                          	// The sequence number of the stream record.
                                                          	SequenceNumber *string
                                                          
                                                          	// The size of the stream record, in bytes.
                                                          	SizeBytes *int64
                                                          
                                                          	// 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
                                                          }

                                                            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

                                                              func (StreamStatus) Values

                                                              func (StreamStatus) Values() []StreamStatus

                                                                Values returns all known values for StreamStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                                type StreamViewType

                                                                type StreamViewType string
                                                                const (
                                                                	StreamViewTypeNewImage        StreamViewType = "NEW_IMAGE"
                                                                	StreamViewTypeOldImage        StreamViewType = "OLD_IMAGE"
                                                                	StreamViewTypeNewAndOldImages StreamViewType = "NEW_AND_OLD_IMAGES"
                                                                	StreamViewTypeKeysOnly        StreamViewType = "KEYS_ONLY"
                                                                )

                                                                  Enum values for StreamViewType

                                                                  func (StreamViewType) Values

                                                                  func (StreamViewType) Values() []StreamViewType

                                                                    Values returns all known values for StreamViewType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

                                                                    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:

                                                                      * 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.

                                                                      func (*TrimmedDataAccessException) Error

                                                                      func (*TrimmedDataAccessException) ErrorCode

                                                                      func (e *TrimmedDataAccessException) ErrorCode() string

                                                                      func (*TrimmedDataAccessException) ErrorFault

                                                                      func (*TrimmedDataAccessException) ErrorMessage

                                                                      func (e *TrimmedDataAccessException) ErrorMessage() string

                                                                      type UnknownUnionMember

                                                                      type UnknownUnionMember struct {
                                                                      	Tag   string
                                                                      	Value []byte
                                                                      }

                                                                        UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.