types

package
v1.4.8 Latest Latest
Warning

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

Go to latest
Published: Sep 26, 2025 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You don't have sufficient access permissions to perform this operation.

This exception occurs when your IAM user or role lacks the required permissions to access the Amazon Keyspaces resource or perform the requested action. Check your IAM policies and ensure they grant the necessary permissions.

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

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

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

type InternalServerException

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The Amazon Keyspaces service encountered an unexpected error while processing the request.

This internal server error is not related to your request parameters. Retry your request after a brief delay. If the issue persists, contact Amazon Web Services Support with details of your request to help identify and resolve the problem.

func (*InternalServerException) Error

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault

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

func (*InternalServerException) ErrorMessage

func (e *InternalServerException) ErrorMessage() string

type KeyspacesCell

type KeyspacesCell struct {

	// Metadata associated with this cell, such as time-to-live (TTL) expiration time
	// and write timestamp.
	Metadata *KeyspacesMetadata

	// The value stored in this cell, which can be of various data types supported by
	// Amazon Keyspaces.
	Value KeyspacesCellValue
	// contains filtered or unexported fields
}

Represents a cell in an Amazon Keyspaces table, containing both the value and metadata about the cell.

type KeyspacesCellMapDefinition

type KeyspacesCellMapDefinition struct {

	// The key of this map entry in the Amazon Keyspaces cell.
	Key KeyspacesCellValue

	// Metadata for this specific key-value pair within the map, such as timestamps
	// and TTL information.
	Metadata *KeyspacesMetadata

	// The value associated with the key in this map entry.
	Value KeyspacesCellValue
	// contains filtered or unexported fields
}

Represents a key-value pair within a map data type in Amazon Keyspaces, including the associated metadata.

type KeyspacesCellValue

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

Represents the value of a cell in an Amazon Keyspaces table, supporting various data types with type-specific fields.

The following types satisfy this interface:

KeyspacesCellValueMemberAsciiT
KeyspacesCellValueMemberBigintT
KeyspacesCellValueMemberBlobT
KeyspacesCellValueMemberBoolT
KeyspacesCellValueMemberCounterT
KeyspacesCellValueMemberDateT
KeyspacesCellValueMemberDecimalT
KeyspacesCellValueMemberDoubleT
KeyspacesCellValueMemberFloatT
KeyspacesCellValueMemberInetT
KeyspacesCellValueMemberIntT
KeyspacesCellValueMemberListT
KeyspacesCellValueMemberMapT
KeyspacesCellValueMemberSetT
KeyspacesCellValueMemberSmallintT
KeyspacesCellValueMemberTextT
KeyspacesCellValueMemberTimestampT
KeyspacesCellValueMemberTimeT
KeyspacesCellValueMemberTimeuuidT
KeyspacesCellValueMemberTinyintT
KeyspacesCellValueMemberTupleT
KeyspacesCellValueMemberUdtT
KeyspacesCellValueMemberUuidT
KeyspacesCellValueMemberVarcharT
KeyspacesCellValueMemberVarintT
Example (OutputUsage)
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/keyspacesstreams/types"
)

func main() {
	var union types.KeyspacesCellValue
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.KeyspacesCellValueMemberAsciiT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberBigintT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberBlobT:
		_ = v.Value // Value is []byte

	case *types.KeyspacesCellValueMemberBoolT:
		_ = v.Value // Value is bool

	case *types.KeyspacesCellValueMemberCounterT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberDateT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberDecimalT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberDoubleT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberFloatT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberInetT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberIntT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberListT:
		_ = v.Value // Value is []types.KeyspacesCell

	case *types.KeyspacesCellValueMemberMapT:
		_ = v.Value // Value is []types.KeyspacesCellMapDefinition

	case *types.KeyspacesCellValueMemberSetT:
		_ = v.Value // Value is []types.KeyspacesCell

	case *types.KeyspacesCellValueMemberSmallintT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberTextT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberTimestampT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberTimeT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberTimeuuidT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberTinyintT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberTupleT:
		_ = v.Value // Value is []types.KeyspacesCell

	case *types.KeyspacesCellValueMemberUdtT:
		_ = v.Value // Value is map[string]types.KeyspacesCell

	case *types.KeyspacesCellValueMemberUuidT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberVarcharT:
		_ = v.Value // Value is string

	case *types.KeyspacesCellValueMemberVarintT:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

var _ map[string]types.KeyspacesCell
var _ []types.KeyspacesCell
var _ *string
var _ *bool
var _ []types.KeyspacesCellMapDefinition
var _ []byte

type KeyspacesCellValueMemberAsciiT

type KeyspacesCellValueMemberAsciiT struct {
	Value string
	// contains filtered or unexported fields
}

A value of ASCII text type, containing US-ASCII characters.

type KeyspacesCellValueMemberBigintT

type KeyspacesCellValueMemberBigintT struct {
	Value string
	// contains filtered or unexported fields
}

A 64-bit signed integer value.

type KeyspacesCellValueMemberBlobT

type KeyspacesCellValueMemberBlobT struct {
	Value []byte
	// contains filtered or unexported fields
}

A binary large object (BLOB) value stored as a Base64-encoded string.

type KeyspacesCellValueMemberBoolT

type KeyspacesCellValueMemberBoolT struct {
	Value bool
	// contains filtered or unexported fields
}

A Boolean value, either true or false .

type KeyspacesCellValueMemberCounterT

type KeyspacesCellValueMemberCounterT struct {
	Value string
	// contains filtered or unexported fields
}

A distributed counter value that can be incremented and decremented.

type KeyspacesCellValueMemberDateT

type KeyspacesCellValueMemberDateT struct {
	Value string
	// contains filtered or unexported fields
}

A date value without a time component, represented as days since epoch (January 1, 1970).

type KeyspacesCellValueMemberDecimalT

type KeyspacesCellValueMemberDecimalT struct {
	Value string
	// contains filtered or unexported fields
}

A variable-precision decimal number value.

type KeyspacesCellValueMemberDoubleT

type KeyspacesCellValueMemberDoubleT struct {
	Value string
	// contains filtered or unexported fields
}

A 64-bit double-precision floating point value.

type KeyspacesCellValueMemberFloatT

type KeyspacesCellValueMemberFloatT struct {
	Value string
	// contains filtered or unexported fields
}

A 32-bit single-precision floating point value.

type KeyspacesCellValueMemberInetT

type KeyspacesCellValueMemberInetT struct {
	Value string
	// contains filtered or unexported fields
}

An IP address value, either IPv4 or IPv6 format.

type KeyspacesCellValueMemberIntT

type KeyspacesCellValueMemberIntT struct {
	Value string
	// contains filtered or unexported fields
}

A 32-bit signed integer value.

type KeyspacesCellValueMemberListT

type KeyspacesCellValueMemberListT struct {
	Value []KeyspacesCell
	// contains filtered or unexported fields
}

An ordered collection of elements that can contain duplicate values.

type KeyspacesCellValueMemberMapT

type KeyspacesCellValueMemberMapT struct {
	Value []KeyspacesCellMapDefinition
	// contains filtered or unexported fields
}

A collection of key-value pairs where each key is unique.

type KeyspacesCellValueMemberSetT

type KeyspacesCellValueMemberSetT struct {
	Value []KeyspacesCell
	// contains filtered or unexported fields
}

An unordered collection of unique elements.

type KeyspacesCellValueMemberSmallintT

type KeyspacesCellValueMemberSmallintT struct {
	Value string
	// contains filtered or unexported fields
}

A 16-bit signed integer value.

type KeyspacesCellValueMemberTextT

type KeyspacesCellValueMemberTextT struct {
	Value string
	// contains filtered or unexported fields
}

A UTF-8 encoded string value.

type KeyspacesCellValueMemberTimeT

type KeyspacesCellValueMemberTimeT struct {
	Value string
	// contains filtered or unexported fields
}

A time value without a date component, with nanosecond precision.

type KeyspacesCellValueMemberTimestampT

type KeyspacesCellValueMemberTimestampT struct {
	Value string
	// contains filtered or unexported fields
}

A timestamp value representing date and time with millisecond precision.

type KeyspacesCellValueMemberTimeuuidT

type KeyspacesCellValueMemberTimeuuidT struct {
	Value string
	// contains filtered or unexported fields
}

A universally unique identifier (UUID) that includes a timestamp component, ensuring both uniqueness and time ordering.

type KeyspacesCellValueMemberTinyintT

type KeyspacesCellValueMemberTinyintT struct {
	Value string
	// contains filtered or unexported fields
}

An 8-bit signed integer value.

type KeyspacesCellValueMemberTupleT

type KeyspacesCellValueMemberTupleT struct {
	Value []KeyspacesCell
	// contains filtered or unexported fields
}

A fixed-length ordered list of elements, where each element can be of a different data type.

type KeyspacesCellValueMemberUdtT

type KeyspacesCellValueMemberUdtT struct {
	Value map[string]KeyspacesCell
	// contains filtered or unexported fields
}

A user-defined type (UDT) value consisting of named fields, each with its own data type.

type KeyspacesCellValueMemberUuidT

type KeyspacesCellValueMemberUuidT struct {
	Value string
	// contains filtered or unexported fields
}

A universally unique identifier (UUID) value.

type KeyspacesCellValueMemberVarcharT

type KeyspacesCellValueMemberVarcharT struct {
	Value string
	// contains filtered or unexported fields
}

A UTF-8 encoded string value, functionally equivalent to text type.

type KeyspacesCellValueMemberVarintT

type KeyspacesCellValueMemberVarintT struct {
	Value string
	// contains filtered or unexported fields
}

A variable precision integer value with arbitrary length.

type KeyspacesMetadata

type KeyspacesMetadata struct {

	// The time at which the associated data will expire, based on the time-to-live
	// (TTL) setting.
	ExpirationTime *string

	// The timestamp at which the associated data was written to the database.
	WriteTime *string
	// contains filtered or unexported fields
}

Contains metadata information associated with Amazon Keyspaces cells and rows.

type KeyspacesRow

type KeyspacesRow struct {

	// Metadata that applies to the entire row, such as timestamps and TTL information.
	RowMetadata *KeyspacesMetadata

	// A map of static column cells shared by all rows with the same partition key,
	// where keys are column names and values are the corresponding cells.
	StaticCells map[string]KeyspacesCell

	// A map of regular (non-static) column cells in the row, where keys are column
	// names and values are the corresponding cells.
	ValueCells map[string]KeyspacesCell
	// contains filtered or unexported fields
}

Represents a row in an Amazon Keyspaces table, containing regular column values, static column values, and row-level metadata.

type OriginType

type OriginType string
const (
	OriginTypeUser        OriginType = "USER"
	OriginTypeReplication OriginType = "REPLICATION"
	OriginTypeTtl         OriginType = "TTL"
)

Enum values for OriginType

func (OriginType) Values

func (OriginType) Values() []OriginType

Values returns all known values for OriginType. 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 clustering key columns and their values for the affected row, which
	// determine the order of rows within a partition.
	ClusteringKeys map[string]KeyspacesCellValue

	// The timestamp indicating when this change data capture record was created.
	CreatedAt *time.Time

	// The version of the record format, used to track the evolution of the record
	// structure over time.
	EventVersion *string

	// The state of the row after the change operation that generated this record.
	NewImage *KeyspacesRow

	// The state of the row before the change operation that generated this record.
	OldImage *KeyspacesRow

	// The origin or source of this change data capture record.
	Origin OriginType

	// The partition key columns and their values for the affected row.
	PartitionKeys map[string]KeyspacesCellValue

	// A unique identifier assigned to this record within the shard, used for ordering
	// and tracking purposes.
	SequenceNumber *string
	// contains filtered or unexported fields
}

Represents a change data capture record for a row in an Amazon Keyspaces table, containing both the new and old states of the row.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The requested resource doesn't exist or could not be found.

This exception occurs when you attempt to access a keyspace, table, stream, or other Amazon Keyspaces resource that doesn't exist or that has been deleted. Verify that the resource identifier is correct and that the resource exists in your account.

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 ending sequence number of the range, which may be null for open-ended
	// ranges.
	EndingSequenceNumber *string

	// The starting sequence number of the range.
	StartingSequenceNumber *string
	// contains filtered or unexported fields
}

Defines a range of sequence numbers within a change data capture stream's shard for Amazon Keyspaces.

type Shard

type Shard struct {

	// The identifiers of parent shards that this shard evolved from, if this shard
	// was created through resharding.
	ParentShardIds []string

	// The range of sequence numbers contained within this shard.
	SequenceNumberRange *SequenceNumberRange

	// A unique identifier for this shard within the stream.
	ShardId *string
	// contains filtered or unexported fields
}

Represents a uniquely identified group of change records within a change data capture stream for Amazon Keyspaces.

type ShardFilter

type ShardFilter struct {

	// The identifier of a specific shard used to filter results based on the
	// specified filter type.
	ShardId *string

	// The type of shard filter to use, which determines how the shardId parameter is
	// interpreted.
	Type ShardFilterType
	// contains filtered or unexported fields
}

A filter used to limit the shards returned by a GetStream operation.

type ShardFilterType

type ShardFilterType string
const (
	ShardFilterTypeChildShards ShardFilterType = "CHILD_SHARDS"
)

Enum values for ShardFilterType

func (ShardFilterType) Values

func (ShardFilterType) Values() []ShardFilterType

Values returns all known values for ShardFilterType. 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 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 name of the keyspace containing the table associated with this stream.
	//
	// This member is required.
	KeyspaceName *string

	// The Amazon Resource Name (ARN) that uniquely identifies this stream.
	//
	// This member is required.
	StreamArn *string

	// A unique identifier for this stream that can be used in stream operations.
	//
	// This member is required.
	StreamLabel *string

	// The name of the table associated with this stream.
	//
	// This member is required.
	TableName *string
	// contains filtered or unexported fields
}

Represents a change data capture stream for an Amazon Keyspaces table, which enables tracking and processing of data changes.

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 ThrottlingException

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request rate is too high and exceeds the service's throughput limits.

This exception occurs when you send too many requests in a short period of time. Implement exponential backoff in your retry strategy to handle this exception. Reducing your request frequency or distributing requests more evenly can help avoid throughput exceptions.

func (*ThrottlingException) Error

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault

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

func (*ThrottlingException) ErrorMessage

func (e *ThrottlingException) ErrorMessage() string

type UnknownUnionMember

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

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

type ValidationException

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	ErrorCode_ ValidationExceptionType
	// contains filtered or unexported fields
}

The request validation failed because one or more input parameters failed validation.

This exception occurs when there are syntax errors in the request, field constraints are violated, or required parameters are missing. To help you fix the issue, the exception message provides details about which parameter failed and why.

func (*ValidationException) Error

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault

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

func (*ValidationException) ErrorMessage

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionType

type ValidationExceptionType string
const (
	ValidationExceptionTypeInvalidFormat     ValidationExceptionType = "InvalidFormat"
	ValidationExceptionTypeTrimmedDataAccess ValidationExceptionType = "TrimmedDataAccess"
	ValidationExceptionTypeExpiredIterator   ValidationExceptionType = "ExpiredIterator"
	ValidationExceptionTypeExpiredNextToken  ValidationExceptionType = "ExpiredNextToken"
)

Enum values for ValidationExceptionType

func (ValidationExceptionType) Values

Values returns all known values for ValidationExceptionType. 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.

Jump to

Keyboard shortcuts

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