dynamodb

package
v1.44.58 Latest Latest
Warning

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

 Go to latest Published: Jul 19, 2022 License: Apache-2.0 Imports: 19 Imported by: 4,457

Documentation

Overview

Package dynamodb provides the client and types for making API requests to Amazon DynamoDB.

Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.

With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the Amazon Web Services Management Console to monitor resource utilization and performance metrics.

DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an Amazon Web Services Region, providing built-in high availability and data durability.

See https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10 for more information on this service.

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

Using the Client

To contact Amazon DynamoDB 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 DynamoDB client DynamoDB for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/dynamodb/#New

AttributeValue Marshaling and Unmarshaling Helpers

Utility helpers to marshal and unmarshal AttributeValue to and from Go types can be found in the dynamodbattribute sub package. This package provides specialized functions for the common ways of working with AttributeValues. Such as map[string]*AttributeValue, []*AttributeValue, and directly with *AttributeValue. This is helpful for marshaling Go types for API operations such as PutItem, and unmarshaling Query and Scan APIs' responses.

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

Expression Builders

The expression package provides utility types and functions to build DynamoDB expression for type safe construction of API ExpressionAttributeNames, and ExpressionAttribute Values.

The package represents the various DynamoDB Expressions as structs named accordingly. For example, ConditionBuilder represents a DynamoDB Condition Expression, an UpdateBuilder represents a DynamoDB Update Expression, and so on.

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

Index

Examples

Constants

View Source 
const (
	// AttributeActionAdd is a AttributeAction enum value
	AttributeActionAdd = "ADD"

	// AttributeActionPut is a AttributeAction enum value
	AttributeActionPut = "PUT"

	// AttributeActionDelete is a AttributeAction enum value
	AttributeActionDelete = "DELETE"
)
View Source 
const (
	// BackupStatusCreating is a BackupStatus enum value
	BackupStatusCreating = "CREATING"

	// BackupStatusDeleted is a BackupStatus enum value
	BackupStatusDeleted = "DELETED"

	// BackupStatusAvailable is a BackupStatus enum value
	BackupStatusAvailable = "AVAILABLE"
)
View Source 
const (
	// BackupTypeUser is a BackupType enum value
	BackupTypeUser = "USER"

	// BackupTypeSystem is a BackupType enum value
	BackupTypeSystem = "SYSTEM"

	// BackupTypeAwsBackup is a BackupType enum value
	BackupTypeAwsBackup = "AWS_BACKUP"
)
View Source 
const (
	// BackupTypeFilterUser is a BackupTypeFilter enum value
	BackupTypeFilterUser = "USER"

	// BackupTypeFilterSystem is a BackupTypeFilter enum value
	BackupTypeFilterSystem = "SYSTEM"

	// BackupTypeFilterAwsBackup is a BackupTypeFilter enum value
	BackupTypeFilterAwsBackup = "AWS_BACKUP"

	// BackupTypeFilterAll is a BackupTypeFilter enum value
	BackupTypeFilterAll = "ALL"
)
View Source 
const (
	// BatchStatementErrorCodeEnumConditionalCheckFailed is a BatchStatementErrorCodeEnum enum value
	BatchStatementErrorCodeEnumConditionalCheckFailed = "ConditionalCheckFailed"

	// BatchStatementErrorCodeEnumItemCollectionSizeLimitExceeded is a BatchStatementErrorCodeEnum enum value
	BatchStatementErrorCodeEnumItemCollectionSizeLimitExceeded = "ItemCollectionSizeLimitExceeded"

	// BatchStatementErrorCodeEnumRequestLimitExceeded is a BatchStatementErrorCodeEnum enum value
	BatchStatementErrorCodeEnumRequestLimitExceeded = "RequestLimitExceeded"

	// BatchStatementErrorCodeEnumValidationError is a BatchStatementErrorCodeEnum enum value
	BatchStatementErrorCodeEnumValidationError = "ValidationError"

	// BatchStatementErrorCodeEnumProvisionedThroughputExceeded is a BatchStatementErrorCodeEnum enum value
	BatchStatementErrorCodeEnumProvisionedThroughputExceeded = "ProvisionedThroughputExceeded"

	// BatchStatementErrorCodeEnumTransactionConflict is a BatchStatementErrorCodeEnum enum value
	BatchStatementErrorCodeEnumTransactionConflict = "TransactionConflict"

	// BatchStatementErrorCodeEnumThrottlingError is a BatchStatementErrorCodeEnum enum value
	BatchStatementErrorCodeEnumThrottlingError = "ThrottlingError"

	// BatchStatementErrorCodeEnumInternalServerError is a BatchStatementErrorCodeEnum enum value
	BatchStatementErrorCodeEnumInternalServerError = "InternalServerError"

	// BatchStatementErrorCodeEnumResourceNotFound is a BatchStatementErrorCodeEnum enum value
	BatchStatementErrorCodeEnumResourceNotFound = "ResourceNotFound"

	// BatchStatementErrorCodeEnumAccessDenied is a BatchStatementErrorCodeEnum enum value
	BatchStatementErrorCodeEnumAccessDenied = "AccessDenied"

	// BatchStatementErrorCodeEnumDuplicateItem is a BatchStatementErrorCodeEnum enum value
	BatchStatementErrorCodeEnumDuplicateItem = "DuplicateItem"
)
View Source 
const (
	// BillingModeProvisioned is a BillingMode enum value
	BillingModeProvisioned = "PROVISIONED"

	// BillingModePayPerRequest is a BillingMode enum value
	BillingModePayPerRequest = "PAY_PER_REQUEST"
)
View Source 
const (
	// ComparisonOperatorEq is a ComparisonOperator enum value
	ComparisonOperatorEq = "EQ"

	// ComparisonOperatorNe is a ComparisonOperator enum value
	ComparisonOperatorNe = "NE"

	// ComparisonOperatorIn is a ComparisonOperator enum value
	ComparisonOperatorIn = "IN"

	// ComparisonOperatorLe is a ComparisonOperator enum value
	ComparisonOperatorLe = "LE"

	// ComparisonOperatorLt is a ComparisonOperator enum value
	ComparisonOperatorLt = "LT"

	// ComparisonOperatorGe is a ComparisonOperator enum value
	ComparisonOperatorGe = "GE"

	// ComparisonOperatorGt is a ComparisonOperator enum value
	ComparisonOperatorGt = "GT"

	// ComparisonOperatorBetween is a ComparisonOperator enum value
	ComparisonOperatorBetween = "BETWEEN"

	// ComparisonOperatorNotNull is a ComparisonOperator enum value
	ComparisonOperatorNotNull = "NOT_NULL"

	// ComparisonOperatorNull is a ComparisonOperator enum value
	ComparisonOperatorNull = "NULL"

	// ComparisonOperatorContains is a ComparisonOperator enum value
	ComparisonOperatorContains = "CONTAINS"

	// ComparisonOperatorNotContains is a ComparisonOperator enum value
	ComparisonOperatorNotContains = "NOT_CONTAINS"

	// ComparisonOperatorBeginsWith is a ComparisonOperator enum value
	ComparisonOperatorBeginsWith = "BEGINS_WITH"
)
View Source 
const (
	// ConditionalOperatorAnd is a ConditionalOperator enum value
	ConditionalOperatorAnd = "AND"

	// ConditionalOperatorOr is a ConditionalOperator enum value
	ConditionalOperatorOr = "OR"
)
View Source 
const (
	// ContinuousBackupsStatusEnabled is a ContinuousBackupsStatus enum value
	ContinuousBackupsStatusEnabled = "ENABLED"

	// ContinuousBackupsStatusDisabled is a ContinuousBackupsStatus enum value
	ContinuousBackupsStatusDisabled = "DISABLED"
)
View Source 
const (
	// ContributorInsightsActionEnable is a ContributorInsightsAction enum value
	ContributorInsightsActionEnable = "ENABLE"

	// ContributorInsightsActionDisable is a ContributorInsightsAction enum value
	ContributorInsightsActionDisable = "DISABLE"
)
View Source 
const (
	// ContributorInsightsStatusEnabling is a ContributorInsightsStatus enum value
	ContributorInsightsStatusEnabling = "ENABLING"

	// ContributorInsightsStatusEnabled is a ContributorInsightsStatus enum value
	ContributorInsightsStatusEnabled = "ENABLED"

	// ContributorInsightsStatusDisabling is a ContributorInsightsStatus enum value
	ContributorInsightsStatusDisabling = "DISABLING"

	// ContributorInsightsStatusDisabled is a ContributorInsightsStatus enum value
	ContributorInsightsStatusDisabled = "DISABLED"

	// ContributorInsightsStatusFailed is a ContributorInsightsStatus enum value
	ContributorInsightsStatusFailed = "FAILED"
)
View Source 
const (
	// DestinationStatusEnabling is a DestinationStatus enum value
	DestinationStatusEnabling = "ENABLING"

	// DestinationStatusActive is a DestinationStatus enum value
	DestinationStatusActive = "ACTIVE"

	// DestinationStatusDisabling is a DestinationStatus enum value
	DestinationStatusDisabling = "DISABLING"

	// DestinationStatusDisabled is a DestinationStatus enum value
	DestinationStatusDisabled = "DISABLED"

	// DestinationStatusEnableFailed is a DestinationStatus enum value
	DestinationStatusEnableFailed = "ENABLE_FAILED"
)
View Source 
const (
	// ExportFormatDynamodbJson is a ExportFormat enum value
	ExportFormatDynamodbJson = "DYNAMODB_JSON"

	// ExportFormatIon is a ExportFormat enum value
	ExportFormatIon = "ION"
)
View Source 
const (
	// ExportStatusInProgress is a ExportStatus enum value
	ExportStatusInProgress = "IN_PROGRESS"

	// ExportStatusCompleted is a ExportStatus enum value
	ExportStatusCompleted = "COMPLETED"

	// ExportStatusFailed is a ExportStatus enum value
	ExportStatusFailed = "FAILED"
)
View Source 
const (
	// GlobalTableStatusCreating is a GlobalTableStatus enum value
	GlobalTableStatusCreating = "CREATING"

	// GlobalTableStatusActive is a GlobalTableStatus enum value
	GlobalTableStatusActive = "ACTIVE"

	// GlobalTableStatusDeleting is a GlobalTableStatus enum value
	GlobalTableStatusDeleting = "DELETING"

	// GlobalTableStatusUpdating is a GlobalTableStatus enum value
	GlobalTableStatusUpdating = "UPDATING"
)
View Source 
const (
	// IndexStatusCreating is a IndexStatus enum value
	IndexStatusCreating = "CREATING"

	// IndexStatusUpdating is a IndexStatus enum value
	IndexStatusUpdating = "UPDATING"

	// IndexStatusDeleting is a IndexStatus enum value
	IndexStatusDeleting = "DELETING"

	// IndexStatusActive is a IndexStatus enum value
	IndexStatusActive = "ACTIVE"
)
View Source 
const (
	// KeyTypeHash is a KeyType enum value
	KeyTypeHash = "HASH"

	// KeyTypeRange is a KeyType enum value
	KeyTypeRange = "RANGE"
)
View Source 
const (
	// PointInTimeRecoveryStatusEnabled is a PointInTimeRecoveryStatus enum value
	PointInTimeRecoveryStatusEnabled = "ENABLED"

	// PointInTimeRecoveryStatusDisabled is a PointInTimeRecoveryStatus enum value
	PointInTimeRecoveryStatusDisabled = "DISABLED"
)
View Source 
const (
	// ProjectionTypeAll is a ProjectionType enum value
	ProjectionTypeAll = "ALL"

	// ProjectionTypeKeysOnly is a ProjectionType enum value
	ProjectionTypeKeysOnly = "KEYS_ONLY"

	// ProjectionTypeInclude is a ProjectionType enum value
	ProjectionTypeInclude = "INCLUDE"
)
View Source 
const (
	// ReplicaStatusCreating is a ReplicaStatus enum value
	ReplicaStatusCreating = "CREATING"

	// ReplicaStatusCreationFailed is a ReplicaStatus enum value
	ReplicaStatusCreationFailed = "CREATION_FAILED"

	// ReplicaStatusUpdating is a ReplicaStatus enum value
	ReplicaStatusUpdating = "UPDATING"

	// ReplicaStatusDeleting is a ReplicaStatus enum value
	ReplicaStatusDeleting = "DELETING"

	// ReplicaStatusActive is a ReplicaStatus enum value
	ReplicaStatusActive = "ACTIVE"

	// ReplicaStatusRegionDisabled is a ReplicaStatus enum value
	ReplicaStatusRegionDisabled = "REGION_DISABLED"

	// ReplicaStatusInaccessibleEncryptionCredentials is a ReplicaStatus enum value
	ReplicaStatusInaccessibleEncryptionCredentials = "INACCESSIBLE_ENCRYPTION_CREDENTIALS"
)
View Source 
const (
	// ReturnConsumedCapacityIndexes is a ReturnConsumedCapacity enum value
	ReturnConsumedCapacityIndexes = "INDEXES"

	// ReturnConsumedCapacityTotal is a ReturnConsumedCapacity enum value
	ReturnConsumedCapacityTotal = "TOTAL"

	// ReturnConsumedCapacityNone is a ReturnConsumedCapacity enum value
	ReturnConsumedCapacityNone = "NONE"
)

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed. Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

  • NONE - No ConsumedCapacity details are included in the response.

View Source 
const (
	// ReturnItemCollectionMetricsSize is a ReturnItemCollectionMetrics enum value
	ReturnItemCollectionMetricsSize = "SIZE"

	// ReturnItemCollectionMetricsNone is a ReturnItemCollectionMetrics enum value
	ReturnItemCollectionMetricsNone = "NONE"
)
View Source 
const (
	// ReturnValueNone is a ReturnValue enum value
	ReturnValueNone = "NONE"

	// ReturnValueAllOld is a ReturnValue enum value
	ReturnValueAllOld = "ALL_OLD"

	// ReturnValueUpdatedOld is a ReturnValue enum value
	ReturnValueUpdatedOld = "UPDATED_OLD"

	// ReturnValueAllNew is a ReturnValue enum value
	ReturnValueAllNew = "ALL_NEW"

	// ReturnValueUpdatedNew is a ReturnValue enum value
	ReturnValueUpdatedNew = "UPDATED_NEW"
)
View Source 
const (
	// ReturnValuesOnConditionCheckFailureAllOld is a ReturnValuesOnConditionCheckFailure enum value
	ReturnValuesOnConditionCheckFailureAllOld = "ALL_OLD"

	// ReturnValuesOnConditionCheckFailureNone is a ReturnValuesOnConditionCheckFailure enum value
	ReturnValuesOnConditionCheckFailureNone = "NONE"
)
View Source 
const (
	// S3SseAlgorithmAes256 is a S3SseAlgorithm enum value
	S3SseAlgorithmAes256 = "AES256"

	// S3SseAlgorithmKms is a S3SseAlgorithm enum value
	S3SseAlgorithmKms = "KMS"
)
View Source 
const (
	// SSEStatusEnabling is a SSEStatus enum value
	SSEStatusEnabling = "ENABLING"

	// SSEStatusEnabled is a SSEStatus enum value
	SSEStatusEnabled = "ENABLED"

	// SSEStatusDisabling is a SSEStatus enum value
	SSEStatusDisabling = "DISABLING"

	// SSEStatusDisabled is a SSEStatus enum value
	SSEStatusDisabled = "DISABLED"

	// SSEStatusUpdating is a SSEStatus enum value
	SSEStatusUpdating = "UPDATING"
)
View Source 
const (
	// SSETypeAes256 is a SSEType enum value
	SSETypeAes256 = "AES256"

	// SSETypeKms is a SSEType enum value
	SSETypeKms = "KMS"
)
View Source 
const (
	// ScalarAttributeTypeS is a ScalarAttributeType enum value
	ScalarAttributeTypeS = "S"

	// ScalarAttributeTypeN is a ScalarAttributeType enum value
	ScalarAttributeTypeN = "N"

	// ScalarAttributeTypeB is a ScalarAttributeType enum value
	ScalarAttributeTypeB = "B"
)
View Source 
const (
	// SelectAllAttributes is a Select enum value
	SelectAllAttributes = "ALL_ATTRIBUTES"

	// SelectAllProjectedAttributes is a Select enum value
	SelectAllProjectedAttributes = "ALL_PROJECTED_ATTRIBUTES"

	// SelectSpecificAttributes is a Select enum value
	SelectSpecificAttributes = "SPECIFIC_ATTRIBUTES"

	// SelectCount is a Select enum value
	SelectCount = "COUNT"
)
View Source 
const (
	// StreamViewTypeNewImage is a StreamViewType enum value
	StreamViewTypeNewImage = "NEW_IMAGE"

	// StreamViewTypeOldImage is a StreamViewType enum value
	StreamViewTypeOldImage = "OLD_IMAGE"

	// StreamViewTypeNewAndOldImages is a StreamViewType enum value
	StreamViewTypeNewAndOldImages = "NEW_AND_OLD_IMAGES"

	// StreamViewTypeKeysOnly is a StreamViewType enum value
	StreamViewTypeKeysOnly = "KEYS_ONLY"
)
View Source 
const (
	// TableClassStandard is a TableClass enum value
	TableClassStandard = "STANDARD"

	// TableClassStandardInfrequentAccess is a TableClass enum value
	TableClassStandardInfrequentAccess = "STANDARD_INFREQUENT_ACCESS"
)
View Source 
const (
	// TableStatusCreating is a TableStatus enum value
	TableStatusCreating = "CREATING"

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

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

	// TableStatusActive is a TableStatus enum value
	TableStatusActive = "ACTIVE"

	// TableStatusInaccessibleEncryptionCredentials is a TableStatus enum value
	TableStatusInaccessibleEncryptionCredentials = "INACCESSIBLE_ENCRYPTION_CREDENTIALS"

	// TableStatusArchiving is a TableStatus enum value
	TableStatusArchiving = "ARCHIVING"

	// TableStatusArchived is a TableStatus enum value
	TableStatusArchived = "ARCHIVED"
)
View Source 
const (
	// TimeToLiveStatusEnabling is a TimeToLiveStatus enum value
	TimeToLiveStatusEnabling = "ENABLING"

	// TimeToLiveStatusDisabling is a TimeToLiveStatus enum value
	TimeToLiveStatusDisabling = "DISABLING"

	// TimeToLiveStatusEnabled is a TimeToLiveStatus enum value
	TimeToLiveStatusEnabled = "ENABLED"

	// TimeToLiveStatusDisabled is a TimeToLiveStatus enum value
	TimeToLiveStatusDisabled = "DISABLED"
)
View Source 
const (

	// ErrCodeBackupInUseException for service response error code
	// "BackupInUseException".
	//
	// There is another ongoing conflicting backup control plane operation on the
	// table. The backup is either being created, deleted or restored to a table.
	ErrCodeBackupInUseException = "BackupInUseException"

	// ErrCodeBackupNotFoundException for service response error code
	// "BackupNotFoundException".
	//
	// Backup not found for the given BackupARN.
	ErrCodeBackupNotFoundException = "BackupNotFoundException"

	// ErrCodeConditionalCheckFailedException for service response error code
	// "ConditionalCheckFailedException".
	//
	// A condition specified in the operation could not be evaluated.
	ErrCodeConditionalCheckFailedException = "ConditionalCheckFailedException"

	// ErrCodeContinuousBackupsUnavailableException for service response error code
	// "ContinuousBackupsUnavailableException".
	//
	// Backups have not yet been enabled for this table.
	ErrCodeContinuousBackupsUnavailableException = "ContinuousBackupsUnavailableException"

	// ErrCodeDuplicateItemException for service response error code
	// "DuplicateItemException".
	//
	// There was an attempt to insert an item with the same primary key as an item
	// that already exists in the DynamoDB table.
	ErrCodeDuplicateItemException = "DuplicateItemException"

	// ErrCodeExportConflictException for service response error code
	// "ExportConflictException".
	//
	// There was a conflict when writing to the specified S3 bucket.
	ErrCodeExportConflictException = "ExportConflictException"

	// ErrCodeExportNotFoundException for service response error code
	// "ExportNotFoundException".
	//
	// The specified export was not found.
	ErrCodeExportNotFoundException = "ExportNotFoundException"

	// ErrCodeGlobalTableAlreadyExistsException for service response error code
	// "GlobalTableAlreadyExistsException".
	//
	// The specified global table already exists.
	ErrCodeGlobalTableAlreadyExistsException = "GlobalTableAlreadyExistsException"

	// ErrCodeGlobalTableNotFoundException for service response error code
	// "GlobalTableNotFoundException".
	//
	// The specified global table does not exist.
	ErrCodeGlobalTableNotFoundException = "GlobalTableNotFoundException"

	// ErrCodeIdempotentParameterMismatchException for service response error code
	// "IdempotentParameterMismatchException".
	//
	// DynamoDB rejected the request because you retried a request with a different
	// payload but with an idempotent token that was already used.
	ErrCodeIdempotentParameterMismatchException = "IdempotentParameterMismatchException"

	// ErrCodeIndexNotFoundException for service response error code
	// "IndexNotFoundException".
	//
	// The operation tried to access a nonexistent index.
	ErrCodeIndexNotFoundException = "IndexNotFoundException"

	// ErrCodeInternalServerError for service response error code
	// "InternalServerError".
	//
	// An error occurred on the server side.
	ErrCodeInternalServerError = "InternalServerError"

	// ErrCodeInvalidExportTimeException for service response error code
	// "InvalidExportTimeException".
	//
	// The specified ExportTime is outside of the point in time recovery window.
	ErrCodeInvalidExportTimeException = "InvalidExportTimeException"

	// ErrCodeInvalidRestoreTimeException for service response error code
	// "InvalidRestoreTimeException".
	//
	// An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime
	// and LatestRestorableDateTime.
	ErrCodeInvalidRestoreTimeException = "InvalidRestoreTimeException"

	// ErrCodeItemCollectionSizeLimitExceededException for service response error code
	// "ItemCollectionSizeLimitExceededException".
	//
	// An item collection is too large. This exception is only returned for tables
	// that have one or more local secondary indexes.
	ErrCodeItemCollectionSizeLimitExceededException = "ItemCollectionSizeLimitExceededException"

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

	// ErrCodePointInTimeRecoveryUnavailableException for service response error code
	// "PointInTimeRecoveryUnavailableException".
	//
	// Point in time recovery has not yet been enabled for this source table.
	ErrCodePointInTimeRecoveryUnavailableException = "PointInTimeRecoveryUnavailableException"

	// ErrCodeProvisionedThroughputExceededException for service response error code
	// "ProvisionedThroughputExceededException".
	//
	// Your request rate is too high. The Amazon Web Services SDKs for DynamoDB
	// automatically retry requests that receive this exception. Your request is
	// eventually successful, unless your retry queue is too large to finish. Reduce
	// the frequency of requests and use exponential backoff. For more information,
	// go to Error Retries and Exponential Backoff (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff)
	// in the Amazon DynamoDB Developer Guide.
	ErrCodeProvisionedThroughputExceededException = "ProvisionedThroughputExceededException"

	// ErrCodeReplicaAlreadyExistsException for service response error code
	// "ReplicaAlreadyExistsException".
	//
	// The specified replica is already part of the global table.
	ErrCodeReplicaAlreadyExistsException = "ReplicaAlreadyExistsException"

	// ErrCodeReplicaNotFoundException for service response error code
	// "ReplicaNotFoundException".
	//
	// The specified replica is no longer part of the global table.
	ErrCodeReplicaNotFoundException = "ReplicaNotFoundException"

	// ErrCodeRequestLimitExceeded for service response error code
	// "RequestLimitExceeded".
	//
	// Throughput exceeds the current throughput quota for your account. Please
	// contact Amazon Web Services Support (https://aws.amazon.com/support) to request
	// a quota increase.
	ErrCodeRequestLimitExceeded = "RequestLimitExceeded"

	// ErrCodeResourceInUseException for service response error code
	// "ResourceInUseException".
	//
	// The operation conflicts with the resource's availability. For example, you
	// attempted to recreate an existing table, or tried to delete a table currently
	// in the CREATING state.
	ErrCodeResourceInUseException = "ResourceInUseException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The operation tried to access a nonexistent table or index. The resource
	// might not be specified correctly, or its status might not be ACTIVE.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeTableAlreadyExistsException for service response error code
	// "TableAlreadyExistsException".
	//
	// A target table with the specified name already exists.
	ErrCodeTableAlreadyExistsException = "TableAlreadyExistsException"

	// ErrCodeTableInUseException for service response error code
	// "TableInUseException".
	//
	// A target table with the specified name is either being created or deleted.
	ErrCodeTableInUseException = "TableInUseException"

	// ErrCodeTableNotFoundException for service response error code
	// "TableNotFoundException".
	//
	// A source table with the name TableName does not currently exist within the
	// subscriber's account or the subscriber is operating in the wrong Amazon Web
	// Services Region.
	ErrCodeTableNotFoundException = "TableNotFoundException"

	// ErrCodeTransactionCanceledException for service response error code
	// "TransactionCanceledException".
	//
	// The entire transaction request was canceled.
	//
	// DynamoDB cancels a TransactWriteItems request under the following circumstances:
	//
	//    * A condition in one of the condition expressions is not met.
	//
	//    * A table in the TransactWriteItems request is in a different account
	//    or region.
	//
	//    * More than one action in the TransactWriteItems operation targets the
	//    same item.
	//
	//    * There is insufficient provisioned capacity for the transaction to be
	//    completed.
	//
	//    * An item size becomes too large (larger than 400 KB), or a local secondary
	//    index (LSI) becomes too large, or a similar validation error occurs because
	//    of changes made by the transaction.
	//
	//    * There is a user error, such as an invalid data format.
	//
	// DynamoDB cancels a TransactGetItems request under the following circumstances:
	//
	//    * There is an ongoing TransactGetItems operation that conflicts with a
	//    concurrent PutItem, UpdateItem, DeleteItem or TransactWriteItems request.
	//    In this case the TransactGetItems operation fails with a TransactionCanceledException.
	//
	//    * A table in the TransactGetItems request is in a different account or
	//    region.
	//
	//    * There is insufficient provisioned capacity for the transaction to be
	//    completed.
	//
	//    * There is a user error, such as an invalid data format.
	//
	// If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons
	// property. This property is not set for other languages. Transaction cancellation
	// reasons are ordered in the order of requested items, if an item has no error
	// it will have None code and Null message.
	//
	// Cancellation reason codes and possible error messages:
	//
	//    * No Errors: Code: None Message: null
	//
	//    * Conditional Check Failed: Code: ConditionalCheckFailed Message: The
	//    conditional request failed.
	//
	//    * Item Collection Size Limit Exceeded: Code: ItemCollectionSizeLimitExceeded
	//    Message: Collection size exceeded.
	//
	//    * Transaction Conflict: Code: TransactionConflict Message: Transaction
	//    is ongoing for the item.
	//
	//    * Provisioned Throughput Exceeded: Code: ProvisionedThroughputExceeded
	//    Messages: The level of configured provisioned throughput for the table
	//    was exceeded. Consider increasing your provisioning level with the UpdateTable
	//    API. This Message is received when provisioned throughput is exceeded
	//    is on a provisioned DynamoDB table. The level of configured provisioned
	//    throughput for one or more global secondary indexes of the table was exceeded.
	//    Consider increasing your provisioning level for the under-provisioned
	//    global secondary indexes with the UpdateTable API. This message is returned
	//    when provisioned throughput is exceeded is on a provisioned GSI.
	//
	//    * Throttling Error: Code: ThrottlingError Messages: Throughput exceeds
	//    the current capacity of your table or index. DynamoDB is automatically
	//    scaling your table or index so please try again shortly. If exceptions
	//    persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
	//    This message is returned when writes get throttled on an On-Demand table
	//    as DynamoDB is automatically scaling the table. Throughput exceeds the
	//    current capacity for one or more global secondary indexes. DynamoDB is
	//    automatically scaling your index so please try again shortly. This message
	//    is returned when when writes get throttled on an On-Demand GSI as DynamoDB
	//    is automatically scaling the GSI.
	//
	//    * Validation Error: Code: ValidationError Messages: One or more parameter
	//    values were invalid. The update expression attempted to update the secondary
	//    index key beyond allowed size limits. The update expression attempted
	//    to update the secondary index key to unsupported type. An operand in the
	//    update expression has an incorrect data type. Item size to update has
	//    exceeded the maximum allowed size. Number overflow. Attempting to store
	//    a number with magnitude larger than supported range. Type mismatch for
	//    attribute to update. Nesting Levels have exceeded supported limits. The
	//    document path provided in the update expression is invalid for update.
	//    The provided expression refers to an attribute that does not exist in
	//    the item.
	ErrCodeTransactionCanceledException = "TransactionCanceledException"

	// ErrCodeTransactionConflictException for service response error code
	// "TransactionConflictException".
	//
	// Operation was rejected because there is an ongoing transaction for the item.
	ErrCodeTransactionConflictException = "TransactionConflictException"

	// ErrCodeTransactionInProgressException for service response error code
	// "TransactionInProgressException".
	//
	// The transaction with the given request token is already in progress.
	ErrCodeTransactionInProgressException = "TransactionInProgressException"
)
View Source 
const (
	ServiceName = "dynamodb"  // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "DynamoDB"  // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func AttributeAction_Values added in v1.34.3 

func AttributeAction_Values() []string

AttributeAction_Values returns all elements of the AttributeAction enum

func BackupStatus_Values added in v1.34.3 

func BackupStatus_Values() []string

BackupStatus_Values returns all elements of the BackupStatus enum

func BackupTypeFilter_Values added in v1.34.3 

func BackupTypeFilter_Values() []string

BackupTypeFilter_Values returns all elements of the BackupTypeFilter enum

func BackupType_Values added in v1.34.3 

func BackupType_Values() []string

BackupType_Values returns all elements of the BackupType enum

func BatchStatementErrorCodeEnum_Values added in v1.35.34 

func BatchStatementErrorCodeEnum_Values() []string

BatchStatementErrorCodeEnum_Values returns all elements of the BatchStatementErrorCodeEnum enum

func BillingMode_Values added in v1.34.3 

func BillingMode_Values() []string

BillingMode_Values returns all elements of the BillingMode enum

func ComparisonOperator_Values added in v1.34.3 

func ComparisonOperator_Values() []string

ComparisonOperator_Values returns all elements of the ComparisonOperator enum

func ConditionalOperator_Values added in v1.34.3 

func ConditionalOperator_Values() []string

ConditionalOperator_Values returns all elements of the ConditionalOperator enum

func ContinuousBackupsStatus_Values added in v1.34.3 

func ContinuousBackupsStatus_Values() []string

ContinuousBackupsStatus_Values returns all elements of the ContinuousBackupsStatus enum

func ContributorInsightsAction_Values added in v1.34.3 

func ContributorInsightsAction_Values() []string

ContributorInsightsAction_Values returns all elements of the ContributorInsightsAction enum

func ContributorInsightsStatus_Values added in v1.34.3 

func ContributorInsightsStatus_Values() []string

ContributorInsightsStatus_Values returns all elements of the ContributorInsightsStatus enum

func DestinationStatus_Values added in v1.35.34 

func DestinationStatus_Values() []string

DestinationStatus_Values returns all elements of the DestinationStatus enum

func ExportFormat_Values added in v1.35.24 

func ExportFormat_Values() []string

ExportFormat_Values returns all elements of the ExportFormat enum

func ExportStatus_Values added in v1.35.24 

func ExportStatus_Values() []string

ExportStatus_Values returns all elements of the ExportStatus enum

func GlobalTableStatus_Values added in v1.34.3 

func GlobalTableStatus_Values() []string

GlobalTableStatus_Values returns all elements of the GlobalTableStatus enum

func IndexStatus_Values added in v1.34.3 

func IndexStatus_Values() []string

IndexStatus_Values returns all elements of the IndexStatus enum

func KeyType_Values added in v1.34.3 

func KeyType_Values() []string

KeyType_Values returns all elements of the KeyType enum

func PointInTimeRecoveryStatus_Values added in v1.34.3 

func PointInTimeRecoveryStatus_Values() []string

PointInTimeRecoveryStatus_Values returns all elements of the PointInTimeRecoveryStatus enum

func ProjectionType_Values added in v1.34.3 

func ProjectionType_Values() []string

ProjectionType_Values returns all elements of the ProjectionType enum

func ReplicaStatus_Values added in v1.34.3 

func ReplicaStatus_Values() []string

ReplicaStatus_Values returns all elements of the ReplicaStatus enum

func ReturnConsumedCapacity_Values added in v1.34.3 

func ReturnConsumedCapacity_Values() []string

ReturnConsumedCapacity_Values returns all elements of the ReturnConsumedCapacity enum

func ReturnItemCollectionMetrics_Values added in v1.34.3 

func ReturnItemCollectionMetrics_Values() []string

ReturnItemCollectionMetrics_Values returns all elements of the ReturnItemCollectionMetrics enum

func ReturnValue_Values added in v1.34.3 

func ReturnValue_Values() []string

ReturnValue_Values returns all elements of the ReturnValue enum

func ReturnValuesOnConditionCheckFailure_Values added in v1.34.3 

func ReturnValuesOnConditionCheckFailure_Values() []string

ReturnValuesOnConditionCheckFailure_Values returns all elements of the ReturnValuesOnConditionCheckFailure enum

func S3SseAlgorithm_Values added in v1.35.24 

func S3SseAlgorithm_Values() []string

S3SseAlgorithm_Values returns all elements of the S3SseAlgorithm enum

func SSEStatus_Values added in v1.34.3 

func SSEStatus_Values() []string

SSEStatus_Values returns all elements of the SSEStatus enum

func SSEType_Values added in v1.34.3 

func SSEType_Values() []string

SSEType_Values returns all elements of the SSEType enum

func ScalarAttributeType_Values added in v1.34.3 

func ScalarAttributeType_Values() []string

ScalarAttributeType_Values returns all elements of the ScalarAttributeType enum

func Select_Values added in v1.34.3 

func Select_Values() []string

Select_Values returns all elements of the Select enum

func StreamViewType_Values added in v1.34.3 

func StreamViewType_Values() []string

StreamViewType_Values returns all elements of the StreamViewType enum

func TableClass_Values added in v1.42.17 

func TableClass_Values() []string

TableClass_Values returns all elements of the TableClass enum

func TableStatus_Values added in v1.34.3 

func TableStatus_Values() []string

TableStatus_Values returns all elements of the TableStatus enum

func TimeToLiveStatus_Values added in v1.34.3 

func TimeToLiveStatus_Values() []string

TimeToLiveStatus_Values returns all elements of the TimeToLiveStatus enum

Types

type ArchivalSummary added in v1.25.43 

type ArchivalSummary struct {

	// The Amazon Resource Name (ARN) of the backup the table was archived to, when
	// applicable in the archival reason. If you wish to restore this backup to
	// the same table name, you will need to delete the original table.
	ArchivalBackupArn *string `min:"37" type:"string"`

	// The date and time when table archival was initiated by DynamoDB, in UNIX
	// epoch time format.
	ArchivalDateTime *time.Time `type:"timestamp"`

	// The reason DynamoDB archived the table. Currently, the only possible value
	// is:
	//
	//    * INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to
	//    the table's KMS key being inaccessible for more than seven days. An On-Demand
	//    backup was created at the archival time.
	ArchivalReason *string `type:"string"`
	// contains filtered or unexported fields
}

Contains details of a table archival operation.

func (ArchivalSummary) GoString added in v1.25.43 

func (s ArchivalSummary) 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 (*ArchivalSummary) SetArchivalBackupArn added in v1.25.43 

func (s *ArchivalSummary) SetArchivalBackupArn(v string) *ArchivalSummary

SetArchivalBackupArn sets the ArchivalBackupArn field's value.

func (*ArchivalSummary) SetArchivalDateTime added in v1.25.43 

func (s *ArchivalSummary) SetArchivalDateTime(v time.Time) *ArchivalSummary

SetArchivalDateTime sets the ArchivalDateTime field's value.

func (*ArchivalSummary) SetArchivalReason added in v1.25.43 

func (s *ArchivalSummary) SetArchivalReason(v string) *ArchivalSummary

SetArchivalReason sets the ArchivalReason field's value.

func (ArchivalSummary) String added in v1.25.43 

func (s ArchivalSummary) 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 AttributeDefinition 

type AttributeDefinition struct {

	// A name for the attribute.
	//
	// AttributeName is a required field
	AttributeName *string `min:"1" type:"string" required:"true"`

	// The data type for the attribute, where:
	//
	//    * S - the attribute is of type String
	//
	//    * N - the attribute is of type Number
	//
	//    * B - the attribute is of type Binary
	//
	// AttributeType is a required field
	AttributeType *string `type:"string" required:"true" enum:"ScalarAttributeType"`
	// contains filtered or unexported fields
}

Represents an attribute for describing the key schema for the table and indexes.

func (AttributeDefinition) GoString added in v0.6.5 

func (s AttributeDefinition) 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 (*AttributeDefinition) SetAttributeName added in v1.5.0 

func (s *AttributeDefinition) SetAttributeName(v string) *AttributeDefinition

SetAttributeName sets the AttributeName field's value.

func (*AttributeDefinition) SetAttributeType added in v1.5.0 

func (s *AttributeDefinition) SetAttributeType(v string) *AttributeDefinition

SetAttributeType sets the AttributeType field's value.

func (AttributeDefinition) String added in v0.6.5 

func (s AttributeDefinition) 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 (*AttributeDefinition) Validate added in v1.1.21 

func (s *AttributeDefinition) Validate() error

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

type AttributeValue 

type AttributeValue struct {

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

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

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

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

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

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

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

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

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

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

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes) in the Amazon DynamoDB Developer Guide.

func (AttributeValue) GoString added in v0.6.5 

func (s AttributeValue) 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 (*AttributeValue) SetB added in v1.5.0 

func (s *AttributeValue) SetB(v []byte) *AttributeValue

SetB sets the B field's value.

func (*AttributeValue) SetBOOL added in v1.5.0 

func (s *AttributeValue) SetBOOL(v bool) *AttributeValue

SetBOOL sets the BOOL field's value.

func (*AttributeValue) SetBS added in v1.5.0 

func (s *AttributeValue) SetBS(v [][]byte) *AttributeValue

SetBS sets the BS field's value.

func (*AttributeValue) SetL added in v1.5.0 

func (s *AttributeValue) SetL(v []*AttributeValue) *AttributeValue

SetL sets the L field's value.

func (*AttributeValue) SetM added in v1.5.0 

func (s *AttributeValue) SetM(v map[string]*AttributeValue) *AttributeValue

SetM sets the M field's value.

func (*AttributeValue) SetN added in v1.5.0 

func (s *AttributeValue) SetN(v string) *AttributeValue

SetN sets the N field's value.

func (*AttributeValue) SetNS added in v1.5.0 

func (s *AttributeValue) SetNS(v []*string) *AttributeValue

SetNS sets the NS field's value.

func (*AttributeValue) SetNULL added in v1.5.0 

func (s *AttributeValue) SetNULL(v bool) *AttributeValue

SetNULL sets the NULL field's value.

func (*AttributeValue) SetS added in v1.5.0 

func (s *AttributeValue) SetS(v string) *AttributeValue

SetS sets the S field's value.

func (*AttributeValue) SetSS added in v1.5.0 

func (s *AttributeValue) SetSS(v []*string) *AttributeValue

SetSS sets the SS field's value.

func (AttributeValue) String added in v0.6.5 

func (s AttributeValue) 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 AttributeValueUpdate 

type AttributeValueUpdate struct {

	// Specifies how to perform the update. Valid values are PUT (default), DELETE,
	// and ADD. The behavior depends on whether the specified primary key already
	// exists in the table.
	//
	// If an item with the specified Key is found in the table:
	//
	//    * PUT - Adds the specified attribute to the item. If the attribute already
	//    exists, it is replaced by the new value.
	//
	//    * DELETE - If no value is specified, the attribute and its value are removed
	//    from the item. The data type of the specified value must match the existing
	//    value's data type. If a set of values is specified, then those values
	//    are subtracted from the old set. For example, if the attribute value was
	//    the set [a,b,c] and the DELETE action specified [a,c], then the final
	//    attribute value would be [b]. Specifying an empty set is an error.
	//
	//    * ADD - If the attribute does not already exist, then the attribute and
	//    its values are added to the item. If the attribute does exist, then the
	//    behavior of ADD depends on the data type of the attribute: If the existing
	//    attribute is a number, and if Value is also a number, then the Value is
	//    mathematically added to the existing attribute. If Value is a negative
	//    number, then it is subtracted from the existing attribute. If you use
	//    ADD to increment or decrement a number value for an item that doesn't
	//    exist before the update, DynamoDB uses 0 as the initial value. In addition,
	//    if you use ADD to update an existing item, and intend to increment or
	//    decrement an attribute value which does not yet exist, DynamoDB uses 0
	//    as the initial value. For example, suppose that the item you want to update
	//    does not yet have an attribute named itemcount, but you decide to ADD
	//    the number 3 to this attribute anyway, even though it currently does not
	//    exist. DynamoDB will create the itemcount attribute, set its initial value
	//    to 0, and finally add 3 to it. The result will be a new itemcount attribute
	//    in the item, with a value of 3. If the existing data type is a set, and
	//    if the Value is also a set, then the Value is added to the existing set.
	//    (This is a set operation, not mathematical addition.) For example, if
	//    the attribute value was the set [1,2], and the ADD action specified [3],
	//    then the final attribute value would be [1,2,3]. An error occurs if an
	//    Add action is specified for a set attribute and the attribute type specified
	//    does not match the existing set type. Both sets must have the same primitive
	//    data type. For example, if the existing data type is a set of strings,
	//    the Value must also be a set of strings. The same holds true for number
	//    sets and binary sets. This action is only valid for an existing attribute
	//    whose data type is number or is a set. Do not use ADD for any other data
	//    types.
	//
	// If no item with the specified Key is found:
	//
	//    * PUT - DynamoDB creates a new item with the specified primary key, and
	//    then adds the attribute.
	//
	//    * DELETE - Nothing happens; there is no attribute to delete.
	//
	//    * ADD - DynamoDB creates a new item with the supplied primary key and
	//    number (or set) for the attribute value. The only data types allowed are
	//    number, number set, string set or binary set.
	Action *string `type:"string" enum:"AttributeAction"`

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

For the UpdateItem operation, represents the attributes to be modified, the action to perform on each, and the new value for each.

You cannot use UpdateItem to update any primary key attributes. Instead, you will need to delete the item, and then use PutItem to create a new item with new attributes.

Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.

func (AttributeValueUpdate) GoString added in v0.6.5 

func (s AttributeValueUpdate) 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 (*AttributeValueUpdate) SetAction added in v1.5.0 

func (s *AttributeValueUpdate) SetAction(v string) *AttributeValueUpdate

SetAction sets the Action field's value.

func (*AttributeValueUpdate) SetValue added in v1.5.0 

func (s *AttributeValueUpdate) SetValue(v *AttributeValue) *AttributeValueUpdate

SetValue sets the Value field's value.

func (AttributeValueUpdate) String added in v0.6.5 

func (s AttributeValueUpdate) 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 AutoScalingPolicyDescription added in v1.14.32 

type AutoScalingPolicyDescription struct {

	// The name of the scaling policy.
	PolicyName *string `min:"1" type:"string"`

	// Represents a target tracking scaling policy configuration.
	TargetTrackingScalingPolicyConfiguration *AutoScalingTargetTrackingScalingPolicyConfigurationDescription `type:"structure"`
	// contains filtered or unexported fields
}

Represents the properties of the scaling policy.

func (AutoScalingPolicyDescription) GoString added in v1.14.32 

func (s AutoScalingPolicyDescription) 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 (*AutoScalingPolicyDescription) SetPolicyName added in v1.14.32 

func (s *AutoScalingPolicyDescription) SetPolicyName(v string) *AutoScalingPolicyDescription

SetPolicyName sets the PolicyName field's value.

func (*AutoScalingPolicyDescription) SetTargetTrackingScalingPolicyConfiguration added in v1.14.32 

func (s *AutoScalingPolicyDescription) SetTargetTrackingScalingPolicyConfiguration(v *AutoScalingTargetTrackingScalingPolicyConfigurationDescription) *AutoScalingPolicyDescription

SetTargetTrackingScalingPolicyConfiguration sets the TargetTrackingScalingPolicyConfiguration field's value.

func (AutoScalingPolicyDescription) String added in v1.14.32 

func (s AutoScalingPolicyDescription) 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 AutoScalingPolicyUpdate added in v1.14.32 

type AutoScalingPolicyUpdate struct {

	// The name of the scaling policy.
	PolicyName *string `min:"1" type:"string"`

	// Represents a target tracking scaling policy configuration.
	//
	// TargetTrackingScalingPolicyConfiguration is a required field
	TargetTrackingScalingPolicyConfiguration *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the auto scaling policy to be modified.

func (AutoScalingPolicyUpdate) GoString added in v1.14.32 

func (s AutoScalingPolicyUpdate) 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 (*AutoScalingPolicyUpdate) SetPolicyName added in v1.14.32 

func (s *AutoScalingPolicyUpdate) SetPolicyName(v string) *AutoScalingPolicyUpdate

SetPolicyName sets the PolicyName field's value.

func (*AutoScalingPolicyUpdate) SetTargetTrackingScalingPolicyConfiguration added in v1.14.32 

func (s *AutoScalingPolicyUpdate) SetTargetTrackingScalingPolicyConfiguration(v *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) *AutoScalingPolicyUpdate

SetTargetTrackingScalingPolicyConfiguration sets the TargetTrackingScalingPolicyConfiguration field's value.

func (AutoScalingPolicyUpdate) String added in v1.14.32 

func (s AutoScalingPolicyUpdate) 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 (*AutoScalingPolicyUpdate) Validate added in v1.14.32 

func (s *AutoScalingPolicyUpdate) Validate() error

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

type AutoScalingSettingsDescription added in v1.14.32 

type AutoScalingSettingsDescription struct {

	// Disabled auto scaling for this global table or global secondary index.
	AutoScalingDisabled *bool `type:"boolean"`

	// Role ARN used for configuring the auto scaling policy.
	AutoScalingRoleArn *string `type:"string"`

	// The maximum capacity units that a global table or global secondary index
	// should be scaled up to.
	MaximumUnits *int64 `min:"1" type:"long"`

	// The minimum capacity units that a global table or global secondary index
	// should be scaled down to.
	MinimumUnits *int64 `min:"1" type:"long"`

	// Information about the scaling policies.
	ScalingPolicies []*AutoScalingPolicyDescription `type:"list"`
	// contains filtered or unexported fields
}

Represents the auto scaling settings for a global table or global secondary index.

func (AutoScalingSettingsDescription) GoString added in v1.14.32 

func (s AutoScalingSettingsDescription) 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 (*AutoScalingSettingsDescription) SetAutoScalingDisabled added in v1.14.32 

func (s *AutoScalingSettingsDescription) SetAutoScalingDisabled(v bool) *AutoScalingSettingsDescription

SetAutoScalingDisabled sets the AutoScalingDisabled field's value.

func (*AutoScalingSettingsDescription) SetAutoScalingRoleArn added in v1.14.32 

func (s *AutoScalingSettingsDescription) SetAutoScalingRoleArn(v string) *AutoScalingSettingsDescription

SetAutoScalingRoleArn sets the AutoScalingRoleArn field's value.

func (*AutoScalingSettingsDescription) SetMaximumUnits added in v1.14.32 

func (s *AutoScalingSettingsDescription) SetMaximumUnits(v int64) *AutoScalingSettingsDescription

SetMaximumUnits sets the MaximumUnits field's value.

func (*AutoScalingSettingsDescription) SetMinimumUnits added in v1.14.32 

func (s *AutoScalingSettingsDescription) SetMinimumUnits(v int64) *AutoScalingSettingsDescription

SetMinimumUnits sets the MinimumUnits field's value.

func (*AutoScalingSettingsDescription) SetScalingPolicies added in v1.14.32 

func (s *AutoScalingSettingsDescription) SetScalingPolicies(v []*AutoScalingPolicyDescription) *AutoScalingSettingsDescription

SetScalingPolicies sets the ScalingPolicies field's value.

func (AutoScalingSettingsDescription) String added in v1.14.32 

func (s AutoScalingSettingsDescription) 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 AutoScalingSettingsUpdate added in v1.14.32 

type AutoScalingSettingsUpdate struct {

	// Disabled auto scaling for this global table or global secondary index.
	AutoScalingDisabled *bool `type:"boolean"`

	// Role ARN used for configuring auto scaling policy.
	AutoScalingRoleArn *string `min:"1" type:"string"`

	// The maximum capacity units that a global table or global secondary index
	// should be scaled up to.
	MaximumUnits *int64 `min:"1" type:"long"`

	// The minimum capacity units that a global table or global secondary index
	// should be scaled down to.
	MinimumUnits *int64 `min:"1" type:"long"`

	// The scaling policy to apply for scaling target global table or global secondary
	// index capacity units.
	ScalingPolicyUpdate *AutoScalingPolicyUpdate `type:"structure"`
	// contains filtered or unexported fields
}

Represents the auto scaling settings to be modified for a global table or global secondary index.

func (AutoScalingSettingsUpdate) GoString added in v1.14.32 

func (s AutoScalingSettingsUpdate) 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 (*AutoScalingSettingsUpdate) SetAutoScalingDisabled added in v1.14.32 

func (s *AutoScalingSettingsUpdate) SetAutoScalingDisabled(v bool) *AutoScalingSettingsUpdate

SetAutoScalingDisabled sets the AutoScalingDisabled field's value.

func (*AutoScalingSettingsUpdate) SetAutoScalingRoleArn added in v1.14.32 

func (s *AutoScalingSettingsUpdate) SetAutoScalingRoleArn(v string) *AutoScalingSettingsUpdate

SetAutoScalingRoleArn sets the AutoScalingRoleArn field's value.

func (*AutoScalingSettingsUpdate) SetMaximumUnits added in v1.14.32 

func (s *AutoScalingSettingsUpdate) SetMaximumUnits(v int64) *AutoScalingSettingsUpdate

SetMaximumUnits sets the MaximumUnits field's value.

func (*AutoScalingSettingsUpdate) SetMinimumUnits added in v1.14.32 

func (s *AutoScalingSettingsUpdate) SetMinimumUnits(v int64) *AutoScalingSettingsUpdate

SetMinimumUnits sets the MinimumUnits field's value.

func (*AutoScalingSettingsUpdate) SetScalingPolicyUpdate added in v1.14.32 

func (s *AutoScalingSettingsUpdate) SetScalingPolicyUpdate(v *AutoScalingPolicyUpdate) *AutoScalingSettingsUpdate

SetScalingPolicyUpdate sets the ScalingPolicyUpdate field's value.

func (AutoScalingSettingsUpdate) String added in v1.14.32 

func (s AutoScalingSettingsUpdate) 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 (*AutoScalingSettingsUpdate) Validate added in v1.14.32 

func (s *AutoScalingSettingsUpdate) Validate() error

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

type AutoScalingTargetTrackingScalingPolicyConfigurationDescription added in v1.14.32 

type AutoScalingTargetTrackingScalingPolicyConfigurationDescription struct {

	// Indicates whether scale in by the target tracking policy is disabled. If
	// the value is true, scale in is disabled and the target tracking policy won't
	// remove capacity from the scalable resource. Otherwise, scale in is enabled
	// and the target tracking policy can remove capacity from the scalable resource.
	// The default value is false.
	DisableScaleIn *bool `type:"boolean"`

	// The amount of time, in seconds, after a scale in activity completes before
	// another scale in activity can start. The cooldown period is used to block
	// subsequent scale in requests until it has expired. You should scale in conservatively
	// to protect your application's availability. However, if another alarm triggers
	// a scale out policy during the cooldown period after a scale-in, application
	// auto scaling scales out your scalable target immediately.
	ScaleInCooldown *int64 `type:"integer"`

	// The amount of time, in seconds, after a scale out activity completes before
	// another scale out activity can start. While the cooldown period is in effect,
	// the capacity that has been added by the previous scale out event that initiated
	// the cooldown is calculated as part of the desired capacity for the next scale
	// out. You should continuously (but not excessively) scale out.
	ScaleOutCooldown *int64 `type:"integer"`

	// The target value for the metric. The range is 8.515920e-109 to 1.174271e+108
	// (Base 10) or 2e-360 to 2e360 (Base 2).
	//
	// TargetValue is a required field
	TargetValue *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

Represents the properties of a target tracking scaling policy.

func (AutoScalingTargetTrackingScalingPolicyConfigurationDescription) GoString added in v1.14.32 

func (s AutoScalingTargetTrackingScalingPolicyConfigurationDescription) 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 (*AutoScalingTargetTrackingScalingPolicyConfigurationDescription) SetDisableScaleIn added in v1.14.32 

func (s *AutoScalingTargetTrackingScalingPolicyConfigurationDescription) SetDisableScaleIn(v bool) *AutoScalingTargetTrackingScalingPolicyConfigurationDescription

SetDisableScaleIn sets the DisableScaleIn field's value.

func (*AutoScalingTargetTrackingScalingPolicyConfigurationDescription) SetScaleInCooldown added in v1.14.32 

func (s *AutoScalingTargetTrackingScalingPolicyConfigurationDescription) SetScaleInCooldown(v int64) *AutoScalingTargetTrackingScalingPolicyConfigurationDescription

SetScaleInCooldown sets the ScaleInCooldown field's value.

func (*AutoScalingTargetTrackingScalingPolicyConfigurationDescription) SetScaleOutCooldown added in v1.14.32 

func (s *AutoScalingTargetTrackingScalingPolicyConfigurationDescription) SetScaleOutCooldown(v int64) *AutoScalingTargetTrackingScalingPolicyConfigurationDescription

SetScaleOutCooldown sets the ScaleOutCooldown field's value.

func (*AutoScalingTargetTrackingScalingPolicyConfigurationDescription) SetTargetValue added in v1.14.32 

func (s *AutoScalingTargetTrackingScalingPolicyConfigurationDescription) SetTargetValue(v float64) *AutoScalingTargetTrackingScalingPolicyConfigurationDescription

SetTargetValue sets the TargetValue field's value.

func (AutoScalingTargetTrackingScalingPolicyConfigurationDescription) String added in v1.14.32 

func (s AutoScalingTargetTrackingScalingPolicyConfigurationDescription) 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 AutoScalingTargetTrackingScalingPolicyConfigurationUpdate added in v1.14.32 

type AutoScalingTargetTrackingScalingPolicyConfigurationUpdate struct {

	// Indicates whether scale in by the target tracking policy is disabled. If
	// the value is true, scale in is disabled and the target tracking policy won't
	// remove capacity from the scalable resource. Otherwise, scale in is enabled
	// and the target tracking policy can remove capacity from the scalable resource.
	// The default value is false.
	DisableScaleIn *bool `type:"boolean"`

	// The amount of time, in seconds, after a scale in activity completes before
	// another scale in activity can start. The cooldown period is used to block
	// subsequent scale in requests until it has expired. You should scale in conservatively
	// to protect your application's availability. However, if another alarm triggers
	// a scale out policy during the cooldown period after a scale-in, application
	// auto scaling scales out your scalable target immediately.
	ScaleInCooldown *int64 `type:"integer"`

	// The amount of time, in seconds, after a scale out activity completes before
	// another scale out activity can start. While the cooldown period is in effect,
	// the capacity that has been added by the previous scale out event that initiated
	// the cooldown is calculated as part of the desired capacity for the next scale
	// out. You should continuously (but not excessively) scale out.
	ScaleOutCooldown *int64 `type:"integer"`

	// The target value for the metric. The range is 8.515920e-109 to 1.174271e+108
	// (Base 10) or 2e-360 to 2e360 (Base 2).
	//
	// TargetValue is a required field
	TargetValue *float64 `type:"double" required:"true"`
	// contains filtered or unexported fields
}

Represents the settings of a target tracking scaling policy that will be modified.

func (AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) GoString added in v1.14.32 

func (s AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) 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 (*AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) SetDisableScaleIn added in v1.14.32 

func (s *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) SetDisableScaleIn(v bool) *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate

SetDisableScaleIn sets the DisableScaleIn field's value.

func (*AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) SetScaleInCooldown added in v1.14.32 

func (s *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) SetScaleInCooldown(v int64) *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate

SetScaleInCooldown sets the ScaleInCooldown field's value.

func (*AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) SetScaleOutCooldown added in v1.14.32 

func (s *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) SetScaleOutCooldown(v int64) *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate

SetScaleOutCooldown sets the ScaleOutCooldown field's value.

func (*AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) SetTargetValue added in v1.14.32 

func (s *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) SetTargetValue(v float64) *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate

SetTargetValue sets the TargetValue field's value.

func (AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) String added in v1.14.32 

func (s AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) 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 (*AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) Validate added in v1.14.32 

func (s *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) Validate() error

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

type BackupDescription added in v1.12.36 

type BackupDescription struct {

	// Contains the details of the backup created for the table.
	BackupDetails *BackupDetails `type:"structure"`

	// Contains the details of the table when the backup was created.
	SourceTableDetails *SourceTableDetails `type:"structure"`

	// Contains the details of the features enabled on the table when the backup
	// was created. For example, LSIs, GSIs, streams, TTL.
	SourceTableFeatureDetails *SourceTableFeatureDetails `type:"structure"`
	// contains filtered or unexported fields
}

Contains the description of the backup created for the table.

func (BackupDescription) GoString added in v1.12.36 

func (s BackupDescription) 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 (*BackupDescription) SetBackupDetails added in v1.12.36 

func (s *BackupDescription) SetBackupDetails(v *BackupDetails) *BackupDescription

SetBackupDetails sets the BackupDetails field's value.

func (*BackupDescription) SetSourceTableDetails added in v1.12.36 

func (s *BackupDescription) SetSourceTableDetails(v *SourceTableDetails) *BackupDescription

SetSourceTableDetails sets the SourceTableDetails field's value.

func (*BackupDescription) SetSourceTableFeatureDetails added in v1.12.36 

func (s *BackupDescription) SetSourceTableFeatureDetails(v *SourceTableFeatureDetails) *BackupDescription

SetSourceTableFeatureDetails sets the SourceTableFeatureDetails field's value.

func (BackupDescription) String added in v1.12.36 

func (s BackupDescription) 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 BackupDetails added in v1.12.36 

type BackupDetails struct {

	// ARN associated with the backup.
	//
	// BackupArn is a required field
	BackupArn *string `min:"37" type:"string" required:"true"`

	// Time at which the backup was created. This is the request time of the backup.
	//
	// BackupCreationDateTime is a required field
	BackupCreationDateTime *time.Time `type:"timestamp" required:"true"`

	// Time at which the automatic on-demand backup created by DynamoDB will expire.
	// This SYSTEM on-demand backup expires automatically 35 days after its creation.
	BackupExpiryDateTime *time.Time `type:"timestamp"`

	// Name of the requested backup.
	//
	// BackupName is a required field
	BackupName *string `min:"3" type:"string" required:"true"`

	// Size of the backup in bytes. DynamoDB updates this value approximately every
	// six hours. Recent changes might not be reflected in this value.
	BackupSizeBytes *int64 `type:"long"`

	// Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
	//
	// BackupStatus is a required field
	BackupStatus *string `type:"string" required:"true" enum:"BackupStatus"`

	// BackupType:
	//
	//    * USER - You create and manage these using the on-demand backup feature.
	//
	//    * SYSTEM - If you delete a table with point-in-time recovery enabled,
	//    a SYSTEM backup is automatically created and is retained for 35 days (at
	//    no additional cost). System backups allow you to restore the deleted table
	//    to the state it was in just before the point of deletion.
	//
	//    * AWS_BACKUP - On-demand backup created by you from Backup service.
	//
	// BackupType is a required field
	BackupType *string `type:"string" required:"true" enum:"BackupType"`
	// contains filtered or unexported fields
}

Contains the details of the backup created for the table.

func (BackupDetails) GoString added in v1.12.36 

func (s BackupDetails) 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 (*BackupDetails) SetBackupArn added in v1.12.36 

func (s *BackupDetails) SetBackupArn(v string) *BackupDetails

SetBackupArn sets the BackupArn field's value.

func (*BackupDetails) SetBackupCreationDateTime added in v1.12.36 

func (s *BackupDetails) SetBackupCreationDateTime(v time.Time) *BackupDetails

SetBackupCreationDateTime sets the BackupCreationDateTime field's value.

func (*BackupDetails) SetBackupExpiryDateTime added in v1.15.6 

func (s *BackupDetails) SetBackupExpiryDateTime(v time.Time) *BackupDetails

SetBackupExpiryDateTime sets the BackupExpiryDateTime field's value.

func (*BackupDetails) SetBackupName added in v1.12.36 

func (s *BackupDetails) SetBackupName(v string) *BackupDetails

SetBackupName sets the BackupName field's value.

func (*BackupDetails) SetBackupSizeBytes added in v1.12.36 

func (s *BackupDetails) SetBackupSizeBytes(v int64) *BackupDetails

SetBackupSizeBytes sets the BackupSizeBytes field's value.

func (*BackupDetails) SetBackupStatus added in v1.12.36 

func (s *BackupDetails) SetBackupStatus(v string) *BackupDetails

SetBackupStatus sets the BackupStatus field's value.

func (*BackupDetails) SetBackupType added in v1.15.6 

func (s *BackupDetails) SetBackupType(v string) *BackupDetails

SetBackupType sets the BackupType field's value.

func (BackupDetails) String added in v1.12.36 

func (s BackupDetails) 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 BackupInUseException added in v1.28.0 

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

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

There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.

func (*BackupInUseException) Code added in v1.28.0 

func (s *BackupInUseException) Code() string

Code returns the exception type name.

func (*BackupInUseException) Error added in v1.28.0 

func (s *BackupInUseException) Error() string

func (BackupInUseException) GoString added in v1.28.0 

func (s BackupInUseException) 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 (*BackupInUseException) Message added in v1.28.0 

func (s *BackupInUseException) Message() string

Message returns the exception's message.

func (*BackupInUseException) OrigErr added in v1.28.0 

func (s *BackupInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BackupInUseException) RequestID added in v1.28.0 

func (s *BackupInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BackupInUseException) StatusCode added in v1.28.0 

func (s *BackupInUseException) StatusCode() int

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

func (BackupInUseException) String added in v1.28.0 

func (s BackupInUseException) 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 BackupNotFoundException added in v1.28.0 

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

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

Backup not found for the given BackupARN.

func (*BackupNotFoundException) Code added in v1.28.0 

func (s *BackupNotFoundException) Code() string

Code returns the exception type name.

func (*BackupNotFoundException) Error added in v1.28.0 

func (s *BackupNotFoundException) Error() string

func (BackupNotFoundException) GoString added in v1.28.0 

func (s BackupNotFoundException) 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 (*BackupNotFoundException) Message added in v1.28.0 

func (s *BackupNotFoundException) Message() string

Message returns the exception's message.

func (*BackupNotFoundException) OrigErr added in v1.28.0 

func (s *BackupNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*BackupNotFoundException) RequestID added in v1.28.0 

func (s *BackupNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*BackupNotFoundException) StatusCode added in v1.28.0 

func (s *BackupNotFoundException) StatusCode() int

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

func (BackupNotFoundException) String added in v1.28.0 

func (s BackupNotFoundException) 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 BackupSummary added in v1.12.36 

type BackupSummary struct {

	// ARN associated with the backup.
	BackupArn *string `min:"37" type:"string"`

	// Time at which the backup was created.
	BackupCreationDateTime *time.Time `type:"timestamp"`

	// Time at which the automatic on-demand backup created by DynamoDB will expire.
	// This SYSTEM on-demand backup expires automatically 35 days after its creation.
	BackupExpiryDateTime *time.Time `type:"timestamp"`

	// Name of the specified backup.
	BackupName *string `min:"3" type:"string"`

	// Size of the backup in bytes.
	BackupSizeBytes *int64 `type:"long"`

	// Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
	BackupStatus *string `type:"string" enum:"BackupStatus"`

	// BackupType:
	//
	//    * USER - You create and manage these using the on-demand backup feature.
	//
	//    * SYSTEM - If you delete a table with point-in-time recovery enabled,
	//    a SYSTEM backup is automatically created and is retained for 35 days (at
	//    no additional cost). System backups allow you to restore the deleted table
	//    to the state it was in just before the point of deletion.
	//
	//    * AWS_BACKUP - On-demand backup created by you from Backup service.
	BackupType *string `type:"string" enum:"BackupType"`

	// ARN associated with the table.
	TableArn *string `type:"string"`

	// Unique identifier for the table.
	TableId *string `type:"string"`

	// Name of the table.
	TableName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

Contains details for the backup.

func (BackupSummary) GoString added in v1.12.36 

func (s BackupSummary) 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 (*BackupSummary) SetBackupArn added in v1.12.36 

func (s *BackupSummary) SetBackupArn(v string) *BackupSummary

SetBackupArn sets the BackupArn field's value.

func (*BackupSummary) SetBackupCreationDateTime added in v1.12.36 

func (s *BackupSummary) SetBackupCreationDateTime(v time.Time) *BackupSummary

SetBackupCreationDateTime sets the BackupCreationDateTime field's value.

func (*BackupSummary) SetBackupExpiryDateTime added in v1.15.6 

func (s *BackupSummary) SetBackupExpiryDateTime(v time.Time) *BackupSummary

SetBackupExpiryDateTime sets the BackupExpiryDateTime field's value.

func (*BackupSummary) SetBackupName added in v1.12.36 

func (s *BackupSummary) SetBackupName(v string) *BackupSummary

SetBackupName sets the BackupName field's value.

func (*BackupSummary) SetBackupSizeBytes added in v1.12.36 

func (s *BackupSummary) SetBackupSizeBytes(v int64) *BackupSummary

SetBackupSizeBytes sets the BackupSizeBytes field's value.

func (*BackupSummary) SetBackupStatus added in v1.12.36 

func (s *BackupSummary) SetBackupStatus(v string) *BackupSummary

SetBackupStatus sets the BackupStatus field's value.

func (*BackupSummary) SetBackupType added in v1.15.6 

func (s *BackupSummary) SetBackupType(v string) *BackupSummary

SetBackupType sets the BackupType field's value.

func (*BackupSummary) SetTableArn added in v1.12.36 

func (s *BackupSummary) SetTableArn(v string) *BackupSummary

SetTableArn sets the TableArn field's value.

func (*BackupSummary) SetTableId added in v1.12.36 

func (s *BackupSummary) SetTableId(v string) *BackupSummary

SetTableId sets the TableId field's value.

func (*BackupSummary) SetTableName added in v1.12.36 

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

SetTableName sets the TableName field's value.

func (BackupSummary) String added in v1.12.36 

func (s BackupSummary) 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 BatchExecuteStatementInput added in v1.35.34 

type BatchExecuteStatementInput struct {

	// Determines the level of detail about either provisioned or on-demand throughput
	// consumption that is returned in the response:
	//
	//    * INDEXES - The response includes the aggregate ConsumedCapacity for the
	//    operation, together with ConsumedCapacity for each table and secondary
	//    index that was accessed. Note that some operations, such as GetItem and
	//    BatchGetItem, do not access any indexes at all. In these cases, specifying
	//    INDEXES will only return ConsumedCapacity information for table(s).
	//
	//    * TOTAL - The response includes only the aggregate ConsumedCapacity for
	//    the operation.
	//
	//    * NONE - No ConsumedCapacity details are included in the response.
	ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"`

	// The list of PartiQL statements representing the batch to run.
	//
	// Statements is a required field
	Statements []*BatchStatementRequest `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchExecuteStatementInput) GoString added in v1.35.34 

func (s BatchExecuteStatementInput) 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 (*BatchExecuteStatementInput) SetReturnConsumedCapacity added in v1.42.11 

func (s *BatchExecuteStatementInput) SetReturnConsumedCapacity(v string) *BatchExecuteStatementInput

SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.

func (*BatchExecuteStatementInput) SetStatements added in v1.35.34 

func (s *BatchExecuteStatementInput) SetStatements(v []*BatchStatementRequest) *BatchExecuteStatementInput

SetStatements sets the Statements field's value.

func (BatchExecuteStatementInput) String added in v1.35.34 

func (s BatchExecuteStatementInput) 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 (*BatchExecuteStatementInput) Validate added in v1.35.34 

func (s *BatchExecuteStatementInput) Validate() error

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

type BatchExecuteStatementOutput added in v1.35.34 

type BatchExecuteStatementOutput struct {

	// The capacity units consumed by the entire operation. The values of the list
	// are ordered according to the ordering of the statements.
	ConsumedCapacity []*ConsumedCapacity `type:"list"`

	// The response to each PartiQL statement in the batch.
	Responses []*BatchStatementResponse `type:"list"`
	// contains filtered or unexported fields
}

func (BatchExecuteStatementOutput) GoString added in v1.35.34 

func (s BatchExecuteStatementOutput) 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 (*BatchExecuteStatementOutput) SetConsumedCapacity added in v1.42.11 

func (s *BatchExecuteStatementOutput) SetConsumedCapacity(v []*ConsumedCapacity) *BatchExecuteStatementOutput

SetConsumedCapacity sets the ConsumedCapacity field's value.

func (*BatchExecuteStatementOutput) SetResponses added in v1.35.34 

func (s *BatchExecuteStatementOutput) SetResponses(v []*BatchStatementResponse) *BatchExecuteStatementOutput

SetResponses sets the Responses field's value.

func (BatchExecuteStatementOutput) String added in v1.35.34 

func (s BatchExecuteStatementOutput) 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 BatchGetItemInput 

type BatchGetItemInput struct {

	// A map of one or more table names and, for each table, a map that describes
	// one or more items to retrieve from that table. Each table name can be used
	// only once per BatchGetItem request.
	//
	// Each element in the map of items to retrieve consists of the following:
	//
	//    * ConsistentRead - If true, a strongly consistent read is used; if false
	//    (the default), an eventually consistent read is used.
	//
	//    * ExpressionAttributeNames - One or more substitution tokens for attribute
	//    names in the ProjectionExpression parameter. The following are some use
	//    cases for using ExpressionAttributeNames: To access an attribute whose
	//    name conflicts with a DynamoDB reserved word. To create a placeholder
	//    for repeating occurrences of an attribute name in an expression. To prevent
	//    special characters in an attribute name from being misinterpreted in an
	//    expression. Use the # character in an expression to dereference an attribute
	//    name. For example, consider the following attribute name: Percentile The
	//    name of this attribute conflicts with a reserved word, so it cannot be
	//    used directly in an expression. (For the complete list of reserved words,
	//    see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
	//    in the Amazon DynamoDB Developer Guide). To work around this, you could
	//    specify the following for ExpressionAttributeNames: {"#P":"Percentile"}
	//    You could then use this substitution in an expression, as in this example:
	//    #P = :val Tokens that begin with the : character are expression attribute
	//    values, which are placeholders for the actual value at runtime. For more
	//    information about expression attribute names, see Accessing Item Attributes
	//    (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
	//    in the Amazon DynamoDB Developer Guide.
	//
	//    * Keys - An array of primary key attribute values that define specific
	//    items in the table. For each primary key, you must provide all of the
	//    key attributes. For example, with a simple primary key, you only need
	//    to provide the partition key value. For a composite key, you must provide
	//    both the partition key value and the sort key value.
	//
	//    * ProjectionExpression - A string that identifies one or more attributes
	//    to retrieve from the table. These attributes can include scalars, sets,
	//    or elements of a JSON document. The attributes in the expression must
	//    be separated by commas. If no attribute names are specified, then all
	//    attributes are returned. If any of the requested attributes are not found,
	//    they do not appear in the result. For more information, see Accessing
	//    Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
	//    in the Amazon DynamoDB Developer Guide.
	//
	//    * AttributesToGet - This is a legacy parameter. Use ProjectionExpression
	//    instead. For more information, see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html)
	//    in the Amazon DynamoDB Developer Guide.
	//
	// RequestItems is a required field
	RequestItems map[string]*KeysAndAttributes `min:"1" type:"map" required:"true"`

	// Determines the level of detail about either provisioned or on-demand throughput
	// consumption that is returned in the response:
	//
	//    * INDEXES - The response includes the aggregate ConsumedCapacity for the
	//    operation, together with ConsumedCapacity for each table and secondary
	//    index that was accessed. Note that some operations, such as GetItem and
	//    BatchGetItem, do not access any indexes at all. In these cases, specifying
	//    INDEXES will only return ConsumedCapacity information for table(s).
	//
	//    * TOTAL - The response includes only the aggregate ConsumedCapacity for
	//    the operation.
	//
	//    * NONE - No ConsumedCapacity details are included in the response.
	ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"`
	// contains filtered or unexported fields
}

Represents the input of a BatchGetItem operation.

func (BatchGetItemInput) GoString added in v0.6.5 

func (s BatchGetItemInput) 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 (*BatchGetItemInput) SetRequestItems added in v1.5.0 

func (s *BatchGetItemInput) SetRequestItems(v map[string]*KeysAndAttributes) *BatchGetItemInput

SetRequestItems sets the RequestItems field's value.

func (*BatchGetItemInput) SetReturnConsumedCapacity added in v1.5.0 

func (s *BatchGetItemInput) SetReturnConsumedCapacity(v string) *BatchGetItemInput

SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.

func (BatchGetItemInput) String added in v0.6.5 

func (s BatchGetItemInput) 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 (*BatchGetItemInput) Validate added in v1.1.21 

func (s *BatchGetItemInput) Validate() error

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

type BatchGetItemOutput 

type BatchGetItemOutput struct {

	// The read capacity units consumed by the entire BatchGetItem operation.
	//
	// Each element consists of:
	//
	//    * TableName - The table that consumed the provisioned throughput.
	//
	//    * CapacityUnits - The total number of capacity units consumed.
	ConsumedCapacity []*ConsumedCapacity `type:"list"`

	// A map of table name to a list of items. Each object in Responses consists
	// of a table name, along with a map of attribute data consisting of the data
	// type and attribute value.
	Responses map[string][]map[string]*AttributeValue `type:"map"`

	// A map of tables and their respective keys that were not processed with the
	// current response. The UnprocessedKeys value is in the same form as RequestItems,
	// so the value can be provided directly to a subsequent BatchGetItem operation.
	// For more information, see RequestItems in the Request Parameters section.
	//
	// Each element consists of:
	//
	//    * Keys - An array of primary key attribute values that define specific
	//    items in the table.
	//
	//    * ProjectionExpression - One or more attributes to be retrieved from the
	//    table or index. By default, all attributes are returned. If a requested
	//    attribute is not found, it does not appear in the result.
	//
	//    * ConsistentRead - The consistency of a read operation. If set to true,
	//    then a strongly consistent read is used; otherwise, an eventually consistent
	//    read is used.
	//
	// If there are no unprocessed keys remaining, the response contains an empty
	// UnprocessedKeys map.
	UnprocessedKeys map[string]*KeysAndAttributes `min:"1" type:"map"`
	// contains filtered or unexported fields
}

Represents the output of a BatchGetItem operation.

func (BatchGetItemOutput) GoString added in v0.6.5 

func (s BatchGetItemOutput) 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 (*BatchGetItemOutput) SetConsumedCapacity added in v1.5.0 

func (s *BatchGetItemOutput) SetConsumedCapacity(v []*ConsumedCapacity) *BatchGetItemOutput

SetConsumedCapacity sets the ConsumedCapacity field's value.

func (*BatchGetItemOutput) SetResponses added in v1.5.0 

func (s *BatchGetItemOutput) SetResponses(v map[string][]map[string]*AttributeValue) *BatchGetItemOutput

SetResponses sets the Responses field's value.

func (*BatchGetItemOutput) SetUnprocessedKeys added in v1.5.0 

func (s *BatchGetItemOutput) SetUnprocessedKeys(v map[string]*KeysAndAttributes) *BatchGetItemOutput

SetUnprocessedKeys sets the UnprocessedKeys field's value.

func (BatchGetItemOutput) String added in v0.6.5 

func (s BatchGetItemOutput) 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 BatchStatementError added in v1.35.34 

type BatchStatementError struct {

	// The error code associated with the failed PartiQL batch statement.
	Code *string `type:"string" enum:"BatchStatementErrorCodeEnum"`

	// The error message associated with the PartiQL batch resposne.
	Message *string `type:"string"`
	// contains filtered or unexported fields
}

An error associated with a statement in a PartiQL batch that was run.

func (BatchStatementError) GoString added in v1.35.34 

func (s BatchStatementError) 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 (*BatchStatementError) SetCode added in v1.35.34 

func (s *BatchStatementError) SetCode(v string) *BatchStatementError

SetCode sets the Code field's value.

func (*BatchStatementError) SetMessage added in v1.35.34 

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

SetMessage sets the Message field's value.

func (BatchStatementError) String added in v1.35.34 

func (s BatchStatementError) 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 BatchStatementRequest added in v1.35.34 

type BatchStatementRequest struct {

	// The read consistency of the PartiQL batch request.
	ConsistentRead *bool `type:"boolean"`

	// The parameters associated with a PartiQL statement in the batch request.
	Parameters []*AttributeValue `min:"1" type:"list"`

	// A valid PartiQL statement.
	//
	// Statement is a required field
	Statement *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A PartiQL batch statement request.

func (BatchStatementRequest) GoString added in v1.35.34 

func (s BatchStatementRequest) 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 (*BatchStatementRequest) SetConsistentRead added in v1.35.34 

func (s *BatchStatementRequest) SetConsistentRead(v bool) *BatchStatementRequest

SetConsistentRead sets the ConsistentRead field's value.

func (*BatchStatementRequest) SetParameters added in v1.35.34 

func (s *BatchStatementRequest) SetParameters(v []*AttributeValue) *BatchStatementRequest

SetParameters sets the Parameters field's value.

func (*BatchStatementRequest) SetStatement added in v1.35.34 

func (s *BatchStatementRequest) SetStatement(v string) *BatchStatementRequest

SetStatement sets the Statement field's value.

func (BatchStatementRequest) String added in v1.35.34 

func (s BatchStatementRequest) 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 (*BatchStatementRequest) Validate added in v1.35.34 

func (s *BatchStatementRequest) Validate() error

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

type BatchStatementResponse added in v1.35.34 

type BatchStatementResponse struct {

	// The error associated with a failed PartiQL batch statement.
	Error *BatchStatementError `type:"structure"`

	// A DynamoDB item associated with a BatchStatementResponse
	Item map[string]*AttributeValue `type:"map"`

	// The table name associated with a failed PartiQL batch statement.
	TableName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

A PartiQL batch statement response..

func (BatchStatementResponse) GoString added in v1.35.34 

func (s BatchStatementResponse) 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 (*BatchStatementResponse) SetError added in v1.35.34 

func (s *BatchStatementResponse) SetError(v *BatchStatementError) *BatchStatementResponse

SetError sets the Error field's value.

func (*BatchStatementResponse) SetItem added in v1.35.34 

func (s *BatchStatementResponse) SetItem(v map[string]*AttributeValue) *BatchStatementResponse

SetItem sets the Item field's value.

func (*BatchStatementResponse) SetTableName added in v1.35.34 

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

SetTableName sets the TableName field's value.

func (BatchStatementResponse) String added in v1.35.34 

func (s BatchStatementResponse) 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 BatchWriteItemInput 

type BatchWriteItemInput struct {

	// A map of one or more table names and, for each table, a list of operations
	// to be performed (DeleteRequest or PutRequest). Each element in the map consists
	// of the following:
	//
	//    * DeleteRequest - Perform a DeleteItem operation on the specified item.
	//    The item to be deleted is identified by a Key subelement: Key - A map
	//    of primary key attribute values that uniquely identify the item. Each
	//    entry in this map consists of an attribute name and an attribute value.
	//    For each primary key, you must provide all of the key attributes. For
	//    example, with a simple primary key, you only need to provide a value for
	//    the partition key. For a composite primary key, you must provide values
	//    for both the partition key and the sort key.
	//
	//    * PutRequest - Perform a PutItem operation on the specified item. The
	//    item to be put is identified by an Item subelement: Item - A map of attributes
	//    and their values. Each entry in this map consists of an attribute name
	//    and an attribute value. Attribute values must not be null; string and
	//    binary type attributes must have lengths greater than zero; and set type
	//    attributes must not be empty. Requests that contain empty values are rejected
	//    with a ValidationException exception. If you specify any attributes that
	//    are part of an index key, then the data types for those attributes must
	//    match those of the schema in the table's attribute definition.
	//
	// RequestItems is a required field
	RequestItems map[string][]*WriteRequest `min:"1" type:"map" required:"true"`

	// Determines the level of detail about either provisioned or on-demand throughput
	// consumption that is returned in the response:
	//
	//    * INDEXES - The response includes the aggregate ConsumedCapacity for the
	//    operation, together with ConsumedCapacity for each table and secondary
	//    index that was accessed. Note that some operations, such as GetItem and
	//    BatchGetItem, do not access any indexes at all. In these cases, specifying
	//    INDEXES will only return ConsumedCapacity information for table(s).
	//
	//    * TOTAL - The response includes only the aggregate ConsumedCapacity for
	//    the operation.
	//
	//    * NONE - No ConsumedCapacity details are included in the response.
	ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"`

	// Determines whether item collection metrics are returned. If set to SIZE,
	// the response includes statistics about item collections, if any, that were
	// modified during the operation are returned in the response. If set to NONE
	// (the default), no statistics are returned.
	ReturnItemCollectionMetrics *string `type:"string" enum:"ReturnItemCollectionMetrics"`
	// contains filtered or unexported fields
}

Represents the input of a BatchWriteItem operation.

func (BatchWriteItemInput) GoString added in v0.6.5 

func (s BatchWriteItemInput) 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 (*BatchWriteItemInput) SetRequestItems added in v1.5.0 

func (s *BatchWriteItemInput) SetRequestItems(v map[string][]*WriteRequest) *BatchWriteItemInput

SetRequestItems sets the RequestItems field's value.

func (*BatchWriteItemInput) SetReturnConsumedCapacity added in v1.5.0 

func (s *BatchWriteItemInput) SetReturnConsumedCapacity(v string) *BatchWriteItemInput

SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.

func (*BatchWriteItemInput) SetReturnItemCollectionMetrics added in v1.5.0 

func (s *BatchWriteItemInput) SetReturnItemCollectionMetrics(v string) *BatchWriteItemInput

SetReturnItemCollectionMetrics sets the ReturnItemCollectionMetrics field's value.

func (BatchWriteItemInput) String added in v0.6.5 

func (s BatchWriteItemInput) 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 (*BatchWriteItemInput) Validate added in v1.1.21 

func (s *BatchWriteItemInput) Validate() error

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

type BatchWriteItemOutput 

type BatchWriteItemOutput struct {

	// The capacity units consumed by the entire BatchWriteItem operation.
	//
	// Each element consists of:
	//
	//    * TableName - The table that consumed the provisioned throughput.
	//
	//    * CapacityUnits - The total number of capacity units consumed.
	ConsumedCapacity []*ConsumedCapacity `type:"list"`

	// A list of tables that were processed by BatchWriteItem and, for each table,
	// information about any item collections that were affected by individual DeleteItem
	// or PutItem operations.
	//
	// Each entry consists of the following subelements:
	//
	//    * ItemCollectionKey - The partition key value of the item collection.
	//    This is the same as the partition key value of the item.
	//
	//    * SizeEstimateRangeGB - An estimate of item collection size, expressed
	//    in GB. This is a two-element array containing a lower bound and an upper
	//    bound for the estimate. The estimate includes the size of all the items
	//    in the table, plus the size of all attributes projected into all of the
	//    local secondary indexes on the table. Use this estimate to measure whether
	//    a local secondary index is approaching its size limit. The estimate is
	//    subject to change over time; therefore, do not rely on the precision or
	//    accuracy of the estimate.
	ItemCollectionMetrics map[string][]*ItemCollectionMetrics `type:"map"`

	// A map of tables and requests against those tables that were not processed.
	// The UnprocessedItems value is in the same form as RequestItems, so you can
	// provide this value directly to a subsequent BatchGetItem operation. For more
	// information, see RequestItems in the Request Parameters section.
	//
	// Each UnprocessedItems entry consists of a table name and, for that table,
	// a list of operations to perform (DeleteRequest or PutRequest).
	//
	//    * DeleteRequest - Perform a DeleteItem operation on the specified item.
	//    The item to be deleted is identified by a Key subelement: Key - A map
	//    of primary key attribute values that uniquely identify the item. Each
	//    entry in this map consists of an attribute name and an attribute value.
	//
	//    * PutRequest - Perform a PutItem operation on the specified item. The
	//    item to be put is identified by an Item subelement: Item - A map of attributes
	//    and their values. Each entry in this map consists of an attribute name
	//    and an attribute value. Attribute values must not be null; string and
	//    binary type attributes must have lengths greater than zero; and set type
	//    attributes must not be empty. Requests that contain empty values will
	//    be rejected with a ValidationException exception. If you specify any attributes
	//    that are part of an index key, then the data types for those attributes
	//    must match those of the schema in the table's attribute definition.
	//
	// If there are no unprocessed items remaining, the response contains an empty
	// UnprocessedItems map.
	UnprocessedItems map[string][]*WriteRequest `min:"1" type:"map"`
	// contains filtered or unexported fields
}

Represents the output of a BatchWriteItem operation.

func (BatchWriteItemOutput) GoString added in v0.6.5 

func (s BatchWriteItemOutput) 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 (*BatchWriteItemOutput) SetConsumedCapacity added in v1.5.0 

func (s *BatchWriteItemOutput) SetConsumedCapacity(v []*ConsumedCapacity) *BatchWriteItemOutput

SetConsumedCapacity sets the ConsumedCapacity field's value.

func (*BatchWriteItemOutput) SetItemCollectionMetrics added in v1.5.0 

func (s *BatchWriteItemOutput) SetItemCollectionMetrics(v map[string][]*ItemCollectionMetrics) *BatchWriteItemOutput

SetItemCollectionMetrics sets the ItemCollectionMetrics field's value.

func (*BatchWriteItemOutput) SetUnprocessedItems added in v1.5.0 

func (s *BatchWriteItemOutput) SetUnprocessedItems(v map[string][]*WriteRequest) *BatchWriteItemOutput

SetUnprocessedItems sets the UnprocessedItems field's value.

func (BatchWriteItemOutput) String added in v0.6.5 

func (s BatchWriteItemOutput) 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 BillingModeSummary added in v1.15.85 

type BillingModeSummary struct {

	// Controls how you are charged for read and write throughput and how you manage
	// capacity. This setting can be changed later.
	//
	//    * PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend
	//    using PROVISIONED for predictable workloads.
	//
	//    * PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST.
	//    We recommend using PAY_PER_REQUEST for unpredictable workloads.
	BillingMode *string `type:"string" enum:"BillingMode"`

	// Represents the time when PAY_PER_REQUEST was last set as the read/write capacity
	// mode.
	LastUpdateToPayPerRequestDateTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Contains the details for the read/write capacity mode.

func (BillingModeSummary) GoString added in v1.15.85 

func (s BillingModeSummary) 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 (*BillingModeSummary) SetBillingMode added in v1.15.85 

func (s *BillingModeSummary) SetBillingMode(v string) *BillingModeSummary

SetBillingMode sets the BillingMode field's value.

func (*BillingModeSummary) SetLastUpdateToPayPerRequestDateTime added in v1.15.85 

func (s *BillingModeSummary) SetLastUpdateToPayPerRequestDateTime(v time.Time) *BillingModeSummary

SetLastUpdateToPayPerRequestDateTime sets the LastUpdateToPayPerRequestDateTime field's value.

func (BillingModeSummary) String added in v1.15.85 

func (s BillingModeSummary) 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 CancellationReason added in v1.15.85 

type CancellationReason struct {

	// Status code for the result of the cancelled transaction.
	Code *string `type:"string"`

	// Item in the request which caused the transaction to get cancelled.
	Item map[string]*AttributeValue `type:"map"`

	// Cancellation reason message description.
	Message *string `type:"string"`
	// contains filtered or unexported fields
}

An ordered list of errors for each item in the request which caused the transaction to get cancelled. The values of the list are ordered according to the ordering of the TransactWriteItems request parameter. If no error occurred for the associated item an error with a Null code and Null message will be present.

func (CancellationReason) GoString added in v1.15.85 

func (s CancellationReason) 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 (*CancellationReason) SetCode added in v1.15.85 

func (s *CancellationReason) SetCode(v string) *CancellationReason

SetCode sets the Code field's value.

func (*CancellationReason) SetItem added in v1.15.85 

func (s *CancellationReason) SetItem(v map[string]*AttributeValue) *CancellationReason

SetItem sets the Item field's value.

func (*CancellationReason) SetMessage added in v1.15.85 

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

SetMessage sets the Message field's value.

func (CancellationReason) String added in v1.15.85 

func (s CancellationReason) 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 Capacity 

type Capacity struct {

	// The total number of capacity units consumed on a table or an index.
	CapacityUnits *float64 `type:"double"`

	// The total number of read capacity units consumed on a table or an index.
	ReadCapacityUnits *float64 `type:"double"`

	// The total number of write capacity units consumed on a table or an index.
	WriteCapacityUnits *float64 `type:"double"`
	// contains filtered or unexported fields
}

Represents the amount of provisioned throughput capacity consumed on a table or an index.

func (Capacity) GoString added in v0.6.5 

func (s Capacity) 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 (*Capacity) SetCapacityUnits added in v1.5.0 

func (s *Capacity) SetCapacityUnits(v float64) *Capacity

SetCapacityUnits sets the CapacityUnits field's value.

func (*Capacity) SetReadCapacityUnits added in v1.15.85 

func (s *Capacity) SetReadCapacityUnits(v float64) *Capacity

SetReadCapacityUnits sets the ReadCapacityUnits field's value.

func (*Capacity) SetWriteCapacityUnits added in v1.15.85 

func (s *Capacity) SetWriteCapacityUnits(v float64) *Capacity

SetWriteCapacityUnits sets the WriteCapacityUnits field's value.

func (Capacity) String added in v0.6.5 

func (s Capacity) 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 Condition 

type Condition struct {

	// One or more values to evaluate against the supplied attribute. The number
	// of values in the list depends on the ComparisonOperator being used.
	//
	// For type Number, value comparisons are numeric.
	//
	// String value comparisons for greater than, equals, or less than are based
	// on ASCII character code values. For example, a is greater than A, and a is
	// greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters
	// (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters).
	//
	// For Binary, DynamoDB treats each byte of the binary data as unsigned when
	// it compares binary values.
	AttributeValueList []*AttributeValue `type:"list"`

	// A comparator for evaluating attributes. For example, equals, greater than,
	// less than, etc.
	//
	// The following comparison operators are available:
	//
	// EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |
	// BEGINS_WITH | IN | BETWEEN
	//
	// The following are descriptions of each comparison operator.
	//
	//    * EQ : Equal. EQ is supported for all data types, including lists and
	//    maps. AttributeValueList can contain only one AttributeValue element of
	//    type String, Number, Binary, String Set, Number Set, or Binary Set. If
	//    an item contains an AttributeValue element of a different type than the
	//    one provided in the request, the value does not match. For example, {"S":"6"}
	//    does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2",
	//    "1"]}.
	//
	//    * NE : Not equal. NE is supported for all data types, including lists
	//    and maps. AttributeValueList can contain only one AttributeValue of type
	//    String, Number, Binary, String Set, Number Set, or Binary Set. If an item
	//    contains an AttributeValue of a different type than the one provided in
	//    the request, the value does not match. For example, {"S":"6"} does not
	//    equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.
	//
	//    * LE : Less than or equal. AttributeValueList can contain only one AttributeValue
	//    element of type String, Number, or Binary (not a set type). If an item
	//    contains an AttributeValue element of a different type than the one provided
	//    in the request, the value does not match. For example, {"S":"6"} does
	//    not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
	//    "1"]}.
	//
	//    * LT : Less than. AttributeValueList can contain only one AttributeValue
	//    of type String, Number, or Binary (not a set type). If an item contains
	//    an AttributeValue element of a different type than the one provided in
	//    the request, the value does not match. For example, {"S":"6"} does not
	//    equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
	//    "1"]}.
	//
	//    * GE : Greater than or equal. AttributeValueList can contain only one
	//    AttributeValue element of type String, Number, or Binary (not a set type).
	//    If an item contains an AttributeValue element of a different type than
	//    the one provided in the request, the value does not match. For example,
	//    {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to
	//    {"NS":["6", "2", "1"]}.
	//
	//    * GT : Greater than. AttributeValueList can contain only one AttributeValue
	//    element of type String, Number, or Binary (not a set type). If an item
	//    contains an AttributeValue element of a different type than the one provided
	//    in the request, the value does not match. For example, {"S":"6"} does
	//    not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
	//    "1"]}.
	//
	//    * NOT_NULL : The attribute exists. NOT_NULL is supported for all data
	//    types, including lists and maps. This operator tests for the existence
	//    of an attribute, not its data type. If the data type of attribute "a"
	//    is null, and you evaluate it using NOT_NULL, the result is a Boolean true.
	//    This result is because the attribute "a" exists; its data type is not
	//    relevant to the NOT_NULL comparison operator.
	//
	//    * NULL : The attribute does not exist. NULL is supported for all data
	//    types, including lists and maps. This operator tests for the nonexistence
	//    of an attribute, not its data type. If the data type of attribute "a"
	//    is null, and you evaluate it using NULL, the result is a Boolean false.
	//    This is because the attribute "a" exists; its data type is not relevant
	//    to the NULL comparison operator.
	//
	//    * CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList
	//    can contain only one AttributeValue element of type String, Number, or
	//    Binary (not a set type). If the target attribute of the comparison is
	//    of type String, then the operator checks for a substring match. If the
	//    target attribute of the comparison is of type Binary, then the operator
	//    looks for a subsequence of the target that matches the input. If the target
	//    attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator
	//    evaluates to true if it finds an exact match with any member of the set.
	//    CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can
	//    be a list; however, "b" cannot be a set, a map, or a list.
	//
	//    * NOT_CONTAINS : Checks for absence of a subsequence, or absence of a
	//    value in a set. AttributeValueList can contain only one AttributeValue
	//    element of type String, Number, or Binary (not a set type). If the target
	//    attribute of the comparison is a String, then the operator checks for
	//    the absence of a substring match. If the target attribute of the comparison
	//    is Binary, then the operator checks for the absence of a subsequence of
	//    the target that matches the input. If the target attribute of the comparison
	//    is a set ("SS", "NS", or "BS"), then the operator evaluates to true if
	//    it does not find an exact match with any member of the set. NOT_CONTAINS
	//    is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be
	//    a list; however, "b" cannot be a set, a map, or a list.
	//
	//    * BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only
	//    one AttributeValue of type String or Binary (not a Number or a set type).
	//    The target attribute of the comparison must be of type String or Binary
	//    (not a Number or a set type).
	//
	//    * IN : Checks for matching elements in a list. AttributeValueList can
	//    contain one or more AttributeValue elements of type String, Number, or
	//    Binary. These attributes are compared against an existing attribute of
	//    an item. If any elements of the input are equal to the item attribute,
	//    the expression evaluates to true.
	//
	//    * BETWEEN : Greater than or equal to the first value, and less than or
	//    equal to the second value. AttributeValueList must contain two AttributeValue
	//    elements of the same type, either String, Number, or Binary (not a set
	//    type). A target attribute matches if the target value is greater than,
	//    or equal to, the first element and less than, or equal to, the second
	//    element. If an item contains an AttributeValue element of a different
	//    type than the one provided in the request, the value does not match. For
	//    example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does
	//    not compare to {"NS":["6", "2", "1"]}
	//
	// For usage examples of AttributeValueList and ComparisonOperator, see Legacy
	// Conditional Parameters (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html)
	// in the Amazon DynamoDB Developer Guide.
	//
	// ComparisonOperator is a required field
	ComparisonOperator *string `type:"string" required:"true" enum:"ComparisonOperator"`
	// contains filtered or unexported fields
}

Represents the selection criteria for a Query or Scan operation:

  • For a Query operation, Condition is used for specifying the KeyConditions to use when querying a table or an index. For KeyConditions, only the following comparison operators are supported: EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN Condition is also used in a QueryFilter, which evaluates the query results and returns only the desired values.

  • For a Scan operation, Condition is used in a ScanFilter, which evaluates the scan results and returns only the desired values.

func (Condition) GoString added in v0.6.5 

func (s Condition) 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 (*Condition) SetAttributeValueList added in v1.5.0 

func (s *Condition) SetAttributeValueList(v []*AttributeValue) *Condition

SetAttributeValueList sets the AttributeValueList field's value.

func (*Condition) SetComparisonOperator added in v1.5.0 

func (s *Condition) SetComparisonOperator(v string) *Condition

SetComparisonOperator sets the ComparisonOperator field's value.

func (Condition) String added in v0.6.5 

func (s Condition) 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 (*Condition) Validate added in v1.1.21 

func (s *Condition) Validate() error

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

type ConditionCheck added in v1.15.85 

type ConditionCheck struct {

	// A condition that must be satisfied in order for a conditional update to succeed.
	//
	// ConditionExpression is a required field
	ConditionExpression *string `type:"string" required:"true"`

	// One or more substitution tokens for attribute names in an expression.
	ExpressionAttributeNames map[string]*string `type:"map"`

	// One or more values that can be substituted in an expression.
	ExpressionAttributeValues map[string]*AttributeValue `type:"map"`

	// The primary key of the item to be checked. Each element consists of an attribute
	// name and a value for that attribute.
	//
	// Key is a required field
	Key map[string]*AttributeValue `type:"map" required:"true"`

	// Use ReturnValuesOnConditionCheckFailure to get the item attributes if the
	// ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure,
	// the valid values are: NONE and ALL_OLD.
	ReturnValuesOnConditionCheckFailure *string `type:"string" enum:"ReturnValuesOnConditionCheckFailure"`

	// Name of the table for the check item request.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a request to perform a check that an item exists or to check the condition of specific attributes of the item.

func (ConditionCheck) GoString added in v1.15.85 

func (s ConditionCheck) 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 (*ConditionCheck) SetConditionExpression added in v1.15.85 

func (s *ConditionCheck) SetConditionExpression(v string) *ConditionCheck

SetConditionExpression sets the ConditionExpression field's value.

func (*ConditionCheck) SetExpressionAttributeNames added in v1.15.85 

func (s *ConditionCheck) SetExpressionAttributeNames(v map[string]*string) *ConditionCheck

SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.

func (*ConditionCheck) SetExpressionAttributeValues added in v1.15.85 

func (s *ConditionCheck) SetExpressionAttributeValues(v map[string]*AttributeValue) *ConditionCheck

SetExpressionAttributeValues sets the ExpressionAttributeValues field's value.

func (*ConditionCheck) SetKey added in v1.15.85 

func (s *ConditionCheck) SetKey(v map[string]*AttributeValue) *ConditionCheck

SetKey sets the Key field's value.

func (*ConditionCheck) SetReturnValuesOnConditionCheckFailure added in v1.15.85 

func (s *ConditionCheck) SetReturnValuesOnConditionCheckFailure(v string) *ConditionCheck

SetReturnValuesOnConditionCheckFailure sets the ReturnValuesOnConditionCheckFailure field's value.

func (*ConditionCheck) SetTableName added in v1.15.85 

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

SetTableName sets the TableName field's value.

func (ConditionCheck) String added in v1.15.85 

func (s ConditionCheck) 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 (*ConditionCheck) Validate added in v1.15.85 

func (s *ConditionCheck) Validate() error

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

type ConditionalCheckFailedException added in v1.28.0 

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

	// The conditional request failed.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

A condition specified in the operation could not be evaluated.

func (*ConditionalCheckFailedException) Code added in v1.28.0 

func (s *ConditionalCheckFailedException) Code() string

Code returns the exception type name.

func (*ConditionalCheckFailedException) Error added in v1.28.0 

func (s *ConditionalCheckFailedException) Error() string

func (ConditionalCheckFailedException) GoString added in v1.28.0 

func (s ConditionalCheckFailedException) 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 (*ConditionalCheckFailedException) Message added in v1.28.0 

func (s *ConditionalCheckFailedException) Message() string

Message returns the exception's message.

func (*ConditionalCheckFailedException) OrigErr added in v1.28.0 

func (s *ConditionalCheckFailedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConditionalCheckFailedException) RequestID added in v1.28.0 

func (s *ConditionalCheckFailedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConditionalCheckFailedException) StatusCode added in v1.28.0 

func (s *ConditionalCheckFailedException) StatusCode() int

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

func (ConditionalCheckFailedException) String added in v1.28.0 

func (s ConditionalCheckFailedException) 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 ConsumedCapacity 

type ConsumedCapacity struct {

	// The total number of capacity units consumed by the operation.
	CapacityUnits *float64 `type:"double"`

	// The amount of throughput consumed on each global index affected by the operation.
	GlobalSecondaryIndexes map[string]*Capacity `type:"map"`

	// The amount of throughput consumed on each local index affected by the operation.
	LocalSecondaryIndexes map[string]*Capacity `type:"map"`

	// The total number of read capacity units consumed by the operation.
	ReadCapacityUnits *float64 `type:"double"`

	// The amount of throughput consumed on the table affected by the operation.
	Table *Capacity `type:"structure"`

	// The name of the table that was affected by the operation.
	TableName *string `min:"3" type:"string"`

	// The total number of write capacity units consumed by the operation.
	WriteCapacityUnits *float64 `type:"double"`
	// contains filtered or unexported fields
}

The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) in the Amazon DynamoDB Developer Guide.

func (ConsumedCapacity) GoString added in v0.6.5 

func (s ConsumedCapacity) 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 (*ConsumedCapacity) SetCapacityUnits added in v1.5.0 

func (s *ConsumedCapacity) SetCapacityUnits(v float64) *ConsumedCapacity

SetCapacityUnits sets the CapacityUnits field's value.

func (*ConsumedCapacity) SetGlobalSecondaryIndexes added in v1.5.0 

func (s *ConsumedCapacity) SetGlobalSecondaryIndexes(v map[string]*Capacity) *ConsumedCapacity

SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.

func (*ConsumedCapacity) SetLocalSecondaryIndexes added in v1.5.0 

func (s *ConsumedCapacity) SetLocalSecondaryIndexes(v map[string]*Capacity) *ConsumedCapacity

SetLocalSecondaryIndexes sets the LocalSecondaryIndexes field's value.

func (*ConsumedCapacity) SetReadCapacityUnits added in v1.15.85 

func (s *ConsumedCapacity) SetReadCapacityUnits(v float64) *ConsumedCapacity

SetReadCapacityUnits sets the ReadCapacityUnits field's value.

func (*ConsumedCapacity) SetTable added in v1.5.0 

func (s *ConsumedCapacity) SetTable(v *Capacity) *ConsumedCapacity

SetTable sets the Table field's value.

func (*ConsumedCapacity) SetTableName added in v1.5.0 

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

SetTableName sets the TableName field's value.

func (*ConsumedCapacity) SetWriteCapacityUnits added in v1.15.85 

func (s *ConsumedCapacity) SetWriteCapacityUnits(v float64) *ConsumedCapacity

SetWriteCapacityUnits sets the WriteCapacityUnits field's value.

func (ConsumedCapacity) String added in v0.6.5 

func (s ConsumedCapacity) 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 ContinuousBackupsDescription added in v1.12.36 

type ContinuousBackupsDescription struct {

	// ContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED
	//
	// ContinuousBackupsStatus is a required field
	ContinuousBackupsStatus *string `type:"string" required:"true" enum:"ContinuousBackupsStatus"`

	// The description of the point in time recovery settings applied to the table.
	PointInTimeRecoveryDescription *PointInTimeRecoveryDescription `type:"structure"`
	// contains filtered or unexported fields
}

Represents the continuous backups and point in time recovery settings on the table.

func (ContinuousBackupsDescription) GoString added in v1.12.36 

func (s ContinuousBackupsDescription) 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 (*ContinuousBackupsDescription) SetContinuousBackupsStatus added in v1.12.36 

func (s *ContinuousBackupsDescription) SetContinuousBackupsStatus(v string) *ContinuousBackupsDescription

SetContinuousBackupsStatus sets the ContinuousBackupsStatus field's value.

func (*ContinuousBackupsDescription) SetPointInTimeRecoveryDescription added in v1.13.21 

func (s *ContinuousBackupsDescription) SetPointInTimeRecoveryDescription(v *PointInTimeRecoveryDescription) *ContinuousBackupsDescription

SetPointInTimeRecoveryDescription sets the PointInTimeRecoveryDescription field's value.

func (ContinuousBackupsDescription) String added in v1.12.36 

func (s ContinuousBackupsDescription) 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 ContinuousBackupsUnavailableException added in v1.28.0 

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

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

Backups have not yet been enabled for this table.

func (*ContinuousBackupsUnavailableException) Code added in v1.28.0 

func (s *ContinuousBackupsUnavailableException) Code() string

Code returns the exception type name.

func (*ContinuousBackupsUnavailableException) Error added in v1.28.0 

func (s *ContinuousBackupsUnavailableException) Error() string

func (ContinuousBackupsUnavailableException) GoString added in v1.28.0 

func (s ContinuousBackupsUnavailableException) 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 (*ContinuousBackupsUnavailableException) Message added in v1.28.0 

func (s *ContinuousBackupsUnavailableException) Message() string

Message returns the exception's message.

func (*ContinuousBackupsUnavailableException) OrigErr added in v1.28.0 

func (s *ContinuousBackupsUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ContinuousBackupsUnavailableException) RequestID added in v1.28.0 

func (s *ContinuousBackupsUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ContinuousBackupsUnavailableException) StatusCode added in v1.28.0 

func (s *ContinuousBackupsUnavailableException) StatusCode() int

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

func (ContinuousBackupsUnavailableException) String added in v1.28.0 

func (s ContinuousBackupsUnavailableException) 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 ContributorInsightsSummary added in v1.25.43 

type ContributorInsightsSummary struct {

	// Describes the current status for contributor insights for the given table
	// and index, if applicable.
	ContributorInsightsStatus *string `type:"string" enum:"ContributorInsightsStatus"`

	// Name of the index associated with the summary, if any.
	IndexName *string `min:"3" type:"string"`

	// Name of the table associated with the summary.
	TableName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

Represents a Contributor Insights summary entry.

func (ContributorInsightsSummary) GoString added in v1.25.43 

func (s ContributorInsightsSummary) 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 (*ContributorInsightsSummary) SetContributorInsightsStatus added in v1.25.43 

func (s *ContributorInsightsSummary) SetContributorInsightsStatus(v string) *ContributorInsightsSummary

SetContributorInsightsStatus sets the ContributorInsightsStatus field's value.

func (*ContributorInsightsSummary) SetIndexName added in v1.25.43 

func (s *ContributorInsightsSummary) SetIndexName(v string) *ContributorInsightsSummary

SetIndexName sets the IndexName field's value.

func (*ContributorInsightsSummary) SetTableName added in v1.25.43 

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

SetTableName sets the TableName field's value.

func (ContributorInsightsSummary) String added in v1.25.43 

func (s ContributorInsightsSummary) 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 CreateBackupInput added in v1.12.36 

type CreateBackupInput struct {

	// Specified name for the backup.
	//
	// BackupName is a required field
	BackupName *string `min:"3" type:"string" required:"true"`

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

func (CreateBackupInput) GoString added in v1.12.36 

func (s CreateBackupInput) 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 (*CreateBackupInput) SetBackupName added in v1.12.36 

func (s *CreateBackupInput) SetBackupName(v string) *CreateBackupInput

SetBackupName sets the BackupName field's value.

func (*CreateBackupInput) SetTableName added in v1.12.36 

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

SetTableName sets the TableName field's value.

func (CreateBackupInput) String added in v1.12.36 

func (s CreateBackupInput) 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 (*CreateBackupInput) Validate added in v1.12.36 

func (s *CreateBackupInput) Validate() error

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

type CreateBackupOutput added in v1.12.36 

type CreateBackupOutput struct {

	// Contains the details of the backup created for the table.
	BackupDetails *BackupDetails `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateBackupOutput) GoString added in v1.12.36 

func (s CreateBackupOutput) 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 (*CreateBackupOutput) SetBackupDetails added in v1.12.36 

func (s *CreateBackupOutput) SetBackupDetails(v *BackupDetails) *CreateBackupOutput

SetBackupDetails sets the BackupDetails field's value.

func (CreateBackupOutput) String added in v1.12.36 

func (s CreateBackupOutput) 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 CreateGlobalSecondaryIndexAction 

type CreateGlobalSecondaryIndexAction struct {

	// The name of the global secondary index to be created.
	//
	// IndexName is a required field
	IndexName *string `min:"3" type:"string" required:"true"`

	// The key schema for the global secondary index.
	//
	// KeySchema is a required field
	KeySchema []*KeySchemaElement `min:"1" type:"list" required:"true"`

	// Represents attributes that are copied (projected) from the table into an
	// index. These are in addition to the primary key attributes and index key
	// attributes, which are automatically projected.
	//
	// Projection is a required field
	Projection *Projection `type:"structure" required:"true"`

	// Represents the provisioned throughput settings for the specified global secondary
	// index.
	//
	// For current minimum and maximum provisioned throughput values, see Service,
	// Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
	// in the Amazon DynamoDB Developer Guide.
	ProvisionedThroughput *ProvisionedThroughput `type:"structure"`
	// contains filtered or unexported fields
}

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

func (CreateGlobalSecondaryIndexAction) GoString added in v0.6.5 

func (s CreateGlobalSecondaryIndexAction) 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 (*CreateGlobalSecondaryIndexAction) SetIndexName added in v1.5.0 

func (s *CreateGlobalSecondaryIndexAction) SetIndexName(v string) *CreateGlobalSecondaryIndexAction

SetIndexName sets the IndexName field's value.

func (*CreateGlobalSecondaryIndexAction) SetKeySchema added in v1.5.0 

func (s *CreateGlobalSecondaryIndexAction) SetKeySchema(v []*KeySchemaElement) *CreateGlobalSecondaryIndexAction

SetKeySchema sets the KeySchema field's value.

func (*CreateGlobalSecondaryIndexAction) SetProjection added in v1.5.0 

func (s *CreateGlobalSecondaryIndexAction) SetProjection(v *Projection) *CreateGlobalSecondaryIndexAction

SetProjection sets the Projection field's value.

func (*CreateGlobalSecondaryIndexAction) SetProvisionedThroughput added in v1.5.0 

func (s *CreateGlobalSecondaryIndexAction) SetProvisionedThroughput(v *ProvisionedThroughput) *CreateGlobalSecondaryIndexAction

SetProvisionedThroughput sets the ProvisionedThroughput field's value.

func (CreateGlobalSecondaryIndexAction) String added in v0.6.5 

func (s CreateGlobalSecondaryIndexAction) 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 (*CreateGlobalSecondaryIndexAction) Validate added in v1.1.21 

func (s *CreateGlobalSecondaryIndexAction) Validate() error

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

type CreateGlobalTableInput added in v1.12.36 

type CreateGlobalTableInput struct {

	// The global table name.
	//
	// GlobalTableName is a required field
	GlobalTableName *string `min:"3" type:"string" required:"true"`

	// The Regions where the global table needs to be created.
	//
	// ReplicationGroup is a required field
	ReplicationGroup []*Replica `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateGlobalTableInput) GoString added in v1.12.36 

func (s CreateGlobalTableInput) 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 (*CreateGlobalTableInput) SetGlobalTableName added in v1.12.36 

func (s *CreateGlobalTableInput) SetGlobalTableName(v string) *CreateGlobalTableInput

SetGlobalTableName sets the GlobalTableName field's value.

func (*CreateGlobalTableInput) SetReplicationGroup added in v1.12.36 

func (s *CreateGlobalTableInput) SetReplicationGroup(v []*Replica) *CreateGlobalTableInput

SetReplicationGroup sets the ReplicationGroup field's value.

func (CreateGlobalTableInput) String added in v1.12.36 

func (s CreateGlobalTableInput) 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 (*CreateGlobalTableInput) Validate added in v1.12.36 

func (s *CreateGlobalTableInput) Validate() error

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

type CreateGlobalTableOutput added in v1.12.36 

type CreateGlobalTableOutput struct {

	// Contains the details of the global table.
	GlobalTableDescription *GlobalTableDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateGlobalTableOutput) GoString added in v1.12.36 

func (s CreateGlobalTableOutput) 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 (*CreateGlobalTableOutput) SetGlobalTableDescription added in v1.12.36 

func (s *CreateGlobalTableOutput) SetGlobalTableDescription(v *GlobalTableDescription) *CreateGlobalTableOutput

SetGlobalTableDescription sets the GlobalTableDescription field's value.

func (CreateGlobalTableOutput) String added in v1.12.36 

func (s CreateGlobalTableOutput) 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 CreateReplicaAction added in v1.12.36 

type CreateReplicaAction struct {

	// The Region of the replica to be added.
	//
	// RegionName is a required field
	RegionName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a replica to be added.

func (CreateReplicaAction) GoString added in v1.12.36 

func (s CreateReplicaAction) 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 (*CreateReplicaAction) SetRegionName added in v1.12.36 

func (s *CreateReplicaAction) SetRegionName(v string) *CreateReplicaAction

SetRegionName sets the RegionName field's value.

func (CreateReplicaAction) String added in v1.12.36 

func (s CreateReplicaAction) 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 (*CreateReplicaAction) Validate added in v1.12.36 

func (s *CreateReplicaAction) Validate() error

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

type CreateReplicationGroupMemberAction added in v1.25.40 

type CreateReplicationGroupMemberAction struct {

	// Replica-specific global secondary index settings.
	GlobalSecondaryIndexes []*ReplicaGlobalSecondaryIndex `min:"1" type:"list"`

	// The KMS key that should be used for KMS encryption in the new replica. To
	// specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or
	// alias ARN. Note that you should only provide this parameter if the key is
	// different from the default DynamoDB KMS key alias/aws/dynamodb.
	KMSMasterKeyId *string `type:"string"`

	// Replica-specific provisioned throughput. If not specified, uses the source
	// table's provisioned throughput settings.
	ProvisionedThroughputOverride *ProvisionedThroughputOverride `type:"structure"`

	// The Region where the new replica will be created.
	//
	// RegionName is a required field
	RegionName *string `type:"string" required:"true"`

	// Replica-specific table class. If not specified, uses the source table's table
	// class.
	TableClassOverride *string `type:"string" enum:"TableClass"`
	// contains filtered or unexported fields
}

Represents a replica to be created.

func (CreateReplicationGroupMemberAction) GoString added in v1.25.40 

func (s CreateReplicationGroupMemberAction) 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 (*CreateReplicationGroupMemberAction) SetGlobalSecondaryIndexes added in v1.25.40 

func (s *CreateReplicationGroupMemberAction) SetGlobalSecondaryIndexes(v []*ReplicaGlobalSecondaryIndex) *CreateReplicationGroupMemberAction

SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.

func (*CreateReplicationGroupMemberAction) SetKMSMasterKeyId added in v1.25.40 

func (s *CreateReplicationGroupMemberAction) SetKMSMasterKeyId(v string) *CreateReplicationGroupMemberAction

SetKMSMasterKeyId sets the KMSMasterKeyId field's value.

func (*CreateReplicationGroupMemberAction) SetProvisionedThroughputOverride added in v1.25.40 

func (s *CreateReplicationGroupMemberAction) SetProvisionedThroughputOverride(v *ProvisionedThroughputOverride) *CreateReplicationGroupMemberAction

SetProvisionedThroughputOverride sets the ProvisionedThroughputOverride field's value.

func (*CreateReplicationGroupMemberAction) SetRegionName added in v1.25.40 

func (s *CreateReplicationGroupMemberAction) SetRegionName(v string) *CreateReplicationGroupMemberAction

SetRegionName sets the RegionName field's value.

func (*CreateReplicationGroupMemberAction) SetTableClassOverride added in v1.42.17 

func (s *CreateReplicationGroupMemberAction) SetTableClassOverride(v string) *CreateReplicationGroupMemberAction

SetTableClassOverride sets the TableClassOverride field's value.

func (CreateReplicationGroupMemberAction) String added in v1.25.40 

func (s CreateReplicationGroupMemberAction) 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 (*CreateReplicationGroupMemberAction) Validate added in v1.25.40 

func (s *CreateReplicationGroupMemberAction) Validate() error

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

type CreateTableInput 

type CreateTableInput struct {

	// An array of attributes that describe the key schema for the table and indexes.
	//
	// AttributeDefinitions is a required field
	AttributeDefinitions []*AttributeDefinition `type:"list" required:"true"`

	// Controls how you are charged for read and write throughput and how you manage
	// capacity. This setting can be changed later.
	//
	//    * PROVISIONED - We recommend using PROVISIONED for predictable workloads.
	//    PROVISIONED sets the billing mode to Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual).
	//
	//    * PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable
	//    workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand).
	BillingMode *string `type:"string" enum:"BillingMode"`

	// One or more global secondary indexes (the maximum is 20) to be created on
	// the table. Each global secondary index in the array includes the following:
	//
	//    * IndexName - The name of the global secondary index. Must be unique only
	//    for this table.
	//
	//    * KeySchema - Specifies the key schema for the global secondary index.
	//
	//    * Projection - Specifies attributes that are copied (projected) from the
	//    table into the index. These are in addition to the primary key attributes
	//    and index key attributes, which are automatically projected. Each attribute
	//    specification is composed of: ProjectionType - One of the following: KEYS_ONLY
	//    - Only the index and primary keys are projected into the index. INCLUDE
	//    - Only the specified table attributes are projected into the index. The
	//    list of projected attributes is in NonKeyAttributes. ALL - All of the
	//    table attributes are projected into the index. NonKeyAttributes - A list
	//    of one or more non-key attribute names that are projected into the secondary
	//    index. The total count of attributes provided in NonKeyAttributes, summed
	//    across all of the secondary indexes, must not exceed 100. If you project
	//    the same attribute into two different indexes, this counts as two distinct
	//    attributes when determining the total.
	//
	//    * ProvisionedThroughput - The provisioned throughput settings for the
	//    global secondary index, consisting of read and write capacity units.
	GlobalSecondaryIndexes []*GlobalSecondaryIndex `type:"list"`

	// Specifies the attributes that make up the primary key for a table or an index.
	// The attributes in KeySchema must also be defined in the AttributeDefinitions
	// array. For more information, see Data Model (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html)
	// in the Amazon DynamoDB Developer Guide.
	//
	// Each KeySchemaElement in the array is composed of:
	//
	//    * AttributeName - The name of this key attribute.
	//
	//    * KeyType - The role that the key attribute will assume: HASH - partition
	//    key RANGE - sort key
	//
	// The partition key of an item is also known as its hash attribute. The term
	// "hash attribute" derives from the DynamoDB usage of an internal hash function
	// to evenly distribute data items across partitions, based on their partition
	// key values.
	//
	// The sort key of an item is also known as its range attribute. The term "range
	// attribute" derives from the way DynamoDB stores items with the same partition
	// key physically close together, in sorted order by the sort key value.
	//
	// For a simple primary key (partition key), you must provide exactly one element
	// with a KeyType of HASH.
	//
	// For a composite primary key (partition key and sort key), you must provide
	// exactly two elements, in this order: The first element must have a KeyType
	// of HASH, and the second element must have a KeyType of RANGE.
	//
	// For more information, see Working with Tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key)
	// in the Amazon DynamoDB Developer Guide.
	//
	// KeySchema is a required field
	KeySchema []*KeySchemaElement `min:"1" type:"list" required:"true"`

	// One or more local secondary indexes (the maximum is 5) to be created on the
	// table. Each index is scoped to a given partition key value. There is a 10
	// GB size limit per partition key value; otherwise, the size of a local secondary
	// index is unconstrained.
	//
	// Each local secondary index in the array includes the following:
	//
	//    * IndexName - The name of the local secondary index. Must be unique only
	//    for this table.
	//
	//    * KeySchema - Specifies the key schema for the local secondary index.
	//    The key schema must begin with the same partition key as the table.
	//
	//    * Projection - Specifies attributes that are copied (projected) from the
	//    table into the index. These are in addition to the primary key attributes
	//    and index key attributes, which are automatically projected. Each attribute
	//    specification is composed of: ProjectionType - One of the following: KEYS_ONLY
	//    - Only the index and primary keys are projected into the index. INCLUDE
	//    - Only the specified table attributes are projected into the index. The
	//    list of projected attributes is in NonKeyAttributes. ALL - All of the
	//    table attributes are projected into the index. NonKeyAttributes - A list
	//    of one or more non-key attribute names that are projected into the secondary
	//    index. The total count of attributes provided in NonKeyAttributes, summed
	//    across all of the secondary indexes, must not exceed 100. If you project
	//    the same attribute into two different indexes, this counts as two distinct
	//    attributes when determining the total.
	LocalSecondaryIndexes []*LocalSecondaryIndex `type:"list"`

	// Represents the provisioned throughput settings for a specified table or index.
	// The settings can be modified using the UpdateTable operation.
	//
	// If you set BillingMode as PROVISIONED, you must specify this property. If
	// you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.
	//
	// For current minimum and maximum provisioned throughput values, see Service,
	// Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
	// in the Amazon DynamoDB Developer Guide.
	ProvisionedThroughput *ProvisionedThroughput `type:"structure"`

	// Represents the settings used to enable server-side encryption.
	SSESpecification *SSESpecification `type:"structure"`

	// The settings for DynamoDB Streams on the table. These settings consist of:
	//
	//    * StreamEnabled - Indicates whether DynamoDB Streams is to be enabled
	//    (true) or disabled (false).
	//
	//    * StreamViewType - When an item in the table is modified, StreamViewType
	//    determines what information is written to the table's stream. Valid values
	//    for StreamViewType are: KEYS_ONLY - Only the key attributes of the modified
	//    item are written to the stream. NEW_IMAGE - The entire item, as it appears
	//    after it was modified, is written to the stream. OLD_IMAGE - The entire
	//    item, as it appeared before it was modified, is written to the stream.
	//    NEW_AND_OLD_IMAGES - Both the new and the old item images of the item
	//    are written to the stream.
	StreamSpecification *StreamSpecification `type:"structure"`

	// The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
	TableClass *string `type:"string" enum:"TableClass"`

	// The name of the table to create.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`

	// A list of key-value pairs to label the table. For more information, see Tagging
	// for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html).
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

Represents the input of a CreateTable operation.

func (CreateTableInput) GoString added in v0.6.5 

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) SetAttributeDefinitions added in v1.5.0 

func (s *CreateTableInput) SetAttributeDefinitions(v []*AttributeDefinition) *CreateTableInput

SetAttributeDefinitions sets the AttributeDefinitions field's value.

func (*CreateTableInput) SetBillingMode added in v1.15.85 

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

SetBillingMode sets the BillingMode field's value.

func (*CreateTableInput) SetGlobalSecondaryIndexes added in v1.5.0 

func (s *CreateTableInput) SetGlobalSecondaryIndexes(v []*GlobalSecondaryIndex) *CreateTableInput

SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.

func (*CreateTableInput) SetKeySchema added in v1.5.0 

func (s *CreateTableInput) SetKeySchema(v []*KeySchemaElement) *CreateTableInput

SetKeySchema sets the KeySchema field's value.

func (*CreateTableInput) SetLocalSecondaryIndexes added in v1.5.0 

func (s *CreateTableInput) SetLocalSecondaryIndexes(v []*LocalSecondaryIndex) *CreateTableInput

SetLocalSecondaryIndexes sets the LocalSecondaryIndexes field's value.

func (*CreateTableInput) SetProvisionedThroughput added in v1.5.0 

func (s *CreateTableInput) SetProvisionedThroughput(v *ProvisionedThroughput) *CreateTableInput

SetProvisionedThroughput sets the ProvisionedThroughput field's value.

func (*CreateTableInput) SetSSESpecification added in v1.12.73 

func (s *CreateTableInput) SetSSESpecification(v *SSESpecification) *CreateTableInput

SetSSESpecification sets the SSESpecification field's value.

func (*CreateTableInput) SetStreamSpecification added in v1.5.0 

func (s *CreateTableInput) SetStreamSpecification(v *StreamSpecification) *CreateTableInput

SetStreamSpecification sets the StreamSpecification field's value.

func (*CreateTableInput) SetTableClass added in v1.42.17 

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

SetTableClass sets the TableClass field's value.

func (*CreateTableInput) SetTableName added in v1.5.0 

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

SetTableName sets the TableName field's value.

func (*CreateTableInput) SetTags added in v1.19.18 

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

SetTags sets the Tags field's value.

func (CreateTableInput) String added in v0.6.5 

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 added in v1.1.21 

func (s *CreateTableInput) Validate() error

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

type CreateTableOutput 

type CreateTableOutput struct {

	// Represents the properties of the table.
	TableDescription *TableDescription `type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a CreateTable operation.

func (CreateTableOutput) GoString added in v0.6.5 

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) SetTableDescription added in v1.5.0 

func (s *CreateTableOutput) SetTableDescription(v *TableDescription) *CreateTableOutput

SetTableDescription sets the TableDescription field's value.

func (CreateTableOutput) String added in v0.6.5 

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 Delete added in v1.15.85 

type Delete struct {

	// A condition that must be satisfied in order for a conditional delete to succeed.
	ConditionExpression *string `type:"string"`

	// One or more substitution tokens for attribute names in an expression.
	ExpressionAttributeNames map[string]*string `type:"map"`

	// One or more values that can be substituted in an expression.
	ExpressionAttributeValues map[string]*AttributeValue `type:"map"`

	// The primary key of the item to be deleted. Each element consists of an attribute
	// name and a value for that attribute.
	//
	// Key is a required field
	Key map[string]*AttributeValue `type:"map" required:"true"`

	// Use ReturnValuesOnConditionCheckFailure to get the item attributes if the
	// Delete condition fails. For ReturnValuesOnConditionCheckFailure, the valid
	// values are: NONE and ALL_OLD.
	ReturnValuesOnConditionCheckFailure *string `type:"string" enum:"ReturnValuesOnConditionCheckFailure"`

	// Name of the table in which the item to be deleted resides.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a request to perform a DeleteItem operation.

func (Delete) GoString added in v1.15.85 

func (s Delete) 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 (*Delete) SetConditionExpression added in v1.15.85 

func (s *Delete) SetConditionExpression(v string) *Delete

SetConditionExpression sets the ConditionExpression field's value.

func (*Delete) SetExpressionAttributeNames added in v1.15.85 

func (s *Delete) SetExpressionAttributeNames(v map[string]*string) *Delete

SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.

func (*Delete) SetExpressionAttributeValues added in v1.15.85 

func (s *Delete) SetExpressionAttributeValues(v map[string]*AttributeValue) *Delete

SetExpressionAttributeValues sets the ExpressionAttributeValues field's value.

func (*Delete) SetKey added in v1.15.85 

func (s *Delete) SetKey(v map[string]*AttributeValue) *Delete

SetKey sets the Key field's value.

func (*Delete) SetReturnValuesOnConditionCheckFailure added in v1.15.85 

func (s *Delete) SetReturnValuesOnConditionCheckFailure(v string) *Delete

SetReturnValuesOnConditionCheckFailure sets the ReturnValuesOnConditionCheckFailure field's value.

func (*Delete) SetTableName added in v1.15.85 

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

SetTableName sets the TableName field's value.

func (Delete) String added in v1.15.85 

func (s Delete) 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 (*Delete) Validate added in v1.15.85 

func (s *Delete) Validate() error

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

type DeleteBackupInput added in v1.12.36 

type DeleteBackupInput struct {

	// The ARN associated with the backup.
	//
	// BackupArn is a required field
	BackupArn *string `min:"37" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBackupInput) GoString added in v1.12.36 

func (s DeleteBackupInput) 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 (*DeleteBackupInput) SetBackupArn added in v1.12.36 

func (s *DeleteBackupInput) SetBackupArn(v string) *DeleteBackupInput

SetBackupArn sets the BackupArn field's value.

func (DeleteBackupInput) String added in v1.12.36 

func (s DeleteBackupInput) 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 (*DeleteBackupInput) Validate added in v1.12.36 

func (s *DeleteBackupInput) Validate() error

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

type DeleteBackupOutput added in v1.12.36 

type DeleteBackupOutput struct {

	// Contains the description of the backup created for the table.
	BackupDescription *BackupDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteBackupOutput) GoString added in v1.12.36 

func (s DeleteBackupOutput) 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 (*DeleteBackupOutput) SetBackupDescription added in v1.12.36 

func (s *DeleteBackupOutput) SetBackupDescription(v *BackupDescription) *DeleteBackupOutput

SetBackupDescription sets the BackupDescription field's value.

func (DeleteBackupOutput) String added in v1.12.36 

func (s DeleteBackupOutput) 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 DeleteGlobalSecondaryIndexAction 

type DeleteGlobalSecondaryIndexAction struct {

	// The name of the global secondary index to be deleted.
	//
	// IndexName is a required field
	IndexName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (DeleteGlobalSecondaryIndexAction) GoString added in v0.6.5 

func (s DeleteGlobalSecondaryIndexAction) 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 (*DeleteGlobalSecondaryIndexAction) SetIndexName added in v1.5.0 

func (s *DeleteGlobalSecondaryIndexAction) SetIndexName(v string) *DeleteGlobalSecondaryIndexAction

SetIndexName sets the IndexName field's value.

func (DeleteGlobalSecondaryIndexAction) String added in v0.6.5 

func (s DeleteGlobalSecondaryIndexAction) 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 (*DeleteGlobalSecondaryIndexAction) Validate added in v1.1.21 

func (s *DeleteGlobalSecondaryIndexAction) Validate() error

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

type DeleteItemInput 

type DeleteItemInput struct {

	// A condition that must be satisfied in order for a conditional DeleteItem
	// to succeed.
	//
	// An expression can contain any of the following:
	//
	//    * Functions: attribute_exists | attribute_not_exists | attribute_type
	//    | contains | begins_with | size These function names are case-sensitive.
	//
	//    * Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
	//
	//    * Logical operators: AND | OR | NOT
	//
	// For more information about condition expressions, see Condition Expressions
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
	// in the Amazon DynamoDB Developer Guide.
	ConditionExpression *string `type:"string"`

	// This is a legacy parameter. Use ConditionExpression instead. For more information,
	// see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html)
	// in the Amazon DynamoDB Developer Guide.
	ConditionalOperator *string `type:"string" enum:"ConditionalOperator"`

	// This is a legacy parameter. Use ConditionExpression instead. For more information,
	// see Expected (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html)
	// in the Amazon DynamoDB Developer Guide.
	Expected map[string]*ExpectedAttributeValue `type:"map"`

	// One or more substitution tokens for attribute names in an expression. The
	// following are some use cases for using ExpressionAttributeNames:
	//
	//    * To access an attribute whose name conflicts with a DynamoDB reserved
	//    word.
	//
	//    * To create a placeholder for repeating occurrences of an attribute name
	//    in an expression.
	//
	//    * To prevent special characters in an attribute name from being misinterpreted
	//    in an expression.
	//
	// Use the # character in an expression to dereference an attribute name. For
	// example, consider the following attribute name:
	//
	//    * Percentile
	//
	// The name of this attribute conflicts with a reserved word, so it cannot be
	// used directly in an expression. (For the complete list of reserved words,
	// see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
	// in the Amazon DynamoDB Developer Guide). To work around this, you could specify
	// the following for ExpressionAttributeNames:
	//
	//    * {"#P":"Percentile"}
	//
	// You could then use this substitution in an expression, as in this example:
	//
	//    * #P = :val
	//
	// Tokens that begin with the : character are expression attribute values, which
	// are placeholders for the actual value at runtime.
	//
	// For more information on expression attribute names, see Specifying Item Attributes
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
	// in the Amazon DynamoDB Developer Guide.
	ExpressionAttributeNames map[string]*string `type:"map"`

	// One or more values that can be substituted in an expression.
	//
	// Use the : (colon) character in an expression to dereference an attribute
	// value. For example, suppose that you wanted to check whether the value of
	// the ProductStatus attribute was one of the following:
	//
	// Available | Backordered | Discontinued
	//
	// You would first need to specify ExpressionAttributeValues as follows:
	//
	// { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"}
	// }
	//
	// You could then use these values in an expression, such as this:
	//
	// ProductStatus IN (:avail, :back, :disc)
	//
	// For more information on expression attribute values, see Condition Expressions
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
	// in the Amazon DynamoDB Developer Guide.
	ExpressionAttributeValues map[string]*AttributeValue `type:"map"`

	// A map of attribute names to AttributeValue objects, representing the primary
	// key of the item to delete.
	//
	// For the primary key, you must provide all of the attributes. For example,
	// with a simple primary key, you only need to provide a value for the partition
	// key. For a composite primary key, you must provide values for both the partition
	// key and the sort key.
	//
	// Key is a required field
	Key map[string]*AttributeValue `type:"map" required:"true"`

	// Determines the level of detail about either provisioned or on-demand throughput
	// consumption that is returned in the response:
	//
	//    * INDEXES - The response includes the aggregate ConsumedCapacity for the
	//    operation, together with ConsumedCapacity for each table and secondary
	//    index that was accessed. Note that some operations, such as GetItem and
	//    BatchGetItem, do not access any indexes at all. In these cases, specifying
	//    INDEXES will only return ConsumedCapacity information for table(s).
	//
	//    * TOTAL - The response includes only the aggregate ConsumedCapacity for
	//    the operation.
	//
	//    * NONE - No ConsumedCapacity details are included in the response.
	ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"`

	// Determines whether item collection metrics are returned. If set to SIZE,
	// the response includes statistics about item collections, if any, that were
	// modified during the operation are returned in the response. If set to NONE
	// (the default), no statistics are returned.
	ReturnItemCollectionMetrics *string `type:"string" enum:"ReturnItemCollectionMetrics"`

	// Use ReturnValues if you want to get the item attributes as they appeared
	// before they were deleted. For DeleteItem, the valid values are:
	//
	//    * NONE - If ReturnValues is not specified, or if its value is NONE, then
	//    nothing is returned. (This setting is the default for ReturnValues.)
	//
	//    * ALL_OLD - The content of the old item is returned.
	//
	// There is no additional cost associated with requesting a return value aside
	// from the small network and processing overhead of receiving a larger response.
	// No read capacity units are consumed.
	//
	// The ReturnValues parameter is used by several DynamoDB operations; however,
	// DeleteItem does not recognize any values other than NONE or ALL_OLD.
	ReturnValues *string `type:"string" enum:"ReturnValue"`

	// The name of the table from which to delete the item.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a DeleteItem operation.

func (DeleteItemInput) GoString added in v0.6.5 

func (s DeleteItemInput) 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 (*DeleteItemInput) SetConditionExpression added in v1.5.0 

func (s *DeleteItemInput) SetConditionExpression(v string) *DeleteItemInput

SetConditionExpression sets the ConditionExpression field's value.

func (*DeleteItemInput) SetConditionalOperator added in v1.5.0 

func (s *DeleteItemInput) SetConditionalOperator(v string) *DeleteItemInput

SetConditionalOperator sets the ConditionalOperator field's value.

func (*DeleteItemInput) SetExpected added in v1.5.0 

func (s *DeleteItemInput) SetExpected(v map[string]*ExpectedAttributeValue) *DeleteItemInput

SetExpected sets the Expected field's value.

func (*DeleteItemInput) SetExpressionAttributeNames added in v1.5.0 

func (s *DeleteItemInput) SetExpressionAttributeNames(v map[string]*string) *DeleteItemInput

SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.

func (*DeleteItemInput) SetExpressionAttributeValues added in v1.5.0 

func (s *DeleteItemInput) SetExpressionAttributeValues(v map[string]*AttributeValue) *DeleteItemInput

SetExpressionAttributeValues sets the ExpressionAttributeValues field's value.

func (*DeleteItemInput) SetKey added in v1.5.0 

func (s *DeleteItemInput) SetKey(v map[string]*AttributeValue) *DeleteItemInput

SetKey sets the Key field's value.

func (*DeleteItemInput) SetReturnConsumedCapacity added in v1.5.0 

func (s *DeleteItemInput) SetReturnConsumedCapacity(v string) *DeleteItemInput

SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.

func (*DeleteItemInput) SetReturnItemCollectionMetrics added in v1.5.0 

func (s *DeleteItemInput) SetReturnItemCollectionMetrics(v string) *DeleteItemInput

SetReturnItemCollectionMetrics sets the ReturnItemCollectionMetrics field's value.

func (*DeleteItemInput) SetReturnValues added in v1.5.0 

func (s *DeleteItemInput) SetReturnValues(v string) *DeleteItemInput

SetReturnValues sets the ReturnValues field's value.

func (*DeleteItemInput) SetTableName added in v1.5.0 

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

SetTableName sets the TableName field's value.

func (DeleteItemInput) String added in v0.6.5 

func (s DeleteItemInput) 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 (*DeleteItemInput) Validate added in v1.1.21 

func (s *DeleteItemInput) Validate() error

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

type DeleteItemOutput 

type DeleteItemOutput struct {

	// A map of attribute names to AttributeValue objects, representing the item
	// as it appeared before the DeleteItem operation. This map appears in the response
	// only if ReturnValues was specified as ALL_OLD in the request.
	Attributes map[string]*AttributeValue `type:"map"`

	// The capacity units consumed by the DeleteItem operation. The data returned
	// includes the total provisioned throughput consumed, along with statistics
	// for the table and any indexes involved in the operation. ConsumedCapacity
	// is only returned if the ReturnConsumedCapacity parameter was specified. For
	// more information, see Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
	// in the Amazon DynamoDB Developer Guide.
	ConsumedCapacity *ConsumedCapacity `type:"structure"`

	// Information about item collections, if any, that were affected by the DeleteItem
	// operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics
	// parameter was specified. If the table does not have any local secondary indexes,
	// this information is not returned in the response.
	//
	// Each ItemCollectionMetrics element consists of:
	//
	//    * ItemCollectionKey - The partition key value of the item collection.
	//    This is the same as the partition key value of the item itself.
	//
	//    * SizeEstimateRangeGB - An estimate of item collection size, in gigabytes.
	//    This value is a two-element array containing a lower bound and an upper
	//    bound for the estimate. The estimate includes the size of all the items
	//    in the table, plus the size of all attributes projected into all of the
	//    local secondary indexes on that table. Use this estimate to measure whether
	//    a local secondary index is approaching its size limit. The estimate is
	//    subject to change over time; therefore, do not rely on the precision or
	//    accuracy of the estimate.
	ItemCollectionMetrics *ItemCollectionMetrics `type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a DeleteItem operation.

func (DeleteItemOutput) GoString added in v0.6.5 

func (s DeleteItemOutput) 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 (*DeleteItemOutput) SetAttributes added in v1.5.0 

func (s *DeleteItemOutput) SetAttributes(v map[string]*AttributeValue) *DeleteItemOutput

SetAttributes sets the Attributes field's value.

func (*DeleteItemOutput) SetConsumedCapacity added in v1.5.0 

func (s *DeleteItemOutput) SetConsumedCapacity(v *ConsumedCapacity) *DeleteItemOutput

SetConsumedCapacity sets the ConsumedCapacity field's value.

func (*DeleteItemOutput) SetItemCollectionMetrics added in v1.5.0 

func (s *DeleteItemOutput) SetItemCollectionMetrics(v *ItemCollectionMetrics) *DeleteItemOutput

SetItemCollectionMetrics sets the ItemCollectionMetrics field's value.

func (DeleteItemOutput) String added in v0.6.5 

func (s DeleteItemOutput) 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 DeleteReplicaAction added in v1.12.36 

type DeleteReplicaAction struct {

	// The Region of the replica to be removed.
	//
	// RegionName is a required field
	RegionName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a replica to be removed.

func (DeleteReplicaAction) GoString added in v1.12.36 

func (s DeleteReplicaAction) 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 (*DeleteReplicaAction) SetRegionName added in v1.12.36 

func (s *DeleteReplicaAction) SetRegionName(v string) *DeleteReplicaAction

SetRegionName sets the RegionName field's value.

func (DeleteReplicaAction) String added in v1.12.36 

func (s DeleteReplicaAction) 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 (*DeleteReplicaAction) Validate added in v1.12.36 

func (s *DeleteReplicaAction) Validate() error

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

type DeleteReplicationGroupMemberAction added in v1.25.40 

type DeleteReplicationGroupMemberAction struct {

	// The Region where the replica exists.
	//
	// RegionName is a required field
	RegionName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a replica to be deleted.

func (DeleteReplicationGroupMemberAction) GoString added in v1.25.40 

func (s DeleteReplicationGroupMemberAction) 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 (*DeleteReplicationGroupMemberAction) SetRegionName added in v1.25.40 

func (s *DeleteReplicationGroupMemberAction) SetRegionName(v string) *DeleteReplicationGroupMemberAction

SetRegionName sets the RegionName field's value.

func (DeleteReplicationGroupMemberAction) String added in v1.25.40 

func (s DeleteReplicationGroupMemberAction) 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 (*DeleteReplicationGroupMemberAction) Validate added in v1.25.40 

func (s *DeleteReplicationGroupMemberAction) Validate() error

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

type DeleteRequest 

type DeleteRequest struct {

	// A map of attribute name to attribute values, representing the primary key
	// of the item to delete. All of the table's primary key attributes must be
	// specified, and their data types must match those of the table's key schema.
	//
	// Key is a required field
	Key map[string]*AttributeValue `type:"map" required:"true"`
	// contains filtered or unexported fields
}

Represents a request to perform a DeleteItem operation on an item.

func (DeleteRequest) GoString added in v0.6.5 

func (s DeleteRequest) 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 (*DeleteRequest) SetKey added in v1.5.0 

func (s *DeleteRequest) SetKey(v map[string]*AttributeValue) *DeleteRequest

SetKey sets the Key field's value.

func (DeleteRequest) String added in v0.6.5 

func (s DeleteRequest) 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 table to delete.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a DeleteTable operation.

func (DeleteTableInput) GoString added in v0.6.5 

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) SetTableName added in v1.5.0 

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

SetTableName sets the TableName field's value.

func (DeleteTableInput) String added in v0.6.5 

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 added in v1.1.21 

func (s *DeleteTableInput) Validate() error

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

type DeleteTableOutput 

type DeleteTableOutput struct {

	// Represents the properties of a table.
	TableDescription *TableDescription `type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a DeleteTable operation.

func (DeleteTableOutput) GoString added in v0.6.5 

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) SetTableDescription added in v1.5.0 

func (s *DeleteTableOutput) SetTableDescription(v *TableDescription) *DeleteTableOutput

SetTableDescription sets the TableDescription field's value.

func (DeleteTableOutput) String added in v0.6.5 

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 DescribeBackupInput added in v1.12.36 

type DescribeBackupInput struct {

	// The Amazon Resource Name (ARN) associated with the backup.
	//
	// BackupArn is a required field
	BackupArn *string `min:"37" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeBackupInput) GoString added in v1.12.36 

func (s DescribeBackupInput) 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 (*DescribeBackupInput) SetBackupArn added in v1.12.36 

func (s *DescribeBackupInput) SetBackupArn(v string) *DescribeBackupInput

SetBackupArn sets the BackupArn field's value.

func (DescribeBackupInput) String added in v1.12.36 

func (s DescribeBackupInput) 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 (*DescribeBackupInput) Validate added in v1.12.36 

func (s *DescribeBackupInput) Validate() error

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

type DescribeBackupOutput added in v1.12.36 

type DescribeBackupOutput struct {

	// Contains the description of the backup created for the table.
	BackupDescription *BackupDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeBackupOutput) GoString added in v1.12.36 

func (s DescribeBackupOutput) 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 (*DescribeBackupOutput) SetBackupDescription added in v1.12.36 

func (s *DescribeBackupOutput) SetBackupDescription(v *BackupDescription) *DescribeBackupOutput

SetBackupDescription sets the BackupDescription field's value.

func (DescribeBackupOutput) String added in v1.12.36 

func (s DescribeBackupOutput) 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 DescribeContinuousBackupsInput added in v1.12.36 

type DescribeContinuousBackupsInput struct {

	// Name of the table for which the customer wants to check the continuous backups
	// and point in time recovery settings.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeContinuousBackupsInput) GoString added in v1.12.36 

func (s DescribeContinuousBackupsInput) 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 (*DescribeContinuousBackupsInput) SetTableName added in v1.12.36 

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

SetTableName sets the TableName field's value.

func (DescribeContinuousBackupsInput) String added in v1.12.36 

func (s DescribeContinuousBackupsInput) 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 (*DescribeContinuousBackupsInput) Validate added in v1.12.36 

func (s *DescribeContinuousBackupsInput) Validate() error

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

type DescribeContinuousBackupsOutput added in v1.12.36 

type DescribeContinuousBackupsOutput struct {

	// Represents the continuous backups and point in time recovery settings on
	// the table.
	ContinuousBackupsDescription *ContinuousBackupsDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeContinuousBackupsOutput) GoString added in v1.12.36 

func (s DescribeContinuousBackupsOutput) 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 (*DescribeContinuousBackupsOutput) SetContinuousBackupsDescription added in v1.12.36 

func (s *DescribeContinuousBackupsOutput) SetContinuousBackupsDescription(v *ContinuousBackupsDescription) *DescribeContinuousBackupsOutput

SetContinuousBackupsDescription sets the ContinuousBackupsDescription field's value.

func (DescribeContinuousBackupsOutput) String added in v1.12.36 

func (s DescribeContinuousBackupsOutput) 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 DescribeContributorInsightsInput added in v1.25.43 

type DescribeContributorInsightsInput struct {

	// The name of the global secondary index to describe, if applicable.
	IndexName *string `min:"3" type:"string"`

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

func (DescribeContributorInsightsInput) GoString added in v1.25.43 

func (s DescribeContributorInsightsInput) 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 (*DescribeContributorInsightsInput) SetIndexName added in v1.25.43 

func (s *DescribeContributorInsightsInput) SetIndexName(v string) *DescribeContributorInsightsInput

SetIndexName sets the IndexName field's value.

func (*DescribeContributorInsightsInput) SetTableName added in v1.25.43 

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

SetTableName sets the TableName field's value.

func (DescribeContributorInsightsInput) String added in v1.25.43 

func (s DescribeContributorInsightsInput) 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 (*DescribeContributorInsightsInput) Validate added in v1.25.43 

func (s *DescribeContributorInsightsInput) Validate() error

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

type DescribeContributorInsightsOutput added in v1.25.43 

type DescribeContributorInsightsOutput struct {

	// List of names of the associated contributor insights rules.
	ContributorInsightsRuleList []*string `type:"list"`

	// Current status of contributor insights.
	ContributorInsightsStatus *string `type:"string" enum:"ContributorInsightsStatus"`

	// Returns information about the last failure that was encountered.
	//
	// The most common exceptions for a FAILED status are:
	//
	//    * LimitExceededException - Per-account Amazon CloudWatch Contributor Insights
	//    rule limit reached. Please disable Contributor Insights for other tables/indexes
	//    OR disable Contributor Insights rules before retrying.
	//
	//    * AccessDeniedException - Amazon CloudWatch Contributor Insights rules
	//    cannot be modified due to insufficient permissions.
	//
	//    * AccessDeniedException - Failed to create service-linked role for Contributor
	//    Insights due to insufficient permissions.
	//
	//    * InternalServerError - Failed to create Amazon CloudWatch Contributor
	//    Insights rules. Please retry request.
	FailureException *FailureException `type:"structure"`

	// The name of the global secondary index being described.
	IndexName *string `min:"3" type:"string"`

	// Timestamp of the last time the status was changed.
	LastUpdateDateTime *time.Time `type:"timestamp"`

	// The name of the table being described.
	TableName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeContributorInsightsOutput) GoString added in v1.25.43 

func (s DescribeContributorInsightsOutput) 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 (*DescribeContributorInsightsOutput) SetContributorInsightsRuleList added in v1.25.43 

func (s *DescribeContributorInsightsOutput) SetContributorInsightsRuleList(v []*string) *DescribeContributorInsightsOutput

SetContributorInsightsRuleList sets the ContributorInsightsRuleList field's value.

func (*DescribeContributorInsightsOutput) SetContributorInsightsStatus added in v1.25.43 

func (s *DescribeContributorInsightsOutput) SetContributorInsightsStatus(v string) *DescribeContributorInsightsOutput

SetContributorInsightsStatus sets the ContributorInsightsStatus field's value.

func (*DescribeContributorInsightsOutput) SetFailureException added in v1.25.43 

func (s *DescribeContributorInsightsOutput) SetFailureException(v *FailureException) *DescribeContributorInsightsOutput

SetFailureException sets the FailureException field's value.

func (*DescribeContributorInsightsOutput) SetIndexName added in v1.25.43 

func (s *DescribeContributorInsightsOutput) SetIndexName(v string) *DescribeContributorInsightsOutput

SetIndexName sets the IndexName field's value.

func (*DescribeContributorInsightsOutput) SetLastUpdateDateTime added in v1.25.43 

func (s *DescribeContributorInsightsOutput) SetLastUpdateDateTime(v time.Time) *DescribeContributorInsightsOutput

SetLastUpdateDateTime sets the LastUpdateDateTime field's value.

func (*DescribeContributorInsightsOutput) SetTableName added in v1.25.43 

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

SetTableName sets the TableName field's value.

func (DescribeContributorInsightsOutput) String added in v1.25.43 

func (s DescribeContributorInsightsOutput) 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 DescribeEndpointsInput added in v1.15.28 

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

func (DescribeEndpointsInput) GoString added in v1.15.28 

func (s DescribeEndpointsInput) 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 (DescribeEndpointsInput) String added in v1.15.28 

func (s DescribeEndpointsInput) 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 DescribeEndpointsOutput added in v1.15.28 

type DescribeEndpointsOutput struct {

	// List of endpoints.
	//
	// Endpoints is a required field
	Endpoints []*Endpoint `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeEndpointsOutput) GoString added in v1.15.28 

func (s DescribeEndpointsOutput) 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 (*DescribeEndpointsOutput) SetEndpoints added in v1.15.28 

func (s *DescribeEndpointsOutput) SetEndpoints(v []*Endpoint) *DescribeEndpointsOutput

SetEndpoints sets the Endpoints field's value.

func (DescribeEndpointsOutput) String added in v1.15.28 

func (s DescribeEndpointsOutput) 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 DescribeExportInput added in v1.35.24 

type DescribeExportInput struct {

	// The Amazon Resource Name (ARN) associated with the export.
	//
	// ExportArn is a required field
	ExportArn *string `min:"37" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeExportInput) GoString added in v1.35.24 

func (s DescribeExportInput) 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 (*DescribeExportInput) SetExportArn added in v1.35.24 

func (s *DescribeExportInput) SetExportArn(v string) *DescribeExportInput

SetExportArn sets the ExportArn field's value.

func (DescribeExportInput) String added in v1.35.24 

func (s DescribeExportInput) 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 (*DescribeExportInput) Validate added in v1.35.24 

func (s *DescribeExportInput) Validate() error

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

type DescribeExportOutput added in v1.35.24 

type DescribeExportOutput struct {

	// Represents the properties of the export.
	ExportDescription *ExportDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeExportOutput) GoString added in v1.35.24 

func (s DescribeExportOutput) 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 (*DescribeExportOutput) SetExportDescription added in v1.35.24 

func (s *DescribeExportOutput) SetExportDescription(v *ExportDescription) *DescribeExportOutput

SetExportDescription sets the ExportDescription field's value.

func (DescribeExportOutput) String added in v1.35.24 

func (s DescribeExportOutput) 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 DescribeGlobalTableInput added in v1.12.36 

type DescribeGlobalTableInput struct {

	// The name of the global table.
	//
	// GlobalTableName is a required field
	GlobalTableName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeGlobalTableInput) GoString added in v1.12.36 

func (s DescribeGlobalTableInput) 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 (*DescribeGlobalTableInput) SetGlobalTableName added in v1.12.36 

func (s *DescribeGlobalTableInput) SetGlobalTableName(v string) *DescribeGlobalTableInput

SetGlobalTableName sets the GlobalTableName field's value.

func (DescribeGlobalTableInput) String added in v1.12.36 

func (s DescribeGlobalTableInput) 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 (*DescribeGlobalTableInput) Validate added in v1.12.36 

func (s *DescribeGlobalTableInput) Validate() error

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

type DescribeGlobalTableOutput added in v1.12.36 

type DescribeGlobalTableOutput struct {

	// Contains the details of the global table.
	GlobalTableDescription *GlobalTableDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeGlobalTableOutput) GoString added in v1.12.36 

func (s DescribeGlobalTableOutput) 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 (*DescribeGlobalTableOutput) SetGlobalTableDescription added in v1.12.36 

func (s *DescribeGlobalTableOutput) SetGlobalTableDescription(v *GlobalTableDescription) *DescribeGlobalTableOutput

SetGlobalTableDescription sets the GlobalTableDescription field's value.

func (DescribeGlobalTableOutput) String added in v1.12.36 

func (s DescribeGlobalTableOutput) 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 DescribeGlobalTableSettingsInput added in v1.13.39 

type DescribeGlobalTableSettingsInput struct {

	// The name of the global table to describe.
	//
	// GlobalTableName is a required field
	GlobalTableName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeGlobalTableSettingsInput) GoString added in v1.13.39 

func (s DescribeGlobalTableSettingsInput) 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 (*DescribeGlobalTableSettingsInput) SetGlobalTableName added in v1.13.39 

func (s *DescribeGlobalTableSettingsInput) SetGlobalTableName(v string) *DescribeGlobalTableSettingsInput

SetGlobalTableName sets the GlobalTableName field's value.

func (DescribeGlobalTableSettingsInput) String added in v1.13.39 

func (s DescribeGlobalTableSettingsInput) 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 (*DescribeGlobalTableSettingsInput) Validate added in v1.13.39 

func (s *DescribeGlobalTableSettingsInput) Validate() error

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

type DescribeGlobalTableSettingsOutput added in v1.13.39 

type DescribeGlobalTableSettingsOutput struct {

	// The name of the global table.
	GlobalTableName *string `min:"3" type:"string"`

	// The Region-specific settings for the global table.
	ReplicaSettings []*ReplicaSettingsDescription `type:"list"`
	// contains filtered or unexported fields
}

func (DescribeGlobalTableSettingsOutput) GoString added in v1.13.39 

func (s DescribeGlobalTableSettingsOutput) 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 (*DescribeGlobalTableSettingsOutput) SetGlobalTableName added in v1.13.39 

func (s *DescribeGlobalTableSettingsOutput) SetGlobalTableName(v string) *DescribeGlobalTableSettingsOutput

SetGlobalTableName sets the GlobalTableName field's value.

func (*DescribeGlobalTableSettingsOutput) SetReplicaSettings added in v1.13.39 

func (s *DescribeGlobalTableSettingsOutput) SetReplicaSettings(v []*ReplicaSettingsDescription) *DescribeGlobalTableSettingsOutput

SetReplicaSettings sets the ReplicaSettings field's value.

func (DescribeGlobalTableSettingsOutput) String added in v1.13.39 

func (s DescribeGlobalTableSettingsOutput) 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 DescribeKinesisStreamingDestinationInput added in v1.35.34 

type DescribeKinesisStreamingDestinationInput struct {

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

func (DescribeKinesisStreamingDestinationInput) GoString added in v1.35.34 

func (s DescribeKinesisStreamingDestinationInput) 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 (*DescribeKinesisStreamingDestinationInput) SetTableName added in v1.35.34 

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

SetTableName sets the TableName field's value.

func (DescribeKinesisStreamingDestinationInput) String added in v1.35.34 

func (s DescribeKinesisStreamingDestinationInput) 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 (*DescribeKinesisStreamingDestinationInput) Validate added in v1.35.34 

func (s *DescribeKinesisStreamingDestinationInput) Validate() error

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

type DescribeKinesisStreamingDestinationOutput added in v1.35.34 

type DescribeKinesisStreamingDestinationOutput struct {

	// The list of replica structures for the table being described.
	KinesisDataStreamDestinations []*KinesisDataStreamDestination `type:"list"`

	// The name of the table being described.
	TableName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeKinesisStreamingDestinationOutput) GoString added in v1.35.34 

func (s DescribeKinesisStreamingDestinationOutput) 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 (*DescribeKinesisStreamingDestinationOutput) SetKinesisDataStreamDestinations added in v1.35.34 

func (s *DescribeKinesisStreamingDestinationOutput) SetKinesisDataStreamDestinations(v []*KinesisDataStreamDestination) *DescribeKinesisStreamingDestinationOutput

SetKinesisDataStreamDestinations sets the KinesisDataStreamDestinations field's value.

func (*DescribeKinesisStreamingDestinationOutput) SetTableName added in v1.35.34 

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

SetTableName sets the TableName field's value.

func (DescribeKinesisStreamingDestinationOutput) String added in v1.35.34 

func (s DescribeKinesisStreamingDestinationOutput) 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 DescribeLimitsInput added in v1.1.7 

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

Represents the input of a DescribeLimits operation. Has no content.

func (DescribeLimitsInput) GoString added in v1.1.7 

func (s DescribeLimitsInput) 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 (DescribeLimitsInput) String added in v1.1.7 

func (s DescribeLimitsInput) 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 DescribeLimitsOutput added in v1.1.7 

type DescribeLimitsOutput struct {

	// The maximum total read capacity units that your account allows you to provision
	// across all of your tables in this Region.
	AccountMaxReadCapacityUnits *int64 `min:"1" type:"long"`

	// The maximum total write capacity units that your account allows you to provision
	// across all of your tables in this Region.
	AccountMaxWriteCapacityUnits *int64 `min:"1" type:"long"`

	// The maximum read capacity units that your account allows you to provision
	// for a new table that you are creating in this Region, including the read
	// capacity units provisioned for its global secondary indexes (GSIs).
	TableMaxReadCapacityUnits *int64 `min:"1" type:"long"`

	// The maximum write capacity units that your account allows you to provision
	// for a new table that you are creating in this Region, including the write
	// capacity units provisioned for its global secondary indexes (GSIs).
	TableMaxWriteCapacityUnits *int64 `min:"1" type:"long"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeLimits operation.

func (DescribeLimitsOutput) GoString added in v1.1.7 

func (s DescribeLimitsOutput) 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 (*DescribeLimitsOutput) SetAccountMaxReadCapacityUnits added in v1.5.0 

func (s *DescribeLimitsOutput) SetAccountMaxReadCapacityUnits(v int64) *DescribeLimitsOutput

SetAccountMaxReadCapacityUnits sets the AccountMaxReadCapacityUnits field's value.

func (*DescribeLimitsOutput) SetAccountMaxWriteCapacityUnits added in v1.5.0 

func (s *DescribeLimitsOutput) SetAccountMaxWriteCapacityUnits(v int64) *DescribeLimitsOutput

SetAccountMaxWriteCapacityUnits sets the AccountMaxWriteCapacityUnits field's value.

func (*DescribeLimitsOutput) SetTableMaxReadCapacityUnits added in v1.5.0 

func (s *DescribeLimitsOutput) SetTableMaxReadCapacityUnits(v int64) *DescribeLimitsOutput

SetTableMaxReadCapacityUnits sets the TableMaxReadCapacityUnits field's value.

func (*DescribeLimitsOutput) SetTableMaxWriteCapacityUnits added in v1.5.0 

func (s *DescribeLimitsOutput) SetTableMaxWriteCapacityUnits(v int64) *DescribeLimitsOutput

SetTableMaxWriteCapacityUnits sets the TableMaxWriteCapacityUnits field's value.

func (DescribeLimitsOutput) String added in v1.1.7 

func (s DescribeLimitsOutput) 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 DescribeTableInput 

type DescribeTableInput struct {

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

Represents the input of a DescribeTable operation.

func (DescribeTableInput) GoString added in v0.6.5 

func (s DescribeTableInput) 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 (*DescribeTableInput) SetTableName added in v1.5.0 

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

SetTableName sets the TableName field's value.

func (DescribeTableInput) String added in v0.6.5 

func (s DescribeTableInput) 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 (*DescribeTableInput) Validate added in v1.1.21 

func (s *DescribeTableInput) Validate() error

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

type DescribeTableOutput 

type DescribeTableOutput struct {

	// The properties of the table.
	Table *TableDescription `type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a DescribeTable operation.

func (DescribeTableOutput) GoString added in v0.6.5 

func (s DescribeTableOutput) 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 (*DescribeTableOutput) SetTable added in v1.5.0 

func (s *DescribeTableOutput) SetTable(v *TableDescription) *DescribeTableOutput

SetTable sets the Table field's value.

func (DescribeTableOutput) String added in v0.6.5 

func (s DescribeTableOutput) 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 DescribeTableReplicaAutoScalingInput added in v1.25.40 

type DescribeTableReplicaAutoScalingInput struct {

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

func (DescribeTableReplicaAutoScalingInput) GoString added in v1.25.40 

func (s DescribeTableReplicaAutoScalingInput) 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 (*DescribeTableReplicaAutoScalingInput) SetTableName added in v1.25.40 

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

SetTableName sets the TableName field's value.

func (DescribeTableReplicaAutoScalingInput) String added in v1.25.40 

func (s DescribeTableReplicaAutoScalingInput) 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 (*DescribeTableReplicaAutoScalingInput) Validate added in v1.25.40 

func (s *DescribeTableReplicaAutoScalingInput) Validate() error

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

type DescribeTableReplicaAutoScalingOutput added in v1.25.40 

type DescribeTableReplicaAutoScalingOutput struct {

	// Represents the auto scaling properties of the table.
	TableAutoScalingDescription *TableAutoScalingDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeTableReplicaAutoScalingOutput) GoString added in v1.25.40 

func (s DescribeTableReplicaAutoScalingOutput) 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 (*DescribeTableReplicaAutoScalingOutput) SetTableAutoScalingDescription added in v1.25.40 

func (s *DescribeTableReplicaAutoScalingOutput) SetTableAutoScalingDescription(v *TableAutoScalingDescription) *DescribeTableReplicaAutoScalingOutput

SetTableAutoScalingDescription sets the TableAutoScalingDescription field's value.

func (DescribeTableReplicaAutoScalingOutput) String added in v1.25.40 

func (s DescribeTableReplicaAutoScalingOutput) 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 DescribeTimeToLiveInput added in v1.7.2 

type DescribeTimeToLiveInput struct {

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

func (DescribeTimeToLiveInput) GoString added in v1.7.2 

func (s DescribeTimeToLiveInput) 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 (*DescribeTimeToLiveInput) SetTableName added in v1.7.2 

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

SetTableName sets the TableName field's value.

func (DescribeTimeToLiveInput) String added in v1.7.2 

func (s DescribeTimeToLiveInput) 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 (*DescribeTimeToLiveInput) Validate added in v1.7.2 

func (s *DescribeTimeToLiveInput) Validate() error

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

type DescribeTimeToLiveOutput added in v1.7.2 

type DescribeTimeToLiveOutput struct {

	// The description of the Time to Live (TTL) status on the specified table.
	TimeToLiveDescription *TimeToLiveDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeTimeToLiveOutput) GoString added in v1.7.2 

func (s DescribeTimeToLiveOutput) 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 (*DescribeTimeToLiveOutput) SetTimeToLiveDescription added in v1.7.2 

func (s *DescribeTimeToLiveOutput) SetTimeToLiveDescription(v *TimeToLiveDescription) *DescribeTimeToLiveOutput

SetTimeToLiveDescription sets the TimeToLiveDescription field's value.

func (DescribeTimeToLiveOutput) String added in v1.7.2 

func (s DescribeTimeToLiveOutput) 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 DisableKinesisStreamingDestinationInput added in v1.35.34 

type DisableKinesisStreamingDestinationInput struct {

	// The ARN for a Kinesis data stream.
	//
	// StreamArn is a required field
	StreamArn *string `min:"37" type:"string" required:"true"`

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

func (DisableKinesisStreamingDestinationInput) GoString added in v1.35.34 

func (s DisableKinesisStreamingDestinationInput) 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 (*DisableKinesisStreamingDestinationInput) SetStreamArn added in v1.35.34 

func (s *DisableKinesisStreamingDestinationInput) SetStreamArn(v string) *DisableKinesisStreamingDestinationInput

SetStreamArn sets the StreamArn field's value.

func (*DisableKinesisStreamingDestinationInput) SetTableName added in v1.35.34 

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

SetTableName sets the TableName field's value.

func (DisableKinesisStreamingDestinationInput) String added in v1.35.34 

func (s DisableKinesisStreamingDestinationInput) 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 (*DisableKinesisStreamingDestinationInput) Validate added in v1.35.34 

func (s *DisableKinesisStreamingDestinationInput) Validate() error

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

type DisableKinesisStreamingDestinationOutput added in v1.35.34 

type DisableKinesisStreamingDestinationOutput struct {

	// The current status of the replication.
	DestinationStatus *string `type:"string" enum:"DestinationStatus"`

	// The ARN for the specific Kinesis data stream.
	StreamArn *string `min:"37" type:"string"`

	// The name of the table being modified.
	TableName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

func (DisableKinesisStreamingDestinationOutput) GoString added in v1.35.34 

func (s DisableKinesisStreamingDestinationOutput) 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 (*DisableKinesisStreamingDestinationOutput) SetDestinationStatus added in v1.35.34 

func (s *DisableKinesisStreamingDestinationOutput) SetDestinationStatus(v string) *DisableKinesisStreamingDestinationOutput

SetDestinationStatus sets the DestinationStatus field's value.

func (*DisableKinesisStreamingDestinationOutput) SetStreamArn added in v1.35.34 

func (s *DisableKinesisStreamingDestinationOutput) SetStreamArn(v string) *DisableKinesisStreamingDestinationOutput

SetStreamArn sets the StreamArn field's value.

func (*DisableKinesisStreamingDestinationOutput) SetTableName added in v1.35.34 

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

SetTableName sets the TableName field's value.

func (DisableKinesisStreamingDestinationOutput) String added in v1.35.34 

func (s DisableKinesisStreamingDestinationOutput) 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 DuplicateItemException added in v1.35.34 

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

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

There was an attempt to insert an item with the same primary key as an item that already exists in the DynamoDB table.

func (*DuplicateItemException) Code added in v1.35.34 

func (s *DuplicateItemException) Code() string

Code returns the exception type name.

func (*DuplicateItemException) Error added in v1.35.34 

func (s *DuplicateItemException) Error() string

func (DuplicateItemException) GoString added in v1.35.34 

func (s DuplicateItemException) 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 (*DuplicateItemException) Message added in v1.35.34 

func (s *DuplicateItemException) Message() string

Message returns the exception's message.

func (*DuplicateItemException) OrigErr added in v1.35.34 

func (s *DuplicateItemException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DuplicateItemException) RequestID added in v1.35.34 

func (s *DuplicateItemException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DuplicateItemException) StatusCode added in v1.35.34 

func (s *DuplicateItemException) StatusCode() int

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

func (DuplicateItemException) String added in v1.35.34 

func (s DuplicateItemException) 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 DynamoDB 

type DynamoDB struct {
	*client.Client
	// contains filtered or unexported fields
}

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

DynamoDB 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) *DynamoDB

New creates a new instance of the DynamoDB 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 DynamoDB client from just a session.
svc := dynamodb.New(mySession)

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

func (*DynamoDB) BatchExecuteStatement added in v1.35.34 

func (c *DynamoDB) BatchExecuteStatement(input *BatchExecuteStatementInput) (*BatchExecuteStatementOutput, error)

BatchExecuteStatement API operation for Amazon DynamoDB.

This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item.

The entire batch must consist of either read statements or write statements, you cannot mix both in one batch.

A HTTP 200 response does not mean that all statements in the BatchExecuteStatement succeeded. Error details for individual statements can be found under the Error (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchStatementResponse.html#DDB-Type-BatchStatementResponse-Error) field of the BatchStatementResponse for each statement.

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 DynamoDB's API operation BatchExecuteStatement for usage and error information.

Returned Error Types:

  • RequestLimitExceeded Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support (https://aws.amazon.com/support) to request a quota increase.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BatchExecuteStatement

func (*DynamoDB) BatchExecuteStatementRequest added in v1.35.34 

func (c *DynamoDB) BatchExecuteStatementRequest(input *BatchExecuteStatementInput) (req *request.Request, output *BatchExecuteStatementOutput)

BatchExecuteStatementRequest generates a "aws/request.Request" representing the client's request for the BatchExecuteStatement 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 BatchExecuteStatement for more information on using the BatchExecuteStatement 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 BatchExecuteStatementRequest method.
req, resp := client.BatchExecuteStatementRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BatchExecuteStatement

func (*DynamoDB) BatchExecuteStatementWithContext added in v1.35.34 

func (c *DynamoDB) BatchExecuteStatementWithContext(ctx aws.Context, input *BatchExecuteStatementInput, opts ...request.Option) (*BatchExecuteStatementOutput, error)

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

See BatchExecuteStatement 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 (*DynamoDB) BatchGetItem 

func (c *DynamoDB) BatchGetItem(input *BatchGetItemInput) (*BatchGetItemOutput, error)

BatchGetItem API operation for Amazon DynamoDB.

The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.

A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem returns a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get.

If you request more than 100 items, BatchGetItem returns a ValidationException with the message "Too many items requested for the BatchGetItem call."

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem returns a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see Batch Operations and Error Handling (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations) in the Amazon DynamoDB Developer Guide.

By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.

In order to minimize response latency, BatchGetItem retrieves items in parallel.

When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the ProjectionExpression parameter.

If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Working with Tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations) in the Amazon DynamoDB 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 DynamoDB's API operation BatchGetItem for usage and error information.

Returned Error Types:

  • ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the Amazon DynamoDB Developer Guide.

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

  • RequestLimitExceeded Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support (https://aws.amazon.com/support) to request a quota increase.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BatchGetItem

Example (Shared00)

To retrieve multiple items from a table

This example reads multiple items from the Music table using a batch of three GetItem requests. Only the AlbumTitle attribute is returned. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
	svc := dynamodb.New(session.New())
	input := &dynamodb.BatchGetItemInput{
		RequestItems: map[string]*dynamodb.KeysAndAttributes{
			"Music": {
				Keys: []map[string]*dynamodb.AttributeValue{
					{
						"Artist": &dynamodb.AttributeValue{
							S: aws.String("No One You Know"),
						},
						"SongTitle": &dynamodb.AttributeValue{
							S: aws.String("Call Me Today"),
						},
					},
					{
						"Artist": &dynamodb.AttributeValue{
							S: aws.String("Acme Band"),
						},
						"SongTitle": &dynamodb.AttributeValue{
							S: aws.String("Happy Day"),
						},
					},
					{
						"Artist": &dynamodb.AttributeValue{
							S: aws.String("No One You Know"),
						},
						"SongTitle": &dynamodb.AttributeValue{
							S: aws.String("Scared of My Shadow"),
						},
					},
				},
				ProjectionExpression: aws.String("AlbumTitle"),
			},
		},
	}

	result, err := svc.BatchGetItem(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodb.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case dynamodb.ErrCodeResourceNotFoundException:
				fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
			case dynamodb.ErrCodeRequestLimitExceeded:
				fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
			case dynamodb.ErrCodeInternalServerError:
				fmt.Println(dynamodb.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDB) BatchGetItemPages 

func (c *DynamoDB) BatchGetItemPages(input *BatchGetItemInput, fn func(*BatchGetItemOutput, bool) bool) error

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

See BatchGetItem 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 BatchGetItem operation.
pageNum := 0
err := client.BatchGetItemPages(params,
    func(page *dynamodb.BatchGetItemOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DynamoDB) BatchGetItemPagesWithContext added in v1.8.0 

func (c *DynamoDB) BatchGetItemPagesWithContext(ctx aws.Context, input *BatchGetItemInput, fn func(*BatchGetItemOutput, bool) bool, opts ...request.Option) error

BatchGetItemPagesWithContext same as BatchGetItemPages 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 (*DynamoDB) BatchGetItemRequest 

func (c *DynamoDB) BatchGetItemRequest(input *BatchGetItemInput) (req *request.Request, output *BatchGetItemOutput)

BatchGetItemRequest generates a "aws/request.Request" representing the client's request for the BatchGetItem 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 BatchGetItem for more information on using the BatchGetItem 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 BatchGetItemRequest method.
req, resp := client.BatchGetItemRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BatchGetItem

func (*DynamoDB) BatchGetItemWithContext added in v1.8.0 

func (c *DynamoDB) BatchGetItemWithContext(ctx aws.Context, input *BatchGetItemInput, opts ...request.Option) (*BatchGetItemOutput, error)

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

See BatchGetItem 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 (*DynamoDB) BatchWriteItem 

func (c *DynamoDB) BatchWriteItem(input *BatchWriteItemInput) (*BatchWriteItemOutput, error)

BatchWriteItem API operation for Amazon DynamoDB.

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html).

BatchWriteItem cannot update items. To update items, use the UpdateItem action.

The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see Batch Operations and Error Handling (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#Programming.Errors.BatchOperations) in the Amazon DynamoDB Developer Guide.

With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.

If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.

Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.

If one or more of the following is true, DynamoDB rejects the entire batch write operation:

  • One or more tables specified in the BatchWriteItem request does not exist.

  • Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.

  • You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.

  • Your request contains at least two items with identical hash and range keys (which essentially is two put operations).

  • There are more than 25 requests in the batch.

  • Any individual item in a batch exceeds 400 KB.

  • The total request size exceeds 16 MB.

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 DynamoDB's API operation BatchWriteItem for usage and error information.

Returned Error Types:

  • ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the Amazon DynamoDB Developer Guide.

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

  • ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

  • RequestLimitExceeded Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support (https://aws.amazon.com/support) to request a quota increase.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BatchWriteItem

Example (Shared00)

To add multiple items to a table

This example adds three new items to the Music table using a batch of three PutItem requests. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
	svc := dynamodb.New(session.New())
	input := &dynamodb.BatchWriteItemInput{
		RequestItems: map[string][]*dynamodb.WriteRequest{
			"Music": {
				{
					PutRequest: &dynamodb.PutRequest{
						Item: map[string]*dynamodb.AttributeValue{
							"AlbumTitle": {
								S: aws.String("Somewhat Famous"),
							},
							"Artist": {
								S: aws.String("No One You Know"),
							},
							"SongTitle": {
								S: aws.String("Call Me Today"),
							},
						},
					},
				},
				{
					PutRequest: &dynamodb.PutRequest{
						Item: map[string]*dynamodb.AttributeValue{
							"AlbumTitle": {
								S: aws.String("Songs About Life"),
							},
							"Artist": {
								S: aws.String("Acme Band"),
							},
							"SongTitle": {
								S: aws.String("Happy Day"),
							},
						},
					},
				},
				{
					PutRequest: &dynamodb.PutRequest{
						Item: map[string]*dynamodb.AttributeValue{
							"AlbumTitle": {
								S: aws.String("Blue Sky Blues"),
							},
							"Artist": {
								S: aws.String("No One You Know"),
							},
							"SongTitle": {
								S: aws.String("Scared of My Shadow"),
							},
						},
					},
				},
			},
		},
	}

	result, err := svc.BatchWriteItem(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodb.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case dynamodb.ErrCodeResourceNotFoundException:
				fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
			case dynamodb.ErrCodeItemCollectionSizeLimitExceededException:
				fmt.Println(dynamodb.ErrCodeItemCollectionSizeLimitExceededException, aerr.Error())
			case dynamodb.ErrCodeRequestLimitExceeded:
				fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
			case dynamodb.ErrCodeInternalServerError:
				fmt.Println(dynamodb.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDB) BatchWriteItemRequest 

func (c *DynamoDB) BatchWriteItemRequest(input *BatchWriteItemInput) (req *request.Request, output *BatchWriteItemOutput)

BatchWriteItemRequest generates a "aws/request.Request" representing the client's request for the BatchWriteItem 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 BatchWriteItem for more information on using the BatchWriteItem 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 BatchWriteItemRequest method.
req, resp := client.BatchWriteItemRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/BatchWriteItem

func (*DynamoDB) BatchWriteItemWithContext added in v1.8.0 

func (c *DynamoDB) BatchWriteItemWithContext(ctx aws.Context, input *BatchWriteItemInput, opts ...request.Option) (*BatchWriteItemOutput, error)

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

See BatchWriteItem 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 (*DynamoDB) CreateBackup added in v1.12.36 

func (c *DynamoDB) CreateBackup(input *CreateBackupInput) (*CreateBackupOutput, error)

CreateBackup API operation for Amazon DynamoDB.

Creates a backup for an existing table.

Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.

When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.

You can call CreateBackup at a maximum rate of 50 times per second.

All backups in DynamoDB work without consuming any provisioned throughput on the table.

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.

Along with data, the following are also included on the backups:

  • Global secondary indexes (GSIs)

  • Local secondary indexes (LSIs)

  • Streams

  • Provisioned read and write capacity

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 DynamoDB's API operation CreateBackup for usage and error information.

Returned Error Types:

  • TableNotFoundException A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

  • TableInUseException A target table with the specified name is either being created or deleted.

  • ContinuousBackupsUnavailableException Backups have not yet been enabled for this table.

  • BackupInUseException There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateBackup

func (*DynamoDB) CreateBackupRequest added in v1.12.36 

func (c *DynamoDB) CreateBackupRequest(input *CreateBackupInput) (req *request.Request, output *CreateBackupOutput)

CreateBackupRequest generates a "aws/request.Request" representing the client's request for the CreateBackup 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 CreateBackup for more information on using the CreateBackup 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 CreateBackupRequest method.
req, resp := client.CreateBackupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateBackup

func (*DynamoDB) CreateBackupWithContext added in v1.12.36 

func (c *DynamoDB) CreateBackupWithContext(ctx aws.Context, input *CreateBackupInput, opts ...request.Option) (*CreateBackupOutput, error)

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

See CreateBackup 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 (*DynamoDB) CreateGlobalTable added in v1.12.36 

func (c *DynamoDB) CreateGlobalTable(input *CreateGlobalTableInput) (*CreateGlobalTableOutput, error)

CreateGlobalTable API operation for Amazon DynamoDB.

Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.

This operation only applies to Version 2017.11.29 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables.

If you want to add a new replica table to a global table, each of the following conditions must be true:

  • The table must have the same primary key as all of the other replicas.

  • The table must have the same name as all of the other replicas.

  • The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.

  • None of the replica tables in the global table can contain any data.

If global secondary indexes are specified, then the following conditions must also be met:

  • The global secondary indexes must have the same name.

  • The global secondary indexes must have the same hash key and sort key (if present).

If local secondary indexes are specified, then the following conditions must also be met:

  • The local secondary indexes must have the same name.

  • The local secondary indexes must have the same hash key and sort key (if present).

Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.

If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global 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 DynamoDB's API operation CreateGlobalTable for usage and error information.

Returned Error Types:

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • InternalServerError An error occurred on the server side.

  • GlobalTableAlreadyExistsException The specified global table already exists.

  • TableNotFoundException A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateGlobalTable

func (*DynamoDB) CreateGlobalTableRequest added in v1.12.36 

func (c *DynamoDB) CreateGlobalTableRequest(input *CreateGlobalTableInput) (req *request.Request, output *CreateGlobalTableOutput)

CreateGlobalTableRequest generates a "aws/request.Request" representing the client's request for the CreateGlobalTable 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 CreateGlobalTable for more information on using the CreateGlobalTable 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 CreateGlobalTableRequest method.
req, resp := client.CreateGlobalTableRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateGlobalTable

func (*DynamoDB) CreateGlobalTableWithContext added in v1.12.36 

func (c *DynamoDB) CreateGlobalTableWithContext(ctx aws.Context, input *CreateGlobalTableInput, opts ...request.Option) (*CreateGlobalTableOutput, error)

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

See CreateGlobalTable 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 (*DynamoDB) CreateTable 

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

CreateTable API operation for Amazon DynamoDB.

The CreateTable operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can have two tables with same name if you create the tables in different Regions.

CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.

You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.

You can use the DescribeTable action to check the table status.

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 DynamoDB's API operation CreateTable for usage and error information.

Returned Error Types:

  • ResourceInUseException The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateTable

Example (Shared00)

To create a table

This example creates a table named Music. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
	svc := dynamodb.New(session.New())
	input := &dynamodb.CreateTableInput{
		AttributeDefinitions: []*dynamodb.AttributeDefinition{
			{
				AttributeName: aws.String("Artist"),
				AttributeType: aws.String("S"),
			},
			{
				AttributeName: aws.String("SongTitle"),
				AttributeType: aws.String("S"),
			},
		},
		KeySchema: []*dynamodb.KeySchemaElement{
			{
				AttributeName: aws.String("Artist"),
				KeyType:       aws.String("HASH"),
			},
			{
				AttributeName: aws.String("SongTitle"),
				KeyType:       aws.String("RANGE"),
			},
		},
		ProvisionedThroughput: &dynamodb.ProvisionedThroughput{
			ReadCapacityUnits:  aws.Int64(5),
			WriteCapacityUnits: aws.Int64(5),
		},
		TableName: aws.String("Music"),
	}

	result, err := svc.CreateTable(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodb.ErrCodeResourceInUseException:
				fmt.Println(dynamodb.ErrCodeResourceInUseException, aerr.Error())
			case dynamodb.ErrCodeLimitExceededException:
				fmt.Println(dynamodb.ErrCodeLimitExceededException, aerr.Error())
			case dynamodb.ErrCodeInternalServerError:
				fmt.Println(dynamodb.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDB) CreateTableRequest 

func (c *DynamoDB) 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/dynamodb-2012-08-10/CreateTable

func (*DynamoDB) CreateTableWithContext added in v1.8.0 

func (c *DynamoDB) 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 (*DynamoDB) DeleteBackup added in v1.12.36 

func (c *DynamoDB) DeleteBackup(input *DeleteBackupInput) (*DeleteBackupOutput, error)

DeleteBackup API operation for Amazon DynamoDB.

Deletes an existing backup of a table.

You can call DeleteBackup at a maximum rate of 10 times per second.

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 DynamoDB's API operation DeleteBackup for usage and error information.

Returned Error Types:

  • BackupNotFoundException Backup not found for the given BackupARN.

  • BackupInUseException There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteBackup

func (*DynamoDB) DeleteBackupRequest added in v1.12.36 

func (c *DynamoDB) DeleteBackupRequest(input *DeleteBackupInput) (req *request.Request, output *DeleteBackupOutput)

DeleteBackupRequest generates a "aws/request.Request" representing the client's request for the DeleteBackup 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 DeleteBackup for more information on using the DeleteBackup 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 DeleteBackupRequest method.
req, resp := client.DeleteBackupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteBackup

func (*DynamoDB) DeleteBackupWithContext added in v1.12.36 

func (c *DynamoDB) DeleteBackupWithContext(ctx aws.Context, input *DeleteBackupInput, opts ...request.Option) (*DeleteBackupOutput, error)

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

See DeleteBackup 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 (*DynamoDB) DeleteItem 

func (c *DynamoDB) DeleteItem(input *DeleteItemInput) (*DeleteItemOutput, error)

DeleteItem API operation for Amazon DynamoDB.

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

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 DynamoDB's API operation DeleteItem for usage and error information.

Returned Error Types:

  • ConditionalCheckFailedException A condition specified in the operation could not be evaluated.

  • ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the Amazon DynamoDB Developer Guide.

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

  • ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

  • TransactionConflictException Operation was rejected because there is an ongoing transaction for the item.

  • RequestLimitExceeded Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support (https://aws.amazon.com/support) to request a quota increase.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteItem

Example (Shared00)

To delete an item

This example deletes an item from the Music table. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
	svc := dynamodb.New(session.New())
	input := &dynamodb.DeleteItemInput{
		Key: map[string]*dynamodb.AttributeValue{
			"Artist": {
				S: aws.String("No One You Know"),
			},
			"SongTitle": {
				S: aws.String("Scared of My Shadow"),
			},
		},
		TableName: aws.String("Music"),
	}

	result, err := svc.DeleteItem(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodb.ErrCodeConditionalCheckFailedException:
				fmt.Println(dynamodb.ErrCodeConditionalCheckFailedException, aerr.Error())
			case dynamodb.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case dynamodb.ErrCodeResourceNotFoundException:
				fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
			case dynamodb.ErrCodeItemCollectionSizeLimitExceededException:
				fmt.Println(dynamodb.ErrCodeItemCollectionSizeLimitExceededException, aerr.Error())
			case dynamodb.ErrCodeTransactionConflictException:
				fmt.Println(dynamodb.ErrCodeTransactionConflictException, aerr.Error())
			case dynamodb.ErrCodeRequestLimitExceeded:
				fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
			case dynamodb.ErrCodeInternalServerError:
				fmt.Println(dynamodb.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDB) DeleteItemRequest 

func (c *DynamoDB) DeleteItemRequest(input *DeleteItemInput) (req *request.Request, output *DeleteItemOutput)

DeleteItemRequest generates a "aws/request.Request" representing the client's request for the DeleteItem 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 DeleteItem for more information on using the DeleteItem 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 DeleteItemRequest method.
req, resp := client.DeleteItemRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteItem

func (*DynamoDB) DeleteItemWithContext added in v1.8.0 

func (c *DynamoDB) DeleteItemWithContext(ctx aws.Context, input *DeleteItemInput, opts ...request.Option) (*DeleteItemOutput, error)

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

See DeleteItem 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 (*DynamoDB) DeleteTable 

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

DeleteTable API operation for Amazon DynamoDB.

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

DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.

When you delete a table, any indexes on that table are also deleted.

If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.

Use the DescribeTable action to check the status of the 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 DynamoDB's API operation DeleteTable for usage and error information.

Returned Error Types:

  • ResourceInUseException The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

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

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteTable

Example (Shared00)

To delete a table

This example deletes the Music table. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
	svc := dynamodb.New(session.New())
	input := &dynamodb.DeleteTableInput{
		TableName: aws.String("Music"),
	}

	result, err := svc.DeleteTable(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodb.ErrCodeResourceInUseException:
				fmt.Println(dynamodb.ErrCodeResourceInUseException, aerr.Error())
			case dynamodb.ErrCodeResourceNotFoundException:
				fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
			case dynamodb.ErrCodeLimitExceededException:
				fmt.Println(dynamodb.ErrCodeLimitExceededException, aerr.Error())
			case dynamodb.ErrCodeInternalServerError:
				fmt.Println(dynamodb.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDB) DeleteTableRequest 

func (c *DynamoDB) 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/dynamodb-2012-08-10/DeleteTable

func (*DynamoDB) DeleteTableWithContext added in v1.8.0 

func (c *DynamoDB) 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 (*DynamoDB) DescribeBackup added in v1.12.36 

func (c *DynamoDB) DescribeBackup(input *DescribeBackupInput) (*DescribeBackupOutput, error)

DescribeBackup API operation for Amazon DynamoDB.

Describes an existing backup of a table.

You can call DescribeBackup at a maximum rate of 10 times per second.

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 DynamoDB's API operation DescribeBackup for usage and error information.

Returned Error Types:

  • BackupNotFoundException Backup not found for the given BackupARN.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeBackup

func (*DynamoDB) DescribeBackupRequest added in v1.12.36 

func (c *DynamoDB) DescribeBackupRequest(input *DescribeBackupInput) (req *request.Request, output *DescribeBackupOutput)

DescribeBackupRequest generates a "aws/request.Request" representing the client's request for the DescribeBackup 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 DescribeBackup for more information on using the DescribeBackup 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 DescribeBackupRequest method.
req, resp := client.DescribeBackupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeBackup

func (*DynamoDB) DescribeBackupWithContext added in v1.12.36 

func (c *DynamoDB) DescribeBackupWithContext(ctx aws.Context, input *DescribeBackupInput, opts ...request.Option) (*DescribeBackupOutput, error)

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

See DescribeBackup 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 (*DynamoDB) DescribeContinuousBackups added in v1.12.36 

func (c *DynamoDB) DescribeContinuousBackups(input *DescribeContinuousBackupsInput) (*DescribeContinuousBackupsOutput, error)

DescribeContinuousBackups API operation for Amazon DynamoDB.

Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.

After continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.

LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.

You can call DescribeContinuousBackups at a maximum rate of 10 times per second.

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 DynamoDB's API operation DescribeContinuousBackups for usage and error information.

Returned Error Types:

  • TableNotFoundException A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeContinuousBackups

func (*DynamoDB) DescribeContinuousBackupsRequest added in v1.12.36 

func (c *DynamoDB) DescribeContinuousBackupsRequest(input *DescribeContinuousBackupsInput) (req *request.Request, output *DescribeContinuousBackupsOutput)

DescribeContinuousBackupsRequest generates a "aws/request.Request" representing the client's request for the DescribeContinuousBackups 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 DescribeContinuousBackups for more information on using the DescribeContinuousBackups 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 DescribeContinuousBackupsRequest method.
req, resp := client.DescribeContinuousBackupsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeContinuousBackups

func (*DynamoDB) DescribeContinuousBackupsWithContext added in v1.12.36 

func (c *DynamoDB) DescribeContinuousBackupsWithContext(ctx aws.Context, input *DescribeContinuousBackupsInput, opts ...request.Option) (*DescribeContinuousBackupsOutput, error)

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

See DescribeContinuousBackups 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 (*DynamoDB) DescribeContributorInsights added in v1.25.43 

func (c *DynamoDB) DescribeContributorInsights(input *DescribeContributorInsightsInput) (*DescribeContributorInsightsOutput, error)

DescribeContributorInsights API operation for Amazon DynamoDB.

Returns information about contributor insights, for a given table or global secondary index.

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 DynamoDB's API operation DescribeContributorInsights for usage and error information.

Returned Error Types:

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

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeContributorInsights

func (*DynamoDB) DescribeContributorInsightsRequest added in v1.25.43 

func (c *DynamoDB) DescribeContributorInsightsRequest(input *DescribeContributorInsightsInput) (req *request.Request, output *DescribeContributorInsightsOutput)

DescribeContributorInsightsRequest generates a "aws/request.Request" representing the client's request for the DescribeContributorInsights 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 DescribeContributorInsights for more information on using the DescribeContributorInsights 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 DescribeContributorInsightsRequest method.
req, resp := client.DescribeContributorInsightsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeContributorInsights

func (*DynamoDB) DescribeContributorInsightsWithContext added in v1.25.43 

func (c *DynamoDB) DescribeContributorInsightsWithContext(ctx aws.Context, input *DescribeContributorInsightsInput, opts ...request.Option) (*DescribeContributorInsightsOutput, error)

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

See DescribeContributorInsights 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 (*DynamoDB) DescribeEndpoints added in v1.15.28 

func (c *DynamoDB) DescribeEndpoints(input *DescribeEndpointsInput) (*DescribeEndpointsOutput, error)

DescribeEndpoints API operation for Amazon DynamoDB.

Returns the regional endpoint information.

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 DynamoDB's API operation DescribeEndpoints for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeEndpoints

func (*DynamoDB) DescribeEndpointsRequest added in v1.15.28 

func (c *DynamoDB) DescribeEndpointsRequest(input *DescribeEndpointsInput) (req *request.Request, output *DescribeEndpointsOutput)

DescribeEndpointsRequest generates a "aws/request.Request" representing the client's request for the DescribeEndpoints 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 DescribeEndpoints for more information on using the DescribeEndpoints 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 DescribeEndpointsRequest method.
req, resp := client.DescribeEndpointsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeEndpoints

func (*DynamoDB) DescribeEndpointsWithContext added in v1.15.28 

func (c *DynamoDB) DescribeEndpointsWithContext(ctx aws.Context, input *DescribeEndpointsInput, opts ...request.Option) (*DescribeEndpointsOutput, error)

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

See DescribeEndpoints 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 (*DynamoDB) DescribeExport added in v1.35.24 

func (c *DynamoDB) DescribeExport(input *DescribeExportInput) (*DescribeExportOutput, error)

DescribeExport API operation for Amazon DynamoDB.

Describes an existing table export.

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 DynamoDB's API operation DescribeExport for usage and error information.

Returned Error Types:

  • ExportNotFoundException The specified export was not found.

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeExport

func (*DynamoDB) DescribeExportRequest added in v1.35.24 

func (c *DynamoDB) DescribeExportRequest(input *DescribeExportInput) (req *request.Request, output *DescribeExportOutput)

DescribeExportRequest generates a "aws/request.Request" representing the client's request for the DescribeExport 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 DescribeExport for more information on using the DescribeExport 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 DescribeExportRequest method.
req, resp := client.DescribeExportRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeExport

func (*DynamoDB) DescribeExportWithContext added in v1.35.24 

func (c *DynamoDB) DescribeExportWithContext(ctx aws.Context, input *DescribeExportInput, opts ...request.Option) (*DescribeExportOutput, error)

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

See DescribeExport 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 (*DynamoDB) DescribeGlobalTable added in v1.12.36 

func (c *DynamoDB) DescribeGlobalTable(input *DescribeGlobalTableInput) (*DescribeGlobalTableOutput, error)

DescribeGlobalTable API operation for Amazon DynamoDB.

Returns information about the specified global table.

This operation only applies to Version 2017.11.29 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables. If you are using global tables Version 2019.11.21 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) you can use DescribeTable (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html) instead.

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 DynamoDB's API operation DescribeGlobalTable for usage and error information.

Returned Error Types:

  • InternalServerError An error occurred on the server side.

  • GlobalTableNotFoundException The specified global table does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeGlobalTable

func (*DynamoDB) DescribeGlobalTableRequest added in v1.12.36 

func (c *DynamoDB) DescribeGlobalTableRequest(input *DescribeGlobalTableInput) (req *request.Request, output *DescribeGlobalTableOutput)

DescribeGlobalTableRequest generates a "aws/request.Request" representing the client's request for the DescribeGlobalTable 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 DescribeGlobalTable for more information on using the DescribeGlobalTable 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 DescribeGlobalTableRequest method.
req, resp := client.DescribeGlobalTableRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeGlobalTable

func (*DynamoDB) DescribeGlobalTableSettings added in v1.13.39 

func (c *DynamoDB) DescribeGlobalTableSettings(input *DescribeGlobalTableSettingsInput) (*DescribeGlobalTableSettingsOutput, error)

DescribeGlobalTableSettings API operation for Amazon DynamoDB.

Describes Region-specific settings for a global table.

This operation only applies to Version 2017.11.29 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global 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 DynamoDB's API operation DescribeGlobalTableSettings for usage and error information.

Returned Error Types:

  • GlobalTableNotFoundException The specified global table does not exist.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeGlobalTableSettings

func (*DynamoDB) DescribeGlobalTableSettingsRequest added in v1.13.39 

func (c *DynamoDB) DescribeGlobalTableSettingsRequest(input *DescribeGlobalTableSettingsInput) (req *request.Request, output *DescribeGlobalTableSettingsOutput)

DescribeGlobalTableSettingsRequest generates a "aws/request.Request" representing the client's request for the DescribeGlobalTableSettings 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 DescribeGlobalTableSettings for more information on using the DescribeGlobalTableSettings 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 DescribeGlobalTableSettingsRequest method.
req, resp := client.DescribeGlobalTableSettingsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeGlobalTableSettings

func (*DynamoDB) DescribeGlobalTableSettingsWithContext added in v1.13.39 

func (c *DynamoDB) DescribeGlobalTableSettingsWithContext(ctx aws.Context, input *DescribeGlobalTableSettingsInput, opts ...request.Option) (*DescribeGlobalTableSettingsOutput, error)

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

See DescribeGlobalTableSettings 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 (*DynamoDB) DescribeGlobalTableWithContext added in v1.12.36 

func (c *DynamoDB) DescribeGlobalTableWithContext(ctx aws.Context, input *DescribeGlobalTableInput, opts ...request.Option) (*DescribeGlobalTableOutput, error)

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

See DescribeGlobalTable 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 (*DynamoDB) DescribeKinesisStreamingDestination added in v1.35.34 

func (c *DynamoDB) DescribeKinesisStreamingDestination(input *DescribeKinesisStreamingDestinationInput) (*DescribeKinesisStreamingDestinationOutput, error)

DescribeKinesisStreamingDestination API operation for Amazon DynamoDB.

Returns information about the status of Kinesis streaming.

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 DynamoDB's API operation DescribeKinesisStreamingDestination for usage and error information.

Returned Error Types:

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

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeKinesisStreamingDestination

func (*DynamoDB) DescribeKinesisStreamingDestinationRequest added in v1.35.34 

func (c *DynamoDB) DescribeKinesisStreamingDestinationRequest(input *DescribeKinesisStreamingDestinationInput) (req *request.Request, output *DescribeKinesisStreamingDestinationOutput)

DescribeKinesisStreamingDestinationRequest generates a "aws/request.Request" representing the client's request for the DescribeKinesisStreamingDestination 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 DescribeKinesisStreamingDestination for more information on using the DescribeKinesisStreamingDestination 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 DescribeKinesisStreamingDestinationRequest method.
req, resp := client.DescribeKinesisStreamingDestinationRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeKinesisStreamingDestination

func (*DynamoDB) DescribeKinesisStreamingDestinationWithContext added in v1.35.34 

func (c *DynamoDB) DescribeKinesisStreamingDestinationWithContext(ctx aws.Context, input *DescribeKinesisStreamingDestinationInput, opts ...request.Option) (*DescribeKinesisStreamingDestinationOutput, error)

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

See DescribeKinesisStreamingDestination 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 (*DynamoDB) DescribeLimits added in v1.1.7 

func (c *DynamoDB) DescribeLimits(input *DescribeLimitsInput) (*DescribeLimitsOutput, error)

DescribeLimits API operation for Amazon DynamoDB.

Returns the current provisioned-capacity quotas for your Amazon Web Services account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.

When you establish an Amazon Web Services account, the account has initial quotas on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given Region. Also, there are per-table quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) page in the Amazon DynamoDB Developer Guide.

Although you can increase these quotas by filing a case at Amazon Web Services Support Center (https://console.aws.amazon.com/support/home#/), obtaining the increase is not instantaneous. The DescribeLimits action lets you write code to compare the capacity you are currently using to those quotas imposed by your account so that you have enough time to apply for an increase before you hit a quota.

For example, you could use one of the Amazon Web Services SDKs to do the following:

Call DescribeLimits for a particular Region to obtain your current account quotas on provisioned capacity there.

Create a variable to hold the aggregate read capacity units provisioned for all your tables in that Region, and one to hold the aggregate write capacity units. Zero them both.

Call ListTables to obtain a list of all your DynamoDB tables.

For each table name listed by ListTables, do the following:

  • Call DescribeTable with the table name.

  • Use the data returned by DescribeTable to add the read capacity units and write capacity units provisioned for the table itself to your variables.

  • If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.

Report the account quotas for that Region returned by DescribeLimits, along with the total current provisioned capacity levels you have calculated.

This will let you see whether you are getting close to your account-level quotas.

The per-table quotas apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.

For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned capacity extremely rapidly, but the only quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas.

DescribeLimits should only be called periodically. You can expect throttling errors if you call it more than once in a minute.

The DescribeLimits Request element has no content.

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 DynamoDB's API operation DescribeLimits for usage and error information.

Returned Error Types:

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeLimits

Example (Shared00)

To determine capacity limits per table and account, in the current AWS region

The following example returns the maximum read and write capacity units per table, and for the AWS account, in the current AWS region. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
	svc := dynamodb.New(session.New())
	input := &dynamodb.DescribeLimitsInput{}

	result, err := svc.DescribeLimits(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodb.ErrCodeInternalServerError:
				fmt.Println(dynamodb.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDB) DescribeLimitsRequest added in v1.1.7 

func (c *DynamoDB) DescribeLimitsRequest(input *DescribeLimitsInput) (req *request.Request, output *DescribeLimitsOutput)

DescribeLimitsRequest generates a "aws/request.Request" representing the client's request for the DescribeLimits 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 DescribeLimits for more information on using the DescribeLimits 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 DescribeLimitsRequest method.
req, resp := client.DescribeLimitsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeLimits

func (*DynamoDB) DescribeLimitsWithContext added in v1.8.0 

func (c *DynamoDB) DescribeLimitsWithContext(ctx aws.Context, input *DescribeLimitsInput, opts ...request.Option) (*DescribeLimitsOutput, error)

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

See DescribeLimits 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 (*DynamoDB) DescribeTable 

func (c *DynamoDB) DescribeTable(input *DescribeTableInput) (*DescribeTableOutput, error)

DescribeTable API operation for Amazon DynamoDB.

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.

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 DynamoDB's API operation DescribeTable for usage and error information.

Returned Error Types:

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

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeTable

Example (Shared00)

To describe a table

This example describes the Music table. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
	svc := dynamodb.New(session.New())
	input := &dynamodb.DescribeTableInput{
		TableName: aws.String("Music"),
	}

	result, err := svc.DescribeTable(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodb.ErrCodeResourceNotFoundException:
				fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
			case dynamodb.ErrCodeInternalServerError:
				fmt.Println(dynamodb.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDB) DescribeTableReplicaAutoScaling added in v1.25.40 

func (c *DynamoDB) DescribeTableReplicaAutoScaling(input *DescribeTableReplicaAutoScalingInput) (*DescribeTableReplicaAutoScalingOutput, error)

DescribeTableReplicaAutoScaling API operation for Amazon DynamoDB.

Describes auto scaling settings across replicas of the global table at once.

This operation only applies to Version 2019.11.21 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) of global 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 DynamoDB's API operation DescribeTableReplicaAutoScaling for usage and error information.

Returned Error Types:

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

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeTableReplicaAutoScaling

func (*DynamoDB) DescribeTableReplicaAutoScalingRequest added in v1.25.40 

func (c *DynamoDB) DescribeTableReplicaAutoScalingRequest(input *DescribeTableReplicaAutoScalingInput) (req *request.Request, output *DescribeTableReplicaAutoScalingOutput)

DescribeTableReplicaAutoScalingRequest generates a "aws/request.Request" representing the client's request for the DescribeTableReplicaAutoScaling 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 DescribeTableReplicaAutoScaling for more information on using the DescribeTableReplicaAutoScaling 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 DescribeTableReplicaAutoScalingRequest method.
req, resp := client.DescribeTableReplicaAutoScalingRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeTableReplicaAutoScaling

func (*DynamoDB) DescribeTableReplicaAutoScalingWithContext added in v1.25.40 

func (c *DynamoDB) DescribeTableReplicaAutoScalingWithContext(ctx aws.Context, input *DescribeTableReplicaAutoScalingInput, opts ...request.Option) (*DescribeTableReplicaAutoScalingOutput, error)

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

See DescribeTableReplicaAutoScaling 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 (*DynamoDB) DescribeTableRequest 

func (c *DynamoDB) DescribeTableRequest(input *DescribeTableInput) (req *request.Request, output *DescribeTableOutput)

DescribeTableRequest generates a "aws/request.Request" representing the client's request for the DescribeTable 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 DescribeTable for more information on using the DescribeTable 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 DescribeTableRequest method.
req, resp := client.DescribeTableRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeTable

func (*DynamoDB) DescribeTableWithContext added in v1.8.0 

func (c *DynamoDB) DescribeTableWithContext(ctx aws.Context, input *DescribeTableInput, opts ...request.Option) (*DescribeTableOutput, error)

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

See DescribeTable 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 (*DynamoDB) DescribeTimeToLive added in v1.7.2 

func (c *DynamoDB) DescribeTimeToLive(input *DescribeTimeToLiveInput) (*DescribeTimeToLiveOutput, error)

DescribeTimeToLive API operation for Amazon DynamoDB.

Gives a description of the Time to Live (TTL) status on 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 DynamoDB's API operation DescribeTimeToLive for usage and error information.

Returned Error Types:

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

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeTimeToLive

func (*DynamoDB) DescribeTimeToLiveRequest added in v1.7.2 

func (c *DynamoDB) DescribeTimeToLiveRequest(input *DescribeTimeToLiveInput) (req *request.Request, output *DescribeTimeToLiveOutput)

DescribeTimeToLiveRequest generates a "aws/request.Request" representing the client's request for the DescribeTimeToLive 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 DescribeTimeToLive for more information on using the DescribeTimeToLive 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 DescribeTimeToLiveRequest method.
req, resp := client.DescribeTimeToLiveRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeTimeToLive

func (*DynamoDB) DescribeTimeToLiveWithContext added in v1.8.0 

func (c *DynamoDB) DescribeTimeToLiveWithContext(ctx aws.Context, input *DescribeTimeToLiveInput, opts ...request.Option) (*DescribeTimeToLiveOutput, error)

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

See DescribeTimeToLive 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 (*DynamoDB) DisableKinesisStreamingDestination added in v1.35.34 

func (c *DynamoDB) DisableKinesisStreamingDestination(input *DisableKinesisStreamingDestinationInput) (*DisableKinesisStreamingDestinationOutput, error)

DisableKinesisStreamingDestination API operation for Amazon DynamoDB.

Stops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources.

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 DynamoDB's API operation DisableKinesisStreamingDestination for usage and error information.

Returned Error Types:

  • InternalServerError An error occurred on the server side.

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • ResourceInUseException The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DisableKinesisStreamingDestination

func (*DynamoDB) DisableKinesisStreamingDestinationRequest added in v1.35.34 

func (c *DynamoDB) DisableKinesisStreamingDestinationRequest(input *DisableKinesisStreamingDestinationInput) (req *request.Request, output *DisableKinesisStreamingDestinationOutput)

DisableKinesisStreamingDestinationRequest generates a "aws/request.Request" representing the client's request for the DisableKinesisStreamingDestination 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 DisableKinesisStreamingDestination for more information on using the DisableKinesisStreamingDestination 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 DisableKinesisStreamingDestinationRequest method.
req, resp := client.DisableKinesisStreamingDestinationRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DisableKinesisStreamingDestination

func (*DynamoDB) DisableKinesisStreamingDestinationWithContext added in v1.35.34 

func (c *DynamoDB) DisableKinesisStreamingDestinationWithContext(ctx aws.Context, input *DisableKinesisStreamingDestinationInput, opts ...request.Option) (*DisableKinesisStreamingDestinationOutput, error)

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

See DisableKinesisStreamingDestination 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 (*DynamoDB) EnableKinesisStreamingDestination added in v1.35.34 

func (c *DynamoDB) EnableKinesisStreamingDestination(input *EnableKinesisStreamingDestinationInput) (*EnableKinesisStreamingDestinationOutput, error)

EnableKinesisStreamingDestination API operation for Amazon DynamoDB.

Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow. If this operation doesn't return results immediately, use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is ACTIVE.

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 DynamoDB's API operation EnableKinesisStreamingDestination for usage and error information.

Returned Error Types:

  • InternalServerError An error occurred on the server side.

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • ResourceInUseException The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/EnableKinesisStreamingDestination

func (*DynamoDB) EnableKinesisStreamingDestinationRequest added in v1.35.34 

func (c *DynamoDB) EnableKinesisStreamingDestinationRequest(input *EnableKinesisStreamingDestinationInput) (req *request.Request, output *EnableKinesisStreamingDestinationOutput)

EnableKinesisStreamingDestinationRequest generates a "aws/request.Request" representing the client's request for the EnableKinesisStreamingDestination 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 EnableKinesisStreamingDestination for more information on using the EnableKinesisStreamingDestination 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 EnableKinesisStreamingDestinationRequest method.
req, resp := client.EnableKinesisStreamingDestinationRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/EnableKinesisStreamingDestination

func (*DynamoDB) EnableKinesisStreamingDestinationWithContext added in v1.35.34 

func (c *DynamoDB) EnableKinesisStreamingDestinationWithContext(ctx aws.Context, input *EnableKinesisStreamingDestinationInput, opts ...request.Option) (*EnableKinesisStreamingDestinationOutput, error)

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

See EnableKinesisStreamingDestination 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 (*DynamoDB) ExecuteStatement added in v1.35.34 

func (c *DynamoDB) ExecuteStatement(input *ExecuteStatementInput) (*ExecuteStatementOutput, error)

ExecuteStatement API operation for Amazon DynamoDB.

This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.

For PartiQL reads (SELECT statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as a LastEvaluatedKey value to continue the read in a subsequent operation. If the filter criteria in WHERE clause does not match any data, the read will return an empty result set.

A single SELECT statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results using WHERE clause). If LastEvaluatedKey is present in the response, you need to paginate the result set.

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 DynamoDB's API operation ExecuteStatement for usage and error information.

Returned Error Types:

  • ConditionalCheckFailedException A condition specified in the operation could not be evaluated.

  • ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the Amazon DynamoDB Developer Guide.

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

  • ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

  • TransactionConflictException Operation was rejected because there is an ongoing transaction for the item.

  • RequestLimitExceeded Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support (https://aws.amazon.com/support) to request a quota increase.

  • InternalServerError An error occurred on the server side.

  • DuplicateItemException There was an attempt to insert an item with the same primary key as an item that already exists in the DynamoDB table.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ExecuteStatement

func (*DynamoDB) ExecuteStatementRequest added in v1.35.34 

func (c *DynamoDB) ExecuteStatementRequest(input *ExecuteStatementInput) (req *request.Request, output *ExecuteStatementOutput)

ExecuteStatementRequest generates a "aws/request.Request" representing the client's request for the ExecuteStatement 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 ExecuteStatement for more information on using the ExecuteStatement 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 ExecuteStatementRequest method.
req, resp := client.ExecuteStatementRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ExecuteStatement

func (*DynamoDB) ExecuteStatementWithContext added in v1.35.34 

func (c *DynamoDB) ExecuteStatementWithContext(ctx aws.Context, input *ExecuteStatementInput, opts ...request.Option) (*ExecuteStatementOutput, error)

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

See ExecuteStatement 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 (*DynamoDB) ExecuteTransaction added in v1.35.34 

func (c *DynamoDB) ExecuteTransaction(input *ExecuteTransactionInput) (*ExecuteTransactionOutput, error)

ExecuteTransaction API operation for Amazon DynamoDB.

This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.

The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to ConditionCheck in the TransactWriteItems (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transaction-apis.html#transaction-apis-txwriteitems) API.

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 DynamoDB's API operation ExecuteTransaction for usage and error information.

Returned Error Types:

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

  • TransactionCanceledException The entire transaction request was canceled.

    DynamoDB cancels a TransactWriteItems request under the following circumstances:

  • A condition in one of the condition expressions is not met.

  • A table in the TransactWriteItems request is in a different account or region.

  • More than one action in the TransactWriteItems operation targets the same item.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.

  • There is a user error, such as an invalid data format.

    DynamoDB cancels a TransactGetItems request under the following circumstances:

  • There is an ongoing TransactGetItems operation that conflicts with a concurrent PutItem, UpdateItem, DeleteItem or TransactWriteItems request. In this case the TransactGetItems operation fails with a TransactionCanceledException.

  • A table in the TransactGetItems request is in a different account or region.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • There is a user error, such as an invalid data format.

    If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have None code and Null message.

    Cancellation reason codes and possible error messages:

  • No Errors: Code: None Message: null

  • Conditional Check Failed: Code: ConditionalCheckFailed Message: The conditional request failed.

  • Item Collection Size Limit Exceeded: Code: ItemCollectionSizeLimitExceeded Message: Collection size exceeded.

  • Transaction Conflict: Code: TransactionConflict Message: Transaction is ongoing for the item.

  • Provisioned Throughput Exceeded: Code: ProvisionedThroughputExceeded Messages: The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API. This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table. The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API. This message is returned when provisioned throughput is exceeded is on a provisioned GSI.

  • Throttling Error: Code: ThrottlingError Messages: Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html. This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table. Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly. This message is returned when when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.

  • Validation Error: Code: ValidationError Messages: One or more parameter values were invalid. The update expression attempted to update the secondary index key beyond allowed size limits. The update expression attempted to update the secondary index key to unsupported type. An operand in the update expression has an incorrect data type. Item size to update has exceeded the maximum allowed size. Number overflow. Attempting to store a number with magnitude larger than supported range. Type mismatch for attribute to update. Nesting Levels have exceeded supported limits. The document path provided in the update expression is invalid for update. The provided expression refers to an attribute that does not exist in the item.

  • TransactionInProgressException The transaction with the given request token is already in progress.

  • IdempotentParameterMismatchException DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.

  • ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the Amazon DynamoDB Developer Guide.

  • RequestLimitExceeded Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support (https://aws.amazon.com/support) to request a quota increase.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ExecuteTransaction

func (*DynamoDB) ExecuteTransactionRequest added in v1.35.34 

func (c *DynamoDB) ExecuteTransactionRequest(input *ExecuteTransactionInput) (req *request.Request, output *ExecuteTransactionOutput)

ExecuteTransactionRequest generates a "aws/request.Request" representing the client's request for the ExecuteTransaction 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 ExecuteTransaction for more information on using the ExecuteTransaction 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 ExecuteTransactionRequest method.
req, resp := client.ExecuteTransactionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ExecuteTransaction

func (*DynamoDB) ExecuteTransactionWithContext added in v1.35.34 

func (c *DynamoDB) ExecuteTransactionWithContext(ctx aws.Context, input *ExecuteTransactionInput, opts ...request.Option) (*ExecuteTransactionOutput, error)

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

See ExecuteTransaction 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 (*DynamoDB) ExportTableToPointInTime added in v1.35.24 

func (c *DynamoDB) ExportTableToPointInTime(input *ExportTableToPointInTimeInput) (*ExportTableToPointInTimeOutput, error)

ExportTableToPointInTime API operation for Amazon DynamoDB.

Exports table data to an S3 bucket. The table must have point in time recovery enabled, and you can export data from any time within the point in time recovery window.

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 DynamoDB's API operation ExportTableToPointInTime for usage and error information.

Returned Error Types:

  • TableNotFoundException A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

  • PointInTimeRecoveryUnavailableException Point in time recovery has not yet been enabled for this source table.

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • InvalidExportTimeException The specified ExportTime is outside of the point in time recovery window.

  • ExportConflictException There was a conflict when writing to the specified S3 bucket.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ExportTableToPointInTime

func (*DynamoDB) ExportTableToPointInTimeRequest added in v1.35.24 

func (c *DynamoDB) ExportTableToPointInTimeRequest(input *ExportTableToPointInTimeInput) (req *request.Request, output *ExportTableToPointInTimeOutput)

ExportTableToPointInTimeRequest generates a "aws/request.Request" representing the client's request for the ExportTableToPointInTime 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 ExportTableToPointInTime for more information on using the ExportTableToPointInTime 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 ExportTableToPointInTimeRequest method.
req, resp := client.ExportTableToPointInTimeRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ExportTableToPointInTime

func (*DynamoDB) ExportTableToPointInTimeWithContext added in v1.35.24 

func (c *DynamoDB) ExportTableToPointInTimeWithContext(ctx aws.Context, input *ExportTableToPointInTimeInput, opts ...request.Option) (*ExportTableToPointInTimeOutput, error)

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

See ExportTableToPointInTime 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 (*DynamoDB) GetItem 

func (c *DynamoDB) GetItem(input *GetItemInput) (*GetItemOutput, error)

GetItem API operation for Amazon DynamoDB.

The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data and there will be no Item element in the response.

GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

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 DynamoDB's API operation GetItem for usage and error information.

Returned Error Types:

  • ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the Amazon DynamoDB Developer Guide.

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

  • RequestLimitExceeded Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support (https://aws.amazon.com/support) to request a quota increase.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/GetItem

Example (Shared00)

To read an item from a table

This example retrieves an item from the Music table. The table has a partition key and a sort key (Artist and SongTitle), so you must specify both of these attributes. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
	svc := dynamodb.New(session.New())
	input := &dynamodb.GetItemInput{
		Key: map[string]*dynamodb.AttributeValue{
			"Artist": {
				S: aws.String("Acme Band"),
			},
			"SongTitle": {
				S: aws.String("Happy Day"),
			},
		},
		TableName: aws.String("Music"),
	}

	result, err := svc.GetItem(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodb.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case dynamodb.ErrCodeResourceNotFoundException:
				fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
			case dynamodb.ErrCodeRequestLimitExceeded:
				fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
			case dynamodb.ErrCodeInternalServerError:
				fmt.Println(dynamodb.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDB) GetItemRequest 

func (c *DynamoDB) GetItemRequest(input *GetItemInput) (req *request.Request, output *GetItemOutput)

GetItemRequest generates a "aws/request.Request" representing the client's request for the GetItem 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 GetItem for more information on using the GetItem 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 GetItemRequest method.
req, resp := client.GetItemRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/GetItem

func (*DynamoDB) GetItemWithContext added in v1.8.0 

func (c *DynamoDB) GetItemWithContext(ctx aws.Context, input *GetItemInput, opts ...request.Option) (*GetItemOutput, error)

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

See GetItem 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 (*DynamoDB) ListBackups added in v1.12.36 

func (c *DynamoDB) ListBackups(input *ListBackupsInput) (*ListBackupsOutput, error)

ListBackups API operation for Amazon DynamoDB.

List backups associated with an Amazon Web Services account. To list backups for a given table, specify TableName. ListBackups returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a maximum number of entries to be returned in a page.

In the request, start time is inclusive, but end time is exclusive. Note that these boundaries are for the time at which the original backup was requested.

You can call ListBackups a maximum of five times per second.

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 DynamoDB's API operation ListBackups for usage and error information.

Returned Error Types:

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListBackups

func (*DynamoDB) ListBackupsRequest added in v1.12.36 

func (c *DynamoDB) ListBackupsRequest(input *ListBackupsInput) (req *request.Request, output *ListBackupsOutput)

ListBackupsRequest generates a "aws/request.Request" representing the client's request for the ListBackups 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 ListBackups for more information on using the ListBackups 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 ListBackupsRequest method.
req, resp := client.ListBackupsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListBackups

func (*DynamoDB) ListBackupsWithContext added in v1.12.36 

func (c *DynamoDB) ListBackupsWithContext(ctx aws.Context, input *ListBackupsInput, opts ...request.Option) (*ListBackupsOutput, error)

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

See ListBackups 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 (*DynamoDB) ListContributorInsights added in v1.25.43 

func (c *DynamoDB) ListContributorInsights(input *ListContributorInsightsInput) (*ListContributorInsightsOutput, error)

ListContributorInsights API operation for Amazon DynamoDB.

Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.

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 DynamoDB's API operation ListContributorInsights for usage and error information.

Returned Error Types:

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

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListContributorInsights

func (*DynamoDB) ListContributorInsightsPages added in v1.25.43 

func (c *DynamoDB) ListContributorInsightsPages(input *ListContributorInsightsInput, fn func(*ListContributorInsightsOutput, bool) bool) error

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

See ListContributorInsights 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 ListContributorInsights operation.
pageNum := 0
err := client.ListContributorInsightsPages(params,
    func(page *dynamodb.ListContributorInsightsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DynamoDB) ListContributorInsightsPagesWithContext added in v1.25.43 

func (c *DynamoDB) ListContributorInsightsPagesWithContext(ctx aws.Context, input *ListContributorInsightsInput, fn func(*ListContributorInsightsOutput, bool) bool, opts ...request.Option) error

ListContributorInsightsPagesWithContext same as ListContributorInsightsPages 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 (*DynamoDB) ListContributorInsightsRequest added in v1.25.43 

func (c *DynamoDB) ListContributorInsightsRequest(input *ListContributorInsightsInput) (req *request.Request, output *ListContributorInsightsOutput)

ListContributorInsightsRequest generates a "aws/request.Request" representing the client's request for the ListContributorInsights 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 ListContributorInsights for more information on using the ListContributorInsights 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 ListContributorInsightsRequest method.
req, resp := client.ListContributorInsightsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListContributorInsights

func (*DynamoDB) ListContributorInsightsWithContext added in v1.25.43 

func (c *DynamoDB) ListContributorInsightsWithContext(ctx aws.Context, input *ListContributorInsightsInput, opts ...request.Option) (*ListContributorInsightsOutput, error)

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

See ListContributorInsights 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 (*DynamoDB) ListExports added in v1.35.24 

func (c *DynamoDB) ListExports(input *ListExportsInput) (*ListExportsOutput, error)

ListExports API operation for Amazon DynamoDB.

Lists completed exports within the past 90 days.

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 DynamoDB's API operation ListExports for usage and error information.

Returned Error Types:

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListExports

func (*DynamoDB) ListExportsPages added in v1.35.24 

func (c *DynamoDB) ListExportsPages(input *ListExportsInput, fn func(*ListExportsOutput, bool) bool) error

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

See ListExports 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 ListExports operation.
pageNum := 0
err := client.ListExportsPages(params,
    func(page *dynamodb.ListExportsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DynamoDB) ListExportsPagesWithContext added in v1.35.24 

func (c *DynamoDB) ListExportsPagesWithContext(ctx aws.Context, input *ListExportsInput, fn func(*ListExportsOutput, bool) bool, opts ...request.Option) error

ListExportsPagesWithContext same as ListExportsPages 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 (*DynamoDB) ListExportsRequest added in v1.35.24 

func (c *DynamoDB) ListExportsRequest(input *ListExportsInput) (req *request.Request, output *ListExportsOutput)

ListExportsRequest generates a "aws/request.Request" representing the client's request for the ListExports 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 ListExports for more information on using the ListExports 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 ListExportsRequest method.
req, resp := client.ListExportsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListExports

func (*DynamoDB) ListExportsWithContext added in v1.35.24 

func (c *DynamoDB) ListExportsWithContext(ctx aws.Context, input *ListExportsInput, opts ...request.Option) (*ListExportsOutput, error)

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

See ListExports 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 (*DynamoDB) ListGlobalTables added in v1.12.36 

func (c *DynamoDB) ListGlobalTables(input *ListGlobalTablesInput) (*ListGlobalTablesOutput, error)

ListGlobalTables API operation for Amazon DynamoDB.

Lists all global tables that have a replica in the specified Region.

This operation only applies to Version 2017.11.29 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global 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 DynamoDB's API operation ListGlobalTables for usage and error information.

Returned Error Types:

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListGlobalTables

func (*DynamoDB) ListGlobalTablesRequest added in v1.12.36 

func (c *DynamoDB) ListGlobalTablesRequest(input *ListGlobalTablesInput) (req *request.Request, output *ListGlobalTablesOutput)

ListGlobalTablesRequest generates a "aws/request.Request" representing the client's request for the ListGlobalTables 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 ListGlobalTables for more information on using the ListGlobalTables 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 ListGlobalTablesRequest method.
req, resp := client.ListGlobalTablesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListGlobalTables

func (*DynamoDB) ListGlobalTablesWithContext added in v1.12.36 

func (c *DynamoDB) ListGlobalTablesWithContext(ctx aws.Context, input *ListGlobalTablesInput, opts ...request.Option) (*ListGlobalTablesOutput, error)

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

See ListGlobalTables 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 (*DynamoDB) ListTables 

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

ListTables API operation for Amazon DynamoDB.

Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names.

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 DynamoDB's API operation ListTables for usage and error information.

Returned Error Types:

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListTables

Example (Shared00)

To list tables

This example lists all of the tables associated with the current AWS account and endpoint. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
	svc := dynamodb.New(session.New())
	input := &dynamodb.ListTablesInput{}

	result, err := svc.ListTables(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodb.ErrCodeInternalServerError:
				fmt.Println(dynamodb.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDB) ListTablesPages 

func (c *DynamoDB) 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 *dynamodb.ListTablesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DynamoDB) ListTablesPagesWithContext added in v1.8.0 

func (c *DynamoDB) 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 (*DynamoDB) ListTablesRequest 

func (c *DynamoDB) 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/dynamodb-2012-08-10/ListTables

func (*DynamoDB) ListTablesWithContext added in v1.8.0 

func (c *DynamoDB) 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 (*DynamoDB) ListTagsOfResource added in v1.6.12 

func (c *DynamoDB) ListTagsOfResource(input *ListTagsOfResourceInput) (*ListTagsOfResourceOutput, error)

ListTagsOfResource API operation for Amazon DynamoDB.

List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the Amazon DynamoDB 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 DynamoDB's API operation ListTagsOfResource for usage and error information.

Returned Error Types:

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

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListTagsOfResource

func (*DynamoDB) ListTagsOfResourceRequest added in v1.6.12 

func (c *DynamoDB) ListTagsOfResourceRequest(input *ListTagsOfResourceInput) (req *request.Request, output *ListTagsOfResourceOutput)

ListTagsOfResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsOfResource 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 ListTagsOfResource for more information on using the ListTagsOfResource 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 ListTagsOfResourceRequest method.
req, resp := client.ListTagsOfResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListTagsOfResource

func (*DynamoDB) ListTagsOfResourceWithContext added in v1.8.0 

func (c *DynamoDB) ListTagsOfResourceWithContext(ctx aws.Context, input *ListTagsOfResourceInput, opts ...request.Option) (*ListTagsOfResourceOutput, error)

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

See ListTagsOfResource 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 (*DynamoDB) PutItem 

func (c *DynamoDB) PutItem(input *PutItemInput) (*PutItemOutput, error)

PutItem API operation for Amazon DynamoDB.

Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. You can return the item's attribute values in the same operation, using the ReturnValues parameter.

When you add an item, the primary key attributes are the only required attributes. Attribute values cannot be null.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. Set type attributes cannot be empty.

Invalid Requests with empty values will be rejected with a ValidationException exception.

To prevent a new item from replacing an existing item, use a conditional expression that contains the attribute_not_exists function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the attribute_not_exists function will only succeed if no matching item exists.

For more information about PutItem, see Working with Items (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html) in the Amazon DynamoDB 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 DynamoDB's API operation PutItem for usage and error information.

Returned Error Types:

  • ConditionalCheckFailedException A condition specified in the operation could not be evaluated.

  • ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the Amazon DynamoDB Developer Guide.

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

  • ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

  • TransactionConflictException Operation was rejected because there is an ongoing transaction for the item.

  • RequestLimitExceeded Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support (https://aws.amazon.com/support) to request a quota increase.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/PutItem

Example (Shared00)

To add an item to a table

This example adds a new item to the Music table. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
	svc := dynamodb.New(session.New())
	input := &dynamodb.PutItemInput{
		Item: map[string]*dynamodb.AttributeValue{
			"AlbumTitle": {
				S: aws.String("Somewhat Famous"),
			},
			"Artist": {
				S: aws.String("No One You Know"),
			},
			"SongTitle": {
				S: aws.String("Call Me Today"),
			},
		},
		ReturnConsumedCapacity: aws.String("TOTAL"),
		TableName:              aws.String("Music"),
	}

	result, err := svc.PutItem(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodb.ErrCodeConditionalCheckFailedException:
				fmt.Println(dynamodb.ErrCodeConditionalCheckFailedException, aerr.Error())
			case dynamodb.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case dynamodb.ErrCodeResourceNotFoundException:
				fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
			case dynamodb.ErrCodeItemCollectionSizeLimitExceededException:
				fmt.Println(dynamodb.ErrCodeItemCollectionSizeLimitExceededException, aerr.Error())
			case dynamodb.ErrCodeTransactionConflictException:
				fmt.Println(dynamodb.ErrCodeTransactionConflictException, aerr.Error())
			case dynamodb.ErrCodeRequestLimitExceeded:
				fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
			case dynamodb.ErrCodeInternalServerError:
				fmt.Println(dynamodb.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDB) PutItemRequest 

func (c *DynamoDB) PutItemRequest(input *PutItemInput) (req *request.Request, output *PutItemOutput)

PutItemRequest generates a "aws/request.Request" representing the client's request for the PutItem 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 PutItem for more information on using the PutItem 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 PutItemRequest method.
req, resp := client.PutItemRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/PutItem

func (*DynamoDB) PutItemWithContext added in v1.8.0 

func (c *DynamoDB) PutItemWithContext(ctx aws.Context, input *PutItemInput, opts ...request.Option) (*PutItemOutput, error)

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

See PutItem 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 (*DynamoDB) Query 

func (c *DynamoDB) Query(input *QueryInput) (*QueryOutput, error)

Query API operation for Amazon DynamoDB.

You must provide the name of the partition key attribute and a single value for that attribute. Query returns all items with that partition key value. Optionally, you can provide a sort key attribute and use a comparison operator to refine the search results.

Use the KeyConditionExpression parameter to provide a specific value for the partition key. The Query operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. To further refine the Query results, you can optionally provide a FilterExpression. A FilterExpression determines which items within the results should be returned to you. All of the other results are discarded.

A Query operation always returns a result set. If no matching items are found, the result set will be empty. Queries that do not return results consume the minimum number of read capacity units for that type of read operation.

DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a FilterExpression.

Query results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set the ScanIndexForward parameter to false.

A single Query operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination) in the Amazon DynamoDB Developer Guide.

FilterExpression is applied after a Query finishes, but before the results are returned. A FilterExpression cannot contain partition key or sort key attributes. You need to specify those attributes in the KeyConditionExpression.

A Query operation can return an empty result set and a LastEvaluatedKey if all the items read for the page of results are filtered out.

You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the ConsistentRead parameter to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index.

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 DynamoDB's API operation Query for usage and error information.

Returned Error Types:

  • ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the Amazon DynamoDB Developer Guide.

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

  • RequestLimitExceeded Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support (https://aws.amazon.com/support) to request a quota increase.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/Query

Example (Shared00)

To query an item

This example queries items in the Music table. The table has a partition key and sort key (Artist and SongTitle), but this query only specifies the partition key value. It returns song titles by the artist named "No One You Know". 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
	svc := dynamodb.New(session.New())
	input := &dynamodb.QueryInput{
		ExpressionAttributeValues: map[string]*dynamodb.AttributeValue{
			":v1": {
				S: aws.String("No One You Know"),
			},
		},
		KeyConditionExpression: aws.String("Artist = :v1"),
		ProjectionExpression:   aws.String("SongTitle"),
		TableName:              aws.String("Music"),
	}

	result, err := svc.Query(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodb.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case dynamodb.ErrCodeResourceNotFoundException:
				fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
			case dynamodb.ErrCodeRequestLimitExceeded:
				fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
			case dynamodb.ErrCodeInternalServerError:
				fmt.Println(dynamodb.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDB) QueryPages 

func (c *DynamoDB) QueryPages(input *QueryInput, fn func(*QueryOutput, bool) bool) error

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

See Query 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 Query operation.
pageNum := 0
err := client.QueryPages(params,
    func(page *dynamodb.QueryOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DynamoDB) QueryPagesWithContext added in v1.8.0 

func (c *DynamoDB) QueryPagesWithContext(ctx aws.Context, input *QueryInput, fn func(*QueryOutput, bool) bool, opts ...request.Option) error

QueryPagesWithContext same as QueryPages 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 (*DynamoDB) QueryRequest 

func (c *DynamoDB) QueryRequest(input *QueryInput) (req *request.Request, output *QueryOutput)

QueryRequest generates a "aws/request.Request" representing the client's request for the Query 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 Query for more information on using the Query 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 QueryRequest method.
req, resp := client.QueryRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/Query

func (*DynamoDB) QueryWithContext added in v1.8.0 

func (c *DynamoDB) QueryWithContext(ctx aws.Context, input *QueryInput, opts ...request.Option) (*QueryOutput, error)

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

See Query 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 (*DynamoDB) RestoreTableFromBackup added in v1.12.36 

func (c *DynamoDB) RestoreTableFromBackup(input *RestoreTableFromBackupInput) (*RestoreTableFromBackupOutput, error)

RestoreTableFromBackup API operation for Amazon DynamoDB.

Creates a new table from an existing backup. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

You can call RestoreTableFromBackup at a maximum rate of 10 times per second.

You must manually set up the following on the restored table:

  • Auto scaling policies

  • IAM policies

  • Amazon CloudWatch metrics and alarms

  • Tags

  • Stream settings

  • Time to Live (TTL) settings

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 DynamoDB's API operation RestoreTableFromBackup for usage and error information.

Returned Error Types:

  • TableAlreadyExistsException A target table with the specified name already exists.

  • TableInUseException A target table with the specified name is either being created or deleted.

  • BackupNotFoundException Backup not found for the given BackupARN.

  • BackupInUseException There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/RestoreTableFromBackup

func (*DynamoDB) RestoreTableFromBackupRequest added in v1.12.36 

func (c *DynamoDB) RestoreTableFromBackupRequest(input *RestoreTableFromBackupInput) (req *request.Request, output *RestoreTableFromBackupOutput)

RestoreTableFromBackupRequest generates a "aws/request.Request" representing the client's request for the RestoreTableFromBackup 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 RestoreTableFromBackup for more information on using the RestoreTableFromBackup 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 RestoreTableFromBackupRequest method.
req, resp := client.RestoreTableFromBackupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/RestoreTableFromBackup

func (*DynamoDB) RestoreTableFromBackupWithContext added in v1.12.36 

func (c *DynamoDB) RestoreTableFromBackupWithContext(ctx aws.Context, input *RestoreTableFromBackupInput, opts ...request.Option) (*RestoreTableFromBackupOutput, error)

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

See RestoreTableFromBackup 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 (*DynamoDB) RestoreTableToPointInTime added in v1.13.21 

func (c *DynamoDB) RestoreTableToPointInTime(input *RestoreTableToPointInTimeInput) (*RestoreTableToPointInTimeOutput, error)

RestoreTableToPointInTime API operation for Amazon DynamoDB.

Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. You can restore your table to any point in time during the last 35 days. 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, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table.

Along with data, the following are also included on the new restored table using point in time recovery:

  • Global secondary indexes (GSIs)

  • Local secondary indexes (LSIs)

  • Provisioned read and write capacity

  • Encryption settings All these settings come from the current settings of the source table at the time of restore.

You must manually set up the following on the restored table:

  • Auto scaling policies

  • IAM policies

  • Amazon CloudWatch metrics and alarms

  • Tags

  • Stream settings

  • Time to Live (TTL) settings

  • Point in time recovery settings

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 DynamoDB's API operation RestoreTableToPointInTime for usage and error information.

Returned Error Types:

  • TableAlreadyExistsException A target table with the specified name already exists.

  • TableNotFoundException A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

  • TableInUseException A target table with the specified name is either being created or deleted.

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • InvalidRestoreTimeException An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.

  • PointInTimeRecoveryUnavailableException Point in time recovery has not yet been enabled for this source table.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/RestoreTableToPointInTime

func (*DynamoDB) RestoreTableToPointInTimeRequest added in v1.13.21 

func (c *DynamoDB) RestoreTableToPointInTimeRequest(input *RestoreTableToPointInTimeInput) (req *request.Request, output *RestoreTableToPointInTimeOutput)

RestoreTableToPointInTimeRequest generates a "aws/request.Request" representing the client's request for the RestoreTableToPointInTime 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 RestoreTableToPointInTime for more information on using the RestoreTableToPointInTime 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 RestoreTableToPointInTimeRequest method.
req, resp := client.RestoreTableToPointInTimeRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/RestoreTableToPointInTime

func (*DynamoDB) RestoreTableToPointInTimeWithContext added in v1.13.21 

func (c *DynamoDB) RestoreTableToPointInTimeWithContext(ctx aws.Context, input *RestoreTableToPointInTimeInput, opts ...request.Option) (*RestoreTableToPointInTimeOutput, error)

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

See RestoreTableToPointInTime 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 (*DynamoDB) Scan 

func (c *DynamoDB) Scan(input *ScanInput) (*ScanOutput, error)

Scan API operation for Amazon DynamoDB.

The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression operation.

If the total number of scanned items exceeds the maximum dataset size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.

A single Scan operation reads up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you need to paginate the result set. For more information, see Paginating the Results (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination) in the Amazon DynamoDB Developer Guide.

Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan) in the Amazon DynamoDB Developer Guide.

Scan uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the ConsistentRead parameter to true.

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 DynamoDB's API operation Scan for usage and error information.

Returned Error Types:

  • ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the Amazon DynamoDB Developer Guide.

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

  • RequestLimitExceeded Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support (https://aws.amazon.com/support) to request a quota increase.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/Scan

Example (Shared00)

To scan a table

This example scans the entire Music table, and then narrows the results to songs by the artist "No One You Know". For each item, only the album title and song title are returned. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
	svc := dynamodb.New(session.New())
	input := &dynamodb.ScanInput{
		ExpressionAttributeNames: map[string]*string{
			"#AT": aws.String("AlbumTitle"),
			"#ST": aws.String("SongTitle"),
		},
		ExpressionAttributeValues: map[string]*dynamodb.AttributeValue{
			":a": {
				S: aws.String("No One You Know"),
			},
		},
		FilterExpression:     aws.String("Artist = :a"),
		ProjectionExpression: aws.String("#ST, #AT"),
		TableName:            aws.String("Music"),
	}

	result, err := svc.Scan(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodb.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case dynamodb.ErrCodeResourceNotFoundException:
				fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
			case dynamodb.ErrCodeRequestLimitExceeded:
				fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
			case dynamodb.ErrCodeInternalServerError:
				fmt.Println(dynamodb.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDB) ScanPages 

func (c *DynamoDB) ScanPages(input *ScanInput, fn func(*ScanOutput, bool) bool) error

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

See Scan 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 Scan operation.
pageNum := 0
err := client.ScanPages(params,
    func(page *dynamodb.ScanOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DynamoDB) ScanPagesWithContext added in v1.8.0 

func (c *DynamoDB) ScanPagesWithContext(ctx aws.Context, input *ScanInput, fn func(*ScanOutput, bool) bool, opts ...request.Option) error

ScanPagesWithContext same as ScanPages 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 (*DynamoDB) ScanRequest 

func (c *DynamoDB) ScanRequest(input *ScanInput) (req *request.Request, output *ScanOutput)

ScanRequest generates a "aws/request.Request" representing the client's request for the Scan 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 Scan for more information on using the Scan 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 ScanRequest method.
req, resp := client.ScanRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/Scan

func (*DynamoDB) ScanWithContext added in v1.8.0 

func (c *DynamoDB) ScanWithContext(ctx aws.Context, input *ScanInput, opts ...request.Option) (*ScanOutput, error)

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

See Scan 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 (*DynamoDB) TagResource added in v1.6.12 

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

TagResource API operation for Amazon DynamoDB.

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the Amazon DynamoDB 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 DynamoDB's API operation TagResource for usage and error information.

Returned Error Types:

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

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

  • InternalServerError An error occurred on the server side.

  • ResourceInUseException The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/TagResource

func (*DynamoDB) TagResourceRequest added in v1.6.12 

func (c *DynamoDB) 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/dynamodb-2012-08-10/TagResource

func (*DynamoDB) TagResourceWithContext added in v1.8.0 

func (c *DynamoDB) 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 (*DynamoDB) TransactGetItems added in v1.15.85 

func (c *DynamoDB) TransactGetItems(input *TransactGetItemsInput) (*TransactGetItemsOutput, error)

TransactGetItems API operation for Amazon DynamoDB.

TransactGetItems is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and Region. A TransactGetItems call can contain up to 25 TransactGetItem objects, each of which contains a Get structure that specifies an item to retrieve from a table in the account and Region. A call to TransactGetItems cannot retrieve items from tables in more than one Amazon Web Services account or Region. The aggregate size of the items in the transaction cannot exceed 4 MB.

DynamoDB rejects the entire TransactGetItems request if any of the following is true:

  • A conflicting operation is in the process of updating an item to be read.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • There is a user error, such as an invalid data format.

  • The aggregate size of the items in the transaction cannot exceed 4 MB.

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 DynamoDB's API operation TransactGetItems for usage and error information.

Returned Error Types:

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

  • TransactionCanceledException The entire transaction request was canceled.

    DynamoDB cancels a TransactWriteItems request under the following circumstances:

  • A condition in one of the condition expressions is not met.

  • A table in the TransactWriteItems request is in a different account or region.

  • More than one action in the TransactWriteItems operation targets the same item.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.

  • There is a user error, such as an invalid data format.

    DynamoDB cancels a TransactGetItems request under the following circumstances:

  • There is an ongoing TransactGetItems operation that conflicts with a concurrent PutItem, UpdateItem, DeleteItem or TransactWriteItems request. In this case the TransactGetItems operation fails with a TransactionCanceledException.

  • A table in the TransactGetItems request is in a different account or region.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • There is a user error, such as an invalid data format.

    If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have None code and Null message.

    Cancellation reason codes and possible error messages:

  • No Errors: Code: None Message: null

  • Conditional Check Failed: Code: ConditionalCheckFailed Message: The conditional request failed.

  • Item Collection Size Limit Exceeded: Code: ItemCollectionSizeLimitExceeded Message: Collection size exceeded.

  • Transaction Conflict: Code: TransactionConflict Message: Transaction is ongoing for the item.

  • Provisioned Throughput Exceeded: Code: ProvisionedThroughputExceeded Messages: The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API. This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table. The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API. This message is returned when provisioned throughput is exceeded is on a provisioned GSI.

  • Throttling Error: Code: ThrottlingError Messages: Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html. This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table. Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly. This message is returned when when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.

  • Validation Error: Code: ValidationError Messages: One or more parameter values were invalid. The update expression attempted to update the secondary index key beyond allowed size limits. The update expression attempted to update the secondary index key to unsupported type. An operand in the update expression has an incorrect data type. Item size to update has exceeded the maximum allowed size. Number overflow. Attempting to store a number with magnitude larger than supported range. Type mismatch for attribute to update. Nesting Levels have exceeded supported limits. The document path provided in the update expression is invalid for update. The provided expression refers to an attribute that does not exist in the item.

  • ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the Amazon DynamoDB Developer Guide.

  • RequestLimitExceeded Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support (https://aws.amazon.com/support) to request a quota increase.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/TransactGetItems

func (*DynamoDB) TransactGetItemsRequest added in v1.15.85 

func (c *DynamoDB) TransactGetItemsRequest(input *TransactGetItemsInput) (req *request.Request, output *TransactGetItemsOutput)

TransactGetItemsRequest generates a "aws/request.Request" representing the client's request for the TransactGetItems 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 TransactGetItems for more information on using the TransactGetItems 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 TransactGetItemsRequest method.
req, resp := client.TransactGetItemsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/TransactGetItems

func (*DynamoDB) TransactGetItemsWithContext added in v1.15.85 

func (c *DynamoDB) TransactGetItemsWithContext(ctx aws.Context, input *TransactGetItemsInput, opts ...request.Option) (*TransactGetItemsOutput, error)

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

See TransactGetItems 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 (*DynamoDB) TransactWriteItems added in v1.15.85 

func (c *DynamoDB) TransactWriteItems(input *TransactWriteItemsInput) (*TransactWriteItemsOutput, error)

TransactWriteItems API operation for Amazon DynamoDB.

TransactWriteItems is a synchronous write operation that groups up to 25 action requests. These actions can target items in different tables, but not in different Amazon Web Services accounts or Regions, and no two actions can target the same item. For example, you cannot both ConditionCheck and Update the same item. The aggregate size of the items in the transaction cannot exceed 4 MB.

The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects:

  • Put — Initiates a PutItem operation to write a new item. This structure specifies the primary key of the item to be written, the name of the table to write it in, an optional condition expression that must be satisfied for the write to succeed, a list of the item's attributes, and a field indicating whether to retrieve the item's attributes if the condition is not met.

  • Update — Initiates an UpdateItem operation to update an existing item. This structure specifies the primary key of the item to be updated, the name of the table where it resides, an optional condition expression that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated, and a field indicating whether to retrieve the item's attributes if the condition is not met.

  • Delete — Initiates a DeleteItem operation to delete an existing item. This structure specifies the primary key of the item to be deleted, the name of the table where it resides, an optional condition expression that must be satisfied for the deletion to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met.

  • ConditionCheck — Applies a condition to an item that is not being modified by the transaction. This structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition expression that must be satisfied for the transaction to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met.

DynamoDB rejects the entire TransactWriteItems request if any of the following is true:

  • A condition in one of the condition expressions is not met.

  • An ongoing operation is in the process of updating the same item.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • An item size becomes too large (bigger than 400 KB), a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.

  • The aggregate size of the items in the transaction exceeds 4 MB.

  • There is a user error, such as an invalid data format.

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 DynamoDB's API operation TransactWriteItems for usage and error information.

Returned Error Types:

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

  • TransactionCanceledException The entire transaction request was canceled.

    DynamoDB cancels a TransactWriteItems request under the following circumstances:

  • A condition in one of the condition expressions is not met.

  • A table in the TransactWriteItems request is in a different account or region.

  • More than one action in the TransactWriteItems operation targets the same item.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.

  • There is a user error, such as an invalid data format.

    DynamoDB cancels a TransactGetItems request under the following circumstances:

  • There is an ongoing TransactGetItems operation that conflicts with a concurrent PutItem, UpdateItem, DeleteItem or TransactWriteItems request. In this case the TransactGetItems operation fails with a TransactionCanceledException.

  • A table in the TransactGetItems request is in a different account or region.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • There is a user error, such as an invalid data format.

    If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have None code and Null message.

    Cancellation reason codes and possible error messages:

  • No Errors: Code: None Message: null

  • Conditional Check Failed: Code: ConditionalCheckFailed Message: The conditional request failed.

  • Item Collection Size Limit Exceeded: Code: ItemCollectionSizeLimitExceeded Message: Collection size exceeded.

  • Transaction Conflict: Code: TransactionConflict Message: Transaction is ongoing for the item.

  • Provisioned Throughput Exceeded: Code: ProvisionedThroughputExceeded Messages: The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API. This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table. The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API. This message is returned when provisioned throughput is exceeded is on a provisioned GSI.

  • Throttling Error: Code: ThrottlingError Messages: Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html. This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table. Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly. This message is returned when when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.

  • Validation Error: Code: ValidationError Messages: One or more parameter values were invalid. The update expression attempted to update the secondary index key beyond allowed size limits. The update expression attempted to update the secondary index key to unsupported type. An operand in the update expression has an incorrect data type. Item size to update has exceeded the maximum allowed size. Number overflow. Attempting to store a number with magnitude larger than supported range. Type mismatch for attribute to update. Nesting Levels have exceeded supported limits. The document path provided in the update expression is invalid for update. The provided expression refers to an attribute that does not exist in the item.

  • TransactionInProgressException The transaction with the given request token is already in progress.

  • IdempotentParameterMismatchException DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.

  • ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the Amazon DynamoDB Developer Guide.

  • RequestLimitExceeded Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support (https://aws.amazon.com/support) to request a quota increase.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/TransactWriteItems

Example (TransactionCanceledException) 
package main

import (
	"log"

	"github.com/aws/aws-sdk-go/awstesting/unit"
	"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
	client := dynamodb.New(unit.Session)

	_, err := client.TransactWriteItems(&dynamodb.TransactWriteItemsInput{})
	if err != nil {
		switch t := err.(type) {
		case *dynamodb.TransactionCanceledException:
			log.Fatalf("failed to write items: %s\n%v",
				t.Message(), t.CancellationReasons)
		default:
			log.Fatalf("failed to write items: %v", err)
		}
	}
}

Output:

func (*DynamoDB) TransactWriteItemsRequest added in v1.15.85 

func (c *DynamoDB) TransactWriteItemsRequest(input *TransactWriteItemsInput) (req *request.Request, output *TransactWriteItemsOutput)

TransactWriteItemsRequest generates a "aws/request.Request" representing the client's request for the TransactWriteItems 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 TransactWriteItems for more information on using the TransactWriteItems 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 TransactWriteItemsRequest method.
req, resp := client.TransactWriteItemsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/TransactWriteItems

func (*DynamoDB) TransactWriteItemsWithContext added in v1.15.85 

func (c *DynamoDB) TransactWriteItemsWithContext(ctx aws.Context, input *TransactWriteItemsInput, opts ...request.Option) (*TransactWriteItemsOutput, error)

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

See TransactWriteItems 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 (*DynamoDB) UntagResource added in v1.6.12 

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

UntagResource API operation for Amazon DynamoDB.

Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to five times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the Amazon DynamoDB 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 DynamoDB's API operation UntagResource for usage and error information.

Returned Error Types:

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

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

  • InternalServerError An error occurred on the server side.

  • ResourceInUseException The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UntagResource

func (*DynamoDB) UntagResourceRequest added in v1.6.12 

func (c *DynamoDB) 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/dynamodb-2012-08-10/UntagResource

func (*DynamoDB) UntagResourceWithContext added in v1.8.0 

func (c *DynamoDB) 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 (*DynamoDB) UpdateContinuousBackups added in v1.13.21 

func (c *DynamoDB) UpdateContinuousBackups(input *UpdateContinuousBackupsInput) (*UpdateContinuousBackupsOutput, error)

UpdateContinuousBackups API operation for Amazon DynamoDB.

UpdateContinuousBackups enables or disables point in time recovery for the specified table. A successful UpdateContinuousBackups call returns the current ContinuousBackupsDescription. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.

Once continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.

LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.

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 DynamoDB's API operation UpdateContinuousBackups for usage and error information.

Returned Error Types:

  • TableNotFoundException A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

  • ContinuousBackupsUnavailableException Backups have not yet been enabled for this table.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateContinuousBackups

func (*DynamoDB) UpdateContinuousBackupsRequest added in v1.13.21 

func (c *DynamoDB) UpdateContinuousBackupsRequest(input *UpdateContinuousBackupsInput) (req *request.Request, output *UpdateContinuousBackupsOutput)

UpdateContinuousBackupsRequest generates a "aws/request.Request" representing the client's request for the UpdateContinuousBackups 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 UpdateContinuousBackups for more information on using the UpdateContinuousBackups 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 UpdateContinuousBackupsRequest method.
req, resp := client.UpdateContinuousBackupsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateContinuousBackups

func (*DynamoDB) UpdateContinuousBackupsWithContext added in v1.13.21 

func (c *DynamoDB) UpdateContinuousBackupsWithContext(ctx aws.Context, input *UpdateContinuousBackupsInput, opts ...request.Option) (*UpdateContinuousBackupsOutput, error)

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

See UpdateContinuousBackups 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 (*DynamoDB) UpdateContributorInsights added in v1.25.43 

func (c *DynamoDB) UpdateContributorInsights(input *UpdateContributorInsightsInput) (*UpdateContributorInsightsOutput, error)

UpdateContributorInsights API operation for Amazon DynamoDB.

Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an Amazon Web Services managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this 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 DynamoDB's API operation UpdateContributorInsights for usage and error information.

Returned Error Types:

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

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateContributorInsights

func (*DynamoDB) UpdateContributorInsightsRequest added in v1.25.43 

func (c *DynamoDB) UpdateContributorInsightsRequest(input *UpdateContributorInsightsInput) (req *request.Request, output *UpdateContributorInsightsOutput)

UpdateContributorInsightsRequest generates a "aws/request.Request" representing the client's request for the UpdateContributorInsights 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 UpdateContributorInsights for more information on using the UpdateContributorInsights 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 UpdateContributorInsightsRequest method.
req, resp := client.UpdateContributorInsightsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateContributorInsights

func (*DynamoDB) UpdateContributorInsightsWithContext added in v1.25.43 

func (c *DynamoDB) UpdateContributorInsightsWithContext(ctx aws.Context, input *UpdateContributorInsightsInput, opts ...request.Option) (*UpdateContributorInsightsOutput, error)

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

See UpdateContributorInsights 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 (*DynamoDB) UpdateGlobalTable added in v1.12.36 

func (c *DynamoDB) UpdateGlobalTable(input *UpdateGlobalTableInput) (*UpdateGlobalTableOutput, error)

UpdateGlobalTable API operation for Amazon DynamoDB.

Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.

Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.

If global secondary indexes are specified, then the following conditions must also be met:

  • The global secondary indexes must have the same name.

  • The global secondary indexes must have the same hash key and sort key (if present).

  • The global secondary indexes must have the same provisioned and maximum write capacity units.

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 DynamoDB's API operation UpdateGlobalTable for usage and error information.

Returned Error Types:

  • InternalServerError An error occurred on the server side.

  • GlobalTableNotFoundException The specified global table does not exist.

  • ReplicaAlreadyExistsException The specified replica is already part of the global table.

  • ReplicaNotFoundException The specified replica is no longer part of the global table.

  • TableNotFoundException A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateGlobalTable

func (*DynamoDB) UpdateGlobalTableRequest added in v1.12.36 

func (c *DynamoDB) UpdateGlobalTableRequest(input *UpdateGlobalTableInput) (req *request.Request, output *UpdateGlobalTableOutput)

UpdateGlobalTableRequest generates a "aws/request.Request" representing the client's request for the UpdateGlobalTable 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 UpdateGlobalTable for more information on using the UpdateGlobalTable 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 UpdateGlobalTableRequest method.
req, resp := client.UpdateGlobalTableRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateGlobalTable

func (*DynamoDB) UpdateGlobalTableSettings added in v1.13.39 

func (c *DynamoDB) UpdateGlobalTableSettings(input *UpdateGlobalTableSettingsInput) (*UpdateGlobalTableSettingsOutput, error)

UpdateGlobalTableSettings API operation for Amazon DynamoDB.

Updates settings for a global 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 DynamoDB's API operation UpdateGlobalTableSettings for usage and error information.

Returned Error Types:

  • GlobalTableNotFoundException The specified global table does not exist.

  • ReplicaNotFoundException The specified replica is no longer part of the global table.

  • IndexNotFoundException The operation tried to access a nonexistent index.

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • ResourceInUseException The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateGlobalTableSettings

func (*DynamoDB) UpdateGlobalTableSettingsRequest added in v1.13.39 

func (c *DynamoDB) UpdateGlobalTableSettingsRequest(input *UpdateGlobalTableSettingsInput) (req *request.Request, output *UpdateGlobalTableSettingsOutput)

UpdateGlobalTableSettingsRequest generates a "aws/request.Request" representing the client's request for the UpdateGlobalTableSettings 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 UpdateGlobalTableSettings for more information on using the UpdateGlobalTableSettings 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 UpdateGlobalTableSettingsRequest method.
req, resp := client.UpdateGlobalTableSettingsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateGlobalTableSettings

func (*DynamoDB) UpdateGlobalTableSettingsWithContext added in v1.13.39 

func (c *DynamoDB) UpdateGlobalTableSettingsWithContext(ctx aws.Context, input *UpdateGlobalTableSettingsInput, opts ...request.Option) (*UpdateGlobalTableSettingsOutput, error)

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

See UpdateGlobalTableSettings 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 (*DynamoDB) UpdateGlobalTableWithContext added in v1.12.36 

func (c *DynamoDB) UpdateGlobalTableWithContext(ctx aws.Context, input *UpdateGlobalTableInput, opts ...request.Option) (*UpdateGlobalTableOutput, error)

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

See UpdateGlobalTable 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 (*DynamoDB) UpdateItem 

func (c *DynamoDB) UpdateItem(input *UpdateItemInput) (*UpdateItemOutput, error)

UpdateItem API operation for Amazon DynamoDB.

Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).

You can also return the item's attribute values in the same UpdateItem operation using the ReturnValues parameter.

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 DynamoDB's API operation UpdateItem for usage and error information.

Returned Error Types:

  • ConditionalCheckFailedException A condition specified in the operation could not be evaluated.

  • ProvisionedThroughputExceededException Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the Amazon DynamoDB Developer Guide.

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

  • ItemCollectionSizeLimitExceededException An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

  • TransactionConflictException Operation was rejected because there is an ongoing transaction for the item.

  • RequestLimitExceeded Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support (https://aws.amazon.com/support) to request a quota increase.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateItem

Example (Shared00)

To update an item in a table

This example updates an item in the Music table. It adds a new attribute (Year) and modifies the AlbumTitle attribute. All of the attributes in the item, as they appear after the update, are returned in the response. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
	svc := dynamodb.New(session.New())
	input := &dynamodb.UpdateItemInput{
		ExpressionAttributeNames: map[string]*string{
			"#AT": aws.String("AlbumTitle"),
			"#Y":  aws.String("Year"),
		},
		ExpressionAttributeValues: map[string]*dynamodb.AttributeValue{
			":t": {
				S: aws.String("Louder Than Ever"),
			},
			":y": {
				N: aws.String("2015"),
			},
		},
		Key: map[string]*dynamodb.AttributeValue{
			"Artist": {
				S: aws.String("Acme Band"),
			},
			"SongTitle": {
				S: aws.String("Happy Day"),
			},
		},
		ReturnValues:     aws.String("ALL_NEW"),
		TableName:        aws.String("Music"),
		UpdateExpression: aws.String("SET #Y = :y, #AT = :t"),
	}

	result, err := svc.UpdateItem(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodb.ErrCodeConditionalCheckFailedException:
				fmt.Println(dynamodb.ErrCodeConditionalCheckFailedException, aerr.Error())
			case dynamodb.ErrCodeProvisionedThroughputExceededException:
				fmt.Println(dynamodb.ErrCodeProvisionedThroughputExceededException, aerr.Error())
			case dynamodb.ErrCodeResourceNotFoundException:
				fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
			case dynamodb.ErrCodeItemCollectionSizeLimitExceededException:
				fmt.Println(dynamodb.ErrCodeItemCollectionSizeLimitExceededException, aerr.Error())
			case dynamodb.ErrCodeTransactionConflictException:
				fmt.Println(dynamodb.ErrCodeTransactionConflictException, aerr.Error())
			case dynamodb.ErrCodeRequestLimitExceeded:
				fmt.Println(dynamodb.ErrCodeRequestLimitExceeded, aerr.Error())
			case dynamodb.ErrCodeInternalServerError:
				fmt.Println(dynamodb.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDB) UpdateItemRequest 

func (c *DynamoDB) UpdateItemRequest(input *UpdateItemInput) (req *request.Request, output *UpdateItemOutput)

UpdateItemRequest generates a "aws/request.Request" representing the client's request for the UpdateItem 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 UpdateItem for more information on using the UpdateItem 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 UpdateItemRequest method.
req, resp := client.UpdateItemRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateItem

func (*DynamoDB) UpdateItemWithContext added in v1.8.0 

func (c *DynamoDB) UpdateItemWithContext(ctx aws.Context, input *UpdateItemInput, opts ...request.Option) (*UpdateItemOutput, error)

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

See UpdateItem 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 (*DynamoDB) UpdateTable 

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

UpdateTable API operation for Amazon DynamoDB.

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

You can only perform one of the following operations at once:

  • Modify the provisioned throughput settings of the table.

  • Remove a global secondary index from the table.

  • Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations.

UpdateTable is an asynchronous operation; while it is executing, the table status changes from ACTIVE to UPDATING. While it is UPDATING, you cannot issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

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 DynamoDB's API operation UpdateTable for usage and error information.

Returned Error Types:

  • ResourceInUseException The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

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

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateTable

Example (Shared00)

To modify a table's provisioned throughput

This example increases the provisioned read and write capacity on the Music table. 

package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/awserr"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/dynamodb"
)

func main() {
	svc := dynamodb.New(session.New())
	input := &dynamodb.UpdateTableInput{
		ProvisionedThroughput: &dynamodb.ProvisionedThroughput{
			ReadCapacityUnits:  aws.Int64(10),
			WriteCapacityUnits: aws.Int64(10),
		},
		TableName: aws.String("MusicCollection"),
	}

	result, err := svc.UpdateTable(input)
	if err != nil {
		if aerr, ok := err.(awserr.Error); ok {
			switch aerr.Code() {
			case dynamodb.ErrCodeResourceInUseException:
				fmt.Println(dynamodb.ErrCodeResourceInUseException, aerr.Error())
			case dynamodb.ErrCodeResourceNotFoundException:
				fmt.Println(dynamodb.ErrCodeResourceNotFoundException, aerr.Error())
			case dynamodb.ErrCodeLimitExceededException:
				fmt.Println(dynamodb.ErrCodeLimitExceededException, aerr.Error())
			case dynamodb.ErrCodeInternalServerError:
				fmt.Println(dynamodb.ErrCodeInternalServerError, aerr.Error())
			default:
				fmt.Println(aerr.Error())
			}
		} else {
			// Print the error, cast err to awserr.Error to get the Code and
			// Message from an error.
			fmt.Println(err.Error())
		}
		return
	}

	fmt.Println(result)
}

Output:

func (*DynamoDB) UpdateTableReplicaAutoScaling added in v1.25.40 

func (c *DynamoDB) UpdateTableReplicaAutoScaling(input *UpdateTableReplicaAutoScalingInput) (*UpdateTableReplicaAutoScalingOutput, error)

UpdateTableReplicaAutoScaling API operation for Amazon DynamoDB.

Updates auto scaling settings on your global tables at once.

This operation only applies to Version 2019.11.21 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) of global 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 DynamoDB's API operation UpdateTableReplicaAutoScaling for usage and error information.

Returned Error Types:

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

  • ResourceInUseException The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateTableReplicaAutoScaling

func (*DynamoDB) UpdateTableReplicaAutoScalingRequest added in v1.25.40 

func (c *DynamoDB) UpdateTableReplicaAutoScalingRequest(input *UpdateTableReplicaAutoScalingInput) (req *request.Request, output *UpdateTableReplicaAutoScalingOutput)

UpdateTableReplicaAutoScalingRequest generates a "aws/request.Request" representing the client's request for the UpdateTableReplicaAutoScaling 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 UpdateTableReplicaAutoScaling for more information on using the UpdateTableReplicaAutoScaling 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 UpdateTableReplicaAutoScalingRequest method.
req, resp := client.UpdateTableReplicaAutoScalingRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateTableReplicaAutoScaling

func (*DynamoDB) UpdateTableReplicaAutoScalingWithContext added in v1.25.40 

func (c *DynamoDB) UpdateTableReplicaAutoScalingWithContext(ctx aws.Context, input *UpdateTableReplicaAutoScalingInput, opts ...request.Option) (*UpdateTableReplicaAutoScalingOutput, error)

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

See UpdateTableReplicaAutoScaling 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 (*DynamoDB) UpdateTableRequest 

func (c *DynamoDB) 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/dynamodb-2012-08-10/UpdateTable

func (*DynamoDB) UpdateTableWithContext added in v1.8.0 

func (c *DynamoDB) 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.

func (*DynamoDB) UpdateTimeToLive added in v1.7.2 

func (c *DynamoDB) UpdateTimeToLive(input *UpdateTimeToLiveInput) (*UpdateTimeToLiveOutput, error)

UpdateTimeToLive API operation for Amazon DynamoDB.

The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. It can take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException.

TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.

The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.

DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.

DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.

As items are deleted, they are removed from any local secondary index and global secondary index immediately in the same eventually consistent way as a standard delete operation.

For more information, see Time To Live (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html) in the Amazon DynamoDB 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 DynamoDB's API operation UpdateTimeToLive for usage and error information.

Returned Error Types:

  • ResourceInUseException The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

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

  • LimitExceededException There is no limit to the number of daily on-demand backups that can be taken.

    Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

    The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

    There is a soft account quota of 2,500 tables.

  • InternalServerError An error occurred on the server side.

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateTimeToLive

func (*DynamoDB) UpdateTimeToLiveRequest added in v1.7.2 

func (c *DynamoDB) UpdateTimeToLiveRequest(input *UpdateTimeToLiveInput) (req *request.Request, output *UpdateTimeToLiveOutput)

UpdateTimeToLiveRequest generates a "aws/request.Request" representing the client's request for the UpdateTimeToLive 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 UpdateTimeToLive for more information on using the UpdateTimeToLive 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 UpdateTimeToLiveRequest method.
req, resp := client.UpdateTimeToLiveRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateTimeToLive

func (*DynamoDB) UpdateTimeToLiveWithContext added in v1.8.0 

func (c *DynamoDB) UpdateTimeToLiveWithContext(ctx aws.Context, input *UpdateTimeToLiveInput, opts ...request.Option) (*UpdateTimeToLiveOutput, error)

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

See UpdateTimeToLive 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 (*DynamoDB) WaitUntilTableExists added in v0.10.3 

func (c *DynamoDB) WaitUntilTableExists(input *DescribeTableInput) error

WaitUntilTableExists uses the DynamoDB API operation DescribeTable to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*DynamoDB) WaitUntilTableExistsWithContext added in v1.8.0 

func (c *DynamoDB) WaitUntilTableExistsWithContext(ctx aws.Context, input *DescribeTableInput, opts ...request.WaiterOption) error

WaitUntilTableExistsWithContext is an extended version of WaitUntilTableExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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 (*DynamoDB) WaitUntilTableNotExists added in v0.10.3 

func (c *DynamoDB) WaitUntilTableNotExists(input *DescribeTableInput) error

WaitUntilTableNotExists uses the DynamoDB API operation DescribeTable to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*DynamoDB) WaitUntilTableNotExistsWithContext added in v1.8.0 

func (c *DynamoDB) WaitUntilTableNotExistsWithContext(ctx aws.Context, input *DescribeTableInput, opts ...request.WaiterOption) error

WaitUntilTableNotExistsWithContext is an extended version of WaitUntilTableNotExists. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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 EnableKinesisStreamingDestinationInput added in v1.35.34 

type EnableKinesisStreamingDestinationInput struct {

	// The ARN for a Kinesis data stream.
	//
	// StreamArn is a required field
	StreamArn *string `min:"37" type:"string" required:"true"`

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

func (EnableKinesisStreamingDestinationInput) GoString added in v1.35.34 

func (s EnableKinesisStreamingDestinationInput) 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 (*EnableKinesisStreamingDestinationInput) SetStreamArn added in v1.35.34 

func (s *EnableKinesisStreamingDestinationInput) SetStreamArn(v string) *EnableKinesisStreamingDestinationInput

SetStreamArn sets the StreamArn field's value.

func (*EnableKinesisStreamingDestinationInput) SetTableName added in v1.35.34 

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

SetTableName sets the TableName field's value.

func (EnableKinesisStreamingDestinationInput) String added in v1.35.34 

func (s EnableKinesisStreamingDestinationInput) 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 (*EnableKinesisStreamingDestinationInput) Validate added in v1.35.34 

func (s *EnableKinesisStreamingDestinationInput) Validate() error

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

type EnableKinesisStreamingDestinationOutput added in v1.35.34 

type EnableKinesisStreamingDestinationOutput struct {

	// The current status of the replication.
	DestinationStatus *string `type:"string" enum:"DestinationStatus"`

	// The ARN for the specific Kinesis data stream.
	StreamArn *string `min:"37" type:"string"`

	// The name of the table being modified.
	TableName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

func (EnableKinesisStreamingDestinationOutput) GoString added in v1.35.34 

func (s EnableKinesisStreamingDestinationOutput) 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 (*EnableKinesisStreamingDestinationOutput) SetDestinationStatus added in v1.35.34 

func (s *EnableKinesisStreamingDestinationOutput) SetDestinationStatus(v string) *EnableKinesisStreamingDestinationOutput

SetDestinationStatus sets the DestinationStatus field's value.

func (*EnableKinesisStreamingDestinationOutput) SetStreamArn added in v1.35.34 

func (s *EnableKinesisStreamingDestinationOutput) SetStreamArn(v string) *EnableKinesisStreamingDestinationOutput

SetStreamArn sets the StreamArn field's value.

func (*EnableKinesisStreamingDestinationOutput) SetTableName added in v1.35.34 

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

SetTableName sets the TableName field's value.

func (EnableKinesisStreamingDestinationOutput) String added in v1.35.34 

func (s EnableKinesisStreamingDestinationOutput) 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 Endpoint added in v1.15.28 

type Endpoint struct {

	// IP address of the endpoint.
	//
	// Address is a required field
	Address *string `type:"string" required:"true"`

	// Endpoint cache time to live (TTL) value.
	//
	// CachePeriodInMinutes is a required field
	CachePeriodInMinutes *int64 `type:"long" required:"true"`
	// contains filtered or unexported fields
}

An endpoint information details.

func (Endpoint) GoString added in v1.15.28 

func (s Endpoint) 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 (*Endpoint) SetAddress added in v1.15.28 

func (s *Endpoint) SetAddress(v string) *Endpoint

SetAddress sets the Address field's value.

func (*Endpoint) SetCachePeriodInMinutes added in v1.15.28 

func (s *Endpoint) SetCachePeriodInMinutes(v int64) *Endpoint

SetCachePeriodInMinutes sets the CachePeriodInMinutes field's value.

func (Endpoint) String added in v1.15.28 

func (s Endpoint) 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 ExecuteStatementInput added in v1.35.34 

type ExecuteStatementInput struct {

	// The consistency of a read operation. If set to true, then a strongly consistent
	// read is used; otherwise, an eventually consistent read is used.
	ConsistentRead *bool `type:"boolean"`

	// The maximum number of items to evaluate (not necessarily the number of matching
	// items). If DynamoDB processes the number of items up to the limit while processing
	// the results, it stops the operation and returns the matching values up to
	// that point, along with a key in LastEvaluatedKey to apply in a subsequent
	// operation so you can pick up where you left off. Also, if the processed dataset
	// size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation
	// and returns the matching values up to the limit, and a key in LastEvaluatedKey
	// to apply in a subsequent operation to continue the operation.
	Limit *int64 `min:"1" type:"integer"`

	// Set this value to get remaining results, if NextToken was returned in the
	// statement response.
	NextToken *string `min:"1" type:"string"`

	// The parameters for the PartiQL statement, if any.
	Parameters []*AttributeValue `min:"1" type:"list"`

	// Determines the level of detail about either provisioned or on-demand throughput
	// consumption that is returned in the response:
	//
	//    * INDEXES - The response includes the aggregate ConsumedCapacity for the
	//    operation, together with ConsumedCapacity for each table and secondary
	//    index that was accessed. Note that some operations, such as GetItem and
	//    BatchGetItem, do not access any indexes at all. In these cases, specifying
	//    INDEXES will only return ConsumedCapacity information for table(s).
	//
	//    * TOTAL - The response includes only the aggregate ConsumedCapacity for
	//    the operation.
	//
	//    * NONE - No ConsumedCapacity details are included in the response.
	ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"`

	// The PartiQL statement representing the operation to run.
	//
	// Statement is a required field
	Statement *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ExecuteStatementInput) GoString added in v1.35.34 

func (s ExecuteStatementInput) 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 (*ExecuteStatementInput) SetConsistentRead added in v1.35.34 

func (s *ExecuteStatementInput) SetConsistentRead(v bool) *ExecuteStatementInput

SetConsistentRead sets the ConsistentRead field's value.

func (*ExecuteStatementInput) SetLimit added in v1.43.3 

func (s *ExecuteStatementInput) SetLimit(v int64) *ExecuteStatementInput

SetLimit sets the Limit field's value.

func (*ExecuteStatementInput) SetNextToken added in v1.35.34 

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

SetNextToken sets the NextToken field's value.

func (*ExecuteStatementInput) SetParameters added in v1.35.34 

func (s *ExecuteStatementInput) SetParameters(v []*AttributeValue) *ExecuteStatementInput

SetParameters sets the Parameters field's value.

func (*ExecuteStatementInput) SetReturnConsumedCapacity added in v1.42.11 

func (s *ExecuteStatementInput) SetReturnConsumedCapacity(v string) *ExecuteStatementInput

SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.

func (*ExecuteStatementInput) SetStatement added in v1.35.34 

func (s *ExecuteStatementInput) SetStatement(v string) *ExecuteStatementInput

SetStatement sets the Statement field's value.

func (ExecuteStatementInput) String added in v1.35.34 

func (s ExecuteStatementInput) 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 (*ExecuteStatementInput) Validate added in v1.35.34 

func (s *ExecuteStatementInput) Validate() error

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

type ExecuteStatementOutput added in v1.35.34 

type ExecuteStatementOutput struct {

	// The capacity units consumed by an operation. The data returned includes the
	// total provisioned throughput consumed, along with statistics for the table
	// and any indexes involved in the operation. ConsumedCapacity is only returned
	// if the request asked for it. For more information, see Provisioned Throughput
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
	// in the Amazon DynamoDB Developer Guide.
	ConsumedCapacity *ConsumedCapacity `type:"structure"`

	// If a read operation was used, this property will contain the result of the
	// read operation; a map of attribute names and their values. For the write
	// operations this value will be empty.
	Items []map[string]*AttributeValue `type:"list"`

	// The primary key of the item where the operation stopped, inclusive of the
	// previous result set. Use this value to start a new operation, excluding this
	// value in the new request. If LastEvaluatedKey is empty, then the "last page"
	// of results has been processed and there is no more data to be retrieved.
	// If LastEvaluatedKey is not empty, it does not necessarily mean that there
	// is more data in the result set. The only way to know when you have reached
	// the end of the result set is when LastEvaluatedKey is empty.
	LastEvaluatedKey map[string]*AttributeValue `type:"map"`

	// If the response of a read request exceeds the response payload limit DynamoDB
	// will set this value in the response. If set, you can use that this value
	// in the subsequent request to get the remaining results.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ExecuteStatementOutput) GoString added in v1.35.34 

func (s ExecuteStatementOutput) 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 (*ExecuteStatementOutput) SetConsumedCapacity added in v1.42.11 

func (s *ExecuteStatementOutput) SetConsumedCapacity(v *ConsumedCapacity) *ExecuteStatementOutput

SetConsumedCapacity sets the ConsumedCapacity field's value.

func (*ExecuteStatementOutput) SetItems added in v1.35.34 

func (s *ExecuteStatementOutput) SetItems(v []map[string]*AttributeValue) *ExecuteStatementOutput

SetItems sets the Items field's value.

func (*ExecuteStatementOutput) SetLastEvaluatedKey added in v1.43.3 

func (s *ExecuteStatementOutput) SetLastEvaluatedKey(v map[string]*AttributeValue) *ExecuteStatementOutput

SetLastEvaluatedKey sets the LastEvaluatedKey field's value.

func (*ExecuteStatementOutput) SetNextToken added in v1.35.34 

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

SetNextToken sets the NextToken field's value.

func (ExecuteStatementOutput) String added in v1.35.34 

func (s ExecuteStatementOutput) 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 ExecuteTransactionInput added in v1.35.34 

type ExecuteTransactionInput struct {

	// Set this value to get remaining results, if NextToken was returned in the
	// statement response.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// Determines the level of detail about either provisioned or on-demand throughput
	// consumption that is returned in the response. For more information, see TransactGetItems
	// (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html)
	// and TransactWriteItems (https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html).
	ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"`

	// The list of PartiQL statements representing the transaction to run.
	//
	// TransactStatements is a required field
	TransactStatements []*ParameterizedStatement `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ExecuteTransactionInput) GoString added in v1.35.34 

func (s ExecuteTransactionInput) 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 (*ExecuteTransactionInput) SetClientRequestToken added in v1.35.34 

func (s *ExecuteTransactionInput) SetClientRequestToken(v string) *ExecuteTransactionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*ExecuteTransactionInput) SetReturnConsumedCapacity added in v1.42.11 

func (s *ExecuteTransactionInput) SetReturnConsumedCapacity(v string) *ExecuteTransactionInput

SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.

func (*ExecuteTransactionInput) SetTransactStatements added in v1.35.34 

func (s *ExecuteTransactionInput) SetTransactStatements(v []*ParameterizedStatement) *ExecuteTransactionInput

SetTransactStatements sets the TransactStatements field's value.

func (ExecuteTransactionInput) String added in v1.35.34 

func (s ExecuteTransactionInput) 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 (*ExecuteTransactionInput) Validate added in v1.35.34 

func (s *ExecuteTransactionInput) Validate() error

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

type ExecuteTransactionOutput added in v1.35.34 

type ExecuteTransactionOutput struct {

	// The capacity units consumed by the entire operation. The values of the list
	// are ordered according to the ordering of the statements.
	ConsumedCapacity []*ConsumedCapacity `type:"list"`

	// The response to a PartiQL transaction.
	Responses []*ItemResponse `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ExecuteTransactionOutput) GoString added in v1.35.34 

func (s ExecuteTransactionOutput) 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 (*ExecuteTransactionOutput) SetConsumedCapacity added in v1.42.11 

func (s *ExecuteTransactionOutput) SetConsumedCapacity(v []*ConsumedCapacity) *ExecuteTransactionOutput

SetConsumedCapacity sets the ConsumedCapacity field's value.

func (*ExecuteTransactionOutput) SetResponses added in v1.35.34 

func (s *ExecuteTransactionOutput) SetResponses(v []*ItemResponse) *ExecuteTransactionOutput

SetResponses sets the Responses field's value.

func (ExecuteTransactionOutput) String added in v1.35.34 

func (s ExecuteTransactionOutput) 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 ExpectedAttributeValue 

type ExpectedAttributeValue struct {

	// One or more values to evaluate against the supplied attribute. The number
	// of values in the list depends on the ComparisonOperator being used.
	//
	// For type Number, value comparisons are numeric.
	//
	// String value comparisons for greater than, equals, or less than are based
	// on ASCII character code values. For example, a is greater than A, and a is
	// greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters
	// (http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters).
	//
	// For Binary, DynamoDB treats each byte of the binary data as unsigned when
	// it compares binary values.
	//
	// For information on specifying data types in JSON, see JSON Data Format (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataFormat.html)
	// in the Amazon DynamoDB Developer Guide.
	AttributeValueList []*AttributeValue `type:"list"`

	// A comparator for evaluating attributes in the AttributeValueList. For example,
	// equals, greater than, less than, etc.
	//
	// The following comparison operators are available:
	//
	// EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS |
	// BEGINS_WITH | IN | BETWEEN
	//
	// The following are descriptions of each comparison operator.
	//
	//    * EQ : Equal. EQ is supported for all data types, including lists and
	//    maps. AttributeValueList can contain only one AttributeValue element of
	//    type String, Number, Binary, String Set, Number Set, or Binary Set. If
	//    an item contains an AttributeValue element of a different type than the
	//    one provided in the request, the value does not match. For example, {"S":"6"}
	//    does not equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2",
	//    "1"]}.
	//
	//    * NE : Not equal. NE is supported for all data types, including lists
	//    and maps. AttributeValueList can contain only one AttributeValue of type
	//    String, Number, Binary, String Set, Number Set, or Binary Set. If an item
	//    contains an AttributeValue of a different type than the one provided in
	//    the request, the value does not match. For example, {"S":"6"} does not
	//    equal {"N":"6"}. Also, {"N":"6"} does not equal {"NS":["6", "2", "1"]}.
	//
	//    * LE : Less than or equal. AttributeValueList can contain only one AttributeValue
	//    element of type String, Number, or Binary (not a set type). If an item
	//    contains an AttributeValue element of a different type than the one provided
	//    in the request, the value does not match. For example, {"S":"6"} does
	//    not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
	//    "1"]}.
	//
	//    * LT : Less than. AttributeValueList can contain only one AttributeValue
	//    of type String, Number, or Binary (not a set type). If an item contains
	//    an AttributeValue element of a different type than the one provided in
	//    the request, the value does not match. For example, {"S":"6"} does not
	//    equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
	//    "1"]}.
	//
	//    * GE : Greater than or equal. AttributeValueList can contain only one
	//    AttributeValue element of type String, Number, or Binary (not a set type).
	//    If an item contains an AttributeValue element of a different type than
	//    the one provided in the request, the value does not match. For example,
	//    {"S":"6"} does not equal {"N":"6"}. Also, {"N":"6"} does not compare to
	//    {"NS":["6", "2", "1"]}.
	//
	//    * GT : Greater than. AttributeValueList can contain only one AttributeValue
	//    element of type String, Number, or Binary (not a set type). If an item
	//    contains an AttributeValue element of a different type than the one provided
	//    in the request, the value does not match. For example, {"S":"6"} does
	//    not equal {"N":"6"}. Also, {"N":"6"} does not compare to {"NS":["6", "2",
	//    "1"]}.
	//
	//    * NOT_NULL : The attribute exists. NOT_NULL is supported for all data
	//    types, including lists and maps. This operator tests for the existence
	//    of an attribute, not its data type. If the data type of attribute "a"
	//    is null, and you evaluate it using NOT_NULL, the result is a Boolean true.
	//    This result is because the attribute "a" exists; its data type is not
	//    relevant to the NOT_NULL comparison operator.
	//
	//    * NULL : The attribute does not exist. NULL is supported for all data
	//    types, including lists and maps. This operator tests for the nonexistence
	//    of an attribute, not its data type. If the data type of attribute "a"
	//    is null, and you evaluate it using NULL, the result is a Boolean false.
	//    This is because the attribute "a" exists; its data type is not relevant
	//    to the NULL comparison operator.
	//
	//    * CONTAINS : Checks for a subsequence, or value in a set. AttributeValueList
	//    can contain only one AttributeValue element of type String, Number, or
	//    Binary (not a set type). If the target attribute of the comparison is
	//    of type String, then the operator checks for a substring match. If the
	//    target attribute of the comparison is of type Binary, then the operator
	//    looks for a subsequence of the target that matches the input. If the target
	//    attribute of the comparison is a set ("SS", "NS", or "BS"), then the operator
	//    evaluates to true if it finds an exact match with any member of the set.
	//    CONTAINS is supported for lists: When evaluating "a CONTAINS b", "a" can
	//    be a list; however, "b" cannot be a set, a map, or a list.
	//
	//    * NOT_CONTAINS : Checks for absence of a subsequence, or absence of a
	//    value in a set. AttributeValueList can contain only one AttributeValue
	//    element of type String, Number, or Binary (not a set type). If the target
	//    attribute of the comparison is a String, then the operator checks for
	//    the absence of a substring match. If the target attribute of the comparison
	//    is Binary, then the operator checks for the absence of a subsequence of
	//    the target that matches the input. If the target attribute of the comparison
	//    is a set ("SS", "NS", or "BS"), then the operator evaluates to true if
	//    it does not find an exact match with any member of the set. NOT_CONTAINS
	//    is supported for lists: When evaluating "a NOT CONTAINS b", "a" can be
	//    a list; however, "b" cannot be a set, a map, or a list.
	//
	//    * BEGINS_WITH : Checks for a prefix. AttributeValueList can contain only
	//    one AttributeValue of type String or Binary (not a Number or a set type).
	//    The target attribute of the comparison must be of type String or Binary
	//    (not a Number or a set type).
	//
	//    * IN : Checks for matching elements in a list. AttributeValueList can
	//    contain one or more AttributeValue elements of type String, Number, or
	//    Binary. These attributes are compared against an existing attribute of
	//    an item. If any elements of the input are equal to the item attribute,
	//    the expression evaluates to true.
	//
	//    * BETWEEN : Greater than or equal to the first value, and less than or
	//    equal to the second value. AttributeValueList must contain two AttributeValue
	//    elements of the same type, either String, Number, or Binary (not a set
	//    type). A target attribute matches if the target value is greater than,
	//    or equal to, the first element and less than, or equal to, the second
	//    element. If an item contains an AttributeValue element of a different
	//    type than the one provided in the request, the value does not match. For
	//    example, {"S":"6"} does not compare to {"N":"6"}. Also, {"N":"6"} does
	//    not compare to {"NS":["6", "2", "1"]}
	ComparisonOperator *string `type:"string" enum:"ComparisonOperator"`

	// Causes DynamoDB to evaluate the value before attempting a conditional operation:
	//
	//    * If Exists is true, DynamoDB will check to see if that attribute value
	//    already exists in the table. If it is found, then the operation succeeds.
	//    If it is not found, the operation fails with a ConditionCheckFailedException.
	//
	//    * If Exists is false, DynamoDB assumes that the attribute value does not
	//    exist in the table. If in fact the value does not exist, then the assumption
	//    is valid and the operation succeeds. If the value is found, despite the
	//    assumption that it does not exist, the operation fails with a ConditionCheckFailedException.
	//
	// The default setting for Exists is true. If you supply a Value all by itself,
	// DynamoDB assumes the attribute exists: You don't have to set Exists to true,
	// because it is implied.
	//
	// DynamoDB returns a ValidationException if:
	//
	//    * Exists is true but there is no Value to check. (You expect a value to
	//    exist, but don't specify what that value is.)
	//
	//    * Exists is false but you also provide a Value. (You cannot expect an
	//    attribute to have a value, while also expecting it not to exist.)
	Exists *bool `type:"boolean"`

	// Represents the data for the expected attribute.
	//
	// Each attribute value is described as a name-value pair. The name is the data
	// type, and the value is the data itself.
	//
	// For more information, see Data Types (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes)
	// in the Amazon DynamoDB Developer Guide.
	Value *AttributeValue `type:"structure"`
	// contains filtered or unexported fields
}

Represents a condition to be compared with an attribute value. This condition can be used with DeleteItem, PutItem, or UpdateItem operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can use ExpectedAttributeValue in one of two different ways:

  • Use AttributeValueList to specify one or more values to compare against an attribute. Use ComparisonOperator to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds.

  • Use Value to specify a value that DynamoDB will compare against an attribute. If the values match, then ExpectedAttributeValue evaluates to true and the conditional operation succeeds. Optionally, you can also set Exists to false, indicating that you do not expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false.

Value and Exists are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.

func (ExpectedAttributeValue) GoString added in v0.6.5 

func (s ExpectedAttributeValue) 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 (*ExpectedAttributeValue) SetAttributeValueList added in v1.5.0 

func (s *ExpectedAttributeValue) SetAttributeValueList(v []*AttributeValue) *ExpectedAttributeValue

SetAttributeValueList sets the AttributeValueList field's value.

func (*ExpectedAttributeValue) SetComparisonOperator added in v1.5.0 

func (s *ExpectedAttributeValue) SetComparisonOperator(v string) *ExpectedAttributeValue

SetComparisonOperator sets the ComparisonOperator field's value.

func (*ExpectedAttributeValue) SetExists added in v1.5.0 

func (s *ExpectedAttributeValue) SetExists(v bool) *ExpectedAttributeValue

SetExists sets the Exists field's value.

func (*ExpectedAttributeValue) SetValue added in v1.5.0 

func (s *ExpectedAttributeValue) SetValue(v *AttributeValue) *ExpectedAttributeValue

SetValue sets the Value field's value.

func (ExpectedAttributeValue) String added in v0.6.5 

func (s ExpectedAttributeValue) 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 ExportConflictException added in v1.35.24 

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

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

There was a conflict when writing to the specified S3 bucket.

func (*ExportConflictException) Code added in v1.35.24 

func (s *ExportConflictException) Code() string

Code returns the exception type name.

func (*ExportConflictException) Error added in v1.35.24 

func (s *ExportConflictException) Error() string

func (ExportConflictException) GoString added in v1.35.24 

func (s ExportConflictException) 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 (*ExportConflictException) Message added in v1.35.24 

func (s *ExportConflictException) Message() string

Message returns the exception's message.

func (*ExportConflictException) OrigErr added in v1.35.24 

func (s *ExportConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ExportConflictException) RequestID added in v1.35.24 

func (s *ExportConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ExportConflictException) StatusCode added in v1.35.24 

func (s *ExportConflictException) StatusCode() int

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

func (ExportConflictException) String added in v1.35.24 

func (s ExportConflictException) 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 ExportDescription added in v1.35.24 

type ExportDescription struct {

	// The billable size of the table export.
	BilledSizeBytes *int64 `type:"long"`

	// The client token that was provided for the export task. A client token makes
	// calls to ExportTableToPointInTimeInput idempotent, meaning that multiple
	// identical calls have the same effect as one single call.
	ClientToken *string `type:"string"`

	// The time at which the export task completed.
	EndTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the table export.
	ExportArn *string `min:"37" type:"string"`

	// The format of the exported data. Valid values for ExportFormat are DYNAMODB_JSON
	// or ION.
	ExportFormat *string `type:"string" enum:"ExportFormat"`

	// The name of the manifest file for the export task.
	ExportManifest *string `type:"string"`

	// Export can be in one of the following states: IN_PROGRESS, COMPLETED, or
	// FAILED.
	ExportStatus *string `type:"string" enum:"ExportStatus"`

	// Point in time from which table data was exported.
	ExportTime *time.Time `type:"timestamp"`

	// Status code for the result of the failed export.
	FailureCode *string `type:"string"`

	// Export failure reason description.
	FailureMessage *string `type:"string"`

	// The number of items exported.
	ItemCount *int64 `type:"long"`

	// The name of the Amazon S3 bucket containing the export.
	S3Bucket *string `type:"string"`

	// The ID of the Amazon Web Services account that owns the bucket containing
	// the export.
	S3BucketOwner *string `type:"string"`

	// The Amazon S3 bucket prefix used as the file name and path of the exported
	// snapshot.
	S3Prefix *string `type:"string"`

	// Type of encryption used on the bucket where export data is stored. Valid
	// values for S3SseAlgorithm are:
	//
	//    * AES256 - server-side encryption with Amazon S3 managed keys
	//
	//    * KMS - server-side encryption with KMS managed keys
	S3SseAlgorithm *string `type:"string" enum:"S3SseAlgorithm"`

	// The ID of the KMS managed key used to encrypt the S3 bucket where export
	// data is stored (if applicable).
	S3SseKmsKeyId *string `min:"1" type:"string"`

	// The time at which the export task began.
	StartTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the table that was exported.
	TableArn *string `type:"string"`

	// Unique ID of the table that was exported.
	TableId *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the properties of the exported table.

func (ExportDescription) GoString added in v1.35.24 

func (s ExportDescription) 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 (*ExportDescription) SetBilledSizeBytes added in v1.35.24 

func (s *ExportDescription) SetBilledSizeBytes(v int64) *ExportDescription

SetBilledSizeBytes sets the BilledSizeBytes field's value.

func (*ExportDescription) SetClientToken added in v1.35.24 

func (s *ExportDescription) SetClientToken(v string) *ExportDescription

SetClientToken sets the ClientToken field's value.

func (*ExportDescription) SetEndTime added in v1.35.24 

func (s *ExportDescription) SetEndTime(v time.Time) *ExportDescription

SetEndTime sets the EndTime field's value.

func (*ExportDescription) SetExportArn added in v1.35.24 

func (s *ExportDescription) SetExportArn(v string) *ExportDescription

SetExportArn sets the ExportArn field's value.

func (*ExportDescription) SetExportFormat added in v1.35.24 

func (s *ExportDescription) SetExportFormat(v string) *ExportDescription

SetExportFormat sets the ExportFormat field's value.

func (*ExportDescription) SetExportManifest added in v1.35.24 

func (s *ExportDescription) SetExportManifest(v string) *ExportDescription

SetExportManifest sets the ExportManifest field's value.

func (*ExportDescription) SetExportStatus added in v1.35.24 

func (s *ExportDescription) SetExportStatus(v string) *ExportDescription

SetExportStatus sets the ExportStatus field's value.

func (*ExportDescription) SetExportTime added in v1.35.24 

func (s *ExportDescription) SetExportTime(v time.Time) *ExportDescription

SetExportTime sets the ExportTime field's value.

func (*ExportDescription) SetFailureCode added in v1.35.24 

func (s *ExportDescription) SetFailureCode(v string) *ExportDescription

SetFailureCode sets the FailureCode field's value.

func (*ExportDescription) SetFailureMessage added in v1.35.24 

func (s *ExportDescription) SetFailureMessage(v string) *ExportDescription

SetFailureMessage sets the FailureMessage field's value.

func (*ExportDescription) SetItemCount added in v1.35.24 

func (s *ExportDescription) SetItemCount(v int64) *ExportDescription

SetItemCount sets the ItemCount field's value.

func (*ExportDescription) SetS3Bucket added in v1.35.24 

func (s *ExportDescription) SetS3Bucket(v string) *ExportDescription

SetS3Bucket sets the S3Bucket field's value.

func (*ExportDescription) SetS3BucketOwner added in v1.35.24 

func (s *ExportDescription) SetS3BucketOwner(v string) *ExportDescription

SetS3BucketOwner sets the S3BucketOwner field's value.

func (*ExportDescription) SetS3Prefix added in v1.35.24 

func (s *ExportDescription) SetS3Prefix(v string) *ExportDescription

SetS3Prefix sets the S3Prefix field's value.

func (*ExportDescription) SetS3SseAlgorithm added in v1.35.24 

func (s *ExportDescription) SetS3SseAlgorithm(v string) *ExportDescription

SetS3SseAlgorithm sets the S3SseAlgorithm field's value.

func (*ExportDescription) SetS3SseKmsKeyId added in v1.35.24 

func (s *ExportDescription) SetS3SseKmsKeyId(v string) *ExportDescription

SetS3SseKmsKeyId sets the S3SseKmsKeyId field's value.

func (*ExportDescription) SetStartTime added in v1.35.24 

func (s *ExportDescription) SetStartTime(v time.Time) *ExportDescription

SetStartTime sets the StartTime field's value.

func (*ExportDescription) SetTableArn added in v1.35.24 

func (s *ExportDescription) SetTableArn(v string) *ExportDescription

SetTableArn sets the TableArn field's value.

func (*ExportDescription) SetTableId added in v1.35.24 

func (s *ExportDescription) SetTableId(v string) *ExportDescription

SetTableId sets the TableId field's value.

func (ExportDescription) String added in v1.35.24 

func (s ExportDescription) 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 ExportNotFoundException added in v1.35.24 

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

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

The specified export was not found.

func (*ExportNotFoundException) Code added in v1.35.24 

func (s *ExportNotFoundException) Code() string

Code returns the exception type name.

func (*ExportNotFoundException) Error added in v1.35.24 

func (s *ExportNotFoundException) Error() string

func (ExportNotFoundException) GoString added in v1.35.24 

func (s ExportNotFoundException) 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 (*ExportNotFoundException) Message added in v1.35.24 

func (s *ExportNotFoundException) Message() string

Message returns the exception's message.

func (*ExportNotFoundException) OrigErr added in v1.35.24 

func (s *ExportNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ExportNotFoundException) RequestID added in v1.35.24 

func (s *ExportNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ExportNotFoundException) StatusCode added in v1.35.24 

func (s *ExportNotFoundException) StatusCode() int

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

func (ExportNotFoundException) String added in v1.35.24 

func (s ExportNotFoundException) 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 ExportSummary added in v1.35.24 

type ExportSummary struct {

	// The Amazon Resource Name (ARN) of the export.
	ExportArn *string `min:"37" type:"string"`

	// Export can be in one of the following states: IN_PROGRESS, COMPLETED, or
	// FAILED.
	ExportStatus *string `type:"string" enum:"ExportStatus"`
	// contains filtered or unexported fields
}

Summary information about an export task.

func (ExportSummary) GoString added in v1.35.24 

func (s ExportSummary) 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 (*ExportSummary) SetExportArn added in v1.35.24 

func (s *ExportSummary) SetExportArn(v string) *ExportSummary

SetExportArn sets the ExportArn field's value.

func (*ExportSummary) SetExportStatus added in v1.35.24 

func (s *ExportSummary) SetExportStatus(v string) *ExportSummary

SetExportStatus sets the ExportStatus field's value.

func (ExportSummary) String added in v1.35.24 

func (s ExportSummary) 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 ExportTableToPointInTimeInput added in v1.35.24 

type ExportTableToPointInTimeInput struct {

	// Providing a ClientToken makes the call to ExportTableToPointInTimeInput idempotent,
	// meaning that multiple identical calls have the same effect as one single
	// call.
	//
	// A client token is valid for 8 hours after the first request that uses it
	// is completed. After 8 hours, any request with the same client token is treated
	// as a new request. Do not resubmit the same request with the same client token
	// for more than 8 hours, or the result might not be idempotent.
	//
	// If you submit a request with the same client token but a change in other
	// parameters within the 8-hour idempotency window, DynamoDB returns an IdempotentParameterMismatch
	// exception.
	ClientToken *string `type:"string" idempotencyToken:"true"`

	// The format for the exported data. Valid values for ExportFormat are DYNAMODB_JSON
	// or ION.
	ExportFormat *string `type:"string" enum:"ExportFormat"`

	// Time in the past from which to export table data, counted in seconds from
	// the start of the Unix epoch. The table export will be a snapshot of the table's
	// state at this point in time.
	ExportTime *time.Time `type:"timestamp"`

	// The name of the Amazon S3 bucket to export the snapshot to.
	//
	// S3Bucket is a required field
	S3Bucket *string `type:"string" required:"true"`

	// The ID of the Amazon Web Services account that owns the bucket the export
	// will be stored in.
	S3BucketOwner *string `type:"string"`

	// The Amazon S3 bucket prefix to use as the file name and path of the exported
	// snapshot.
	S3Prefix *string `type:"string"`

	// Type of encryption used on the bucket where export data will be stored. Valid
	// values for S3SseAlgorithm are:
	//
	//    * AES256 - server-side encryption with Amazon S3 managed keys
	//
	//    * KMS - server-side encryption with KMS managed keys
	S3SseAlgorithm *string `type:"string" enum:"S3SseAlgorithm"`

	// The ID of the KMS managed key used to encrypt the S3 bucket where export
	// data will be stored (if applicable).
	S3SseKmsKeyId *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) associated with the table to export.
	//
	// TableArn is a required field
	TableArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ExportTableToPointInTimeInput) GoString added in v1.35.24 

func (s ExportTableToPointInTimeInput) 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 (*ExportTableToPointInTimeInput) SetClientToken added in v1.35.24 

func (s *ExportTableToPointInTimeInput) SetClientToken(v string) *ExportTableToPointInTimeInput

SetClientToken sets the ClientToken field's value.

func (*ExportTableToPointInTimeInput) SetExportFormat added in v1.35.24 

func (s *ExportTableToPointInTimeInput) SetExportFormat(v string) *ExportTableToPointInTimeInput

SetExportFormat sets the ExportFormat field's value.

func (*ExportTableToPointInTimeInput) SetExportTime added in v1.35.24 

func (s *ExportTableToPointInTimeInput) SetExportTime(v time.Time) *ExportTableToPointInTimeInput

SetExportTime sets the ExportTime field's value.

func (*ExportTableToPointInTimeInput) SetS3Bucket added in v1.35.24 

func (s *ExportTableToPointInTimeInput) SetS3Bucket(v string) *ExportTableToPointInTimeInput

SetS3Bucket sets the S3Bucket field's value.

func (*ExportTableToPointInTimeInput) SetS3BucketOwner added in v1.35.24 

func (s *ExportTableToPointInTimeInput) SetS3BucketOwner(v string) *ExportTableToPointInTimeInput

SetS3BucketOwner sets the S3BucketOwner field's value.

func (*ExportTableToPointInTimeInput) SetS3Prefix added in v1.35.24 

func (s *ExportTableToPointInTimeInput) SetS3Prefix(v string) *ExportTableToPointInTimeInput

SetS3Prefix sets the S3Prefix field's value.

func (*ExportTableToPointInTimeInput) SetS3SseAlgorithm added in v1.35.24 

func (s *ExportTableToPointInTimeInput) SetS3SseAlgorithm(v string) *ExportTableToPointInTimeInput

SetS3SseAlgorithm sets the S3SseAlgorithm field's value.

func (*ExportTableToPointInTimeInput) SetS3SseKmsKeyId added in v1.35.24 

func (s *ExportTableToPointInTimeInput) SetS3SseKmsKeyId(v string) *ExportTableToPointInTimeInput

SetS3SseKmsKeyId sets the S3SseKmsKeyId field's value.

func (*ExportTableToPointInTimeInput) SetTableArn added in v1.35.24 

func (s *ExportTableToPointInTimeInput) SetTableArn(v string) *ExportTableToPointInTimeInput

SetTableArn sets the TableArn field's value.

func (ExportTableToPointInTimeInput) String added in v1.35.24 

func (s ExportTableToPointInTimeInput) 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 (*ExportTableToPointInTimeInput) Validate added in v1.35.24 

func (s *ExportTableToPointInTimeInput) Validate() error

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

type ExportTableToPointInTimeOutput added in v1.35.24 

type ExportTableToPointInTimeOutput struct {

	// Contains a description of the table export.
	ExportDescription *ExportDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (ExportTableToPointInTimeOutput) GoString added in v1.35.24 

func (s ExportTableToPointInTimeOutput) 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 (*ExportTableToPointInTimeOutput) SetExportDescription added in v1.35.24 

func (s *ExportTableToPointInTimeOutput) SetExportDescription(v *ExportDescription) *ExportTableToPointInTimeOutput

SetExportDescription sets the ExportDescription field's value.

func (ExportTableToPointInTimeOutput) String added in v1.35.24 

func (s ExportTableToPointInTimeOutput) 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 FailureException added in v1.25.43 

type FailureException struct {

	// Description of the failure.
	ExceptionDescription *string `type:"string"`

	// Exception name.
	ExceptionName *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a failure a contributor insights operation.

func (FailureException) GoString added in v1.25.43 

func (s FailureException) 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 (*FailureException) SetExceptionDescription added in v1.25.43 

func (s *FailureException) SetExceptionDescription(v string) *FailureException

SetExceptionDescription sets the ExceptionDescription field's value.

func (*FailureException) SetExceptionName added in v1.25.43 

func (s *FailureException) SetExceptionName(v string) *FailureException

SetExceptionName sets the ExceptionName field's value.

func (FailureException) String added in v1.25.43 

func (s FailureException) 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 Get added in v1.15.85 

type Get struct {

	// One or more substitution tokens for attribute names in the ProjectionExpression
	// parameter.
	ExpressionAttributeNames map[string]*string `type:"map"`

	// A map of attribute names to AttributeValue objects that specifies the primary
	// key of the item to retrieve.
	//
	// Key is a required field
	Key map[string]*AttributeValue `type:"map" required:"true"`

	// A string that identifies one or more attributes of the specified item to
	// retrieve from the table. The attributes in the expression must be separated
	// by commas. If no attribute names are specified, then all attributes of the
	// specified item are returned. If any of the requested attributes are not found,
	// they do not appear in the result.
	ProjectionExpression *string `type:"string"`

	// The name of the table from which to retrieve the specified item.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies an item and related attribute values to retrieve in a TransactGetItem object.

func (Get) GoString added in v1.15.85 

func (s Get) 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 (*Get) SetExpressionAttributeNames added in v1.15.85 

func (s *Get) SetExpressionAttributeNames(v map[string]*string) *Get

SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.

func (*Get) SetKey added in v1.15.85 

func (s *Get) SetKey(v map[string]*AttributeValue) *Get

SetKey sets the Key field's value.

func (*Get) SetProjectionExpression added in v1.15.85 

func (s *Get) SetProjectionExpression(v string) *Get

SetProjectionExpression sets the ProjectionExpression field's value.

func (*Get) SetTableName added in v1.15.85 

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

SetTableName sets the TableName field's value.

func (Get) String added in v1.15.85 

func (s Get) 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 (*Get) Validate added in v1.15.85 

func (s *Get) Validate() error

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

type GetItemInput 

type GetItemInput struct {

	// This is a legacy parameter. Use ProjectionExpression instead. For more information,
	// see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html)
	// in the Amazon DynamoDB Developer Guide.
	AttributesToGet []*string `min:"1" type:"list"`

	// Determines the read consistency model: If set to true, then the operation
	// uses strongly consistent reads; otherwise, the operation uses eventually
	// consistent reads.
	ConsistentRead *bool `type:"boolean"`

	// One or more substitution tokens for attribute names in an expression. The
	// following are some use cases for using ExpressionAttributeNames:
	//
	//    * To access an attribute whose name conflicts with a DynamoDB reserved
	//    word.
	//
	//    * To create a placeholder for repeating occurrences of an attribute name
	//    in an expression.
	//
	//    * To prevent special characters in an attribute name from being misinterpreted
	//    in an expression.
	//
	// Use the # character in an expression to dereference an attribute name. For
	// example, consider the following attribute name:
	//
	//    * Percentile
	//
	// The name of this attribute conflicts with a reserved word, so it cannot be
	// used directly in an expression. (For the complete list of reserved words,
	// see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
	// in the Amazon DynamoDB Developer Guide). To work around this, you could specify
	// the following for ExpressionAttributeNames:
	//
	//    * {"#P":"Percentile"}
	//
	// You could then use this substitution in an expression, as in this example:
	//
	//    * #P = :val
	//
	// Tokens that begin with the : character are expression attribute values, which
	// are placeholders for the actual value at runtime.
	//
	// For more information on expression attribute names, see Specifying Item Attributes
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
	// in the Amazon DynamoDB Developer Guide.
	ExpressionAttributeNames map[string]*string `type:"map"`

	// A map of attribute names to AttributeValue objects, representing the primary
	// key of the item to retrieve.
	//
	// For the primary key, you must provide all of the attributes. For example,
	// with a simple primary key, you only need to provide a value for the partition
	// key. For a composite primary key, you must provide values for both the partition
	// key and the sort key.
	//
	// Key is a required field
	Key map[string]*AttributeValue `type:"map" required:"true"`

	// A string that identifies one or more attributes to retrieve from the table.
	// These attributes can include scalars, sets, or elements of a JSON document.
	// The attributes in the expression must be separated by commas.
	//
	// If no attribute names are specified, then all attributes are returned. If
	// any of the requested attributes are not found, they do not appear in the
	// result.
	//
	// For more information, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
	// in the Amazon DynamoDB Developer Guide.
	ProjectionExpression *string `type:"string"`

	// Determines the level of detail about either provisioned or on-demand throughput
	// consumption that is returned in the response:
	//
	//    * INDEXES - The response includes the aggregate ConsumedCapacity for the
	//    operation, together with ConsumedCapacity for each table and secondary
	//    index that was accessed. Note that some operations, such as GetItem and
	//    BatchGetItem, do not access any indexes at all. In these cases, specifying
	//    INDEXES will only return ConsumedCapacity information for table(s).
	//
	//    * TOTAL - The response includes only the aggregate ConsumedCapacity for
	//    the operation.
	//
	//    * NONE - No ConsumedCapacity details are included in the response.
	ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"`

	// The name of the table containing the requested item.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a GetItem operation.

func (GetItemInput) GoString added in v0.6.5 

func (s GetItemInput) 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 (*GetItemInput) SetAttributesToGet added in v1.5.0 

func (s *GetItemInput) SetAttributesToGet(v []*string) *GetItemInput

SetAttributesToGet sets the AttributesToGet field's value.

func (*GetItemInput) SetConsistentRead added in v1.5.0 

func (s *GetItemInput) SetConsistentRead(v bool) *GetItemInput

SetConsistentRead sets the ConsistentRead field's value.

func (*GetItemInput) SetExpressionAttributeNames added in v1.5.0 

func (s *GetItemInput) SetExpressionAttributeNames(v map[string]*string) *GetItemInput

SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.

func (*GetItemInput) SetKey added in v1.5.0 

func (s *GetItemInput) SetKey(v map[string]*AttributeValue) *GetItemInput

SetKey sets the Key field's value.

func (*GetItemInput) SetProjectionExpression added in v1.5.0 

func (s *GetItemInput) SetProjectionExpression(v string) *GetItemInput

SetProjectionExpression sets the ProjectionExpression field's value.

func (*GetItemInput) SetReturnConsumedCapacity added in v1.5.0 

func (s *GetItemInput) SetReturnConsumedCapacity(v string) *GetItemInput

SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.

func (*GetItemInput) SetTableName added in v1.5.0 

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

SetTableName sets the TableName field's value.

func (GetItemInput) String added in v0.6.5 

func (s GetItemInput) 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 (*GetItemInput) Validate added in v1.1.21 

func (s *GetItemInput) Validate() error

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

type GetItemOutput 

type GetItemOutput struct {

	// The capacity units consumed by the GetItem operation. The data returned includes
	// the total provisioned throughput consumed, along with statistics for the
	// table and any indexes involved in the operation. ConsumedCapacity is only
	// returned if the ReturnConsumedCapacity parameter was specified. For more
	// information, see Read/Write Capacity Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
	// in the Amazon DynamoDB Developer Guide.
	ConsumedCapacity *ConsumedCapacity `type:"structure"`

	// A map of attribute names to AttributeValue objects, as specified by ProjectionExpression.
	Item map[string]*AttributeValue `type:"map"`
	// contains filtered or unexported fields
}

Represents the output of a GetItem operation.

func (GetItemOutput) GoString added in v0.6.5 

func (s GetItemOutput) 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 (*GetItemOutput) SetConsumedCapacity added in v1.5.0 

func (s *GetItemOutput) SetConsumedCapacity(v *ConsumedCapacity) *GetItemOutput

SetConsumedCapacity sets the ConsumedCapacity field's value.

func (*GetItemOutput) SetItem added in v1.5.0 

func (s *GetItemOutput) SetItem(v map[string]*AttributeValue) *GetItemOutput

SetItem sets the Item field's value.

func (GetItemOutput) String added in v0.6.5 

func (s GetItemOutput) 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 GlobalSecondaryIndex 

type GlobalSecondaryIndex struct {

	// The name of the global secondary index. The name must be unique among all
	// other indexes on this table.
	//
	// IndexName is a required field
	IndexName *string `min:"3" type:"string" required:"true"`

	// The complete key schema for a global secondary index, which consists of one
	// or more pairs of attribute names and key types:
	//
	//    * HASH - partition key
	//
	//    * RANGE - sort key
	//
	// The partition key of an item is also known as its hash attribute. The term
	// "hash attribute" derives from DynamoDB's usage of an internal hash function
	// to evenly distribute data items across partitions, based on their partition
	// key values.
	//
	// The sort key of an item is also known as its range attribute. The term "range
	// attribute" derives from the way DynamoDB stores items with the same partition
	// key physically close together, in sorted order by the sort key value.
	//
	// KeySchema is a required field
	KeySchema []*KeySchemaElement `min:"1" type:"list" required:"true"`

	// Represents attributes that are copied (projected) from the table into the
	// global secondary index. These are in addition to the primary key attributes
	// and index key attributes, which are automatically projected.
	//
	// Projection is a required field
	Projection *Projection `type:"structure" required:"true"`

	// Represents the provisioned throughput settings for the specified global secondary
	// index.
	//
	// For current minimum and maximum provisioned throughput values, see Service,
	// Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
	// in the Amazon DynamoDB Developer Guide.
	ProvisionedThroughput *ProvisionedThroughput `type:"structure"`
	// contains filtered or unexported fields
}

Represents the properties of a global secondary index.

func (GlobalSecondaryIndex) GoString added in v0.6.5 

func (s GlobalSecondaryIndex) 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 (*GlobalSecondaryIndex) SetIndexName added in v1.5.0 

func (s *GlobalSecondaryIndex) SetIndexName(v string) *GlobalSecondaryIndex

SetIndexName sets the IndexName field's value.

func (*GlobalSecondaryIndex) SetKeySchema added in v1.5.0 

func (s *GlobalSecondaryIndex) SetKeySchema(v []*KeySchemaElement) *GlobalSecondaryIndex

SetKeySchema sets the KeySchema field's value.

func (*GlobalSecondaryIndex) SetProjection added in v1.5.0 

func (s *GlobalSecondaryIndex) SetProjection(v *Projection) *GlobalSecondaryIndex

SetProjection sets the Projection field's value.

func (*GlobalSecondaryIndex) SetProvisionedThroughput added in v1.5.0 

func (s *GlobalSecondaryIndex) SetProvisionedThroughput(v *ProvisionedThroughput) *GlobalSecondaryIndex

SetProvisionedThroughput sets the ProvisionedThroughput field's value.

func (GlobalSecondaryIndex) String added in v0.6.5 

func (s GlobalSecondaryIndex) 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 (*GlobalSecondaryIndex) Validate added in v1.1.21 

func (s *GlobalSecondaryIndex) Validate() error

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

type GlobalSecondaryIndexAutoScalingUpdate added in v1.25.40 

type GlobalSecondaryIndexAutoScalingUpdate struct {

	// The name of the global secondary index.
	IndexName *string `min:"3" type:"string"`

	// Represents the auto scaling settings to be modified for a global table or
	// global secondary index.
	ProvisionedWriteCapacityAutoScalingUpdate *AutoScalingSettingsUpdate `type:"structure"`
	// contains filtered or unexported fields
}

Represents the auto scaling settings of a global secondary index for a global table that will be modified.

func (GlobalSecondaryIndexAutoScalingUpdate) GoString added in v1.25.40 

func (s GlobalSecondaryIndexAutoScalingUpdate) 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 (*GlobalSecondaryIndexAutoScalingUpdate) SetIndexName added in v1.25.40 

func (s *GlobalSecondaryIndexAutoScalingUpdate) SetIndexName(v string) *GlobalSecondaryIndexAutoScalingUpdate

SetIndexName sets the IndexName field's value.

func (*GlobalSecondaryIndexAutoScalingUpdate) SetProvisionedWriteCapacityAutoScalingUpdate added in v1.25.40 

func (s *GlobalSecondaryIndexAutoScalingUpdate) SetProvisionedWriteCapacityAutoScalingUpdate(v *AutoScalingSettingsUpdate) *GlobalSecondaryIndexAutoScalingUpdate

SetProvisionedWriteCapacityAutoScalingUpdate sets the ProvisionedWriteCapacityAutoScalingUpdate field's value.

func (GlobalSecondaryIndexAutoScalingUpdate) String added in v1.25.40 

func (s GlobalSecondaryIndexAutoScalingUpdate) 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 (*GlobalSecondaryIndexAutoScalingUpdate) Validate added in v1.25.40 

func (s *GlobalSecondaryIndexAutoScalingUpdate) Validate() error

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

type GlobalSecondaryIndexDescription 

type GlobalSecondaryIndexDescription struct {

	// Indicates whether the index is currently backfilling. Backfilling is the
	// process of reading items from the table and determining whether they can
	// be added to the index. (Not all items will qualify: For example, a partition
	// key cannot have any duplicate values.) If an item can be added to the index,
	// DynamoDB will do so. After all items have been processed, the backfilling
	// operation is complete and Backfilling is false.
	//
	// You can delete an index that is being created during the Backfilling phase
	// when IndexStatus is set to CREATING and Backfilling is true. You can't delete
	// the index that is being created when IndexStatus is set to CREATING and Backfilling
	// is false.
	//
	// For indexes that were created during a CreateTable operation, the Backfilling
	// attribute does not appear in the DescribeTable output.
	Backfilling *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) that uniquely identifies the index.
	IndexArn *string `type:"string"`

	// The name of the global secondary index.
	IndexName *string `min:"3" type:"string"`

	// The total size of the specified index, in bytes. DynamoDB updates this value
	// approximately every six hours. Recent changes might not be reflected in this
	// value.
	IndexSizeBytes *int64 `type:"long"`

	// The current state of the global secondary index:
	//
	//    * CREATING - The index is being created.
	//
	//    * UPDATING - The index is being updated.
	//
	//    * DELETING - The index is being deleted.
	//
	//    * ACTIVE - The index is ready for use.
	IndexStatus *string `type:"string" enum:"IndexStatus"`

	// The number of items in the specified index. DynamoDB updates this value approximately
	// every six hours. Recent changes might not be reflected in this value.
	ItemCount *int64 `type:"long"`

	// The complete key schema for a global secondary index, which consists of one
	// or more pairs of attribute names and key types:
	//
	//    * HASH - partition key
	//
	//    * RANGE - sort key
	//
	// The partition key of an item is also known as its hash attribute. The term
	// "hash attribute" derives from DynamoDB's usage of an internal hash function
	// to evenly distribute data items across partitions, based on their partition
	// key values.
	//
	// The sort key of an item is also known as its range attribute. The term "range
	// attribute" derives from the way DynamoDB stores items with the same partition
	// key physically close together, in sorted order by the sort key value.
	KeySchema []*KeySchemaElement `min:"1" type:"list"`

	// Represents attributes that are copied (projected) from the table into the
	// global secondary index. These are in addition to the primary key attributes
	// and index key attributes, which are automatically projected.
	Projection *Projection `type:"structure"`

	// Represents the provisioned throughput settings for the specified global secondary
	// index.
	//
	// For current minimum and maximum provisioned throughput values, see Service,
	// Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
	// in the Amazon DynamoDB Developer Guide.
	ProvisionedThroughput *ProvisionedThroughputDescription `type:"structure"`
	// contains filtered or unexported fields
}

Represents the properties of a global secondary index.

func (GlobalSecondaryIndexDescription) GoString added in v0.6.5 

func (s GlobalSecondaryIndexDescription) 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 (*GlobalSecondaryIndexDescription) SetBackfilling added in v1.5.0 

func (s *GlobalSecondaryIndexDescription) SetBackfilling(v bool) *GlobalSecondaryIndexDescription

SetBackfilling sets the Backfilling field's value.

func (*GlobalSecondaryIndexDescription) SetIndexArn added in v1.5.0 

func (s *GlobalSecondaryIndexDescription) SetIndexArn(v string) *GlobalSecondaryIndexDescription

SetIndexArn sets the IndexArn field's value.

func (*GlobalSecondaryIndexDescription) SetIndexName added in v1.5.0 

func (s *GlobalSecondaryIndexDescription) SetIndexName(v string) *GlobalSecondaryIndexDescription

SetIndexName sets the IndexName field's value.

func (*GlobalSecondaryIndexDescription) SetIndexSizeBytes added in v1.5.0 

func (s *GlobalSecondaryIndexDescription) SetIndexSizeBytes(v int64) *GlobalSecondaryIndexDescription

SetIndexSizeBytes sets the IndexSizeBytes field's value.

func (*GlobalSecondaryIndexDescription) SetIndexStatus added in v1.5.0 

func (s *GlobalSecondaryIndexDescription) SetIndexStatus(v string) *GlobalSecondaryIndexDescription

SetIndexStatus sets the IndexStatus field's value.

func (*GlobalSecondaryIndexDescription) SetItemCount added in v1.5.0 

func (s *GlobalSecondaryIndexDescription) SetItemCount(v int64) *GlobalSecondaryIndexDescription

SetItemCount sets the ItemCount field's value.

func (*GlobalSecondaryIndexDescription) SetKeySchema added in v1.5.0 

func (s *GlobalSecondaryIndexDescription) SetKeySchema(v []*KeySchemaElement) *GlobalSecondaryIndexDescription

SetKeySchema sets the KeySchema field's value.

func (*GlobalSecondaryIndexDescription) SetProjection added in v1.5.0 

func (s *GlobalSecondaryIndexDescription) SetProjection(v *Projection) *GlobalSecondaryIndexDescription

SetProjection sets the Projection field's value.

func (*GlobalSecondaryIndexDescription) SetProvisionedThroughput added in v1.5.0 

func (s *GlobalSecondaryIndexDescription) SetProvisionedThroughput(v *ProvisionedThroughputDescription) *GlobalSecondaryIndexDescription

SetProvisionedThroughput sets the ProvisionedThroughput field's value.

func (GlobalSecondaryIndexDescription) String added in v0.6.5 

func (s GlobalSecondaryIndexDescription) 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 GlobalSecondaryIndexInfo added in v1.12.36 

type GlobalSecondaryIndexInfo struct {

	// The name of the global secondary index.
	IndexName *string `min:"3" type:"string"`

	// The complete key schema for a global secondary index, which consists of one
	// or more pairs of attribute names and key types:
	//
	//    * HASH - partition key
	//
	//    * RANGE - sort key
	//
	// The partition key of an item is also known as its hash attribute. The term
	// "hash attribute" derives from DynamoDB's usage of an internal hash function
	// to evenly distribute data items across partitions, based on their partition
	// key values.
	//
	// The sort key of an item is also known as its range attribute. The term "range
	// attribute" derives from the way DynamoDB stores items with the same partition
	// key physically close together, in sorted order by the sort key value.
	KeySchema []*KeySchemaElement `min:"1" type:"list"`

	// Represents attributes that are copied (projected) from the table into the
	// global secondary index. These are in addition to the primary key attributes
	// and index key attributes, which are automatically projected.
	Projection *Projection `type:"structure"`

	// Represents the provisioned throughput settings for the specified global secondary
	// index.
	ProvisionedThroughput *ProvisionedThroughput `type:"structure"`
	// contains filtered or unexported fields
}

Represents the properties of a global secondary index for the table when the backup was created.

func (GlobalSecondaryIndexInfo) GoString added in v1.12.36 

func (s GlobalSecondaryIndexInfo) 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 (*GlobalSecondaryIndexInfo) SetIndexName added in v1.12.36 

func (s *GlobalSecondaryIndexInfo) SetIndexName(v string) *GlobalSecondaryIndexInfo

SetIndexName sets the IndexName field's value.

func (*GlobalSecondaryIndexInfo) SetKeySchema added in v1.12.36 

func (s *GlobalSecondaryIndexInfo) SetKeySchema(v []*KeySchemaElement) *GlobalSecondaryIndexInfo

SetKeySchema sets the KeySchema field's value.

func (*GlobalSecondaryIndexInfo) SetProjection added in v1.12.36 

func (s *GlobalSecondaryIndexInfo) SetProjection(v *Projection) *GlobalSecondaryIndexInfo

SetProjection sets the Projection field's value.

func (*GlobalSecondaryIndexInfo) SetProvisionedThroughput added in v1.12.36 

func (s *GlobalSecondaryIndexInfo) SetProvisionedThroughput(v *ProvisionedThroughput) *GlobalSecondaryIndexInfo

SetProvisionedThroughput sets the ProvisionedThroughput field's value.

func (GlobalSecondaryIndexInfo) String added in v1.12.36 

func (s GlobalSecondaryIndexInfo) 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 GlobalSecondaryIndexUpdate 

type GlobalSecondaryIndexUpdate struct {

	// The parameters required for creating a global secondary index on an existing
	// table:
	//
	//    * IndexName
	//
	//    * KeySchema
	//
	//    * AttributeDefinitions
	//
	//    * Projection
	//
	//    * ProvisionedThroughput
	Create *CreateGlobalSecondaryIndexAction `type:"structure"`

	// The name of an existing global secondary index to be removed.
	Delete *DeleteGlobalSecondaryIndexAction `type:"structure"`

	// The name of an existing global secondary index, along with new provisioned
	// throughput settings to be applied to that index.
	Update *UpdateGlobalSecondaryIndexAction `type:"structure"`
	// contains filtered or unexported fields
}

Represents one of the following:

  • A new global secondary index to be added to an existing table.

  • New provisioned throughput parameters for an existing global secondary index.

  • An existing global secondary index to be removed from an existing table.

func (GlobalSecondaryIndexUpdate) GoString added in v0.6.5 

func (s GlobalSecondaryIndexUpdate) 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 (*GlobalSecondaryIndexUpdate) SetCreate added in v1.5.0 

func (s *GlobalSecondaryIndexUpdate) SetCreate(v *CreateGlobalSecondaryIndexAction) *GlobalSecondaryIndexUpdate

SetCreate sets the Create field's value.

func (*GlobalSecondaryIndexUpdate) SetDelete added in v1.5.0 

func (s *GlobalSecondaryIndexUpdate) SetDelete(v *DeleteGlobalSecondaryIndexAction) *GlobalSecondaryIndexUpdate

SetDelete sets the Delete field's value.

func (*GlobalSecondaryIndexUpdate) SetUpdate added in v1.5.0 

func (s *GlobalSecondaryIndexUpdate) SetUpdate(v *UpdateGlobalSecondaryIndexAction) *GlobalSecondaryIndexUpdate

SetUpdate sets the Update field's value.

func (GlobalSecondaryIndexUpdate) String added in v0.6.5 

func (s GlobalSecondaryIndexUpdate) 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 (*GlobalSecondaryIndexUpdate) Validate added in v1.1.21 

func (s *GlobalSecondaryIndexUpdate) Validate() error

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

type GlobalTable added in v1.12.36 

type GlobalTable struct {

	// The global table name.
	GlobalTableName *string `min:"3" type:"string"`

	// The Regions where the global table has replicas.
	ReplicationGroup []*Replica `type:"list"`
	// contains filtered or unexported fields
}

Represents the properties of a global table.

func (GlobalTable) GoString added in v1.12.36 

func (s GlobalTable) 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 (*GlobalTable) SetGlobalTableName added in v1.12.36 

func (s *GlobalTable) SetGlobalTableName(v string) *GlobalTable

SetGlobalTableName sets the GlobalTableName field's value.

func (*GlobalTable) SetReplicationGroup added in v1.12.36 

func (s *GlobalTable) SetReplicationGroup(v []*Replica) *GlobalTable

SetReplicationGroup sets the ReplicationGroup field's value.

func (GlobalTable) String added in v1.12.36 

func (s GlobalTable) 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 GlobalTableAlreadyExistsException added in v1.28.0 

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

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

The specified global table already exists.

func (*GlobalTableAlreadyExistsException) Code added in v1.28.0 

func (s *GlobalTableAlreadyExistsException) Code() string

Code returns the exception type name.

func (*GlobalTableAlreadyExistsException) Error added in v1.28.0 

func (s *GlobalTableAlreadyExistsException) Error() string

func (GlobalTableAlreadyExistsException) GoString added in v1.28.0 

func (s GlobalTableAlreadyExistsException) 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 (*GlobalTableAlreadyExistsException) Message added in v1.28.0 

func (s *GlobalTableAlreadyExistsException) Message() string

Message returns the exception's message.

func (*GlobalTableAlreadyExistsException) OrigErr added in v1.28.0 

func (s *GlobalTableAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*GlobalTableAlreadyExistsException) RequestID added in v1.28.0 

func (s *GlobalTableAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*GlobalTableAlreadyExistsException) StatusCode added in v1.28.0 

func (s *GlobalTableAlreadyExistsException) StatusCode() int

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

func (GlobalTableAlreadyExistsException) String added in v1.28.0 

func (s GlobalTableAlreadyExistsException) 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 GlobalTableDescription added in v1.12.36 

type GlobalTableDescription struct {

	// The creation time of the global table.
	CreationDateTime *time.Time `type:"timestamp"`

	// The unique identifier of the global table.
	GlobalTableArn *string `type:"string"`

	// The global table name.
	GlobalTableName *string `min:"3" type:"string"`

	// The current state of the global table:
	//
	//    * CREATING - The global table is being created.
	//
	//    * UPDATING - The global table is being updated.
	//
	//    * DELETING - The global table is being deleted.
	//
	//    * ACTIVE - The global table is ready for use.
	GlobalTableStatus *string `type:"string" enum:"GlobalTableStatus"`

	// The Regions where the global table has replicas.
	ReplicationGroup []*ReplicaDescription `type:"list"`
	// contains filtered or unexported fields
}

Contains details about the global table.

func (GlobalTableDescription) GoString added in v1.12.36 

func (s GlobalTableDescription) 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 (*GlobalTableDescription) SetCreationDateTime added in v1.12.36 

func (s *GlobalTableDescription) SetCreationDateTime(v time.Time) *GlobalTableDescription

SetCreationDateTime sets the CreationDateTime field's value.

func (*GlobalTableDescription) SetGlobalTableArn added in v1.12.36 

func (s *GlobalTableDescription) SetGlobalTableArn(v string) *GlobalTableDescription

SetGlobalTableArn sets the GlobalTableArn field's value.

func (*GlobalTableDescription) SetGlobalTableName added in v1.12.36 

func (s *GlobalTableDescription) SetGlobalTableName(v string) *GlobalTableDescription

SetGlobalTableName sets the GlobalTableName field's value.

func (*GlobalTableDescription) SetGlobalTableStatus added in v1.12.36 

func (s *GlobalTableDescription) SetGlobalTableStatus(v string) *GlobalTableDescription

SetGlobalTableStatus sets the GlobalTableStatus field's value.

func (*GlobalTableDescription) SetReplicationGroup added in v1.12.36 

func (s *GlobalTableDescription) SetReplicationGroup(v []*ReplicaDescription) *GlobalTableDescription

SetReplicationGroup sets the ReplicationGroup field's value.

func (GlobalTableDescription) String added in v1.12.36 

func (s GlobalTableDescription) 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 GlobalTableGlobalSecondaryIndexSettingsUpdate added in v1.13.39 

type GlobalTableGlobalSecondaryIndexSettingsUpdate struct {

	// The name of the global secondary index. The name must be unique among all
	// other indexes on this table.
	//
	// IndexName is a required field
	IndexName *string `min:"3" type:"string" required:"true"`

	// Auto scaling settings for managing a global secondary index's write capacity
	// units.
	ProvisionedWriteCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate `type:"structure"`

	// The maximum number of writes consumed per second before DynamoDB returns
	// a ThrottlingException.
	ProvisionedWriteCapacityUnits *int64 `min:"1" type:"long"`
	// contains filtered or unexported fields
}

Represents the settings of a global secondary index for a global table that will be modified.

func (GlobalTableGlobalSecondaryIndexSettingsUpdate) GoString added in v1.13.39 

func (s GlobalTableGlobalSecondaryIndexSettingsUpdate) 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 (*GlobalTableGlobalSecondaryIndexSettingsUpdate) SetIndexName added in v1.13.39 

func (s *GlobalTableGlobalSecondaryIndexSettingsUpdate) SetIndexName(v string) *GlobalTableGlobalSecondaryIndexSettingsUpdate

SetIndexName sets the IndexName field's value.

func (*GlobalTableGlobalSecondaryIndexSettingsUpdate) SetProvisionedWriteCapacityAutoScalingSettingsUpdate added in v1.14.32 

func (s *GlobalTableGlobalSecondaryIndexSettingsUpdate) SetProvisionedWriteCapacityAutoScalingSettingsUpdate(v *AutoScalingSettingsUpdate) *GlobalTableGlobalSecondaryIndexSettingsUpdate

SetProvisionedWriteCapacityAutoScalingSettingsUpdate sets the ProvisionedWriteCapacityAutoScalingSettingsUpdate field's value.

func (*GlobalTableGlobalSecondaryIndexSettingsUpdate) SetProvisionedWriteCapacityUnits added in v1.13.39 

func (s *GlobalTableGlobalSecondaryIndexSettingsUpdate) SetProvisionedWriteCapacityUnits(v int64) *GlobalTableGlobalSecondaryIndexSettingsUpdate

SetProvisionedWriteCapacityUnits sets the ProvisionedWriteCapacityUnits field's value.

func (GlobalTableGlobalSecondaryIndexSettingsUpdate) String added in v1.13.39 

func (s GlobalTableGlobalSecondaryIndexSettingsUpdate) 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 (*GlobalTableGlobalSecondaryIndexSettingsUpdate) Validate added in v1.13.39 

func (s *GlobalTableGlobalSecondaryIndexSettingsUpdate) Validate() error

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

type GlobalTableNotFoundException added in v1.28.0 

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

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

The specified global table does not exist.

func (*GlobalTableNotFoundException) Code added in v1.28.0 

func (s *GlobalTableNotFoundException) Code() string

Code returns the exception type name.

func (*GlobalTableNotFoundException) Error added in v1.28.0 

func (s *GlobalTableNotFoundException) Error() string

func (GlobalTableNotFoundException) GoString added in v1.28.0 

func (s GlobalTableNotFoundException) 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 (*GlobalTableNotFoundException) Message added in v1.28.0 

func (s *GlobalTableNotFoundException) Message() string

Message returns the exception's message.

func (*GlobalTableNotFoundException) OrigErr added in v1.28.0 

func (s *GlobalTableNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*GlobalTableNotFoundException) RequestID added in v1.28.0 

func (s *GlobalTableNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*GlobalTableNotFoundException) StatusCode added in v1.28.0 

func (s *GlobalTableNotFoundException) StatusCode() int

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

func (GlobalTableNotFoundException) String added in v1.28.0 

func (s GlobalTableNotFoundException) 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 IdempotentParameterMismatchException added in v1.28.0 

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

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

DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.

func (*IdempotentParameterMismatchException) Code added in v1.28.0 

func (s *IdempotentParameterMismatchException) Code() string

Code returns the exception type name.

func (*IdempotentParameterMismatchException) Error added in v1.28.0 

func (s *IdempotentParameterMismatchException) Error() string

func (IdempotentParameterMismatchException) GoString added in v1.28.0 

func (s IdempotentParameterMismatchException) 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 (*IdempotentParameterMismatchException) Message added in v1.28.0 

func (s *IdempotentParameterMismatchException) Message() string

Message returns the exception's message.

func (*IdempotentParameterMismatchException) OrigErr added in v1.28.0 

func (s *IdempotentParameterMismatchException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IdempotentParameterMismatchException) RequestID added in v1.28.0 

func (s *IdempotentParameterMismatchException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IdempotentParameterMismatchException) StatusCode added in v1.28.0 

func (s *IdempotentParameterMismatchException) StatusCode() int

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

func (IdempotentParameterMismatchException) String added in v1.28.0 

func (s IdempotentParameterMismatchException) 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 IndexNotFoundException added in v1.28.0 

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

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

The operation tried to access a nonexistent index.

func (*IndexNotFoundException) Code added in v1.28.0 

func (s *IndexNotFoundException) Code() string

Code returns the exception type name.

func (*IndexNotFoundException) Error added in v1.28.0 

func (s *IndexNotFoundException) Error() string

func (IndexNotFoundException) GoString added in v1.28.0 

func (s IndexNotFoundException) 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 (*IndexNotFoundException) Message added in v1.28.0 

func (s *IndexNotFoundException) Message() string

Message returns the exception's message.

func (*IndexNotFoundException) OrigErr added in v1.28.0 

func (s *IndexNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IndexNotFoundException) RequestID added in v1.28.0 

func (s *IndexNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IndexNotFoundException) StatusCode added in v1.28.0 

func (s *IndexNotFoundException) StatusCode() int

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

func (IndexNotFoundException) String added in v1.28.0 

func (s IndexNotFoundException) 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 InternalServerError added in v1.28.0 

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

	// The server encountered an internal error trying to fulfill the request.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An error occurred on the server side.

func (*InternalServerError) Code added in v1.28.0 

func (s *InternalServerError) Code() string

Code returns the exception type name.

func (*InternalServerError) Error added in v1.28.0 

func (s *InternalServerError) Error() string

func (InternalServerError) GoString added in v1.28.0 

func (s InternalServerError) 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 (*InternalServerError) Message added in v1.28.0 

func (s *InternalServerError) Message() string

Message returns the exception's message.

func (*InternalServerError) OrigErr added in v1.28.0 

func (s *InternalServerError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerError) RequestID added in v1.28.0 

func (s *InternalServerError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerError) StatusCode added in v1.28.0 

func (s *InternalServerError) StatusCode() int

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

func (InternalServerError) String added in v1.28.0 

func (s InternalServerError) 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 InvalidExportTimeException added in v1.35.24 

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

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

The specified ExportTime is outside of the point in time recovery window.

func (*InvalidExportTimeException) Code added in v1.35.24 

func (s *InvalidExportTimeException) Code() string

Code returns the exception type name.

func (*InvalidExportTimeException) Error added in v1.35.24 

func (s *InvalidExportTimeException) Error() string

func (InvalidExportTimeException) GoString added in v1.35.24 

func (s InvalidExportTimeException) 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 (*InvalidExportTimeException) Message added in v1.35.24 

func (s *InvalidExportTimeException) Message() string

Message returns the exception's message.

func (*InvalidExportTimeException) OrigErr added in v1.35.24 

func (s *InvalidExportTimeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidExportTimeException) RequestID added in v1.35.24 

func (s *InvalidExportTimeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidExportTimeException) StatusCode added in v1.35.24 

func (s *InvalidExportTimeException) StatusCode() int

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

func (InvalidExportTimeException) String added in v1.35.24 

func (s InvalidExportTimeException) 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 InvalidRestoreTimeException added in v1.28.0 

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

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

An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.

func (*InvalidRestoreTimeException) Code added in v1.28.0 

func (s *InvalidRestoreTimeException) Code() string

Code returns the exception type name.

func (*InvalidRestoreTimeException) Error added in v1.28.0 

func (s *InvalidRestoreTimeException) Error() string

func (InvalidRestoreTimeException) GoString added in v1.28.0 

func (s InvalidRestoreTimeException) 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 (*InvalidRestoreTimeException) Message added in v1.28.0 

func (s *InvalidRestoreTimeException) Message() string

Message returns the exception's message.

func (*InvalidRestoreTimeException) OrigErr added in v1.28.0 

func (s *InvalidRestoreTimeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRestoreTimeException) RequestID added in v1.28.0 

func (s *InvalidRestoreTimeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRestoreTimeException) StatusCode added in v1.28.0 

func (s *InvalidRestoreTimeException) StatusCode() int

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

func (InvalidRestoreTimeException) String added in v1.28.0 

func (s InvalidRestoreTimeException) 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 ItemCollectionMetrics 

type ItemCollectionMetrics struct {

	// The partition key value of the item collection. This value is the same as
	// the partition key value of the item.
	ItemCollectionKey map[string]*AttributeValue `type:"map"`

	// An estimate of item collection size, in gigabytes. This value is a two-element
	// array containing a lower bound and an upper bound for the estimate. The estimate
	// includes the size of all the items in the table, plus the size of all attributes
	// projected into all of the local secondary indexes on that table. Use this
	// estimate to measure whether a local secondary index is approaching its size
	// limit.
	//
	// The estimate is subject to change over time; therefore, do not rely on the
	// precision or accuracy of the estimate.
	SizeEstimateRangeGB []*float64 `type:"list"`
	// contains filtered or unexported fields
}

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.

func (ItemCollectionMetrics) GoString added in v0.6.5 

func (s ItemCollectionMetrics) 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 (*ItemCollectionMetrics) SetItemCollectionKey added in v1.5.0 

func (s *ItemCollectionMetrics) SetItemCollectionKey(v map[string]*AttributeValue) *ItemCollectionMetrics

SetItemCollectionKey sets the ItemCollectionKey field's value.

func (*ItemCollectionMetrics) SetSizeEstimateRangeGB added in v1.5.0 

func (s *ItemCollectionMetrics) SetSizeEstimateRangeGB(v []*float64) *ItemCollectionMetrics

SetSizeEstimateRangeGB sets the SizeEstimateRangeGB field's value.

func (ItemCollectionMetrics) String added in v0.6.5 

func (s ItemCollectionMetrics) 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 ItemCollectionSizeLimitExceededException added in v1.28.0 

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

	// The total size of an item collection has exceeded the maximum limit of 10
	// gigabytes.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

func (*ItemCollectionSizeLimitExceededException) Code added in v1.28.0 

func (s *ItemCollectionSizeLimitExceededException) Code() string

Code returns the exception type name.

func (*ItemCollectionSizeLimitExceededException) Error added in v1.28.0 

func (s *ItemCollectionSizeLimitExceededException) Error() string

func (ItemCollectionSizeLimitExceededException) GoString added in v1.28.0 

func (s ItemCollectionSizeLimitExceededException) 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 (*ItemCollectionSizeLimitExceededException) Message added in v1.28.0 

func (s *ItemCollectionSizeLimitExceededException) Message() string

Message returns the exception's message.

func (*ItemCollectionSizeLimitExceededException) OrigErr added in v1.28.0 

func (s *ItemCollectionSizeLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ItemCollectionSizeLimitExceededException) RequestID added in v1.28.0 

func (s *ItemCollectionSizeLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ItemCollectionSizeLimitExceededException) StatusCode added in v1.28.0 

func (s *ItemCollectionSizeLimitExceededException) StatusCode() int

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

func (ItemCollectionSizeLimitExceededException) String added in v1.28.0 

func (s ItemCollectionSizeLimitExceededException) 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 ItemResponse added in v1.15.85 

type ItemResponse struct {

	// Map of attribute data consisting of the data type and attribute value.
	Item map[string]*AttributeValue `type:"map"`
	// contains filtered or unexported fields
}

Details for the requested item.

func (ItemResponse) GoString added in v1.15.85 

func (s ItemResponse) 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 (*ItemResponse) SetItem added in v1.15.85 

func (s *ItemResponse) SetItem(v map[string]*AttributeValue) *ItemResponse

SetItem sets the Item field's value.

func (ItemResponse) String added in v1.15.85 

func (s ItemResponse) 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 KeySchemaElement 

type KeySchemaElement struct {

	// The name of a key attribute.
	//
	// AttributeName is a required field
	AttributeName *string `min:"1" type:"string" required:"true"`

	// The role that this key attribute will assume:
	//
	//    * HASH - partition key
	//
	//    * RANGE - sort key
	//
	// The partition key of an item is also known as its hash attribute. The term
	// "hash attribute" derives from DynamoDB's usage of an internal hash function
	// to evenly distribute data items across partitions, based on their partition
	// key values.
	//
	// The sort key of an item is also known as its range attribute. The term "range
	// attribute" derives from the way DynamoDB stores items with the same partition
	// key physically close together, in sorted order by the sort key value.
	//
	// KeyType is a required field
	KeyType *string `type:"string" required:"true" enum:"KeyType"`
	// contains filtered or unexported fields
}

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.

A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.

A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

func (KeySchemaElement) GoString added in v0.6.5 

func (s KeySchemaElement) 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 (*KeySchemaElement) SetAttributeName added in v1.5.0 

func (s *KeySchemaElement) SetAttributeName(v string) *KeySchemaElement

SetAttributeName sets the AttributeName field's value.

func (*KeySchemaElement) SetKeyType added in v1.5.0 

func (s *KeySchemaElement) SetKeyType(v string) *KeySchemaElement

SetKeyType sets the KeyType field's value.

func (KeySchemaElement) String added in v0.6.5 

func (s KeySchemaElement) 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 (*KeySchemaElement) Validate added in v1.1.21 

func (s *KeySchemaElement) Validate() error

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

type KeysAndAttributes 

type KeysAndAttributes struct {

	// This is a legacy parameter. Use ProjectionExpression instead. For more information,
	// see Legacy Conditional Parameters (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html)
	// in the Amazon DynamoDB Developer Guide.
	AttributesToGet []*string `min:"1" type:"list"`

	// The consistency of a read operation. If set to true, then a strongly consistent
	// read is used; otherwise, an eventually consistent read is used.
	ConsistentRead *bool `type:"boolean"`

	// One or more substitution tokens for attribute names in an expression. The
	// following are some use cases for using ExpressionAttributeNames:
	//
	//    * To access an attribute whose name conflicts with a DynamoDB reserved
	//    word.
	//
	//    * To create a placeholder for repeating occurrences of an attribute name
	//    in an expression.
	//
	//    * To prevent special characters in an attribute name from being misinterpreted
	//    in an expression.
	//
	// Use the # character in an expression to dereference an attribute name. For
	// example, consider the following attribute name:
	//
	//    * Percentile
	//
	// The name of this attribute conflicts with a reserved word, so it cannot be
	// used directly in an expression. (For the complete list of reserved words,
	// see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
	// in the Amazon DynamoDB Developer Guide). To work around this, you could specify
	// the following for ExpressionAttributeNames:
	//
	//    * {"#P":"Percentile"}
	//
	// You could then use this substitution in an expression, as in this example:
	//
	//    * #P = :val
	//
	// Tokens that begin with the : character are expression attribute values, which
	// are placeholders for the actual value at runtime.
	//
	// For more information on expression attribute names, see Accessing Item Attributes
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
	// in the Amazon DynamoDB Developer Guide.
	ExpressionAttributeNames map[string]*string `type:"map"`

	// The primary key attribute values that define the items and the attributes
	// associated with the items.
	//
	// Keys is a required field
	Keys []map[string]*AttributeValue `min:"1" type:"list" required:"true"`

	// A string that identifies one or more attributes to retrieve from the table.
	// These attributes can include scalars, sets, or elements of a JSON document.
	// The attributes in the ProjectionExpression must be separated by commas.
	//
	// If no attribute names are specified, then all attributes will be returned.
	// If any of the requested attributes are not found, they will not appear in
	// the result.
	//
	// For more information, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
	// in the Amazon DynamoDB Developer Guide.
	ProjectionExpression *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a set of primary keys and, for each key, the attributes to retrieve from the table.

For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key. For a composite primary key, you must provide both the partition key and the sort key.

func (KeysAndAttributes) GoString added in v0.6.5 

func (s KeysAndAttributes) 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 (*KeysAndAttributes) SetAttributesToGet added in v1.5.0 

func (s *KeysAndAttributes) SetAttributesToGet(v []*string) *KeysAndAttributes

SetAttributesToGet sets the AttributesToGet field's value.

func (*KeysAndAttributes) SetConsistentRead added in v1.5.0 

func (s *KeysAndAttributes) SetConsistentRead(v bool) *KeysAndAttributes

SetConsistentRead sets the ConsistentRead field's value.

func (*KeysAndAttributes) SetExpressionAttributeNames added in v1.5.0 

func (s *KeysAndAttributes) SetExpressionAttributeNames(v map[string]*string) *KeysAndAttributes

SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.

func (*KeysAndAttributes) SetKeys added in v1.5.0 

func (s *KeysAndAttributes) SetKeys(v []map[string]*AttributeValue) *KeysAndAttributes

SetKeys sets the Keys field's value.

func (*KeysAndAttributes) SetProjectionExpression added in v1.5.0 

func (s *KeysAndAttributes) SetProjectionExpression(v string) *KeysAndAttributes

SetProjectionExpression sets the ProjectionExpression field's value.

func (KeysAndAttributes) String added in v0.6.5 

func (s KeysAndAttributes) 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 (*KeysAndAttributes) Validate added in v1.1.21 

func (s *KeysAndAttributes) Validate() error

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

type KinesisDataStreamDestination added in v1.35.34 

type KinesisDataStreamDestination struct {

	// The current status of replication.
	DestinationStatus *string `type:"string" enum:"DestinationStatus"`

	// The human-readable string that corresponds to the replica status.
	DestinationStatusDescription *string `type:"string"`

	// The ARN for a specific Kinesis data stream.
	StreamArn *string `min:"37" type:"string"`
	// contains filtered or unexported fields
}

Describes a Kinesis data stream destination.

func (KinesisDataStreamDestination) GoString added in v1.35.34 

func (s KinesisDataStreamDestination) 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 (*KinesisDataStreamDestination) SetDestinationStatus added in v1.35.34 

func (s *KinesisDataStreamDestination) SetDestinationStatus(v string) *KinesisDataStreamDestination

SetDestinationStatus sets the DestinationStatus field's value.

func (*KinesisDataStreamDestination) SetDestinationStatusDescription added in v1.35.34 

func (s *KinesisDataStreamDestination) SetDestinationStatusDescription(v string) *KinesisDataStreamDestination

SetDestinationStatusDescription sets the DestinationStatusDescription field's value.

func (*KinesisDataStreamDestination) SetStreamArn added in v1.35.34 

func (s *KinesisDataStreamDestination) SetStreamArn(v string) *KinesisDataStreamDestination

SetStreamArn sets the StreamArn field's value.

func (KinesisDataStreamDestination) String added in v1.35.34 

func (s KinesisDataStreamDestination) 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 LimitExceededException added in v1.28.0 

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

	// Too many operations for a given subscriber.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

There is a soft account quota of 2,500 tables.

func (*LimitExceededException) Code added in v1.28.0 

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0 

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0 

func (s LimitExceededException) 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 (*LimitExceededException) Message added in v1.28.0 

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0 

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0 

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0 

func (s *LimitExceededException) StatusCode() int

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

func (LimitExceededException) String added in v1.28.0 

func (s LimitExceededException) 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 ListBackupsInput added in v1.12.36 

type ListBackupsInput struct {

	// The backups from the table specified by BackupType are listed.
	//
	// Where BackupType can be:
	//
	//    * USER - On-demand backup created by you. (The default setting if no other
	//    backup types are specified.)
	//
	//    * SYSTEM - On-demand backup automatically created by DynamoDB.
	//
	//    * ALL - All types of on-demand backups (USER and SYSTEM).
	BackupType *string `type:"string" enum:"BackupTypeFilter"`

	// LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last
	// evaluated when the current page of results was returned, inclusive of the
	// current page of results. This value may be specified as the ExclusiveStartBackupArn
	// of a new ListBackups operation in order to fetch the next page of results.
	ExclusiveStartBackupArn *string `min:"37" type:"string"`

	// Maximum number of backups to return at once.
	Limit *int64 `min:"1" type:"integer"`

	// The backups from the table specified by TableName are listed.
	TableName *string `min:"3" type:"string"`

	// Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
	TimeRangeLowerBound *time.Time `type:"timestamp"`

	// Only backups created before this time are listed. TimeRangeUpperBound is
	// exclusive.
	TimeRangeUpperBound *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (ListBackupsInput) GoString added in v1.12.36 

func (s ListBackupsInput) 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 (*ListBackupsInput) SetBackupType added in v1.15.6 

func (s *ListBackupsInput) SetBackupType(v string) *ListBackupsInput

SetBackupType sets the BackupType field's value.

func (*ListBackupsInput) SetExclusiveStartBackupArn added in v1.12.36 

func (s *ListBackupsInput) SetExclusiveStartBackupArn(v string) *ListBackupsInput

SetExclusiveStartBackupArn sets the ExclusiveStartBackupArn field's value.

func (*ListBackupsInput) SetLimit added in v1.12.36 

func (s *ListBackupsInput) SetLimit(v int64) *ListBackupsInput

SetLimit sets the Limit field's value.

func (*ListBackupsInput) SetTableName added in v1.12.36 

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

SetTableName sets the TableName field's value.

func (*ListBackupsInput) SetTimeRangeLowerBound added in v1.12.36 

func (s *ListBackupsInput) SetTimeRangeLowerBound(v time.Time) *ListBackupsInput

SetTimeRangeLowerBound sets the TimeRangeLowerBound field's value.

func (*ListBackupsInput) SetTimeRangeUpperBound added in v1.12.36 

func (s *ListBackupsInput) SetTimeRangeUpperBound(v time.Time) *ListBackupsInput

SetTimeRangeUpperBound sets the TimeRangeUpperBound field's value.

func (ListBackupsInput) String added in v1.12.36 

func (s ListBackupsInput) 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 (*ListBackupsInput) Validate added in v1.12.36 

func (s *ListBackupsInput) Validate() error

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

type ListBackupsOutput added in v1.12.36 

type ListBackupsOutput struct {

	// List of BackupSummary objects.
	BackupSummaries []*BackupSummary `type:"list"`

	// The ARN of the backup last evaluated when the current page of results was
	// returned, inclusive of the current page of results. This value may be specified
	// as the ExclusiveStartBackupArn of a new ListBackups operation in order to
	// fetch the next page of results.
	//
	// If LastEvaluatedBackupArn is empty, then the last page of results has been
	// processed and there are no more results to be retrieved.
	//
	// If LastEvaluatedBackupArn is not empty, this may or may not indicate that
	// there is more data to be returned. All results are guaranteed to have been
	// returned if and only if no value for LastEvaluatedBackupArn is returned.
	LastEvaluatedBackupArn *string `min:"37" type:"string"`
	// contains filtered or unexported fields
}

func (ListBackupsOutput) GoString added in v1.12.36 

func (s ListBackupsOutput) 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 (*ListBackupsOutput) SetBackupSummaries added in v1.12.36 

func (s *ListBackupsOutput) SetBackupSummaries(v []*BackupSummary) *ListBackupsOutput

SetBackupSummaries sets the BackupSummaries field's value.

func (*ListBackupsOutput) SetLastEvaluatedBackupArn added in v1.12.36 

func (s *ListBackupsOutput) SetLastEvaluatedBackupArn(v string) *ListBackupsOutput

SetLastEvaluatedBackupArn sets the LastEvaluatedBackupArn field's value.

func (ListBackupsOutput) String added in v1.12.36 

func (s ListBackupsOutput) 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 ListContributorInsightsInput added in v1.25.43 

type ListContributorInsightsInput struct {

	// Maximum number of results to return per page.
	MaxResults *int64 `type:"integer"`

	// A token to for the desired page, if there is one.
	NextToken *string `type:"string"`

	// The name of the table.
	TableName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

func (ListContributorInsightsInput) GoString added in v1.25.43 

func (s ListContributorInsightsInput) 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 (*ListContributorInsightsInput) SetMaxResults added in v1.25.43 

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

SetMaxResults sets the MaxResults field's value.

func (*ListContributorInsightsInput) SetNextToken added in v1.25.43 

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

SetNextToken sets the NextToken field's value.

func (*ListContributorInsightsInput) SetTableName added in v1.25.43 

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

SetTableName sets the TableName field's value.

func (ListContributorInsightsInput) String added in v1.25.43 

func (s ListContributorInsightsInput) 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 (*ListContributorInsightsInput) Validate added in v1.25.43 

func (s *ListContributorInsightsInput) Validate() error

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

type ListContributorInsightsOutput added in v1.25.43 

type ListContributorInsightsOutput struct {

	// A list of ContributorInsightsSummary.
	ContributorInsightsSummaries []*ContributorInsightsSummary `type:"list"`

	// A token to go to the next page if there is one.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListContributorInsightsOutput) GoString added in v1.25.43 

func (s ListContributorInsightsOutput) 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 (*ListContributorInsightsOutput) SetContributorInsightsSummaries added in v1.25.43 

func (s *ListContributorInsightsOutput) SetContributorInsightsSummaries(v []*ContributorInsightsSummary) *ListContributorInsightsOutput

SetContributorInsightsSummaries sets the ContributorInsightsSummaries field's value.

func (*ListContributorInsightsOutput) SetNextToken added in v1.25.43 

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

SetNextToken sets the NextToken field's value.

func (ListContributorInsightsOutput) String added in v1.25.43 

func (s ListContributorInsightsOutput) 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 ListExportsInput added in v1.35.24 

type ListExportsInput struct {

	// Maximum number of results to return per page.
	MaxResults *int64 `min:"1" type:"integer"`

	// An optional string that, if supplied, must be copied from the output of a
	// previous call to ListExports. When provided in this manner, the API fetches
	// the next page of results.
	NextToken *string `type:"string"`

	// The Amazon Resource Name (ARN) associated with the exported table.
	TableArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListExportsInput) GoString added in v1.35.24 

func (s ListExportsInput) 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 (*ListExportsInput) SetMaxResults added in v1.35.24 

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

SetMaxResults sets the MaxResults field's value.

func (*ListExportsInput) SetNextToken added in v1.35.24 

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

SetNextToken sets the NextToken field's value.

func (*ListExportsInput) SetTableArn added in v1.35.24 

func (s *ListExportsInput) SetTableArn(v string) *ListExportsInput

SetTableArn sets the TableArn field's value.

func (ListExportsInput) String added in v1.35.24 

func (s ListExportsInput) 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 (*ListExportsInput) Validate added in v1.35.24 

func (s *ListExportsInput) Validate() error

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

type ListExportsOutput added in v1.35.24 

type ListExportsOutput struct {

	// A list of ExportSummary objects.
	ExportSummaries []*ExportSummary `type:"list"`

	// If this value is returned, there are additional results to be displayed.
	// To retrieve them, call ListExports again, with NextToken set to this value.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListExportsOutput) GoString added in v1.35.24 

func (s ListExportsOutput) 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 (*ListExportsOutput) SetExportSummaries added in v1.35.24 

func (s *ListExportsOutput) SetExportSummaries(v []*ExportSummary) *ListExportsOutput

SetExportSummaries sets the ExportSummaries field's value.

func (*ListExportsOutput) SetNextToken added in v1.35.24 

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

SetNextToken sets the NextToken field's value.

func (ListExportsOutput) String added in v1.35.24 

func (s ListExportsOutput) 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 ListGlobalTablesInput added in v1.12.36 

type ListGlobalTablesInput struct {

	// The first global table name that this operation will evaluate.
	ExclusiveStartGlobalTableName *string `min:"3" type:"string"`

	// The maximum number of table names to return, if the parameter is not specified
	// DynamoDB defaults to 100.
	//
	// If the number of global tables DynamoDB finds reaches this limit, it stops
	// the operation and returns the table names collected up to that point, with
	// a table name in the LastEvaluatedGlobalTableName to apply in a subsequent
	// operation to the ExclusiveStartGlobalTableName parameter.
	Limit *int64 `min:"1" type:"integer"`

	// Lists the global tables in a specific Region.
	RegionName *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListGlobalTablesInput) GoString added in v1.12.36 

func (s ListGlobalTablesInput) 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 (*ListGlobalTablesInput) SetExclusiveStartGlobalTableName added in v1.12.36 

func (s *ListGlobalTablesInput) SetExclusiveStartGlobalTableName(v string) *ListGlobalTablesInput

SetExclusiveStartGlobalTableName sets the ExclusiveStartGlobalTableName field's value.

func (*ListGlobalTablesInput) SetLimit added in v1.12.36 

func (s *ListGlobalTablesInput) SetLimit(v int64) *ListGlobalTablesInput

SetLimit sets the Limit field's value.

func (*ListGlobalTablesInput) SetRegionName added in v1.12.36 

func (s *ListGlobalTablesInput) SetRegionName(v string) *ListGlobalTablesInput

SetRegionName sets the RegionName field's value.

func (ListGlobalTablesInput) String added in v1.12.36 

func (s ListGlobalTablesInput) 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 (*ListGlobalTablesInput) Validate added in v1.12.36 

func (s *ListGlobalTablesInput) Validate() error

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

type ListGlobalTablesOutput added in v1.12.36 

type ListGlobalTablesOutput struct {

	// List of global table names.
	GlobalTables []*GlobalTable `type:"list"`

	// Last evaluated global table name.
	LastEvaluatedGlobalTableName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

func (ListGlobalTablesOutput) GoString added in v1.12.36 

func (s ListGlobalTablesOutput) 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 (*ListGlobalTablesOutput) SetGlobalTables added in v1.12.36 

func (s *ListGlobalTablesOutput) SetGlobalTables(v []*GlobalTable) *ListGlobalTablesOutput

SetGlobalTables sets the GlobalTables field's value.

func (*ListGlobalTablesOutput) SetLastEvaluatedGlobalTableName added in v1.12.36 

func (s *ListGlobalTablesOutput) SetLastEvaluatedGlobalTableName(v string) *ListGlobalTablesOutput

SetLastEvaluatedGlobalTableName sets the LastEvaluatedGlobalTableName field's value.

func (ListGlobalTablesOutput) String added in v1.12.36 

func (s ListGlobalTablesOutput) 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 first table name that this operation will evaluate. Use the value that
	// was returned for LastEvaluatedTableName in a previous operation, so that
	// you can obtain the next page of results.
	ExclusiveStartTableName *string `min:"3" type:"string"`

	// A maximum number of table names to return. If this parameter is not specified,
	// the limit is 100.
	Limit *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Represents the input of a ListTables operation.

func (ListTablesInput) GoString added in v0.6.5 

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) SetExclusiveStartTableName added in v1.5.0 

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

SetExclusiveStartTableName sets the ExclusiveStartTableName field's value.

func (*ListTablesInput) SetLimit added in v1.5.0 

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

SetLimit sets the Limit field's value.

func (ListTablesInput) String added in v0.6.5 

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 added in v1.1.21 

func (s *ListTablesInput) Validate() error

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

type ListTablesOutput 

type ListTablesOutput struct {

	// The name of the last table in the current page of results. Use this value
	// as the ExclusiveStartTableName in a new request to obtain the next page of
	// results, until all the table names are returned.
	//
	// If you do not receive a LastEvaluatedTableName value in the response, this
	// means that there are no more table names to be retrieved.
	LastEvaluatedTableName *string `min:"3" type:"string"`

	// The names of the tables associated with the current account at the current
	// endpoint. The maximum size of this array is 100.
	//
	// If LastEvaluatedTableName also appears in the output, you can use this value
	// as the ExclusiveStartTableName parameter in a subsequent ListTables request
	// and obtain the next page of results.
	TableNames []*string `type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a ListTables operation.

func (ListTablesOutput) GoString added in v0.6.5 

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) SetLastEvaluatedTableName added in v1.5.0 

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

SetLastEvaluatedTableName sets the LastEvaluatedTableName field's value.

func (*ListTablesOutput) SetTableNames added in v1.5.0 

func (s *ListTablesOutput) SetTableNames(v []*string) *ListTablesOutput

SetTableNames sets the TableNames field's value.

func (ListTablesOutput) String added in v0.6.5 

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 ListTagsOfResourceInput added in v1.6.12 

type ListTagsOfResourceInput struct {

	// An optional string that, if supplied, must be copied from the output of a
	// previous call to ListTagOfResource. When provided in this manner, this API
	// fetches the next page of results.
	NextToken *string `type:"string"`

	// The Amazon DynamoDB resource with tags to be listed. This value is an Amazon
	// Resource Name (ARN).
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsOfResourceInput) GoString added in v1.6.12 

func (s ListTagsOfResourceInput) 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 (*ListTagsOfResourceInput) SetNextToken added in v1.6.12 

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

SetNextToken sets the NextToken field's value.

func (*ListTagsOfResourceInput) SetResourceArn added in v1.6.12 

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

SetResourceArn sets the ResourceArn field's value.

func (ListTagsOfResourceInput) String added in v1.6.12 

func (s ListTagsOfResourceInput) 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 (*ListTagsOfResourceInput) Validate added in v1.6.12 

func (s *ListTagsOfResourceInput) Validate() error

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

type ListTagsOfResourceOutput added in v1.6.12 

type ListTagsOfResourceOutput struct {

	// If this value is returned, there are additional results to be displayed.
	// To retrieve them, call ListTagsOfResource again, with NextToken set to this
	// value.
	NextToken *string `type:"string"`

	// The tags currently associated with the Amazon DynamoDB resource.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsOfResourceOutput) GoString added in v1.6.12 

func (s ListTagsOfResourceOutput) 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 (*ListTagsOfResourceOutput) SetNextToken added in v1.6.12 

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

SetNextToken sets the NextToken field's value.

func (*ListTagsOfResourceOutput) SetTags added in v1.6.12 

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

SetTags sets the Tags field's value.

func (ListTagsOfResourceOutput) String added in v1.6.12 

func (s ListTagsOfResourceOutput) 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 LocalSecondaryIndex 

type LocalSecondaryIndex struct {

	// The name of the local secondary index. The name must be unique among all
	// other indexes on this table.
	//
	// IndexName is a required field
	IndexName *string `min:"3" type:"string" required:"true"`

	// The complete key schema for the local secondary index, consisting of one
	// or more pairs of attribute names and key types:
	//
	//    * HASH - partition key
	//
	//    * RANGE - sort key
	//
	// The partition key of an item is also known as its hash attribute. The term
	// "hash attribute" derives from DynamoDB's usage of an internal hash function
	// to evenly distribute data items across partitions, based on their partition
	// key values.
	//
	// The sort key of an item is also known as its range attribute. The term "range
	// attribute" derives from the way DynamoDB stores items with the same partition
	// key physically close together, in sorted order by the sort key value.
	//
	// KeySchema is a required field
	KeySchema []*KeySchemaElement `min:"1" type:"list" required:"true"`

	// Represents attributes that are copied (projected) from the table into the
	// local secondary index. These are in addition to the primary key attributes
	// and index key attributes, which are automatically projected.
	//
	// Projection is a required field
	Projection *Projection `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the properties of a local secondary index.

func (LocalSecondaryIndex) GoString added in v0.6.5 

func (s LocalSecondaryIndex) 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 (*LocalSecondaryIndex) SetIndexName added in v1.5.0 

func (s *LocalSecondaryIndex) SetIndexName(v string) *LocalSecondaryIndex

SetIndexName sets the IndexName field's value.

func (*LocalSecondaryIndex) SetKeySchema added in v1.5.0 

func (s *LocalSecondaryIndex) SetKeySchema(v []*KeySchemaElement) *LocalSecondaryIndex

SetKeySchema sets the KeySchema field's value.

func (*LocalSecondaryIndex) SetProjection added in v1.5.0 

func (s *LocalSecondaryIndex) SetProjection(v *Projection) *LocalSecondaryIndex

SetProjection sets the Projection field's value.

func (LocalSecondaryIndex) String added in v0.6.5 

func (s LocalSecondaryIndex) 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 (*LocalSecondaryIndex) Validate added in v1.1.21 

func (s *LocalSecondaryIndex) Validate() error

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

type LocalSecondaryIndexDescription 

type LocalSecondaryIndexDescription struct {

	// The Amazon Resource Name (ARN) that uniquely identifies the index.
	IndexArn *string `type:"string"`

	// Represents the name of the local secondary index.
	IndexName *string `min:"3" type:"string"`

	// The total size of the specified index, in bytes. DynamoDB updates this value
	// approximately every six hours. Recent changes might not be reflected in this
	// value.
	IndexSizeBytes *int64 `type:"long"`

	// The number of items in the specified index. DynamoDB updates this value approximately
	// every six hours. Recent changes might not be reflected in this value.
	ItemCount *int64 `type:"long"`

	// The complete key schema for the local secondary index, consisting of one
	// or more pairs of attribute names and key types:
	//
	//    * HASH - partition key
	//
	//    * RANGE - sort key
	//
	// The partition key of an item is also known as its hash attribute. The term
	// "hash attribute" derives from DynamoDB's usage of an internal hash function
	// to evenly distribute data items across partitions, based on their partition
	// key values.
	//
	// The sort key of an item is also known as its range attribute. The term "range
	// attribute" derives from the way DynamoDB stores items with the same partition
	// key physically close together, in sorted order by the sort key value.
	KeySchema []*KeySchemaElement `min:"1" type:"list"`

	// Represents attributes that are copied (projected) from the table into the
	// global secondary index. These are in addition to the primary key attributes
	// and index key attributes, which are automatically projected.
	Projection *Projection `type:"structure"`
	// contains filtered or unexported fields
}

Represents the properties of a local secondary index.

func (LocalSecondaryIndexDescription) GoString added in v0.6.5 

func (s LocalSecondaryIndexDescription) 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 (*LocalSecondaryIndexDescription) SetIndexArn added in v1.5.0 

func (s *LocalSecondaryIndexDescription) SetIndexArn(v string) *LocalSecondaryIndexDescription

SetIndexArn sets the IndexArn field's value.

func (*LocalSecondaryIndexDescription) SetIndexName added in v1.5.0 

func (s *LocalSecondaryIndexDescription) SetIndexName(v string) *LocalSecondaryIndexDescription

SetIndexName sets the IndexName field's value.

func (*LocalSecondaryIndexDescription) SetIndexSizeBytes added in v1.5.0 

func (s *LocalSecondaryIndexDescription) SetIndexSizeBytes(v int64) *LocalSecondaryIndexDescription

SetIndexSizeBytes sets the IndexSizeBytes field's value.

func (*LocalSecondaryIndexDescription) SetItemCount added in v1.5.0 

func (s *LocalSecondaryIndexDescription) SetItemCount(v int64) *LocalSecondaryIndexDescription

SetItemCount sets the ItemCount field's value.

func (*LocalSecondaryIndexDescription) SetKeySchema added in v1.5.0 

func (s *LocalSecondaryIndexDescription) SetKeySchema(v []*KeySchemaElement) *LocalSecondaryIndexDescription

SetKeySchema sets the KeySchema field's value.

func (*LocalSecondaryIndexDescription) SetProjection added in v1.5.0 

func (s *LocalSecondaryIndexDescription) SetProjection(v *Projection) *LocalSecondaryIndexDescription

SetProjection sets the Projection field's value.

func (LocalSecondaryIndexDescription) String added in v0.6.5 

func (s LocalSecondaryIndexDescription) 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 LocalSecondaryIndexInfo added in v1.12.36 

type LocalSecondaryIndexInfo struct {

	// Represents the name of the local secondary index.
	IndexName *string `min:"3" type:"string"`

	// The complete key schema for a local secondary index, which consists of one
	// or more pairs of attribute names and key types:
	//
	//    * HASH - partition key
	//
	//    * RANGE - sort key
	//
	// The partition key of an item is also known as its hash attribute. The term
	// "hash attribute" derives from DynamoDB's usage of an internal hash function
	// to evenly distribute data items across partitions, based on their partition
	// key values.
	//
	// The sort key of an item is also known as its range attribute. The term "range
	// attribute" derives from the way DynamoDB stores items with the same partition
	// key physically close together, in sorted order by the sort key value.
	KeySchema []*KeySchemaElement `min:"1" type:"list"`

	// Represents attributes that are copied (projected) from the table into the
	// global secondary index. These are in addition to the primary key attributes
	// and index key attributes, which are automatically projected.
	Projection *Projection `type:"structure"`
	// contains filtered or unexported fields
}

Represents the properties of a local secondary index for the table when the backup was created.

func (LocalSecondaryIndexInfo) GoString added in v1.12.36 

func (s LocalSecondaryIndexInfo) 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 (*LocalSecondaryIndexInfo) SetIndexName added in v1.12.36 

func (s *LocalSecondaryIndexInfo) SetIndexName(v string) *LocalSecondaryIndexInfo

SetIndexName sets the IndexName field's value.

func (*LocalSecondaryIndexInfo) SetKeySchema added in v1.12.36 

func (s *LocalSecondaryIndexInfo) SetKeySchema(v []*KeySchemaElement) *LocalSecondaryIndexInfo

SetKeySchema sets the KeySchema field's value.

func (*LocalSecondaryIndexInfo) SetProjection added in v1.12.36 

func (s *LocalSecondaryIndexInfo) SetProjection(v *Projection) *LocalSecondaryIndexInfo

SetProjection sets the Projection field's value.

func (LocalSecondaryIndexInfo) String added in v1.12.36 

func (s LocalSecondaryIndexInfo) 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 ParameterizedStatement added in v1.35.34 

type ParameterizedStatement struct {

	// The parameter values.
	Parameters []*AttributeValue `min:"1" type:"list"`

	// A PartiQL statment that uses parameters.
	//
	// Statement is a required field
	Statement *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a PartiQL statment that uses parameters.

func (ParameterizedStatement) GoString added in v1.35.34 

func (s ParameterizedStatement) 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 (*ParameterizedStatement) SetParameters added in v1.35.34 

func (s *ParameterizedStatement) SetParameters(v []*AttributeValue) *ParameterizedStatement

SetParameters sets the Parameters field's value.

func (*ParameterizedStatement) SetStatement added in v1.35.34 

func (s *ParameterizedStatement) SetStatement(v string) *ParameterizedStatement

SetStatement sets the Statement field's value.

func (ParameterizedStatement) String added in v1.35.34 

func (s ParameterizedStatement) 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 (*ParameterizedStatement) Validate added in v1.35.34 

func (s *ParameterizedStatement) Validate() error

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

type PointInTimeRecoveryDescription added in v1.13.21 

type PointInTimeRecoveryDescription struct {

	// Specifies the earliest point in time you can restore your table to. You can
	// restore your table to any point in time during the last 35 days.
	EarliestRestorableDateTime *time.Time `type:"timestamp"`

	// LatestRestorableDateTime is typically 5 minutes before the current time.
	LatestRestorableDateTime *time.Time `type:"timestamp"`

	// The current state of point in time recovery:
	//
	//    * ENABLED - Point in time recovery is enabled.
	//
	//    * DISABLED - Point in time recovery is disabled.
	PointInTimeRecoveryStatus *string `type:"string" enum:"PointInTimeRecoveryStatus"`
	// contains filtered or unexported fields
}

The description of the point in time settings applied to the table.

func (PointInTimeRecoveryDescription) GoString added in v1.13.21 

func (s PointInTimeRecoveryDescription) 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 (*PointInTimeRecoveryDescription) SetEarliestRestorableDateTime added in v1.13.21 

func (s *PointInTimeRecoveryDescription) SetEarliestRestorableDateTime(v time.Time) *PointInTimeRecoveryDescription

SetEarliestRestorableDateTime sets the EarliestRestorableDateTime field's value.

func (*PointInTimeRecoveryDescription) SetLatestRestorableDateTime added in v1.13.21 

func (s *PointInTimeRecoveryDescription) SetLatestRestorableDateTime(v time.Time) *PointInTimeRecoveryDescription

SetLatestRestorableDateTime sets the LatestRestorableDateTime field's value.

func (*PointInTimeRecoveryDescription) SetPointInTimeRecoveryStatus added in v1.13.21 

func (s *PointInTimeRecoveryDescription) SetPointInTimeRecoveryStatus(v string) *PointInTimeRecoveryDescription

SetPointInTimeRecoveryStatus sets the PointInTimeRecoveryStatus field's value.

func (PointInTimeRecoveryDescription) String added in v1.13.21 

func (s PointInTimeRecoveryDescription) 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 PointInTimeRecoverySpecification added in v1.13.21 

type PointInTimeRecoverySpecification struct {

	// Indicates whether point in time recovery is enabled (true) or disabled (false)
	// on the table.
	//
	// PointInTimeRecoveryEnabled is a required field
	PointInTimeRecoveryEnabled *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Represents the settings used to enable point in time recovery.

func (PointInTimeRecoverySpecification) GoString added in v1.13.21 

func (s PointInTimeRecoverySpecification) 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 (*PointInTimeRecoverySpecification) SetPointInTimeRecoveryEnabled added in v1.13.21 

func (s *PointInTimeRecoverySpecification) SetPointInTimeRecoveryEnabled(v bool) *PointInTimeRecoverySpecification

SetPointInTimeRecoveryEnabled sets the PointInTimeRecoveryEnabled field's value.

func (PointInTimeRecoverySpecification) String added in v1.13.21 

func (s PointInTimeRecoverySpecification) 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 (*PointInTimeRecoverySpecification) Validate added in v1.13.21 

func (s *PointInTimeRecoverySpecification) Validate() error

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

type PointInTimeRecoveryUnavailableException added in v1.28.0 

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

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

Point in time recovery has not yet been enabled for this source table.

func (*PointInTimeRecoveryUnavailableException) Code added in v1.28.0 

func (s *PointInTimeRecoveryUnavailableException) Code() string

Code returns the exception type name.

func (*PointInTimeRecoveryUnavailableException) Error added in v1.28.0 

func (s *PointInTimeRecoveryUnavailableException) Error() string

func (PointInTimeRecoveryUnavailableException) GoString added in v1.28.0 

func (s PointInTimeRecoveryUnavailableException) 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 (*PointInTimeRecoveryUnavailableException) Message added in v1.28.0 

func (s *PointInTimeRecoveryUnavailableException) Message() string

Message returns the exception's message.

func (*PointInTimeRecoveryUnavailableException) OrigErr added in v1.28.0 

func (s *PointInTimeRecoveryUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*PointInTimeRecoveryUnavailableException) RequestID added in v1.28.0 

func (s *PointInTimeRecoveryUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*PointInTimeRecoveryUnavailableException) StatusCode added in v1.28.0 

func (s *PointInTimeRecoveryUnavailableException) StatusCode() int

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

func (PointInTimeRecoveryUnavailableException) String added in v1.28.0 

func (s PointInTimeRecoveryUnavailableException) 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 Projection 

type Projection struct {

	// Represents the non-key attribute names which will be projected into the index.
	//
	// For local secondary indexes, the total count of NonKeyAttributes summed across
	// all of the local secondary indexes, must not exceed 100. If you project the
	// same attribute into two different indexes, this counts as two distinct attributes
	// when determining the total.
	NonKeyAttributes []*string `min:"1" type:"list"`

	// The set of attributes that are projected into the index:
	//
	//    * KEYS_ONLY - Only the index and primary keys are projected into the index.
	//
	//    * INCLUDE - In addition to the attributes described in KEYS_ONLY, the
	//    secondary index will include other non-key attributes that you specify.
	//
	//    * ALL - All of the table attributes are projected into the index.
	ProjectionType *string `type:"string" enum:"ProjectionType"`
	// contains filtered or unexported fields
}

Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

func (Projection) GoString added in v0.6.5 

func (s Projection) 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 (*Projection) SetNonKeyAttributes added in v1.5.0 

func (s *Projection) SetNonKeyAttributes(v []*string) *Projection

SetNonKeyAttributes sets the NonKeyAttributes field's value.

func (*Projection) SetProjectionType added in v1.5.0 

func (s *Projection) SetProjectionType(v string) *Projection

SetProjectionType sets the ProjectionType field's value.

func (Projection) String added in v0.6.5 

func (s Projection) 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 (*Projection) Validate added in v1.1.21 

func (s *Projection) Validate() error

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

type ProvisionedThroughput 

type ProvisionedThroughput struct {

	// The maximum number of strongly consistent reads consumed per second before
	// DynamoDB returns a ThrottlingException. For more information, see Specifying
	// Read and Write Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput)
	// in the Amazon DynamoDB Developer Guide.
	//
	// If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
	//
	// ReadCapacityUnits is a required field
	ReadCapacityUnits *int64 `min:"1" type:"long" required:"true"`

	// The maximum number of writes consumed per second before DynamoDB returns
	// a ThrottlingException. For more information, see Specifying Read and Write
	// Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput)
	// in the Amazon DynamoDB Developer Guide.
	//
	// If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
	//
	// WriteCapacityUnits is a required field
	WriteCapacityUnits *int64 `min:"1" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide.

func (ProvisionedThroughput) GoString added in v0.6.5 

func (s ProvisionedThroughput) 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 (*ProvisionedThroughput) SetReadCapacityUnits added in v1.5.0 

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

SetReadCapacityUnits sets the ReadCapacityUnits field's value.

func (*ProvisionedThroughput) SetWriteCapacityUnits added in v1.5.0 

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

SetWriteCapacityUnits sets the WriteCapacityUnits field's value.

func (ProvisionedThroughput) String added in v0.6.5 

func (s ProvisionedThroughput) 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 (*ProvisionedThroughput) Validate added in v1.1.21 

func (s *ProvisionedThroughput) Validate() error

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

type ProvisionedThroughputDescription 

type ProvisionedThroughputDescription struct {

	// The date and time of the last provisioned throughput decrease for this table.
	LastDecreaseDateTime *time.Time `type:"timestamp"`

	// The date and time of the last provisioned throughput increase for this table.
	LastIncreaseDateTime *time.Time `type:"timestamp"`

	// The number of provisioned throughput decreases for this table during this
	// UTC calendar day. For current maximums on provisioned throughput decreases,
	// see Service, Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
	// in the Amazon DynamoDB Developer Guide.
	NumberOfDecreasesToday *int64 `min:"1" type:"long"`

	// The maximum number of strongly consistent reads consumed per second before
	// DynamoDB returns a ThrottlingException. Eventually consistent reads require
	// less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits
	// per second provides 100 eventually consistent ReadCapacityUnits per second.
	ReadCapacityUnits *int64 `type:"long"`

	// The maximum number of writes consumed per second before DynamoDB returns
	// a ThrottlingException.
	WriteCapacityUnits *int64 `type:"long"`
	// contains filtered or unexported fields
}

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

func (ProvisionedThroughputDescription) GoString added in v0.6.5 

func (s ProvisionedThroughputDescription) 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 (*ProvisionedThroughputDescription) SetLastDecreaseDateTime added in v1.5.0 

func (s *ProvisionedThroughputDescription) SetLastDecreaseDateTime(v time.Time) *ProvisionedThroughputDescription

SetLastDecreaseDateTime sets the LastDecreaseDateTime field's value.

func (*ProvisionedThroughputDescription) SetLastIncreaseDateTime added in v1.5.0 

func (s *ProvisionedThroughputDescription) SetLastIncreaseDateTime(v time.Time) *ProvisionedThroughputDescription

SetLastIncreaseDateTime sets the LastIncreaseDateTime field's value.

func (*ProvisionedThroughputDescription) SetNumberOfDecreasesToday added in v1.5.0 

func (s *ProvisionedThroughputDescription) SetNumberOfDecreasesToday(v int64) *ProvisionedThroughputDescription

SetNumberOfDecreasesToday sets the NumberOfDecreasesToday field's value.

func (*ProvisionedThroughputDescription) SetReadCapacityUnits added in v1.5.0 

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

SetReadCapacityUnits sets the ReadCapacityUnits field's value.

func (*ProvisionedThroughputDescription) SetWriteCapacityUnits added in v1.5.0 

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

SetWriteCapacityUnits sets the WriteCapacityUnits field's value.

func (ProvisionedThroughputDescription) String added in v0.6.5 

func (s ProvisionedThroughputDescription) 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 ProvisionedThroughputExceededException added in v1.28.0 

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

	// You exceeded your maximum allowed provisioned throughput.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Programming.Errors.html#Programming.Errors.RetryAndBackoff) in the Amazon DynamoDB Developer Guide.

func (*ProvisionedThroughputExceededException) Code added in v1.28.0 

func (s *ProvisionedThroughputExceededException) Code() string

Code returns the exception type name.

func (*ProvisionedThroughputExceededException) Error added in v1.28.0 

func (s *ProvisionedThroughputExceededException) Error() string

func (ProvisionedThroughputExceededException) GoString added in v1.28.0 

func (s ProvisionedThroughputExceededException) 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 (*ProvisionedThroughputExceededException) Message added in v1.28.0 

func (s *ProvisionedThroughputExceededException) Message() string

Message returns the exception's message.

func (*ProvisionedThroughputExceededException) OrigErr added in v1.28.0 

func (s *ProvisionedThroughputExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ProvisionedThroughputExceededException) RequestID added in v1.28.0 

func (s *ProvisionedThroughputExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ProvisionedThroughputExceededException) StatusCode added in v1.28.0 

func (s *ProvisionedThroughputExceededException) StatusCode() int

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

func (ProvisionedThroughputExceededException) String added in v1.28.0 

func (s ProvisionedThroughputExceededException) 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 ProvisionedThroughputOverride added in v1.25.40 

type ProvisionedThroughputOverride struct {

	// Replica-specific read capacity units. If not specified, uses the source table's
	// read capacity settings.
	ReadCapacityUnits *int64 `min:"1" type:"long"`
	// contains filtered or unexported fields
}

Replica-specific provisioned throughput settings. If not specified, uses the source table's provisioned throughput settings.

func (ProvisionedThroughputOverride) GoString added in v1.25.40 

func (s ProvisionedThroughputOverride) 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 (*ProvisionedThroughputOverride) SetReadCapacityUnits added in v1.25.40 

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

SetReadCapacityUnits sets the ReadCapacityUnits field's value.

func (ProvisionedThroughputOverride) String added in v1.25.40 

func (s ProvisionedThroughputOverride) 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 (*ProvisionedThroughputOverride) Validate added in v1.25.40 

func (s *ProvisionedThroughputOverride) Validate() error

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

type Put added in v1.15.85 

type Put struct {

	// A condition that must be satisfied in order for a conditional update to succeed.
	ConditionExpression *string `type:"string"`

	// One or more substitution tokens for attribute names in an expression.
	ExpressionAttributeNames map[string]*string `type:"map"`

	// One or more values that can be substituted in an expression.
	ExpressionAttributeValues map[string]*AttributeValue `type:"map"`

	// A map of attribute name to attribute values, representing the primary key
	// of the item to be written by PutItem. All of the table's primary key attributes
	// must be specified, and their data types must match those of the table's key
	// schema. If any attributes are present in the item that are part of an index
	// key schema for the table, their types must match the index key schema.
	//
	// Item is a required field
	Item map[string]*AttributeValue `type:"map" required:"true"`

	// Use ReturnValuesOnConditionCheckFailure to get the item attributes if the
	// Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values
	// are: NONE and ALL_OLD.
	ReturnValuesOnConditionCheckFailure *string `type:"string" enum:"ReturnValuesOnConditionCheckFailure"`

	// Name of the table in which to write the item.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a request to perform a PutItem operation.

func (Put) GoString added in v1.15.85 

func (s Put) 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 (*Put) SetConditionExpression added in v1.15.85 

func (s *Put) SetConditionExpression(v string) *Put

SetConditionExpression sets the ConditionExpression field's value.

func (*Put) SetExpressionAttributeNames added in v1.15.85 

func (s *Put) SetExpressionAttributeNames(v map[string]*string) *Put

SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.

func (*Put) SetExpressionAttributeValues added in v1.15.85 

func (s *Put) SetExpressionAttributeValues(v map[string]*AttributeValue) *Put

SetExpressionAttributeValues sets the ExpressionAttributeValues field's value.

func (*Put) SetItem added in v1.15.85 

func (s *Put) SetItem(v map[string]*AttributeValue) *Put

SetItem sets the Item field's value.

func (*Put) SetReturnValuesOnConditionCheckFailure added in v1.15.85 

func (s *Put) SetReturnValuesOnConditionCheckFailure(v string) *Put

SetReturnValuesOnConditionCheckFailure sets the ReturnValuesOnConditionCheckFailure field's value.

func (*Put) SetTableName added in v1.15.85 

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

SetTableName sets the TableName field's value.

func (Put) String added in v1.15.85 

func (s Put) 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 (*Put) Validate added in v1.15.85 

func (s *Put) Validate() error

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

type PutItemInput 

type PutItemInput struct {

	// A condition that must be satisfied in order for a conditional PutItem operation
	// to succeed.
	//
	// An expression can contain any of the following:
	//
	//    * Functions: attribute_exists | attribute_not_exists | attribute_type
	//    | contains | begins_with | size These function names are case-sensitive.
	//
	//    * Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
	//
	//    * Logical operators: AND | OR | NOT
	//
	// For more information on condition expressions, see Condition Expressions
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
	// in the Amazon DynamoDB Developer Guide.
	ConditionExpression *string `type:"string"`

	// This is a legacy parameter. Use ConditionExpression instead. For more information,
	// see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html)
	// in the Amazon DynamoDB Developer Guide.
	ConditionalOperator *string `type:"string" enum:"ConditionalOperator"`

	// This is a legacy parameter. Use ConditionExpression instead. For more information,
	// see Expected (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html)
	// in the Amazon DynamoDB Developer Guide.
	Expected map[string]*ExpectedAttributeValue `type:"map"`

	// One or more substitution tokens for attribute names in an expression. The
	// following are some use cases for using ExpressionAttributeNames:
	//
	//    * To access an attribute whose name conflicts with a DynamoDB reserved
	//    word.
	//
	//    * To create a placeholder for repeating occurrences of an attribute name
	//    in an expression.
	//
	//    * To prevent special characters in an attribute name from being misinterpreted
	//    in an expression.
	//
	// Use the # character in an expression to dereference an attribute name. For
	// example, consider the following attribute name:
	//
	//    * Percentile
	//
	// The name of this attribute conflicts with a reserved word, so it cannot be
	// used directly in an expression. (For the complete list of reserved words,
	// see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
	// in the Amazon DynamoDB Developer Guide). To work around this, you could specify
	// the following for ExpressionAttributeNames:
	//
	//    * {"#P":"Percentile"}
	//
	// You could then use this substitution in an expression, as in this example:
	//
	//    * #P = :val
	//
	// Tokens that begin with the : character are expression attribute values, which
	// are placeholders for the actual value at runtime.
	//
	// For more information on expression attribute names, see Specifying Item Attributes
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
	// in the Amazon DynamoDB Developer Guide.
	ExpressionAttributeNames map[string]*string `type:"map"`

	// One or more values that can be substituted in an expression.
	//
	// Use the : (colon) character in an expression to dereference an attribute
	// value. For example, suppose that you wanted to check whether the value of
	// the ProductStatus attribute was one of the following:
	//
	// Available | Backordered | Discontinued
	//
	// You would first need to specify ExpressionAttributeValues as follows:
	//
	// { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"}
	// }
	//
	// You could then use these values in an expression, such as this:
	//
	// ProductStatus IN (:avail, :back, :disc)
	//
	// For more information on expression attribute values, see Condition Expressions
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
	// in the Amazon DynamoDB Developer Guide.
	ExpressionAttributeValues map[string]*AttributeValue `type:"map"`

	// A map of attribute name/value pairs, one for each attribute. Only the primary
	// key attributes are required; you can optionally provide other attribute name-value
	// pairs for the item.
	//
	// You must provide all of the attributes for the primary key. For example,
	// with a simple primary key, you only need to provide a value for the partition
	// key. For a composite primary key, you must provide both values for both the
	// partition key and the sort key.
	//
	// If you specify any attributes that are part of an index key, then the data
	// types for those attributes must match those of the schema in the table's
	// attribute definition.
	//
	// Empty String and Binary attribute values are allowed. Attribute values of
	// type String and Binary must have a length greater than zero if the attribute
	// is used as a key attribute for a table or index.
	//
	// For more information about primary keys, see Primary Key (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.PrimaryKey)
	// in the Amazon DynamoDB Developer Guide.
	//
	// Each element in the Item map is an AttributeValue object.
	//
	// Item is a required field
	Item map[string]*AttributeValue `type:"map" required:"true"`

	// Determines the level of detail about either provisioned or on-demand throughput
	// consumption that is returned in the response:
	//
	//    * INDEXES - The response includes the aggregate ConsumedCapacity for the
	//    operation, together with ConsumedCapacity for each table and secondary
	//    index that was accessed. Note that some operations, such as GetItem and
	//    BatchGetItem, do not access any indexes at all. In these cases, specifying
	//    INDEXES will only return ConsumedCapacity information for table(s).
	//
	//    * TOTAL - The response includes only the aggregate ConsumedCapacity for
	//    the operation.
	//
	//    * NONE - No ConsumedCapacity details are included in the response.
	ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"`

	// Determines whether item collection metrics are returned. If set to SIZE,
	// the response includes statistics about item collections, if any, that were
	// modified during the operation are returned in the response. If set to NONE
	// (the default), no statistics are returned.
	ReturnItemCollectionMetrics *string `type:"string" enum:"ReturnItemCollectionMetrics"`

	// Use ReturnValues if you want to get the item attributes as they appeared
	// before they were updated with the PutItem request. For PutItem, the valid
	// values are:
	//
	//    * NONE - If ReturnValues is not specified, or if its value is NONE, then
	//    nothing is returned. (This setting is the default for ReturnValues.)
	//
	//    * ALL_OLD - If PutItem overwrote an attribute name-value pair, then the
	//    content of the old item is returned.
	//
	// The values returned are strongly consistent.
	//
	// There is no additional cost associated with requesting a return value aside
	// from the small network and processing overhead of receiving a larger response.
	// No read capacity units are consumed.
	//
	// The ReturnValues parameter is used by several DynamoDB operations; however,
	// PutItem does not recognize any values other than NONE or ALL_OLD.
	ReturnValues *string `type:"string" enum:"ReturnValue"`

	// The name of the table to contain the item.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a PutItem operation.

func (PutItemInput) GoString added in v0.6.5 

func (s PutItemInput) 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 (*PutItemInput) SetConditionExpression added in v1.5.0 

func (s *PutItemInput) SetConditionExpression(v string) *PutItemInput

SetConditionExpression sets the ConditionExpression field's value.

func (*PutItemInput) SetConditionalOperator added in v1.5.0 

func (s *PutItemInput) SetConditionalOperator(v string) *PutItemInput

SetConditionalOperator sets the ConditionalOperator field's value.

func (*PutItemInput) SetExpected added in v1.5.0 

func (s *PutItemInput) SetExpected(v map[string]*ExpectedAttributeValue) *PutItemInput

SetExpected sets the Expected field's value.

func (*PutItemInput) SetExpressionAttributeNames added in v1.5.0 

func (s *PutItemInput) SetExpressionAttributeNames(v map[string]*string) *PutItemInput

SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.

func (*PutItemInput) SetExpressionAttributeValues added in v1.5.0 

func (s *PutItemInput) SetExpressionAttributeValues(v map[string]*AttributeValue) *PutItemInput

SetExpressionAttributeValues sets the ExpressionAttributeValues field's value.

func (*PutItemInput) SetItem added in v1.5.0 

func (s *PutItemInput) SetItem(v map[string]*AttributeValue) *PutItemInput

SetItem sets the Item field's value.

func (*PutItemInput) SetReturnConsumedCapacity added in v1.5.0 

func (s *PutItemInput) SetReturnConsumedCapacity(v string) *PutItemInput

SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.

func (*PutItemInput) SetReturnItemCollectionMetrics added in v1.5.0 

func (s *PutItemInput) SetReturnItemCollectionMetrics(v string) *PutItemInput

SetReturnItemCollectionMetrics sets the ReturnItemCollectionMetrics field's value.

func (*PutItemInput) SetReturnValues added in v1.5.0 

func (s *PutItemInput) SetReturnValues(v string) *PutItemInput

SetReturnValues sets the ReturnValues field's value.

func (*PutItemInput) SetTableName added in v1.5.0 

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

SetTableName sets the TableName field's value.

func (PutItemInput) String added in v0.6.5 

func (s PutItemInput) 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 (*PutItemInput) Validate added in v1.1.21 

func (s *PutItemInput) Validate() error

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

type PutItemOutput 

type PutItemOutput struct {

	// The attribute values as they appeared before the PutItem operation, but only
	// if ReturnValues is specified as ALL_OLD in the request. Each element consists
	// of an attribute name and an attribute value.
	Attributes map[string]*AttributeValue `type:"map"`

	// The capacity units consumed by the PutItem operation. The data returned includes
	// the total provisioned throughput consumed, along with statistics for the
	// table and any indexes involved in the operation. ConsumedCapacity is only
	// returned if the ReturnConsumedCapacity parameter was specified. For more
	// information, see Read/Write Capacity Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
	// in the Amazon DynamoDB Developer Guide.
	ConsumedCapacity *ConsumedCapacity `type:"structure"`

	// Information about item collections, if any, that were affected by the PutItem
	// operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics
	// parameter was specified. If the table does not have any local secondary indexes,
	// this information is not returned in the response.
	//
	// Each ItemCollectionMetrics element consists of:
	//
	//    * ItemCollectionKey - The partition key value of the item collection.
	//    This is the same as the partition key value of the item itself.
	//
	//    * SizeEstimateRangeGB - An estimate of item collection size, in gigabytes.
	//    This value is a two-element array containing a lower bound and an upper
	//    bound for the estimate. The estimate includes the size of all the items
	//    in the table, plus the size of all attributes projected into all of the
	//    local secondary indexes on that table. Use this estimate to measure whether
	//    a local secondary index is approaching its size limit. The estimate is
	//    subject to change over time; therefore, do not rely on the precision or
	//    accuracy of the estimate.
	ItemCollectionMetrics *ItemCollectionMetrics `type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a PutItem operation.

func (PutItemOutput) GoString added in v0.6.5 

func (s PutItemOutput) 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 (*PutItemOutput) SetAttributes added in v1.5.0 

func (s *PutItemOutput) SetAttributes(v map[string]*AttributeValue) *PutItemOutput

SetAttributes sets the Attributes field's value.

func (*PutItemOutput) SetConsumedCapacity added in v1.5.0 

func (s *PutItemOutput) SetConsumedCapacity(v *ConsumedCapacity) *PutItemOutput

SetConsumedCapacity sets the ConsumedCapacity field's value.

func (*PutItemOutput) SetItemCollectionMetrics added in v1.5.0 

func (s *PutItemOutput) SetItemCollectionMetrics(v *ItemCollectionMetrics) *PutItemOutput

SetItemCollectionMetrics sets the ItemCollectionMetrics field's value.

func (PutItemOutput) String added in v0.6.5 

func (s PutItemOutput) 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 PutRequest 

type PutRequest struct {

	// A map of attribute name to attribute values, representing the primary key
	// of an item to be processed by PutItem. All of the table's primary key attributes
	// must be specified, and their data types must match those of the table's key
	// schema. If any attributes are present in the item that are part of an index
	// key schema for the table, their types must match the index key schema.
	//
	// Item is a required field
	Item map[string]*AttributeValue `type:"map" required:"true"`
	// contains filtered or unexported fields
}

Represents a request to perform a PutItem operation on an item.

func (PutRequest) GoString added in v0.6.5 

func (s PutRequest) 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 (*PutRequest) SetItem added in v1.5.0 

func (s *PutRequest) SetItem(v map[string]*AttributeValue) *PutRequest

SetItem sets the Item field's value.

func (PutRequest) String added in v0.6.5 

func (s PutRequest) 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 QueryInput 

type QueryInput struct {

	// This is a legacy parameter. Use ProjectionExpression instead. For more information,
	// see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html)
	// in the Amazon DynamoDB Developer Guide.
	AttributesToGet []*string `min:"1" type:"list"`

	// This is a legacy parameter. Use FilterExpression instead. For more information,
	// see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html)
	// in the Amazon DynamoDB Developer Guide.
	ConditionalOperator *string `type:"string" enum:"ConditionalOperator"`

	// Determines the read consistency model: If set to true, then the operation
	// uses strongly consistent reads; otherwise, the operation uses eventually
	// consistent reads.
	//
	// Strongly consistent reads are not supported on global secondary indexes.
	// If you query a global secondary index with ConsistentRead set to true, you
	// will receive a ValidationException.
	ConsistentRead *bool `type:"boolean"`

	// The primary key of the first item that this operation will evaluate. Use
	// the value that was returned for LastEvaluatedKey in the previous operation.
	//
	// The data type for ExclusiveStartKey must be String, Number, or Binary. No
	// set data types are allowed.
	ExclusiveStartKey map[string]*AttributeValue `type:"map"`

	// One or more substitution tokens for attribute names in an expression. The
	// following are some use cases for using ExpressionAttributeNames:
	//
	//    * To access an attribute whose name conflicts with a DynamoDB reserved
	//    word.
	//
	//    * To create a placeholder for repeating occurrences of an attribute name
	//    in an expression.
	//
	//    * To prevent special characters in an attribute name from being misinterpreted
	//    in an expression.
	//
	// Use the # character in an expression to dereference an attribute name. For
	// example, consider the following attribute name:
	//
	//    * Percentile
	//
	// The name of this attribute conflicts with a reserved word, so it cannot be
	// used directly in an expression. (For the complete list of reserved words,
	// see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
	// in the Amazon DynamoDB Developer Guide). To work around this, you could specify
	// the following for ExpressionAttributeNames:
	//
	//    * {"#P":"Percentile"}
	//
	// You could then use this substitution in an expression, as in this example:
	//
	//    * #P = :val
	//
	// Tokens that begin with the : character are expression attribute values, which
	// are placeholders for the actual value at runtime.
	//
	// For more information on expression attribute names, see Specifying Item Attributes
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
	// in the Amazon DynamoDB Developer Guide.
	ExpressionAttributeNames map[string]*string `type:"map"`

	// One or more values that can be substituted in an expression.
	//
	// Use the : (colon) character in an expression to dereference an attribute
	// value. For example, suppose that you wanted to check whether the value of
	// the ProductStatus attribute was one of the following:
	//
	// Available | Backordered | Discontinued
	//
	// You would first need to specify ExpressionAttributeValues as follows:
	//
	// { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"}
	// }
	//
	// You could then use these values in an expression, such as this:
	//
	// ProductStatus IN (:avail, :back, :disc)
	//
	// For more information on expression attribute values, see Specifying Conditions
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
	// in the Amazon DynamoDB Developer Guide.
	ExpressionAttributeValues map[string]*AttributeValue `type:"map"`

	// A string that contains conditions that DynamoDB applies after the Query operation,
	// but before the data is returned to you. Items that do not satisfy the FilterExpression
	// criteria are not returned.
	//
	// A FilterExpression does not allow key attributes. You cannot define a filter
	// expression based on a partition key or a sort key.
	//
	// A FilterExpression is applied after the items have already been read; the
	// process of filtering does not consume any additional read capacity units.
	//
	// For more information, see Filter Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Query.FilterExpression)
	// in the Amazon DynamoDB Developer Guide.
	FilterExpression *string `type:"string"`

	// The name of an index to query. This index can be any local secondary index
	// or global secondary index on the table. Note that if you use the IndexName
	// parameter, you must also provide TableName.
	IndexName *string `min:"3" type:"string"`

	// The condition that specifies the key values for items to be retrieved by
	// the Query action.
	//
	// The condition must perform an equality test on a single partition key value.
	//
	// The condition can optionally perform one of several comparison tests on a
	// single sort key value. This allows Query to retrieve one item with a given
	// partition key value and sort key value, or several items that have the same
	// partition key value but different sort key values.
	//
	// The partition key equality test is required, and must be specified in the
	// following format:
	//
	// partitionKeyName = :partitionkeyval
	//
	// If you also want to provide a condition for the sort key, it must be combined
	// using AND with the condition for the sort key. Following is an example, using
	// the = comparison operator for the sort key:
	//
	// partitionKeyName = :partitionkeyval AND sortKeyName = :sortkeyval
	//
	// Valid comparisons for the sort key condition are as follows:
	//
	//    * sortKeyName = :sortkeyval - true if the sort key value is equal to :sortkeyval.
	//
	//    * sortKeyName < :sortkeyval - true if the sort key value is less than
	//    :sortkeyval.
	//
	//    * sortKeyName <= :sortkeyval - true if the sort key value is less than
	//    or equal to :sortkeyval.
	//
	//    * sortKeyName > :sortkeyval - true if the sort key value is greater than
	//    :sortkeyval.
	//
	//    * sortKeyName >= :sortkeyval - true if the sort key value is greater than
	//    or equal to :sortkeyval.
	//
	//    * sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2 - true if the sort
	//    key value is greater than or equal to :sortkeyval1, and less than or equal
	//    to :sortkeyval2.
	//
	//    * begins_with ( sortKeyName, :sortkeyval ) - true if the sort key value
	//    begins with a particular operand. (You cannot use this function with a
	//    sort key that is of type Number.) Note that the function name begins_with
	//    is case-sensitive.
	//
	// Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval
	// and :sortval with actual values at runtime.
	//
	// You can optionally use the ExpressionAttributeNames parameter to replace
	// the names of the partition key and sort key with placeholder tokens. This
	// option might be necessary if an attribute name conflicts with a DynamoDB
	// reserved word. For example, the following KeyConditionExpression parameter
	// causes an error because Size is a reserved word:
	//
	//    * Size = :myval
	//
	// To work around this, define a placeholder (such a #S) to represent the attribute
	// name Size. KeyConditionExpression then is as follows:
	//
	//    * #S = :myval
	//
	// For a list of reserved words, see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
	// in the Amazon DynamoDB Developer Guide.
	//
	// For more information on ExpressionAttributeNames and ExpressionAttributeValues,
	// see Using Placeholders for Attribute Names and Values (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html)
	// in the Amazon DynamoDB Developer Guide.
	KeyConditionExpression *string `type:"string"`

	// This is a legacy parameter. Use KeyConditionExpression instead. For more
	// information, see KeyConditions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html)
	// in the Amazon DynamoDB Developer Guide.
	KeyConditions map[string]*Condition `type:"map"`

	// The maximum number of items to evaluate (not necessarily the number of matching
	// items). If DynamoDB processes the number of items up to the limit while processing
	// the results, it stops the operation and returns the matching values up to
	// that point, and a key in LastEvaluatedKey to apply in a subsequent operation,
	// so that you can pick up where you left off. Also, if the processed dataset
	// size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation
	// and returns the matching values up to the limit, and a key in LastEvaluatedKey
	// to apply in a subsequent operation to continue the operation. For more information,
	// see Query and Scan (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html)
	// in the Amazon DynamoDB Developer Guide.
	Limit *int64 `min:"1" type:"integer"`

	// A string that identifies one or more attributes to retrieve from the table.
	// These attributes can include scalars, sets, or elements of a JSON document.
	// The attributes in the expression must be separated by commas.
	//
	// If no attribute names are specified, then all attributes will be returned.
	// If any of the requested attributes are not found, they will not appear in
	// the result.
	//
	// For more information, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
	// in the Amazon DynamoDB Developer Guide.
	ProjectionExpression *string `type:"string"`

	// This is a legacy parameter. Use FilterExpression instead. For more information,
	// see QueryFilter (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html)
	// in the Amazon DynamoDB Developer Guide.
	QueryFilter map[string]*Condition `type:"map"`

	// Determines the level of detail about either provisioned or on-demand throughput
	// consumption that is returned in the response:
	//
	//    * INDEXES - The response includes the aggregate ConsumedCapacity for the
	//    operation, together with ConsumedCapacity for each table and secondary
	//    index that was accessed. Note that some operations, such as GetItem and
	//    BatchGetItem, do not access any indexes at all. In these cases, specifying
	//    INDEXES will only return ConsumedCapacity information for table(s).
	//
	//    * TOTAL - The response includes only the aggregate ConsumedCapacity for
	//    the operation.
	//
	//    * NONE - No ConsumedCapacity details are included in the response.
	ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"`

	// Specifies the order for index traversal: If true (default), the traversal
	// is performed in ascending order; if false, the traversal is performed in
	// descending order.
	//
	// Items with the same partition key value are stored in sorted order by sort
	// key. If the sort key data type is Number, the results are stored in numeric
	// order. For type String, the results are stored in order of UTF-8 bytes. For
	// type Binary, DynamoDB treats each byte of the binary data as unsigned.
	//
	// If ScanIndexForward is true, DynamoDB returns the results in the order in
	// which they are stored (by sort key value). This is the default behavior.
	// If ScanIndexForward is false, DynamoDB reads the results in reverse order
	// by sort key value, and then returns the results to the client.
	ScanIndexForward *bool `type:"boolean"`

	// The attributes to be returned in the result. You can retrieve all item attributes,
	// specific item attributes, the count of matching items, or in the case of
	// an index, some or all of the attributes projected into the index.
	//
	//    * ALL_ATTRIBUTES - Returns all of the item attributes from the specified
	//    table or index. If you query a local secondary index, then for each matching
	//    item in the index, DynamoDB fetches the entire item from the parent table.
	//    If the index is configured to project all item attributes, then all of
	//    the data can be obtained from the local secondary index, and no fetching
	//    is required.
	//
	//    * ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves
	//    all attributes that have been projected into the index. If the index is
	//    configured to project all attributes, this return value is equivalent
	//    to specifying ALL_ATTRIBUTES.
	//
	//    * COUNT - Returns the number of matching items, rather than the matching
	//    items themselves.
	//
	//    * SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression.
	//    This return value is equivalent to specifying ProjectionExpression without
	//    specifying any value for Select. If you query or scan a local secondary
	//    index and request only attributes that are projected into that index,
	//    the operation will read only the index and not the table. If any of the
	//    requested attributes are not projected into the local secondary index,
	//    DynamoDB fetches each of these attributes from the parent table. This
	//    extra fetching incurs additional throughput cost and latency. If you query
	//    or scan a global secondary index, you can only request attributes that
	//    are projected into the index. Global secondary index queries cannot fetch
	//    attributes from the parent table.
	//
	// If neither Select nor ProjectionExpression are specified, DynamoDB defaults
	// to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when
	// accessing an index. You cannot use both Select and ProjectionExpression together
	// in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES.
	// (This usage is equivalent to specifying ProjectionExpression without any
	// value for Select.)
	//
	// If you use the ProjectionExpression parameter, then the value for Select
	// can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an
	// error.
	Select *string `type:"string" enum:"Select"`

	// The name of the table containing the requested items.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of a Query operation.

func (QueryInput) GoString added in v0.6.5 

func (s QueryInput) 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 (*QueryInput) SetAttributesToGet added in v1.5.0 

func (s *QueryInput) SetAttributesToGet(v []*string) *QueryInput

SetAttributesToGet sets the AttributesToGet field's value.

func (*QueryInput) SetConditionalOperator added in v1.5.0 

func (s *QueryInput) SetConditionalOperator(v string) *QueryInput

SetConditionalOperator sets the ConditionalOperator field's value.

func (*QueryInput) SetConsistentRead added in v1.5.0 

func (s *QueryInput) SetConsistentRead(v bool) *QueryInput

SetConsistentRead sets the ConsistentRead field's value.

func (*QueryInput) SetExclusiveStartKey added in v1.5.0 

func (s *QueryInput) SetExclusiveStartKey(v map[string]*AttributeValue) *QueryInput

SetExclusiveStartKey sets the ExclusiveStartKey field's value.

func (*QueryInput) SetExpressionAttributeNames added in v1.5.0 

func (s *QueryInput) SetExpressionAttributeNames(v map[string]*string) *QueryInput

SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.

func (*QueryInput) SetExpressionAttributeValues added in v1.5.0 

func (s *QueryInput) SetExpressionAttributeValues(v map[string]*AttributeValue) *QueryInput

SetExpressionAttributeValues sets the ExpressionAttributeValues field's value.

func (*QueryInput) SetFilterExpression added in v1.5.0 

func (s *QueryInput) SetFilterExpression(v string) *QueryInput

SetFilterExpression sets the FilterExpression field's value.

func (*QueryInput) SetIndexName added in v1.5.0 

func (s *QueryInput) SetIndexName(v string) *QueryInput

SetIndexName sets the IndexName field's value.

func (*QueryInput) SetKeyConditionExpression added in v1.5.0 

func (s *QueryInput) SetKeyConditionExpression(v string) *QueryInput

SetKeyConditionExpression sets the KeyConditionExpression field's value.

func (*QueryInput) SetKeyConditions added in v1.5.0 

func (s *QueryInput) SetKeyConditions(v map[string]*Condition) *QueryInput

SetKeyConditions sets the KeyConditions field's value.

func (*QueryInput) SetLimit added in v1.5.0 

func (s *QueryInput) SetLimit(v int64) *QueryInput

SetLimit sets the Limit field's value.

func (*QueryInput) SetProjectionExpression added in v1.5.0 

func (s *QueryInput) SetProjectionExpression(v string) *QueryInput

SetProjectionExpression sets the ProjectionExpression field's value.

func (*QueryInput) SetQueryFilter added in v1.5.0 

func (s *QueryInput) SetQueryFilter(v map[string]*Condition) *QueryInput

SetQueryFilter sets the QueryFilter field's value.

func (*QueryInput) SetReturnConsumedCapacity added in v1.5.0 

func (s *QueryInput) SetReturnConsumedCapacity(v string) *QueryInput

SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.

func (*QueryInput) SetScanIndexForward added in v1.5.0 

func (s *QueryInput) SetScanIndexForward(v bool) *QueryInput

SetScanIndexForward sets the ScanIndexForward field's value.

func (*QueryInput) SetSelect added in v1.5.0 

func (s *QueryInput) SetSelect(v string) *QueryInput

SetSelect sets the Select field's value.

func (*QueryInput) SetTableName added in v1.5.0 

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

SetTableName sets the TableName field's value.

func (QueryInput) String added in v0.6.5 

func (s QueryInput) 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 (*QueryInput) Validate added in v1.1.21 

func (s *QueryInput) Validate() error

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

type QueryOutput 

type QueryOutput struct {

	// The capacity units consumed by the Query operation. The data returned includes
	// the total provisioned throughput consumed, along with statistics for the
	// table and any indexes involved in the operation. ConsumedCapacity is only
	// returned if the ReturnConsumedCapacity parameter was specified. For more
	// information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
	// in the Amazon DynamoDB Developer Guide.
	ConsumedCapacity *ConsumedCapacity `type:"structure"`

	// The number of items in the response.
	//
	// If you used a QueryFilter in the request, then Count is the number of items
	// returned after the filter was applied, and ScannedCount is the number of
	// matching items before the filter was applied.
	//
	// If you did not use a filter in the request, then Count and ScannedCount are
	// the same.
	Count *int64 `type:"integer"`

	// An array of item attributes that match the query criteria. Each element in
	// this array consists of an attribute name and the value for that attribute.
	Items []map[string]*AttributeValue `type:"list"`

	// The primary key of the item where the operation stopped, inclusive of the
	// previous result set. Use this value to start a new operation, excluding this
	// value in the new request.
	//
	// If LastEvaluatedKey is empty, then the "last page" of results has been processed
	// and there is no more data to be retrieved.
	//
	// If LastEvaluatedKey is not empty, it does not necessarily mean that there
	// is more data in the result set. The only way to know when you have reached
	// the end of the result set is when LastEvaluatedKey is empty.
	LastEvaluatedKey map[string]*AttributeValue `type:"map"`

	// The number of items evaluated, before any QueryFilter is applied. A high
	// ScannedCount value with few, or no, Count results indicates an inefficient
	// Query operation. For more information, see Count and ScannedCount (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count)
	// in the Amazon DynamoDB Developer Guide.
	//
	// If you did not use a filter in the request, then ScannedCount is the same
	// as Count.
	ScannedCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the output of a Query operation.

func (QueryOutput) GoString added in v0.6.5 

func (s QueryOutput) 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 (*QueryOutput) SetConsumedCapacity added in v1.5.0 

func (s *QueryOutput) SetConsumedCapacity(v *ConsumedCapacity) *QueryOutput

SetConsumedCapacity sets the ConsumedCapacity field's value.

func (*QueryOutput) SetCount added in v1.5.0 

func (s *QueryOutput) SetCount(v int64) *QueryOutput

SetCount sets the Count field's value.

func (*QueryOutput) SetItems added in v1.5.0 

func (s *QueryOutput) SetItems(v []map[string]*AttributeValue) *QueryOutput

SetItems sets the Items field's value.

func (*QueryOutput) SetLastEvaluatedKey added in v1.5.0 

func (s *QueryOutput) SetLastEvaluatedKey(v map[string]*AttributeValue) *QueryOutput

SetLastEvaluatedKey sets the LastEvaluatedKey field's value.

func (*QueryOutput) SetScannedCount added in v1.5.0 

func (s *QueryOutput) SetScannedCount(v int64) *QueryOutput

SetScannedCount sets the ScannedCount field's value.

func (QueryOutput) String added in v0.6.5 

func (s QueryOutput) 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 Replica added in v1.12.36 

type Replica struct {

	// The Region where the replica needs to be created.
	RegionName *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the properties of a replica.

func (Replica) GoString added in v1.12.36 

func (s Replica) 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 (*Replica) SetRegionName added in v1.12.36 

func (s *Replica) SetRegionName(v string) *Replica

SetRegionName sets the RegionName field's value.

func (Replica) String added in v1.12.36 

func (s Replica) 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 ReplicaAlreadyExistsException added in v1.28.0 

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

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

The specified replica is already part of the global table.

func (*ReplicaAlreadyExistsException) Code added in v1.28.0 

func (s *ReplicaAlreadyExistsException) Code() string

Code returns the exception type name.

func (*ReplicaAlreadyExistsException) Error added in v1.28.0 

func (s *ReplicaAlreadyExistsException) Error() string

func (ReplicaAlreadyExistsException) GoString added in v1.28.0 

func (s ReplicaAlreadyExistsException) 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 (*ReplicaAlreadyExistsException) Message added in v1.28.0 

func (s *ReplicaAlreadyExistsException) Message() string

Message returns the exception's message.

func (*ReplicaAlreadyExistsException) OrigErr added in v1.28.0 

func (s *ReplicaAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ReplicaAlreadyExistsException) RequestID added in v1.28.0 

func (s *ReplicaAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ReplicaAlreadyExistsException) StatusCode added in v1.28.0 

func (s *ReplicaAlreadyExistsException) StatusCode() int

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

func (ReplicaAlreadyExistsException) String added in v1.28.0 

func (s ReplicaAlreadyExistsException) 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 ReplicaAutoScalingDescription added in v1.25.40 

type ReplicaAutoScalingDescription struct {

	// Replica-specific global secondary index auto scaling settings.
	GlobalSecondaryIndexes []*ReplicaGlobalSecondaryIndexAutoScalingDescription `type:"list"`

	// The Region where the replica exists.
	RegionName *string `type:"string"`

	// Represents the auto scaling settings for a global table or global secondary
	// index.
	ReplicaProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`

	// Represents the auto scaling settings for a global table or global secondary
	// index.
	ReplicaProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`

	// The current state of the replica:
	//
	//    * CREATING - The replica is being created.
	//
	//    * UPDATING - The replica is being updated.
	//
	//    * DELETING - The replica is being deleted.
	//
	//    * ACTIVE - The replica is ready for use.
	ReplicaStatus *string `type:"string" enum:"ReplicaStatus"`
	// contains filtered or unexported fields
}

Represents the auto scaling settings of the replica.

func (ReplicaAutoScalingDescription) GoString added in v1.25.40 

func (s ReplicaAutoScalingDescription) 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 (*ReplicaAutoScalingDescription) SetGlobalSecondaryIndexes added in v1.25.40 

func (s *ReplicaAutoScalingDescription) SetGlobalSecondaryIndexes(v []*ReplicaGlobalSecondaryIndexAutoScalingDescription) *ReplicaAutoScalingDescription

SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.

func (*ReplicaAutoScalingDescription) SetRegionName added in v1.25.40 

func (s *ReplicaAutoScalingDescription) SetRegionName(v string) *ReplicaAutoScalingDescription

SetRegionName sets the RegionName field's value.

func (*ReplicaAutoScalingDescription) SetReplicaProvisionedReadCapacityAutoScalingSettings added in v1.25.40 

func (s *ReplicaAutoScalingDescription) SetReplicaProvisionedReadCapacityAutoScalingSettings(v *AutoScalingSettingsDescription) *ReplicaAutoScalingDescription

SetReplicaProvisionedReadCapacityAutoScalingSettings sets the ReplicaProvisionedReadCapacityAutoScalingSettings field's value.

func (*ReplicaAutoScalingDescription) SetReplicaProvisionedWriteCapacityAutoScalingSettings added in v1.25.40 

func (s *ReplicaAutoScalingDescription) SetReplicaProvisionedWriteCapacityAutoScalingSettings(v *AutoScalingSettingsDescription) *ReplicaAutoScalingDescription

SetReplicaProvisionedWriteCapacityAutoScalingSettings sets the ReplicaProvisionedWriteCapacityAutoScalingSettings field's value.

func (*ReplicaAutoScalingDescription) SetReplicaStatus added in v1.25.40 

func (s *ReplicaAutoScalingDescription) SetReplicaStatus(v string) *ReplicaAutoScalingDescription

SetReplicaStatus sets the ReplicaStatus field's value.

func (ReplicaAutoScalingDescription) String added in v1.25.40 

func (s ReplicaAutoScalingDescription) 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 ReplicaAutoScalingUpdate added in v1.25.40 

type ReplicaAutoScalingUpdate struct {

	// The Region where the replica exists.
	//
	// RegionName is a required field
	RegionName *string `type:"string" required:"true"`

	// Represents the auto scaling settings of global secondary indexes that will
	// be modified.
	ReplicaGlobalSecondaryIndexUpdates []*ReplicaGlobalSecondaryIndexAutoScalingUpdate `type:"list"`

	// Represents the auto scaling settings to be modified for a global table or
	// global secondary index.
	ReplicaProvisionedReadCapacityAutoScalingUpdate *AutoScalingSettingsUpdate `type:"structure"`
	// contains filtered or unexported fields
}

Represents the auto scaling settings of a replica that will be modified.

func (ReplicaAutoScalingUpdate) GoString added in v1.25.40 

func (s ReplicaAutoScalingUpdate) 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 (*ReplicaAutoScalingUpdate) SetRegionName added in v1.25.40 

func (s *ReplicaAutoScalingUpdate) SetRegionName(v string) *ReplicaAutoScalingUpdate

SetRegionName sets the RegionName field's value.

func (*ReplicaAutoScalingUpdate) SetReplicaGlobalSecondaryIndexUpdates added in v1.25.40 

func (s *ReplicaAutoScalingUpdate) SetReplicaGlobalSecondaryIndexUpdates(v []*ReplicaGlobalSecondaryIndexAutoScalingUpdate) *ReplicaAutoScalingUpdate

SetReplicaGlobalSecondaryIndexUpdates sets the ReplicaGlobalSecondaryIndexUpdates field's value.

func (*ReplicaAutoScalingUpdate) SetReplicaProvisionedReadCapacityAutoScalingUpdate added in v1.25.40 

func (s *ReplicaAutoScalingUpdate) SetReplicaProvisionedReadCapacityAutoScalingUpdate(v *AutoScalingSettingsUpdate) *ReplicaAutoScalingUpdate

SetReplicaProvisionedReadCapacityAutoScalingUpdate sets the ReplicaProvisionedReadCapacityAutoScalingUpdate field's value.

func (ReplicaAutoScalingUpdate) String added in v1.25.40 

func (s ReplicaAutoScalingUpdate) 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 (*ReplicaAutoScalingUpdate) Validate added in v1.25.40 

func (s *ReplicaAutoScalingUpdate) Validate() error

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

type ReplicaDescription added in v1.12.36 

type ReplicaDescription struct {

	// Replica-specific global secondary index settings.
	GlobalSecondaryIndexes []*ReplicaGlobalSecondaryIndexDescription `type:"list"`

	// The KMS key of the replica that will be used for KMS encryption.
	KMSMasterKeyId *string `type:"string"`

	// Replica-specific provisioned throughput. If not described, uses the source
	// table's provisioned throughput settings.
	ProvisionedThroughputOverride *ProvisionedThroughputOverride `type:"structure"`

	// The name of the Region.
	RegionName *string `type:"string"`

	// The time at which the replica was first detected as inaccessible. To determine
	// cause of inaccessibility check the ReplicaStatus property.
	ReplicaInaccessibleDateTime *time.Time `type:"timestamp"`

	// The current state of the replica:
	//
	//    * CREATING - The replica is being created.
	//
	//    * UPDATING - The replica is being updated.
	//
	//    * DELETING - The replica is being deleted.
	//
	//    * ACTIVE - The replica is ready for use.
	//
	//    * REGION_DISABLED - The replica is inaccessible because the Amazon Web
	//    Services Region has been disabled. If the Amazon Web Services Region remains
	//    inaccessible for more than 20 hours, DynamoDB will remove this replica
	//    from the replication group. The replica will not be deleted and replication
	//    will stop from and to this region.
	//
	//    * INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the
	//    table is inaccessible. If the KMS key remains inaccessible for more than
	//    20 hours, DynamoDB will remove this replica from the replication group.
	//    The replica will not be deleted and replication will stop from and to
	//    this region.
	ReplicaStatus *string `type:"string" enum:"ReplicaStatus"`

	// Detailed information about the replica status.
	ReplicaStatusDescription *string `type:"string"`

	// Specifies the progress of a Create, Update, or Delete action on the replica
	// as a percentage.
	ReplicaStatusPercentProgress *string `type:"string"`

	// Contains details of the table class.
	ReplicaTableClassSummary *TableClassSummary `type:"structure"`
	// contains filtered or unexported fields
}

Contains the details of the replica.

func (ReplicaDescription) GoString added in v1.12.36 

func (s ReplicaDescription) 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 (*ReplicaDescription) SetGlobalSecondaryIndexes added in v1.25.40 

func (s *ReplicaDescription) SetGlobalSecondaryIndexes(v []*ReplicaGlobalSecondaryIndexDescription) *ReplicaDescription

SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.

func (*ReplicaDescription) SetKMSMasterKeyId added in v1.25.40 

func (s *ReplicaDescription) SetKMSMasterKeyId(v string) *ReplicaDescription

SetKMSMasterKeyId sets the KMSMasterKeyId field's value.

func (*ReplicaDescription) SetProvisionedThroughputOverride added in v1.25.40 

func (s *ReplicaDescription) SetProvisionedThroughputOverride(v *ProvisionedThroughputOverride) *ReplicaDescription

SetProvisionedThroughputOverride sets the ProvisionedThroughputOverride field's value.

func (*ReplicaDescription) SetRegionName added in v1.12.36 

func (s *ReplicaDescription) SetRegionName(v string) *ReplicaDescription

SetRegionName sets the RegionName field's value.

func (*ReplicaDescription) SetReplicaInaccessibleDateTime added in v1.35.3 

func (s *ReplicaDescription) SetReplicaInaccessibleDateTime(v time.Time) *ReplicaDescription

SetReplicaInaccessibleDateTime sets the ReplicaInaccessibleDateTime field's value.

func (*ReplicaDescription) SetReplicaStatus added in v1.25.40 

func (s *ReplicaDescription) SetReplicaStatus(v string) *ReplicaDescription

SetReplicaStatus sets the ReplicaStatus field's value.

func (*ReplicaDescription) SetReplicaStatusDescription added in v1.25.40 

func (s *ReplicaDescription) SetReplicaStatusDescription(v string) *ReplicaDescription

SetReplicaStatusDescription sets the ReplicaStatusDescription field's value.

func (*ReplicaDescription) SetReplicaStatusPercentProgress added in v1.25.40 

func (s *ReplicaDescription) SetReplicaStatusPercentProgress(v string) *ReplicaDescription

SetReplicaStatusPercentProgress sets the ReplicaStatusPercentProgress field's value.

func (*ReplicaDescription) SetReplicaTableClassSummary added in v1.42.17 

func (s *ReplicaDescription) SetReplicaTableClassSummary(v *TableClassSummary) *ReplicaDescription

SetReplicaTableClassSummary sets the ReplicaTableClassSummary field's value.

func (ReplicaDescription) String added in v1.12.36 

func (s ReplicaDescription) 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 ReplicaGlobalSecondaryIndex added in v1.25.40 

type ReplicaGlobalSecondaryIndex struct {

	// The name of the global secondary index.
	//
	// IndexName is a required field
	IndexName *string `min:"3" type:"string" required:"true"`

	// Replica table GSI-specific provisioned throughput. If not specified, uses
	// the source table GSI's read capacity settings.
	ProvisionedThroughputOverride *ProvisionedThroughputOverride `type:"structure"`
	// contains filtered or unexported fields
}

Represents the properties of a replica global secondary index.

func (ReplicaGlobalSecondaryIndex) GoString added in v1.25.40 

func (s ReplicaGlobalSecondaryIndex) 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 (*ReplicaGlobalSecondaryIndex) SetIndexName added in v1.25.40 

func (s *ReplicaGlobalSecondaryIndex) SetIndexName(v string) *ReplicaGlobalSecondaryIndex

SetIndexName sets the IndexName field's value.

func (*ReplicaGlobalSecondaryIndex) SetProvisionedThroughputOverride added in v1.25.40 

func (s *ReplicaGlobalSecondaryIndex) SetProvisionedThroughputOverride(v *ProvisionedThroughputOverride) *ReplicaGlobalSecondaryIndex

SetProvisionedThroughputOverride sets the ProvisionedThroughputOverride field's value.

func (ReplicaGlobalSecondaryIndex) String added in v1.25.40 

func (s ReplicaGlobalSecondaryIndex) 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 (*ReplicaGlobalSecondaryIndex) Validate added in v1.25.40 

func (s *ReplicaGlobalSecondaryIndex) Validate() error

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

type ReplicaGlobalSecondaryIndexAutoScalingDescription added in v1.25.40 

type ReplicaGlobalSecondaryIndexAutoScalingDescription struct {

	// The name of the global secondary index.
	IndexName *string `min:"3" type:"string"`

	// The current state of the replica global secondary index:
	//
	//    * CREATING - The index is being created.
	//
	//    * UPDATING - The index is being updated.
	//
	//    * DELETING - The index is being deleted.
	//
	//    * ACTIVE - The index is ready for use.
	IndexStatus *string `type:"string" enum:"IndexStatus"`

	// Represents the auto scaling settings for a global table or global secondary
	// index.
	ProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`

	// Represents the auto scaling settings for a global table or global secondary
	// index.
	ProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`
	// contains filtered or unexported fields
}

Represents the auto scaling configuration for a replica global secondary index.

func (ReplicaGlobalSecondaryIndexAutoScalingDescription) GoString added in v1.25.40 

func (s ReplicaGlobalSecondaryIndexAutoScalingDescription) 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 (*ReplicaGlobalSecondaryIndexAutoScalingDescription) SetIndexName added in v1.25.40 

func (s *ReplicaGlobalSecondaryIndexAutoScalingDescription) SetIndexName(v string) *ReplicaGlobalSecondaryIndexAutoScalingDescription

SetIndexName sets the IndexName field's value.

func (*ReplicaGlobalSecondaryIndexAutoScalingDescription) SetIndexStatus added in v1.25.40 

func (s *ReplicaGlobalSecondaryIndexAutoScalingDescription) SetIndexStatus(v string) *ReplicaGlobalSecondaryIndexAutoScalingDescription

SetIndexStatus sets the IndexStatus field's value.

func (*ReplicaGlobalSecondaryIndexAutoScalingDescription) SetProvisionedReadCapacityAutoScalingSettings added in v1.25.40 

func (s *ReplicaGlobalSecondaryIndexAutoScalingDescription) SetProvisionedReadCapacityAutoScalingSettings(v *AutoScalingSettingsDescription) *ReplicaGlobalSecondaryIndexAutoScalingDescription

SetProvisionedReadCapacityAutoScalingSettings sets the ProvisionedReadCapacityAutoScalingSettings field's value.

func (*ReplicaGlobalSecondaryIndexAutoScalingDescription) SetProvisionedWriteCapacityAutoScalingSettings added in v1.25.40 

func (s *ReplicaGlobalSecondaryIndexAutoScalingDescription) SetProvisionedWriteCapacityAutoScalingSettings(v *AutoScalingSettingsDescription) *ReplicaGlobalSecondaryIndexAutoScalingDescription

SetProvisionedWriteCapacityAutoScalingSettings sets the ProvisionedWriteCapacityAutoScalingSettings field's value.

func (ReplicaGlobalSecondaryIndexAutoScalingDescription) String added in v1.25.40 

func (s ReplicaGlobalSecondaryIndexAutoScalingDescription) 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 ReplicaGlobalSecondaryIndexAutoScalingUpdate added in v1.25.40 

type ReplicaGlobalSecondaryIndexAutoScalingUpdate struct {

	// The name of the global secondary index.
	IndexName *string `min:"3" type:"string"`

	// Represents the auto scaling settings to be modified for a global table or
	// global secondary index.
	ProvisionedReadCapacityAutoScalingUpdate *AutoScalingSettingsUpdate `type:"structure"`
	// contains filtered or unexported fields
}

Represents the auto scaling settings of a global secondary index for a replica that will be modified.

func (ReplicaGlobalSecondaryIndexAutoScalingUpdate) GoString added in v1.25.40 

func (s ReplicaGlobalSecondaryIndexAutoScalingUpdate) 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 (*ReplicaGlobalSecondaryIndexAutoScalingUpdate) SetIndexName added in v1.25.40 

func (s *ReplicaGlobalSecondaryIndexAutoScalingUpdate) SetIndexName(v string) *ReplicaGlobalSecondaryIndexAutoScalingUpdate

SetIndexName sets the IndexName field's value.

func (*ReplicaGlobalSecondaryIndexAutoScalingUpdate) SetProvisionedReadCapacityAutoScalingUpdate added in v1.25.40 

func (s *ReplicaGlobalSecondaryIndexAutoScalingUpdate) SetProvisionedReadCapacityAutoScalingUpdate(v *AutoScalingSettingsUpdate) *ReplicaGlobalSecondaryIndexAutoScalingUpdate

SetProvisionedReadCapacityAutoScalingUpdate sets the ProvisionedReadCapacityAutoScalingUpdate field's value.

func (ReplicaGlobalSecondaryIndexAutoScalingUpdate) String added in v1.25.40 

func (s ReplicaGlobalSecondaryIndexAutoScalingUpdate) 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 (*ReplicaGlobalSecondaryIndexAutoScalingUpdate) Validate added in v1.25.40 

func (s *ReplicaGlobalSecondaryIndexAutoScalingUpdate) Validate() error

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

type ReplicaGlobalSecondaryIndexDescription added in v1.25.40 

type ReplicaGlobalSecondaryIndexDescription struct {

	// The name of the global secondary index.
	IndexName *string `min:"3" type:"string"`

	// If not described, uses the source table GSI's read capacity settings.
	ProvisionedThroughputOverride *ProvisionedThroughputOverride `type:"structure"`
	// contains filtered or unexported fields
}

Represents the properties of a replica global secondary index.

func (ReplicaGlobalSecondaryIndexDescription) GoString added in v1.25.40 

func (s ReplicaGlobalSecondaryIndexDescription) 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 (*ReplicaGlobalSecondaryIndexDescription) SetIndexName added in v1.25.40 

func (s *ReplicaGlobalSecondaryIndexDescription) SetIndexName(v string) *ReplicaGlobalSecondaryIndexDescription

SetIndexName sets the IndexName field's value.

func (*ReplicaGlobalSecondaryIndexDescription) SetProvisionedThroughputOverride added in v1.25.40 

func (s *ReplicaGlobalSecondaryIndexDescription) SetProvisionedThroughputOverride(v *ProvisionedThroughputOverride) *ReplicaGlobalSecondaryIndexDescription

SetProvisionedThroughputOverride sets the ProvisionedThroughputOverride field's value.

func (ReplicaGlobalSecondaryIndexDescription) String added in v1.25.40 

func (s ReplicaGlobalSecondaryIndexDescription) 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 ReplicaGlobalSecondaryIndexSettingsDescription added in v1.13.39 

type ReplicaGlobalSecondaryIndexSettingsDescription struct {

	// The name of the global secondary index. The name must be unique among all
	// other indexes on this table.
	//
	// IndexName is a required field
	IndexName *string `min:"3" type:"string" required:"true"`

	// The current status of the global secondary index:
	//
	//    * CREATING - The global secondary index is being created.
	//
	//    * UPDATING - The global secondary index is being updated.
	//
	//    * DELETING - The global secondary index is being deleted.
	//
	//    * ACTIVE - The global secondary index is ready for use.
	IndexStatus *string `type:"string" enum:"IndexStatus"`

	// Auto scaling settings for a global secondary index replica's read capacity
	// units.
	ProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`

	// The maximum number of strongly consistent reads consumed per second before
	// DynamoDB returns a ThrottlingException.
	ProvisionedReadCapacityUnits *int64 `min:"1" type:"long"`

	// Auto scaling settings for a global secondary index replica's write capacity
	// units.
	ProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`

	// The maximum number of writes consumed per second before DynamoDB returns
	// a ThrottlingException.
	ProvisionedWriteCapacityUnits *int64 `min:"1" type:"long"`
	// contains filtered or unexported fields
}

Represents the properties of a global secondary index.

func (ReplicaGlobalSecondaryIndexSettingsDescription) GoString added in v1.13.39 

func (s ReplicaGlobalSecondaryIndexSettingsDescription) 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 (*ReplicaGlobalSecondaryIndexSettingsDescription) SetIndexName added in v1.13.39 

func (s *ReplicaGlobalSecondaryIndexSettingsDescription) SetIndexName(v string) *ReplicaGlobalSecondaryIndexSettingsDescription

SetIndexName sets the IndexName field's value.

func (*ReplicaGlobalSecondaryIndexSettingsDescription) SetIndexStatus added in v1.13.39 

func (s *ReplicaGlobalSecondaryIndexSettingsDescription) SetIndexStatus(v string) *ReplicaGlobalSecondaryIndexSettingsDescription

SetIndexStatus sets the IndexStatus field's value.

func (*ReplicaGlobalSecondaryIndexSettingsDescription) SetProvisionedReadCapacityAutoScalingSettings added in v1.14.32 

func (s *ReplicaGlobalSecondaryIndexSettingsDescription) SetProvisionedReadCapacityAutoScalingSettings(v *AutoScalingSettingsDescription) *ReplicaGlobalSecondaryIndexSettingsDescription

SetProvisionedReadCapacityAutoScalingSettings sets the ProvisionedReadCapacityAutoScalingSettings field's value.

func (*ReplicaGlobalSecondaryIndexSettingsDescription) SetProvisionedReadCapacityUnits added in v1.13.39 

func (s *ReplicaGlobalSecondaryIndexSettingsDescription) SetProvisionedReadCapacityUnits(v int64) *ReplicaGlobalSecondaryIndexSettingsDescription

SetProvisionedReadCapacityUnits sets the ProvisionedReadCapacityUnits field's value.

func (*ReplicaGlobalSecondaryIndexSettingsDescription) SetProvisionedWriteCapacityAutoScalingSettings added in v1.14.32 

func (s *ReplicaGlobalSecondaryIndexSettingsDescription) SetProvisionedWriteCapacityAutoScalingSettings(v *AutoScalingSettingsDescription) *ReplicaGlobalSecondaryIndexSettingsDescription

SetProvisionedWriteCapacityAutoScalingSettings sets the ProvisionedWriteCapacityAutoScalingSettings field's value.

func (*ReplicaGlobalSecondaryIndexSettingsDescription) SetProvisionedWriteCapacityUnits added in v1.13.39 

func (s *ReplicaGlobalSecondaryIndexSettingsDescription) SetProvisionedWriteCapacityUnits(v int64) *ReplicaGlobalSecondaryIndexSettingsDescription

SetProvisionedWriteCapacityUnits sets the ProvisionedWriteCapacityUnits field's value.

func (ReplicaGlobalSecondaryIndexSettingsDescription) String added in v1.13.39 

func (s ReplicaGlobalSecondaryIndexSettingsDescription) 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 ReplicaGlobalSecondaryIndexSettingsUpdate added in v1.13.39 

type ReplicaGlobalSecondaryIndexSettingsUpdate struct {

	// The name of the global secondary index. The name must be unique among all
	// other indexes on this table.
	//
	// IndexName is a required field
	IndexName *string `min:"3" type:"string" required:"true"`

	// Auto scaling settings for managing a global secondary index replica's read
	// capacity units.
	ProvisionedReadCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate `type:"structure"`

	// The maximum number of strongly consistent reads consumed per second before
	// DynamoDB returns a ThrottlingException.
	ProvisionedReadCapacityUnits *int64 `min:"1" type:"long"`
	// contains filtered or unexported fields
}

Represents the settings of a global secondary index for a global table that will be modified.

func (ReplicaGlobalSecondaryIndexSettingsUpdate) GoString added in v1.13.39 

func (s ReplicaGlobalSecondaryIndexSettingsUpdate) 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 (*ReplicaGlobalSecondaryIndexSettingsUpdate) SetIndexName added in v1.13.39 

func (s *ReplicaGlobalSecondaryIndexSettingsUpdate) SetIndexName(v string) *ReplicaGlobalSecondaryIndexSettingsUpdate

SetIndexName sets the IndexName field's value.

func (*ReplicaGlobalSecondaryIndexSettingsUpdate) SetProvisionedReadCapacityAutoScalingSettingsUpdate added in v1.14.32 

func (s *ReplicaGlobalSecondaryIndexSettingsUpdate) SetProvisionedReadCapacityAutoScalingSettingsUpdate(v *AutoScalingSettingsUpdate) *ReplicaGlobalSecondaryIndexSettingsUpdate

SetProvisionedReadCapacityAutoScalingSettingsUpdate sets the ProvisionedReadCapacityAutoScalingSettingsUpdate field's value.

func (*ReplicaGlobalSecondaryIndexSettingsUpdate) SetProvisionedReadCapacityUnits added in v1.13.39 

func (s *ReplicaGlobalSecondaryIndexSettingsUpdate) SetProvisionedReadCapacityUnits(v int64) *ReplicaGlobalSecondaryIndexSettingsUpdate

SetProvisionedReadCapacityUnits sets the ProvisionedReadCapacityUnits field's value.

func (ReplicaGlobalSecondaryIndexSettingsUpdate) String added in v1.13.39 

func (s ReplicaGlobalSecondaryIndexSettingsUpdate) 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 (*ReplicaGlobalSecondaryIndexSettingsUpdate) Validate added in v1.13.39 

func (s *ReplicaGlobalSecondaryIndexSettingsUpdate) Validate() error

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

type ReplicaNotFoundException added in v1.28.0 

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

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

The specified replica is no longer part of the global table.

func (*ReplicaNotFoundException) Code added in v1.28.0 

func (s *ReplicaNotFoundException) Code() string

Code returns the exception type name.

func (*ReplicaNotFoundException) Error added in v1.28.0 

func (s *ReplicaNotFoundException) Error() string

func (ReplicaNotFoundException) GoString added in v1.28.0 

func (s ReplicaNotFoundException) 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 (*ReplicaNotFoundException) Message added in v1.28.0 

func (s *ReplicaNotFoundException) Message() string

Message returns the exception's message.

func (*ReplicaNotFoundException) OrigErr added in v1.28.0 

func (s *ReplicaNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ReplicaNotFoundException) RequestID added in v1.28.0 

func (s *ReplicaNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ReplicaNotFoundException) StatusCode added in v1.28.0 

func (s *ReplicaNotFoundException) StatusCode() int

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

func (ReplicaNotFoundException) String added in v1.28.0 

func (s ReplicaNotFoundException) 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 ReplicaSettingsDescription added in v1.13.39 

type ReplicaSettingsDescription struct {

	// The Region name of the replica.
	//
	// RegionName is a required field
	RegionName *string `type:"string" required:"true"`

	// The read/write capacity mode of the replica.
	ReplicaBillingModeSummary *BillingModeSummary `type:"structure"`

	// Replica global secondary index settings for the global table.
	ReplicaGlobalSecondaryIndexSettings []*ReplicaGlobalSecondaryIndexSettingsDescription `type:"list"`

	// Auto scaling settings for a global table replica's read capacity units.
	ReplicaProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`

	// The maximum number of strongly consistent reads consumed per second before
	// DynamoDB returns a ThrottlingException. For more information, see Specifying
	// Read and Write Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput)
	// in the Amazon DynamoDB Developer Guide.
	ReplicaProvisionedReadCapacityUnits *int64 `type:"long"`

	// Auto scaling settings for a global table replica's write capacity units.
	ReplicaProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"`

	// The maximum number of writes consumed per second before DynamoDB returns
	// a ThrottlingException. For more information, see Specifying Read and Write
	// Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput)
	// in the Amazon DynamoDB Developer Guide.
	ReplicaProvisionedWriteCapacityUnits *int64 `type:"long"`

	// The current state of the Region:
	//
	//    * CREATING - The Region is being created.
	//
	//    * UPDATING - The Region is being updated.
	//
	//    * DELETING - The Region is being deleted.
	//
	//    * ACTIVE - The Region is ready for use.
	ReplicaStatus *string `type:"string" enum:"ReplicaStatus"`

	// Contains details of the table class.
	ReplicaTableClassSummary *TableClassSummary `type:"structure"`
	// contains filtered or unexported fields
}

Represents the properties of a replica.

func (ReplicaSettingsDescription) GoString added in v1.13.39 

func (s ReplicaSettingsDescription) 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 (*ReplicaSettingsDescription) SetRegionName added in v1.13.39 

func (s *ReplicaSettingsDescription) SetRegionName(v string) *ReplicaSettingsDescription

SetRegionName sets the RegionName field's value.

func (*ReplicaSettingsDescription) SetReplicaBillingModeSummary added in v1.15.85 

func (s *ReplicaSettingsDescription) SetReplicaBillingModeSummary(v *BillingModeSummary) *ReplicaSettingsDescription

SetReplicaBillingModeSummary sets the ReplicaBillingModeSummary field's value.

func (*ReplicaSettingsDescription) SetReplicaGlobalSecondaryIndexSettings added in v1.13.39 

func (s *ReplicaSettingsDescription) SetReplicaGlobalSecondaryIndexSettings(v []*ReplicaGlobalSecondaryIndexSettingsDescription) *ReplicaSettingsDescription

SetReplicaGlobalSecondaryIndexSettings sets the ReplicaGlobalSecondaryIndexSettings field's value.

func (*ReplicaSettingsDescription) SetReplicaProvisionedReadCapacityAutoScalingSettings added in v1.14.32 

func (s *ReplicaSettingsDescription) SetReplicaProvisionedReadCapacityAutoScalingSettings(v *AutoScalingSettingsDescription) *ReplicaSettingsDescription

SetReplicaProvisionedReadCapacityAutoScalingSettings sets the ReplicaProvisionedReadCapacityAutoScalingSettings field's value.

func (*ReplicaSettingsDescription) SetReplicaProvisionedReadCapacityUnits added in v1.13.39 

func (s *ReplicaSettingsDescription) SetReplicaProvisionedReadCapacityUnits(v int64) *ReplicaSettingsDescription

SetReplicaProvisionedReadCapacityUnits sets the ReplicaProvisionedReadCapacityUnits field's value.

func (*ReplicaSettingsDescription) SetReplicaProvisionedWriteCapacityAutoScalingSettings added in v1.14.32 

func (s *ReplicaSettingsDescription) SetReplicaProvisionedWriteCapacityAutoScalingSettings(v *AutoScalingSettingsDescription) *ReplicaSettingsDescription

SetReplicaProvisionedWriteCapacityAutoScalingSettings sets the ReplicaProvisionedWriteCapacityAutoScalingSettings field's value.

func (*ReplicaSettingsDescription) SetReplicaProvisionedWriteCapacityUnits added in v1.13.39 

func (s *ReplicaSettingsDescription) SetReplicaProvisionedWriteCapacityUnits(v int64) *ReplicaSettingsDescription

SetReplicaProvisionedWriteCapacityUnits sets the ReplicaProvisionedWriteCapacityUnits field's value.

func (*ReplicaSettingsDescription) SetReplicaStatus added in v1.13.39 

func (s *ReplicaSettingsDescription) SetReplicaStatus(v string) *ReplicaSettingsDescription

SetReplicaStatus sets the ReplicaStatus field's value.

func (*ReplicaSettingsDescription) SetReplicaTableClassSummary added in v1.42.17 

func (s *ReplicaSettingsDescription) SetReplicaTableClassSummary(v *TableClassSummary) *ReplicaSettingsDescription

SetReplicaTableClassSummary sets the ReplicaTableClassSummary field's value.

func (ReplicaSettingsDescription) String added in v1.13.39 

func (s ReplicaSettingsDescription) 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 ReplicaSettingsUpdate added in v1.13.39 

type ReplicaSettingsUpdate struct {

	// The Region of the replica to be added.
	//
	// RegionName is a required field
	RegionName *string `type:"string" required:"true"`

	// Represents the settings of a global secondary index for a global table that
	// will be modified.
	ReplicaGlobalSecondaryIndexSettingsUpdate []*ReplicaGlobalSecondaryIndexSettingsUpdate `min:"1" type:"list"`

	// Auto scaling settings for managing a global table replica's read capacity
	// units.
	ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate `type:"structure"`

	// The maximum number of strongly consistent reads consumed per second before
	// DynamoDB returns a ThrottlingException. For more information, see Specifying
	// Read and Write Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput)
	// in the Amazon DynamoDB Developer Guide.
	ReplicaProvisionedReadCapacityUnits *int64 `min:"1" type:"long"`

	// Replica-specific table class. If not specified, uses the source table's table
	// class.
	ReplicaTableClass *string `type:"string" enum:"TableClass"`
	// contains filtered or unexported fields
}

Represents the settings for a global table in a Region that will be modified.

func (ReplicaSettingsUpdate) GoString added in v1.13.39 

func (s ReplicaSettingsUpdate) 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 (*ReplicaSettingsUpdate) SetRegionName added in v1.13.39 

func (s *ReplicaSettingsUpdate) SetRegionName(v string) *ReplicaSettingsUpdate

SetRegionName sets the RegionName field's value.

func (*ReplicaSettingsUpdate) SetReplicaGlobalSecondaryIndexSettingsUpdate added in v1.13.39 

func (s *ReplicaSettingsUpdate) SetReplicaGlobalSecondaryIndexSettingsUpdate(v []*ReplicaGlobalSecondaryIndexSettingsUpdate) *ReplicaSettingsUpdate

SetReplicaGlobalSecondaryIndexSettingsUpdate sets the ReplicaGlobalSecondaryIndexSettingsUpdate field's value.

func (*ReplicaSettingsUpdate) SetReplicaProvisionedReadCapacityAutoScalingSettingsUpdate added in v1.14.32 

func (s *ReplicaSettingsUpdate) SetReplicaProvisionedReadCapacityAutoScalingSettingsUpdate(v *AutoScalingSettingsUpdate) *ReplicaSettingsUpdate

SetReplicaProvisionedReadCapacityAutoScalingSettingsUpdate sets the ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate field's value.

func (*ReplicaSettingsUpdate) SetReplicaProvisionedReadCapacityUnits added in v1.13.39 

func (s *ReplicaSettingsUpdate) SetReplicaProvisionedReadCapacityUnits(v int64) *ReplicaSettingsUpdate

SetReplicaProvisionedReadCapacityUnits sets the ReplicaProvisionedReadCapacityUnits field's value.

func (*ReplicaSettingsUpdate) SetReplicaTableClass added in v1.42.17 

func (s *ReplicaSettingsUpdate) SetReplicaTableClass(v string) *ReplicaSettingsUpdate

SetReplicaTableClass sets the ReplicaTableClass field's value.

func (ReplicaSettingsUpdate) String added in v1.13.39 

func (s ReplicaSettingsUpdate) 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 (*ReplicaSettingsUpdate) Validate added in v1.13.39 

func (s *ReplicaSettingsUpdate) Validate() error

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

type ReplicaUpdate added in v1.12.36 

type ReplicaUpdate struct {

	// The parameters required for creating a replica on an existing global table.
	Create *CreateReplicaAction `type:"structure"`

	// The name of the existing replica to be removed.
	Delete *DeleteReplicaAction `type:"structure"`
	// contains filtered or unexported fields
}

Represents one of the following:

  • A new replica to be added to an existing global table.

  • New parameters for an existing replica.

  • An existing replica to be removed from an existing global table.

func (ReplicaUpdate) GoString added in v1.12.36 

func (s ReplicaUpdate) 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 (*ReplicaUpdate) SetCreate added in v1.12.36 

func (s *ReplicaUpdate) SetCreate(v *CreateReplicaAction) *ReplicaUpdate

SetCreate sets the Create field's value.

func (*ReplicaUpdate) SetDelete added in v1.12.36 

func (s *ReplicaUpdate) SetDelete(v *DeleteReplicaAction) *ReplicaUpdate

SetDelete sets the Delete field's value.

func (ReplicaUpdate) String added in v1.12.36 

func (s ReplicaUpdate) 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 (*ReplicaUpdate) Validate added in v1.12.36 

func (s *ReplicaUpdate) Validate() error

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

type ReplicationGroupUpdate added in v1.25.40 

type ReplicationGroupUpdate struct {

	// The parameters required for creating a replica for the table.
	Create *CreateReplicationGroupMemberAction `type:"structure"`

	// The parameters required for deleting a replica for the table.
	Delete *DeleteReplicationGroupMemberAction `type:"structure"`

	// The parameters required for updating a replica for the table.
	Update *UpdateReplicationGroupMemberAction `type:"structure"`
	// contains filtered or unexported fields
}

Represents one of the following:

  • A new replica to be added to an existing regional table or global table. This request invokes the CreateTableReplica action in the destination Region.

  • New parameters for an existing replica. This request invokes the UpdateTable action in the destination Region.

  • An existing replica to be deleted. The request invokes the DeleteTableReplica action in the destination Region, deleting the replica and all if its items in the destination Region.

When you manually remove a table or global table replica, you do not automatically remove any associated scalable targets, scaling policies, or CloudWatch alarms.

func (ReplicationGroupUpdate) GoString added in v1.25.40 

func (s ReplicationGroupUpdate) 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 (*ReplicationGroupUpdate) SetCreate added in v1.25.40 

func (s *ReplicationGroupUpdate) SetCreate(v *CreateReplicationGroupMemberAction) *ReplicationGroupUpdate

SetCreate sets the Create field's value.

func (*ReplicationGroupUpdate) SetDelete added in v1.25.40 

func (s *ReplicationGroupUpdate) SetDelete(v *DeleteReplicationGroupMemberAction) *ReplicationGroupUpdate

SetDelete sets the Delete field's value.

func (*ReplicationGroupUpdate) SetUpdate added in v1.25.40 

func (s *ReplicationGroupUpdate) SetUpdate(v *UpdateReplicationGroupMemberAction) *ReplicationGroupUpdate

SetUpdate sets the Update field's value.

func (ReplicationGroupUpdate) String added in v1.25.40 

func (s ReplicationGroupUpdate) 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 (*ReplicationGroupUpdate) Validate added in v1.25.40 

func (s *ReplicationGroupUpdate) Validate() error

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

type RequestLimitExceeded added in v1.28.0 

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

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

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support (https://aws.amazon.com/support) to request a quota increase.

func (*RequestLimitExceeded) Code added in v1.28.0 

func (s *RequestLimitExceeded) Code() string

Code returns the exception type name.

func (*RequestLimitExceeded) Error added in v1.28.0 

func (s *RequestLimitExceeded) Error() string

func (RequestLimitExceeded) GoString added in v1.28.0 

func (s RequestLimitExceeded) 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 (*RequestLimitExceeded) Message added in v1.28.0 

func (s *RequestLimitExceeded) Message() string

Message returns the exception's message.

func (*RequestLimitExceeded) OrigErr added in v1.28.0 

func (s *RequestLimitExceeded) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RequestLimitExceeded) RequestID added in v1.28.0 

func (s *RequestLimitExceeded) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RequestLimitExceeded) StatusCode added in v1.28.0 

func (s *RequestLimitExceeded) StatusCode() int

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

func (RequestLimitExceeded) String added in v1.28.0 

func (s RequestLimitExceeded) 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 ResourceInUseException added in v1.28.0 

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

	// The resource which is being attempted to be changed is in use.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

func (*ResourceInUseException) Code added in v1.28.0 

func (s *ResourceInUseException) Code() string

Code returns the exception type name.

func (*ResourceInUseException) Error added in v1.28.0 

func (s *ResourceInUseException) Error() string

func (ResourceInUseException) GoString added in v1.28.0 

func (s ResourceInUseException) 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 (*ResourceInUseException) Message added in v1.28.0 

func (s *ResourceInUseException) Message() string

Message returns the exception's message.

func (*ResourceInUseException) OrigErr added in v1.28.0 

func (s *ResourceInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceInUseException) RequestID added in v1.28.0 

func (s *ResourceInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceInUseException) StatusCode added in v1.28.0 

func (s *ResourceInUseException) StatusCode() int

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

func (ResourceInUseException) String added in v1.28.0 

func (s ResourceInUseException) 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 ResourceNotFoundException added in v1.28.0 

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

	// The resource which is being requested does not exist.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*ResourceNotFoundException) Code added in v1.28.0 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0 

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 added in v1.28.0 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0 

func (s *ResourceNotFoundException) StatusCode() int

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

func (ResourceNotFoundException) String added in v1.28.0 

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 RestoreSummary added in v1.12.36 

type RestoreSummary struct {

	// Point in time or source backup time.
	//
	// RestoreDateTime is a required field
	RestoreDateTime *time.Time `type:"timestamp" required:"true"`

	// Indicates if a restore is in progress or not.
	//
	// RestoreInProgress is a required field
	RestoreInProgress *bool `type:"boolean" required:"true"`

	// The Amazon Resource Name (ARN) of the backup from which the table was restored.
	SourceBackupArn *string `min:"37" type:"string"`

	// The ARN of the source table of the backup that is being restored.
	SourceTableArn *string `type:"string"`
	// contains filtered or unexported fields
}

Contains details for the restore.

func (RestoreSummary) GoString added in v1.12.36 

func (s RestoreSummary) 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 (*RestoreSummary) SetRestoreDateTime added in v1.12.36 

func (s *RestoreSummary) SetRestoreDateTime(v time.Time) *RestoreSummary

SetRestoreDateTime sets the RestoreDateTime field's value.

func (*RestoreSummary) SetRestoreInProgress added in v1.12.36 

func (s *RestoreSummary) SetRestoreInProgress(v bool) *RestoreSummary

SetRestoreInProgress sets the RestoreInProgress field's value.

func (*RestoreSummary) SetSourceBackupArn added in v1.12.36 

func (s *RestoreSummary) SetSourceBackupArn(v string) *RestoreSummary

SetSourceBackupArn sets the SourceBackupArn field's value.

func (*RestoreSummary) SetSourceTableArn added in v1.12.36 

func (s *RestoreSummary) SetSourceTableArn(v string) *RestoreSummary

SetSourceTableArn sets the SourceTableArn field's value.

func (RestoreSummary) String added in v1.12.36 

func (s RestoreSummary) 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 RestoreTableFromBackupInput added in v1.12.36 

type RestoreTableFromBackupInput struct {

	// The Amazon Resource Name (ARN) associated with the backup.
	//
	// BackupArn is a required field
	BackupArn *string `min:"37" type:"string" required:"true"`

	// The billing mode of the restored table.
	BillingModeOverride *string `type:"string" enum:"BillingMode"`

	// List of global secondary indexes for the restored table. The indexes provided
	// should match existing secondary indexes. You can choose to exclude some or
	// all of the indexes at the time of restore.
	GlobalSecondaryIndexOverride []*GlobalSecondaryIndex `type:"list"`

	// List of local secondary indexes for the restored table. The indexes provided
	// should match existing secondary indexes. You can choose to exclude some or
	// all of the indexes at the time of restore.
	LocalSecondaryIndexOverride []*LocalSecondaryIndex `type:"list"`

	// Provisioned throughput settings for the restored table.
	ProvisionedThroughputOverride *ProvisionedThroughput `type:"structure"`

	// The new server-side encryption settings for the restored table.
	SSESpecificationOverride *SSESpecification `type:"structure"`

	// The name of the new table to which the backup must be restored.
	//
	// TargetTableName is a required field
	TargetTableName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RestoreTableFromBackupInput) GoString added in v1.12.36 

func (s RestoreTableFromBackupInput) 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 (*RestoreTableFromBackupInput) SetBackupArn added in v1.12.36 

func (s *RestoreTableFromBackupInput) SetBackupArn(v string) *RestoreTableFromBackupInput

SetBackupArn sets the BackupArn field's value.

func (*RestoreTableFromBackupInput) SetBillingModeOverride added in v1.25.33 

func (s *RestoreTableFromBackupInput) SetBillingModeOverride(v string) *RestoreTableFromBackupInput

SetBillingModeOverride sets the BillingModeOverride field's value.

func (*RestoreTableFromBackupInput) SetGlobalSecondaryIndexOverride added in v1.25.33 

func (s *RestoreTableFromBackupInput) SetGlobalSecondaryIndexOverride(v []*GlobalSecondaryIndex) *RestoreTableFromBackupInput

SetGlobalSecondaryIndexOverride sets the GlobalSecondaryIndexOverride field's value.

func (*RestoreTableFromBackupInput) SetLocalSecondaryIndexOverride added in v1.25.33 

func (s *RestoreTableFromBackupInput) SetLocalSecondaryIndexOverride(v []*LocalSecondaryIndex) *RestoreTableFromBackupInput

SetLocalSecondaryIndexOverride sets the LocalSecondaryIndexOverride field's value.

func (*RestoreTableFromBackupInput) SetProvisionedThroughputOverride added in v1.25.33 

func (s *RestoreTableFromBackupInput) SetProvisionedThroughputOverride(v *ProvisionedThroughput) *RestoreTableFromBackupInput

SetProvisionedThroughputOverride sets the ProvisionedThroughputOverride field's value.

func (*RestoreTableFromBackupInput) SetSSESpecificationOverride added in v1.29.4 

func (s *RestoreTableFromBackupInput) SetSSESpecificationOverride(v *SSESpecification) *RestoreTableFromBackupInput

SetSSESpecificationOverride sets the SSESpecificationOverride field's value.

func (*RestoreTableFromBackupInput) SetTargetTableName added in v1.12.36 

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

SetTargetTableName sets the TargetTableName field's value.

func (RestoreTableFromBackupInput) String added in v1.12.36 

func (s RestoreTableFromBackupInput) 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 (*RestoreTableFromBackupInput) Validate added in v1.12.36 

func (s *RestoreTableFromBackupInput) Validate() error

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

type RestoreTableFromBackupOutput added in v1.12.36 

type RestoreTableFromBackupOutput struct {

	// The description of the table created from an existing backup.
	TableDescription *TableDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (RestoreTableFromBackupOutput) GoString added in v1.12.36 

func (s RestoreTableFromBackupOutput) 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 (*RestoreTableFromBackupOutput) SetTableDescription added in v1.12.36 

func (s *RestoreTableFromBackupOutput) SetTableDescription(v *TableDescription) *RestoreTableFromBackupOutput

SetTableDescription sets the TableDescription field's value.

func (RestoreTableFromBackupOutput) String added in v1.12.36 

func (s RestoreTableFromBackupOutput) 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 RestoreTableToPointInTimeInput added in v1.13.21 

type RestoreTableToPointInTimeInput struct {

	// The billing mode of the restored table.
	BillingModeOverride *string `type:"string" enum:"BillingMode"`

	// List of global secondary indexes for the restored table. The indexes provided
	// should match existing secondary indexes. You can choose to exclude some or
	// all of the indexes at the time of restore.
	GlobalSecondaryIndexOverride []*GlobalSecondaryIndex `type:"list"`

	// List of local secondary indexes for the restored table. The indexes provided
	// should match existing secondary indexes. You can choose to exclude some or
	// all of the indexes at the time of restore.
	LocalSecondaryIndexOverride []*LocalSecondaryIndex `type:"list"`

	// Provisioned throughput settings for the restored table.
	ProvisionedThroughputOverride *ProvisionedThroughput `type:"structure"`

	// Time in the past to restore the table to.
	RestoreDateTime *time.Time `type:"timestamp"`

	// The new server-side encryption settings for the restored table.
	SSESpecificationOverride *SSESpecification `type:"structure"`

	// The DynamoDB table that will be restored. This value is an Amazon Resource
	// Name (ARN).
	SourceTableArn *string `type:"string"`

	// Name of the source table that is being restored.
	SourceTableName *string `min:"3" type:"string"`

	// The name of the new table to which it must be restored to.
	//
	// TargetTableName is a required field
	TargetTableName *string `min:"3" type:"string" required:"true"`

	// Restore the table to the latest possible time. LatestRestorableDateTime is
	// typically 5 minutes before the current time.
	UseLatestRestorableTime *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (RestoreTableToPointInTimeInput) GoString added in v1.13.21 

func (s RestoreTableToPointInTimeInput) 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 (*RestoreTableToPointInTimeInput) SetBillingModeOverride added in v1.25.33 

func (s *RestoreTableToPointInTimeInput) SetBillingModeOverride(v string) *RestoreTableToPointInTimeInput

SetBillingModeOverride sets the BillingModeOverride field's value.

func (*RestoreTableToPointInTimeInput) SetGlobalSecondaryIndexOverride added in v1.25.33 

func (s *RestoreTableToPointInTimeInput) SetGlobalSecondaryIndexOverride(v []*GlobalSecondaryIndex) *RestoreTableToPointInTimeInput

SetGlobalSecondaryIndexOverride sets the GlobalSecondaryIndexOverride field's value.

func (*RestoreTableToPointInTimeInput) SetLocalSecondaryIndexOverride added in v1.25.33 

func (s *RestoreTableToPointInTimeInput) SetLocalSecondaryIndexOverride(v []*LocalSecondaryIndex) *RestoreTableToPointInTimeInput

SetLocalSecondaryIndexOverride sets the LocalSecondaryIndexOverride field's value.

func (*RestoreTableToPointInTimeInput) SetProvisionedThroughputOverride added in v1.25.33 

func (s *RestoreTableToPointInTimeInput) SetProvisionedThroughputOverride(v *ProvisionedThroughput) *RestoreTableToPointInTimeInput

SetProvisionedThroughputOverride sets the ProvisionedThroughputOverride field's value.

func (*RestoreTableToPointInTimeInput) SetRestoreDateTime added in v1.13.21 

func (s *RestoreTableToPointInTimeInput) SetRestoreDateTime(v time.Time) *RestoreTableToPointInTimeInput

SetRestoreDateTime sets the RestoreDateTime field's value.

func (*RestoreTableToPointInTimeInput) SetSSESpecificationOverride added in v1.29.4 

func (s *RestoreTableToPointInTimeInput) SetSSESpecificationOverride(v *SSESpecification) *RestoreTableToPointInTimeInput

SetSSESpecificationOverride sets the SSESpecificationOverride field's value.

func (*RestoreTableToPointInTimeInput) SetSourceTableArn added in v1.29.4 

func (s *RestoreTableToPointInTimeInput) SetSourceTableArn(v string) *RestoreTableToPointInTimeInput

SetSourceTableArn sets the SourceTableArn field's value.

func (*RestoreTableToPointInTimeInput) SetSourceTableName added in v1.13.21 

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

SetSourceTableName sets the SourceTableName field's value.

func (*RestoreTableToPointInTimeInput) SetTargetTableName added in v1.13.21 

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

SetTargetTableName sets the TargetTableName field's value.

func (*RestoreTableToPointInTimeInput) SetUseLatestRestorableTime added in v1.13.21 

func (s *RestoreTableToPointInTimeInput) SetUseLatestRestorableTime(v bool) *RestoreTableToPointInTimeInput

SetUseLatestRestorableTime sets the UseLatestRestorableTime field's value.

func (RestoreTableToPointInTimeInput) String added in v1.13.21 

func (s RestoreTableToPointInTimeInput) 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 (*RestoreTableToPointInTimeInput) Validate added in v1.13.21 

func (s *RestoreTableToPointInTimeInput) Validate() error

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

type RestoreTableToPointInTimeOutput added in v1.13.21 

type RestoreTableToPointInTimeOutput struct {

	// Represents the properties of a table.
	TableDescription *TableDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (RestoreTableToPointInTimeOutput) GoString added in v1.13.21 

func (s RestoreTableToPointInTimeOutput) 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 (*RestoreTableToPointInTimeOutput) SetTableDescription added in v1.13.21 

func (s *RestoreTableToPointInTimeOutput) SetTableDescription(v *TableDescription) *RestoreTableToPointInTimeOutput

SetTableDescription sets the TableDescription field's value.

func (RestoreTableToPointInTimeOutput) String added in v1.13.21 

func (s RestoreTableToPointInTimeOutput) 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 SSEDescription added in v1.12.73 

type SSEDescription struct {

	// Indicates the time, in UNIX epoch date format, when DynamoDB detected that
	// the table's KMS key was inaccessible. This attribute will automatically be
	// cleared when DynamoDB detects that the table's KMS key is accessible again.
	// DynamoDB will initiate the table archival process when table's KMS key remains
	// inaccessible for more than seven days from this date.
	InaccessibleEncryptionDateTime *time.Time `type:"timestamp"`

	// The KMS key ARN used for the KMS encryption.
	KMSMasterKeyArn *string `type:"string"`

	// Server-side encryption type. The only supported value is:
	//
	//    * KMS - Server-side encryption that uses Key Management Service. The key
	//    is stored in your account and is managed by KMS (KMS charges apply).
	SSEType *string `type:"string" enum:"SSEType"`

	// Represents the current state of server-side encryption. The only supported
	// values are:
	//
	//    * ENABLED - Server-side encryption is enabled.
	//
	//    * UPDATING - Server-side encryption is being updated.
	Status *string `type:"string" enum:"SSEStatus"`
	// contains filtered or unexported fields
}

The description of the server-side encryption status on the specified table.

func (SSEDescription) GoString added in v1.12.73 

func (s SSEDescription) 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 (*SSEDescription) SetInaccessibleEncryptionDateTime added in v1.25.43 

func (s *SSEDescription) SetInaccessibleEncryptionDateTime(v time.Time) *SSEDescription

SetInaccessibleEncryptionDateTime sets the InaccessibleEncryptionDateTime field's value.

func (*SSEDescription) SetKMSMasterKeyArn added in v1.14.7 

func (s *SSEDescription) SetKMSMasterKeyArn(v string) *SSEDescription

SetKMSMasterKeyArn sets the KMSMasterKeyArn field's value.

func (*SSEDescription) SetSSEType added in v1.14.7 

func (s *SSEDescription) SetSSEType(v string) *SSEDescription

SetSSEType sets the SSEType field's value.

func (*SSEDescription) SetStatus added in v1.12.73 

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

SetStatus sets the Status field's value.

func (SSEDescription) String added in v1.12.73 

func (s SSEDescription) 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 SSESpecification added in v1.12.73 

type SSESpecification struct {

	// Indicates whether server-side encryption is done using an Amazon Web Services
	// managed key or an Amazon Web Services owned key. If enabled (true), server-side
	// encryption type is set to KMS and an Amazon Web Services managed key is used
	// (KMS charges apply). If disabled (false) or not specified, server-side encryption
	// is set to Amazon Web Services owned key.
	Enabled *bool `type:"boolean"`

	// The KMS key that should be used for the KMS encryption. To specify a key,
	// use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note
	// that you should only provide this parameter if the key is different from
	// the default DynamoDB key alias/aws/dynamodb.
	KMSMasterKeyId *string `type:"string"`

	// Server-side encryption type. The only supported value is:
	//
	//    * KMS - Server-side encryption that uses Key Management Service. The key
	//    is stored in your account and is managed by KMS (KMS charges apply).
	SSEType *string `type:"string" enum:"SSEType"`
	// contains filtered or unexported fields
}

Represents the settings used to enable server-side encryption.

func (SSESpecification) GoString added in v1.12.73 

func (s SSESpecification) 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 (*SSESpecification) SetEnabled added in v1.12.73 

func (s *SSESpecification) SetEnabled(v bool) *SSESpecification

SetEnabled sets the Enabled field's value.

func (*SSESpecification) SetKMSMasterKeyId added in v1.15.16 

func (s *SSESpecification) SetKMSMasterKeyId(v string) *SSESpecification

SetKMSMasterKeyId sets the KMSMasterKeyId field's value.

func (*SSESpecification) SetSSEType added in v1.15.16 

func (s *SSESpecification) SetSSEType(v string) *SSESpecification

SetSSEType sets the SSEType field's value.

func (SSESpecification) String added in v1.12.73 

func (s SSESpecification) 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 ScanInput 

type ScanInput struct {

	// This is a legacy parameter. Use ProjectionExpression instead. For more information,
	// see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html)
	// in the Amazon DynamoDB Developer Guide.
	AttributesToGet []*string `min:"1" type:"list"`

	// This is a legacy parameter. Use FilterExpression instead. For more information,
	// see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html)
	// in the Amazon DynamoDB Developer Guide.
	ConditionalOperator *string `type:"string" enum:"ConditionalOperator"`

	// A Boolean value that determines the read consistency model during the scan:
	//
	//    * If ConsistentRead is false, then the data returned from Scan might not
	//    contain the results from other recently completed write operations (PutItem,
	//    UpdateItem, or DeleteItem).
	//
	//    * If ConsistentRead is true, then all of the write operations that completed
	//    before the Scan began are guaranteed to be contained in the Scan response.
	//
	// The default setting for ConsistentRead is false.
	//
	// The ConsistentRead parameter is not supported on global secondary indexes.
	// If you scan a global secondary index with ConsistentRead set to true, you
	// will receive a ValidationException.
	ConsistentRead *bool `type:"boolean"`

	// The primary key of the first item that this operation will evaluate. Use
	// the value that was returned for LastEvaluatedKey in the previous operation.
	//
	// The data type for ExclusiveStartKey must be String, Number or Binary. No
	// set data types are allowed.
	//
	// In a parallel scan, a Scan request that includes ExclusiveStartKey must specify
	// the same segment whose previous Scan returned the corresponding value of
	// LastEvaluatedKey.
	ExclusiveStartKey map[string]*AttributeValue `type:"map"`

	// One or more substitution tokens for attribute names in an expression. The
	// following are some use cases for using ExpressionAttributeNames:
	//
	//    * To access an attribute whose name conflicts with a DynamoDB reserved
	//    word.
	//
	//    * To create a placeholder for repeating occurrences of an attribute name
	//    in an expression.
	//
	//    * To prevent special characters in an attribute name from being misinterpreted
	//    in an expression.
	//
	// Use the # character in an expression to dereference an attribute name. For
	// example, consider the following attribute name:
	//
	//    * Percentile
	//
	// The name of this attribute conflicts with a reserved word, so it cannot be
	// used directly in an expression. (For the complete list of reserved words,
	// see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
	// in the Amazon DynamoDB Developer Guide). To work around this, you could specify
	// the following for ExpressionAttributeNames:
	//
	//    * {"#P":"Percentile"}
	//
	// You could then use this substitution in an expression, as in this example:
	//
	//    * #P = :val
	//
	// Tokens that begin with the : character are expression attribute values, which
	// are placeholders for the actual value at runtime.
	//
	// For more information on expression attribute names, see Specifying Item Attributes
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
	// in the Amazon DynamoDB Developer Guide.
	ExpressionAttributeNames map[string]*string `type:"map"`

	// One or more values that can be substituted in an expression.
	//
	// Use the : (colon) character in an expression to dereference an attribute
	// value. For example, suppose that you wanted to check whether the value of
	// the ProductStatus attribute was one of the following:
	//
	// Available | Backordered | Discontinued
	//
	// You would first need to specify ExpressionAttributeValues as follows:
	//
	// { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"}
	// }
	//
	// You could then use these values in an expression, such as this:
	//
	// ProductStatus IN (:avail, :back, :disc)
	//
	// For more information on expression attribute values, see Condition Expressions
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
	// in the Amazon DynamoDB Developer Guide.
	ExpressionAttributeValues map[string]*AttributeValue `type:"map"`

	// A string that contains conditions that DynamoDB applies after the Scan operation,
	// but before the data is returned to you. Items that do not satisfy the FilterExpression
	// criteria are not returned.
	//
	// A FilterExpression is applied after the items have already been read; the
	// process of filtering does not consume any additional read capacity units.
	//
	// For more information, see Filter Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Query.FilterExpression)
	// in the Amazon DynamoDB Developer Guide.
	FilterExpression *string `type:"string"`

	// The name of a secondary index to scan. This index can be any local secondary
	// index or global secondary index. Note that if you use the IndexName parameter,
	// you must also provide TableName.
	IndexName *string `min:"3" type:"string"`

	// The maximum number of items to evaluate (not necessarily the number of matching
	// items). If DynamoDB processes the number of items up to the limit while processing
	// the results, it stops the operation and returns the matching values up to
	// that point, and a key in LastEvaluatedKey to apply in a subsequent operation,
	// so that you can pick up where you left off. Also, if the processed dataset
	// size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation
	// and returns the matching values up to the limit, and a key in LastEvaluatedKey
	// to apply in a subsequent operation to continue the operation. For more information,
	// see Working with Queries (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html)
	// in the Amazon DynamoDB Developer Guide.
	Limit *int64 `min:"1" type:"integer"`

	// A string that identifies one or more attributes to retrieve from the specified
	// table or index. These attributes can include scalars, sets, or elements of
	// a JSON document. The attributes in the expression must be separated by commas.
	//
	// If no attribute names are specified, then all attributes will be returned.
	// If any of the requested attributes are not found, they will not appear in
	// the result.
	//
	// For more information, see Specifying Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
	// in the Amazon DynamoDB Developer Guide.
	ProjectionExpression *string `type:"string"`

	// Determines the level of detail about either provisioned or on-demand throughput
	// consumption that is returned in the response:
	//
	//    * INDEXES - The response includes the aggregate ConsumedCapacity for the
	//    operation, together with ConsumedCapacity for each table and secondary
	//    index that was accessed. Note that some operations, such as GetItem and
	//    BatchGetItem, do not access any indexes at all. In these cases, specifying
	//    INDEXES will only return ConsumedCapacity information for table(s).
	//
	//    * TOTAL - The response includes only the aggregate ConsumedCapacity for
	//    the operation.
	//
	//    * NONE - No ConsumedCapacity details are included in the response.
	ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"`

	// This is a legacy parameter. Use FilterExpression instead. For more information,
	// see ScanFilter (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html)
	// in the Amazon DynamoDB Developer Guide.
	ScanFilter map[string]*Condition `type:"map"`

	// For a parallel Scan request, Segment identifies an individual segment to
	// be scanned by an application worker.
	//
	// Segment IDs are zero-based, so the first segment is always 0. For example,
	// if you want to use four application threads to scan a table or an index,
	// then the first thread specifies a Segment value of 0, the second thread specifies
	// 1, and so on.
	//
	// The value of LastEvaluatedKey returned from a parallel Scan request must
	// be used as ExclusiveStartKey with the same segment ID in a subsequent Scan
	// operation.
	//
	// The value for Segment must be greater than or equal to 0, and less than the
	// value provided for TotalSegments.
	//
	// If you provide Segment, you must also provide TotalSegments.
	Segment *int64 `type:"integer"`

	// The attributes to be returned in the result. You can retrieve all item attributes,
	// specific item attributes, the count of matching items, or in the case of
	// an index, some or all of the attributes projected into the index.
	//
	//    * ALL_ATTRIBUTES - Returns all of the item attributes from the specified
	//    table or index. If you query a local secondary index, then for each matching
	//    item in the index, DynamoDB fetches the entire item from the parent table.
	//    If the index is configured to project all item attributes, then all of
	//    the data can be obtained from the local secondary index, and no fetching
	//    is required.
	//
	//    * ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves
	//    all attributes that have been projected into the index. If the index is
	//    configured to project all attributes, this return value is equivalent
	//    to specifying ALL_ATTRIBUTES.
	//
	//    * COUNT - Returns the number of matching items, rather than the matching
	//    items themselves.
	//
	//    * SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression.
	//    This return value is equivalent to specifying ProjectionExpression without
	//    specifying any value for Select. If you query or scan a local secondary
	//    index and request only attributes that are projected into that index,
	//    the operation reads only the index and not the table. If any of the requested
	//    attributes are not projected into the local secondary index, DynamoDB
	//    fetches each of these attributes from the parent table. This extra fetching
	//    incurs additional throughput cost and latency. If you query or scan a
	//    global secondary index, you can only request attributes that are projected
	//    into the index. Global secondary index queries cannot fetch attributes
	//    from the parent table.
	//
	// If neither Select nor ProjectionExpression are specified, DynamoDB defaults
	// to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when
	// accessing an index. You cannot use both Select and ProjectionExpression together
	// in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES.
	// (This usage is equivalent to specifying ProjectionExpression without any
	// value for Select.)
	//
	// If you use the ProjectionExpression parameter, then the value for Select
	// can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an
	// error.
	Select *string `type:"string" enum:"Select"`

	// The name of the table containing the requested items; or, if you provide
	// IndexName, the name of the table to which that index belongs.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`

	// For a parallel Scan request, TotalSegments represents the total number of
	// segments into which the Scan operation will be divided. The value of TotalSegments
	// corresponds to the number of application workers that will perform the parallel
	// scan. For example, if you want to use four application threads to scan a
	// table or an index, specify a TotalSegments value of 4.
	//
	// The value for TotalSegments must be greater than or equal to 1, and less
	// than or equal to 1000000. If you specify a TotalSegments value of 1, the
	// Scan operation will be sequential rather than parallel.
	//
	// If you specify TotalSegments, you must also specify Segment.
	TotalSegments *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

Represents the input of a Scan operation.

func (ScanInput) GoString added in v0.6.5 

func (s ScanInput) 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 (*ScanInput) SetAttributesToGet added in v1.5.0 

func (s *ScanInput) SetAttributesToGet(v []*string) *ScanInput

SetAttributesToGet sets the AttributesToGet field's value.

func (*ScanInput) SetConditionalOperator added in v1.5.0 

func (s *ScanInput) SetConditionalOperator(v string) *ScanInput

SetConditionalOperator sets the ConditionalOperator field's value.

func (*ScanInput) SetConsistentRead added in v1.5.0 

func (s *ScanInput) SetConsistentRead(v bool) *ScanInput

SetConsistentRead sets the ConsistentRead field's value.

func (*ScanInput) SetExclusiveStartKey added in v1.5.0 

func (s *ScanInput) SetExclusiveStartKey(v map[string]*AttributeValue) *ScanInput

SetExclusiveStartKey sets the ExclusiveStartKey field's value.

func (*ScanInput) SetExpressionAttributeNames added in v1.5.0 

func (s *ScanInput) SetExpressionAttributeNames(v map[string]*string) *ScanInput

SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.

func (*ScanInput) SetExpressionAttributeValues added in v1.5.0 

func (s *ScanInput) SetExpressionAttributeValues(v map[string]*AttributeValue) *ScanInput

SetExpressionAttributeValues sets the ExpressionAttributeValues field's value.

func (*ScanInput) SetFilterExpression added in v1.5.0 

func (s *ScanInput) SetFilterExpression(v string) *ScanInput

SetFilterExpression sets the FilterExpression field's value.

func (*ScanInput) SetIndexName added in v1.5.0 

func (s *ScanInput) SetIndexName(v string) *ScanInput

SetIndexName sets the IndexName field's value.

func (*ScanInput) SetLimit added in v1.5.0 

func (s *ScanInput) SetLimit(v int64) *ScanInput

SetLimit sets the Limit field's value.

func (*ScanInput) SetProjectionExpression added in v1.5.0 

func (s *ScanInput) SetProjectionExpression(v string) *ScanInput

SetProjectionExpression sets the ProjectionExpression field's value.

func (*ScanInput) SetReturnConsumedCapacity added in v1.5.0 

func (s *ScanInput) SetReturnConsumedCapacity(v string) *ScanInput

SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.

func (*ScanInput) SetScanFilter added in v1.5.0 

func (s *ScanInput) SetScanFilter(v map[string]*Condition) *ScanInput

SetScanFilter sets the ScanFilter field's value.

func (*ScanInput) SetSegment added in v1.5.0 

func (s *ScanInput) SetSegment(v int64) *ScanInput

SetSegment sets the Segment field's value.

func (*ScanInput) SetSelect added in v1.5.0 

func (s *ScanInput) SetSelect(v string) *ScanInput

SetSelect sets the Select field's value.

func (*ScanInput) SetTableName added in v1.5.0 

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

SetTableName sets the TableName field's value.

func (*ScanInput) SetTotalSegments added in v1.5.0 

func (s *ScanInput) SetTotalSegments(v int64) *ScanInput

SetTotalSegments sets the TotalSegments field's value.

func (ScanInput) String added in v0.6.5 

func (s ScanInput) 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 (*ScanInput) Validate added in v1.1.21 

func (s *ScanInput) Validate() error

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

type ScanOutput 

type ScanOutput struct {

	// The capacity units consumed by the Scan operation. The data returned includes
	// the total provisioned throughput consumed, along with statistics for the
	// table and any indexes involved in the operation. ConsumedCapacity is only
	// returned if the ReturnConsumedCapacity parameter was specified. For more
	// information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
	// in the Amazon DynamoDB Developer Guide.
	ConsumedCapacity *ConsumedCapacity `type:"structure"`

	// The number of items in the response.
	//
	// If you set ScanFilter in the request, then Count is the number of items returned
	// after the filter was applied, and ScannedCount is the number of matching
	// items before the filter was applied.
	//
	// If you did not use a filter in the request, then Count is the same as ScannedCount.
	Count *int64 `type:"integer"`

	// An array of item attributes that match the scan criteria. Each element in
	// this array consists of an attribute name and the value for that attribute.
	Items []map[string]*AttributeValue `type:"list"`

	// The primary key of the item where the operation stopped, inclusive of the
	// previous result set. Use this value to start a new operation, excluding this
	// value in the new request.
	//
	// If LastEvaluatedKey is empty, then the "last page" of results has been processed
	// and there is no more data to be retrieved.
	//
	// If LastEvaluatedKey is not empty, it does not necessarily mean that there
	// is more data in the result set. The only way to know when you have reached
	// the end of the result set is when LastEvaluatedKey is empty.
	LastEvaluatedKey map[string]*AttributeValue `type:"map"`

	// The number of items evaluated, before any ScanFilter is applied. A high ScannedCount
	// value with few, or no, Count results indicates an inefficient Scan operation.
	// For more information, see Count and ScannedCount (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count)
	// in the Amazon DynamoDB Developer Guide.
	//
	// If you did not use a filter in the request, then ScannedCount is the same
	// as Count.
	ScannedCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the output of a Scan operation.

func (ScanOutput) GoString added in v0.6.5 

func (s ScanOutput) 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 (*ScanOutput) SetConsumedCapacity added in v1.5.0 

func (s *ScanOutput) SetConsumedCapacity(v *ConsumedCapacity) *ScanOutput

SetConsumedCapacity sets the ConsumedCapacity field's value.

func (*ScanOutput) SetCount added in v1.5.0 

func (s *ScanOutput) SetCount(v int64) *ScanOutput

SetCount sets the Count field's value.

func (*ScanOutput) SetItems added in v1.5.0 

func (s *ScanOutput) SetItems(v []map[string]*AttributeValue) *ScanOutput

SetItems sets the Items field's value.

func (*ScanOutput) SetLastEvaluatedKey added in v1.5.0 

func (s *ScanOutput) SetLastEvaluatedKey(v map[string]*AttributeValue) *ScanOutput

SetLastEvaluatedKey sets the LastEvaluatedKey field's value.

func (*ScanOutput) SetScannedCount added in v1.5.0 

func (s *ScanOutput) SetScannedCount(v int64) *ScanOutput

SetScannedCount sets the ScannedCount field's value.

func (ScanOutput) String added in v0.6.5 

func (s ScanOutput) 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 SourceTableDetails added in v1.12.36 

type SourceTableDetails struct {

	// Controls how you are charged for read and write throughput and how you manage
	// capacity. This setting can be changed later.
	//
	//    * PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend
	//    using PROVISIONED for predictable workloads.
	//
	//    * PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST.
	//    We recommend using PAY_PER_REQUEST for unpredictable workloads.
	BillingMode *string `type:"string" enum:"BillingMode"`

	// Number of items in the table. Note that this is an approximate value.
	ItemCount *int64 `type:"long"`

	// Schema of the table.
	//
	// KeySchema is a required field
	KeySchema []*KeySchemaElement `min:"1" type:"list" required:"true"`

	// Read IOPs and Write IOPS on the table when the backup was created.
	//
	// ProvisionedThroughput is a required field
	ProvisionedThroughput *ProvisionedThroughput `type:"structure" required:"true"`

	// ARN of the table for which backup was created.
	TableArn *string `type:"string"`

	// Time when the source table was created.
	//
	// TableCreationDateTime is a required field
	TableCreationDateTime *time.Time `type:"timestamp" required:"true"`

	// Unique identifier for the table for which the backup was created.
	//
	// TableId is a required field
	TableId *string `type:"string" required:"true"`

	// The name of the table for which the backup was created.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`

	// Size of the table in bytes. Note that this is an approximate value.
	TableSizeBytes *int64 `type:"long"`
	// contains filtered or unexported fields
}

Contains the details of the table when the backup was created.

func (SourceTableDetails) GoString added in v1.12.36 

func (s SourceTableDetails) 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 (*SourceTableDetails) SetBillingMode added in v1.15.85 

func (s *SourceTableDetails) SetBillingMode(v string) *SourceTableDetails

SetBillingMode sets the BillingMode field's value.

func (*SourceTableDetails) SetItemCount added in v1.12.36 

func (s *SourceTableDetails) SetItemCount(v int64) *SourceTableDetails

SetItemCount sets the ItemCount field's value.

func (*SourceTableDetails) SetKeySchema added in v1.12.36 

func (s *SourceTableDetails) SetKeySchema(v []*KeySchemaElement) *SourceTableDetails

SetKeySchema sets the KeySchema field's value.

func (*SourceTableDetails) SetProvisionedThroughput added in v1.12.36 

func (s *SourceTableDetails) SetProvisionedThroughput(v *ProvisionedThroughput) *SourceTableDetails

SetProvisionedThroughput sets the ProvisionedThroughput field's value.

func (*SourceTableDetails) SetTableArn added in v1.12.36 

func (s *SourceTableDetails) SetTableArn(v string) *SourceTableDetails

SetTableArn sets the TableArn field's value.

func (*SourceTableDetails) SetTableCreationDateTime added in v1.12.36 

func (s *SourceTableDetails) SetTableCreationDateTime(v time.Time) *SourceTableDetails

SetTableCreationDateTime sets the TableCreationDateTime field's value.

func (*SourceTableDetails) SetTableId added in v1.12.36 

func (s *SourceTableDetails) SetTableId(v string) *SourceTableDetails

SetTableId sets the TableId field's value.

func (*SourceTableDetails) SetTableName added in v1.12.36 

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

SetTableName sets the TableName field's value.

func (*SourceTableDetails) SetTableSizeBytes added in v1.12.36 

func (s *SourceTableDetails) SetTableSizeBytes(v int64) *SourceTableDetails

SetTableSizeBytes sets the TableSizeBytes field's value.

func (SourceTableDetails) String added in v1.12.36 

func (s SourceTableDetails) 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 SourceTableFeatureDetails added in v1.12.36 

type SourceTableFeatureDetails struct {

	// Represents the GSI properties for the table when the backup was created.
	// It includes the IndexName, KeySchema, Projection, and ProvisionedThroughput
	// for the GSIs on the table at the time of backup.
	GlobalSecondaryIndexes []*GlobalSecondaryIndexInfo `type:"list"`

	// Represents the LSI properties for the table when the backup was created.
	// It includes the IndexName, KeySchema and Projection for the LSIs on the table
	// at the time of backup.
	LocalSecondaryIndexes []*LocalSecondaryIndexInfo `type:"list"`

	// The description of the server-side encryption status on the table when the
	// backup was created.
	SSEDescription *SSEDescription `type:"structure"`

	// Stream settings on the table when the backup was created.
	StreamDescription *StreamSpecification `type:"structure"`

	// Time to Live settings on the table when the backup was created.
	TimeToLiveDescription *TimeToLiveDescription `type:"structure"`
	// contains filtered or unexported fields
}

Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.

func (SourceTableFeatureDetails) GoString added in v1.12.36 

func (s SourceTableFeatureDetails) 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 (*SourceTableFeatureDetails) SetGlobalSecondaryIndexes added in v1.12.36 

func (s *SourceTableFeatureDetails) SetGlobalSecondaryIndexes(v []*GlobalSecondaryIndexInfo) *SourceTableFeatureDetails

SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.

func (*SourceTableFeatureDetails) SetLocalSecondaryIndexes added in v1.12.36 

func (s *SourceTableFeatureDetails) SetLocalSecondaryIndexes(v []*LocalSecondaryIndexInfo) *SourceTableFeatureDetails

SetLocalSecondaryIndexes sets the LocalSecondaryIndexes field's value.

func (*SourceTableFeatureDetails) SetSSEDescription added in v1.12.73 

func (s *SourceTableFeatureDetails) SetSSEDescription(v *SSEDescription) *SourceTableFeatureDetails

SetSSEDescription sets the SSEDescription field's value.

func (*SourceTableFeatureDetails) SetStreamDescription added in v1.12.36 

func (s *SourceTableFeatureDetails) SetStreamDescription(v *StreamSpecification) *SourceTableFeatureDetails

SetStreamDescription sets the StreamDescription field's value.

func (*SourceTableFeatureDetails) SetTimeToLiveDescription added in v1.12.36 

func (s *SourceTableFeatureDetails) SetTimeToLiveDescription(v *TimeToLiveDescription) *SourceTableFeatureDetails

SetTimeToLiveDescription sets the TimeToLiveDescription field's value.

func (SourceTableFeatureDetails) String added in v1.12.36 

func (s SourceTableFeatureDetails) 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 StreamSpecification added in v0.6.7 

type StreamSpecification struct {

	// Indicates whether DynamoDB Streams is enabled (true) or disabled (false)
	// on the table.
	//
	// StreamEnabled is a required field
	StreamEnabled *bool `type:"boolean" required:"true"`

	// When an item in the table is modified, StreamViewType determines what information
	// is written to the stream for this table. Valid values for StreamViewType
	// are:
	//
	//    * KEYS_ONLY - Only the key attributes of the modified item are written
	//    to the stream.
	//
	//    * NEW_IMAGE - The entire item, as it appears after it was modified, is
	//    written to the stream.
	//
	//    * OLD_IMAGE - The entire item, as it appeared before it was modified,
	//    is written to the stream.
	//
	//    * NEW_AND_OLD_IMAGES - Both the new and the old item images of the item
	//    are written to the stream.
	StreamViewType *string `type:"string" enum:"StreamViewType"`
	// contains filtered or unexported fields
}

Represents the DynamoDB Streams configuration for a table in DynamoDB.

func (StreamSpecification) GoString added in v0.6.7 

func (s StreamSpecification) 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 (*StreamSpecification) SetStreamEnabled added in v1.5.0 

func (s *StreamSpecification) SetStreamEnabled(v bool) *StreamSpecification

SetStreamEnabled sets the StreamEnabled field's value.

func (*StreamSpecification) SetStreamViewType added in v1.5.0 

func (s *StreamSpecification) SetStreamViewType(v string) *StreamSpecification

SetStreamViewType sets the StreamViewType field's value.

func (StreamSpecification) String added in v0.6.7 

func (s StreamSpecification) 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 (*StreamSpecification) Validate added in v1.25.40 

func (s *StreamSpecification) Validate() error

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

type TableAlreadyExistsException added in v1.28.0 

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

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

A target table with the specified name already exists.

func (*TableAlreadyExistsException) Code added in v1.28.0 

func (s *TableAlreadyExistsException) Code() string

Code returns the exception type name.

func (*TableAlreadyExistsException) Error added in v1.28.0 

func (s *TableAlreadyExistsException) Error() string

func (TableAlreadyExistsException) GoString added in v1.28.0 

func (s TableAlreadyExistsException) 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 (*TableAlreadyExistsException) Message added in v1.28.0 

func (s *TableAlreadyExistsException) Message() string

Message returns the exception's message.

func (*TableAlreadyExistsException) OrigErr added in v1.28.0 

func (s *TableAlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TableAlreadyExistsException) RequestID added in v1.28.0 

func (s *TableAlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TableAlreadyExistsException) StatusCode added in v1.28.0 

func (s *TableAlreadyExistsException) StatusCode() int

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

func (TableAlreadyExistsException) String added in v1.28.0 

func (s TableAlreadyExistsException) 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 TableAutoScalingDescription added in v1.25.40 

type TableAutoScalingDescription struct {

	// Represents replicas of the global table.
	Replicas []*ReplicaAutoScalingDescription `type:"list"`

	// The name of the table.
	TableName *string `min:"3" type:"string"`

	// The current state of the table:
	//
	//    * CREATING - The table is being created.
	//
	//    * UPDATING - The table is being updated.
	//
	//    * DELETING - The table is being deleted.
	//
	//    * ACTIVE - The table is ready for use.
	TableStatus *string `type:"string" enum:"TableStatus"`
	// contains filtered or unexported fields
}

Represents the auto scaling configuration for a global table.

func (TableAutoScalingDescription) GoString added in v1.25.40 

func (s TableAutoScalingDescription) 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 (*TableAutoScalingDescription) SetReplicas added in v1.25.40 

func (s *TableAutoScalingDescription) SetReplicas(v []*ReplicaAutoScalingDescription) *TableAutoScalingDescription

SetReplicas sets the Replicas field's value.

func (*TableAutoScalingDescription) SetTableName added in v1.25.40 

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

SetTableName sets the TableName field's value.

func (*TableAutoScalingDescription) SetTableStatus added in v1.25.40 

func (s *TableAutoScalingDescription) SetTableStatus(v string) *TableAutoScalingDescription

SetTableStatus sets the TableStatus field's value.

func (TableAutoScalingDescription) String added in v1.25.40 

func (s TableAutoScalingDescription) 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 TableClassSummary added in v1.42.17 

type TableClassSummary struct {

	// The date and time at which the table class was last updated.
	LastUpdateDateTime *time.Time `type:"timestamp"`

	// The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
	TableClass *string `type:"string" enum:"TableClass"`
	// contains filtered or unexported fields
}

Contains details of the table class.

func (TableClassSummary) GoString added in v1.42.17 

func (s TableClassSummary) 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 (*TableClassSummary) SetLastUpdateDateTime added in v1.42.17 

func (s *TableClassSummary) SetLastUpdateDateTime(v time.Time) *TableClassSummary

SetLastUpdateDateTime sets the LastUpdateDateTime field's value.

func (*TableClassSummary) SetTableClass added in v1.42.17 

func (s *TableClassSummary) SetTableClass(v string) *TableClassSummary

SetTableClass sets the TableClass field's value.

func (TableClassSummary) String added in v1.42.17 

func (s TableClassSummary) 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 TableDescription 

type TableDescription struct {

	// Contains information about the table archive.
	ArchivalSummary *ArchivalSummary `type:"structure"`

	// An array of AttributeDefinition objects. Each of these objects describes
	// one attribute in the table and index key schema.
	//
	// Each AttributeDefinition object in this array is composed of:
	//
	//    * AttributeName - The name of the attribute.
	//
	//    * AttributeType - The data type for the attribute.
	AttributeDefinitions []*AttributeDefinition `type:"list"`

	// Contains the details for the read/write capacity mode.
	BillingModeSummary *BillingModeSummary `type:"structure"`

	// The date and time when the table was created, in UNIX epoch time (http://www.epochconverter.com/)
	// format.
	CreationDateTime *time.Time `type:"timestamp"`

	// The global secondary indexes, if any, on the table. Each index is scoped
	// to a given partition key value. Each element is composed of:
	//
	//    * Backfilling - If true, then the index is currently in the backfilling
	//    phase. Backfilling occurs only when a new global secondary index is added
	//    to the table. It is the process by which DynamoDB populates the new index
	//    with data from the table. (This attribute does not appear for indexes
	//    that were created during a CreateTable operation.) You can delete an index
	//    that is being created during the Backfilling phase when IndexStatus is
	//    set to CREATING and Backfilling is true. You can't delete the index that
	//    is being created when IndexStatus is set to CREATING and Backfilling is
	//    false. (This attribute does not appear for indexes that were created during
	//    a CreateTable operation.)
	//
	//    * IndexName - The name of the global secondary index.
	//
	//    * IndexSizeBytes - The total size of the global secondary index, in bytes.
	//    DynamoDB updates this value approximately every six hours. Recent changes
	//    might not be reflected in this value.
	//
	//    * IndexStatus - The current status of the global secondary index: CREATING
	//    - The index is being created. UPDATING - The index is being updated. DELETING
	//    - The index is being deleted. ACTIVE - The index is ready for use.
	//
	//    * ItemCount - The number of items in the global secondary index. DynamoDB
	//    updates this value approximately every six hours. Recent changes might
	//    not be reflected in this value.
	//
	//    * KeySchema - Specifies the complete index key schema. The attribute names
	//    in the key schema must be between 1 and 255 characters (inclusive). The
	//    key schema must begin with the same partition key as the table.
	//
	//    * Projection - Specifies attributes that are copied (projected) from the
	//    table into the index. These are in addition to the primary key attributes
	//    and index key attributes, which are automatically projected. Each attribute
	//    specification is composed of: ProjectionType - One of the following: KEYS_ONLY
	//    - Only the index and primary keys are projected into the index. INCLUDE
	//    - In addition to the attributes described in KEYS_ONLY, the secondary
	//    index will include other non-key attributes that you specify. ALL - All
	//    of the table attributes are projected into the index. NonKeyAttributes
	//    - A list of one or more non-key attribute names that are projected into
	//    the secondary index. The total count of attributes provided in NonKeyAttributes,
	//    summed across all of the secondary indexes, must not exceed 100. If you
	//    project the same attribute into two different indexes, this counts as
	//    two distinct attributes when determining the total.
	//
	//    * ProvisionedThroughput - The provisioned throughput settings for the
	//    global secondary index, consisting of read and write capacity units, along
	//    with data about increases and decreases.
	//
	// If the table is in the DELETING state, no information about indexes will
	// be returned.
	GlobalSecondaryIndexes []*GlobalSecondaryIndexDescription `type:"list"`

	// Represents the version of global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)
	// in use, if the table is replicated across Amazon Web Services Regions.
	GlobalTableVersion *string `type:"string"`

	// The number of items in the specified table. DynamoDB updates this value approximately
	// every six hours. Recent changes might not be reflected in this value.
	ItemCount *int64 `type:"long"`

	// The primary key structure for the table. Each KeySchemaElement consists of:
	//
	//    * AttributeName - The name of the attribute.
	//
	//    * KeyType - The role of the attribute: HASH - partition key RANGE - sort
	//    key The partition key of an item is also known as its hash attribute.
	//    The term "hash attribute" derives from DynamoDB's usage of an internal
	//    hash function to evenly distribute data items across partitions, based
	//    on their partition key values. The sort key of an item is also known as
	//    its range attribute. The term "range attribute" derives from the way DynamoDB
	//    stores items with the same partition key physically close together, in
	//    sorted order by the sort key value.
	//
	// For more information about primary keys, see Primary Key (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey)
	// in the Amazon DynamoDB Developer Guide.
	KeySchema []*KeySchemaElement `min:"1" type:"list"`

	// The Amazon Resource Name (ARN) that uniquely identifies the latest stream
	// for this table.
	LatestStreamArn *string `min:"37" type:"string"`

	// A timestamp, in ISO 8601 format, for this stream.
	//
	// Note that LatestStreamLabel is not a unique identifier for the stream, because
	// it is possible that a stream from another table might have the same timestamp.
	// However, the combination of the following three elements is guaranteed to
	// be unique:
	//
	//    * Amazon Web Services customer ID
	//
	//    * Table name
	//
	//    * StreamLabel
	LatestStreamLabel *string `type:"string"`

	// Represents one or more local secondary indexes on the table. Each index is
	// scoped to a given partition key value. Tables with one or more local secondary
	// indexes are subject to an item collection size limit, where the amount of
	// data within a given item collection cannot exceed 10 GB. Each element is
	// composed of:
	//
	//    * IndexName - The name of the local secondary index.
	//
	//    * KeySchema - Specifies the complete index key schema. The attribute names
	//    in the key schema must be between 1 and 255 characters (inclusive). The
	//    key schema must begin with the same partition key as the table.
	//
	//    * Projection - Specifies attributes that are copied (projected) from the
	//    table into the index. These are in addition to the primary key attributes
	//    and index key attributes, which are automatically projected. Each attribute
	//    specification is composed of: ProjectionType - One of the following: KEYS_ONLY
	//    - Only the index and primary keys are projected into the index. INCLUDE
	//    - Only the specified table attributes are projected into the index. The
	//    list of projected attributes is in NonKeyAttributes. ALL - All of the
	//    table attributes are projected into the index. NonKeyAttributes - A list
	//    of one or more non-key attribute names that are projected into the secondary
	//    index. The total count of attributes provided in NonKeyAttributes, summed
	//    across all of the secondary indexes, must not exceed 100. If you project
	//    the same attribute into two different indexes, this counts as two distinct
	//    attributes when determining the total.
	//
	//    * IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB
	//    updates this value approximately every six hours. Recent changes might
	//    not be reflected in this value.
	//
	//    * ItemCount - Represents the number of items in the index. DynamoDB updates
	//    this value approximately every six hours. Recent changes might not be
	//    reflected in this value.
	//
	// If the table is in the DELETING state, no information about indexes will
	// be returned.
	LocalSecondaryIndexes []*LocalSecondaryIndexDescription `type:"list"`

	// The provisioned throughput settings for the table, consisting of read and
	// write capacity units, along with data about increases and decreases.
	ProvisionedThroughput *ProvisionedThroughputDescription `type:"structure"`

	// Represents replicas of the table.
	Replicas []*ReplicaDescription `type:"list"`

	// Contains details for the restore.
	RestoreSummary *RestoreSummary `type:"structure"`

	// The description of the server-side encryption status on the specified table.
	SSEDescription *SSEDescription `type:"structure"`

	// The current DynamoDB Streams configuration for the table.
	StreamSpecification *StreamSpecification `type:"structure"`

	// The Amazon Resource Name (ARN) that uniquely identifies the table.
	TableArn *string `type:"string"`

	// Contains details of the table class.
	TableClassSummary *TableClassSummary `type:"structure"`

	// Unique identifier for the table for which the backup was created.
	TableId *string `type:"string"`

	// The name of the table.
	TableName *string `min:"3" type:"string"`

	// The total size of the specified table, in bytes. DynamoDB updates this value
	// approximately every six hours. Recent changes might not be reflected in this
	// value.
	TableSizeBytes *int64 `type:"long"`

	// The current state of the table:
	//
	//    * CREATING - The table is being created.
	//
	//    * UPDATING - The table is being updated.
	//
	//    * DELETING - The table is being deleted.
	//
	//    * ACTIVE - The table is ready for use.
	//
	//    * INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the
	//    table in inaccessible. Table operations may fail due to failure to use
	//    the KMS key. DynamoDB will initiate the table archival process when a
	//    table's KMS key remains inaccessible for more than seven days.
	//
	//    * ARCHIVING - The table is being archived. Operations are not allowed
	//    until archival is complete.
	//
	//    * ARCHIVED - The table has been archived. See the ArchivalReason for more
	//    information.
	TableStatus *string `type:"string" enum:"TableStatus"`
	// contains filtered or unexported fields
}

Represents the properties of a table.

func (TableDescription) GoString added in v0.6.5 

func (s TableDescription) 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 (*TableDescription) SetArchivalSummary added in v1.25.43 

func (s *TableDescription) SetArchivalSummary(v *ArchivalSummary) *TableDescription

SetArchivalSummary sets the ArchivalSummary field's value.

func (*TableDescription) SetAttributeDefinitions added in v1.5.0 

func (s *TableDescription) SetAttributeDefinitions(v []*AttributeDefinition) *TableDescription

SetAttributeDefinitions sets the AttributeDefinitions field's value.

func (*TableDescription) SetBillingModeSummary added in v1.15.85 

func (s *TableDescription) SetBillingModeSummary(v *BillingModeSummary) *TableDescription

SetBillingModeSummary sets the BillingModeSummary field's value.

func (*TableDescription) SetCreationDateTime added in v1.5.0 

func (s *TableDescription) SetCreationDateTime(v time.Time) *TableDescription

SetCreationDateTime sets the CreationDateTime field's value.

func (*TableDescription) SetGlobalSecondaryIndexes added in v1.5.0 

func (s *TableDescription) SetGlobalSecondaryIndexes(v []*GlobalSecondaryIndexDescription) *TableDescription

SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.

func (*TableDescription) SetGlobalTableVersion added in v1.25.40 

func (s *TableDescription) SetGlobalTableVersion(v string) *TableDescription

SetGlobalTableVersion sets the GlobalTableVersion field's value.

func (*TableDescription) SetItemCount added in v1.5.0 

func (s *TableDescription) SetItemCount(v int64) *TableDescription

SetItemCount sets the ItemCount field's value.

func (*TableDescription) SetKeySchema added in v1.5.0 

func (s *TableDescription) SetKeySchema(v []*KeySchemaElement) *TableDescription

SetKeySchema sets the KeySchema field's value.

func (*TableDescription) SetLatestStreamArn added in v1.5.0 

func (s *TableDescription) SetLatestStreamArn(v string) *TableDescription

SetLatestStreamArn sets the LatestStreamArn field's value.

func (*TableDescription) SetLatestStreamLabel added in v1.5.0 

func (s *TableDescription) SetLatestStreamLabel(v string) *TableDescription

SetLatestStreamLabel sets the LatestStreamLabel field's value.

func (*TableDescription) SetLocalSecondaryIndexes added in v1.5.0 

func (s *TableDescription) SetLocalSecondaryIndexes(v []*LocalSecondaryIndexDescription) *TableDescription

SetLocalSecondaryIndexes sets the LocalSecondaryIndexes field's value.

func (*TableDescription) SetProvisionedThroughput added in v1.5.0 

func (s *TableDescription) SetProvisionedThroughput(v *ProvisionedThroughputDescription) *TableDescription

SetProvisionedThroughput sets the ProvisionedThroughput field's value.

func (*TableDescription) SetReplicas added in v1.25.40 

func (s *TableDescription) SetReplicas(v []*ReplicaDescription) *TableDescription

SetReplicas sets the Replicas field's value.

func (*TableDescription) SetRestoreSummary added in v1.12.36 

func (s *TableDescription) SetRestoreSummary(v *RestoreSummary) *TableDescription

SetRestoreSummary sets the RestoreSummary field's value.

func (*TableDescription) SetSSEDescription added in v1.12.73 

func (s *TableDescription) SetSSEDescription(v *SSEDescription) *TableDescription

SetSSEDescription sets the SSEDescription field's value.

func (*TableDescription) SetStreamSpecification added in v1.5.0 

func (s *TableDescription) SetStreamSpecification(v *StreamSpecification) *TableDescription

SetStreamSpecification sets the StreamSpecification field's value.

func (*TableDescription) SetTableArn added in v1.5.0 

func (s *TableDescription) SetTableArn(v string) *TableDescription

SetTableArn sets the TableArn field's value.

func (*TableDescription) SetTableClassSummary added in v1.42.17 

func (s *TableDescription) SetTableClassSummary(v *TableClassSummary) *TableDescription

SetTableClassSummary sets the TableClassSummary field's value.

func (*TableDescription) SetTableId added in v1.12.36 

func (s *TableDescription) SetTableId(v string) *TableDescription

SetTableId sets the TableId field's value.

func (*TableDescription) SetTableName added in v1.5.0 

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

SetTableName sets the TableName field's value.

func (*TableDescription) SetTableSizeBytes added in v1.5.0 

func (s *TableDescription) SetTableSizeBytes(v int64) *TableDescription

SetTableSizeBytes sets the TableSizeBytes field's value.

func (*TableDescription) SetTableStatus added in v1.5.0 

func (s *TableDescription) SetTableStatus(v string) *TableDescription

SetTableStatus sets the TableStatus field's value.

func (TableDescription) String added in v0.6.5 

func (s TableDescription) 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 TableInUseException added in v1.28.0 

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

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

A target table with the specified name is either being created or deleted.

func (*TableInUseException) Code added in v1.28.0 

func (s *TableInUseException) Code() string

Code returns the exception type name.

func (*TableInUseException) Error added in v1.28.0 

func (s *TableInUseException) Error() string

func (TableInUseException) GoString added in v1.28.0 

func (s TableInUseException) 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 (*TableInUseException) Message added in v1.28.0 

func (s *TableInUseException) Message() string

Message returns the exception's message.

func (*TableInUseException) OrigErr added in v1.28.0 

func (s *TableInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TableInUseException) RequestID added in v1.28.0 

func (s *TableInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TableInUseException) StatusCode added in v1.28.0 

func (s *TableInUseException) StatusCode() int

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

func (TableInUseException) String added in v1.28.0 

func (s TableInUseException) 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 TableNotFoundException added in v1.28.0 

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

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

A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

func (*TableNotFoundException) Code added in v1.28.0 

func (s *TableNotFoundException) Code() string

Code returns the exception type name.

func (*TableNotFoundException) Error added in v1.28.0 

func (s *TableNotFoundException) Error() string

func (TableNotFoundException) GoString added in v1.28.0 

func (s TableNotFoundException) 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 (*TableNotFoundException) Message added in v1.28.0 

func (s *TableNotFoundException) Message() string

Message returns the exception's message.

func (*TableNotFoundException) OrigErr added in v1.28.0 

func (s *TableNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TableNotFoundException) RequestID added in v1.28.0 

func (s *TableNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TableNotFoundException) StatusCode added in v1.28.0 

func (s *TableNotFoundException) StatusCode() int

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

func (TableNotFoundException) String added in v1.28.0 

func (s TableNotFoundException) 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 added in v1.6.12 

type Tag struct {

	// The key of the tag. Tag keys are case sensitive. Each DynamoDB table 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 `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 `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 DynamoDB table.

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 an overview on tagging DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html) in the Amazon DynamoDB Developer Guide.

func (Tag) GoString added in v1.6.12 

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 added in v1.6.12 

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

SetKey sets the Key field's value.

func (*Tag) SetValue added in v1.6.12 

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

SetValue sets the Value field's value.

func (Tag) String added in v1.6.12 

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 added in v1.6.12 

func (s *Tag) Validate() error

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

type TagResourceInput added in v1.6.12 

type TagResourceInput struct {

	// Identifies the Amazon DynamoDB resource to which tags should be added. This
	// value is an Amazon Resource Name (ARN).
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`

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

func (TagResourceInput) GoString added in v1.6.12 

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 added in v1.6.12 

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

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.6.12 

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

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.6.12 

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 added in v1.6.12 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput added in v1.6.12 

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

func (TagResourceOutput) GoString added in v1.6.12 

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 added in v1.6.12 

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 TimeToLiveDescription added in v1.7.2 

type TimeToLiveDescription struct {

	// The name of the TTL attribute for items in the table.
	AttributeName *string `min:"1" type:"string"`

	// The TTL status for the table.
	TimeToLiveStatus *string `type:"string" enum:"TimeToLiveStatus"`
	// contains filtered or unexported fields
}

The description of the Time to Live (TTL) status on the specified table.

func (TimeToLiveDescription) GoString added in v1.7.2 

func (s TimeToLiveDescription) 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 (*TimeToLiveDescription) SetAttributeName added in v1.7.2 

func (s *TimeToLiveDescription) SetAttributeName(v string) *TimeToLiveDescription

SetAttributeName sets the AttributeName field's value.

func (*TimeToLiveDescription) SetTimeToLiveStatus added in v1.7.2 

func (s *TimeToLiveDescription) SetTimeToLiveStatus(v string) *TimeToLiveDescription

SetTimeToLiveStatus sets the TimeToLiveStatus field's value.

func (TimeToLiveDescription) String added in v1.7.2 

func (s TimeToLiveDescription) 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 TimeToLiveSpecification added in v1.7.2 

type TimeToLiveSpecification struct {

	// The name of the TTL attribute used to store the expiration time for items
	// in the table.
	//
	// AttributeName is a required field
	AttributeName *string `min:"1" type:"string" required:"true"`

	// Indicates whether TTL is to be enabled (true) or disabled (false) on the
	// table.
	//
	// Enabled is a required field
	Enabled *bool `type:"boolean" required:"true"`
	// contains filtered or unexported fields
}

Represents the settings used to enable or disable Time to Live (TTL) for the specified table.

func (TimeToLiveSpecification) GoString added in v1.7.2 

func (s TimeToLiveSpecification) 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 (*TimeToLiveSpecification) SetAttributeName added in v1.7.2 

func (s *TimeToLiveSpecification) SetAttributeName(v string) *TimeToLiveSpecification

SetAttributeName sets the AttributeName field's value.

func (*TimeToLiveSpecification) SetEnabled added in v1.7.2 

func (s *TimeToLiveSpecification) SetEnabled(v bool) *TimeToLiveSpecification

SetEnabled sets the Enabled field's value.

func (TimeToLiveSpecification) String added in v1.7.2 

func (s TimeToLiveSpecification) 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 (*TimeToLiveSpecification) Validate added in v1.7.2 

func (s *TimeToLiveSpecification) Validate() error

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

type TransactGetItem added in v1.15.85 

type TransactGetItem struct {

	// Contains the primary key that identifies the item to get, together with the
	// name of the table that contains the item, and optionally the specific attributes
	// of the item to retrieve.
	//
	// Get is a required field
	Get *Get `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Specifies an item to be retrieved as part of the transaction.

func (TransactGetItem) GoString added in v1.15.85 

func (s TransactGetItem) 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 (*TransactGetItem) SetGet added in v1.15.85 

func (s *TransactGetItem) SetGet(v *Get) *TransactGetItem

SetGet sets the Get field's value.

func (TransactGetItem) String added in v1.15.85 

func (s TransactGetItem) 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 (*TransactGetItem) Validate added in v1.15.85 

func (s *TransactGetItem) Validate() error

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

type TransactGetItemsInput added in v1.15.85 

type TransactGetItemsInput struct {

	// A value of TOTAL causes consumed capacity information to be returned, and
	// a value of NONE prevents that information from being returned. No other value
	// is valid.
	ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"`

	// An ordered array of up to 25 TransactGetItem objects, each of which contains
	// a Get structure.
	//
	// TransactItems is a required field
	TransactItems []*TransactGetItem `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TransactGetItemsInput) GoString added in v1.15.85 

func (s TransactGetItemsInput) 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 (*TransactGetItemsInput) SetReturnConsumedCapacity added in v1.15.85 

func (s *TransactGetItemsInput) SetReturnConsumedCapacity(v string) *TransactGetItemsInput

SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.

func (*TransactGetItemsInput) SetTransactItems added in v1.15.85 

func (s *TransactGetItemsInput) SetTransactItems(v []*TransactGetItem) *TransactGetItemsInput

SetTransactItems sets the TransactItems field's value.

func (TransactGetItemsInput) String added in v1.15.85 

func (s TransactGetItemsInput) 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 (*TransactGetItemsInput) Validate added in v1.15.85 

func (s *TransactGetItemsInput) Validate() error

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

type TransactGetItemsOutput added in v1.15.85 

type TransactGetItemsOutput struct {

	// If the ReturnConsumedCapacity value was TOTAL, this is an array of ConsumedCapacity
	// objects, one for each table addressed by TransactGetItem objects in the TransactItems
	// parameter. These ConsumedCapacity objects report the read-capacity units
	// consumed by the TransactGetItems call in that table.
	ConsumedCapacity []*ConsumedCapacity `type:"list"`

	// An ordered array of up to 25 ItemResponse objects, each of which corresponds
	// to the TransactGetItem object in the same position in the TransactItems array.
	// Each ItemResponse object contains a Map of the name-value pairs that are
	// the projected attributes of the requested item.
	//
	// If a requested item could not be retrieved, the corresponding ItemResponse
	// object is Null, or if the requested item has no projected attributes, the
	// corresponding ItemResponse object is an empty Map.
	Responses []*ItemResponse `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (TransactGetItemsOutput) GoString added in v1.15.85 

func (s TransactGetItemsOutput) 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 (*TransactGetItemsOutput) SetConsumedCapacity added in v1.15.85 

func (s *TransactGetItemsOutput) SetConsumedCapacity(v []*ConsumedCapacity) *TransactGetItemsOutput

SetConsumedCapacity sets the ConsumedCapacity field's value.

func (*TransactGetItemsOutput) SetResponses added in v1.15.85 

func (s *TransactGetItemsOutput) SetResponses(v []*ItemResponse) *TransactGetItemsOutput

SetResponses sets the Responses field's value.

func (TransactGetItemsOutput) String added in v1.15.85 

func (s TransactGetItemsOutput) 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 TransactWriteItem added in v1.15.85 

type TransactWriteItem struct {

	// A request to perform a check item operation.
	ConditionCheck *ConditionCheck `type:"structure"`

	// A request to perform a DeleteItem operation.
	Delete *Delete `type:"structure"`

	// A request to perform a PutItem operation.
	Put *Put `type:"structure"`

	// A request to perform an UpdateItem operation.
	Update *Update `type:"structure"`
	// contains filtered or unexported fields
}

A list of requests that can perform update, put, delete, or check operations on multiple items in one or more tables atomically.

func (TransactWriteItem) GoString added in v1.15.85 

func (s TransactWriteItem) 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 (*TransactWriteItem) SetConditionCheck added in v1.15.85 

func (s *TransactWriteItem) SetConditionCheck(v *ConditionCheck) *TransactWriteItem

SetConditionCheck sets the ConditionCheck field's value.

func (*TransactWriteItem) SetDelete added in v1.15.85 

func (s *TransactWriteItem) SetDelete(v *Delete) *TransactWriteItem

SetDelete sets the Delete field's value.

func (*TransactWriteItem) SetPut added in v1.15.85 

func (s *TransactWriteItem) SetPut(v *Put) *TransactWriteItem

SetPut sets the Put field's value.

func (*TransactWriteItem) SetUpdate added in v1.15.85 

func (s *TransactWriteItem) SetUpdate(v *Update) *TransactWriteItem

SetUpdate sets the Update field's value.

func (TransactWriteItem) String added in v1.15.85 

func (s TransactWriteItem) 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 (*TransactWriteItem) Validate added in v1.15.85 

func (s *TransactWriteItem) Validate() error

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

type TransactWriteItemsInput added in v1.15.85 

type TransactWriteItemsInput struct {

	// Providing a ClientRequestToken makes the call to TransactWriteItems idempotent,
	// meaning that multiple identical calls have the same effect as one single
	// call.
	//
	// Although multiple identical calls using the same client request token produce
	// the same result on the server (no side effects), the responses to the calls
	// might not be the same. If the ReturnConsumedCapacity> parameter is set, then
	// the initial TransactWriteItems call returns the amount of write capacity
	// units consumed in making the changes. Subsequent TransactWriteItems calls
	// with the same client token return the number of read capacity units consumed
	// in reading the item.
	//
	// A client request token is valid for 10 minutes after the first request that
	// uses it is completed. After 10 minutes, any request with the same client
	// token is treated as a new request. Do not resubmit the same request with
	// the same client token for more than 10 minutes, or the result might not be
	// idempotent.
	//
	// If you submit a request with the same client token but a change in other
	// parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch
	// exception.
	ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// Determines the level of detail about either provisioned or on-demand throughput
	// consumption that is returned in the response:
	//
	//    * INDEXES - The response includes the aggregate ConsumedCapacity for the
	//    operation, together with ConsumedCapacity for each table and secondary
	//    index that was accessed. Note that some operations, such as GetItem and
	//    BatchGetItem, do not access any indexes at all. In these cases, specifying
	//    INDEXES will only return ConsumedCapacity information for table(s).
	//
	//    * TOTAL - The response includes only the aggregate ConsumedCapacity for
	//    the operation.
	//
	//    * NONE - No ConsumedCapacity details are included in the response.
	ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"`

	// Determines whether item collection metrics are returned. If set to SIZE,
	// the response includes statistics about item collections (if any), that were
	// modified during the operation and are returned in the response. If set to
	// NONE (the default), no statistics are returned.
	ReturnItemCollectionMetrics *string `type:"string" enum:"ReturnItemCollectionMetrics"`

	// An ordered array of up to 25 TransactWriteItem objects, each of which contains
	// a ConditionCheck, Put, Update, or Delete object. These can operate on items
	// in different tables, but the tables must reside in the same Amazon Web Services
	// account and Region, and no two of them can operate on the same item.
	//
	// TransactItems is a required field
	TransactItems []*TransactWriteItem `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TransactWriteItemsInput) GoString added in v1.15.85 

func (s TransactWriteItemsInput) 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 (*TransactWriteItemsInput) SetClientRequestToken added in v1.15.85 

func (s *TransactWriteItemsInput) SetClientRequestToken(v string) *TransactWriteItemsInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*TransactWriteItemsInput) SetReturnConsumedCapacity added in v1.15.85 

func (s *TransactWriteItemsInput) SetReturnConsumedCapacity(v string) *TransactWriteItemsInput

SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.

func (*TransactWriteItemsInput) SetReturnItemCollectionMetrics added in v1.15.85 

func (s *TransactWriteItemsInput) SetReturnItemCollectionMetrics(v string) *TransactWriteItemsInput

SetReturnItemCollectionMetrics sets the ReturnItemCollectionMetrics field's value.

func (*TransactWriteItemsInput) SetTransactItems added in v1.15.85 

func (s *TransactWriteItemsInput) SetTransactItems(v []*TransactWriteItem) *TransactWriteItemsInput

SetTransactItems sets the TransactItems field's value.

func (TransactWriteItemsInput) String added in v1.15.85 

func (s TransactWriteItemsInput) 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 (*TransactWriteItemsInput) Validate added in v1.15.85 

func (s *TransactWriteItemsInput) Validate() error

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

type TransactWriteItemsOutput added in v1.15.85 

type TransactWriteItemsOutput struct {

	// The capacity units consumed by the entire TransactWriteItems operation. The
	// values of the list are ordered according to the ordering of the TransactItems
	// request parameter.
	ConsumedCapacity []*ConsumedCapacity `type:"list"`

	// A list of tables that were processed by TransactWriteItems and, for each
	// table, information about any item collections that were affected by individual
	// UpdateItem, PutItem, or DeleteItem operations.
	ItemCollectionMetrics map[string][]*ItemCollectionMetrics `type:"map"`
	// contains filtered or unexported fields
}

func (TransactWriteItemsOutput) GoString added in v1.15.85 

func (s TransactWriteItemsOutput) 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 (*TransactWriteItemsOutput) SetConsumedCapacity added in v1.15.85 

func (s *TransactWriteItemsOutput) SetConsumedCapacity(v []*ConsumedCapacity) *TransactWriteItemsOutput

SetConsumedCapacity sets the ConsumedCapacity field's value.

func (*TransactWriteItemsOutput) SetItemCollectionMetrics added in v1.15.85 

func (s *TransactWriteItemsOutput) SetItemCollectionMetrics(v map[string][]*ItemCollectionMetrics) *TransactWriteItemsOutput

SetItemCollectionMetrics sets the ItemCollectionMetrics field's value.

func (TransactWriteItemsOutput) String added in v1.15.85 

func (s TransactWriteItemsOutput) 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 TransactionCanceledException added in v1.28.0 

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

	// A list of cancellation reasons.
	CancellationReasons []*CancellationReason `min:"1" type:"list"`

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

The entire transaction request was canceled.

DynamoDB cancels a TransactWriteItems request under the following circumstances:

  • A condition in one of the condition expressions is not met.

  • A table in the TransactWriteItems request is in a different account or region.

  • More than one action in the TransactWriteItems operation targets the same item.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.

  • There is a user error, such as an invalid data format.

DynamoDB cancels a TransactGetItems request under the following circumstances:

  • There is an ongoing TransactGetItems operation that conflicts with a concurrent PutItem, UpdateItem, DeleteItem or TransactWriteItems request. In this case the TransactGetItems operation fails with a TransactionCanceledException.

  • A table in the TransactGetItems request is in a different account or region.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • There is a user error, such as an invalid data format.

If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have None code and Null message.

Cancellation reason codes and possible error messages:

  • No Errors: Code: None Message: null

  • Conditional Check Failed: Code: ConditionalCheckFailed Message: The conditional request failed.

  • Item Collection Size Limit Exceeded: Code: ItemCollectionSizeLimitExceeded Message: Collection size exceeded.

  • Transaction Conflict: Code: TransactionConflict Message: Transaction is ongoing for the item.

  • Provisioned Throughput Exceeded: Code: ProvisionedThroughputExceeded Messages: The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API. This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table. The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API. This message is returned when provisioned throughput is exceeded is on a provisioned GSI.

  • Throttling Error: Code: ThrottlingError Messages: Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html. This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table. Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly. This message is returned when when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.

  • Validation Error: Code: ValidationError Messages: One or more parameter values were invalid. The update expression attempted to update the secondary index key beyond allowed size limits. The update expression attempted to update the secondary index key to unsupported type. An operand in the update expression has an incorrect data type. Item size to update has exceeded the maximum allowed size. Number overflow. Attempting to store a number with magnitude larger than supported range. Type mismatch for attribute to update. Nesting Levels have exceeded supported limits. The document path provided in the update expression is invalid for update. The provided expression refers to an attribute that does not exist in the item.

func (*TransactionCanceledException) Code added in v1.28.0 

func (s *TransactionCanceledException) Code() string

Code returns the exception type name.

func (*TransactionCanceledException) Error added in v1.28.0 

func (s *TransactionCanceledException) Error() string

func (TransactionCanceledException) GoString added in v1.28.0 

func (s TransactionCanceledException) 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 (*TransactionCanceledException) Message added in v1.28.0 

func (s *TransactionCanceledException) Message() string

Message returns the exception's message.

func (*TransactionCanceledException) OrigErr added in v1.28.0 

func (s *TransactionCanceledException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TransactionCanceledException) RequestID added in v1.28.0 

func (s *TransactionCanceledException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TransactionCanceledException) StatusCode added in v1.28.0 

func (s *TransactionCanceledException) StatusCode() int

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

func (TransactionCanceledException) String added in v1.28.0 

func (s TransactionCanceledException) 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 TransactionConflictException added in v1.28.0 

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

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

Operation was rejected because there is an ongoing transaction for the item.

func (*TransactionConflictException) Code added in v1.28.0 

func (s *TransactionConflictException) Code() string

Code returns the exception type name.

func (*TransactionConflictException) Error added in v1.28.0 

func (s *TransactionConflictException) Error() string

func (TransactionConflictException) GoString added in v1.28.0 

func (s TransactionConflictException) 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 (*TransactionConflictException) Message added in v1.28.0 

func (s *TransactionConflictException) Message() string

Message returns the exception's message.

func (*TransactionConflictException) OrigErr added in v1.28.0 

func (s *TransactionConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TransactionConflictException) RequestID added in v1.28.0 

func (s *TransactionConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TransactionConflictException) StatusCode added in v1.28.0 

func (s *TransactionConflictException) StatusCode() int

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

func (TransactionConflictException) String added in v1.28.0 

func (s TransactionConflictException) 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 TransactionInProgressException added in v1.28.0 

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

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

The transaction with the given request token is already in progress.

func (*TransactionInProgressException) Code added in v1.28.0 

func (s *TransactionInProgressException) Code() string

Code returns the exception type name.

func (*TransactionInProgressException) Error added in v1.28.0 

func (s *TransactionInProgressException) Error() string

func (TransactionInProgressException) GoString added in v1.28.0 

func (s TransactionInProgressException) 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 (*TransactionInProgressException) Message added in v1.28.0 

func (s *TransactionInProgressException) Message() string

Message returns the exception's message.

func (*TransactionInProgressException) OrigErr added in v1.28.0 

func (s *TransactionInProgressException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TransactionInProgressException) RequestID added in v1.28.0 

func (s *TransactionInProgressException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TransactionInProgressException) StatusCode added in v1.28.0 

func (s *TransactionInProgressException) StatusCode() int

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

func (TransactionInProgressException) String added in v1.28.0 

func (s TransactionInProgressException) 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 UntagResourceInput added in v1.6.12 

type UntagResourceInput struct {

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

	// A list of tag keys. Existing tags of the resource whose keys are members
	// of this list will be removed from the DynamoDB resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.6.12 

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 added in v1.6.12 

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

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.6.12 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.6.12 

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 added in v1.6.12 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput added in v1.6.12 

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

func (UntagResourceOutput) GoString added in v1.6.12 

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 added in v1.6.12 

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 Update added in v1.15.85 

type Update struct {

	// A condition that must be satisfied in order for a conditional update to succeed.
	ConditionExpression *string `type:"string"`

	// One or more substitution tokens for attribute names in an expression.
	ExpressionAttributeNames map[string]*string `type:"map"`

	// One or more values that can be substituted in an expression.
	ExpressionAttributeValues map[string]*AttributeValue `type:"map"`

	// The primary key of the item to be updated. Each element consists of an attribute
	// name and a value for that attribute.
	//
	// Key is a required field
	Key map[string]*AttributeValue `type:"map" required:"true"`

	// Use ReturnValuesOnConditionCheckFailure to get the item attributes if the
	// Update condition fails. For ReturnValuesOnConditionCheckFailure, the valid
	// values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.
	ReturnValuesOnConditionCheckFailure *string `type:"string" enum:"ReturnValuesOnConditionCheckFailure"`

	// Name of the table for the UpdateItem request.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`

	// An expression that defines one or more attributes to be updated, the action
	// to be performed on them, and new value(s) for them.
	//
	// UpdateExpression is a required field
	UpdateExpression *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents a request to perform an UpdateItem operation.

func (Update) GoString added in v1.15.85 

func (s Update) 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 (*Update) SetConditionExpression added in v1.15.85 

func (s *Update) SetConditionExpression(v string) *Update

SetConditionExpression sets the ConditionExpression field's value.

func (*Update) SetExpressionAttributeNames added in v1.15.85 

func (s *Update) SetExpressionAttributeNames(v map[string]*string) *Update

SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.

func (*Update) SetExpressionAttributeValues added in v1.15.85 

func (s *Update) SetExpressionAttributeValues(v map[string]*AttributeValue) *Update

SetExpressionAttributeValues sets the ExpressionAttributeValues field's value.

func (*Update) SetKey added in v1.15.85 

func (s *Update) SetKey(v map[string]*AttributeValue) *Update

SetKey sets the Key field's value.

func (*Update) SetReturnValuesOnConditionCheckFailure added in v1.15.85 

func (s *Update) SetReturnValuesOnConditionCheckFailure(v string) *Update

SetReturnValuesOnConditionCheckFailure sets the ReturnValuesOnConditionCheckFailure field's value.

func (*Update) SetTableName added in v1.15.85 

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

SetTableName sets the TableName field's value.

func (*Update) SetUpdateExpression added in v1.15.85 

func (s *Update) SetUpdateExpression(v string) *Update

SetUpdateExpression sets the UpdateExpression field's value.

func (Update) String added in v1.15.85 

func (s Update) 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 (*Update) Validate added in v1.15.85 

func (s *Update) Validate() error

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

type UpdateContinuousBackupsInput added in v1.13.21 

type UpdateContinuousBackupsInput struct {

	// Represents the settings used to enable point in time recovery.
	//
	// PointInTimeRecoverySpecification is a required field
	PointInTimeRecoverySpecification *PointInTimeRecoverySpecification `type:"structure" required:"true"`

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

func (UpdateContinuousBackupsInput) GoString added in v1.13.21 

func (s UpdateContinuousBackupsInput) 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 (*UpdateContinuousBackupsInput) SetPointInTimeRecoverySpecification added in v1.13.21 

func (s *UpdateContinuousBackupsInput) SetPointInTimeRecoverySpecification(v *PointInTimeRecoverySpecification) *UpdateContinuousBackupsInput

SetPointInTimeRecoverySpecification sets the PointInTimeRecoverySpecification field's value.

func (*UpdateContinuousBackupsInput) SetTableName added in v1.13.21 

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

SetTableName sets the TableName field's value.

func (UpdateContinuousBackupsInput) String added in v1.13.21 

func (s UpdateContinuousBackupsInput) 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 (*UpdateContinuousBackupsInput) Validate added in v1.13.21 

func (s *UpdateContinuousBackupsInput) Validate() error

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

type UpdateContinuousBackupsOutput added in v1.13.21 

type UpdateContinuousBackupsOutput struct {

	// Represents the continuous backups and point in time recovery settings on
	// the table.
	ContinuousBackupsDescription *ContinuousBackupsDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateContinuousBackupsOutput) GoString added in v1.13.21 

func (s UpdateContinuousBackupsOutput) 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 (*UpdateContinuousBackupsOutput) SetContinuousBackupsDescription added in v1.13.21 

func (s *UpdateContinuousBackupsOutput) SetContinuousBackupsDescription(v *ContinuousBackupsDescription) *UpdateContinuousBackupsOutput

SetContinuousBackupsDescription sets the ContinuousBackupsDescription field's value.

func (UpdateContinuousBackupsOutput) String added in v1.13.21 

func (s UpdateContinuousBackupsOutput) 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 UpdateContributorInsightsInput added in v1.25.43 

type UpdateContributorInsightsInput struct {

	// Represents the contributor insights action.
	//
	// ContributorInsightsAction is a required field
	ContributorInsightsAction *string `type:"string" required:"true" enum:"ContributorInsightsAction"`

	// The global secondary index name, if applicable.
	IndexName *string `min:"3" type:"string"`

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

func (UpdateContributorInsightsInput) GoString added in v1.25.43 

func (s UpdateContributorInsightsInput) 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 (*UpdateContributorInsightsInput) SetContributorInsightsAction added in v1.25.43 

func (s *UpdateContributorInsightsInput) SetContributorInsightsAction(v string) *UpdateContributorInsightsInput

SetContributorInsightsAction sets the ContributorInsightsAction field's value.

func (*UpdateContributorInsightsInput) SetIndexName added in v1.25.43 

func (s *UpdateContributorInsightsInput) SetIndexName(v string) *UpdateContributorInsightsInput

SetIndexName sets the IndexName field's value.

func (*UpdateContributorInsightsInput) SetTableName added in v1.25.43 

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

SetTableName sets the TableName field's value.

func (UpdateContributorInsightsInput) String added in v1.25.43 

func (s UpdateContributorInsightsInput) 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 (*UpdateContributorInsightsInput) Validate added in v1.25.43 

func (s *UpdateContributorInsightsInput) Validate() error

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

type UpdateContributorInsightsOutput added in v1.25.43 

type UpdateContributorInsightsOutput struct {

	// The status of contributor insights
	ContributorInsightsStatus *string `type:"string" enum:"ContributorInsightsStatus"`

	// The name of the global secondary index, if applicable.
	IndexName *string `min:"3" type:"string"`

	// The name of the table.
	TableName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateContributorInsightsOutput) GoString added in v1.25.43 

func (s UpdateContributorInsightsOutput) 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 (*UpdateContributorInsightsOutput) SetContributorInsightsStatus added in v1.25.43 

func (s *UpdateContributorInsightsOutput) SetContributorInsightsStatus(v string) *UpdateContributorInsightsOutput

SetContributorInsightsStatus sets the ContributorInsightsStatus field's value.

func (*UpdateContributorInsightsOutput) SetIndexName added in v1.25.43 

func (s *UpdateContributorInsightsOutput) SetIndexName(v string) *UpdateContributorInsightsOutput

SetIndexName sets the IndexName field's value.

func (*UpdateContributorInsightsOutput) SetTableName added in v1.25.43 

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

SetTableName sets the TableName field's value.

func (UpdateContributorInsightsOutput) String added in v1.25.43 

func (s UpdateContributorInsightsOutput) 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 UpdateGlobalSecondaryIndexAction 

type UpdateGlobalSecondaryIndexAction struct {

	// The name of the global secondary index to be updated.
	//
	// IndexName is a required field
	IndexName *string `min:"3" type:"string" required:"true"`

	// Represents the provisioned throughput settings for the specified global secondary
	// index.
	//
	// For current minimum and maximum provisioned throughput values, see Service,
	// Account, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
	// in the Amazon DynamoDB Developer Guide.
	//
	// ProvisionedThroughput is a required field
	ProvisionedThroughput *ProvisionedThroughput `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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

func (UpdateGlobalSecondaryIndexAction) GoString added in v0.6.5 

func (s UpdateGlobalSecondaryIndexAction) 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 (*UpdateGlobalSecondaryIndexAction) SetIndexName added in v1.5.0 

func (s *UpdateGlobalSecondaryIndexAction) SetIndexName(v string) *UpdateGlobalSecondaryIndexAction

SetIndexName sets the IndexName field's value.

func (*UpdateGlobalSecondaryIndexAction) SetProvisionedThroughput added in v1.5.0 

func (s *UpdateGlobalSecondaryIndexAction) SetProvisionedThroughput(v *ProvisionedThroughput) *UpdateGlobalSecondaryIndexAction

SetProvisionedThroughput sets the ProvisionedThroughput field's value.

func (UpdateGlobalSecondaryIndexAction) String added in v0.6.5 

func (s UpdateGlobalSecondaryIndexAction) 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 (*UpdateGlobalSecondaryIndexAction) Validate added in v1.1.21 

func (s *UpdateGlobalSecondaryIndexAction) Validate() error

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

type UpdateGlobalTableInput added in v1.12.36 

type UpdateGlobalTableInput struct {

	// The global table name.
	//
	// GlobalTableName is a required field
	GlobalTableName *string `min:"3" type:"string" required:"true"`

	// A list of Regions that should be added or removed from the global table.
	//
	// ReplicaUpdates is a required field
	ReplicaUpdates []*ReplicaUpdate `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateGlobalTableInput) GoString added in v1.12.36 

func (s UpdateGlobalTableInput) 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 (*UpdateGlobalTableInput) SetGlobalTableName added in v1.12.36 

func (s *UpdateGlobalTableInput) SetGlobalTableName(v string) *UpdateGlobalTableInput

SetGlobalTableName sets the GlobalTableName field's value.

func (*UpdateGlobalTableInput) SetReplicaUpdates added in v1.12.36 

func (s *UpdateGlobalTableInput) SetReplicaUpdates(v []*ReplicaUpdate) *UpdateGlobalTableInput

SetReplicaUpdates sets the ReplicaUpdates field's value.

func (UpdateGlobalTableInput) String added in v1.12.36 

func (s UpdateGlobalTableInput) 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 (*UpdateGlobalTableInput) Validate added in v1.12.36 

func (s *UpdateGlobalTableInput) Validate() error

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

type UpdateGlobalTableOutput added in v1.12.36 

type UpdateGlobalTableOutput struct {

	// Contains the details of the global table.
	GlobalTableDescription *GlobalTableDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateGlobalTableOutput) GoString added in v1.12.36 

func (s UpdateGlobalTableOutput) 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 (*UpdateGlobalTableOutput) SetGlobalTableDescription added in v1.12.36 

func (s *UpdateGlobalTableOutput) SetGlobalTableDescription(v *GlobalTableDescription) *UpdateGlobalTableOutput

SetGlobalTableDescription sets the GlobalTableDescription field's value.

func (UpdateGlobalTableOutput) String added in v1.12.36 

func (s UpdateGlobalTableOutput) 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 UpdateGlobalTableSettingsInput added in v1.13.39 

type UpdateGlobalTableSettingsInput struct {

	// The billing mode of the global table. If GlobalTableBillingMode is not specified,
	// the global table defaults to PROVISIONED capacity billing mode.
	//
	//    * PROVISIONED - We recommend using PROVISIONED for predictable workloads.
	//    PROVISIONED sets the billing mode to Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual).
	//
	//    * PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable
	//    workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand).
	GlobalTableBillingMode *string `type:"string" enum:"BillingMode"`

	// Represents the settings of a global secondary index for a global table that
	// will be modified.
	GlobalTableGlobalSecondaryIndexSettingsUpdate []*GlobalTableGlobalSecondaryIndexSettingsUpdate `min:"1" type:"list"`

	// The name of the global table
	//
	// GlobalTableName is a required field
	GlobalTableName *string `min:"3" type:"string" required:"true"`

	// Auto scaling settings for managing provisioned write capacity for the global
	// table.
	GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate `type:"structure"`

	// The maximum number of writes consumed per second before DynamoDB returns
	// a ThrottlingException.
	GlobalTableProvisionedWriteCapacityUnits *int64 `min:"1" type:"long"`

	// Represents the settings for a global table in a Region that will be modified.
	ReplicaSettingsUpdate []*ReplicaSettingsUpdate `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateGlobalTableSettingsInput) GoString added in v1.13.39 

func (s UpdateGlobalTableSettingsInput) 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 (*UpdateGlobalTableSettingsInput) SetGlobalTableBillingMode added in v1.15.85 

func (s *UpdateGlobalTableSettingsInput) SetGlobalTableBillingMode(v string) *UpdateGlobalTableSettingsInput

SetGlobalTableBillingMode sets the GlobalTableBillingMode field's value.

func (*UpdateGlobalTableSettingsInput) SetGlobalTableGlobalSecondaryIndexSettingsUpdate added in v1.13.39 

func (s *UpdateGlobalTableSettingsInput) SetGlobalTableGlobalSecondaryIndexSettingsUpdate(v []*GlobalTableGlobalSecondaryIndexSettingsUpdate) *UpdateGlobalTableSettingsInput

SetGlobalTableGlobalSecondaryIndexSettingsUpdate sets the GlobalTableGlobalSecondaryIndexSettingsUpdate field's value.

func (*UpdateGlobalTableSettingsInput) SetGlobalTableName added in v1.13.39 

func (s *UpdateGlobalTableSettingsInput) SetGlobalTableName(v string) *UpdateGlobalTableSettingsInput

SetGlobalTableName sets the GlobalTableName field's value.

func (*UpdateGlobalTableSettingsInput) SetGlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate added in v1.14.32 

func (s *UpdateGlobalTableSettingsInput) SetGlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate(v *AutoScalingSettingsUpdate) *UpdateGlobalTableSettingsInput

SetGlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate sets the GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate field's value.

func (*UpdateGlobalTableSettingsInput) SetGlobalTableProvisionedWriteCapacityUnits added in v1.13.39 

func (s *UpdateGlobalTableSettingsInput) SetGlobalTableProvisionedWriteCapacityUnits(v int64) *UpdateGlobalTableSettingsInput

SetGlobalTableProvisionedWriteCapacityUnits sets the GlobalTableProvisionedWriteCapacityUnits field's value.

func (*UpdateGlobalTableSettingsInput) SetReplicaSettingsUpdate added in v1.13.39 

func (s *UpdateGlobalTableSettingsInput) SetReplicaSettingsUpdate(v []*ReplicaSettingsUpdate) *UpdateGlobalTableSettingsInput

SetReplicaSettingsUpdate sets the ReplicaSettingsUpdate field's value.

func (UpdateGlobalTableSettingsInput) String added in v1.13.39 

func (s UpdateGlobalTableSettingsInput) 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 (*UpdateGlobalTableSettingsInput) Validate added in v1.13.39 

func (s *UpdateGlobalTableSettingsInput) Validate() error

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

type UpdateGlobalTableSettingsOutput added in v1.13.39 

type UpdateGlobalTableSettingsOutput struct {

	// The name of the global table.
	GlobalTableName *string `min:"3" type:"string"`

	// The Region-specific settings for the global table.
	ReplicaSettings []*ReplicaSettingsDescription `type:"list"`
	// contains filtered or unexported fields
}

func (UpdateGlobalTableSettingsOutput) GoString added in v1.13.39 

func (s UpdateGlobalTableSettingsOutput) 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 (*UpdateGlobalTableSettingsOutput) SetGlobalTableName added in v1.13.39 

func (s *UpdateGlobalTableSettingsOutput) SetGlobalTableName(v string) *UpdateGlobalTableSettingsOutput

SetGlobalTableName sets the GlobalTableName field's value.

func (*UpdateGlobalTableSettingsOutput) SetReplicaSettings added in v1.13.39 

func (s *UpdateGlobalTableSettingsOutput) SetReplicaSettings(v []*ReplicaSettingsDescription) *UpdateGlobalTableSettingsOutput

SetReplicaSettings sets the ReplicaSettings field's value.

func (UpdateGlobalTableSettingsOutput) String added in v1.13.39 

func (s UpdateGlobalTableSettingsOutput) 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 UpdateItemInput 

type UpdateItemInput struct {

	// This is a legacy parameter. Use UpdateExpression instead. For more information,
	// see AttributeUpdates (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html)
	// in the Amazon DynamoDB Developer Guide.
	AttributeUpdates map[string]*AttributeValueUpdate `type:"map"`

	// A condition that must be satisfied in order for a conditional update to succeed.
	//
	// An expression can contain any of the following:
	//
	//    * Functions: attribute_exists | attribute_not_exists | attribute_type
	//    | contains | begins_with | size These function names are case-sensitive.
	//
	//    * Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
	//
	//    * Logical operators: AND | OR | NOT
	//
	// For more information about condition expressions, see Specifying Conditions
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
	// in the Amazon DynamoDB Developer Guide.
	ConditionExpression *string `type:"string"`

	// This is a legacy parameter. Use ConditionExpression instead. For more information,
	// see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html)
	// in the Amazon DynamoDB Developer Guide.
	ConditionalOperator *string `type:"string" enum:"ConditionalOperator"`

	// This is a legacy parameter. Use ConditionExpression instead. For more information,
	// see Expected (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html)
	// in the Amazon DynamoDB Developer Guide.
	Expected map[string]*ExpectedAttributeValue `type:"map"`

	// One or more substitution tokens for attribute names in an expression. The
	// following are some use cases for using ExpressionAttributeNames:
	//
	//    * To access an attribute whose name conflicts with a DynamoDB reserved
	//    word.
	//
	//    * To create a placeholder for repeating occurrences of an attribute name
	//    in an expression.
	//
	//    * To prevent special characters in an attribute name from being misinterpreted
	//    in an expression.
	//
	// Use the # character in an expression to dereference an attribute name. For
	// example, consider the following attribute name:
	//
	//    * Percentile
	//
	// The name of this attribute conflicts with a reserved word, so it cannot be
	// used directly in an expression. (For the complete list of reserved words,
	// see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html)
	// in the Amazon DynamoDB Developer Guide.) To work around this, you could specify
	// the following for ExpressionAttributeNames:
	//
	//    * {"#P":"Percentile"}
	//
	// You could then use this substitution in an expression, as in this example:
	//
	//    * #P = :val
	//
	// Tokens that begin with the : character are expression attribute values, which
	// are placeholders for the actual value at runtime.
	//
	// For more information about expression attribute names, see Specifying Item
	// Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html)
	// in the Amazon DynamoDB Developer Guide.
	ExpressionAttributeNames map[string]*string `type:"map"`

	// One or more values that can be substituted in an expression.
	//
	// Use the : (colon) character in an expression to dereference an attribute
	// value. For example, suppose that you wanted to check whether the value of
	// the ProductStatus attribute was one of the following:
	//
	// Available | Backordered | Discontinued
	//
	// You would first need to specify ExpressionAttributeValues as follows:
	//
	// { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"}
	// }
	//
	// You could then use these values in an expression, such as this:
	//
	// ProductStatus IN (:avail, :back, :disc)
	//
	// For more information on expression attribute values, see Condition Expressions
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html)
	// in the Amazon DynamoDB Developer Guide.
	ExpressionAttributeValues map[string]*AttributeValue `type:"map"`

	// The primary key of the item to be updated. Each element consists of an attribute
	// name and a value for that attribute.
	//
	// For the primary key, you must provide all of the attributes. For example,
	// with a simple primary key, you only need to provide a value for the partition
	// key. For a composite primary key, you must provide values for both the partition
	// key and the sort key.
	//
	// Key is a required field
	Key map[string]*AttributeValue `type:"map" required:"true"`

	// Determines the level of detail about either provisioned or on-demand throughput
	// consumption that is returned in the response:
	//
	//    * INDEXES - The response includes the aggregate ConsumedCapacity for the
	//    operation, together with ConsumedCapacity for each table and secondary
	//    index that was accessed. Note that some operations, such as GetItem and
	//    BatchGetItem, do not access any indexes at all. In these cases, specifying
	//    INDEXES will only return ConsumedCapacity information for table(s).
	//
	//    * TOTAL - The response includes only the aggregate ConsumedCapacity for
	//    the operation.
	//
	//    * NONE - No ConsumedCapacity details are included in the response.
	ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"`

	// Determines whether item collection metrics are returned. If set to SIZE,
	// the response includes statistics about item collections, if any, that were
	// modified during the operation are returned in the response. If set to NONE
	// (the default), no statistics are returned.
	ReturnItemCollectionMetrics *string `type:"string" enum:"ReturnItemCollectionMetrics"`

	// Use ReturnValues if you want to get the item attributes as they appear before
	// or after they are updated. For UpdateItem, the valid values are:
	//
	//    * NONE - If ReturnValues is not specified, or if its value is NONE, then
	//    nothing is returned. (This setting is the default for ReturnValues.)
	//
	//    * ALL_OLD - Returns all of the attributes of the item, as they appeared
	//    before the UpdateItem operation.
	//
	//    * UPDATED_OLD - Returns only the updated attributes, as they appeared
	//    before the UpdateItem operation.
	//
	//    * ALL_NEW - Returns all of the attributes of the item, as they appear
	//    after the UpdateItem operation.
	//
	//    * UPDATED_NEW - Returns only the updated attributes, as they appear after
	//    the UpdateItem operation.
	//
	// There is no additional cost associated with requesting a return value aside
	// from the small network and processing overhead of receiving a larger response.
	// No read capacity units are consumed.
	//
	// The values returned are strongly consistent.
	ReturnValues *string `type:"string" enum:"ReturnValue"`

	// The name of the table containing the item to update.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`

	// An expression that defines one or more attributes to be updated, the action
	// to be performed on them, and new values for them.
	//
	// The following action values are available for UpdateExpression.
	//
	//    * SET - Adds one or more attributes and values to an item. If any of these
	//    attributes already exist, they are replaced by the new values. You can
	//    also use SET to add or subtract from an attribute that is of type Number.
	//    For example: SET myNum = myNum + :val SET supports the following functions:
	//    if_not_exists (path, operand) - if the item does not contain an attribute
	//    at the specified path, then if_not_exists evaluates to operand; otherwise,
	//    it evaluates to path. You can use this function to avoid overwriting an
	//    attribute that may already be present in the item. list_append (operand,
	//    operand) - evaluates to a list with a new element added to it. You can
	//    append the new element to the start or the end of the list by reversing
	//    the order of the operands. These function names are case-sensitive.
	//
	//    * REMOVE - Removes one or more attributes from an item.
	//
	//    * ADD - Adds the specified value to the item, if the attribute does not
	//    already exist. If the attribute does exist, then the behavior of ADD depends
	//    on the data type of the attribute: If the existing attribute is a number,
	//    and if Value is also a number, then Value is mathematically added to the
	//    existing attribute. If Value is a negative number, then it is subtracted
	//    from the existing attribute. If you use ADD to increment or decrement
	//    a number value for an item that doesn't exist before the update, DynamoDB
	//    uses 0 as the initial value. Similarly, if you use ADD for an existing
	//    item to increment or decrement an attribute value that doesn't exist before
	//    the update, DynamoDB uses 0 as the initial value. For example, suppose
	//    that the item you want to update doesn't have an attribute named itemcount,
	//    but you decide to ADD the number 3 to this attribute anyway. DynamoDB
	//    will create the itemcount attribute, set its initial value to 0, and finally
	//    add 3 to it. The result will be a new itemcount attribute in the item,
	//    with a value of 3. If the existing data type is a set and if Value is
	//    also a set, then Value is added to the existing set. For example, if the
	//    attribute value is the set [1,2], and the ADD action specified [3], then
	//    the final attribute value is [1,2,3]. An error occurs if an ADD action
	//    is specified for a set attribute and the attribute type specified does
	//    not match the existing set type. Both sets must have the same primitive
	//    data type. For example, if the existing data type is a set of strings,
	//    the Value must also be a set of strings. The ADD action only supports
	//    Number and set data types. In addition, ADD can only be used on top-level
	//    attributes, not nested attributes.
	//
	//    * DELETE - Deletes an element from a set. If a set of values is specified,
	//    then those values are subtracted from the old set. For example, if the
	//    attribute value was the set [a,b,c] and the DELETE action specifies [a,c],
	//    then the final attribute value is [b]. Specifying an empty set is an error.
	//    The DELETE action only supports set data types. In addition, DELETE can
	//    only be used on top-level attributes, not nested attributes.
	//
	// You can have many actions in a single expression, such as the following:
	// SET a=:value1, b=:value2 DELETE :value3, :value4, :value5
	//
	// For more information on update expressions, see Modifying Items and Attributes
	// (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.Modifying.html)
	// in the Amazon DynamoDB Developer Guide.
	UpdateExpression *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input of an UpdateItem operation.

func (UpdateItemInput) GoString added in v0.6.5 

func (s UpdateItemInput) 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 (*UpdateItemInput) SetAttributeUpdates added in v1.5.0 

func (s *UpdateItemInput) SetAttributeUpdates(v map[string]*AttributeValueUpdate) *UpdateItemInput

SetAttributeUpdates sets the AttributeUpdates field's value.

func (*UpdateItemInput) SetConditionExpression added in v1.5.0 

func (s *UpdateItemInput) SetConditionExpression(v string) *UpdateItemInput

SetConditionExpression sets the ConditionExpression field's value.

func (*UpdateItemInput) SetConditionalOperator added in v1.5.0 

func (s *UpdateItemInput) SetConditionalOperator(v string) *UpdateItemInput

SetConditionalOperator sets the ConditionalOperator field's value.

func (*UpdateItemInput) SetExpected added in v1.5.0 

func (s *UpdateItemInput) SetExpected(v map[string]*ExpectedAttributeValue) *UpdateItemInput

SetExpected sets the Expected field's value.

func (*UpdateItemInput) SetExpressionAttributeNames added in v1.5.0 

func (s *UpdateItemInput) SetExpressionAttributeNames(v map[string]*string) *UpdateItemInput

SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.

func (*UpdateItemInput) SetExpressionAttributeValues added in v1.5.0 

func (s *UpdateItemInput) SetExpressionAttributeValues(v map[string]*AttributeValue) *UpdateItemInput

SetExpressionAttributeValues sets the ExpressionAttributeValues field's value.

func (*UpdateItemInput) SetKey added in v1.5.0 

func (s *UpdateItemInput) SetKey(v map[string]*AttributeValue) *UpdateItemInput

SetKey sets the Key field's value.

func (*UpdateItemInput) SetReturnConsumedCapacity added in v1.5.0 

func (s *UpdateItemInput) SetReturnConsumedCapacity(v string) *UpdateItemInput

SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.

func (*UpdateItemInput) SetReturnItemCollectionMetrics added in v1.5.0 

func (s *UpdateItemInput) SetReturnItemCollectionMetrics(v string) *UpdateItemInput

SetReturnItemCollectionMetrics sets the ReturnItemCollectionMetrics field's value.

func (*UpdateItemInput) SetReturnValues added in v1.5.0 

func (s *UpdateItemInput) SetReturnValues(v string) *UpdateItemInput

SetReturnValues sets the ReturnValues field's value.

func (*UpdateItemInput) SetTableName added in v1.5.0 

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

SetTableName sets the TableName field's value.

func (*UpdateItemInput) SetUpdateExpression added in v1.5.0 

func (s *UpdateItemInput) SetUpdateExpression(v string) *UpdateItemInput

SetUpdateExpression sets the UpdateExpression field's value.

func (UpdateItemInput) String added in v0.6.5 

func (s UpdateItemInput) 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 (*UpdateItemInput) Validate added in v1.1.21 

func (s *UpdateItemInput) Validate() error

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

type UpdateItemOutput 

type UpdateItemOutput struct {

	// A map of attribute values as they appear before or after the UpdateItem operation,
	// as determined by the ReturnValues parameter.
	//
	// The Attributes map is only present if ReturnValues was specified as something
	// other than NONE in the request. Each element represents one attribute.
	Attributes map[string]*AttributeValue `type:"map"`

	// The capacity units consumed by the UpdateItem operation. The data returned
	// includes the total provisioned throughput consumed, along with statistics
	// for the table and any indexes involved in the operation. ConsumedCapacity
	// is only returned if the ReturnConsumedCapacity parameter was specified. For
	// more information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html)
	// in the Amazon DynamoDB Developer Guide.
	ConsumedCapacity *ConsumedCapacity `type:"structure"`

	// Information about item collections, if any, that were affected by the UpdateItem
	// operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics
	// parameter was specified. If the table does not have any local secondary indexes,
	// this information is not returned in the response.
	//
	// Each ItemCollectionMetrics element consists of:
	//
	//    * ItemCollectionKey - The partition key value of the item collection.
	//    This is the same as the partition key value of the item itself.
	//
	//    * SizeEstimateRangeGB - An estimate of item collection size, in gigabytes.
	//    This value is a two-element array containing a lower bound and an upper
	//    bound for the estimate. The estimate includes the size of all the items
	//    in the table, plus the size of all attributes projected into all of the
	//    local secondary indexes on that table. Use this estimate to measure whether
	//    a local secondary index is approaching its size limit. The estimate is
	//    subject to change over time; therefore, do not rely on the precision or
	//    accuracy of the estimate.
	ItemCollectionMetrics *ItemCollectionMetrics `type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of an UpdateItem operation.

func (UpdateItemOutput) GoString added in v0.6.5 

func (s UpdateItemOutput) 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 (*UpdateItemOutput) SetAttributes added in v1.5.0 

func (s *UpdateItemOutput) SetAttributes(v map[string]*AttributeValue) *UpdateItemOutput

SetAttributes sets the Attributes field's value.

func (*UpdateItemOutput) SetConsumedCapacity added in v1.5.0 

func (s *UpdateItemOutput) SetConsumedCapacity(v *ConsumedCapacity) *UpdateItemOutput

SetConsumedCapacity sets the ConsumedCapacity field's value.

func (*UpdateItemOutput) SetItemCollectionMetrics added in v1.5.0 

func (s *UpdateItemOutput) SetItemCollectionMetrics(v *ItemCollectionMetrics) *UpdateItemOutput

SetItemCollectionMetrics sets the ItemCollectionMetrics field's value.

func (UpdateItemOutput) String added in v0.6.5 

func (s UpdateItemOutput) 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 UpdateReplicationGroupMemberAction added in v1.25.40 

type UpdateReplicationGroupMemberAction struct {

	// Replica-specific global secondary index settings.
	GlobalSecondaryIndexes []*ReplicaGlobalSecondaryIndex `min:"1" type:"list"`

	// The KMS key of the replica that should be used for KMS encryption. To specify
	// a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN.
	// Note that you should only provide this parameter if the key is different
	// from the default DynamoDB KMS key alias/aws/dynamodb.
	KMSMasterKeyId *string `type:"string"`

	// Replica-specific provisioned throughput. If not specified, uses the source
	// table's provisioned throughput settings.
	ProvisionedThroughputOverride *ProvisionedThroughputOverride `type:"structure"`

	// The Region where the replica exists.
	//
	// RegionName is a required field
	RegionName *string `type:"string" required:"true"`

	// Replica-specific table class. If not specified, uses the source table's table
	// class.
	TableClassOverride *string `type:"string" enum:"TableClass"`
	// contains filtered or unexported fields
}

Represents a replica to be modified.

func (UpdateReplicationGroupMemberAction) GoString added in v1.25.40 

func (s UpdateReplicationGroupMemberAction) 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 (*UpdateReplicationGroupMemberAction) SetGlobalSecondaryIndexes added in v1.25.40 

func (s *UpdateReplicationGroupMemberAction) SetGlobalSecondaryIndexes(v []*ReplicaGlobalSecondaryIndex) *UpdateReplicationGroupMemberAction

SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.

func (*UpdateReplicationGroupMemberAction) SetKMSMasterKeyId added in v1.25.40 

func (s *UpdateReplicationGroupMemberAction) SetKMSMasterKeyId(v string) *UpdateReplicationGroupMemberAction

SetKMSMasterKeyId sets the KMSMasterKeyId field's value.

func (*UpdateReplicationGroupMemberAction) SetProvisionedThroughputOverride added in v1.25.40 

func (s *UpdateReplicationGroupMemberAction) SetProvisionedThroughputOverride(v *ProvisionedThroughputOverride) *UpdateReplicationGroupMemberAction

SetProvisionedThroughputOverride sets the ProvisionedThroughputOverride field's value.

func (*UpdateReplicationGroupMemberAction) SetRegionName added in v1.25.40 

func (s *UpdateReplicationGroupMemberAction) SetRegionName(v string) *UpdateReplicationGroupMemberAction

SetRegionName sets the RegionName field's value.

func (*UpdateReplicationGroupMemberAction) SetTableClassOverride added in v1.42.17 

func (s *UpdateReplicationGroupMemberAction) SetTableClassOverride(v string) *UpdateReplicationGroupMemberAction

SetTableClassOverride sets the TableClassOverride field's value.

func (UpdateReplicationGroupMemberAction) String added in v1.25.40 

func (s UpdateReplicationGroupMemberAction) 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 (*UpdateReplicationGroupMemberAction) Validate added in v1.25.40 

func (s *UpdateReplicationGroupMemberAction) Validate() error

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

type UpdateTableInput 

type UpdateTableInput struct {

	// An array of attributes that describe the key schema for the table and indexes.
	// If you are adding a new global secondary index to the table, AttributeDefinitions
	// must include the key element(s) of the new index.
	AttributeDefinitions []*AttributeDefinition `type:"list"`

	// Controls how you are charged for read and write throughput and how you manage
	// capacity. When switching from pay-per-request to provisioned capacity, initial
	// provisioned capacity values must be set. The initial provisioned capacity
	// values are estimated based on the consumed read and write capacity of your
	// table and global secondary indexes over the past 30 minutes.
	//
	//    * PROVISIONED - We recommend using PROVISIONED for predictable workloads.
	//    PROVISIONED sets the billing mode to Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual).
	//
	//    * PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable
	//    workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand).
	BillingMode *string `type:"string" enum:"BillingMode"`

	// An array of one or more global secondary indexes for the table. For each
	// index in the array, you can request one action:
	//
	//    * Create - add a new global secondary index to the table.
	//
	//    * Update - modify the provisioned throughput settings of an existing global
	//    secondary index.
	//
	//    * Delete - remove a global secondary index from the table.
	//
	// You can create or delete only one global secondary index per UpdateTable
	// operation.
	//
	// For more information, see Managing Global Secondary Indexes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.OnlineOps.html)
	// in the Amazon DynamoDB Developer Guide.
	GlobalSecondaryIndexUpdates []*GlobalSecondaryIndexUpdate `type:"list"`

	// The new provisioned throughput settings for the specified table or index.
	ProvisionedThroughput *ProvisionedThroughput `type:"structure"`

	// A list of replica update actions (create, delete, or update) for the table.
	//
	// This property only applies to Version 2019.11.21 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html)
	// of global tables.
	ReplicaUpdates []*ReplicationGroupUpdate `min:"1" type:"list"`

	// The new server-side encryption settings for the specified table.
	SSESpecification *SSESpecification `type:"structure"`

	// Represents the DynamoDB Streams configuration for the table.
	//
	// You receive a ResourceInUseException if you try to enable a stream on a table
	// that already has a stream, or if you try to disable a stream on a table that
	// doesn't have a stream.
	StreamSpecification *StreamSpecification `type:"structure"`

	// The table class of the table to be updated. Valid values are STANDARD and
	// STANDARD_INFREQUENT_ACCESS.
	TableClass *string `type:"string" enum:"TableClass"`

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

Represents the input of an UpdateTable operation.

func (UpdateTableInput) GoString added in v0.6.5 

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) SetAttributeDefinitions added in v1.5.0 

func (s *UpdateTableInput) SetAttributeDefinitions(v []*AttributeDefinition) *UpdateTableInput

SetAttributeDefinitions sets the AttributeDefinitions field's value.

func (*UpdateTableInput) SetBillingMode added in v1.15.85 

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

SetBillingMode sets the BillingMode field's value.

func (*UpdateTableInput) SetGlobalSecondaryIndexUpdates added in v1.5.0 

func (s *UpdateTableInput) SetGlobalSecondaryIndexUpdates(v []*GlobalSecondaryIndexUpdate) *UpdateTableInput

SetGlobalSecondaryIndexUpdates sets the GlobalSecondaryIndexUpdates field's value.

func (*UpdateTableInput) SetProvisionedThroughput added in v1.5.0 

func (s *UpdateTableInput) SetProvisionedThroughput(v *ProvisionedThroughput) *UpdateTableInput

SetProvisionedThroughput sets the ProvisionedThroughput field's value.

func (*UpdateTableInput) SetReplicaUpdates added in v1.25.40 

func (s *UpdateTableInput) SetReplicaUpdates(v []*ReplicationGroupUpdate) *UpdateTableInput

SetReplicaUpdates sets the ReplicaUpdates field's value.

func (*UpdateTableInput) SetSSESpecification added in v1.15.16 

func (s *UpdateTableInput) SetSSESpecification(v *SSESpecification) *UpdateTableInput

SetSSESpecification sets the SSESpecification field's value.

func (*UpdateTableInput) SetStreamSpecification added in v1.5.0 

func (s *UpdateTableInput) SetStreamSpecification(v *StreamSpecification) *UpdateTableInput

SetStreamSpecification sets the StreamSpecification field's value.

func (*UpdateTableInput) SetTableClass added in v1.42.17 

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

SetTableClass sets the TableClass field's value.

func (*UpdateTableInput) SetTableName added in v1.5.0 

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

SetTableName sets the TableName field's value.

func (UpdateTableInput) String added in v0.6.5 

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 added in v1.1.21 

func (s *UpdateTableInput) Validate() error

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

type UpdateTableOutput 

type UpdateTableOutput struct {

	// Represents the properties of the table.
	TableDescription *TableDescription `type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of an UpdateTable operation.

func (UpdateTableOutput) GoString added in v0.6.5 

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) SetTableDescription added in v1.5.0 

func (s *UpdateTableOutput) SetTableDescription(v *TableDescription) *UpdateTableOutput

SetTableDescription sets the TableDescription field's value.

func (UpdateTableOutput) String added in v0.6.5 

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 UpdateTableReplicaAutoScalingInput added in v1.25.40 

type UpdateTableReplicaAutoScalingInput struct {

	// Represents the auto scaling settings of the global secondary indexes of the
	// replica to be updated.
	GlobalSecondaryIndexUpdates []*GlobalSecondaryIndexAutoScalingUpdate `min:"1" type:"list"`

	// Represents the auto scaling settings to be modified for a global table or
	// global secondary index.
	ProvisionedWriteCapacityAutoScalingUpdate *AutoScalingSettingsUpdate `type:"structure"`

	// Represents the auto scaling settings of replicas of the table that will be
	// modified.
	ReplicaUpdates []*ReplicaAutoScalingUpdate `min:"1" type:"list"`

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

func (UpdateTableReplicaAutoScalingInput) GoString added in v1.25.40 

func (s UpdateTableReplicaAutoScalingInput) 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 (*UpdateTableReplicaAutoScalingInput) SetGlobalSecondaryIndexUpdates added in v1.25.40 

func (s *UpdateTableReplicaAutoScalingInput) SetGlobalSecondaryIndexUpdates(v []*GlobalSecondaryIndexAutoScalingUpdate) *UpdateTableReplicaAutoScalingInput

SetGlobalSecondaryIndexUpdates sets the GlobalSecondaryIndexUpdates field's value.

func (*UpdateTableReplicaAutoScalingInput) SetProvisionedWriteCapacityAutoScalingUpdate added in v1.25.40 

func (s *UpdateTableReplicaAutoScalingInput) SetProvisionedWriteCapacityAutoScalingUpdate(v *AutoScalingSettingsUpdate) *UpdateTableReplicaAutoScalingInput

SetProvisionedWriteCapacityAutoScalingUpdate sets the ProvisionedWriteCapacityAutoScalingUpdate field's value.

func (*UpdateTableReplicaAutoScalingInput) SetReplicaUpdates added in v1.25.40 

func (s *UpdateTableReplicaAutoScalingInput) SetReplicaUpdates(v []*ReplicaAutoScalingUpdate) *UpdateTableReplicaAutoScalingInput

SetReplicaUpdates sets the ReplicaUpdates field's value.

func (*UpdateTableReplicaAutoScalingInput) SetTableName added in v1.25.40 

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

SetTableName sets the TableName field's value.

func (UpdateTableReplicaAutoScalingInput) String added in v1.25.40 

func (s UpdateTableReplicaAutoScalingInput) 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 (*UpdateTableReplicaAutoScalingInput) Validate added in v1.25.40 

func (s *UpdateTableReplicaAutoScalingInput) Validate() error

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

type UpdateTableReplicaAutoScalingOutput added in v1.25.40 

type UpdateTableReplicaAutoScalingOutput struct {

	// Returns information about the auto scaling settings of a table with replicas.
	TableAutoScalingDescription *TableAutoScalingDescription `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateTableReplicaAutoScalingOutput) GoString added in v1.25.40 

func (s UpdateTableReplicaAutoScalingOutput) 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 (*UpdateTableReplicaAutoScalingOutput) SetTableAutoScalingDescription added in v1.25.40 

func (s *UpdateTableReplicaAutoScalingOutput) SetTableAutoScalingDescription(v *TableAutoScalingDescription) *UpdateTableReplicaAutoScalingOutput

SetTableAutoScalingDescription sets the TableAutoScalingDescription field's value.

func (UpdateTableReplicaAutoScalingOutput) String added in v1.25.40 

func (s UpdateTableReplicaAutoScalingOutput) 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 UpdateTimeToLiveInput added in v1.7.2 

type UpdateTimeToLiveInput struct {

	// The name of the table to be configured.
	//
	// TableName is a required field
	TableName *string `min:"3" type:"string" required:"true"`

	// Represents the settings used to enable or disable Time to Live for the specified
	// table.
	//
	// TimeToLiveSpecification is a required field
	TimeToLiveSpecification *TimeToLiveSpecification `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the input of an UpdateTimeToLive operation.

func (UpdateTimeToLiveInput) GoString added in v1.7.2 

func (s UpdateTimeToLiveInput) 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 (*UpdateTimeToLiveInput) SetTableName added in v1.7.2 

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

SetTableName sets the TableName field's value.

func (*UpdateTimeToLiveInput) SetTimeToLiveSpecification added in v1.7.2 

func (s *UpdateTimeToLiveInput) SetTimeToLiveSpecification(v *TimeToLiveSpecification) *UpdateTimeToLiveInput

SetTimeToLiveSpecification sets the TimeToLiveSpecification field's value.

func (UpdateTimeToLiveInput) String added in v1.7.2 

func (s UpdateTimeToLiveInput) 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 (*UpdateTimeToLiveInput) Validate added in v1.7.2 

func (s *UpdateTimeToLiveInput) Validate() error

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

type UpdateTimeToLiveOutput added in v1.7.2 

type UpdateTimeToLiveOutput struct {

	// Represents the output of an UpdateTimeToLive operation.
	TimeToLiveSpecification *TimeToLiveSpecification `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateTimeToLiveOutput) GoString added in v1.7.2 

func (s UpdateTimeToLiveOutput) 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 (*UpdateTimeToLiveOutput) SetTimeToLiveSpecification added in v1.7.2 

func (s *UpdateTimeToLiveOutput) SetTimeToLiveSpecification(v *TimeToLiveSpecification) *UpdateTimeToLiveOutput

SetTimeToLiveSpecification sets the TimeToLiveSpecification field's value.

func (UpdateTimeToLiveOutput) String added in v1.7.2 

func (s UpdateTimeToLiveOutput) 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 WriteRequest 

type WriteRequest struct {

	// A request to perform a DeleteItem operation.
	DeleteRequest *DeleteRequest `type:"structure"`

	// A request to perform a PutItem operation.
	PutRequest *PutRequest `type:"structure"`
	// contains filtered or unexported fields
}

Represents an operation to perform - either DeleteItem or PutItem. You can only request one of these operations, not both, in a single WriteRequest. If you do need to perform both of these operations, you need to provide two separate WriteRequest objects.

func (WriteRequest) GoString added in v0.6.5 

func (s WriteRequest) 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 (*WriteRequest) SetDeleteRequest added in v1.5.0 

func (s *WriteRequest) SetDeleteRequest(v *DeleteRequest) *WriteRequest

SetDeleteRequest sets the DeleteRequest field's value.

func (*WriteRequest) SetPutRequest added in v1.5.0 

func (s *WriteRequest) SetPutRequest(v *PutRequest) *WriteRequest

SetPutRequest sets the PutRequest field's value.

func (WriteRequest) String added in v0.6.5 

func (s WriteRequest) 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 dynamodbattribute provides marshaling and unmarshaling utilities to convert between Go types and dynamodb.AttributeValues.
 Package dynamodbattribute provides marshaling and unmarshaling utilities to convert between Go types and dynamodb.AttributeValues.
Package dynamodbiface provides an interface to enable mocking the Amazon DynamoDB service client for testing your code.
 Package dynamodbiface provides an interface to enable mocking the Amazon DynamoDB service client for testing your code.
Package expression provides types and functions to create Amazon DynamoDB Expression strings, ExpressionAttributeNames maps, and ExpressionAttributeValues maps.
 Package expression provides types and functions to create Amazon DynamoDB Expression strings, ExpressionAttributeNames maps, and ExpressionAttributeValues maps.

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.