types

package
v0.0.2-beta Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 21, 2022 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func SprintError

func SprintError(code, message, extra string, origErr error) string

SprintError returns a string of the formatted error code.

func StringValue

func StringValue(str *string) string

func ToString

func ToString(str string) *string

Types

type AttributeDefinition

type AttributeDefinition struct {
	AttributeName *string `min:"1" type:"string" required:"true"`
	AttributeType *string `type:"string" required:"true" enum:"ScalarAttributeType"`
	// contains filtered or unexported fields
}

type AttributeValueUpdate

type AttributeValueUpdate struct {
	Action *string `type:"string" enum:"AttributeAction"`
	Value  Item    `type:"structure"`
	// contains filtered or unexported fields
}

type BatchedErrors

type BatchedErrors interface {
	Error
	OrigErrs() []error
}

BatchedErrors is a batch of errors which also wraps lower level errors with code, message, and original errors. Calling Error() will include all errors that occurred in the batch.

func NewBatchError

func NewBatchError(code, message string, errs []error) BatchedErrors

NewBatchError returns an BatchedErrors with a collection of errors as an array of errors.

type ConditionalCheckFailedException

type ConditionalCheckFailedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`
	Message_     string                    `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A condition specified in the operation could not be evaluated.

func (*ConditionalCheckFailedException) Code

Code returns the exception type name.

func (*ConditionalCheckFailedException) Error

func (ConditionalCheckFailedException) GoString

GoString returns the string representation

func (*ConditionalCheckFailedException) Message

Message returns the exception's message.

func (*ConditionalCheckFailedException) OrigErr

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConditionalCheckFailedException) RequestID

func (s *ConditionalCheckFailedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConditionalCheckFailedException) StatusCode

func (s *ConditionalCheckFailedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConditionalCheckFailedException) String

String returns the string representation

type CreateGlobalSecondaryIndexAction

type CreateGlobalSecondaryIndexAction struct {
	IndexName             *string                `min:"3" type:"string" required:"true"`
	KeySchema             []*KeySchemaElement    `min:"1" type:"list" required:"true"`
	Projection            *Projection            `type:"structure" required:"true"`
	ProvisionedThroughput *ProvisionedThroughput `type:"structure"`
	// contains filtered or unexported fields
}

Represents a new global secondary index to be added to an existing table.

type CreateTableInput

type CreateTableInput struct {
	ProvisionedThroughput *ProvisionedThroughput `type:"structure"`
	KeySchema             []*KeySchemaElement    `min:"1" type:"list" required:"true"`
}

type DeleteGlobalSecondaryIndexAction

type DeleteGlobalSecondaryIndexAction struct {
	IndexName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a global secondary index to be deleted from an existing table.

type DeleteItemInput

type DeleteItemInput struct {
	ConditionExpression         *string                            `type:"string"`
	ConditionalOperator         *string                            `type:"string" enum:"ConditionalOperator"`
	Expected                    map[string]*ExpectedAttributeValue `type:"map"`
	ExpressionAttributeNames    map[string]*string                 `type:"map"`
	ExpressionAttributeValues   map[string]*Item                   `type:"map"`
	Key                         map[string]*Item                   `type:"map" required:"true"`
	ReturnConsumedCapacity      *string                            `type:"string" enum:"ReturnConsumedCapacity"`
	ReturnItemCollectionMetrics *string                            `type:"string" enum:"ReturnItemCollectionMetrics"`
	ReturnValues                *string                            `type:"string" enum:"ReturnValue"`
	TableName                   *string                            `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a DeleteItem operation.

type Error

type Error interface {
	error

	Code() string
	Message() string
	OrigErr() error
}

An Error wraps lower level errors with code, message and an original error. The underlying concrete error type may also satisfy other interfaces which can be to used to obtain more specific information about the error.

func NewError

func NewError(code, message string, origErr error) Error

NewError returns an Error object described by the code, message, and origErr. If origErr satisfies the Error interface it will not be wrapped within a new Error object and will instead be returned.

type ExpectedAttributeValue

type ExpectedAttributeValue struct {
	AttributeValueList []*Item `type:"list"`
	ComparisonOperator *string `type:"string" enum:"ComparisonOperator"`
	Exists             *bool   `type:"boolean"`
	Value              *Item   `type:"structure"`
	// contains filtered or unexported fields
}

type GlobalSecondaryIndex

type GlobalSecondaryIndex struct {
	IndexName             *string                `min:"3" type:"string" required:"true"`
	KeySchema             []*KeySchemaElement    `min:"1" type:"list" required:"true"`
	Projection            *Projection            `type:"structure" required:"true"`
	ProvisionedThroughput *ProvisionedThroughput `type:"structure"`
	// contains filtered or unexported fields
}

Represents the properties of a global secondary index.

type GlobalSecondaryIndexDescription

type GlobalSecondaryIndexDescription struct {
	Backfilling    *bool              `type:"boolean"`
	IndexArn       *string            `type:"string"`
	IndexName      *string            `min:"3" type:"string"`
	IndexSizeBytes *int64             `type:"long"`
	IndexStatus    *string            `type:"string" enum:"IndexStatus"`
	ItemCount      int64              `type:"long"`
	KeySchema      []KeySchemaElement `min:"1" type:"list"`
	Projection     *Projection        `type:"structure"`
	// contains filtered or unexported fields
}

Represents the properties of a global secondary index.

type GlobalSecondaryIndexUpdate

type GlobalSecondaryIndexUpdate struct {
	Create *CreateGlobalSecondaryIndexAction `type:"structure"`
	Delete *DeleteGlobalSecondaryIndexAction `type:"structure"`
	Update *UpdateGlobalSecondaryIndexAction `type:"structure"`
	// contains filtered or unexported fields
}

type Item

type Item struct {

	// An attribute of type Binary. For example:
	//
	// "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
	// B is automatically base64 encoded/decoded by the SDK.
	B []byte `type:"blob"`

	// An attribute of type Boolean. For example:
	//
	// "BOOL": true
	BOOL *bool `type:"boolean"`

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

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

	// An attribute of type Map. For example:
	//
	// "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}
	M map[string]*Item `type:"map"`

	// 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.
	N *string `type:"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.
	NS []*string `type:"list"`

	// An attribute of type Null. For example:
	//
	// "NULL": true
	NULL *bool `type:"boolean"`

	// An attribute of type String. For example:
	//
	// "S": "Hello"
	S *string `type:"string"`

	// An attribute of type String Set. For example:
	//
	// "SS": ["Giraffe", "Hippo" ,"Zebra"]
	SS []*string `type:"list"`
	// contains filtered or unexported fields
}

type KeySchemaElement

type KeySchemaElement struct {
	AttributeName string `min:"1" type:"string" required:"true"`
	KeyType       string `type:"string" required:"true" enum:"KeyType"`
	// contains filtered or unexported fields
}

type LocalSecondaryIndex

type LocalSecondaryIndex struct {
	IndexName  *string             `min:"3" type:"string" required:"true"`
	KeySchema  []*KeySchemaElement `min:"1" type:"list" required:"true"`
	Projection *Projection         `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the properties of a local secondary index.

type LocalSecondaryIndexDescription

type LocalSecondaryIndexDescription struct {
	IndexArn       *string            `type:"string"`
	IndexName      *string            `min:"3" type:"string"`
	IndexSizeBytes *int64             `type:"long"`
	ItemCount      int64              `type:"long"`
	KeySchema      []KeySchemaElement `min:"1" type:"list"`
	Projection     *Projection        `type:"structure"`
	// contains filtered or unexported fields
}

Represents the properties of a local secondary index.

type Projection

type Projection struct {
	NonKeyAttributes []*string `min:"1" type:"list"`
	ProjectionType   *string   `type:"string" enum:"ProjectionType"`
	// contains filtered or unexported fields
}

type ProvisionedThroughput

type ProvisionedThroughput struct {
	ReadCapacityUnits  int64 `min:"1" type:"long" required:"true"`
	WriteCapacityUnits int64 `min:"1" type:"long" required:"true"`
	// contains filtered or unexported fields
}

type PutItemInput

type PutItemInput struct {
	ConditionExpression         *string           `type:"string"`
	ConditionalOperator         *string           `type:"string" enum:"ConditionalOperator"`
	ExpressionAttributeNames    map[string]string `type:"map"`
	ExpressionAttributeValues   map[string]*Item  `type:"map"`
	Item                        map[string]*Item  `type:"map" required:"true"`
	ReturnConsumedCapacity      *string           `type:"string" enum:"ReturnConsumedCapacity"`
	ReturnItemCollectionMetrics *string           `type:"string" enum:"ReturnItemCollectionMetrics"`
	ReturnValues                *string           `type:"string" enum:"ReturnValue"`
	TableName                   *string           `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a PutItem operation.

type RequestFailure

type RequestFailure interface {
	Error
	StatusCode() int
	RequestID() string
}

A RequestFailure is an interface to extract request failure information from an Error such as the request ID of the failed request returned by a service. RequestFailures may not always have a requestID value if the request failed prior to reaching the service such as a connection error.

func NewRequestFailure

func NewRequestFailure(err Error, statusCode int, reqID string) RequestFailure

NewRequestFailure returns a wrapped error with additional information for request status code, and service requestID.

type TableDescription

type TableDescription struct {
	GlobalSecondaryIndexes []GlobalSecondaryIndexDescription `type:"list"`
	GlobalTableVersion     string                            `type:"string"`
	ItemCount              int64                             `type:"long"`
	KeySchema              []KeySchemaElement                `min:"1" type:"list"`
	LatestStreamArn        string                            `min:"37" type:"string"`
	LatestStreamLabel      string                            `type:"string"`
	LocalSecondaryIndexes  []LocalSecondaryIndexDescription  `type:"list"`
	TableArn               string                            `type:"string"`
	TableId                string                            `type:"string"`
	TableName              string                            `min:"3" type:"string"`
	TableSizeBytes         int64                             `type:"long"`
	TableStatus            string                            `type:"string" enum:"TableStatus"`
	// contains filtered or unexported fields
}

Represents the properties of a table.

type UnmarshalError

type UnmarshalError interface {
	Bytes() []byte
	// contains filtered or unexported methods
}

UnmarshalError provides the interface for the SDK failing to unmarshal data.

type UpdateGlobalSecondaryIndexAction

type UpdateGlobalSecondaryIndexAction struct {
	IndexName             *string                `min:"3" type:"string" required:"true"`
	ProvisionedThroughput *ProvisionedThroughput `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the new provisioned throughput settings to be applied to a global secondary index.

type UpdateItemInput

type UpdateItemInput struct {
	AttributeUpdates            map[string]*AttributeValueUpdate   `type:"map"`
	ConditionExpression         *string                            `type:"string"`
	ConditionalOperator         *string                            `type:"string" enum:"ConditionalOperator"`
	Expected                    map[string]*ExpectedAttributeValue `type:"map"`
	ExpressionAttributeNames    map[string]string                  `type:"map"`
	ExpressionAttributeValues   map[string]*Item                   `type:"map"`
	Key                         map[string]*Item                   `type:"map" required:"true"`
	ReturnConsumedCapacity      *string                            `type:"string" enum:"ReturnConsumedCapacity"`
	ReturnItemCollectionMetrics *string                            `type:"string" enum:"ReturnItemCollectionMetrics"`
	ReturnValues                *string                            `type:"string" enum:"ReturnValue"`
	TableName                   *string                            `min:"3" type:"string" required:"true"`
	UpdateExpression            string                             `type:"string"`
	// contains filtered or unexported fields
}

Represents the input of an UpdateItem operation.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL