func AttributeAction_Values() []string
AttributeAction_Values returns all elements of the AttributeAction enum
func BackupStatus_Values() []string
BackupStatus_Values returns all elements of the BackupStatus enum
func BackupTypeFilter_Values() []string
BackupTypeFilter_Values returns all elements of the BackupTypeFilter enum
func BackupType_Values() []string
BackupType_Values returns all elements of the BackupType enum
func BatchStatementErrorCodeEnum_Values() []string
BatchStatementErrorCodeEnum_Values returns all elements of the BatchStatementErrorCodeEnum enum
func BillingMode_Values() []string
BillingMode_Values returns all elements of the BillingMode enum
func ComparisonOperator_Values() []string
ComparisonOperator_Values returns all elements of the ComparisonOperator enum
func ConditionalOperator_Values() []string
ConditionalOperator_Values returns all elements of the ConditionalOperator enum
func ContinuousBackupsStatus_Values() []string
ContinuousBackupsStatus_Values returns all elements of the ContinuousBackupsStatus enum
func ContributorInsightsAction_Values() []string
ContributorInsightsAction_Values returns all elements of the ContributorInsightsAction enum
func ContributorInsightsStatus_Values() []string
ContributorInsightsStatus_Values returns all elements of the ContributorInsightsStatus enum
func DestinationStatus_Values() []string
DestinationStatus_Values returns all elements of the DestinationStatus enum
func ExportFormat_Values() []string
ExportFormat_Values returns all elements of the ExportFormat enum
func ExportStatus_Values() []string
ExportStatus_Values returns all elements of the ExportStatus enum
func ExportType_Values() []string
ExportType_Values returns all elements of the ExportType enum
func ExportViewType_Values() []string
ExportViewType_Values returns all elements of the ExportViewType enum
func GlobalTableStatus_Values() []string
GlobalTableStatus_Values returns all elements of the GlobalTableStatus enum
func ImportStatus_Values() []string
ImportStatus_Values returns all elements of the ImportStatus enum
func IndexStatus_Values() []string
IndexStatus_Values returns all elements of the IndexStatus enum
func InputCompressionType_Values() []string
InputCompressionType_Values returns all elements of the InputCompressionType enum
func InputFormat_Values() []string
InputFormat_Values returns all elements of the InputFormat enum
func KeyType_Values() []string
KeyType_Values returns all elements of the KeyType enum
func PointInTimeRecoveryStatus_Values() []string
PointInTimeRecoveryStatus_Values returns all elements of the PointInTimeRecoveryStatus enum
func ProjectionType_Values() []string
ProjectionType_Values returns all elements of the ProjectionType enum
func ReplicaStatus_Values() []string
ReplicaStatus_Values returns all elements of the ReplicaStatus enum
func ReturnConsumedCapacity_Values() []string
ReturnConsumedCapacity_Values returns all elements of the ReturnConsumedCapacity enum
func ReturnItemCollectionMetrics_Values() []string
ReturnItemCollectionMetrics_Values returns all elements of the ReturnItemCollectionMetrics enum
func ReturnValue_Values() []string
ReturnValue_Values returns all elements of the ReturnValue enum
func ReturnValuesOnConditionCheckFailure_Values() []string
ReturnValuesOnConditionCheckFailure_Values returns all elements of the ReturnValuesOnConditionCheckFailure enum
func S3SseAlgorithm_Values() []string
S3SseAlgorithm_Values returns all elements of the S3SseAlgorithm enum
func SSEStatus_Values() []string
SSEStatus_Values returns all elements of the SSEStatus enum
func SSEType_Values() []string
SSEType_Values returns all elements of the SSEType enum
func ScalarAttributeType_Values() []string
ScalarAttributeType_Values returns all elements of the ScalarAttributeType enum
func Select_Values() []string
Select_Values returns all elements of the Select enum
func StreamViewType_Values() []string
StreamViewType_Values returns all elements of the StreamViewType enum
func TableClass_Values() []string
TableClass_Values returns all elements of the TableClass enum
func TableStatus_Values() []string
TableStatus_Values returns all elements of the TableStatus enum
func TimeToLiveStatus_Values() []string
TimeToLiveStatus_Values returns all elements of the TimeToLiveStatus enum
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 (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 (s *ArchivalSummary) SetArchivalBackupArn(v string) *ArchivalSummary
SetArchivalBackupArn sets the ArchivalBackupArn field's value.
func (s *ArchivalSummary) SetArchivalDateTime(v time.Time) *ArchivalSummary
SetArchivalDateTime sets the ArchivalDateTime field's value.
func (s *ArchivalSummary) SetArchivalReason(v string) *ArchivalSummary
SetArchivalReason sets the ArchivalReason field's value.
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 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 (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 (s *AttributeDefinition) SetAttributeName(v string) *AttributeDefinition
SetAttributeName sets the AttributeName field's value.
func (s *AttributeDefinition) SetAttributeType(v string) *AttributeDefinition
SetAttributeType sets the AttributeType field's value.
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 (s *AttributeDefinition) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *AttributeValue) SetB(v []byte) *AttributeValue
SetB sets the B field's value.
func (s *AttributeValue) SetBOOL(v bool) *AttributeValue
SetBOOL sets the BOOL field's value.
func (s *AttributeValue) SetBS(v [][]byte) *AttributeValue
SetBS sets the BS field's value.
func (s *AttributeValue) SetL(v []*AttributeValue) *AttributeValue
SetL sets the L field's value.
func (s *AttributeValue) SetM(v map[string]*AttributeValue) *AttributeValue
SetM sets the M field's value.
func (s *AttributeValue) SetN(v string) *AttributeValue
SetN sets the N field's value.
func (s *AttributeValue) SetNS(v []*string) *AttributeValue
SetNS sets the NS field's value.
func (s *AttributeValue) SetNULL(v bool) *AttributeValue
SetNULL sets the NULL field's value.
func (s *AttributeValue) SetS(v string) *AttributeValue
SetS sets the S field's value.
func (s *AttributeValue) SetSS(v []*string) *AttributeValue
SetSS sets the SS field's value.
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 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 (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 (s *AttributeValueUpdate) SetAction(v string) *AttributeValueUpdate
SetAction sets the Action field's value.
func (s *AttributeValueUpdate) SetValue(v *AttributeValue) *AttributeValueUpdate
SetValue sets the Value field's value.
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 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 (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 (s *AutoScalingPolicyDescription) SetPolicyName(v string) *AutoScalingPolicyDescription
SetPolicyName sets the PolicyName field's value.
func (s *AutoScalingPolicyDescription) SetTargetTrackingScalingPolicyConfiguration(v *AutoScalingTargetTrackingScalingPolicyConfigurationDescription) *AutoScalingPolicyDescription
SetTargetTrackingScalingPolicyConfiguration sets the TargetTrackingScalingPolicyConfiguration field's value.
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 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 (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 (s *AutoScalingPolicyUpdate) SetPolicyName(v string) *AutoScalingPolicyUpdate
SetPolicyName sets the PolicyName field's value.
func (s *AutoScalingPolicyUpdate) SetTargetTrackingScalingPolicyConfiguration(v *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) *AutoScalingPolicyUpdate
SetTargetTrackingScalingPolicyConfiguration sets the TargetTrackingScalingPolicyConfiguration field's value.
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 (s *AutoScalingPolicyUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *AutoScalingSettingsDescription) SetAutoScalingDisabled(v bool) *AutoScalingSettingsDescription
SetAutoScalingDisabled sets the AutoScalingDisabled field's value.
func (s *AutoScalingSettingsDescription) SetAutoScalingRoleArn(v string) *AutoScalingSettingsDescription
SetAutoScalingRoleArn sets the AutoScalingRoleArn field's value.
func (s *AutoScalingSettingsDescription) SetMaximumUnits(v int64) *AutoScalingSettingsDescription
SetMaximumUnits sets the MaximumUnits field's value.
func (s *AutoScalingSettingsDescription) SetMinimumUnits(v int64) *AutoScalingSettingsDescription
SetMinimumUnits sets the MinimumUnits field's value.
func (s *AutoScalingSettingsDescription) SetScalingPolicies(v []*AutoScalingPolicyDescription) *AutoScalingSettingsDescription
SetScalingPolicies sets the ScalingPolicies field's value.
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 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 (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 (s *AutoScalingSettingsUpdate) SetAutoScalingDisabled(v bool) *AutoScalingSettingsUpdate
SetAutoScalingDisabled sets the AutoScalingDisabled field's value.
func (s *AutoScalingSettingsUpdate) SetAutoScalingRoleArn(v string) *AutoScalingSettingsUpdate
SetAutoScalingRoleArn sets the AutoScalingRoleArn field's value.
func (s *AutoScalingSettingsUpdate) SetMaximumUnits(v int64) *AutoScalingSettingsUpdate
SetMaximumUnits sets the MaximumUnits field's value.
func (s *AutoScalingSettingsUpdate) SetMinimumUnits(v int64) *AutoScalingSettingsUpdate
SetMinimumUnits sets the MinimumUnits field's value.
func (s *AutoScalingSettingsUpdate) SetScalingPolicyUpdate(v *AutoScalingPolicyUpdate) *AutoScalingSettingsUpdate
SetScalingPolicyUpdate sets the ScalingPolicyUpdate field's value.
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 (s *AutoScalingSettingsUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *AutoScalingTargetTrackingScalingPolicyConfigurationDescription) SetDisableScaleIn(v bool) *AutoScalingTargetTrackingScalingPolicyConfigurationDescription
SetDisableScaleIn sets the DisableScaleIn field's value.
func (s *AutoScalingTargetTrackingScalingPolicyConfigurationDescription) SetScaleInCooldown(v int64) *AutoScalingTargetTrackingScalingPolicyConfigurationDescription
SetScaleInCooldown sets the ScaleInCooldown field's value.
func (s *AutoScalingTargetTrackingScalingPolicyConfigurationDescription) SetScaleOutCooldown(v int64) *AutoScalingTargetTrackingScalingPolicyConfigurationDescription
SetScaleOutCooldown sets the ScaleOutCooldown field's value.
func (s *AutoScalingTargetTrackingScalingPolicyConfigurationDescription) SetTargetValue(v float64) *AutoScalingTargetTrackingScalingPolicyConfigurationDescription
SetTargetValue sets the TargetValue field's value.
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 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 (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 (s *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) SetDisableScaleIn(v bool) *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
SetDisableScaleIn sets the DisableScaleIn field's value.
func (s *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) SetScaleInCooldown(v int64) *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
SetScaleInCooldown sets the ScaleInCooldown field's value.
func (s *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) SetScaleOutCooldown(v int64) *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
SetScaleOutCooldown sets the ScaleOutCooldown field's value.
func (s *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) SetTargetValue(v float64) *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate
SetTargetValue sets the TargetValue field's value.
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 (s *AutoScalingTargetTrackingScalingPolicyConfigurationUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *BackupDescription) SetBackupDetails(v *BackupDetails) *BackupDescription
SetBackupDetails sets the BackupDetails field's value.
func (s *BackupDescription) SetSourceTableDetails(v *SourceTableDetails) *BackupDescription
SetSourceTableDetails sets the SourceTableDetails field's value.
func (s *BackupDescription) SetSourceTableFeatureDetails(v *SourceTableFeatureDetails) *BackupDescription
SetSourceTableFeatureDetails sets the SourceTableFeatureDetails field's value.
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 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 (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 (s *BackupDetails) SetBackupArn(v string) *BackupDetails
SetBackupArn sets the BackupArn field's value.
func (s *BackupDetails) SetBackupCreationDateTime(v time.Time) *BackupDetails
SetBackupCreationDateTime sets the BackupCreationDateTime field's value.
func (s *BackupDetails) SetBackupExpiryDateTime(v time.Time) *BackupDetails
SetBackupExpiryDateTime sets the BackupExpiryDateTime field's value.
func (s *BackupDetails) SetBackupName(v string) *BackupDetails
SetBackupName sets the BackupName field's value.
func (s *BackupDetails) SetBackupSizeBytes(v int64) *BackupDetails
SetBackupSizeBytes sets the BackupSizeBytes field's value.
func (s *BackupDetails) SetBackupStatus(v string) *BackupDetails
SetBackupStatus sets the BackupStatus field's value.
func (s *BackupDetails) SetBackupType(v string) *BackupDetails
SetBackupType sets the BackupType field's value.
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 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 (s *BackupInUseException) Code() string
Code returns the exception type name.
func (s *BackupInUseException) Error() string
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 (s *BackupInUseException) Message() string
Message returns the exception's message.
func (s *BackupInUseException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *BackupInUseException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *BackupInUseException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *BackupNotFoundException) Code() string
Code returns the exception type name.
func (s *BackupNotFoundException) Error() string
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 (s *BackupNotFoundException) Message() string
Message returns the exception's message.
func (s *BackupNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *BackupNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *BackupNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *BackupSummary) SetBackupArn(v string) *BackupSummary
SetBackupArn sets the BackupArn field's value.
func (s *BackupSummary) SetBackupCreationDateTime(v time.Time) *BackupSummary
SetBackupCreationDateTime sets the BackupCreationDateTime field's value.
func (s *BackupSummary) SetBackupExpiryDateTime(v time.Time) *BackupSummary
SetBackupExpiryDateTime sets the BackupExpiryDateTime field's value.
func (s *BackupSummary) SetBackupName(v string) *BackupSummary
SetBackupName sets the BackupName field's value.
func (s *BackupSummary) SetBackupSizeBytes(v int64) *BackupSummary
SetBackupSizeBytes sets the BackupSizeBytes field's value.
func (s *BackupSummary) SetBackupStatus(v string) *BackupSummary
SetBackupStatus sets the BackupStatus field's value.
func (s *BackupSummary) SetBackupType(v string) *BackupSummary
SetBackupType sets the BackupType field's value.
func (s *BackupSummary) SetTableArn(v string) *BackupSummary
SetTableArn sets the TableArn field's value.
func (s *BackupSummary) SetTableId(v string) *BackupSummary
SetTableId sets the TableId field's value.
func (s *BackupSummary) SetTableName(v string) *BackupSummary
SetTableName sets the TableName field's value.
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 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 (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 (s *BatchExecuteStatementInput) SetReturnConsumedCapacity(v string) *BatchExecuteStatementInput
SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.
func (s *BatchExecuteStatementInput) SetStatements(v []*BatchStatementRequest) *BatchExecuteStatementInput
SetStatements sets the Statements field's value.
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 (s *BatchExecuteStatementInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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. The values of the list // are ordered according to the ordering of the request statements. Responses []*BatchStatementResponse `type:"list"` // contains filtered or unexported fields }
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 (s *BatchExecuteStatementOutput) SetConsumedCapacity(v []*ConsumedCapacity) *BatchExecuteStatementOutput
SetConsumedCapacity sets the ConsumedCapacity field's value.
func (s *BatchExecuteStatementOutput) SetResponses(v []*BatchStatementResponse) *BatchExecuteStatementOutput
SetResponses sets the Responses field's value.
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 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 (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 (s *BatchGetItemInput) SetRequestItems(v map[string]*KeysAndAttributes) *BatchGetItemInput
SetRequestItems sets the RequestItems field's value.
func (s *BatchGetItemInput) SetReturnConsumedCapacity(v string) *BatchGetItemInput
SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.
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 (s *BatchGetItemInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *BatchGetItemOutput) SetConsumedCapacity(v []*ConsumedCapacity) *BatchGetItemOutput
SetConsumedCapacity sets the ConsumedCapacity field's value.
func (s *BatchGetItemOutput) SetResponses(v map[string][]map[string]*AttributeValue) *BatchGetItemOutput
SetResponses sets the Responses field's value.
func (s *BatchGetItemOutput) SetUnprocessedKeys(v map[string]*KeysAndAttributes) *BatchGetItemOutput
SetUnprocessedKeys sets the UnprocessedKeys field's value.
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 struct { // The error code associated with the failed PartiQL batch statement. Code *string `type:"string" enum:"BatchStatementErrorCodeEnum"` // The item which caused the condition check to fail. This will be set if ReturnValuesOnConditionCheckFailure // is specified as ALL_OLD. Item map[string]*AttributeValue `type:"map"` // The error message associated with the PartiQL batch response. Message *string `type:"string"` // contains filtered or unexported fields }
An error associated with a statement in a PartiQL batch that was run.
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 (s *BatchStatementError) SetCode(v string) *BatchStatementError
SetCode sets the Code field's value.
func (s *BatchStatementError) SetItem(v map[string]*AttributeValue) *BatchStatementError
SetItem sets the Item field's value.
func (s *BatchStatementError) SetMessage(v string) *BatchStatementError
SetMessage sets the Message field's value.
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 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"` // An optional parameter that returns the item attributes for a PartiQL batch // request operation that failed a condition check. // // 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. ReturnValuesOnConditionCheckFailure *string `type:"string" enum:"ReturnValuesOnConditionCheckFailure"` // 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 (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 (s *BatchStatementRequest) SetConsistentRead(v bool) *BatchStatementRequest
SetConsistentRead sets the ConsistentRead field's value.
func (s *BatchStatementRequest) SetParameters(v []*AttributeValue) *BatchStatementRequest
SetParameters sets the Parameters field's value.
func (s *BatchStatementRequest) SetReturnValuesOnConditionCheckFailure(v string) *BatchStatementRequest
SetReturnValuesOnConditionCheckFailure sets the ReturnValuesOnConditionCheckFailure field's value.
func (s *BatchStatementRequest) SetStatement(v string) *BatchStatementRequest
SetStatement sets the Statement field's value.
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 (s *BatchStatementRequest) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *BatchStatementResponse) SetError(v *BatchStatementError) *BatchStatementResponse
SetError sets the Error field's value.
func (s *BatchStatementResponse) SetItem(v map[string]*AttributeValue) *BatchStatementResponse
SetItem sets the Item field's value.
func (s *BatchStatementResponse) SetTableName(v string) *BatchStatementResponse
SetTableName sets the TableName field's value.
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 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 (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 (s *BatchWriteItemInput) SetRequestItems(v map[string][]*WriteRequest) *BatchWriteItemInput
SetRequestItems sets the RequestItems field's value.
func (s *BatchWriteItemInput) SetReturnConsumedCapacity(v string) *BatchWriteItemInput
SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.
func (s *BatchWriteItemInput) SetReturnItemCollectionMetrics(v string) *BatchWriteItemInput
SetReturnItemCollectionMetrics sets the ReturnItemCollectionMetrics field's value.
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 (s *BatchWriteItemInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 BatchWriteItem 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 (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 (s *BatchWriteItemOutput) SetConsumedCapacity(v []*ConsumedCapacity) *BatchWriteItemOutput
SetConsumedCapacity sets the ConsumedCapacity field's value.
func (s *BatchWriteItemOutput) SetItemCollectionMetrics(v map[string][]*ItemCollectionMetrics) *BatchWriteItemOutput
SetItemCollectionMetrics sets the ItemCollectionMetrics field's value.
func (s *BatchWriteItemOutput) SetUnprocessedItems(v map[string][]*WriteRequest) *BatchWriteItemOutput
SetUnprocessedItems sets the UnprocessedItems field's value.
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 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. This page talks about PROVISIONED and PAY_PER_REQUEST billing modes. For more information about these modes, see Read/write capacity mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html).
You may need to switch to on-demand mode at least once in order to return a BillingModeSummary response.
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 (s *BillingModeSummary) SetBillingMode(v string) *BillingModeSummary
SetBillingMode sets the BillingMode field's value.
func (s *BillingModeSummary) SetLastUpdateToPayPerRequestDateTime(v time.Time) *BillingModeSummary
SetLastUpdateToPayPerRequestDateTime sets the LastUpdateToPayPerRequestDateTime field's value.
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 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 (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 (s *CancellationReason) SetCode(v string) *CancellationReason
SetCode sets the Code field's value.
func (s *CancellationReason) SetItem(v map[string]*AttributeValue) *CancellationReason
SetItem sets the Item field's value.
func (s *CancellationReason) SetMessage(v string) *CancellationReason
SetMessage sets the Message field's value.
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 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 (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 (s *Capacity) SetCapacityUnits(v float64) *Capacity
SetCapacityUnits sets the CapacityUnits field's value.
func (s *Capacity) SetReadCapacityUnits(v float64) *Capacity
SetReadCapacityUnits sets the ReadCapacityUnits field's value.
func (s *Capacity) SetWriteCapacityUnits(v float64) *Capacity
SetWriteCapacityUnits sets the WriteCapacityUnits field's value.
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 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 (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 (s *Condition) SetAttributeValueList(v []*AttributeValue) *Condition
SetAttributeValueList sets the AttributeValueList field's value.
func (s *Condition) SetComparisonOperator(v string) *Condition
SetComparisonOperator sets the ComparisonOperator field's value.
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 (s *Condition) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ConditionCheck struct { // A condition that must be satisfied in order for a conditional update to succeed. // For more information, see Condition expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) // in the Amazon DynamoDB Developer Guide. // // ConditionExpression is a required field ConditionExpression *string `type:"string" required:"true"` // One or more substitution tokens for attribute names in an expression. For // more information, see Expression attribute names (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeNames.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string `type:"map"` // One or more values that can be substituted in an expression. For more information, // see Condition expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html) // in the Amazon DynamoDB Developer Guide. 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 (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 (s *ConditionCheck) SetConditionExpression(v string) *ConditionCheck
SetConditionExpression sets the ConditionExpression field's value.
func (s *ConditionCheck) SetExpressionAttributeNames(v map[string]*string) *ConditionCheck
SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.
func (s *ConditionCheck) SetExpressionAttributeValues(v map[string]*AttributeValue) *ConditionCheck
SetExpressionAttributeValues sets the ExpressionAttributeValues field's value.
func (s *ConditionCheck) SetKey(v map[string]*AttributeValue) *ConditionCheck
SetKey sets the Key field's value.
func (s *ConditionCheck) SetReturnValuesOnConditionCheckFailure(v string) *ConditionCheck
SetReturnValuesOnConditionCheckFailure sets the ReturnValuesOnConditionCheckFailure field's value.
func (s *ConditionCheck) SetTableName(v string) *ConditionCheck
SetTableName sets the TableName field's value.
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 (s *ConditionCheck) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ConditionalCheckFailedException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` // Item which caused the ConditionalCheckFailedException. Item map[string]*AttributeValue `type:"map"` // 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 (s *ConditionalCheckFailedException) Code() string
Code returns the exception type name.
func (s *ConditionalCheckFailedException) Error() string
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 (s *ConditionalCheckFailedException) Message() string
Message returns the exception's message.
func (s *ConditionalCheckFailedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConditionalCheckFailedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConditionalCheckFailedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *ConsumedCapacity) SetCapacityUnits(v float64) *ConsumedCapacity
SetCapacityUnits sets the CapacityUnits field's value.
func (s *ConsumedCapacity) SetGlobalSecondaryIndexes(v map[string]*Capacity) *ConsumedCapacity
SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.
func (s *ConsumedCapacity) SetLocalSecondaryIndexes(v map[string]*Capacity) *ConsumedCapacity
SetLocalSecondaryIndexes sets the LocalSecondaryIndexes field's value.
func (s *ConsumedCapacity) SetReadCapacityUnits(v float64) *ConsumedCapacity
SetReadCapacityUnits sets the ReadCapacityUnits field's value.
func (s *ConsumedCapacity) SetTable(v *Capacity) *ConsumedCapacity
SetTable sets the Table field's value.
func (s *ConsumedCapacity) SetTableName(v string) *ConsumedCapacity
SetTableName sets the TableName field's value.
func (s *ConsumedCapacity) SetWriteCapacityUnits(v float64) *ConsumedCapacity
SetWriteCapacityUnits sets the WriteCapacityUnits field's value.
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 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 (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 (s *ContinuousBackupsDescription) SetContinuousBackupsStatus(v string) *ContinuousBackupsDescription
SetContinuousBackupsStatus sets the ContinuousBackupsStatus field's value.
func (s *ContinuousBackupsDescription) SetPointInTimeRecoveryDescription(v *PointInTimeRecoveryDescription) *ContinuousBackupsDescription
SetPointInTimeRecoveryDescription sets the PointInTimeRecoveryDescription field's value.
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 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 (s *ContinuousBackupsUnavailableException) Code() string
Code returns the exception type name.
func (s *ContinuousBackupsUnavailableException) Error() string
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 (s *ContinuousBackupsUnavailableException) Message() string
Message returns the exception's message.
func (s *ContinuousBackupsUnavailableException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ContinuousBackupsUnavailableException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ContinuousBackupsUnavailableException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *ContributorInsightsSummary) SetContributorInsightsStatus(v string) *ContributorInsightsSummary
SetContributorInsightsStatus sets the ContributorInsightsStatus field's value.
func (s *ContributorInsightsSummary) SetIndexName(v string) *ContributorInsightsSummary
SetIndexName sets the IndexName field's value.
func (s *ContributorInsightsSummary) SetTableName(v string) *ContributorInsightsSummary
SetTableName sets the TableName field's value.
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 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 (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 (s *CreateBackupInput) SetBackupName(v string) *CreateBackupInput
SetBackupName sets the BackupName field's value.
func (s *CreateBackupInput) SetTableName(v string) *CreateBackupInput
SetTableName sets the TableName field's value.
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 (s *CreateBackupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateBackupOutput struct { // Contains the details of the backup created for the table. BackupDetails *BackupDetails `type:"structure"` // contains filtered or unexported fields }
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 (s *CreateBackupOutput) SetBackupDetails(v *BackupDetails) *CreateBackupOutput
SetBackupDetails sets the BackupDetails field's value.
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 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 (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 (s *CreateGlobalSecondaryIndexAction) SetIndexName(v string) *CreateGlobalSecondaryIndexAction
SetIndexName sets the IndexName field's value.
func (s *CreateGlobalSecondaryIndexAction) SetKeySchema(v []*KeySchemaElement) *CreateGlobalSecondaryIndexAction
SetKeySchema sets the KeySchema field's value.
func (s *CreateGlobalSecondaryIndexAction) SetProjection(v *Projection) *CreateGlobalSecondaryIndexAction
SetProjection sets the Projection field's value.
func (s *CreateGlobalSecondaryIndexAction) SetProvisionedThroughput(v *ProvisionedThroughput) *CreateGlobalSecondaryIndexAction
SetProvisionedThroughput sets the ProvisionedThroughput field's value.
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 (s *CreateGlobalSecondaryIndexAction) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *CreateGlobalTableInput) SetGlobalTableName(v string) *CreateGlobalTableInput
SetGlobalTableName sets the GlobalTableName field's value.
func (s *CreateGlobalTableInput) SetReplicationGroup(v []*Replica) *CreateGlobalTableInput
SetReplicationGroup sets the ReplicationGroup field's value.
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 (s *CreateGlobalTableInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateGlobalTableOutput struct { // Contains the details of the global table. GlobalTableDescription *GlobalTableDescription `type:"structure"` // contains filtered or unexported fields }
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 (s *CreateGlobalTableOutput) SetGlobalTableDescription(v *GlobalTableDescription) *CreateGlobalTableOutput
SetGlobalTableDescription sets the GlobalTableDescription field's value.
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 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 (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 (s *CreateReplicaAction) SetRegionName(v string) *CreateReplicaAction
SetRegionName sets the RegionName field's value.
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 (s *CreateReplicaAction) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *CreateReplicationGroupMemberAction) SetGlobalSecondaryIndexes(v []*ReplicaGlobalSecondaryIndex) *CreateReplicationGroupMemberAction
SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.
func (s *CreateReplicationGroupMemberAction) SetKMSMasterKeyId(v string) *CreateReplicationGroupMemberAction
SetKMSMasterKeyId sets the KMSMasterKeyId field's value.
func (s *CreateReplicationGroupMemberAction) SetProvisionedThroughputOverride(v *ProvisionedThroughputOverride) *CreateReplicationGroupMemberAction
SetProvisionedThroughputOverride sets the ProvisionedThroughputOverride field's value.
func (s *CreateReplicationGroupMemberAction) SetRegionName(v string) *CreateReplicationGroupMemberAction
SetRegionName sets the RegionName field's value.
func (s *CreateReplicationGroupMemberAction) SetTableClassOverride(v string) *CreateReplicationGroupMemberAction
SetTableClassOverride sets the TableClassOverride field's value.
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 (s *CreateReplicationGroupMemberAction) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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"` // Indicates whether deletion protection is to be enabled (true) or disabled // (false) on the table. DeletionProtectionEnabled *bool `type:"boolean"` // 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 (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 (s *CreateTableInput) SetAttributeDefinitions(v []*AttributeDefinition) *CreateTableInput
SetAttributeDefinitions sets the AttributeDefinitions field's value.
func (s *CreateTableInput) SetBillingMode(v string) *CreateTableInput
SetBillingMode sets the BillingMode field's value.
func (s *CreateTableInput) SetDeletionProtectionEnabled(v bool) *CreateTableInput
SetDeletionProtectionEnabled sets the DeletionProtectionEnabled field's value.
func (s *CreateTableInput) SetGlobalSecondaryIndexes(v []*GlobalSecondaryIndex) *CreateTableInput
SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.
func (s *CreateTableInput) SetKeySchema(v []*KeySchemaElement) *CreateTableInput
SetKeySchema sets the KeySchema field's value.
func (s *CreateTableInput) SetLocalSecondaryIndexes(v []*LocalSecondaryIndex) *CreateTableInput
SetLocalSecondaryIndexes sets the LocalSecondaryIndexes field's value.
func (s *CreateTableInput) SetProvisionedThroughput(v *ProvisionedThroughput) *CreateTableInput
SetProvisionedThroughput sets the ProvisionedThroughput field's value.
func (s *CreateTableInput) SetSSESpecification(v *SSESpecification) *CreateTableInput
SetSSESpecification sets the SSESpecification field's value.
func (s *CreateTableInput) SetStreamSpecification(v *StreamSpecification) *CreateTableInput
SetStreamSpecification sets the StreamSpecification field's value.
func (s *CreateTableInput) SetTableClass(v string) *CreateTableInput
SetTableClass sets the TableClass field's value.
func (s *CreateTableInput) SetTableName(v string) *CreateTableInput
SetTableName sets the TableName field's value.
func (s *CreateTableInput) SetTags(v []*Tag) *CreateTableInput
SetTags sets the Tags field's value.
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 (s *CreateTableInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *CreateTableOutput) SetTableDescription(v *TableDescription) *CreateTableOutput
SetTableDescription sets the TableDescription field's value.
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 CsvOptions struct { // The delimiter used for separating items in the CSV file being imported. Delimiter *string `min:"1" type:"string"` // List of the headers used to specify a common header for all source CSV files // being imported. If this field is specified then the first line of each CSV // file is treated as data instead of the header. If this field is not specified // the the first line of each CSV file is treated as the header. HeaderList []*string `min:"1" type:"list"` // contains filtered or unexported fields }
Processing options for the CSV file being imported.
func (s CsvOptions) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CsvOptions) SetDelimiter(v string) *CsvOptions
SetDelimiter sets the Delimiter field's value.
func (s *CsvOptions) SetHeaderList(v []*string) *CsvOptions
SetHeaderList sets the HeaderList field's value.
func (s CsvOptions) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CsvOptions) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *Delete) SetConditionExpression(v string) *Delete
SetConditionExpression sets the ConditionExpression field's value.
func (s *Delete) SetExpressionAttributeNames(v map[string]*string) *Delete
SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.
func (s *Delete) SetExpressionAttributeValues(v map[string]*AttributeValue) *Delete
SetExpressionAttributeValues sets the ExpressionAttributeValues field's value.
func (s *Delete) SetKey(v map[string]*AttributeValue) *Delete
SetKey sets the Key field's value.
func (s *Delete) SetReturnValuesOnConditionCheckFailure(v string) *Delete
SetReturnValuesOnConditionCheckFailure sets the ReturnValuesOnConditionCheckFailure field's value.
func (s *Delete) SetTableName(v string) *Delete
SetTableName sets the TableName field's value.
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 (s *Delete) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DeleteBackupInput) SetBackupArn(v string) *DeleteBackupInput
SetBackupArn sets the BackupArn field's value.
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 (s *DeleteBackupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteBackupOutput struct { // Contains the description of the backup created for the table. BackupDescription *BackupDescription `type:"structure"` // contains filtered or unexported fields }
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 (s *DeleteBackupOutput) SetBackupDescription(v *BackupDescription) *DeleteBackupOutput
SetBackupDescription sets the BackupDescription field's value.
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 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 (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 (s *DeleteGlobalSecondaryIndexAction) SetIndexName(v string) *DeleteGlobalSecondaryIndexAction
SetIndexName sets the IndexName field's value.
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 (s *DeleteGlobalSecondaryIndexAction) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 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. // // 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"` // An optional parameter that returns the item attributes for a DeleteItem operation // that failed a condition check. // // 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. ReturnValuesOnConditionCheckFailure *string `type:"string" enum:"ReturnValuesOnConditionCheckFailure"` // 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 (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 (s *DeleteItemInput) SetConditionExpression(v string) *DeleteItemInput
SetConditionExpression sets the ConditionExpression field's value.
func (s *DeleteItemInput) SetConditionalOperator(v string) *DeleteItemInput
SetConditionalOperator sets the ConditionalOperator field's value.
func (s *DeleteItemInput) SetExpected(v map[string]*ExpectedAttributeValue) *DeleteItemInput
SetExpected sets the Expected field's value.
func (s *DeleteItemInput) SetExpressionAttributeNames(v map[string]*string) *DeleteItemInput
SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.
func (s *DeleteItemInput) SetExpressionAttributeValues(v map[string]*AttributeValue) *DeleteItemInput
SetExpressionAttributeValues sets the ExpressionAttributeValues field's value.
func (s *DeleteItemInput) SetKey(v map[string]*AttributeValue) *DeleteItemInput
SetKey sets the Key field's value.
func (s *DeleteItemInput) SetReturnConsumedCapacity(v string) *DeleteItemInput
SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.
func (s *DeleteItemInput) SetReturnItemCollectionMetrics(v string) *DeleteItemInput
SetReturnItemCollectionMetrics sets the ReturnItemCollectionMetrics field's value.
func (s *DeleteItemInput) SetReturnValues(v string) *DeleteItemInput
SetReturnValues sets the ReturnValues field's value.
func (s *DeleteItemInput) SetReturnValuesOnConditionCheckFailure(v string) *DeleteItemInput
SetReturnValuesOnConditionCheckFailure sets the ReturnValuesOnConditionCheckFailure field's value.
func (s *DeleteItemInput) SetTableName(v string) *DeleteItemInput
SetTableName sets the TableName field's value.
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 (s *DeleteItemInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 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 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 (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 (s *DeleteItemOutput) SetAttributes(v map[string]*AttributeValue) *DeleteItemOutput
SetAttributes sets the Attributes field's value.
func (s *DeleteItemOutput) SetConsumedCapacity(v *ConsumedCapacity) *DeleteItemOutput
SetConsumedCapacity sets the ConsumedCapacity field's value.
func (s *DeleteItemOutput) SetItemCollectionMetrics(v *ItemCollectionMetrics) *DeleteItemOutput
SetItemCollectionMetrics sets the ItemCollectionMetrics field's value.
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 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 (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 (s *DeleteReplicaAction) SetRegionName(v string) *DeleteReplicaAction
SetRegionName sets the RegionName field's value.
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 (s *DeleteReplicaAction) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DeleteReplicationGroupMemberAction) SetRegionName(v string) *DeleteReplicationGroupMemberAction
SetRegionName sets the RegionName field's value.
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 (s *DeleteReplicationGroupMemberAction) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DeleteRequest) SetKey(v map[string]*AttributeValue) *DeleteRequest
SetKey sets the Key field's value.
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 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 (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 (s *DeleteTableInput) SetTableName(v string) *DeleteTableInput
SetTableName sets the TableName field's value.
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 (s *DeleteTableInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DeleteTableOutput) SetTableDescription(v *TableDescription) *DeleteTableOutput
SetTableDescription sets the TableDescription field's value.
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 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 (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 (s *DescribeBackupInput) SetBackupArn(v string) *DescribeBackupInput
SetBackupArn sets the BackupArn field's value.
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 (s *DescribeBackupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeBackupOutput struct { // Contains the description of the backup created for the table. BackupDescription *BackupDescription `type:"structure"` // contains filtered or unexported fields }
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 (s *DescribeBackupOutput) SetBackupDescription(v *BackupDescription) *DescribeBackupOutput
SetBackupDescription sets the BackupDescription field's value.
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 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 (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 (s *DescribeContinuousBackupsInput) SetTableName(v string) *DescribeContinuousBackupsInput
SetTableName sets the TableName field's value.
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 (s *DescribeContinuousBackupsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeContinuousBackupsOutput) SetContinuousBackupsDescription(v *ContinuousBackupsDescription) *DescribeContinuousBackupsOutput
SetContinuousBackupsDescription sets the ContinuousBackupsDescription field's value.
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 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 (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 (s *DescribeContributorInsightsInput) SetIndexName(v string) *DescribeContributorInsightsInput
SetIndexName sets the IndexName field's value.
func (s *DescribeContributorInsightsInput) SetTableName(v string) *DescribeContributorInsightsInput
SetTableName sets the TableName field's value.
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 (s *DescribeContributorInsightsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeContributorInsightsOutput) SetContributorInsightsRuleList(v []*string) *DescribeContributorInsightsOutput
SetContributorInsightsRuleList sets the ContributorInsightsRuleList field's value.
func (s *DescribeContributorInsightsOutput) SetContributorInsightsStatus(v string) *DescribeContributorInsightsOutput
SetContributorInsightsStatus sets the ContributorInsightsStatus field's value.
func (s *DescribeContributorInsightsOutput) SetFailureException(v *FailureException) *DescribeContributorInsightsOutput
SetFailureException sets the FailureException field's value.
func (s *DescribeContributorInsightsOutput) SetIndexName(v string) *DescribeContributorInsightsOutput
SetIndexName sets the IndexName field's value.
func (s *DescribeContributorInsightsOutput) SetLastUpdateDateTime(v time.Time) *DescribeContributorInsightsOutput
SetLastUpdateDateTime sets the LastUpdateDateTime field's value.
func (s *DescribeContributorInsightsOutput) SetTableName(v string) *DescribeContributorInsightsOutput
SetTableName sets the TableName field's value.
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 struct {
// contains filtered or unexported fields
}
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 (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 struct { // List of endpoints. // // Endpoints is a required field Endpoints []*Endpoint `type:"list" required:"true"` // contains filtered or unexported fields }
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 (s *DescribeEndpointsOutput) SetEndpoints(v []*Endpoint) *DescribeEndpointsOutput
SetEndpoints sets the Endpoints field's value.
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 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 (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 (s *DescribeExportInput) SetExportArn(v string) *DescribeExportInput
SetExportArn sets the ExportArn field's value.
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 (s *DescribeExportInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeExportOutput struct { // Represents the properties of the export. ExportDescription *ExportDescription `type:"structure"` // contains filtered or unexported fields }
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 (s *DescribeExportOutput) SetExportDescription(v *ExportDescription) *DescribeExportOutput
SetExportDescription sets the ExportDescription field's value.
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 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 (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 (s *DescribeGlobalTableInput) SetGlobalTableName(v string) *DescribeGlobalTableInput
SetGlobalTableName sets the GlobalTableName field's value.
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 (s *DescribeGlobalTableInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeGlobalTableOutput struct { // Contains the details of the global table. GlobalTableDescription *GlobalTableDescription `type:"structure"` // contains filtered or unexported fields }
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 (s *DescribeGlobalTableOutput) SetGlobalTableDescription(v *GlobalTableDescription) *DescribeGlobalTableOutput
SetGlobalTableDescription sets the GlobalTableDescription field's value.
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 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 (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 (s *DescribeGlobalTableSettingsInput) SetGlobalTableName(v string) *DescribeGlobalTableSettingsInput
SetGlobalTableName sets the GlobalTableName field's value.
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 (s *DescribeGlobalTableSettingsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeGlobalTableSettingsOutput) SetGlobalTableName(v string) *DescribeGlobalTableSettingsOutput
SetGlobalTableName sets the GlobalTableName field's value.
func (s *DescribeGlobalTableSettingsOutput) SetReplicaSettings(v []*ReplicaSettingsDescription) *DescribeGlobalTableSettingsOutput
SetReplicaSettings sets the ReplicaSettings field's value.
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 DescribeImportInput struct { // The Amazon Resource Name (ARN) associated with the table you're importing // to. // // ImportArn is a required field ImportArn *string `min:"37" type:"string" required:"true"` // contains filtered or unexported fields }
func (s DescribeImportInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeImportInput) SetImportArn(v string) *DescribeImportInput
SetImportArn sets the ImportArn field's value.
func (s DescribeImportInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeImportInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeImportOutput struct { // Represents the properties of the table created for the import, and parameters // of the import. The import parameters include import status, how many items // were processed, and how many errors were encountered. // // ImportTableDescription is a required field ImportTableDescription *ImportTableDescription `type:"structure" required:"true"` // contains filtered or unexported fields }
func (s DescribeImportOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeImportOutput) SetImportTableDescription(v *ImportTableDescription) *DescribeImportOutput
SetImportTableDescription sets the ImportTableDescription field's value.
func (s DescribeImportOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in 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 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 (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 (s *DescribeKinesisStreamingDestinationInput) SetTableName(v string) *DescribeKinesisStreamingDestinationInput
SetTableName sets the TableName field's value.
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 (s *DescribeKinesisStreamingDestinationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeKinesisStreamingDestinationOutput) SetKinesisDataStreamDestinations(v []*KinesisDataStreamDestination) *DescribeKinesisStreamingDestinationOutput
SetKinesisDataStreamDestinations sets the KinesisDataStreamDestinations field's value.
func (s *DescribeKinesisStreamingDestinationOutput) SetTableName(v string) *DescribeKinesisStreamingDestinationOutput
SetTableName sets the TableName field's value.
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 struct {
// contains filtered or unexported fields
}
Represents the input of a DescribeLimits operation. Has no content.
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 (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 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 (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 (s *DescribeLimitsOutput) SetAccountMaxReadCapacityUnits(v int64) *DescribeLimitsOutput
SetAccountMaxReadCapacityUnits sets the AccountMaxReadCapacityUnits field's value.
func (s *DescribeLimitsOutput) SetAccountMaxWriteCapacityUnits(v int64) *DescribeLimitsOutput
SetAccountMaxWriteCapacityUnits sets the AccountMaxWriteCapacityUnits field's value.
func (s *DescribeLimitsOutput) SetTableMaxReadCapacityUnits(v int64) *DescribeLimitsOutput
SetTableMaxReadCapacityUnits sets the TableMaxReadCapacityUnits field's value.
func (s *DescribeLimitsOutput) SetTableMaxWriteCapacityUnits(v int64) *DescribeLimitsOutput
SetTableMaxWriteCapacityUnits sets the TableMaxWriteCapacityUnits field's value.
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 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 (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 (s *DescribeTableInput) SetTableName(v string) *DescribeTableInput
SetTableName sets the TableName field's value.
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 (s *DescribeTableInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeTableOutput) SetTable(v *TableDescription) *DescribeTableOutput
SetTable sets the Table field's value.
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 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 (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 (s *DescribeTableReplicaAutoScalingInput) SetTableName(v string) *DescribeTableReplicaAutoScalingInput
SetTableName sets the TableName field's value.
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 (s *DescribeTableReplicaAutoScalingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeTableReplicaAutoScalingOutput struct { // Represents the auto scaling properties of the table. TableAutoScalingDescription *TableAutoScalingDescription `type:"structure"` // contains filtered or unexported fields }
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 (s *DescribeTableReplicaAutoScalingOutput) SetTableAutoScalingDescription(v *TableAutoScalingDescription) *DescribeTableReplicaAutoScalingOutput
SetTableAutoScalingDescription sets the TableAutoScalingDescription field's value.
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 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 (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 (s *DescribeTimeToLiveInput) SetTableName(v string) *DescribeTimeToLiveInput
SetTableName sets the TableName field's value.
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 (s *DescribeTimeToLiveInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeTimeToLiveOutput) SetTimeToLiveDescription(v *TimeToLiveDescription) *DescribeTimeToLiveOutput
SetTimeToLiveDescription sets the TimeToLiveDescription field's value.
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 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 (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 (s *DisableKinesisStreamingDestinationInput) SetStreamArn(v string) *DisableKinesisStreamingDestinationInput
SetStreamArn sets the StreamArn field's value.
func (s *DisableKinesisStreamingDestinationInput) SetTableName(v string) *DisableKinesisStreamingDestinationInput
SetTableName sets the TableName field's value.
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 (s *DisableKinesisStreamingDestinationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DisableKinesisStreamingDestinationOutput) SetDestinationStatus(v string) *DisableKinesisStreamingDestinationOutput
SetDestinationStatus sets the DestinationStatus field's value.
func (s *DisableKinesisStreamingDestinationOutput) SetStreamArn(v string) *DisableKinesisStreamingDestinationOutput
SetStreamArn sets the StreamArn field's value.
func (s *DisableKinesisStreamingDestinationOutput) SetTableName(v string) *DisableKinesisStreamingDestinationOutput
SetTableName sets the TableName field's value.
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 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 (s *DuplicateItemException) Code() string
Code returns the exception type name.
func (s *DuplicateItemException) Error() string
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 (s *DuplicateItemException) Message() string
Message returns the exception's message.
func (s *DuplicateItemException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *DuplicateItemException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *DuplicateItemException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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(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 (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 (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 (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 (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, more than 1MB per partition is requested, 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 may retrieve 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
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 (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 (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 (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 (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. If you perform a BatchWriteItem operation on an existing item, that item's values will be overwritten by the operation and it will appear like it was updated. To update items, we recommend you 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
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 (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 (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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
InternalServerError An error occurred on the server side.
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateBackup
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 (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 (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 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
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 (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 (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 (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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
InternalServerError An error occurred on the server side.
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateTable
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 (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 (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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
InternalServerError An error occurred on the server side.
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteBackup
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 (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 (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
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 (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 (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.
This operation only applies to Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) of global tables.
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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
InternalServerError An error occurred on the server side.
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DeleteTable
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (c *DynamoDB) DescribeEndpoints(input *DescribeEndpointsInput) (*DescribeEndpointsOutput, error)
DescribeEndpoints API operation for Amazon DynamoDB.
Returns the regional endpoint information. For more information on policy permissions, please see Internetwork traffic privacy (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/inter-network-traffic-privacy.html#inter-network-traffic-DescribeEndpoints).
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 (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 (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 (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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
InternalServerError An error occurred on the server side.
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeExport
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 (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 (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 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
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 (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 (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 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
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 (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 (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 (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 (c *DynamoDB) DescribeImport(input *DescribeImportInput) (*DescribeImportOutput, error)
DescribeImport API operation for Amazon DynamoDB.
Represents the properties of the import.
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 DescribeImport for usage and error information.
Returned Error Types:
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeImport
func (c *DynamoDB) DescribeImportRequest(input *DescribeImportInput) (req *request.Request, output *DescribeImportOutput)
DescribeImportRequest generates a "aws/request.Request" representing the client's request for the DescribeImport 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 DescribeImport for more information on using the DescribeImport 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 DescribeImportRequest method. req, resp := client.DescribeImportRequest(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/DescribeImport
func (c *DynamoDB) DescribeImportWithContext(ctx aws.Context, input *DescribeImportInput, opts ...request.Option) (*DescribeImportOutput, error)
DescribeImportWithContext is the same as DescribeImport with the addition of the ability to pass a context and additional request options.
See DescribeImport 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 (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 (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 (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 (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:
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeLimits
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 (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 (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.
This operation only applies to Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) of global tables.
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
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 (Current) (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 (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 (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 (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 (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 (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 (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 (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 (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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
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 (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 (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 (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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
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 (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 (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 (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. If NextToken is present, you need to paginate the result set and include NextToken.
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 (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 (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 (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.
There is an ongoing TransactWriteItems operation that conflicts with a concurrent TransactWriteItems request. In this case the TransactWriteItems operation fails with a TransactionCanceledException.
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 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.
Recommended Settings
This is a general recommendation for handling the TransactionInProgressException. These settings help ensure that the client retries will trigger completion of the ongoing TransactWriteItems request.
Set clientExecutionTimeout to a value that allows at least one retry to be processed after 5 seconds have elapsed since the first attempt for the TransactWriteItems operation.
Set socketTimeout to a value a little lower than the requestTimeout setting.
requestTimeout should be set based on the time taken for the individual retries of a single HTTP request for your use case, but setting it to 1 second or higher should work well to reduce chances of retries and TransactionInProgressException errors.
Use exponential backoff when retrying and tune backoff if needed.
Assuming default retry policy (https://github.com/aws/aws-sdk-java/blob/fd409dee8ae23fb8953e0bb4dbde65536a7e0514/aws-java-sdk-core/src/main/java/com/amazonaws/retry/PredefinedRetryPolicies.java#L97), example timeout settings based on the guidelines above are as follows:
Example timeline:
0-1000 first attempt
1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay for 4xx errors)
1500-2500 second attempt
2500-3500 second sleep/delay (500 * 2, exponential backoff)
3500-4500 third attempt
4500-6500 third sleep/delay (500 * 2^2)
6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)
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 (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 (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 (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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
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 (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 (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 (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
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 (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 (c *DynamoDB) ImportTable(input *ImportTableInput) (*ImportTableOutput, error)
ImportTable API operation for Amazon DynamoDB.
Imports table data from an S3 bucket.
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 ImportTable 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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
ImportConflictException There was a conflict when importing from the specified S3 source. This can occur when the current import conflicts with a previous import request that had the same client token.
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ImportTable
func (c *DynamoDB) ImportTableRequest(input *ImportTableInput) (req *request.Request, output *ImportTableOutput)
ImportTableRequest generates a "aws/request.Request" representing the client's request for the ImportTable 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 ImportTable for more information on using the ImportTable 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 ImportTableRequest method. req, resp := client.ImportTableRequest(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/ImportTable
func (c *DynamoDB) ImportTableWithContext(ctx aws.Context, input *ImportTableInput, opts ...request.Option) (*ImportTableOutput, error)
ImportTableWithContext is the same as ImportTable with the addition of the ability to pass a context and additional request options.
See ImportTable 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 (c *DynamoDB) ListBackups(input *ListBackupsInput) (*ListBackupsOutput, error)
ListBackups API operation for Amazon DynamoDB.
List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup. To list these 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.
If you want to retrieve the complete list of backups made with Amazon Web Services Backup, use the Amazon Web Services Backup list API. (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListBackupJobs.html)
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:
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListBackups
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 (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 (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 (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 (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 (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 (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 (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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
InternalServerError An error occurred on the server side.
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListExports
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 (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 (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 (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 (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 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
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:
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListGlobalTables
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 (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 (c *DynamoDB) ListImports(input *ListImportsInput) (*ListImportsOutput, error)
ListImports API operation for Amazon DynamoDB.
Lists completed imports 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 ListImports 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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListImports
func (c *DynamoDB) ListImportsPages(input *ListImportsInput, fn func(*ListImportsOutput, bool) bool) error
ListImportsPages iterates over the pages of a ListImports operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListImports 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 ListImports operation. pageNum := 0 err := client.ListImportsPages(params, func(page *dynamodb.ListImportsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *DynamoDB) ListImportsPagesWithContext(ctx aws.Context, input *ListImportsInput, fn func(*ListImportsOutput, bool) bool, opts ...request.Option) error
ListImportsPagesWithContext same as ListImportsPages 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 (c *DynamoDB) ListImportsRequest(input *ListImportsInput) (req *request.Request, output *ListImportsOutput)
ListImportsRequest generates a "aws/request.Request" representing the client's request for the ListImports 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 ListImports for more information on using the ListImports 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 ListImportsRequest method. req, resp := client.ListImportsRequest(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/ListImports
func (c *DynamoDB) ListImportsWithContext(ctx aws.Context, input *ListImportsInput, opts ...request.Option) (*ListImportsOutput, error)
ListImportsWithContext is the same as ListImports with the addition of the ability to pass a context and additional request options.
See ListImports 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 (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:
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListTables
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 (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 (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 (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 (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 (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 (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 (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.
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
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 (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 (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
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 (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 (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 (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 (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 50 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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
InternalServerError An error occurred on the server side.
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/RestoreTableFromBackup
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 (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 (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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
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 (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 (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 (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 size of scanned items exceeds the maximum dataset size limit of 1 MB, the scan completes and results are returned to the user. The LastEvaluatedKey value is also returned and the requestor can use the LastEvaluatedKey to continue the scan in a subsequent operation. Each scan response also includes number of items that were scanned (ScannedCount) as part of the request. If using a FilterExpression, a scan result can result in no items meeting the criteria and the Count will result in zero. If you did not use a FilterExpression in the scan request, then Count is the same as ScannedCount.
Count and ScannedCount only return the count of items specific to a single scan request and, unless the table is less than 1MB, do not represent the total number of items in the table.
A single Scan operation first reads up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then applies any filtering to the results if a FilterExpression is provided. If LastEvaluatedKey is present in the response, pagination is required to complete the full table scan. 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.
By default, a Scan uses eventually consistent reads when accessing the items in a table. Therefore, the results from an eventually consistent Scan may not include the latest item changes at the time the scan iterates through each item in the table. If you require a strongly consistent read of each item as the scan iterates through the items in the table, you can set the ConsistentRead parameter to true. Strong consistency only relates to the consistency of the read at the item level.
DynamoDB does not provide snapshot isolation for a scan operation when the ConsistentRead parameter is set to true. Thus, a DynamoDB scan operation does not guarantee that all reads in a scan see a consistent snapshot of the table when the scan operation was requested.
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
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 (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 (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 (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 (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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
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 (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 (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 (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 100 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 exceeded 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.
There is an ongoing TransactWriteItems operation that conflicts with a concurrent TransactWriteItems request. In this case the TransactWriteItems operation fails with a TransactionCanceledException.
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 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 (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 (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 (c *DynamoDB) TransactWriteItems(input *TransactWriteItemsInput) (*TransactWriteItemsOutput, error)
TransactWriteItems API operation for Amazon DynamoDB.
TransactWriteItems is a synchronous write operation that groups up to 100 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.
There is an ongoing TransactWriteItems operation that conflicts with a concurrent TransactWriteItems request. In this case the TransactWriteItems operation fails with a TransactionCanceledException.
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 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.
Recommended Settings
This is a general recommendation for handling the TransactionInProgressException. These settings help ensure that the client retries will trigger completion of the ongoing TransactWriteItems request.
Set clientExecutionTimeout to a value that allows at least one retry to be processed after 5 seconds have elapsed since the first attempt for the TransactWriteItems operation.
Set socketTimeout to a value a little lower than the requestTimeout setting.
requestTimeout should be set based on the time taken for the individual retries of a single HTTP request for your use case, but setting it to 1 second or higher should work well to reduce chances of retries and TransactionInProgressException errors.
Use exponential backoff when retrying and tune backoff if needed.
Assuming default retry policy (https://github.com/aws/aws-sdk-java/blob/fd409dee8ae23fb8953e0bb4dbde65536a7e0514/aws-java-sdk-core/src/main/java/com/amazonaws/retry/PredefinedRetryPolicies.java#L97), example timeout settings based on the guidelines above are as follows:
Example timeline:
0-1000 first attempt
1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay for 4xx errors)
1500-2500 second attempt
2500-3500 second sleep/delay (500 * 2, exponential backoff)
3500-4500 third attempt
4500-6500 third sleep/delay (500 * 2^2)
6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)
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)
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 (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 (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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
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 (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 (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 (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 (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 (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 (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 (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 (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 (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.
This operation only applies to Version 2017.11.29 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
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.
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 (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 (c *DynamoDB) UpdateGlobalTableSettings(input *UpdateGlobalTableSettingsInput) (*UpdateGlobalTableSettingsOutput, error)
UpdateGlobalTableSettings API operation for Amazon DynamoDB.
Updates settings for a global table.
This operation only applies to Version 2017.11.29 (Legacy) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables. We recommend using Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) when creating new global tables, as it provides greater flexibility, higher efficiency and consumes less write capacity than 2017.11.29 (Legacy). To determine which version you are using, see Determining the version (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.DetermineVersion.html). To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Updating global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/V2globaltables_upgrade.html).
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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
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 (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 (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 (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 (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
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 (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 (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.
This operation only applies to Version 2019.11.21 (Current) (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) of global tables.
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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
InternalServerError An error occurred on the server side.
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateTable
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 (Current) (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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
InternalServerError An error occurred on the server side.
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateTableReplicaAutoScaling
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 (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 (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 (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 (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.
For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.
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, then DynamoDB might temporarily reduce the number of concurrent operations.
When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
There is a soft account quota of 2,500 tables.
GetRecords was called with a value of more than 1000 for the limit request parameter.
More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
InternalServerError An error occurred on the server side.
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateTimeToLive
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 (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 (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 (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 (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 (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 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 (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 (s *EnableKinesisStreamingDestinationInput) SetStreamArn(v string) *EnableKinesisStreamingDestinationInput
SetStreamArn sets the StreamArn field's value.
func (s *EnableKinesisStreamingDestinationInput) SetTableName(v string) *EnableKinesisStreamingDestinationInput
SetTableName sets the TableName field's value.
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 (s *EnableKinesisStreamingDestinationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *EnableKinesisStreamingDestinationOutput) SetDestinationStatus(v string) *EnableKinesisStreamingDestinationOutput
SetDestinationStatus sets the DestinationStatus field's value.
func (s *EnableKinesisStreamingDestinationOutput) SetStreamArn(v string) *EnableKinesisStreamingDestinationOutput
SetStreamArn sets the StreamArn field's value.
func (s *EnableKinesisStreamingDestinationOutput) SetTableName(v string) *EnableKinesisStreamingDestinationOutput
SetTableName sets the TableName field's value.
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 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 (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 (s *Endpoint) SetAddress(v string) *Endpoint
SetAddress sets the Address field's value.
func (s *Endpoint) SetCachePeriodInMinutes(v int64) *Endpoint
SetCachePeriodInMinutes sets the CachePeriodInMinutes field's value.
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 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"` // An optional parameter that returns the item attributes for an ExecuteStatement // operation that failed a condition check. // // 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. ReturnValuesOnConditionCheckFailure *string `type:"string" enum:"ReturnValuesOnConditionCheckFailure"` // 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 (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 (s *ExecuteStatementInput) SetConsistentRead(v bool) *ExecuteStatementInput
SetConsistentRead sets the ConsistentRead field's value.
func (s *ExecuteStatementInput) SetLimit(v int64) *ExecuteStatementInput
SetLimit sets the Limit field's value.
func (s *ExecuteStatementInput) SetNextToken(v string) *ExecuteStatementInput
SetNextToken sets the NextToken field's value.
func (s *ExecuteStatementInput) SetParameters(v []*AttributeValue) *ExecuteStatementInput
SetParameters sets the Parameters field's value.
func (s *ExecuteStatementInput) SetReturnConsumedCapacity(v string) *ExecuteStatementInput
SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.
func (s *ExecuteStatementInput) SetReturnValuesOnConditionCheckFailure(v string) *ExecuteStatementInput
SetReturnValuesOnConditionCheckFailure sets the ReturnValuesOnConditionCheckFailure field's value.
func (s *ExecuteStatementInput) SetStatement(v string) *ExecuteStatementInput
SetStatement sets the Statement field's value.
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 (s *ExecuteStatementInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ExecuteStatementOutput) SetConsumedCapacity(v *ConsumedCapacity) *ExecuteStatementOutput
SetConsumedCapacity sets the ConsumedCapacity field's value.
func (s *ExecuteStatementOutput) SetItems(v []map[string]*AttributeValue) *ExecuteStatementOutput
SetItems sets the Items field's value.
func (s *ExecuteStatementOutput) SetLastEvaluatedKey(v map[string]*AttributeValue) *ExecuteStatementOutput
SetLastEvaluatedKey sets the LastEvaluatedKey field's value.
func (s *ExecuteStatementOutput) SetNextToken(v string) *ExecuteStatementOutput
SetNextToken sets the NextToken field's value.
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 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 (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 (s *ExecuteTransactionInput) SetClientRequestToken(v string) *ExecuteTransactionInput
SetClientRequestToken sets the ClientRequestToken field's value.
func (s *ExecuteTransactionInput) SetReturnConsumedCapacity(v string) *ExecuteTransactionInput
SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.
func (s *ExecuteTransactionInput) SetTransactStatements(v []*ParameterizedStatement) *ExecuteTransactionInput
SetTransactStatements sets the TransactStatements field's value.
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 (s *ExecuteTransactionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ExecuteTransactionOutput) SetConsumedCapacity(v []*ConsumedCapacity) *ExecuteTransactionOutput
SetConsumedCapacity sets the ConsumedCapacity field's value.
func (s *ExecuteTransactionOutput) SetResponses(v []*ItemResponse) *ExecuteTransactionOutput
SetResponses sets the Responses field's value.
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 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 (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 (s *ExpectedAttributeValue) SetAttributeValueList(v []*AttributeValue) *ExpectedAttributeValue
SetAttributeValueList sets the AttributeValueList field's value.
func (s *ExpectedAttributeValue) SetComparisonOperator(v string) *ExpectedAttributeValue
SetComparisonOperator sets the ComparisonOperator field's value.
func (s *ExpectedAttributeValue) SetExists(v bool) *ExpectedAttributeValue
SetExists sets the Exists field's value.
func (s *ExpectedAttributeValue) SetValue(v *AttributeValue) *ExpectedAttributeValue
SetValue sets the Value field's value.
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 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 (s *ExportConflictException) Code() string
Code returns the exception type name.
func (s *ExportConflictException) Error() string
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 (s *ExportConflictException) Message() string
Message returns the exception's message.
func (s *ExportConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ExportConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ExportConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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"` // The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. ExportType *string `type:"string" enum:"ExportType"` // Status code for the result of the failed export. FailureCode *string `type:"string"` // Export failure reason description. FailureMessage *string `type:"string"` // Optional object containing the parameters specific to an incremental export. IncrementalExportSpecification *IncrementalExportSpecification `type:"structure"` // 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 (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 (s *ExportDescription) SetBilledSizeBytes(v int64) *ExportDescription
SetBilledSizeBytes sets the BilledSizeBytes field's value.
func (s *ExportDescription) SetClientToken(v string) *ExportDescription
SetClientToken sets the ClientToken field's value.
func (s *ExportDescription) SetEndTime(v time.Time) *ExportDescription
SetEndTime sets the EndTime field's value.
func (s *ExportDescription) SetExportArn(v string) *ExportDescription
SetExportArn sets the ExportArn field's value.
func (s *ExportDescription) SetExportFormat(v string) *ExportDescription
SetExportFormat sets the ExportFormat field's value.
func (s *ExportDescription) SetExportManifest(v string) *ExportDescription
SetExportManifest sets the ExportManifest field's value.
func (s *ExportDescription) SetExportStatus(v string) *ExportDescription
SetExportStatus sets the ExportStatus field's value.
func (s *ExportDescription) SetExportTime(v time.Time) *ExportDescription
SetExportTime sets the ExportTime field's value.
func (s *ExportDescription) SetExportType(v string) *ExportDescription
SetExportType sets the ExportType field's value.
func (s *ExportDescription) SetFailureCode(v string) *ExportDescription
SetFailureCode sets the FailureCode field's value.
func (s *ExportDescription) SetFailureMessage(v string) *ExportDescription
SetFailureMessage sets the FailureMessage field's value.
func (s *ExportDescription) SetIncrementalExportSpecification(v *IncrementalExportSpecification) *ExportDescription
SetIncrementalExportSpecification sets the IncrementalExportSpecification field's value.
func (s *ExportDescription) SetItemCount(v int64) *ExportDescription
SetItemCount sets the ItemCount field's value.
func (s *ExportDescription) SetS3Bucket(v string) *ExportDescription
SetS3Bucket sets the S3Bucket field's value.
func (s *ExportDescription) SetS3BucketOwner(v string) *ExportDescription
SetS3BucketOwner sets the S3BucketOwner field's value.
func (s *ExportDescription) SetS3Prefix(v string) *ExportDescription
SetS3Prefix sets the S3Prefix field's value.
func (s *ExportDescription) SetS3SseAlgorithm(v string) *ExportDescription
SetS3SseAlgorithm sets the S3SseAlgorithm field's value.
func (s *ExportDescription) SetS3SseKmsKeyId(v string) *ExportDescription
SetS3SseKmsKeyId sets the S3SseKmsKeyId field's value.
func (s *ExportDescription) SetStartTime(v time.Time) *ExportDescription
SetStartTime sets the StartTime field's value.
func (s *ExportDescription) SetTableArn(v string) *ExportDescription
SetTableArn sets the TableArn field's value.
func (s *ExportDescription) SetTableId(v string) *ExportDescription
SetTableId sets the TableId field's value.
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 struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The specified export was not found.
func (s *ExportNotFoundException) Code() string
Code returns the exception type name.
func (s *ExportNotFoundException) Error() string
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 (s *ExportNotFoundException) Message() string
Message returns the exception's message.
func (s *ExportNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ExportNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ExportNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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"` // The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. ExportType *string `type:"string" enum:"ExportType"` // contains filtered or unexported fields }
Summary information about an export task.
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 (s *ExportSummary) SetExportArn(v string) *ExportSummary
SetExportArn sets the ExportArn field's value.
func (s *ExportSummary) SetExportStatus(v string) *ExportSummary
SetExportStatus sets the ExportStatus field's value.
func (s *ExportSummary) SetExportType(v string) *ExportSummary
SetExportType sets the ExportType field's value.
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 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 ImportConflictException. 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"` // Choice of whether to execute as a full export or incremental export. Valid // values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. // If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must // also be used. ExportType *string `type:"string" enum:"ExportType"` // Optional object containing the parameters specific to an incremental export. IncrementalExportSpecification *IncrementalExportSpecification `type:"structure"` // 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 (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 (s *ExportTableToPointInTimeInput) SetClientToken(v string) *ExportTableToPointInTimeInput
SetClientToken sets the ClientToken field's value.
func (s *ExportTableToPointInTimeInput) SetExportFormat(v string) *ExportTableToPointInTimeInput
SetExportFormat sets the ExportFormat field's value.
func (s *ExportTableToPointInTimeInput) SetExportTime(v time.Time) *ExportTableToPointInTimeInput
SetExportTime sets the ExportTime field's value.
func (s *ExportTableToPointInTimeInput) SetExportType(v string) *ExportTableToPointInTimeInput
SetExportType sets the ExportType field's value.
func (s *ExportTableToPointInTimeInput) SetIncrementalExportSpecification(v *IncrementalExportSpecification) *ExportTableToPointInTimeInput
SetIncrementalExportSpecification sets the IncrementalExportSpecification field's value.
func (s *ExportTableToPointInTimeInput) SetS3Bucket(v string) *ExportTableToPointInTimeInput
SetS3Bucket sets the S3Bucket field's value.
func (s *ExportTableToPointInTimeInput) SetS3BucketOwner(v string) *ExportTableToPointInTimeInput
SetS3BucketOwner sets the S3BucketOwner field's value.
func (s *ExportTableToPointInTimeInput) SetS3Prefix(v string) *ExportTableToPointInTimeInput
SetS3Prefix sets the S3Prefix field's value.
func (s *ExportTableToPointInTimeInput) SetS3SseAlgorithm(v string) *ExportTableToPointInTimeInput
SetS3SseAlgorithm sets the S3SseAlgorithm field's value.
func (s *ExportTableToPointInTimeInput) SetS3SseKmsKeyId(v string) *ExportTableToPointInTimeInput
SetS3SseKmsKeyId sets the S3SseKmsKeyId field's value.
func (s *ExportTableToPointInTimeInput) SetTableArn(v string) *ExportTableToPointInTimeInput
SetTableArn sets the TableArn field's value.
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 (s *ExportTableToPointInTimeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ExportTableToPointInTimeOutput struct { // Contains a description of the table export. ExportDescription *ExportDescription `type:"structure"` // contains filtered or unexported fields }
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 (s *ExportTableToPointInTimeOutput) SetExportDescription(v *ExportDescription) *ExportTableToPointInTimeOutput
SetExportDescription sets the ExportDescription field's value.
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 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 (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 (s *FailureException) SetExceptionDescription(v string) *FailureException
SetExceptionDescription sets the ExceptionDescription field's value.
func (s *FailureException) SetExceptionName(v string) *FailureException
SetExceptionName sets the ExceptionName field's value.
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 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 (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 (s *Get) SetExpressionAttributeNames(v map[string]*string) *Get
SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.
func (s *Get) SetKey(v map[string]*AttributeValue) *Get
SetKey sets the Key field's value.
func (s *Get) SetProjectionExpression(v string) *Get
SetProjectionExpression sets the ProjectionExpression field's value.
func (s *Get) SetTableName(v string) *Get
SetTableName sets the TableName field's value.
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 (s *Get) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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). //