types

package
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Mar 14, 2023 License: Apache-2.0 Imports: 4 Imported by: 3

Documentation

Index

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 do not have sufficient access to perform this action.

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 CapacitySpecification 

type CapacitySpecification struct {

	// The read/write throughput capacity mode for a table. The options are:
	//
	// *
	// throughputMode:PAY_PER_REQUEST and
	//
	// * throughputMode:PROVISIONED - Provisioned
	// capacity mode requires readCapacityUnits and writeCapacityUnits as input.
	//
	// The
	// default is throughput_mode:PAY_PER_REQUEST. For more information, see Read/write
	// capacity modes
	// (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html)
	// in the Amazon Keyspaces Developer Guide.
	//
	// This member is required.
	ThroughputMode ThroughputMode

	// The throughput capacity specified for read operations defined in read capacity
	// units(RCUs).
	ReadCapacityUnits *int64

	// The throughput capacity specified for write operations defined in write capacity
	// units(WCUs).
	WriteCapacityUnits *int64
	// contains filtered or unexported fields
}

Amazon Keyspaces has two read/write capacity modes for processing reads and writes on your tables:

* On-demand (default)

* Provisioned

The read/write capacity mode that you choose controls how you are charged for read and write throughput and how table throughput capacity is managed. For more information, see Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) in the Amazon Keyspaces Developer Guide.

type CapacitySpecificationSummary 

type CapacitySpecificationSummary struct {

	// The read/write throughput capacity mode for a table. The options are:
	//
	// *
	// throughputMode:PAY_PER_REQUEST and
	//
	// * throughputMode:PROVISIONED - Provisioned
	// capacity mode requires readCapacityUnits and writeCapacityUnits as input.
	//
	// The
	// default is throughput_mode:PAY_PER_REQUEST. For more information, see Read/write
	// capacity modes
	// (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html)
	// in the Amazon Keyspaces Developer Guide.
	//
	// This member is required.
	ThroughputMode ThroughputMode

	// The timestamp of the last operation that changed the provisioned throughput
	// capacity of a table.
	LastUpdateToPayPerRequestTimestamp *time.Time

	// The throughput capacity specified for read operations defined in read capacity
	// units(RCUs).
	ReadCapacityUnits *int64

	// The throughput capacity specified for write operations defined in write capacity
	// units(WCUs).
	WriteCapacityUnits *int64
	// contains filtered or unexported fields
}

The read/write throughput capacity mode for a table. The options are:

* throughputMode:PAY_PER_REQUEST and

* throughputMode:PROVISIONED.

For more information, see Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html) in the Amazon Keyspaces Developer Guide.

type ClientSideTimestamps added in v1.2.0 

type ClientSideTimestamps struct {

	// Shows how to enable client-side timestamps settings for the specified table.
	//
	// This member is required.
	Status ClientSideTimestampsStatus
	// contains filtered or unexported fields
}

The client-side timestamp setting of the table. For more information, see How it works: Amazon Keyspaces client-side timestamps (https://docs.aws.amazon.com/keyspaces/latest/devguide/client-side-timestamps-how-it-works.html) in the Amazon Keyspaces Developer Guide.

type ClientSideTimestampsStatus added in v1.2.0 

type ClientSideTimestampsStatus string
const (
	ClientSideTimestampsStatusEnabled ClientSideTimestampsStatus = "ENABLED"
)

Enum values for ClientSideTimestampsStatus

func (ClientSideTimestampsStatus) Values added in v1.2.0 

func (ClientSideTimestampsStatus) Values() []ClientSideTimestampsStatus

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

type ClusteringKey struct {

	// The name(s) of the clustering column(s).
	//
	// This member is required.
	Name *string

	// Sets the ascendant (ASC) or descendant (DESC) order modifier.
	//
	// This member is required.
	OrderBy SortOrder
	// contains filtered or unexported fields
}

The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.

type ColumnDefinition 

type ColumnDefinition struct {

	// The name of the column.
	//
	// This member is required.
	Name *string

	// The data type of the column. For a list of available data types, see Data types
	// (https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types)
	// in the Amazon Keyspaces Developer Guide.
	//
	// This member is required.
	Type *string
	// contains filtered or unexported fields
}

The names and data types of regular columns.

type Comment 

type Comment struct {

	// An optional description of the table.
	//
	// This member is required.
	Message *string
	// contains filtered or unexported fields
}

An optional comment that describes the table.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Amazon Keyspaces could not complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

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

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type EncryptionSpecification 

type EncryptionSpecification struct {

	// The encryption option specified for the table. You can choose one of the
	// following KMS keys (KMS keys):
	//
	// * type:AWS_OWNED_KMS_KEY - This key is owned by
	// Amazon Keyspaces.
	//
	// * type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your
	// account and is created, owned, and managed by you. This option requires the
	// kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as
	// input.
	//
	// The default is type:AWS_OWNED_KMS_KEY. For more information, see
	// Encryption at rest
	// (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) in
	// the Amazon Keyspaces Developer Guide.
	//
	// This member is required.
	Type EncryptionType

	// The Amazon Resource Name (ARN) of the customer managed KMS key, for example
	// kms_key_identifier:ARN.
	KmsKeyIdentifier *string
	// contains filtered or unexported fields
}

Amazon Keyspaces encrypts and decrypts the table data at rest transparently and integrates with Key Management Service for storing and managing the encryption key. You can choose one of the following KMS keys (KMS keys):

* Amazon Web Services owned key - This is the default encryption type. The key is owned by Amazon Keyspaces (no additional charge).

* Customer managed key - This key is stored in your account and is created, owned, and managed by you. You have full control over the customer managed key (KMS charges apply).

For more information about encryption at rest in Amazon Keyspaces, see Encryption at rest (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) in the Amazon Keyspaces Developer Guide. For more information about KMS, see KMS management service concepts (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html) in the Key Management Service Developer Guide.

type EncryptionType 

type EncryptionType string
const (
	EncryptionTypeCustomerManagedKmsKey EncryptionType = "CUSTOMER_MANAGED_KMS_KEY"
	EncryptionTypeAwsOwnedKmsKey        EncryptionType = "AWS_OWNED_KMS_KEY"
)

Enum values for EncryptionType

func (EncryptionType) Values 

func (EncryptionType) Values() []EncryptionType

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

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Amazon Keyspaces was unable to fully process this request because of an internal server error.

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 KeyspaceSummary 

type KeyspaceSummary struct {

	// The name of the keyspace.
	//
	// This member is required.
	KeyspaceName *string

	// The unique identifier of the keyspace in the format of an Amazon Resource Name
	// (ARN).
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

Represents the properties of a keyspace.

type PartitionKey 

type PartitionKey struct {

	// The name(s) of the partition key column(s).
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

The partition key portion of the primary key is required and determines how Amazon Keyspaces stores the data. The partition key can be a single column, or it can be a compound value composed of two or more columns.

type PointInTimeRecovery 

type PointInTimeRecovery struct {

	// The options are:
	//
	// * status=ENABLED
	//
	// * status=DISABLED
	//
	// This member is required.
	Status PointInTimeRecoveryStatus
	// contains filtered or unexported fields
}

Point-in-time recovery (PITR) helps protect your Amazon Keyspaces tables from accidental write or delete operations by providing you continuous backups of your table data. For more information, see Point-in-time recovery (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html) in the Amazon Keyspaces Developer Guide.

type PointInTimeRecoveryStatus 

type PointInTimeRecoveryStatus string
const (
	PointInTimeRecoveryStatusEnabled  PointInTimeRecoveryStatus = "ENABLED"
	PointInTimeRecoveryStatusDisabled PointInTimeRecoveryStatus = "DISABLED"
)

Enum values for PointInTimeRecoveryStatus

func (PointInTimeRecoveryStatus) Values 

func (PointInTimeRecoveryStatus) Values() []PointInTimeRecoveryStatus

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

type PointInTimeRecoverySummary struct {

	// Shows if point-in-time recovery is enabled or disabled for the specified table.
	//
	// This member is required.
	Status PointInTimeRecoveryStatus

	// Specifies the earliest possible restore point of the table in ISO 8601 format.
	EarliestRestorableTimestamp *time.Time
	// contains filtered or unexported fields
}

The point-in-time recovery status of the specified table.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceArn *string
	// contains filtered or unexported fields
}

The operation tried to access a keyspace or table that doesn't exist. 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 (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type SchemaDefinition 

type SchemaDefinition struct {

	// The regular columns of the table.
	//
	// This member is required.
	AllColumns []ColumnDefinition

	// The columns that are part of the partition key of the table .
	//
	// This member is required.
	PartitionKeys []PartitionKey

	// The columns that are part of the clustering key of the table.
	ClusteringKeys []ClusteringKey

	// The columns that have been defined as STATIC. Static columns store values that
	// are shared by all rows in the same partition.
	StaticColumns []StaticColumn
	// contains filtered or unexported fields
}

Describes the schema of the table.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas (https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html) in the Amazon Keyspaces Developer Guide.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

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

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type SortOrder 

type SortOrder string
const (
	SortOrderAsc  SortOrder = "ASC"
	SortOrderDesc SortOrder = "DESC"
)

Enum values for SortOrder

func (SortOrder) Values 

func (SortOrder) Values() []SortOrder

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

type StaticColumn struct {

	// The name of the static column.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

The static columns of the table. Static columns store values that are shared by all rows in the same partition.

type TableStatus 

type TableStatus string
const (
	TableStatusActive                            TableStatus = "ACTIVE"
	TableStatusCreating                          TableStatus = "CREATING"
	TableStatusUpdating                          TableStatus = "UPDATING"
	TableStatusDeleting                          TableStatus = "DELETING"
	TableStatusDeleted                           TableStatus = "DELETED"
	TableStatusRestoring                         TableStatus = "RESTORING"
	TableStatusInaccessibleEncryptionCredentials TableStatus = "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
)

Enum values for TableStatus

func (TableStatus) Values 

func (TableStatus) Values() []TableStatus

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

type TableSummary struct {

	// The name of the keyspace that the table is stored in.
	//
	// This member is required.
	KeyspaceName *string

	// The unique identifier of the table in the format of an Amazon Resource Name
	// (ARN).
	//
	// This member is required.
	ResourceArn *string

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

Returns the name of the specified table, the keyspace it is stored in, and the unique identifier in the format of an Amazon Resource Name (ARN).

type Tag 

type Tag struct {

	// The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource
	// can only have up to one tag with the same key. If you try to add an existing tag
	// (same key), the existing tag value will be updated to the new value.
	//
	// This member is required.
	Key *string

	// The value of the tag. Tag values are case-sensitive and can be null.
	//
	// This member is required.
	Value *string
	// contains filtered or unexported fields
}

Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource. Amazon Web Services-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag. For more information, see Adding tags and labels to Amazon Keyspaces resources (https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html) in the Amazon Keyspaces Developer Guide.

type ThroughputMode 

type ThroughputMode string
const (
	ThroughputModePayPerRequest ThroughputMode = "PAY_PER_REQUEST"
	ThroughputModeProvisioned   ThroughputMode = "PROVISIONED"
)

Enum values for ThroughputMode

func (ThroughputMode) Values 

func (ThroughputMode) Values() []ThroughputMode

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

type TimeToLive struct {

	// Shows how to enable custom Time to Live (TTL) settings for the specified table.
	//
	// This member is required.
	Status TimeToLiveStatus
	// contains filtered or unexported fields
}

Enable custom Time to Live (TTL) settings for rows and columns without setting a TTL default for the specified table. For more information, see Enabling TTL on tables (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_enabling) in the Amazon Keyspaces Developer Guide.

type TimeToLiveStatus 

type TimeToLiveStatus string
const (
	TimeToLiveStatusEnabled TimeToLiveStatus = "ENABLED"
)

Enum values for TimeToLiveStatus

func (TimeToLiveStatus) Values 

func (TimeToLiveStatus) Values() []TimeToLiveStatus

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

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The operation failed due to an invalid or malformed request.

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.