keyspaces

package
v0.0.0-...-5458e1c Latest Latest
Warning

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

 Go to latest Published: Nov 22, 2024 License: Apache-2.0, Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package keyspaces provides the client and types for making API requests to Amazon Keyspaces.

Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate, run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software.

In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI, as well as infrastructure as code (IaC) services and tools such as CloudFormation and Terraform. This API reference describes the supported DDL operations in detail.

For the list of all supported CQL APIs, see Supported Cassandra APIs, operations, and data types in Amazon Keyspaces (https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html) in the Amazon Keyspaces Developer Guide.

To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see Amazon Keyspaces information in CloudTrail (https://docs.aws.amazon.com/keyspaces/latest/devguide/logging-using-cloudtrail.html#service-name-info-in-cloudtrail) in the Amazon Keyspaces Developer Guide.

For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see Amazon Web Services APIs (https://docs.aws.amazon.com/general/latest/gr/aws-apis.html) in the General Reference.

See https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10 for more information on this service.

See keyspaces package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/keyspaces/

Using the Client

To contact Amazon Keyspaces with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Keyspaces client Keyspaces for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/keyspaces/#New

Index

Constants

View Source 
const (
	// EncryptionTypeCustomerManagedKmsKey is a EncryptionType enum value
	EncryptionTypeCustomerManagedKmsKey = "CUSTOMER_MANAGED_KMS_KEY"

	// EncryptionTypeAwsOwnedKmsKey is a EncryptionType enum value
	EncryptionTypeAwsOwnedKmsKey = "AWS_OWNED_KMS_KEY"
)
View Source 
const (
	// PointInTimeRecoveryStatusEnabled is a PointInTimeRecoveryStatus enum value
	PointInTimeRecoveryStatusEnabled = "ENABLED"

	// PointInTimeRecoveryStatusDisabled is a PointInTimeRecoveryStatus enum value
	PointInTimeRecoveryStatusDisabled = "DISABLED"
)
View Source 
const (
	// RsSingleRegion is a Rs enum value
	RsSingleRegion = "SINGLE_REGION"

	// RsMultiRegion is a Rs enum value
	RsMultiRegion = "MULTI_REGION"
)
View Source 
const (
	// SortOrderAsc is a SortOrder enum value
	SortOrderAsc = "ASC"

	// SortOrderDesc is a SortOrder enum value
	SortOrderDesc = "DESC"
)
View Source 
const (
	// TableStatusActive is a TableStatus enum value
	TableStatusActive = "ACTIVE"

	// TableStatusCreating is a TableStatus enum value
	TableStatusCreating = "CREATING"

	// TableStatusUpdating is a TableStatus enum value
	TableStatusUpdating = "UPDATING"

	// TableStatusDeleting is a TableStatus enum value
	TableStatusDeleting = "DELETING"

	// TableStatusDeleted is a TableStatus enum value
	TableStatusDeleted = "DELETED"

	// TableStatusRestoring is a TableStatus enum value
	TableStatusRestoring = "RESTORING"

	// TableStatusInaccessibleEncryptionCredentials is a TableStatus enum value
	TableStatusInaccessibleEncryptionCredentials = "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
)
View Source 
const (
	// ThroughputModePayPerRequest is a ThroughputMode enum value
	ThroughputModePayPerRequest = "PAY_PER_REQUEST"

	// ThroughputModeProvisioned is a ThroughputMode enum value
	ThroughputModeProvisioned = "PROVISIONED"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// 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.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// Amazon Keyspaces was unable to fully process this request because of an internal
	// server error.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// 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.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// 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.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The operation failed due to an invalid or malformed request.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "Keyspaces" // Name of service.
	EndpointsID = "cassandra" // ID to lookup a service endpoint with.
	ServiceID   = "Keyspaces" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// ClientSideTimestampsStatusEnabled is a ClientSideTimestampsStatus enum value
	ClientSideTimestampsStatusEnabled = "ENABLED"
)
View Source 
const (
	// TimeToLiveStatusEnabled is a TimeToLiveStatus enum value
	TimeToLiveStatusEnabled = "ENABLED"
)

Variables

This section is empty.

Functions

func ClientSideTimestampsStatus_Values 

func ClientSideTimestampsStatus_Values() []string

ClientSideTimestampsStatus_Values returns all elements of the ClientSideTimestampsStatus enum

func EncryptionType_Values 

func EncryptionType_Values() []string

EncryptionType_Values returns all elements of the EncryptionType enum

func PointInTimeRecoveryStatus_Values 

func PointInTimeRecoveryStatus_Values() []string

PointInTimeRecoveryStatus_Values returns all elements of the PointInTimeRecoveryStatus enum

func Rs_Values 

func Rs_Values() []string

Rs_Values returns all elements of the Rs enum

func SortOrder_Values 

func SortOrder_Values() []string

SortOrder_Values returns all elements of the SortOrder enum

func TableStatus_Values 

func TableStatus_Values() []string

TableStatus_Values returns all elements of the TableStatus enum

func ThroughputMode_Values 

func ThroughputMode_Values() []string

ThroughputMode_Values returns all elements of the ThroughputMode enum

func TimeToLiveStatus_Values 

func TimeToLiveStatus_Values() []string

TimeToLiveStatus_Values returns all elements of the TimeToLiveStatus enum

Types

type AccessDeniedException 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

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

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CapacitySpecification 

type CapacitySpecification struct {

	// The throughput capacity specified for read operations defined in read capacity
	// units (RCUs).
	ReadCapacityUnits *int64 `locationName:"readCapacityUnits" min:"1" type:"long"`

	// 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.
	//
	// ThroughputMode is a required field
	ThroughputMode *string `locationName:"throughputMode" type:"string" required:"true" enum:"ThroughputMode"`

	// The throughput capacity specified for write operations defined in write capacity
	// units (WCUs).
	WriteCapacityUnits *int64 `locationName:"writeCapacityUnits" min:"1" type:"long"`
	// 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.

func (CapacitySpecification) GoString 

func (s CapacitySpecification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacitySpecification) SetReadCapacityUnits 

func (s *CapacitySpecification) SetReadCapacityUnits(v int64) *CapacitySpecification

SetReadCapacityUnits sets the ReadCapacityUnits field's value.

func (*CapacitySpecification) SetThroughputMode 

func (s *CapacitySpecification) SetThroughputMode(v string) *CapacitySpecification

SetThroughputMode sets the ThroughputMode field's value.

func (*CapacitySpecification) SetWriteCapacityUnits 

func (s *CapacitySpecification) SetWriteCapacityUnits(v int64) *CapacitySpecification

SetWriteCapacityUnits sets the WriteCapacityUnits field's value.

func (CapacitySpecification) String 

func (s CapacitySpecification) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacitySpecification) Validate 

func (s *CapacitySpecification) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CapacitySpecificationSummary 

type CapacitySpecificationSummary struct {

	// The timestamp of the last operation that changed the provisioned throughput
	// capacity of a table.
	LastUpdateToPayPerRequestTimestamp *time.Time `locationName:"lastUpdateToPayPerRequestTimestamp" type:"timestamp"`

	// The throughput capacity specified for read operations defined in read capacity
	// units (RCUs).
	ReadCapacityUnits *int64 `locationName:"readCapacityUnits" min:"1" type:"long"`

	// 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.
	//
	// ThroughputMode is a required field
	ThroughputMode *string `locationName:"throughputMode" type:"string" required:"true" enum:"ThroughputMode"`

	// The throughput capacity specified for write operations defined in write capacity
	// units (WCUs).
	WriteCapacityUnits *int64 `locationName:"writeCapacityUnits" min:"1" type:"long"`
	// 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.

func (CapacitySpecificationSummary) GoString 

func (s CapacitySpecificationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacitySpecificationSummary) SetLastUpdateToPayPerRequestTimestamp 

func (s *CapacitySpecificationSummary) SetLastUpdateToPayPerRequestTimestamp(v time.Time) *CapacitySpecificationSummary

SetLastUpdateToPayPerRequestTimestamp sets the LastUpdateToPayPerRequestTimestamp field's value.

func (*CapacitySpecificationSummary) SetReadCapacityUnits 

func (s *CapacitySpecificationSummary) SetReadCapacityUnits(v int64) *CapacitySpecificationSummary

SetReadCapacityUnits sets the ReadCapacityUnits field's value.

func (*CapacitySpecificationSummary) SetThroughputMode 

func (s *CapacitySpecificationSummary) SetThroughputMode(v string) *CapacitySpecificationSummary

SetThroughputMode sets the ThroughputMode field's value.

func (*CapacitySpecificationSummary) SetWriteCapacityUnits 

func (s *CapacitySpecificationSummary) SetWriteCapacityUnits(v int64) *CapacitySpecificationSummary

SetWriteCapacityUnits sets the WriteCapacityUnits field's value.

func (CapacitySpecificationSummary) String 

func (s CapacitySpecificationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClientSideTimestamps 

type ClientSideTimestamps struct {

	// Shows how to enable client-side timestamps settings for the specified table.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"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.

func (ClientSideTimestamps) GoString 

func (s ClientSideTimestamps) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClientSideTimestamps) SetStatus 

func (s *ClientSideTimestamps) SetStatus(v string) *ClientSideTimestamps

SetStatus sets the Status field's value.

func (ClientSideTimestamps) String 

func (s ClientSideTimestamps) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClientSideTimestamps) Validate 

func (s *ClientSideTimestamps) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ClusteringKey 

type ClusteringKey struct {

	// The name(s) of the clustering column(s).
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// Sets the ascendant (ASC) or descendant (DESC) order modifier.
	//
	// OrderBy is a required field
	OrderBy *string `locationName:"orderBy" type:"string" required:"true" enum:"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.

func (ClusteringKey) GoString 

func (s ClusteringKey) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusteringKey) SetName 

func (s *ClusteringKey) SetName(v string) *ClusteringKey

SetName sets the Name field's value.

func (*ClusteringKey) SetOrderBy 

func (s *ClusteringKey) SetOrderBy(v string) *ClusteringKey

SetOrderBy sets the OrderBy field's value.

func (ClusteringKey) String 

func (s ClusteringKey) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusteringKey) Validate 

func (s *ClusteringKey) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ColumnDefinition 

type ColumnDefinition struct {

	// The name of the column.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`

	// 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.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The names and data types of regular columns.

func (ColumnDefinition) GoString 

func (s ColumnDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ColumnDefinition) SetName 

func (s *ColumnDefinition) SetName(v string) *ColumnDefinition

SetName sets the Name field's value.

func (*ColumnDefinition) SetType 

func (s *ColumnDefinition) SetType(v string) *ColumnDefinition

SetType sets the Type field's value.

func (ColumnDefinition) String 

func (s ColumnDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ColumnDefinition) Validate 

func (s *ColumnDefinition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Comment 

type Comment struct {

	// An optional description of the table.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`
	// contains filtered or unexported fields
}

An optional comment that describes the table.

func (Comment) GoString 

func (s Comment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Comment) SetMessage 

func (s *Comment) SetMessage(v string) *Comment

SetMessage sets the Message field's value.

func (Comment) String 

func (s Comment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Comment) Validate 

func (s *Comment) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConflictException 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"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) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateKeyspaceInput 

type CreateKeyspaceInput struct {

	// The name of the keyspace to be created.
	//
	// KeyspaceName is a required field
	KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"`

	// The replication specification of the keyspace includes:
	//
	//    * replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION.
	//
	//    * regionList - if the replicationStrategy is MULTI_REGION, the regionList
	//    requires the current Region and at least one additional Amazon Web Services
	//    Region where the keyspace is going to be replicated in. The maximum number
	//    of supported replication Regions including the current Region is six.
	ReplicationSpecification *ReplicationSpecification `locationName:"replicationSpecification" type:"structure"`

	// A list of key-value pair tags to be attached to the keyspace.
	//
	// 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.
	Tags []*Tag `locationName:"tags" min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateKeyspaceInput) GoString 

func (s CreateKeyspaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateKeyspaceInput) SetKeyspaceName 

func (s *CreateKeyspaceInput) SetKeyspaceName(v string) *CreateKeyspaceInput

SetKeyspaceName sets the KeyspaceName field's value.

func (*CreateKeyspaceInput) SetReplicationSpecification 

func (s *CreateKeyspaceInput) SetReplicationSpecification(v *ReplicationSpecification) *CreateKeyspaceInput

SetReplicationSpecification sets the ReplicationSpecification field's value.

func (*CreateKeyspaceInput) SetTags 

func (s *CreateKeyspaceInput) SetTags(v []*Tag) *CreateKeyspaceInput

SetTags sets the Tags field's value.

func (CreateKeyspaceInput) String 

func (s CreateKeyspaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateKeyspaceInput) Validate 

func (s *CreateKeyspaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateKeyspaceOutput 

type CreateKeyspaceOutput struct {

	// The unique identifier of the keyspace in the format of an Amazon Resource
	// Name (ARN).
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateKeyspaceOutput) GoString 

func (s CreateKeyspaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateKeyspaceOutput) SetResourceArn 

func (s *CreateKeyspaceOutput) SetResourceArn(v string) *CreateKeyspaceOutput

SetResourceArn sets the ResourceArn field's value.

func (CreateKeyspaceOutput) String 

func (s CreateKeyspaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateTableInput 

type CreateTableInput struct {

	// Specifies the read/write throughput capacity mode for the 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.
	CapacitySpecification *CapacitySpecification `locationName:"capacitySpecification" type:"structure"`

	// Enables client-side timestamps for the table. By default, the setting is
	// disabled. You can enable client-side timestamps with the following option:
	//
	//    * status: "enabled"
	//
	// Once client-side timestamps are enabled for a table, this setting cannot
	// be disabled.
	ClientSideTimestamps *ClientSideTimestamps `locationName:"clientSideTimestamps" type:"structure"`

	// This parameter allows to enter a description of the table.
	Comment *Comment `locationName:"comment" type:"structure"`

	// The default Time to Live setting in seconds for the table.
	//
	// For more information, see Setting the default TTL value for a table (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl)
	// in the Amazon Keyspaces Developer Guide.
	DefaultTimeToLive *int64 `locationName:"defaultTimeToLive" min:"1" type:"integer"`

	// Specifies how the encryption key for encryption at rest is managed for the
	// table. You can choose one of the following KMS key (KMS key):
	//
	//    * 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.
	EncryptionSpecification *EncryptionSpecification `locationName:"encryptionSpecification" type:"structure"`

	// The name of the keyspace that the table is going to be created in.
	//
	// KeyspaceName is a required field
	KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"`

	// Specifies if pointInTimeRecovery is enabled or disabled for the table. The
	// options are:
	//
	//    * status=ENABLED
	//
	//    * status=DISABLED
	//
	// If it's not specified, the default is status=DISABLED.
	//
	// For more information, see Point-in-time recovery (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html)
	// in the Amazon Keyspaces Developer Guide.
	PointInTimeRecovery *PointInTimeRecovery `locationName:"pointInTimeRecovery" type:"structure"`

	// The schemaDefinition consists of the following parameters.
	//
	// For each column to be created:
	//
	//    * name - The name of the column.
	//
	//    * type - An Amazon Keyspaces data type. For more information, see Data
	//    types (https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types)
	//    in the Amazon Keyspaces Developer Guide.
	//
	// The primary key of the table consists of the following columns:
	//
	//    * partitionKeys - The partition key can be a single column, or it can
	//    be a compound value composed of two or more columns. The partition key
	//    portion of the primary key is required and determines how Amazon Keyspaces
	//    stores your data.
	//
	//    * name - The name of each partition key column.
	//
	//    * clusteringKeys - The optional clustering column portion of your primary
	//    key determines how the data is clustered and sorted within each partition.
	//
	//    * name - The name of the clustering column.
	//
	//    * orderBy - Sets the ascendant (ASC) or descendant (DESC) order modifier.
	//    To define a column as static use staticColumns - Static columns store
	//    values that are shared by all rows in the same partition:
	//
	//    * name - The name of the column.
	//
	//    * type - An Amazon Keyspaces data type.
	//
	// SchemaDefinition is a required field
	SchemaDefinition *SchemaDefinition `locationName:"schemaDefinition" type:"structure" required:"true"`

	// The name of the table.
	//
	// TableName is a required field
	TableName *string `locationName:"tableName" min:"1" type:"string" required:"true"`

	// A list of key-value pair tags to be attached to the resource.
	//
	// 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.
	Tags []*Tag `locationName:"tags" min:"1" type:"list"`

	// Enables Time to Live custom settings for the table. The options are:
	//
	//    * status:enabled
	//
	//    * status:disabled
	//
	// The default is status:disabled. After ttl is enabled, you can't disable it
	// for the table.
	//
	// For more information, see Expiring data by using Amazon Keyspaces Time to
	// Live (TTL) (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html)
	// in the Amazon Keyspaces Developer Guide.
	Ttl *TimeToLive `locationName:"ttl" type:"structure"`
	// contains filtered or unexported fields
}

func (CreateTableInput) GoString 

func (s CreateTableInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTableInput) SetCapacitySpecification 

func (s *CreateTableInput) SetCapacitySpecification(v *CapacitySpecification) *CreateTableInput

SetCapacitySpecification sets the CapacitySpecification field's value.

func (*CreateTableInput) SetClientSideTimestamps 

func (s *CreateTableInput) SetClientSideTimestamps(v *ClientSideTimestamps) *CreateTableInput

SetClientSideTimestamps sets the ClientSideTimestamps field's value.

func (*CreateTableInput) SetComment 

func (s *CreateTableInput) SetComment(v *Comment) *CreateTableInput

SetComment sets the Comment field's value.

func (*CreateTableInput) SetDefaultTimeToLive 

func (s *CreateTableInput) SetDefaultTimeToLive(v int64) *CreateTableInput

SetDefaultTimeToLive sets the DefaultTimeToLive field's value.

func (*CreateTableInput) SetEncryptionSpecification 

func (s *CreateTableInput) SetEncryptionSpecification(v *EncryptionSpecification) *CreateTableInput

SetEncryptionSpecification sets the EncryptionSpecification field's value.

func (*CreateTableInput) SetKeyspaceName 

func (s *CreateTableInput) SetKeyspaceName(v string) *CreateTableInput

SetKeyspaceName sets the KeyspaceName field's value.

func (*CreateTableInput) SetPointInTimeRecovery 

func (s *CreateTableInput) SetPointInTimeRecovery(v *PointInTimeRecovery) *CreateTableInput

SetPointInTimeRecovery sets the PointInTimeRecovery field's value.

func (*CreateTableInput) SetSchemaDefinition 

func (s *CreateTableInput) SetSchemaDefinition(v *SchemaDefinition) *CreateTableInput

SetSchemaDefinition sets the SchemaDefinition field's value.

func (*CreateTableInput) SetTableName 

func (s *CreateTableInput) SetTableName(v string) *CreateTableInput

SetTableName sets the TableName field's value.

func (*CreateTableInput) SetTags 

func (s *CreateTableInput) SetTags(v []*Tag) *CreateTableInput

SetTags sets the Tags field's value.

func (*CreateTableInput) SetTtl 

func (s *CreateTableInput) SetTtl(v *TimeToLive) *CreateTableInput

SetTtl sets the Ttl field's value.

func (CreateTableInput) String 

func (s CreateTableInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTableInput) Validate 

func (s *CreateTableInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateTableOutput 

type CreateTableOutput struct {

	// The unique identifier of the table in the format of an Amazon Resource Name
	// (ARN).
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateTableOutput) GoString 

func (s CreateTableOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateTableOutput) SetResourceArn 

func (s *CreateTableOutput) SetResourceArn(v string) *CreateTableOutput

SetResourceArn sets the ResourceArn field's value.

func (CreateTableOutput) String 

func (s CreateTableOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteKeyspaceInput 

type DeleteKeyspaceInput struct {

	// The name of the keyspace to be deleted.
	//
	// KeyspaceName is a required field
	KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteKeyspaceInput) GoString 

func (s DeleteKeyspaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteKeyspaceInput) SetKeyspaceName 

func (s *DeleteKeyspaceInput) SetKeyspaceName(v string) *DeleteKeyspaceInput

SetKeyspaceName sets the KeyspaceName field's value.

func (DeleteKeyspaceInput) String 

func (s DeleteKeyspaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteKeyspaceInput) Validate 

func (s *DeleteKeyspaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteKeyspaceOutput 

type DeleteKeyspaceOutput struct {
	// contains filtered or unexported fields
}

func (DeleteKeyspaceOutput) GoString 

func (s DeleteKeyspaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteKeyspaceOutput) String 

func (s DeleteKeyspaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteTableInput 

type DeleteTableInput struct {

	// The name of the keyspace of the to be deleted table.
	//
	// KeyspaceName is a required field
	KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"`

	// The name of the table to be deleted.
	//
	// TableName is a required field
	TableName *string `locationName:"tableName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTableInput) GoString 

func (s DeleteTableInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTableInput) SetKeyspaceName 

func (s *DeleteTableInput) SetKeyspaceName(v string) *DeleteTableInput

SetKeyspaceName sets the KeyspaceName field's value.

func (*DeleteTableInput) SetTableName 

func (s *DeleteTableInput) SetTableName(v string) *DeleteTableInput

SetTableName sets the TableName field's value.

func (DeleteTableInput) String 

func (s DeleteTableInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteTableInput) Validate 

func (s *DeleteTableInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteTableOutput 

type DeleteTableOutput struct {
	// contains filtered or unexported fields
}

func (DeleteTableOutput) GoString 

func (s DeleteTableOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteTableOutput) String 

func (s DeleteTableOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EncryptionSpecification 

type EncryptionSpecification struct {

	// The Amazon Resource Name (ARN) of the customer managed KMS key, for example
	// kms_key_identifier:ARN.
	KmsKeyIdentifier *string `locationName:"kmsKeyIdentifier" min:"1" type:"string"`

	// 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.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"EncryptionType"`
	// 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.

func (EncryptionSpecification) GoString 

func (s EncryptionSpecification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionSpecification) SetKmsKeyIdentifier 

func (s *EncryptionSpecification) SetKmsKeyIdentifier(v string) *EncryptionSpecification

SetKmsKeyIdentifier sets the KmsKeyIdentifier field's value.

func (*EncryptionSpecification) SetType 

func (s *EncryptionSpecification) SetType(v string) *EncryptionSpecification

SetType sets the Type field's value.

func (EncryptionSpecification) String 

func (s EncryptionSpecification) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionSpecification) Validate 

func (s *EncryptionSpecification) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetKeyspaceInput 

type GetKeyspaceInput struct {

	// The name of the keyspace.
	//
	// KeyspaceName is a required field
	KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetKeyspaceInput) GoString 

func (s GetKeyspaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetKeyspaceInput) SetKeyspaceName 

func (s *GetKeyspaceInput) SetKeyspaceName(v string) *GetKeyspaceInput

SetKeyspaceName sets the KeyspaceName field's value.

func (GetKeyspaceInput) String 

func (s GetKeyspaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetKeyspaceInput) Validate 

func (s *GetKeyspaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetKeyspaceOutput 

type GetKeyspaceOutput struct {

	// The name of the keyspace.
	//
	// KeyspaceName is a required field
	KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"`

	// If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication
	// Regions is returned.
	ReplicationRegions []*string `locationName:"replicationRegions" min:"2" type:"list"`

	// Returns the replication strategy of the keyspace. The options are SINGLE_REGION
	// or MULTI_REGION.
	//
	// ReplicationStrategy is a required field
	ReplicationStrategy *string `locationName:"replicationStrategy" min:"1" type:"string" required:"true" enum:"Rs"`

	// Returns the ARN of the keyspace.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetKeyspaceOutput) GoString 

func (s GetKeyspaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetKeyspaceOutput) SetKeyspaceName 

func (s *GetKeyspaceOutput) SetKeyspaceName(v string) *GetKeyspaceOutput

SetKeyspaceName sets the KeyspaceName field's value.

func (*GetKeyspaceOutput) SetReplicationRegions 

func (s *GetKeyspaceOutput) SetReplicationRegions(v []*string) *GetKeyspaceOutput

SetReplicationRegions sets the ReplicationRegions field's value.

func (*GetKeyspaceOutput) SetReplicationStrategy 

func (s *GetKeyspaceOutput) SetReplicationStrategy(v string) *GetKeyspaceOutput

SetReplicationStrategy sets the ReplicationStrategy field's value.

func (*GetKeyspaceOutput) SetResourceArn 

func (s *GetKeyspaceOutput) SetResourceArn(v string) *GetKeyspaceOutput

SetResourceArn sets the ResourceArn field's value.

func (GetKeyspaceOutput) String 

func (s GetKeyspaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetTableInput 

type GetTableInput struct {

	// The name of the keyspace that the table is stored in.
	//
	// KeyspaceName is a required field
	KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"`

	// The name of the table.
	//
	// TableName is a required field
	TableName *string `locationName:"tableName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetTableInput) GoString 

func (s GetTableInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTableInput) SetKeyspaceName 

func (s *GetTableInput) SetKeyspaceName(v string) *GetTableInput

SetKeyspaceName sets the KeyspaceName field's value.

func (*GetTableInput) SetTableName 

func (s *GetTableInput) SetTableName(v string) *GetTableInput

SetTableName sets the TableName field's value.

func (GetTableInput) String 

func (s GetTableInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTableInput) Validate 

func (s *GetTableInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetTableOutput 

type GetTableOutput struct {

	// The read/write throughput capacity mode for a table. The options are:
	//
	//    * throughputMode:PAY_PER_REQUEST
	//
	//    * throughputMode:PROVISIONED
	CapacitySpecification *CapacitySpecificationSummary `locationName:"capacitySpecification" type:"structure"`

	// The client-side timestamps setting of the table.
	ClientSideTimestamps *ClientSideTimestamps `locationName:"clientSideTimestamps" type:"structure"`

	// The the description of the specified table.
	Comment *Comment `locationName:"comment" type:"structure"`

	// The creation timestamp of the specified table.
	CreationTimestamp *time.Time `locationName:"creationTimestamp" type:"timestamp"`

	// The default Time to Live settings in seconds of the specified table.
	DefaultTimeToLive *int64 `locationName:"defaultTimeToLive" min:"1" type:"integer"`

	// The encryption settings of the specified table.
	EncryptionSpecification *EncryptionSpecification `locationName:"encryptionSpecification" type:"structure"`

	// The name of the keyspace that the specified table is stored in.
	//
	// KeyspaceName is a required field
	KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"`

	// The point-in-time recovery status of the specified table.
	PointInTimeRecovery *PointInTimeRecoverySummary `locationName:"pointInTimeRecovery" type:"structure"`

	// The Amazon Resource Name (ARN) of the specified table.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"20" type:"string" required:"true"`

	// The schema definition of the specified table.
	SchemaDefinition *SchemaDefinition `locationName:"schemaDefinition" type:"structure"`

	// The current status of the specified table.
	Status *string `locationName:"status" type:"string" enum:"TableStatus"`

	// The name of the specified table.
	//
	// TableName is a required field
	TableName *string `locationName:"tableName" min:"1" type:"string" required:"true"`

	// The custom Time to Live settings of the specified table.
	Ttl *TimeToLive `locationName:"ttl" type:"structure"`
	// contains filtered or unexported fields
}

func (GetTableOutput) GoString 

func (s GetTableOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetTableOutput) SetCapacitySpecification 

func (s *GetTableOutput) SetCapacitySpecification(v *CapacitySpecificationSummary) *GetTableOutput

SetCapacitySpecification sets the CapacitySpecification field's value.

func (*GetTableOutput) SetClientSideTimestamps 

func (s *GetTableOutput) SetClientSideTimestamps(v *ClientSideTimestamps) *GetTableOutput

SetClientSideTimestamps sets the ClientSideTimestamps field's value.

func (*GetTableOutput) SetComment 

func (s *GetTableOutput) SetComment(v *Comment) *GetTableOutput

SetComment sets the Comment field's value.

func (*GetTableOutput) SetCreationTimestamp 

func (s *GetTableOutput) SetCreationTimestamp(v time.Time) *GetTableOutput

SetCreationTimestamp sets the CreationTimestamp field's value.

func (*GetTableOutput) SetDefaultTimeToLive 

func (s *GetTableOutput) SetDefaultTimeToLive(v int64) *GetTableOutput

SetDefaultTimeToLive sets the DefaultTimeToLive field's value.

func (*GetTableOutput) SetEncryptionSpecification 

func (s *GetTableOutput) SetEncryptionSpecification(v *EncryptionSpecification) *GetTableOutput

SetEncryptionSpecification sets the EncryptionSpecification field's value.

func (*GetTableOutput) SetKeyspaceName 

func (s *GetTableOutput) SetKeyspaceName(v string) *GetTableOutput

SetKeyspaceName sets the KeyspaceName field's value.

func (*GetTableOutput) SetPointInTimeRecovery 

func (s *GetTableOutput) SetPointInTimeRecovery(v *PointInTimeRecoverySummary) *GetTableOutput

SetPointInTimeRecovery sets the PointInTimeRecovery field's value.

func (*GetTableOutput) SetResourceArn 

func (s *GetTableOutput) SetResourceArn(v string) *GetTableOutput

SetResourceArn sets the ResourceArn field's value.

func (*GetTableOutput) SetSchemaDefinition 

func (s *GetTableOutput) SetSchemaDefinition(v *SchemaDefinition) *GetTableOutput

SetSchemaDefinition sets the SchemaDefinition field's value.

func (*GetTableOutput) SetStatus 

func (s *GetTableOutput) SetStatus(v string) *GetTableOutput

SetStatus sets the Status field's value.

func (*GetTableOutput) SetTableName 

func (s *GetTableOutput) SetTableName(v string) *GetTableOutput

SetTableName sets the TableName field's value.

func (*GetTableOutput) SetTtl 

func (s *GetTableOutput) SetTtl(v *TimeToLive) *GetTableOutput

SetTtl sets the Ttl field's value.

func (GetTableOutput) String 

func (s GetTableOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

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

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type KeyspaceSummary 

type KeyspaceSummary struct {

	// The name of the keyspace.
	//
	// KeyspaceName is a required field
	KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"`

	// If the replicationStrategy of the keyspace is MULTI_REGION, a list of replication
	// Regions is returned.
	ReplicationRegions []*string `locationName:"replicationRegions" min:"2" type:"list"`

	// This property specifies if a keyspace is a single Region keyspace or a multi-Region
	// keyspace. The available values are SINGLE_REGION or MULTI_REGION.
	//
	// ReplicationStrategy is a required field
	ReplicationStrategy *string `locationName:"replicationStrategy" min:"1" type:"string" required:"true" enum:"Rs"`

	// The unique identifier of the keyspace in the format of an Amazon Resource
	// Name (ARN).
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the properties of a keyspace.

func (KeyspaceSummary) GoString 

func (s KeyspaceSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*KeyspaceSummary) SetKeyspaceName 

func (s *KeyspaceSummary) SetKeyspaceName(v string) *KeyspaceSummary

SetKeyspaceName sets the KeyspaceName field's value.

func (*KeyspaceSummary) SetReplicationRegions 

func (s *KeyspaceSummary) SetReplicationRegions(v []*string) *KeyspaceSummary

SetReplicationRegions sets the ReplicationRegions field's value.

func (*KeyspaceSummary) SetReplicationStrategy 

func (s *KeyspaceSummary) SetReplicationStrategy(v string) *KeyspaceSummary

SetReplicationStrategy sets the ReplicationStrategy field's value.

func (*KeyspaceSummary) SetResourceArn 

func (s *KeyspaceSummary) SetResourceArn(v string) *KeyspaceSummary

SetResourceArn sets the ResourceArn field's value.

func (KeyspaceSummary) String 

func (s KeyspaceSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Keyspaces 

type Keyspaces struct {
	*client.Client
}

Keyspaces provides the API operation methods for making requests to Amazon Keyspaces. See this package's package overview docs for details on the service.

Keyspaces methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Keyspaces

New creates a new instance of the Keyspaces client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a Keyspaces client from just a session.
svc := keyspaces.New(mySession)

// Create a Keyspaces client with additional configuration
svc := keyspaces.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Keyspaces) CreateKeyspace 

func (c *Keyspaces) CreateKeyspace(input *CreateKeyspaceInput) (*CreateKeyspaceOutput, error)

CreateKeyspace API operation for Amazon Keyspaces.

The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.

CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace by using the GetKeyspace operation.

For more information, see Creating keyspaces (https://docs.aws.amazon.com/keyspaces/latest/devguide/working-with-keyspaces.html#keyspaces-create) in the Amazon Keyspaces Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Keyspaces's API operation CreateKeyspace for usage and error information.

Returned Error Types:

  • ValidationException The operation failed due to an invalid or malformed request.

  • ServiceQuotaExceededException 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.

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

  • ConflictException 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.

  • AccessDeniedException You do not have sufficient access to perform this action.

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/CreateKeyspace

func (*Keyspaces) CreateKeyspaceRequest 

func (c *Keyspaces) CreateKeyspaceRequest(input *CreateKeyspaceInput) (req *request.Request, output *CreateKeyspaceOutput)

CreateKeyspaceRequest generates a "aws/request.Request" representing the client's request for the CreateKeyspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateKeyspace for more information on using the CreateKeyspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateKeyspaceRequest method.
req, resp := client.CreateKeyspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/CreateKeyspace

func (*Keyspaces) CreateKeyspaceWithContext 

func (c *Keyspaces) CreateKeyspaceWithContext(ctx aws.Context, input *CreateKeyspaceInput, opts ...request.Option) (*CreateKeyspaceOutput, error)

CreateKeyspaceWithContext is the same as CreateKeyspace with the addition of the ability to pass a context and additional request options.

See CreateKeyspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Keyspaces) CreateTable 

func (c *Keyspaces) CreateTable(input *CreateTableInput) (*CreateTableOutput, error)

CreateTable API operation for Amazon Keyspaces.

The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.

CreateTable is an asynchronous operation. When the request is received, the status of the table is set to CREATING. You can monitor the creation status of the new table by using the GetTable operation, which returns the current status of the table. You can start using a table when the status is ACTIVE.

For more information, see Creating tables (https://docs.aws.amazon.com/keyspaces/latest/devguide/working-with-tables.html#tables-create) in the Amazon Keyspaces Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Keyspaces's API operation CreateTable for usage and error information.

Returned Error Types:

  • ValidationException The operation failed due to an invalid or malformed request.

  • ServiceQuotaExceededException 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.

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

  • ConflictException 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.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/CreateTable

func (*Keyspaces) CreateTableRequest 

func (c *Keyspaces) CreateTableRequest(input *CreateTableInput) (req *request.Request, output *CreateTableOutput)

CreateTableRequest generates a "aws/request.Request" representing the client's request for the CreateTable operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateTable for more information on using the CreateTable API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateTableRequest method.
req, resp := client.CreateTableRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/CreateTable

func (*Keyspaces) CreateTableWithContext 

func (c *Keyspaces) CreateTableWithContext(ctx aws.Context, input *CreateTableInput, opts ...request.Option) (*CreateTableOutput, error)

CreateTableWithContext is the same as CreateTable with the addition of the ability to pass a context and additional request options.

See CreateTable for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Keyspaces) DeleteKeyspace 

func (c *Keyspaces) DeleteKeyspace(input *DeleteKeyspaceInput) (*DeleteKeyspaceOutput, error)

DeleteKeyspace API operation for Amazon Keyspaces.

The DeleteKeyspace operation deletes a keyspace and all of its tables.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Keyspaces's API operation DeleteKeyspace for usage and error information.

Returned Error Types:

  • ValidationException The operation failed due to an invalid or malformed request.

  • ServiceQuotaExceededException 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.

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

  • ConflictException 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.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/DeleteKeyspace

func (*Keyspaces) DeleteKeyspaceRequest 

func (c *Keyspaces) DeleteKeyspaceRequest(input *DeleteKeyspaceInput) (req *request.Request, output *DeleteKeyspaceOutput)

DeleteKeyspaceRequest generates a "aws/request.Request" representing the client's request for the DeleteKeyspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteKeyspace for more information on using the DeleteKeyspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteKeyspaceRequest method.
req, resp := client.DeleteKeyspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/DeleteKeyspace

func (*Keyspaces) DeleteKeyspaceWithContext 

func (c *Keyspaces) DeleteKeyspaceWithContext(ctx aws.Context, input *DeleteKeyspaceInput, opts ...request.Option) (*DeleteKeyspaceOutput, error)

DeleteKeyspaceWithContext is the same as DeleteKeyspace with the addition of the ability to pass a context and additional request options.

See DeleteKeyspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Keyspaces) DeleteTable 

func (c *Keyspaces) DeleteTable(input *DeleteTableInput) (*DeleteTableOutput, error)

DeleteTable API operation for Amazon Keyspaces.

The DeleteTable operation deletes a table and all of its data. After a DeleteTable request is received, the specified table is in the DELETING state until Amazon Keyspaces completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is either in the CREATING or UPDATING states, then Amazon Keyspaces returns a ResourceInUseException. If the specified table does not exist, Amazon Keyspaces returns a ResourceNotFoundException. If the table is already in the DELETING state, no error is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Keyspaces's API operation DeleteTable for usage and error information.

Returned Error Types:

  • ValidationException The operation failed due to an invalid or malformed request.

  • ServiceQuotaExceededException 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.

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

  • ConflictException 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.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/DeleteTable

func (*Keyspaces) DeleteTableRequest 

func (c *Keyspaces) DeleteTableRequest(input *DeleteTableInput) (req *request.Request, output *DeleteTableOutput)

DeleteTableRequest generates a "aws/request.Request" representing the client's request for the DeleteTable operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteTable for more information on using the DeleteTable API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteTableRequest method.
req, resp := client.DeleteTableRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/DeleteTable

func (*Keyspaces) DeleteTableWithContext 

func (c *Keyspaces) DeleteTableWithContext(ctx aws.Context, input *DeleteTableInput, opts ...request.Option) (*DeleteTableOutput, error)

DeleteTableWithContext is the same as DeleteTable with the addition of the ability to pass a context and additional request options.

See DeleteTable for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Keyspaces) GetKeyspace 

func (c *Keyspaces) GetKeyspace(input *GetKeyspaceInput) (*GetKeyspaceOutput, error)

GetKeyspace API operation for Amazon Keyspaces.

Returns the name and the Amazon Resource Name (ARN) of the specified table.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Keyspaces's API operation GetKeyspace for usage and error information.

Returned Error Types:

  • ValidationException The operation failed due to an invalid or malformed request.

  • ServiceQuotaExceededException 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.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/GetKeyspace

func (*Keyspaces) GetKeyspaceRequest 

func (c *Keyspaces) GetKeyspaceRequest(input *GetKeyspaceInput) (req *request.Request, output *GetKeyspaceOutput)

GetKeyspaceRequest generates a "aws/request.Request" representing the client's request for the GetKeyspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetKeyspace for more information on using the GetKeyspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetKeyspaceRequest method.
req, resp := client.GetKeyspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/GetKeyspace

func (*Keyspaces) GetKeyspaceWithContext 

func (c *Keyspaces) GetKeyspaceWithContext(ctx aws.Context, input *GetKeyspaceInput, opts ...request.Option) (*GetKeyspaceOutput, error)

GetKeyspaceWithContext is the same as GetKeyspace with the addition of the ability to pass a context and additional request options.

See GetKeyspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Keyspaces) GetTable 

func (c *Keyspaces) GetTable(input *GetTableInput) (*GetTableOutput, error)

GetTable API operation for Amazon Keyspaces.

Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.

To read table metadata using GetTable, Select action permissions for the table and system tables are required to complete the operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Keyspaces's API operation GetTable for usage and error information.

Returned Error Types:

  • ValidationException The operation failed due to an invalid or malformed request.

  • ServiceQuotaExceededException 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.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/GetTable

func (*Keyspaces) GetTableRequest 

func (c *Keyspaces) GetTableRequest(input *GetTableInput) (req *request.Request, output *GetTableOutput)

GetTableRequest generates a "aws/request.Request" representing the client's request for the GetTable operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetTable for more information on using the GetTable API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetTableRequest method.
req, resp := client.GetTableRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/GetTable

func (*Keyspaces) GetTableWithContext 

func (c *Keyspaces) GetTableWithContext(ctx aws.Context, input *GetTableInput, opts ...request.Option) (*GetTableOutput, error)

GetTableWithContext is the same as GetTable with the addition of the ability to pass a context and additional request options.

See GetTable for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Keyspaces) ListKeyspaces 

func (c *Keyspaces) ListKeyspaces(input *ListKeyspacesInput) (*ListKeyspacesOutput, error)

ListKeyspaces API operation for Amazon Keyspaces.

Returns a list of keyspaces.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Keyspaces's API operation ListKeyspaces for usage and error information.

Returned Error Types:

  • ValidationException The operation failed due to an invalid or malformed request.

  • ServiceQuotaExceededException 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.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/ListKeyspaces

func (*Keyspaces) ListKeyspacesPages 

func (c *Keyspaces) ListKeyspacesPages(input *ListKeyspacesInput, fn func(*ListKeyspacesOutput, bool) bool) error

ListKeyspacesPages iterates over the pages of a ListKeyspaces operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListKeyspaces method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListKeyspaces operation.
pageNum := 0
err := client.ListKeyspacesPages(params,
    func(page *keyspaces.ListKeyspacesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Keyspaces) ListKeyspacesPagesWithContext 

func (c *Keyspaces) ListKeyspacesPagesWithContext(ctx aws.Context, input *ListKeyspacesInput, fn func(*ListKeyspacesOutput, bool) bool, opts ...request.Option) error

ListKeyspacesPagesWithContext same as ListKeyspacesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Keyspaces) ListKeyspacesRequest 

func (c *Keyspaces) ListKeyspacesRequest(input *ListKeyspacesInput) (req *request.Request, output *ListKeyspacesOutput)

ListKeyspacesRequest generates a "aws/request.Request" representing the client's request for the ListKeyspaces operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListKeyspaces for more information on using the ListKeyspaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListKeyspacesRequest method.
req, resp := client.ListKeyspacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/ListKeyspaces

func (*Keyspaces) ListKeyspacesWithContext 

func (c *Keyspaces) ListKeyspacesWithContext(ctx aws.Context, input *ListKeyspacesInput, opts ...request.Option) (*ListKeyspacesOutput, error)

ListKeyspacesWithContext is the same as ListKeyspaces with the addition of the ability to pass a context and additional request options.

See ListKeyspaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Keyspaces) ListTables 

func (c *Keyspaces) ListTables(input *ListTablesInput) (*ListTablesOutput, error)

ListTables API operation for Amazon Keyspaces.

Returns a list of tables for a specified keyspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Keyspaces's API operation ListTables for usage and error information.

Returned Error Types:

  • ValidationException The operation failed due to an invalid or malformed request.

  • ServiceQuotaExceededException 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.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/ListTables

func (*Keyspaces) ListTablesPages 

func (c *Keyspaces) ListTablesPages(input *ListTablesInput, fn func(*ListTablesOutput, bool) bool) error

ListTablesPages iterates over the pages of a ListTables operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTables method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTables operation.
pageNum := 0
err := client.ListTablesPages(params,
    func(page *keyspaces.ListTablesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Keyspaces) ListTablesPagesWithContext 

func (c *Keyspaces) ListTablesPagesWithContext(ctx aws.Context, input *ListTablesInput, fn func(*ListTablesOutput, bool) bool, opts ...request.Option) error

ListTablesPagesWithContext same as ListTablesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Keyspaces) ListTablesRequest 

func (c *Keyspaces) ListTablesRequest(input *ListTablesInput) (req *request.Request, output *ListTablesOutput)

ListTablesRequest generates a "aws/request.Request" representing the client's request for the ListTables operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTables for more information on using the ListTables API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTablesRequest method.
req, resp := client.ListTablesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/ListTables

func (*Keyspaces) ListTablesWithContext 

func (c *Keyspaces) ListTablesWithContext(ctx aws.Context, input *ListTablesInput, opts ...request.Option) (*ListTablesOutput, error)

ListTablesWithContext is the same as ListTables with the addition of the ability to pass a context and additional request options.

See ListTables for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Keyspaces) ListTagsForResource 

func (c *Keyspaces) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Keyspaces.

Returns a list of all tags associated with the specified Amazon Keyspaces resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Keyspaces's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ValidationException The operation failed due to an invalid or malformed request.

  • ServiceQuotaExceededException 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.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/ListTagsForResource

func (*Keyspaces) ListTagsForResourcePages 

func (c *Keyspaces) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error

ListTagsForResourcePages iterates over the pages of a ListTagsForResource operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTagsForResource method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListTagsForResource operation.
pageNum := 0
err := client.ListTagsForResourcePages(params,
    func(page *keyspaces.ListTagsForResourceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Keyspaces) ListTagsForResourcePagesWithContext 

func (c *Keyspaces) ListTagsForResourcePagesWithContext(ctx aws.Context, input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool, opts ...request.Option) error

ListTagsForResourcePagesWithContext same as ListTagsForResourcePages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Keyspaces) ListTagsForResourceRequest 

func (c *Keyspaces) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/ListTagsForResource

func (*Keyspaces) ListTagsForResourceWithContext 

func (c *Keyspaces) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Keyspaces) RestoreTable 

func (c *Keyspaces) RestoreTable(input *RestoreTableInput) (*RestoreTableOutput, error)

RestoreTable API operation for Amazon Keyspaces.

Restores the specified table to the specified point in time within the earliest_restorable_timestamp and the current time. For more information about restore points, see Time window for PITR continuous backups (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery_HowItWorks.html#howitworks_backup_window) in the Amazon Keyspaces Developer Guide.

Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to the state based on the selected timestamp (day:hour:minute:second) to a new table. The Time to Live (TTL) settings are also restored to the state based on the selected timestamp.

In addition to the table's schema, data, and TTL settings, RestoreTable restores the capacity mode, encryption, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, these settings are always restored based on the table's settings as of the current time or when the table was deleted.

You can also overwrite these settings during restore:

  • Read/write capacity mode

  • Provisioned throughput capacity settings

  • Point-in-time (PITR) settings

  • Tags

For more information, see PITR restore settings (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery_HowItWorks.html#howitworks_backup_settings) in the Amazon Keyspaces Developer Guide.

Note that the following settings are not restored, and you must configure them manually for the new table:

  • Automatic scaling policies (for tables that use provisioned capacity mode)

  • Identity and Access Management (IAM) policies

  • Amazon CloudWatch metrics and alarms

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Keyspaces's API operation RestoreTable for usage and error information.

Returned Error Types:

  • ValidationException The operation failed due to an invalid or malformed request.

  • ServiceQuotaExceededException 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.

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

  • ConflictException 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.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/RestoreTable

func (*Keyspaces) RestoreTableRequest 

func (c *Keyspaces) RestoreTableRequest(input *RestoreTableInput) (req *request.Request, output *RestoreTableOutput)

RestoreTableRequest generates a "aws/request.Request" representing the client's request for the RestoreTable operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RestoreTable for more information on using the RestoreTable API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RestoreTableRequest method.
req, resp := client.RestoreTableRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/RestoreTable

func (*Keyspaces) RestoreTableWithContext 

func (c *Keyspaces) RestoreTableWithContext(ctx aws.Context, input *RestoreTableInput, opts ...request.Option) (*RestoreTableOutput, error)

RestoreTableWithContext is the same as RestoreTable with the addition of the ability to pass a context and additional request options.

See RestoreTable for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Keyspaces) TagResource 

func (c *Keyspaces) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Keyspaces.

Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. 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.

For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, see Amazon Keyspaces resource access based on tags (https://docs.aws.amazon.com/keyspaces/latest/devguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-tags) in the Amazon Keyspaces Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Keyspaces's API operation TagResource for usage and error information.

Returned Error Types:

  • ValidationException The operation failed due to an invalid or malformed request.

  • ServiceQuotaExceededException 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.

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

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/TagResource

func (*Keyspaces) TagResourceRequest 

func (c *Keyspaces) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/TagResource

func (*Keyspaces) TagResourceWithContext 

func (c *Keyspaces) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Keyspaces) UntagResource 

func (c *Keyspaces) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Keyspaces.

Removes the association of tags from a Amazon Keyspaces resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Keyspaces's API operation UntagResource for usage and error information.

Returned Error Types:

  • ValidationException The operation failed due to an invalid or malformed request.

  • ServiceQuotaExceededException 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.

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

  • ConflictException 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.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/UntagResource

func (*Keyspaces) UntagResourceRequest 

func (c *Keyspaces) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/UntagResource

func (*Keyspaces) UntagResourceWithContext 

func (c *Keyspaces) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Keyspaces) UpdateTable 

func (c *Keyspaces) UpdateTable(input *UpdateTableInput) (*UpdateTableOutput, error)

UpdateTable API operation for Amazon Keyspaces.

Adds new columns to the table or updates one of the table's settings, for example capacity mode, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Keyspaces's API operation UpdateTable for usage and error information.

Returned Error Types:

  • ValidationException The operation failed due to an invalid or malformed request.

  • ServiceQuotaExceededException 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.

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

  • ConflictException 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.

  • AccessDeniedException You do not have sufficient access to perform this action.

  • ResourceNotFoundException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/UpdateTable

func (*Keyspaces) UpdateTableRequest 

func (c *Keyspaces) UpdateTableRequest(input *UpdateTableInput) (req *request.Request, output *UpdateTableOutput)

UpdateTableRequest generates a "aws/request.Request" representing the client's request for the UpdateTable operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateTable for more information on using the UpdateTable API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateTableRequest method.
req, resp := client.UpdateTableRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/keyspaces-2022-02-10/UpdateTable

func (*Keyspaces) UpdateTableWithContext 

func (c *Keyspaces) UpdateTableWithContext(ctx aws.Context, input *UpdateTableInput, opts ...request.Option) (*UpdateTableOutput, error)

UpdateTableWithContext is the same as UpdateTable with the addition of the ability to pass a context and additional request options.

See UpdateTable for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type ListKeyspacesInput 

type ListKeyspacesInput struct {

	// The total number of keyspaces to return in the output. If the total number
	// of keyspaces available is more than the value specified, a NextToken is provided
	// in the output. To resume pagination, provide the NextToken value as an argument
	// of a subsequent API invocation.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The pagination token. To resume pagination, provide the NextToken value as
	// argument of a subsequent API invocation.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListKeyspacesInput) GoString 

func (s ListKeyspacesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKeyspacesInput) SetMaxResults 

func (s *ListKeyspacesInput) SetMaxResults(v int64) *ListKeyspacesInput

SetMaxResults sets the MaxResults field's value.

func (*ListKeyspacesInput) SetNextToken 

func (s *ListKeyspacesInput) SetNextToken(v string) *ListKeyspacesInput

SetNextToken sets the NextToken field's value.

func (ListKeyspacesInput) String 

func (s ListKeyspacesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKeyspacesInput) Validate 

func (s *ListKeyspacesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListKeyspacesOutput 

type ListKeyspacesOutput struct {

	// A list of keyspaces.
	//
	// Keyspaces is a required field
	Keyspaces []*KeyspaceSummary `locationName:"keyspaces" type:"list" required:"true"`

	// A token to specify where to start paginating. This is the NextToken from
	// a previously truncated response.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListKeyspacesOutput) GoString 

func (s ListKeyspacesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListKeyspacesOutput) SetKeyspaces 

func (s *ListKeyspacesOutput) SetKeyspaces(v []*KeyspaceSummary) *ListKeyspacesOutput

SetKeyspaces sets the Keyspaces field's value.

func (*ListKeyspacesOutput) SetNextToken 

func (s *ListKeyspacesOutput) SetNextToken(v string) *ListKeyspacesOutput

SetNextToken sets the NextToken field's value.

func (ListKeyspacesOutput) String 

func (s ListKeyspacesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTablesInput 

type ListTablesInput struct {

	// The name of the keyspace.
	//
	// KeyspaceName is a required field
	KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"`

	// The total number of tables to return in the output. If the total number of
	// tables available is more than the value specified, a NextToken is provided
	// in the output. To resume pagination, provide the NextToken value as an argument
	// of a subsequent API invocation.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The pagination token. To resume pagination, provide the NextToken value as
	// an argument of a subsequent API invocation.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListTablesInput) GoString 

func (s ListTablesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTablesInput) SetKeyspaceName 

func (s *ListTablesInput) SetKeyspaceName(v string) *ListTablesInput

SetKeyspaceName sets the KeyspaceName field's value.

func (*ListTablesInput) SetMaxResults 

func (s *ListTablesInput) SetMaxResults(v int64) *ListTablesInput

SetMaxResults sets the MaxResults field's value.

func (*ListTablesInput) SetNextToken 

func (s *ListTablesInput) SetNextToken(v string) *ListTablesInput

SetNextToken sets the NextToken field's value.

func (ListTablesInput) String 

func (s ListTablesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTablesInput) Validate 

func (s *ListTablesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTablesOutput 

type ListTablesOutput struct {

	// A token to specify where to start paginating. This is the NextToken from
	// a previously truncated response.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// A list of tables.
	Tables []*TableSummary `locationName:"tables" type:"list"`
	// contains filtered or unexported fields
}

func (ListTablesOutput) GoString 

func (s ListTablesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTablesOutput) SetNextToken 

func (s *ListTablesOutput) SetNextToken(v string) *ListTablesOutput

SetNextToken sets the NextToken field's value.

func (*ListTablesOutput) SetTables 

func (s *ListTablesOutput) SetTables(v []*TableSummary) *ListTablesOutput

SetTables sets the Tables field's value.

func (ListTablesOutput) String 

func (s ListTablesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The total number of tags to return in the output. If the total number of
	// tags available is more than the value specified, a NextToken is provided
	// in the output. To resume pagination, provide the NextToken value as an argument
	// of a subsequent API invocation.
	MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"`

	// The pagination token. To resume pagination, provide the NextToken value as
	// argument of a subsequent API invocation.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetMaxResults 

func (s *ListTagsForResourceInput) SetMaxResults(v int64) *ListTagsForResourceInput

SetMaxResults sets the MaxResults field's value.

func (*ListTagsForResourceInput) SetNextToken 

func (s *ListTagsForResourceInput) SetNextToken(v string) *ListTagsForResourceInput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// A token to specify where to start paginating. This is the NextToken from
	// a previously truncated response.
	NextToken *string `locationName:"nextToken" min:"1" type:"string"`

	// A list of tags.
	Tags []*Tag `locationName:"tags" min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetNextToken 

func (s *ListTagsForResourceOutput) SetNextToken(v string) *ListTagsForResourceOutput

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PartitionKey 

type PartitionKey struct {

	// The name(s) of the partition key column(s).
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// 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.

func (PartitionKey) GoString 

func (s PartitionKey) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PartitionKey) SetName 

func (s *PartitionKey) SetName(v string) *PartitionKey

SetName sets the Name field's value.

func (PartitionKey) String 

func (s PartitionKey) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PartitionKey) Validate 

func (s *PartitionKey) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PointInTimeRecovery 

type PointInTimeRecovery struct {

	// The options are:
	//
	//    * status=ENABLED
	//
	//    * status=DISABLED
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"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.

func (PointInTimeRecovery) GoString 

func (s PointInTimeRecovery) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PointInTimeRecovery) SetStatus 

func (s *PointInTimeRecovery) SetStatus(v string) *PointInTimeRecovery

SetStatus sets the Status field's value.

func (PointInTimeRecovery) String 

func (s PointInTimeRecovery) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PointInTimeRecovery) Validate 

func (s *PointInTimeRecovery) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PointInTimeRecoverySummary 

type PointInTimeRecoverySummary struct {

	// Specifies the earliest possible restore point of the table in ISO 8601 format.
	EarliestRestorableTimestamp *time.Time `locationName:"earliestRestorableTimestamp" type:"timestamp"`

	// Shows if point-in-time recovery is enabled or disabled for the specified
	// table.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"PointInTimeRecoveryStatus"`
	// contains filtered or unexported fields
}

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

func (PointInTimeRecoverySummary) GoString 

func (s PointInTimeRecoverySummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PointInTimeRecoverySummary) SetEarliestRestorableTimestamp 

func (s *PointInTimeRecoverySummary) SetEarliestRestorableTimestamp(v time.Time) *PointInTimeRecoverySummary

SetEarliestRestorableTimestamp sets the EarliestRestorableTimestamp field's value.

func (*PointInTimeRecoverySummary) SetStatus 

func (s *PointInTimeRecoverySummary) SetStatus(v string) *PointInTimeRecoverySummary

SetStatus sets the Status field's value.

func (PointInTimeRecoverySummary) String 

func (s PointInTimeRecoverySummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReplicationSpecification 

type ReplicationSpecification struct {

	// The regionList can contain up to six Amazon Web Services Regions where the
	// keyspace is replicated in.
	RegionList []*string `locationName:"regionList" min:"2" type:"list"`

	// The replicationStrategy of a keyspace, the required value is SINGLE_REGION
	// or MULTI_REGION.
	//
	// ReplicationStrategy is a required field
	ReplicationStrategy *string `locationName:"replicationStrategy" min:"1" type:"string" required:"true" enum:"Rs"`
	// contains filtered or unexported fields
}

The replication specification of the keyspace includes:

  • regionList - up to six Amazon Web Services Regions where the keyspace is replicated in.

  • replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION.

func (ReplicationSpecification) GoString 

func (s ReplicationSpecification) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReplicationSpecification) SetRegionList 

func (s *ReplicationSpecification) SetRegionList(v []*string) *ReplicationSpecification

SetRegionList sets the RegionList field's value.

func (*ReplicationSpecification) SetReplicationStrategy 

func (s *ReplicationSpecification) SetReplicationStrategy(v string) *ReplicationSpecification

SetReplicationStrategy sets the ReplicationStrategy field's value.

func (ReplicationSpecification) String 

func (s ReplicationSpecification) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReplicationSpecification) Validate 

func (s *ReplicationSpecification) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The unique identifier in the format of Amazon Resource Name (ARN), for the
	// resource not found.
	ResourceArn *string `locationName:"resourceArn" min:"20" type:"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) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RestoreTableInput 

type RestoreTableInput struct {

	// Specifies the read/write throughput capacity mode for the target table. The
	// options are:
	//
	//    * throughputMode:PAY_PER_REQUEST
	//
	//    * 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.
	CapacitySpecificationOverride *CapacitySpecification `locationName:"capacitySpecificationOverride" type:"structure"`

	// Specifies the encryption settings for the target table. You can choose one
	// of the following KMS key (KMS key):
	//
	//    * 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.
	EncryptionSpecificationOverride *EncryptionSpecification `locationName:"encryptionSpecificationOverride" type:"structure"`

	// Specifies the pointInTimeRecovery settings for the target table. The options
	// are:
	//
	//    * status=ENABLED
	//
	//    * status=DISABLED
	//
	// If it's not specified, the default is status=DISABLED.
	//
	// For more information, see Point-in-time recovery (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html)
	// in the Amazon Keyspaces Developer Guide.
	PointInTimeRecoveryOverride *PointInTimeRecovery `locationName:"pointInTimeRecoveryOverride" type:"structure"`

	// The restore timestamp in ISO 8601 format.
	RestoreTimestamp *time.Time `locationName:"restoreTimestamp" type:"timestamp"`

	// The keyspace name of the source table.
	//
	// SourceKeyspaceName is a required field
	SourceKeyspaceName *string `locationName:"sourceKeyspaceName" min:"1" type:"string" required:"true"`

	// The name of the source table.
	//
	// SourceTableName is a required field
	SourceTableName *string `locationName:"sourceTableName" min:"1" type:"string" required:"true"`

	// A list of key-value pair tags to be attached to the restored table.
	//
	// 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.
	TagsOverride []*Tag `locationName:"tagsOverride" min:"1" type:"list"`

	// The name of the target keyspace.
	//
	// TargetKeyspaceName is a required field
	TargetKeyspaceName *string `locationName:"targetKeyspaceName" min:"1" type:"string" required:"true"`

	// The name of the target table.
	//
	// TargetTableName is a required field
	TargetTableName *string `locationName:"targetTableName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RestoreTableInput) GoString 

func (s RestoreTableInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreTableInput) SetCapacitySpecificationOverride 

func (s *RestoreTableInput) SetCapacitySpecificationOverride(v *CapacitySpecification) *RestoreTableInput

SetCapacitySpecificationOverride sets the CapacitySpecificationOverride field's value.

func (*RestoreTableInput) SetEncryptionSpecificationOverride 

func (s *RestoreTableInput) SetEncryptionSpecificationOverride(v *EncryptionSpecification) *RestoreTableInput

SetEncryptionSpecificationOverride sets the EncryptionSpecificationOverride field's value.

func (*RestoreTableInput) SetPointInTimeRecoveryOverride 

func (s *RestoreTableInput) SetPointInTimeRecoveryOverride(v *PointInTimeRecovery) *RestoreTableInput

SetPointInTimeRecoveryOverride sets the PointInTimeRecoveryOverride field's value.

func (*RestoreTableInput) SetRestoreTimestamp 

func (s *RestoreTableInput) SetRestoreTimestamp(v time.Time) *RestoreTableInput

SetRestoreTimestamp sets the RestoreTimestamp field's value.

func (*RestoreTableInput) SetSourceKeyspaceName 

func (s *RestoreTableInput) SetSourceKeyspaceName(v string) *RestoreTableInput

SetSourceKeyspaceName sets the SourceKeyspaceName field's value.

func (*RestoreTableInput) SetSourceTableName 

func (s *RestoreTableInput) SetSourceTableName(v string) *RestoreTableInput

SetSourceTableName sets the SourceTableName field's value.

func (*RestoreTableInput) SetTagsOverride 

func (s *RestoreTableInput) SetTagsOverride(v []*Tag) *RestoreTableInput

SetTagsOverride sets the TagsOverride field's value.

func (*RestoreTableInput) SetTargetKeyspaceName 

func (s *RestoreTableInput) SetTargetKeyspaceName(v string) *RestoreTableInput

SetTargetKeyspaceName sets the TargetKeyspaceName field's value.

func (*RestoreTableInput) SetTargetTableName 

func (s *RestoreTableInput) SetTargetTableName(v string) *RestoreTableInput

SetTargetTableName sets the TargetTableName field's value.

func (RestoreTableInput) String 

func (s RestoreTableInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreTableInput) Validate 

func (s *RestoreTableInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RestoreTableOutput 

type RestoreTableOutput struct {

	// The Amazon Resource Name (ARN) of the restored table.
	//
	// RestoredTableARN is a required field
	RestoredTableARN *string `locationName:"restoredTableARN" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RestoreTableOutput) GoString 

func (s RestoreTableOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreTableOutput) SetRestoredTableARN 

func (s *RestoreTableOutput) SetRestoredTableARN(v string) *RestoreTableOutput

SetRestoredTableARN sets the RestoredTableARN field's value.

func (RestoreTableOutput) String 

func (s RestoreTableOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SchemaDefinition 

type SchemaDefinition struct {

	// The regular columns of the table.
	//
	// AllColumns is a required field
	AllColumns []*ColumnDefinition `locationName:"allColumns" min:"1" type:"list" required:"true"`

	// The columns that are part of the clustering key of the table.
	ClusteringKeys []*ClusteringKey `locationName:"clusteringKeys" type:"list"`

	// The columns that are part of the partition key of the table .
	//
	// PartitionKeys is a required field
	PartitionKeys []*PartitionKey `locationName:"partitionKeys" min:"1" type:"list" required:"true"`

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

Describes the schema of the table.

func (SchemaDefinition) GoString 

func (s SchemaDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SchemaDefinition) SetAllColumns 

func (s *SchemaDefinition) SetAllColumns(v []*ColumnDefinition) *SchemaDefinition

SetAllColumns sets the AllColumns field's value.

func (*SchemaDefinition) SetClusteringKeys 

func (s *SchemaDefinition) SetClusteringKeys(v []*ClusteringKey) *SchemaDefinition

SetClusteringKeys sets the ClusteringKeys field's value.

func (*SchemaDefinition) SetPartitionKeys 

func (s *SchemaDefinition) SetPartitionKeys(v []*PartitionKey) *SchemaDefinition

SetPartitionKeys sets the PartitionKeys field's value.

func (*SchemaDefinition) SetStaticColumns 

func (s *SchemaDefinition) SetStaticColumns(v []*StaticColumn) *SchemaDefinition

SetStaticColumns sets the StaticColumns field's value.

func (SchemaDefinition) String 

func (s SchemaDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SchemaDefinition) Validate 

func (s *SchemaDefinition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"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) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

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

func (ServiceQuotaExceededException) String 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StaticColumn 

type StaticColumn struct {

	// The name of the static column.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// 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.

func (StaticColumn) GoString 

func (s StaticColumn) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StaticColumn) SetName 

func (s *StaticColumn) SetName(v string) *StaticColumn

SetName sets the Name field's value.

func (StaticColumn) String 

func (s StaticColumn) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StaticColumn) Validate 

func (s *StaticColumn) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TableSummary 

type TableSummary struct {

	// The name of the keyspace that the table is stored in.
	//
	// KeyspaceName is a required field
	KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"`

	// The unique identifier of the table in the format of an Amazon Resource Name
	// (ARN).
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"20" type:"string" required:"true"`

	// The name of the table.
	//
	// TableName is a required field
	TableName *string `locationName:"tableName" min:"1" type:"string" required:"true"`
	// 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).

func (TableSummary) GoString 

func (s TableSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TableSummary) SetKeyspaceName 

func (s *TableSummary) SetKeyspaceName(v string) *TableSummary

SetKeyspaceName sets the KeyspaceName field's value.

func (*TableSummary) SetResourceArn 

func (s *TableSummary) SetResourceArn(v string) *TableSummary

SetResourceArn sets the ResourceArn field's value.

func (*TableSummary) SetTableName 

func (s *TableSummary) SetTableName(v string) *TableSummary

SetTableName sets the TableName field's value.

func (TableSummary) String 

func (s TableSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// Key is a required field
	Key *string `locationName:"key" min:"1" type:"string" required:"true"`

	// The value of the tag. Tag values are case-sensitive and can be null.
	//
	// Value is a required field
	Value *string `locationName:"value" min:"1" type:"string" required:"true"`
	// 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.

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String 

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which
	// to add tags.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"20" type:"string" required:"true"`

	// The tags to be assigned to the Amazon Keyspaces resource.
	//
	// Tags is a required field
	Tags []*Tag `locationName:"tags" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TimeToLive 

type TimeToLive struct {

	// Shows how to enable custom Time to Live (TTL) settings for the specified
	// table.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"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.

func (TimeToLive) GoString 

func (s TimeToLive) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeToLive) SetStatus 

func (s *TimeToLive) SetStatus(v string) *TimeToLive

SetStatus sets the Status field's value.

func (TimeToLive) String 

func (s TimeToLive) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TimeToLive) Validate 

func (s *TimeToLive) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Keyspaces resource that the tags will be removed from. This value
	// is an Amazon Resource Name (ARN).
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"20" type:"string" required:"true"`

	// A list of existing tags to be removed from the Amazon Keyspaces resource.
	//
	// Tags is a required field
	Tags []*Tag `locationName:"tags" min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTags 

func (s *UntagResourceInput) SetTags(v []*Tag) *UntagResourceInput

SetTags sets the Tags field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateTableInput 

type UpdateTableInput struct {

	// For each column to be added to the specified table:
	//
	//    * name - The name of the column.
	//
	//    * type - An Amazon Keyspaces data type. For more information, see Data
	//    types (https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types)
	//    in the Amazon Keyspaces Developer Guide.
	AddColumns []*ColumnDefinition `locationName:"addColumns" min:"1" type:"list"`

	// Modifies the read/write throughput capacity mode for the 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.
	CapacitySpecification *CapacitySpecification `locationName:"capacitySpecification" type:"structure"`

	// Enables client-side timestamps for the table. By default, the setting is
	// disabled. You can enable client-side timestamps with the following option:
	//
	//    * status: "enabled"
	//
	// Once client-side timestamps are enabled for a table, this setting cannot
	// be disabled.
	ClientSideTimestamps *ClientSideTimestamps `locationName:"clientSideTimestamps" type:"structure"`

	// The default Time to Live setting in seconds for the table.
	//
	// For more information, see Setting the default TTL value for a table (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl)
	// in the Amazon Keyspaces Developer Guide.
	DefaultTimeToLive *int64 `locationName:"defaultTimeToLive" min:"1" type:"integer"`

	// Modifies the encryption settings of the table. You can choose one of the
	// following KMS key (KMS key):
	//
	//    * 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 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.
	EncryptionSpecification *EncryptionSpecification `locationName:"encryptionSpecification" type:"structure"`

	// The name of the keyspace the specified table is stored in.
	//
	// KeyspaceName is a required field
	KeyspaceName *string `locationName:"keyspaceName" min:"1" type:"string" required:"true"`

	// Modifies the pointInTimeRecovery settings of the table. The options are:
	//
	//    * status=ENABLED
	//
	//    * status=DISABLED
	//
	// If it's not specified, the default is status=DISABLED.
	//
	// For more information, see Point-in-time recovery (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html)
	// in the Amazon Keyspaces Developer Guide.
	PointInTimeRecovery *PointInTimeRecovery `locationName:"pointInTimeRecovery" type:"structure"`

	// The name of the table.
	//
	// TableName is a required field
	TableName *string `locationName:"tableName" min:"1" type:"string" required:"true"`

	// Modifies Time to Live custom settings for the table. The options are:
	//
	//    * status:enabled
	//
	//    * status:disabled
	//
	// The default is status:disabled. After ttl is enabled, you can't disable it
	// for the table.
	//
	// For more information, see Expiring data by using Amazon Keyspaces Time to
	// Live (TTL) (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html)
	// in the Amazon Keyspaces Developer Guide.
	Ttl *TimeToLive `locationName:"ttl" type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateTableInput) GoString 

func (s UpdateTableInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTableInput) SetAddColumns 

func (s *UpdateTableInput) SetAddColumns(v []*ColumnDefinition) *UpdateTableInput

SetAddColumns sets the AddColumns field's value.

func (*UpdateTableInput) SetCapacitySpecification 

func (s *UpdateTableInput) SetCapacitySpecification(v *CapacitySpecification) *UpdateTableInput

SetCapacitySpecification sets the CapacitySpecification field's value.

func (*UpdateTableInput) SetClientSideTimestamps 

func (s *UpdateTableInput) SetClientSideTimestamps(v *ClientSideTimestamps) *UpdateTableInput

SetClientSideTimestamps sets the ClientSideTimestamps field's value.

func (*UpdateTableInput) SetDefaultTimeToLive 

func (s *UpdateTableInput) SetDefaultTimeToLive(v int64) *UpdateTableInput

SetDefaultTimeToLive sets the DefaultTimeToLive field's value.

func (*UpdateTableInput) SetEncryptionSpecification 

func (s *UpdateTableInput) SetEncryptionSpecification(v *EncryptionSpecification) *UpdateTableInput

SetEncryptionSpecification sets the EncryptionSpecification field's value.

func (*UpdateTableInput) SetKeyspaceName 

func (s *UpdateTableInput) SetKeyspaceName(v string) *UpdateTableInput

SetKeyspaceName sets the KeyspaceName field's value.

func (*UpdateTableInput) SetPointInTimeRecovery 

func (s *UpdateTableInput) SetPointInTimeRecovery(v *PointInTimeRecovery) *UpdateTableInput

SetPointInTimeRecovery sets the PointInTimeRecovery field's value.

func (*UpdateTableInput) SetTableName 

func (s *UpdateTableInput) SetTableName(v string) *UpdateTableInput

SetTableName sets the TableName field's value.

func (*UpdateTableInput) SetTtl 

func (s *UpdateTableInput) SetTtl(v *TimeToLive) *UpdateTableInput

SetTtl sets the Ttl field's value.

func (UpdateTableInput) String 

func (s UpdateTableInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTableInput) Validate 

func (s *UpdateTableInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateTableOutput 

type UpdateTableOutput struct {

	// The Amazon Resource Name (ARN) of the modified table.
	//
	// ResourceArn is a required field
	ResourceArn *string `locationName:"resourceArn" min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateTableOutput) GoString 

func (s UpdateTableOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTableOutput) SetResourceArn 

func (s *UpdateTableOutput) SetResourceArn(v string) *UpdateTableOutput

SetResourceArn sets the ResourceArn field's value.

func (UpdateTableOutput) String 

func (s UpdateTableOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The operation failed due to an invalid or malformed request.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

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

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package keyspacesiface provides an interface to enable mocking the Amazon Keyspaces service client for testing your code.
 Package keyspacesiface provides an interface to enable mocking the Amazon Keyspaces service client for testing your code.

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.