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 AWS 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
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
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
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
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
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
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 an item with the supplied primary key and number // (or set of numbers) for the attribute value. The only data types allowed // are number and number set; no other data types can be specified. 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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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. 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 AWS 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
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
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 AWS 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
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
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 provisioned 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
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
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
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
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 provisioned 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
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
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 BatchGetItem operation. For more // information, see RequestItems in the Request Parameters section. // // Each UnprocessedItems entry consists of a table name and, for that table, // a list of operations to perform (DeleteRequest or PutRequest). // // * DeleteRequest - Perform a DeleteItem operation on the specified item. // The item to be deleted is identified by a Key subelement: Key - A map // of primary key attribute values that uniquely identify the item. Each // entry in this map consists of an attribute name and an attribute value. // // * PutRequest - Perform a PutItem operation on the specified item. The // item to be put is identified by an Item subelement: Item - A map of attributes // and their values. Each entry in this map consists of an attribute name // and an attribute value. Attribute values must not be null; string and // binary type attributes must have lengths greater than zero; and set type // attributes must not be empty. Requests that contain empty values will // be rejected with a ValidationException exception. If you specify any attributes // that are part of an index key, then the data types for those attributes // must match those of the schema in the table's attribute definition. // // If there are no unprocessed items remaining, the response contains an empty // UnprocessedItems map. UnprocessedItems map[string][]*WriteRequest `min:"1" type:"map"` // contains filtered or unexported fields }
Represents the output of a BatchWriteItem operation.
func (s BatchWriteItemOutput) GoString() string
GoString returns the string representation
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
type BillingModeSummary struct { // Controls how you are charged for read and write throughput and how you manage // capacity. This setting can be changed later. // // * PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend // using PROVISIONED for predictable workloads. // // * PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. // We recommend using PAY_PER_REQUEST for unpredictable workloads. BillingMode *string `type:"string" enum:"BillingMode"` // Represents the time when PAY_PER_REQUEST was last set as the read/write capacity // mode. LastUpdateToPayPerRequestDateTime *time.Time `type:"timestamp"` // contains filtered or unexported fields }
Contains the details for the read/write capacity mode.
func (s BillingModeSummary) GoString() string
GoString returns the string representation
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
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
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
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
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
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
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
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. // // ConditionExpression is a required field ConditionExpression *string `type:"string" required:"true"` // One or more substitution tokens for attribute names in an expression. ExpressionAttributeNames map[string]*string `type:"map"` // One or more values that can be substituted in an expression. ExpressionAttributeValues map[string]*AttributeValue `type:"map"` // The primary key of the item to be checked. Each element consists of an attribute // name and a value for that attribute. // // Key is a required field Key map[string]*AttributeValue `type:"map" required:"true"` // Use ReturnValuesOnConditionCheckFailure to get the item attributes if the // ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, // the valid values are: NONE and ALL_OLD. ReturnValuesOnConditionCheckFailure *string `type:"string" enum:"ReturnValuesOnConditionCheckFailure"` // Name of the table for the check item request. // // TableName is a required field TableName *string `min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
Represents a request to perform a check that an item exists or to check the condition of specific attributes of the item.
func (s ConditionCheck) GoString() string
GoString returns the string representation
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
func (s *ConditionCheck) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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
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
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
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
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
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
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
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
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
func (s *CreateBackupOutput) SetBackupDetails(v *BackupDetails) *CreateBackupOutput
SetBackupDetails sets the BackupDetails field's value.
func (s CreateBackupOutput) String() string
String returns the string representation
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 Limits // (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
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
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
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
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
func (s *CreateGlobalTableOutput) SetGlobalTableDescription(v *GlobalTableDescription) *CreateGlobalTableOutput
SetGlobalTableDescription sets the GlobalTableDescription field's value.
func (s CreateGlobalTableOutput) String() string
String returns the string representation
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
func (s *CreateReplicaAction) SetRegionName(v string) *CreateReplicaAction
SetRegionName sets the RegionName field's value.
func (s CreateReplicaAction) String() string
String returns the string representation
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 AWS KMS customer master key (CMK) that should be used for AWS KMS encryption // in the new replica. To specify a CMK, 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 master 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"` // contains filtered or unexported fields }
Represents a replica to be created.
func (s CreateReplicationGroupMemberAction) GoString() string
GoString returns the string representation
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) String() string
String returns the string representation
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"` // 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 Limits // (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 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
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) 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) 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
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
func (s *CreateTableOutput) SetTableDescription(v *TableDescription) *CreateTableOutput
SetTableDescription sets the TableDescription field's value.
func (s CreateTableOutput) String() string
String returns the string representation
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
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
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
func (s *DeleteBackupInput) SetBackupArn(v string) *DeleteBackupInput
SetBackupArn sets the BackupArn field's value.
func (s DeleteBackupInput) String() string
String returns the string representation
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
func (s *DeleteBackupOutput) SetBackupDescription(v *BackupDescription) *DeleteBackupOutput
SetBackupDescription sets the BackupDescription field's value.
func (s DeleteBackupOutput) String() string
String returns the string representation
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
func (s *DeleteGlobalSecondaryIndexAction) SetIndexName(v string) *DeleteGlobalSecondaryIndexAction
SetIndexName sets the IndexName field's value.
func (s DeleteGlobalSecondaryIndexAction) String() string
String returns the string representation
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 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 provisioned 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. // // The ReturnValues parameter is used by several DynamoDB operations; however, // DeleteItem does not recognize any values other than NONE or ALL_OLD. ReturnValues *string `type:"string" enum:"ReturnValue"` // The name of the table from which to delete the item. // // TableName is a required field TableName *string `min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a DeleteItem operation.
func (s DeleteItemInput) GoString() string
GoString returns the string representation
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) SetTableName(v string) *DeleteItemInput
SetTableName sets the TableName field's value.
func (s DeleteItemInput) String() string
String returns the string representation
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 Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) // in the Amazon DynamoDB Developer Guide. ConsumedCapacity *ConsumedCapacity `type:"structure"` // Information about item collections, if any, that were affected by the DeleteItem // operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics // parameter was specified. If the table does not have any local secondary indexes, // this information is not returned in the response. // // Each ItemCollectionMetrics element consists of: // // * ItemCollectionKey - The partition key value of the item collection. // This is the same as the partition key value of the item itself. // // * SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. // This value is a two-element array containing a lower bound and an upper // bound for the estimate. The estimate includes the size of all the items // in the table, plus the size of all attributes projected into all of the // local secondary indexes on that table. Use this estimate to measure whether // a local secondary index is approaching its size limit. The estimate is // subject to change over time; therefore, do not rely on the precision or // accuracy of the estimate. ItemCollectionMetrics *ItemCollectionMetrics `type:"structure"` // contains filtered or unexported fields }
Represents the output of a DeleteItem operation.
func (s DeleteItemOutput) GoString() string
GoString returns the string representation
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
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
func (s *DeleteReplicaAction) SetRegionName(v string) *DeleteReplicaAction
SetRegionName sets the RegionName field's value.
func (s DeleteReplicaAction) String() string
String returns the string representation
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
func (s *DeleteReplicationGroupMemberAction) SetRegionName(v string) *DeleteReplicationGroupMemberAction
SetRegionName sets the RegionName field's value.
func (s DeleteReplicationGroupMemberAction) String() string
String returns the string representation
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
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
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
func (s *DeleteTableInput) SetTableName(v string) *DeleteTableInput
SetTableName sets the TableName field's value.
func (s DeleteTableInput) String() string
String returns the string representation
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
func (s *DeleteTableOutput) SetTableDescription(v *TableDescription) *DeleteTableOutput
SetTableDescription sets the TableDescription field's value.
func (s DeleteTableOutput) String() string
String returns the string representation
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
func (s *DescribeBackupInput) SetBackupArn(v string) *DescribeBackupInput
SetBackupArn sets the BackupArn field's value.
func (s DescribeBackupInput) String() string
String returns the string representation
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
func (s *DescribeBackupOutput) SetBackupDescription(v *BackupDescription) *DescribeBackupOutput
SetBackupDescription sets the BackupDescription field's value.
func (s DescribeBackupOutput) String() string
String returns the string representation
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
func (s *DescribeContinuousBackupsInput) SetTableName(v string) *DescribeContinuousBackupsInput
SetTableName sets the TableName field's value.
func (s DescribeContinuousBackupsInput) String() string
String returns the string representation
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
func (s *DescribeContinuousBackupsOutput) SetContinuousBackupsDescription(v *ContinuousBackupsDescription) *DescribeContinuousBackupsOutput
SetContinuousBackupsDescription sets the ContinuousBackupsDescription field's value.
func (s DescribeContinuousBackupsOutput) String() string
String returns the string representation
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
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
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 Alpine rules. ContributorInsightsRuleList []*string `type:"list"` // Current Status contributor insights. ContributorInsightsStatus *string `type:"string" enum:"ContributorInsightsStatus"` // Returns information about the last failure that 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
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
type DescribeEndpointsInput struct {
// contains filtered or unexported fields
}
func (s DescribeEndpointsInput) GoString() string
GoString returns the string representation
func (s DescribeEndpointsInput) String() string
String returns the string representation
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
func (s *DescribeEndpointsOutput) SetEndpoints(v []*Endpoint) *DescribeEndpointsOutput
SetEndpoints sets the Endpoints field's value.
func (s DescribeEndpointsOutput) String() string
String returns the string representation
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
func (s *DescribeGlobalTableInput) SetGlobalTableName(v string) *DescribeGlobalTableInput
SetGlobalTableName sets the GlobalTableName field's value.
func (s DescribeGlobalTableInput) String() string
String returns the string representation
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
func (s *DescribeGlobalTableOutput) SetGlobalTableDescription(v *GlobalTableDescription) *DescribeGlobalTableOutput
SetGlobalTableDescription sets the GlobalTableDescription field's value.
func (s DescribeGlobalTableOutput) String() string
String returns the string representation
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
func (s *DescribeGlobalTableSettingsInput) SetGlobalTableName(v string) *DescribeGlobalTableSettingsInput
SetGlobalTableName sets the GlobalTableName field's value.
func (s DescribeGlobalTableSettingsInput) String() string
String returns the string representation
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
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
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
func (s DescribeLimitsInput) String() string
String returns the string representation
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
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
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
func (s *DescribeTableInput) SetTableName(v string) *DescribeTableInput
SetTableName sets the TableName field's value.
func (s DescribeTableInput) String() string
String returns the string representation
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
func (s *DescribeTableOutput) SetTable(v *TableDescription) *DescribeTableOutput
SetTable sets the Table field's value.
func (s DescribeTableOutput) String() string
String returns the string representation
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
func (s *DescribeTableReplicaAutoScalingInput) SetTableName(v string) *DescribeTableReplicaAutoScalingInput
SetTableName sets the TableName field's value.
func (s DescribeTableReplicaAutoScalingInput) String() string
String returns the string representation
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
func (s *DescribeTableReplicaAutoScalingOutput) SetTableAutoScalingDescription(v *TableAutoScalingDescription) *DescribeTableReplicaAutoScalingOutput
SetTableAutoScalingDescription sets the TableAutoScalingDescription field's value.
func (s DescribeTableReplicaAutoScalingOutput) String() string
String returns the string representation
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
func (s *DescribeTimeToLiveInput) SetTableName(v string) *DescribeTimeToLiveInput
SetTableName sets the TableName field's value.
func (s DescribeTimeToLiveInput) String() string
String returns the string representation
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
func (s *DescribeTimeToLiveOutput) SetTimeToLiveDescription(v *TimeToLiveDescription) *DescribeTimeToLiveOutput
SetTimeToLiveDescription sets the TimeToLiveDescription field's value.
func (s DescribeTimeToLiveOutput) String() string
String returns the string representation
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) BatchGetItem(input *BatchGetItemInput) (*BatchGetItemOutput, error)
BatchGetItem API operation for Amazon DynamoDB.
The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.
A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem returns a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get.
If you request more than 100 items, BatchGetItem returns a ValidationException with the message "Too many items requested for the BatchGetItem call."
For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem returns a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations) in the Amazon DynamoDB Developer Guide.
By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.
In order to minimize response latency, BatchGetItem retrieves items in parallel.
When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the ProjectionExpression parameter.
If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Working with Tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations) in the Amazon DynamoDB Developer Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon DynamoDB's API operation BatchGetItem for usage and error information.
Returned Error Codes:
* ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" Your request rate is too high. The AWS 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. * ErrCodeResourceNotFoundException "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. * ErrCodeRequestLimitExceeded "RequestLimitExceeded" Throughput exceeds the current throughput limit for your account. Please contact AWS Support at AWS Support (https://aws.amazon.com/support) to request a limit increase. * ErrCodeInternalServerError "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 write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB.
BatchWriteItem cannot update items. To update items, use the UpdateItem action.
The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.
If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException.
If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.
For more information, see Batch Operations and Error Handling (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#Programming.Errors.BatchOperations) in the Amazon DynamoDB Developer Guide.
With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.
If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.
Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.
If one or more of the following is true, DynamoDB rejects the entire batch write operation:
* One or more tables specified in the BatchWriteItem request does not exist. * Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema. * You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request. * Your request contains at least two items with identical hash and range keys (which essentially is two put operations). * There are more than 25 requests in the batch. * Any individual item in a batch exceeds 400 KB. * The total request size exceeds 16 MB.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon DynamoDB's API operation BatchWriteItem for usage and error information.
Returned Error Codes:
* ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" Your request rate is too high. The AWS 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. * ErrCodeResourceNotFoundException "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. * ErrCodeItemCollectionSizeLimitExceededException "ItemCollectionSizeLimitExceededException" An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. * ErrCodeRequestLimitExceeded "RequestLimitExceeded" Throughput exceeds the current throughput limit for your account. Please contact AWS Support at AWS Support (https://aws.amazon.com/support) to request a limit increase. * ErrCodeInternalServerError "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 Codes:
* ErrCodeTableNotFoundException "TableNotFoundException" A source table with the name TableName does not currently exist within the subscriber's account. * ErrCodeTableInUseException "TableInUseException" A target table with the specified name is either being created or deleted. * ErrCodeContinuousBackupsUnavailableException "ContinuousBackupsUnavailableException" Backups have not yet been enabled for this table. * ErrCodeBackupInUseException "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. * ErrCodeLimitExceededException "LimitExceededException" There is no limit to the number of daily on-demand backups that can be taken. Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations. There is a soft account limit of 256 tables. * ErrCodeInternalServerError "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 method only applies to Version 2017.11.29 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables.
If you want to add a new replica table to a global table, each of the following conditions must be true:
* The table must have the same primary key as all of the other replicas. * The table must have the same name as all of the other replicas. * The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item. * None of the replica tables in the global table can contain any data.
If global secondary indexes are specified, then the following conditions must also be met:
* The global secondary indexes must have the same name. * The global secondary indexes must have the same hash key and sort key (if present).
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 Codes:
* ErrCodeLimitExceededException "LimitExceededException" There is no limit to the number of daily on-demand backups that can be taken. Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations. There is a soft account limit of 256 tables. * ErrCodeInternalServerError "InternalServerError" An error occurred on the server side. * ErrCodeGlobalTableAlreadyExistsException "GlobalTableAlreadyExistsException" The specified global table already exists. * ErrCodeTableNotFoundException "TableNotFoundException" A source table with the name TableName does not currently exist within the subscriber's account.
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 AWS 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 Codes:
* ErrCodeResourceInUseException "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. * ErrCodeLimitExceededException "LimitExceededException" There is no limit to the number of daily on-demand backups that can be taken. Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations. There is a soft account limit of 256 tables. * ErrCodeInternalServerError "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 Codes:
* ErrCodeBackupNotFoundException "BackupNotFoundException" Backup not found for the given BackupARN. * ErrCodeBackupInUseException "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. * ErrCodeLimitExceededException "LimitExceededException" There is no limit to the number of daily on-demand backups that can be taken. Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations. There is a soft account limit of 256 tables. * ErrCodeInternalServerError "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 Codes:
* ErrCodeConditionalCheckFailedException "ConditionalCheckFailedException" A condition specified in the operation could not be evaluated. * ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" Your request rate is too high. The AWS 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. * ErrCodeResourceNotFoundException "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. * ErrCodeItemCollectionSizeLimitExceededException "ItemCollectionSizeLimitExceededException" An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. * ErrCodeTransactionConflictException "TransactionConflictException" Operation was rejected because there is an ongoing transaction for the item. * ErrCodeRequestLimitExceeded "RequestLimitExceeded" Throughput exceeds the current throughput limit for your account. Please contact AWS Support at AWS Support (https://aws.amazon.com/support) to request a limit increase. * ErrCodeInternalServerError "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.
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 Codes:
* ErrCodeResourceInUseException "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. * ErrCodeResourceNotFoundException "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. * ErrCodeLimitExceededException "LimitExceededException" There is no limit to the number of daily on-demand backups that can be taken. Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations. There is a soft account limit of 256 tables. * ErrCodeInternalServerError "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 Codes:
* ErrCodeBackupNotFoundException "BackupNotFoundException" Backup not found for the given BackupARN. * ErrCodeInternalServerError "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 Codes:
* ErrCodeTableNotFoundException "TableNotFoundException" A source table with the name TableName does not currently exist within the subscriber's account. * ErrCodeInternalServerError "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 Codes:
* ErrCodeResourceNotFoundException "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. * ErrCodeInternalServerError "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.
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) DescribeGlobalTable(input *DescribeGlobalTableInput) (*DescribeGlobalTableOutput, error)
DescribeGlobalTable API operation for Amazon DynamoDB.
Returns information about the specified global table.
This method only applies to Version 2017.11.29 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon DynamoDB's API operation DescribeGlobalTable for usage and error information.
Returned Error Codes:
* ErrCodeInternalServerError "InternalServerError" An error occurred on the server side. * ErrCodeGlobalTableNotFoundException "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 method only applies to Version 2017.11.29 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon DynamoDB's API operation DescribeGlobalTableSettings for usage and error information.
Returned Error Codes:
* ErrCodeGlobalTableNotFoundException "GlobalTableNotFoundException" The specified global table does not exist. * ErrCodeInternalServerError "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) DescribeLimits(input *DescribeLimitsInput) (*DescribeLimitsOutput, error)
DescribeLimits API operation for Amazon DynamoDB.
Returns the current provisioned-capacity limits for your AWS 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 AWS account, the account has initial limits 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 limits that apply when you create a table there. For more information, see Limits (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) page in the Amazon DynamoDB Developer Guide.
Although you can increase these limits by filing a case at AWS 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 limits imposed by your account so that you have enough time to apply for an increase before you hit a limit.
For example, you could use one of the AWS SDKs to do the following:
Call DescribeLimits for a particular Region to obtain your current account limits 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 limits 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 limits.
The per-table limits 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 upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits.
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 Codes:
* ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.
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.
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 Codes:
* ErrCodeResourceNotFoundException "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. * ErrCodeInternalServerError "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 method only applies to Version 2019.11.21 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) of global tables.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon DynamoDB's API operation DescribeTableReplicaAutoScaling for usage and error information.
Returned Error Codes:
* ErrCodeResourceNotFoundException "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. * ErrCodeInternalServerError "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 Codes:
* ErrCodeResourceNotFoundException "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. * ErrCodeInternalServerError "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) 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 Codes:
* ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" Your request rate is too high. The AWS 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. * ErrCodeResourceNotFoundException "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. * ErrCodeRequestLimitExceeded "RequestLimitExceeded" Throughput exceeds the current throughput limit for your account. Please contact AWS Support at AWS Support (https://aws.amazon.com/support) to request a limit increase. * ErrCodeInternalServerError "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) ListBackups(input *ListBackupsInput) (*ListBackupsOutput, error)
ListBackups API operation for Amazon DynamoDB.
List backups associated with an AWS account. To list backups for a given table, specify TableName. ListBackups returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a limit for the 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 limits are for the time at which the original backup was requested.
You can call ListBackups a maximum of five times per second.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon DynamoDB's API operation ListBackups for usage and error information.
Returned Error Codes:
* ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.
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 Codes:
* ErrCodeResourceNotFoundException "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. * ErrCodeInternalServerError "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) ListGlobalTables(input *ListGlobalTablesInput) (*ListGlobalTablesOutput, error)
ListGlobalTables API operation for Amazon DynamoDB.
Lists all global tables that have a replica in the specified Region.
This method only applies to Version 2017.11.29 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V1.html) of global tables.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon DynamoDB's API operation ListGlobalTables for usage and error information.
Returned Error Codes:
* ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.
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) 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 Codes:
* ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.
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 Codes:
* ErrCodeResourceNotFoundException "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. * ErrCodeInternalServerError "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.
This topic provides general information about the PutItem API.
For information on how to call the PutItem API using the AWS SDK in specific languages, see the following:
* PutItem in the AWS Command Line Interface (http://docs.aws.amazon.com/goto/aws-cli/dynamodb-2012-08-10/PutItem) * PutItem in the AWS SDK for .NET (http://docs.aws.amazon.com/goto/DotNetSDKV3/dynamodb-2012-08-10/PutItem) * PutItem in the AWS SDK for C++ (http://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/PutItem) * PutItem in the AWS SDK for Go (http://docs.aws.amazon.com/goto/SdkForGoV1/dynamodb-2012-08-10/PutItem) * PutItem in the AWS SDK for Java (http://docs.aws.amazon.com/goto/SdkForJava/dynamodb-2012-08-10/PutItem) * PutItem in the AWS SDK for JavaScript (http://docs.aws.amazon.com/goto/AWSJavaScriptSDK/dynamodb-2012-08-10/PutItem) * PutItem in the AWS SDK for PHP V3 (http://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/PutItem) * PutItem in the AWS SDK for Python (http://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/PutItem) * PutItem in the AWS SDK for Ruby V2 (http://docs.aws.amazon.com/goto/SdkForRubyV2/dynamodb-2012-08-10/PutItem)
When you add an item, the primary key attributes are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. 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 Codes:
* ErrCodeConditionalCheckFailedException "ConditionalCheckFailedException" A condition specified in the operation could not be evaluated. * ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" Your request rate is too high. The AWS 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. * ErrCodeResourceNotFoundException "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. * ErrCodeItemCollectionSizeLimitExceededException "ItemCollectionSizeLimitExceededException" An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. * ErrCodeTransactionConflictException "TransactionConflictException" Operation was rejected because there is an ongoing transaction for the item. * ErrCodeRequestLimitExceeded "RequestLimitExceeded" Throughput exceeds the current throughput limit for your account. Please contact AWS Support at AWS Support (https://aws.amazon.com/support) to request a limit increase. * ErrCodeInternalServerError "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.
The Query operation finds items based on primary key values. You can query any table or secondary index that has a composite primary key (a partition key and a sort key).
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 Codes:
* ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" Your request rate is too high. The AWS 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. * ErrCodeResourceNotFoundException "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. * ErrCodeRequestLimitExceeded "RequestLimitExceeded" Throughput exceeds the current throughput limit for your account. Please contact AWS Support at AWS Support (https://aws.amazon.com/support) to request a limit increase. * ErrCodeInternalServerError "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 4 concurrent restores (any type of restore) in a given account.
You can call RestoreTableFromBackup at a maximum rate of 10 times per second.
You must manually set up the following on the restored table:
* Auto scaling policies * IAM policies * Amazon CloudWatch metrics and alarms * Tags * Stream settings * Time to Live (TTL) settings
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon DynamoDB's API operation RestoreTableFromBackup for usage and error information.
Returned Error Codes:
* ErrCodeTableAlreadyExistsException "TableAlreadyExistsException" A target table with the specified name already exists. * ErrCodeTableInUseException "TableInUseException" A target table with the specified name is either being created or deleted. * ErrCodeBackupNotFoundException "BackupNotFoundException" Backup not found for the given BackupARN. * ErrCodeBackupInUseException "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. * ErrCodeLimitExceededException "LimitExceededException" There is no limit to the number of daily on-demand backups that can be taken. Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations. There is a soft account limit of 256 tables. * ErrCodeInternalServerError "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 Codes:
* ErrCodeTableAlreadyExistsException "TableAlreadyExistsException" A target table with the specified name already exists. * ErrCodeTableNotFoundException "TableNotFoundException" A source table with the name TableName does not currently exist within the subscriber's account. * ErrCodeTableInUseException "TableInUseException" A target table with the specified name is either being created or deleted. * ErrCodeLimitExceededException "LimitExceededException" There is no limit to the number of daily on-demand backups that can be taken. Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations. There is a soft account limit of 256 tables. * ErrCodeInvalidRestoreTimeException "InvalidRestoreTimeException" An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime. * ErrCodePointInTimeRecoveryUnavailableException "PointInTimeRecoveryUnavailableException" Point in time recovery has not yet been enabled for this source table. * ErrCodeInternalServerError "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 number of scanned items exceeds the maximum dataset size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.
A single Scan operation reads up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you need to paginate the result set. For more information, see Paginating the Results (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination) in the Amazon DynamoDB Developer Guide.
Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan) in the Amazon DynamoDB Developer Guide.
Scan uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the ConsistentRead parameter to true.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon DynamoDB's API operation Scan for usage and error information.
Returned Error Codes:
* ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" Your request rate is too high. The AWS 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. * ErrCodeResourceNotFoundException "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. * ErrCodeRequestLimitExceeded "RequestLimitExceeded" Throughput exceeds the current throughput limit for your account. Please contact AWS Support at AWS Support (https://aws.amazon.com/support) to request a limit increase. * ErrCodeInternalServerError "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 Codes:
* ErrCodeLimitExceededException "LimitExceededException" There is no limit to the number of daily on-demand backups that can be taken. Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations. There is a soft account limit of 256 tables. * ErrCodeResourceNotFoundException "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. * ErrCodeInternalServerError "InternalServerError" An error occurred on the server side. * ErrCodeResourceInUseException "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 25 TransactGetItem objects, each of which contains a Get structure that specifies an item to retrieve from a table in the account and Region. A call to TransactGetItems cannot retrieve items from tables in more than one AWS account or Region. The aggregate size of the items in the transaction cannot exceed 4 MB.
DynamoDB rejects the entire TransactGetItems request if any of the following is true:
* A conflicting operation is in the process of updating an item to be read. * There is insufficient provisioned capacity for the transaction to be completed. * There is a user error, such as an invalid data format. * The aggregate size of the items in the transaction cannot exceed 4 MB.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon DynamoDB's API operation TransactGetItems for usage and error information.
Returned Error Codes:
* ErrCodeResourceNotFoundException "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. * ErrCodeTransactionCanceledException "TransactionCanceledException" The entire transaction request was canceled. DynamoDB cancels a TransactWriteItems request under the following circumstances: * A condition in one of the condition expressions is not met. * A table in the TransactWriteItems request is in a different account or region. * More than one action in the TransactWriteItems operation targets the same item. * There is insufficient provisioned capacity for the transaction to be completed. * An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction. * There is a user error, such as an invalid data format. DynamoDB cancels a TransactGetItems request under the following circumstances: * There is an ongoing TransactGetItems operation that conflicts with a concurrent PutItem, UpdateItem, DeleteItem or TransactWriteItems request. In this case the TransactGetItems operation fails with a TransactionCanceledException. * A table in the TransactGetItems request is in a different account or region. * There is insufficient provisioned capacity for the transaction to be completed. * There is a user error, such as an invalid data format. If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have NONE code and Null message. Cancellation reason codes and possible error messages: * No Errors: Code: NONE Message: null * Conditional Check Failed: Code: ConditionalCheckFailed Message: The conditional request failed. * Item Collection Size Limit Exceeded: Code: ItemCollectionSizeLimitExceeded Message: Collection size exceeded. * Transaction Conflict: Code: TransactionConflict Message: Transaction is ongoing for the item. * Provisioned Throughput Exceeded: Code: ProvisionedThroughputExceeded Messages: The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API. This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table. The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API. This message is returned when provisioned throughput is exceeded is on a provisioned GSI. * Throttling Error: Code: ThrottlingError Messages: Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html. This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table. Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly. This message is returned when when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI. * Validation Error: Code: ValidationError Messages: One or more parameter values were invalid. The update expression attempted to update the secondary index key beyond allowed size limits. The update expression attempted to update the secondary index key to unsupported type. An operand in the update expression has an incorrect data type. Item size to update has exceeded the maximum allowed size. Number overflow. Attempting to store a number with magnitude larger than supported range. Type mismatch for attribute to update. Nesting Levels have exceeded supported limits. The document path provided in the update expression is invalid for update. The provided expression refers to an attribute that does not exist in the item. * ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" Your request rate is too high. The AWS 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. * ErrCodeRequestLimitExceeded "RequestLimitExceeded" Throughput exceeds the current throughput limit for your account. Please contact AWS Support at AWS Support (https://aws.amazon.com/support) to request a limit increase. * ErrCodeInternalServerError "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 25 action requests. These actions can target items in different tables, but not in different AWS 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 Codes:
* ErrCodeResourceNotFoundException "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. * ErrCodeTransactionCanceledException "TransactionCanceledException" The entire transaction request was canceled. DynamoDB cancels a TransactWriteItems request under the following circumstances: * A condition in one of the condition expressions is not met. * A table in the TransactWriteItems request is in a different account or region. * More than one action in the TransactWriteItems operation targets the same item. * There is insufficient provisioned capacity for the transaction to be completed. * An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction. * There is a user error, such as an invalid data format. DynamoDB cancels a TransactGetItems request under the following circumstances: * There is an ongoing TransactGetItems operation that conflicts with a concurrent PutItem, UpdateItem, DeleteItem or TransactWriteItems request. In this case the TransactGetItems operation fails with a TransactionCanceledException. * A table in the TransactGetItems request is in a different account or region. * There is insufficient provisioned capacity for the transaction to be completed. * There is a user error, such as an invalid data format. If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have NONE code and Null message. Cancellation reason codes and possible error messages: * No Errors: Code: NONE Message: null * Conditional Check Failed: Code: ConditionalCheckFailed Message: The conditional request failed. * Item Collection Size Limit Exceeded: Code: ItemCollectionSizeLimitExceeded Message: Collection size exceeded. * Transaction Conflict: Code: TransactionConflict Message: Transaction is ongoing for the item. * Provisioned Throughput Exceeded: Code: ProvisionedThroughputExceeded Messages: The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API. This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table. The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API. This message is returned when provisioned throughput is exceeded is on a provisioned GSI. * Throttling Error: Code: ThrottlingError Messages: Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html. This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table. Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly. This message is returned when when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI. * Validation Error: Code: ValidationError Messages: One or more parameter values were invalid. The update expression attempted to update the secondary index key beyond allowed size limits. The update expression attempted to update the secondary index key to unsupported type. An operand in the update expression has an incorrect data type. Item size to update has exceeded the maximum allowed size. Number overflow. Attempting to store a number with magnitude larger than supported range. Type mismatch for attribute to update. Nesting Levels have exceeded supported limits. The document path provided in the update expression is invalid for update. The provided expression refers to an attribute that does not exist in the item. * ErrCodeTransactionInProgressException "TransactionInProgressException" The transaction with the given request token is already in progress. * ErrCodeIdempotentParameterMismatchException "IdempotentParameterMismatchException" DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used. * ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" Your request rate is too high. The AWS 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. * ErrCodeRequestLimitExceeded "RequestLimitExceeded" Throughput exceeds the current throughput limit for your account. Please contact AWS Support at AWS Support (https://aws.amazon.com/support) to request a limit increase. * ErrCodeInternalServerError "InternalServerError" An error occurred on the server side.
See also, https://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/TransactWriteItems
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 Codes:
* ErrCodeLimitExceededException "LimitExceededException" There is no limit to the number of daily on-demand backups that can be taken. Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations. There is a soft account limit of 256 tables. * ErrCodeResourceNotFoundException "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. * ErrCodeInternalServerError "InternalServerError" An error occurred on the server side. * ErrCodeResourceInUseException "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 Codes:
* ErrCodeTableNotFoundException "TableNotFoundException" A source table with the name TableName does not currently exist within the subscriber's account. * ErrCodeContinuousBackupsUnavailableException "ContinuousBackupsUnavailableException" Backups have not yet been enabled for this table. * ErrCodeInternalServerError "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.
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 Codes:
* ErrCodeResourceNotFoundException "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. * ErrCodeInternalServerError "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.
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 Codes:
* ErrCodeInternalServerError "InternalServerError" An error occurred on the server side. * ErrCodeGlobalTableNotFoundException "GlobalTableNotFoundException" The specified global table does not exist. * ErrCodeReplicaAlreadyExistsException "ReplicaAlreadyExistsException" The specified replica is already part of the global table. * ErrCodeReplicaNotFoundException "ReplicaNotFoundException" The specified replica is no longer part of the global table. * ErrCodeTableNotFoundException "TableNotFoundException" A source table with the name TableName does not currently exist within the subscriber's account.
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.
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 Codes:
* ErrCodeGlobalTableNotFoundException "GlobalTableNotFoundException" The specified global table does not exist. * ErrCodeReplicaNotFoundException "ReplicaNotFoundException" The specified replica is no longer part of the global table. * ErrCodeIndexNotFoundException "IndexNotFoundException" The operation tried to access a nonexistent index. * ErrCodeLimitExceededException "LimitExceededException" There is no limit to the number of daily on-demand backups that can be taken. Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations. There is a soft account limit of 256 tables. * ErrCodeResourceInUseException "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. * ErrCodeInternalServerError "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 Codes:
* ErrCodeConditionalCheckFailedException "ConditionalCheckFailedException" A condition specified in the operation could not be evaluated. * ErrCodeProvisionedThroughputExceededException "ProvisionedThroughputExceededException" Your request rate is too high. The AWS 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. * ErrCodeResourceNotFoundException "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. * ErrCodeItemCollectionSizeLimitExceededException "ItemCollectionSizeLimitExceededException" An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes. * ErrCodeTransactionConflictException "TransactionConflictException" Operation was rejected because there is an ongoing transaction for the item. * ErrCodeRequestLimitExceeded "RequestLimitExceeded" Throughput exceeds the current throughput limit for your account. Please contact AWS Support at AWS Support (https://aws.amazon.com/support) to request a limit increase. * ErrCodeInternalServerError "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.
You can only perform one of the following operations at once:
* Modify the provisioned throughput settings of the table. * Enable or disable DynamoDB Streams on 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 Codes:
* ErrCodeResourceInUseException "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. * ErrCodeResourceNotFoundException "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. * ErrCodeLimitExceededException "LimitExceededException" There is no limit to the number of daily on-demand backups that can be taken. Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations. There is a soft account limit of 256 tables. * ErrCodeInternalServerError "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 method only applies to Version 2019.11.21 (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) of global tables.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for Amazon DynamoDB's API operation UpdateTableReplicaAutoScaling for usage and error information.
Returned Error Codes:
* ErrCodeResourceNotFoundException "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. * ErrCodeResourceInUseException "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. * ErrCodeLimitExceededException "LimitExceededException" There is no limit to the number of daily on-demand backups that can be taken. Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations. There is a soft account limit of 256 tables. * ErrCodeInternalServerError "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 Codes:
* ErrCodeResourceInUseException "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. * ErrCodeResourceNotFoundException "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. * ErrCodeLimitExceededException "LimitExceededException" There is no limit to the number of daily on-demand backups that can be taken. Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations. There is a soft account limit of 256 tables. * ErrCodeInternalServerError "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 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
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
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
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
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
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
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
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
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 provisioned throughput consumption that // is returned in the response: // // * INDEXES - The response includes the aggregate ConsumedCapacity for the // operation, together with ConsumedCapacity for each table and secondary // index that was accessed. Note that some operations, such as GetItem and // BatchGetItem, do not access any indexes at all. In these cases, specifying // INDEXES will only return ConsumedCapacity information for table(s). // // * TOTAL - The response includes only the aggregate ConsumedCapacity for // the operation. // // * NONE - No ConsumedCapacity details are included in the response. ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"` // The name of the table containing the requested item. // // TableName is a required field TableName *string `min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a GetItem operation.
func (s GetItemInput) GoString() string
GoString returns the string representation
func (s *GetItemInput) SetAttributesToGet(v []*string) *GetItemInput
SetAttributesToGet sets the AttributesToGet field's value.
func (s *GetItemInput) SetConsistentRead(v bool) *GetItemInput
SetConsistentRead sets the ConsistentRead field's value.
func (s *GetItemInput) SetExpressionAttributeNames(v map[string]*string) *GetItemInput
SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.
func (s *GetItemInput) SetKey(v map[string]*AttributeValue) *GetItemInput
SetKey sets the Key field's value.
func (s *GetItemInput) SetProjectionExpression(v string) *GetItemInput
SetProjectionExpression sets the ProjectionExpression field's value.
func (s *GetItemInput) SetReturnConsumedCapacity(v string) *GetItemInput
SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.
func (s *GetItemInput) SetTableName(v string) *GetItemInput
SetTableName sets the TableName field's value.
func (s GetItemInput) String() string
String returns the string representation
func (s *GetItemInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetItemOutput struct { // The capacity units consumed by the GetItem operation. The data returned includes // the total provisioned throughput consumed, along with statistics for the // table and any indexes involved in the operation. ConsumedCapacity is only // returned if the ReturnConsumedCapacity parameter was specified. For more // information, see Read/Write Capacity Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) // in the Amazon DynamoDB Developer Guide. ConsumedCapacity *ConsumedCapacity `type:"structure"` // A map of attribute names to AttributeValue objects, as specified by ProjectionExpression. Item map[string]*AttributeValue `type:"map"` // contains filtered or unexported fields }
Represents the output of a GetItem operation.
func (s GetItemOutput) GoString() string
GoString returns the string representation
func (s *GetItemOutput) SetConsumedCapacity(v *ConsumedCapacity) *GetItemOutput
SetConsumedCapacity sets the ConsumedCapacity field's value.
func (s *GetItemOutput) SetItem(v map[string]*AttributeValue) *GetItemOutput
SetItem sets the Item field's value.
func (s GetItemOutput) String() string
String returns the string representation
type GlobalSecondaryIndex struct { // The name of the global secondary index. The name must be unique among all // other indexes on this table. // // IndexName is a required field IndexName *string `min:"3" type:"string" required:"true"` // The complete key schema for a global secondary index, which consists of one // or more pairs of attribute names and key types: // // * HASH - partition key // // * RANGE - sort key // // The partition key of an item is also known as its hash attribute. The term // "hash attribute" derives from DynamoDB's usage of an internal hash function // to evenly distribute data items across partitions, based on their partition // key values. // // The sort key of an item is also known as its range attribute. The term "range // attribute" derives from the way DynamoDB stores items with the same partition // key physically close together, in sorted order by the sort key value. // // KeySchema is a required field KeySchema []*KeySchemaElement `min:"1" type:"list" required:"true"` // Represents attributes that are copied (projected) from the table into the // global secondary index. These are in addition to the primary key attributes // and index key attributes, which are automatically projected. // // Projection is a required field Projection *Projection `type:"structure" required:"true"` // Represents the provisioned throughput settings for the specified global secondary // index. // // For current minimum and maximum provisioned throughput values, see Limits // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) // in the Amazon DynamoDB Developer Guide. ProvisionedThroughput *ProvisionedThroughput `type:"structure"` // contains filtered or unexported fields }
Represents the properties of a global secondary index.
func (s GlobalSecondaryIndex) GoString() string
GoString returns the string representation
func (s *GlobalSecondaryIndex) SetIndexName(v string) *GlobalSecondaryIndex
SetIndexName sets the IndexName field's value.
func (s *GlobalSecondaryIndex) SetKeySchema(v []*KeySchemaElement) *GlobalSecondaryIndex
SetKeySchema sets the KeySchema field's value.
func (s *GlobalSecondaryIndex) SetProjection(v *Projection) *GlobalSecondaryIndex
SetProjection sets the Projection field's value.
func (s *GlobalSecondaryIndex) SetProvisionedThroughput(v *ProvisionedThroughput) *GlobalSecondaryIndex
SetProvisionedThroughput sets the ProvisionedThroughput field's value.
func (s GlobalSecondaryIndex) String() string
String returns the string representation
func (s *GlobalSecondaryIndex) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GlobalSecondaryIndexAutoScalingUpdate struct { // The name of the global secondary index. IndexName *string `min:"3" type:"string"` // Represents the auto scaling settings to be modified for a global table or // global secondary index. ProvisionedWriteCapacityAutoScalingUpdate *AutoScalingSettingsUpdate `type:"structure"` // contains filtered or unexported fields }
Represents the auto scaling settings of a global secondary index for a global table that will be modified.
func (s GlobalSecondaryIndexAutoScalingUpdate) GoString() string
GoString returns the string representation
func (s *GlobalSecondaryIndexAutoScalingUpdate) SetIndexName(v string) *GlobalSecondaryIndexAutoScalingUpdate
SetIndexName sets the IndexName field's value.
func (s *GlobalSecondaryIndexAutoScalingUpdate) SetProvisionedWriteCapacityAutoScalingUpdate(v *AutoScalingSettingsUpdate) *GlobalSecondaryIndexAutoScalingUpdate
SetProvisionedWriteCapacityAutoScalingUpdate sets the ProvisionedWriteCapacityAutoScalingUpdate field's value.
func (s GlobalSecondaryIndexAutoScalingUpdate) String() string
String returns the string representation
func (s *GlobalSecondaryIndexAutoScalingUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GlobalSecondaryIndexDescription struct { // Indicates whether the index is currently backfilling. Backfilling is the // process of reading items from the table and determining whether they can // be added to the index. (Not all items will qualify: For example, a partition // key cannot have any duplicate values.) If an item can be added to the index, // DynamoDB will do so. After all items have been processed, the backfilling // operation is complete and Backfilling is false. // // You can delete an index that is being created during the Backfilling phase // when IndexStatus is set to CREATING and Backfilling is true. You can't delete // the index that is being created when IndexStatus is set to CREATING and Backfilling // is false. // // For indexes that were created during a CreateTable operation, the Backfilling // attribute does not appear in the DescribeTable output. Backfilling *bool `type:"boolean"` // The Amazon Resource Name (ARN) that uniquely identifies the index. IndexArn *string `type:"string"` // The name of the global secondary index. IndexName *string `min:"3" type:"string"` // The total size of the specified index, in bytes. DynamoDB updates this value // approximately every six hours. Recent changes might not be reflected in this // value. IndexSizeBytes *int64 `type:"long"` // The current state of the global secondary index: // // * CREATING - The index is being created. // // * UPDATING - The index is being updated. // // * DELETING - The index is being deleted. // // * ACTIVE - The index is ready for use. IndexStatus *string `type:"string" enum:"IndexStatus"` // The number of items in the specified index. DynamoDB updates this value approximately // every six hours. Recent changes might not be reflected in this value. ItemCount *int64 `type:"long"` // The complete key schema for a global secondary index, which consists of one // or more pairs of attribute names and key types: // // * HASH - partition key // // * RANGE - sort key // // The partition key of an item is also known as its hash attribute. The term // "hash attribute" derives from DynamoDB's usage of an internal hash function // to evenly distribute data items across partitions, based on their partition // key values. // // The sort key of an item is also known as its range attribute. The term "range // attribute" derives from the way DynamoDB stores items with the same partition // key physically close together, in sorted order by the sort key value. KeySchema []*KeySchemaElement `min:"1" type:"list"` // Represents attributes that are copied (projected) from the table into the // global secondary index. These are in addition to the primary key attributes // and index key attributes, which are automatically projected. Projection *Projection `type:"structure"` // Represents the provisioned throughput settings for the specified global secondary // index. // // For current minimum and maximum provisioned throughput values, see Limits // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) // in the Amazon DynamoDB Developer Guide. ProvisionedThroughput *ProvisionedThroughputDescription `type:"structure"` // contains filtered or unexported fields }
Represents the properties of a global secondary index.
func (s GlobalSecondaryIndexDescription) GoString() string
GoString returns the string representation
func (s *GlobalSecondaryIndexDescription) SetBackfilling(v bool) *GlobalSecondaryIndexDescription
SetBackfilling sets the Backfilling field's value.
func (s *GlobalSecondaryIndexDescription) SetIndexArn(v string) *GlobalSecondaryIndexDescription
SetIndexArn sets the IndexArn field's value.
func (s *GlobalSecondaryIndexDescription) SetIndexName(v string) *GlobalSecondaryIndexDescription
SetIndexName sets the IndexName field's value.
func (s *GlobalSecondaryIndexDescription) SetIndexSizeBytes(v int64) *GlobalSecondaryIndexDescription
SetIndexSizeBytes sets the IndexSizeBytes field's value.
func (s *GlobalSecondaryIndexDescription) SetIndexStatus(v string) *GlobalSecondaryIndexDescription
SetIndexStatus sets the IndexStatus field's value.
func (s *GlobalSecondaryIndexDescription) SetItemCount(v int64) *GlobalSecondaryIndexDescription
SetItemCount sets the ItemCount field's value.
func (s *GlobalSecondaryIndexDescription) SetKeySchema(v []*KeySchemaElement) *GlobalSecondaryIndexDescription
SetKeySchema sets the KeySchema field's value.
func (s *GlobalSecondaryIndexDescription) SetProjection(v *Projection) *GlobalSecondaryIndexDescription
SetProjection sets the Projection field's value.
func (s *GlobalSecondaryIndexDescription) SetProvisionedThroughput(v *ProvisionedThroughputDescription) *GlobalSecondaryIndexDescription
SetProvisionedThroughput sets the ProvisionedThroughput field's value.
func (s GlobalSecondaryIndexDescription) String() string
String returns the string representation
type GlobalSecondaryIndexInfo struct { // The name of the global secondary index. IndexName *string `min:"3" type:"string"` // The complete key schema for a global secondary index, which consists of one // or more pairs of attribute names and key types: // // * HASH - partition key // // * RANGE - sort key // // The partition key of an item is also known as its hash attribute. The term // "hash attribute" derives from DynamoDB's usage of an internal hash function // to evenly distribute data items across partitions, based on their partition // key values. // // The sort key of an item is also known as its range attribute. The term "range // attribute" derives from the way DynamoDB stores items with the same partition // key physically close together, in sorted order by the sort key value. KeySchema []*KeySchemaElement `min:"1" type:"list"` // Represents attributes that are copied (projected) from the table into the // global secondary index. These are in addition to the primary key attributes // and index key attributes, which are automatically projected. Projection *Projection `type:"structure"` // Represents the provisioned throughput settings for the specified global secondary // index. ProvisionedThroughput *ProvisionedThroughput `type:"structure"` // contains filtered or unexported fields }
Represents the properties of a global secondary index for the table when the backup was created.
func (s GlobalSecondaryIndexInfo) GoString() string
GoString returns the string representation
func (s *GlobalSecondaryIndexInfo) SetIndexName(v string) *GlobalSecondaryIndexInfo
SetIndexName sets the IndexName field's value.
func (s *GlobalSecondaryIndexInfo) SetKeySchema(v []*KeySchemaElement) *GlobalSecondaryIndexInfo
SetKeySchema sets the KeySchema field's value.
func (s *GlobalSecondaryIndexInfo) SetProjection(v *Projection) *GlobalSecondaryIndexInfo
SetProjection sets the Projection field's value.
func (s *GlobalSecondaryIndexInfo) SetProvisionedThroughput(v *ProvisionedThroughput) *GlobalSecondaryIndexInfo
SetProvisionedThroughput sets the ProvisionedThroughput field's value.
func (s GlobalSecondaryIndexInfo) String() string
String returns the string representation
type GlobalSecondaryIndexUpdate struct { // The parameters required for creating a global secondary index on an existing // table: // // * IndexName // // * KeySchema // // * AttributeDefinitions // // * Projection // // * ProvisionedThroughput Create *CreateGlobalSecondaryIndexAction `type:"structure"` // The name of an existing global secondary index to be removed. Delete *DeleteGlobalSecondaryIndexAction `type:"structure"` // The name of an existing global secondary index, along with new provisioned // throughput settings to be applied to that index. Update *UpdateGlobalSecondaryIndexAction `type:"structure"` // contains filtered or unexported fields }
Represents one of the following:
* A new global secondary index to be added to an existing table. * New provisioned throughput parameters for an existing global secondary index. * An existing global secondary index to be removed from an existing table.
func (s GlobalSecondaryIndexUpdate) GoString() string
GoString returns the string representation
func (s *GlobalSecondaryIndexUpdate) SetCreate(v *CreateGlobalSecondaryIndexAction) *GlobalSecondaryIndexUpdate
SetCreate sets the Create field's value.
func (s *GlobalSecondaryIndexUpdate) SetDelete(v *DeleteGlobalSecondaryIndexAction) *GlobalSecondaryIndexUpdate
SetDelete sets the Delete field's value.
func (s *GlobalSecondaryIndexUpdate) SetUpdate(v *UpdateGlobalSecondaryIndexAction) *GlobalSecondaryIndexUpdate
SetUpdate sets the Update field's value.
func (s GlobalSecondaryIndexUpdate) String() string
String returns the string representation
func (s *GlobalSecondaryIndexUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GlobalTable struct { // The global table name. GlobalTableName *string `min:"3" type:"string"` // The Regions where the global table has replicas. ReplicationGroup []*Replica `type:"list"` // contains filtered or unexported fields }
Represents the properties of a global table.
func (s GlobalTable) GoString() string
GoString returns the string representation
func (s *GlobalTable) SetGlobalTableName(v string) *GlobalTable
SetGlobalTableName sets the GlobalTableName field's value.
func (s *GlobalTable) SetReplicationGroup(v []*Replica) *GlobalTable
SetReplicationGroup sets the ReplicationGroup field's value.
func (s GlobalTable) String() string
String returns the string representation
type GlobalTableDescription struct { // The creation time of the global table. CreationDateTime *time.Time `type:"timestamp"` // The unique identifier of the global table. GlobalTableArn *string `type:"string"` // The global table name. GlobalTableName *string `min:"3" type:"string"` // The current state of the global table: // // * CREATING - The global table is being created. // // * UPDATING - The global table is being updated. // // * DELETING - The global table is being deleted. // // * ACTIVE - The global table is ready for use. GlobalTableStatus *string `type:"string" enum:"GlobalTableStatus"` // The Regions where the global table has replicas. ReplicationGroup []*ReplicaDescription `type:"list"` // contains filtered or unexported fields }
Contains details about the global table.
func (s GlobalTableDescription) GoString() string
GoString returns the string representation
func (s *GlobalTableDescription) SetCreationDateTime(v time.Time) *GlobalTableDescription
SetCreationDateTime sets the CreationDateTime field's value.
func (s *GlobalTableDescription) SetGlobalTableArn(v string) *GlobalTableDescription
SetGlobalTableArn sets the GlobalTableArn field's value.
func (s *GlobalTableDescription) SetGlobalTableName(v string) *GlobalTableDescription
SetGlobalTableName sets the GlobalTableName field's value.
func (s *GlobalTableDescription) SetGlobalTableStatus(v string) *GlobalTableDescription
SetGlobalTableStatus sets the GlobalTableStatus field's value.
func (s *GlobalTableDescription) SetReplicationGroup(v []*ReplicaDescription) *GlobalTableDescription
SetReplicationGroup sets the ReplicationGroup field's value.
func (s GlobalTableDescription) String() string
String returns the string representation
type GlobalTableGlobalSecondaryIndexSettingsUpdate struct { // The name of the global secondary index. The name must be unique among all // other indexes on this table. // // IndexName is a required field IndexName *string `min:"3" type:"string" required:"true"` // Auto scaling settings for managing a global secondary index's write capacity // units. ProvisionedWriteCapacityAutoScalingSettingsUpdate *AutoScalingSettingsUpdate `type:"structure"` // The maximum number of writes consumed per second before DynamoDB returns // a ThrottlingException. ProvisionedWriteCapacityUnits *int64 `min:"1" type:"long"` // contains filtered or unexported fields }
Represents the settings of a global secondary index for a global table that will be modified.
func (s GlobalTableGlobalSecondaryIndexSettingsUpdate) GoString() string
GoString returns the string representation
func (s *GlobalTableGlobalSecondaryIndexSettingsUpdate) SetIndexName(v string) *GlobalTableGlobalSecondaryIndexSettingsUpdate
SetIndexName sets the IndexName field's value.
func (s *GlobalTableGlobalSecondaryIndexSettingsUpdate) SetProvisionedWriteCapacityAutoScalingSettingsUpdate(v *AutoScalingSettingsUpdate) *GlobalTableGlobalSecondaryIndexSettingsUpdate
SetProvisionedWriteCapacityAutoScalingSettingsUpdate sets the ProvisionedWriteCapacityAutoScalingSettingsUpdate field's value.
func (s *GlobalTableGlobalSecondaryIndexSettingsUpdate) SetProvisionedWriteCapacityUnits(v int64) *GlobalTableGlobalSecondaryIndexSettingsUpdate
SetProvisionedWriteCapacityUnits sets the ProvisionedWriteCapacityUnits field's value.
func (s GlobalTableGlobalSecondaryIndexSettingsUpdate) String() string
String returns the string representation
func (s *GlobalTableGlobalSecondaryIndexSettingsUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ItemCollectionMetrics struct { // The partition key value of the item collection. This value is the same as // the partition key value of the item. ItemCollectionKey map[string]*AttributeValue `type:"map"` // An estimate of item collection size, in gigabytes. This value is a two-element // array containing a lower bound and an upper bound for the estimate. The estimate // includes the size of all the items in the table, plus the size of all attributes // projected into all of the local secondary indexes on that table. Use this // estimate to measure whether a local secondary index is approaching its size // limit. // // The estimate is subject to change over time; therefore, do not rely on the // precision or accuracy of the estimate. SizeEstimateRangeGB []*float64 `type:"list"` // contains filtered or unexported fields }
Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.
func (s ItemCollectionMetrics) GoString() string
GoString returns the string representation
func (s *ItemCollectionMetrics) SetItemCollectionKey(v map[string]*AttributeValue) *ItemCollectionMetrics
SetItemCollectionKey sets the ItemCollectionKey field's value.
func (s *ItemCollectionMetrics) SetSizeEstimateRangeGB(v []*float64) *ItemCollectionMetrics
SetSizeEstimateRangeGB sets the SizeEstimateRangeGB field's value.
func (s ItemCollectionMetrics) String() string
String returns the string representation
type ItemResponse struct { // Map of attribute data consisting of the data type and attribute value. Item map[string]*AttributeValue `type:"map"` // contains filtered or unexported fields }
Details for the requested item.
func (s ItemResponse) GoString() string
GoString returns the string representation
func (s *ItemResponse) SetItem(v map[string]*AttributeValue) *ItemResponse
SetItem sets the Item field's value.
func (s ItemResponse) String() string
String returns the string representation
type KeySchemaElement struct { // The name of a key attribute. // // AttributeName is a required field AttributeName *string `min:"1" type:"string" required:"true"` // The role that this key attribute will assume: // // * HASH - partition key // // * RANGE - sort key // // The partition key of an item is also known as its hash attribute. The term // "hash attribute" derives from DynamoDB's usage of an internal hash function // to evenly distribute data items across partitions, based on their partition // key values. // // The sort key of an item is also known as its range attribute. The term "range // attribute" derives from the way DynamoDB stores items with the same partition // key physically close together, in sorted order by the sort key value. // // KeyType is a required field KeyType *string `type:"string" required:"true" enum:"KeyType"` // contains filtered or unexported fields }
Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.
A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.
A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.
func (s KeySchemaElement) GoString() string
GoString returns the string representation
func (s *KeySchemaElement) SetAttributeName(v string) *KeySchemaElement
SetAttributeName sets the AttributeName field's value.
func (s *KeySchemaElement) SetKeyType(v string) *KeySchemaElement
SetKeyType sets the KeyType field's value.
func (s KeySchemaElement) String() string
String returns the string representation
func (s *KeySchemaElement) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type KeysAndAttributes struct { // This is a legacy parameter. Use ProjectionExpression instead. For more information, // see Legacy Conditional Parameters (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html) // in the Amazon DynamoDB Developer Guide. AttributesToGet []*string `min:"1" type:"list"` // The consistency of a read operation. If set to true, then a strongly consistent // read is used; otherwise, an eventually consistent read is used. ConsistentRead *bool `type:"boolean"` // One or more substitution tokens for attribute names in an expression. The // following are some use cases for using ExpressionAttributeNames: // // * To access an attribute whose name conflicts with a DynamoDB reserved // word. // // * To create a placeholder for repeating occurrences of an attribute name // in an expression. // // * To prevent special characters in an attribute name from being misinterpreted // in an expression. // // Use the # character in an expression to dereference an attribute name. For // example, consider the following attribute name: // // * Percentile // // The name of this attribute conflicts with a reserved word, so it cannot be // used directly in an expression. (For the complete list of reserved words, // see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) // in the Amazon DynamoDB Developer Guide). To work around this, you could specify // the following for ExpressionAttributeNames: // // * {"#P":"Percentile"} // // You could then use this substitution in an expression, as in this example: // // * #P = :val // // Tokens that begin with the : character are expression attribute values, which // are placeholders for the actual value at runtime. // // For more information on expression attribute names, see Accessing Item Attributes // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string `type:"map"` // The primary key attribute values that define the items and the attributes // associated with the items. // // Keys is a required field Keys []map[string]*AttributeValue `min:"1" type:"list" required:"true"` // A string that identifies one or more attributes to retrieve from the table. // These attributes can include scalars, sets, or elements of a JSON document. // The attributes in the ProjectionExpression must be separated by commas. // // If no attribute names are specified, then all attributes will be returned. // If any of the requested attributes are not found, they will not appear in // the result. // // For more information, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ProjectionExpression *string `type:"string"` // contains filtered or unexported fields }
Represents a set of primary keys and, for each key, the attributes to retrieve from the table.
For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key. For a composite primary key, you must provide both the partition key and the sort key.
func (s KeysAndAttributes) GoString() string
GoString returns the string representation
func (s *KeysAndAttributes) SetAttributesToGet(v []*string) *KeysAndAttributes
SetAttributesToGet sets the AttributesToGet field's value.
func (s *KeysAndAttributes) SetConsistentRead(v bool) *KeysAndAttributes
SetConsistentRead sets the ConsistentRead field's value.
func (s *KeysAndAttributes) SetExpressionAttributeNames(v map[string]*string) *KeysAndAttributes
SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.
func (s *KeysAndAttributes) SetKeys(v []map[string]*AttributeValue) *KeysAndAttributes
SetKeys sets the Keys field's value.
func (s *KeysAndAttributes) SetProjectionExpression(v string) *KeysAndAttributes
SetProjectionExpression sets the ProjectionExpression field's value.
func (s KeysAndAttributes) String() string
String returns the string representation
func (s *KeysAndAttributes) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListBackupsInput struct { // The backups from the table specified by BackupType are listed. // // Where BackupType can be: // // * USER - On-demand backup created by you. // // * SYSTEM - On-demand backup automatically created by DynamoDB. // // * ALL - All types of on-demand backups (USER and SYSTEM). BackupType *string `type:"string" enum:"BackupTypeFilter"` // LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last // evaluated when the current page of results was returned, inclusive of the // current page of results. This value may be specified as the ExclusiveStartBackupArn // of a new ListBackups operation in order to fetch the next page of results. ExclusiveStartBackupArn *string `min:"37" type:"string"` // Maximum number of backups to return at once. Limit *int64 `min:"1" type:"integer"` // The backups from the table specified by TableName are listed. TableName *string `min:"3" type:"string"` // Only backups created after this time are listed. TimeRangeLowerBound is inclusive. TimeRangeLowerBound *time.Time `type:"timestamp"` // Only backups created before this time are listed. TimeRangeUpperBound is // exclusive. TimeRangeUpperBound *time.Time `type:"timestamp"` // contains filtered or unexported fields }
func (s ListBackupsInput) GoString() string
GoString returns the string representation
func (s *ListBackupsInput) SetBackupType(v string) *ListBackupsInput
SetBackupType sets the BackupType field's value.
func (s *ListBackupsInput) SetExclusiveStartBackupArn(v string) *ListBackupsInput
SetExclusiveStartBackupArn sets the ExclusiveStartBackupArn field's value.
func (s *ListBackupsInput) SetLimit(v int64) *ListBackupsInput
SetLimit sets the Limit field's value.
func (s *ListBackupsInput) SetTableName(v string) *ListBackupsInput
SetTableName sets the TableName field's value.
func (s *ListBackupsInput) SetTimeRangeLowerBound(v time.Time) *ListBackupsInput
SetTimeRangeLowerBound sets the TimeRangeLowerBound field's value.
func (s *ListBackupsInput) SetTimeRangeUpperBound(v time.Time) *ListBackupsInput
SetTimeRangeUpperBound sets the TimeRangeUpperBound field's value.
func (s ListBackupsInput) String() string
String returns the string representation
func (s *ListBackupsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListBackupsOutput struct { // List of BackupSummary objects. BackupSummaries []*BackupSummary `type:"list"` // The ARN of the backup last evaluated when the current page of results was // returned, inclusive of the current page of results. This value may be specified // as the ExclusiveStartBackupArn of a new ListBackups operation in order to // fetch the next page of results. // // If LastEvaluatedBackupArn is empty, then the last page of results has been // processed and there are no more results to be retrieved. // // If LastEvaluatedBackupArn is not empty, this may or may not indicate that // there is more data to be returned. All results are guaranteed to have been // returned if and only if no value for LastEvaluatedBackupArn is returned. LastEvaluatedBackupArn *string `min:"37" type:"string"` // contains filtered or unexported fields }
func (s ListBackupsOutput) GoString() string
GoString returns the string representation
func (s *ListBackupsOutput) SetBackupSummaries(v []*BackupSummary) *ListBackupsOutput
SetBackupSummaries sets the BackupSummaries field's value.
func (s *ListBackupsOutput) SetLastEvaluatedBackupArn(v string) *ListBackupsOutput
SetLastEvaluatedBackupArn sets the LastEvaluatedBackupArn field's value.
func (s ListBackupsOutput) String() string
String returns the string representation
type ListContributorInsightsInput struct { // Maximum number of results to return per page. MaxResults *int64 `type:"integer"` // A token to for the desired page, if there is one. NextToken *string `type:"string"` // The name of the table. TableName *string `min:"3" type:"string"` // contains filtered or unexported fields }
func (s ListContributorInsightsInput) GoString() string
GoString returns the string representation
func (s *ListContributorInsightsInput) SetMaxResults(v int64) *ListContributorInsightsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListContributorInsightsInput) SetNextToken(v string) *ListContributorInsightsInput
SetNextToken sets the NextToken field's value.
func (s *ListContributorInsightsInput) SetTableName(v string) *ListContributorInsightsInput
SetTableName sets the TableName field's value.
func (s ListContributorInsightsInput) String() string
String returns the string representation
func (s *ListContributorInsightsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListContributorInsightsOutput struct { // A list of ContributorInsightsSummary. ContributorInsightsSummaries []*ContributorInsightsSummary `type:"list"` // A token to go to the next page if there is one. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (s ListContributorInsightsOutput) GoString() string
GoString returns the string representation
func (s *ListContributorInsightsOutput) SetContributorInsightsSummaries(v []*ContributorInsightsSummary) *ListContributorInsightsOutput
SetContributorInsightsSummaries sets the ContributorInsightsSummaries field's value.
func (s *ListContributorInsightsOutput) SetNextToken(v string) *ListContributorInsightsOutput
SetNextToken sets the NextToken field's value.
func (s ListContributorInsightsOutput) String() string
String returns the string representation
type ListGlobalTablesInput struct { // The first global table name that this operation will evaluate. ExclusiveStartGlobalTableName *string `min:"3" type:"string"` // The maximum number of table names to return. Limit *int64 `min:"1" type:"integer"` // Lists the global tables in a specific Region. RegionName *string `type:"string"` // contains filtered or unexported fields }
func (s ListGlobalTablesInput) GoString() string
GoString returns the string representation
func (s *ListGlobalTablesInput) SetExclusiveStartGlobalTableName(v string) *ListGlobalTablesInput
SetExclusiveStartGlobalTableName sets the ExclusiveStartGlobalTableName field's value.
func (s *ListGlobalTablesInput) SetLimit(v int64) *ListGlobalTablesInput
SetLimit sets the Limit field's value.
func (s *ListGlobalTablesInput) SetRegionName(v string) *ListGlobalTablesInput
SetRegionName sets the RegionName field's value.
func (s ListGlobalTablesInput) String() string
String returns the string representation
func (s *ListGlobalTablesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListGlobalTablesOutput struct { // List of global table names. GlobalTables []*GlobalTable `type:"list"` // Last evaluated global table name. LastEvaluatedGlobalTableName *string `min:"3" type:"string"` // contains filtered or unexported fields }
func (s ListGlobalTablesOutput) GoString() string
GoString returns the string representation
func (s *ListGlobalTablesOutput) SetGlobalTables(v []*GlobalTable) *ListGlobalTablesOutput
SetGlobalTables sets the GlobalTables field's value.
func (s *ListGlobalTablesOutput) SetLastEvaluatedGlobalTableName(v string) *ListGlobalTablesOutput
SetLastEvaluatedGlobalTableName sets the LastEvaluatedGlobalTableName field's value.
func (s ListGlobalTablesOutput) String() string
String returns the string representation
type ListTablesInput struct { // The first table name that this operation will evaluate. Use the value that // was returned for LastEvaluatedTableName in a previous operation, so that // you can obtain the next page of results. ExclusiveStartTableName *string `min:"3" type:"string"` // A maximum number of table names to return. If this parameter is not specified, // the limit is 100. Limit *int64 `min:"1" type:"integer"` // contains filtered or unexported fields }
Represents the input of a ListTables operation.
func (s ListTablesInput) GoString() string
GoString returns the string representation
func (s *ListTablesInput) SetExclusiveStartTableName(v string) *ListTablesInput
SetExclusiveStartTableName sets the ExclusiveStartTableName field's value.
func (s *ListTablesInput) SetLimit(v int64) *ListTablesInput
SetLimit sets the Limit field's value.
func (s ListTablesInput) String() string
String returns the string representation
func (s *ListTablesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTablesOutput struct { // The name of the last table in the current page of results. Use this value // as the ExclusiveStartTableName in a new request to obtain the next page of // results, until all the table names are returned. // // If you do not receive a LastEvaluatedTableName value in the response, this // means that there are no more table names to be retrieved. LastEvaluatedTableName *string `min:"3" type:"string"` // The names of the tables associated with the current account at the current // endpoint. The maximum size of this array is 100. // // If LastEvaluatedTableName also appears in the output, you can use this value // as the ExclusiveStartTableName parameter in a subsequent ListTables request // and obtain the next page of results. TableNames []*string `type:"list"` // contains filtered or unexported fields }
Represents the output of a ListTables operation.
func (s ListTablesOutput) GoString() string
GoString returns the string representation
func (s *ListTablesOutput) SetLastEvaluatedTableName(v string) *ListTablesOutput
SetLastEvaluatedTableName sets the LastEvaluatedTableName field's value.
func (s *ListTablesOutput) SetTableNames(v []*string) *ListTablesOutput
SetTableNames sets the TableNames field's value.
func (s ListTablesOutput) String() string
String returns the string representation
type ListTagsOfResourceInput struct { // An optional string that, if supplied, must be copied from the output of a // previous call to ListTagOfResource. When provided in this manner, this API // fetches the next page of results. NextToken *string `type:"string"` // The Amazon DynamoDB resource with tags to be listed. This value is an Amazon // Resource Name (ARN). // // ResourceArn is a required field ResourceArn *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
func (s ListTagsOfResourceInput) GoString() string
GoString returns the string representation
func (s *ListTagsOfResourceInput) SetNextToken(v string) *ListTagsOfResourceInput
SetNextToken sets the NextToken field's value.
func (s *ListTagsOfResourceInput) SetResourceArn(v string) *ListTagsOfResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s ListTagsOfResourceInput) String() string
String returns the string representation
func (s *ListTagsOfResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsOfResourceOutput struct { // If this value is returned, there are additional results to be displayed. // To retrieve them, call ListTagsOfResource again, with NextToken set to this // value. NextToken *string `type:"string"` // The tags currently associated with the Amazon DynamoDB resource. Tags []*Tag `type:"list"` // contains filtered or unexported fields }
func (s ListTagsOfResourceOutput) GoString() string
GoString returns the string representation
func (s *ListTagsOfResourceOutput) SetNextToken(v string) *ListTagsOfResourceOutput
SetNextToken sets the NextToken field's value.
func (s *ListTagsOfResourceOutput) SetTags(v []*Tag) *ListTagsOfResourceOutput
SetTags sets the Tags field's value.
func (s ListTagsOfResourceOutput) String() string
String returns the string representation
type LocalSecondaryIndex struct { // The name of the local secondary index. The name must be unique among all // other indexes on this table. // // IndexName is a required field IndexName *string `min:"3" type:"string" required:"true"` // The complete key schema for the local secondary index, consisting of one // or more pairs of attribute names and key types: // // * HASH - partition key // // * RANGE - sort key // // The partition key of an item is also known as its hash attribute. The term // "hash attribute" derives from DynamoDB's usage of an internal hash function // to evenly distribute data items across partitions, based on their partition // key values. // // The sort key of an item is also known as its range attribute. The term "range // attribute" derives from the way DynamoDB stores items with the same partition // key physically close together, in sorted order by the sort key value. // // KeySchema is a required field KeySchema []*KeySchemaElement `min:"1" type:"list" required:"true"` // Represents attributes that are copied (projected) from the table into the // local secondary index. These are in addition to the primary key attributes // and index key attributes, which are automatically projected. // // Projection is a required field Projection *Projection `type:"structure" required:"true"` // contains filtered or unexported fields }
Represents the properties of a local secondary index.
func (s LocalSecondaryIndex) GoString() string
GoString returns the string representation
func (s *LocalSecondaryIndex) SetIndexName(v string) *LocalSecondaryIndex
SetIndexName sets the IndexName field's value.
func (s *LocalSecondaryIndex) SetKeySchema(v []*KeySchemaElement) *LocalSecondaryIndex
SetKeySchema sets the KeySchema field's value.
func (s *LocalSecondaryIndex) SetProjection(v *Projection) *LocalSecondaryIndex
SetProjection sets the Projection field's value.
func (s LocalSecondaryIndex) String() string
String returns the string representation
func (s *LocalSecondaryIndex) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type LocalSecondaryIndexDescription struct { // The Amazon Resource Name (ARN) that uniquely identifies the index. IndexArn *string `type:"string"` // Represents the name of the local secondary index. IndexName *string `min:"3" type:"string"` // The total size of the specified index, in bytes. DynamoDB updates this value // approximately every six hours. Recent changes might not be reflected in this // value. IndexSizeBytes *int64 `type:"long"` // The number of items in the specified index. DynamoDB updates this value approximately // every six hours. Recent changes might not be reflected in this value. ItemCount *int64 `type:"long"` // The complete key schema for the local secondary index, consisting of one // or more pairs of attribute names and key types: // // * HASH - partition key // // * RANGE - sort key // // The partition key of an item is also known as its hash attribute. The term // "hash attribute" derives from DynamoDB's usage of an internal hash function // to evenly distribute data items across partitions, based on their partition // key values. // // The sort key of an item is also known as its range attribute. The term "range // attribute" derives from the way DynamoDB stores items with the same partition // key physically close together, in sorted order by the sort key value. KeySchema []*KeySchemaElement `min:"1" type:"list"` // Represents attributes that are copied (projected) from the table into the // global secondary index. These are in addition to the primary key attributes // and index key attributes, which are automatically projected. Projection *Projection `type:"structure"` // contains filtered or unexported fields }
Represents the properties of a local secondary index.
func (s LocalSecondaryIndexDescription) GoString() string
GoString returns the string representation
func (s *LocalSecondaryIndexDescription) SetIndexArn(v string) *LocalSecondaryIndexDescription
SetIndexArn sets the IndexArn field's value.
func (s *LocalSecondaryIndexDescription) SetIndexName(v string) *LocalSecondaryIndexDescription
SetIndexName sets the IndexName field's value.
func (s *LocalSecondaryIndexDescription) SetIndexSizeBytes(v int64) *LocalSecondaryIndexDescription
SetIndexSizeBytes sets the IndexSizeBytes field's value.
func (s *LocalSecondaryIndexDescription) SetItemCount(v int64) *LocalSecondaryIndexDescription
SetItemCount sets the ItemCount field's value.
func (s *LocalSecondaryIndexDescription) SetKeySchema(v []*KeySchemaElement) *LocalSecondaryIndexDescription
SetKeySchema sets the KeySchema field's value.
func (s *LocalSecondaryIndexDescription) SetProjection(v *Projection) *LocalSecondaryIndexDescription
SetProjection sets the Projection field's value.
func (s LocalSecondaryIndexDescription) String() string
String returns the string representation
type LocalSecondaryIndexInfo struct { // Represents the name of the local secondary index. IndexName *string `min:"3" type:"string"` // The complete key schema for a local secondary index, which consists of one // or more pairs of attribute names and key types: // // * HASH - partition key // // * RANGE - sort key // // The partition key of an item is also known as its hash attribute. The term // "hash attribute" derives from DynamoDB's usage of an internal hash function // to evenly distribute data items across partitions, based on their partition // key values. // // The sort key of an item is also known as its range attribute. The term "range // attribute" derives from the way DynamoDB stores items with the same partition // key physically close together, in sorted order by the sort key value. KeySchema []*KeySchemaElement `min:"1" type:"list"` // Represents attributes that are copied (projected) from the table into the // global secondary index. These are in addition to the primary key attributes // and index key attributes, which are automatically projected. Projection *Projection `type:"structure"` // contains filtered or unexported fields }
Represents the properties of a local secondary index for the table when the backup was created.
func (s LocalSecondaryIndexInfo) GoString() string
GoString returns the string representation
func (s *LocalSecondaryIndexInfo) SetIndexName(v string) *LocalSecondaryIndexInfo
SetIndexName sets the IndexName field's value.
func (s *LocalSecondaryIndexInfo) SetKeySchema(v []*KeySchemaElement) *LocalSecondaryIndexInfo
SetKeySchema sets the KeySchema field's value.
func (s *LocalSecondaryIndexInfo) SetProjection(v *Projection) *LocalSecondaryIndexInfo
SetProjection sets the Projection field's value.
func (s LocalSecondaryIndexInfo) String() string
String returns the string representation
type PointInTimeRecoveryDescription struct { // Specifies the earliest point in time you can restore your table to. You can // restore your table to any point in time during the last 35 days. EarliestRestorableDateTime *time.Time `type:"timestamp"` // LatestRestorableDateTime is typically 5 minutes before the current time. LatestRestorableDateTime *time.Time `type:"timestamp"` // The current state of point in time recovery: // // * ENABLING - Point in time recovery is being enabled. // // * ENABLED - Point in time recovery is enabled. // // * DISABLED - Point in time recovery is disabled. PointInTimeRecoveryStatus *string `type:"string" enum:"PointInTimeRecoveryStatus"` // contains filtered or unexported fields }
The description of the point in time settings applied to the table.
func (s PointInTimeRecoveryDescription) GoString() string
GoString returns the string representation
func (s *PointInTimeRecoveryDescription) SetEarliestRestorableDateTime(v time.Time) *PointInTimeRecoveryDescription
SetEarliestRestorableDateTime sets the EarliestRestorableDateTime field's value.
func (s *PointInTimeRecoveryDescription) SetLatestRestorableDateTime(v time.Time) *PointInTimeRecoveryDescription
SetLatestRestorableDateTime sets the LatestRestorableDateTime field's value.
func (s *PointInTimeRecoveryDescription) SetPointInTimeRecoveryStatus(v string) *PointInTimeRecoveryDescription
SetPointInTimeRecoveryStatus sets the PointInTimeRecoveryStatus field's value.
func (s PointInTimeRecoveryDescription) String() string
String returns the string representation
type PointInTimeRecoverySpecification struct { // Indicates whether point in time recovery is enabled (true) or disabled (false) // on the table. // // PointInTimeRecoveryEnabled is a required field PointInTimeRecoveryEnabled *bool `type:"boolean" required:"true"` // contains filtered or unexported fields }
Represents the settings used to enable point in time recovery.
func (s PointInTimeRecoverySpecification) GoString() string
GoString returns the string representation
func (s *PointInTimeRecoverySpecification) SetPointInTimeRecoveryEnabled(v bool) *PointInTimeRecoverySpecification
SetPointInTimeRecoveryEnabled sets the PointInTimeRecoveryEnabled field's value.
func (s PointInTimeRecoverySpecification) String() string
String returns the string representation
func (s *PointInTimeRecoverySpecification) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Projection struct { // Represents the non-key attribute names which will be projected into the index. // // For local secondary indexes, the total count of NonKeyAttributes summed across // all of the local secondary indexes, must not exceed 20. If you project the // same attribute into two different indexes, this counts as two distinct attributes // when determining the total. NonKeyAttributes []*string `min:"1" type:"list"` // The set of attributes that are projected into the index: // // * KEYS_ONLY - Only the index and primary keys are projected into the index. // // * INCLUDE - 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. ProjectionType *string `type:"string" enum:"ProjectionType"` // contains filtered or unexported fields }
Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
func (s Projection) GoString() string
GoString returns the string representation
func (s *Projection) SetNonKeyAttributes(v []*string) *Projection
SetNonKeyAttributes sets the NonKeyAttributes field's value.
func (s *Projection) SetProjectionType(v string) *Projection
SetProjectionType sets the ProjectionType field's value.
func (s Projection) String() string
String returns the string representation
func (s *Projection) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ProvisionedThroughput struct { // The maximum number of strongly consistent reads consumed per second before // DynamoDB returns a ThrottlingException. For more information, see Specifying // Read and Write Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) // in the Amazon DynamoDB Developer Guide. // // If read/write capacity mode is PAY_PER_REQUEST the value is set to 0. // // ReadCapacityUnits is a required field ReadCapacityUnits *int64 `min:"1" type:"long" required:"true"` // The maximum number of writes consumed per second before DynamoDB returns // a ThrottlingException. For more information, see Specifying Read and Write // Requirements (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput) // in the Amazon DynamoDB Developer Guide. // // If read/write capacity mode is PAY_PER_REQUEST the value is set to 0. // // WriteCapacityUnits is a required field WriteCapacityUnits *int64 `min:"1" type:"long" required:"true"` // contains filtered or unexported fields }
Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.
For current minimum and maximum provisioned throughput values, see Limits (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide.
func (s ProvisionedThroughput) GoString() string
GoString returns the string representation
func (s *ProvisionedThroughput) SetReadCapacityUnits(v int64) *ProvisionedThroughput
SetReadCapacityUnits sets the ReadCapacityUnits field's value.
func (s *ProvisionedThroughput) SetWriteCapacityUnits(v int64) *ProvisionedThroughput
SetWriteCapacityUnits sets the WriteCapacityUnits field's value.
func (s ProvisionedThroughput) String() string
String returns the string representation
func (s *ProvisionedThroughput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ProvisionedThroughputDescription struct { // The date and time of the last provisioned throughput decrease for this table. LastDecreaseDateTime *time.Time `type:"timestamp"` // The date and time of the last provisioned throughput increase for this table. LastIncreaseDateTime *time.Time `type:"timestamp"` // The number of provisioned throughput decreases for this table during this // UTC calendar day. For current maximums on provisioned throughput decreases, // see Limits (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) // in the Amazon DynamoDB Developer Guide. NumberOfDecreasesToday *int64 `min:"1" type:"long"` // The maximum number of strongly consistent reads consumed per second before // DynamoDB returns a ThrottlingException. Eventually consistent reads require // less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits // per second provides 100 eventually consistent ReadCapacityUnits per second. ReadCapacityUnits *int64 `type:"long"` // The maximum number of writes consumed per second before DynamoDB returns // a ThrottlingException. WriteCapacityUnits *int64 `type:"long"` // contains filtered or unexported fields }
Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
func (s ProvisionedThroughputDescription) GoString() string
GoString returns the string representation
func (s *ProvisionedThroughputDescription) SetLastDecreaseDateTime(v time.Time) *ProvisionedThroughputDescription
SetLastDecreaseDateTime sets the LastDecreaseDateTime field's value.
func (s *ProvisionedThroughputDescription) SetLastIncreaseDateTime(v time.Time) *ProvisionedThroughputDescription
SetLastIncreaseDateTime sets the LastIncreaseDateTime field's value.
func (s *ProvisionedThroughputDescription) SetNumberOfDecreasesToday(v int64) *ProvisionedThroughputDescription
SetNumberOfDecreasesToday sets the NumberOfDecreasesToday field's value.
func (s *ProvisionedThroughputDescription) SetReadCapacityUnits(v int64) *ProvisionedThroughputDescription
SetReadCapacityUnits sets the ReadCapacityUnits field's value.
func (s *ProvisionedThroughputDescription) SetWriteCapacityUnits(v int64) *ProvisionedThroughputDescription
SetWriteCapacityUnits sets the WriteCapacityUnits field's value.
func (s ProvisionedThroughputDescription) String() string
String returns the string representation
type ProvisionedThroughputOverride struct { // Replica-specific read capacity units. If not specified, uses the source table's // read capacity settings. ReadCapacityUnits *int64 `min:"1" type:"long"` // contains filtered or unexported fields }
Replica-specific provisioned throughput settings. If not specified, uses the source table's provisioned throughput settings.
func (s ProvisionedThroughputOverride) GoString() string
GoString returns the string representation
func (s *ProvisionedThroughputOverride) SetReadCapacityUnits(v int64) *ProvisionedThroughputOverride
SetReadCapacityUnits sets the ReadCapacityUnits field's value.
func (s ProvisionedThroughputOverride) String() string
String returns the string representation
func (s *ProvisionedThroughputOverride) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Put struct { // A condition that must be satisfied in order for a conditional update to succeed. ConditionExpression *string `type:"string"` // One or more substitution tokens for attribute names in an expression. ExpressionAttributeNames map[string]*string `type:"map"` // One or more values that can be substituted in an expression. ExpressionAttributeValues map[string]*AttributeValue `type:"map"` // A map of attribute name to attribute values, representing the primary key // of the item to be written by PutItem. All of the table's primary key attributes // must be specified, and their data types must match those of the table's key // schema. If any attributes are present in the item that are part of an index // key schema for the table, their types must match the index key schema. // // Item is a required field Item map[string]*AttributeValue `type:"map" required:"true"` // Use ReturnValuesOnConditionCheckFailure to get the item attributes if the // Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values // are: NONE and ALL_OLD. ReturnValuesOnConditionCheckFailure *string `type:"string" enum:"ReturnValuesOnConditionCheckFailure"` // Name of the table in which to write the item. // // TableName is a required field TableName *string `min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
Represents a request to perform a PutItem operation.
func (s Put) GoString() string
GoString returns the string representation
func (s *Put) SetConditionExpression(v string) *Put
SetConditionExpression sets the ConditionExpression field's value.
func (s *Put) SetExpressionAttributeNames(v map[string]*string) *Put
SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.
func (s *Put) SetExpressionAttributeValues(v map[string]*AttributeValue) *Put
SetExpressionAttributeValues sets the ExpressionAttributeValues field's value.
func (s *Put) SetItem(v map[string]*AttributeValue) *Put
SetItem sets the Item field's value.
func (s *Put) SetReturnValuesOnConditionCheckFailure(v string) *Put
SetReturnValuesOnConditionCheckFailure sets the ReturnValuesOnConditionCheckFailure field's value.
func (s *Put) SetTableName(v string) *Put
SetTableName sets the TableName field's value.
func (s Put) String() string
String returns the string representation
func (s *Put) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutItemInput struct { // A condition that must be satisfied in order for a conditional PutItem operation // to succeed. // // An expression can contain any of the following: // // * Functions: attribute_exists | attribute_not_exists | attribute_type // | contains | begins_with | size These function names are case-sensitive. // // * Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN // // * Logical operators: AND | OR | NOT // // For more information on condition expressions, see Condition Expressions // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) // in the Amazon DynamoDB Developer Guide. ConditionExpression *string `type:"string"` // This is a legacy parameter. Use ConditionExpression instead. For more information, // see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) // in the Amazon DynamoDB Developer Guide. ConditionalOperator *string `type:"string" enum:"ConditionalOperator"` // This is a legacy parameter. Use ConditionExpression instead. For more information, // see Expected (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html) // in the Amazon DynamoDB Developer Guide. Expected map[string]*ExpectedAttributeValue `type:"map"` // One or more substitution tokens for attribute names in an expression. The // following are some use cases for using ExpressionAttributeNames: // // * To access an attribute whose name conflicts with a DynamoDB reserved // word. // // * To create a placeholder for repeating occurrences of an attribute name // in an expression. // // * To prevent special characters in an attribute name from being misinterpreted // in an expression. // // Use the # character in an expression to dereference an attribute name. For // example, consider the following attribute name: // // * Percentile // // The name of this attribute conflicts with a reserved word, so it cannot be // used directly in an expression. (For the complete list of reserved words, // see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) // in the Amazon DynamoDB Developer Guide). To work around this, you could specify // the following for ExpressionAttributeNames: // // * {"#P":"Percentile"} // // You could then use this substitution in an expression, as in this example: // // * #P = :val // // Tokens that begin with the : character are expression attribute values, which // are placeholders for the actual value at runtime. // // For more information on expression attribute names, see Specifying Item Attributes // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string `type:"map"` // One or more values that can be substituted in an expression. // // Use the : (colon) character in an expression to dereference an attribute // value. For example, suppose that you wanted to check whether the value of // the ProductStatus attribute was one of the following: // // Available | Backordered | Discontinued // // You would first need to specify ExpressionAttributeValues as follows: // // { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} // } // // You could then use these values in an expression, such as this: // // ProductStatus IN (:avail, :back, :disc) // // For more information on expression attribute values, see Condition Expressions // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeValues map[string]*AttributeValue `type:"map"` // A map of attribute name/value pairs, one for each attribute. Only the primary // key attributes are required; you can optionally provide other attribute name-value // pairs for the item. // // You must provide all of the attributes for the primary key. For example, // with a simple primary key, you only need to provide a value for the partition // key. For a composite primary key, you must provide both values for both the // partition key and the sort key. // // If you specify any attributes that are part of an index key, then the data // types for those attributes must match those of the schema in the table's // attribute definition. // // For more information about primary keys, see Primary Key (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.PrimaryKey) // in the Amazon DynamoDB Developer Guide. // // Each element in the Item map is an AttributeValue object. // // Item is a required field Item map[string]*AttributeValue `type:"map" required:"true"` // Determines the level of detail about provisioned throughput consumption that // is returned in the response: // // * INDEXES - The response includes the aggregate ConsumedCapacity for the // operation, together with ConsumedCapacity for each table and secondary // index that was accessed. Note that some operations, such as GetItem and // BatchGetItem, do not access any indexes at all. In these cases, specifying // INDEXES will only return ConsumedCapacity information for table(s). // // * TOTAL - The response includes only the aggregate ConsumedCapacity for // the operation. // // * NONE - No ConsumedCapacity details are included in the response. ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"` // Determines whether item collection metrics are returned. If set to SIZE, // the response includes statistics about item collections, if any, that were // modified during the operation are returned in the response. If set to NONE // (the default), no statistics are returned. ReturnItemCollectionMetrics *string `type:"string" enum:"ReturnItemCollectionMetrics"` // Use ReturnValues if you want to get the item attributes as they appeared // before they were updated with the PutItem request. For PutItem, the valid // values are: // // * NONE - If ReturnValues is not specified, or if its value is NONE, then // nothing is returned. (This setting is the default for ReturnValues.) // // * ALL_OLD - If PutItem overwrote an attribute name-value pair, then the // content of the old item is returned. // // The ReturnValues parameter is used by several DynamoDB operations; however, // PutItem does not recognize any values other than NONE or ALL_OLD. ReturnValues *string `type:"string" enum:"ReturnValue"` // The name of the table to contain the item. // // TableName is a required field TableName *string `min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a PutItem operation.
func (s PutItemInput) GoString() string
GoString returns the string representation
func (s *PutItemInput) SetConditionExpression(v string) *PutItemInput
SetConditionExpression sets the ConditionExpression field's value.
func (s *PutItemInput) SetConditionalOperator(v string) *PutItemInput
SetConditionalOperator sets the ConditionalOperator field's value.
func (s *PutItemInput) SetExpected(v map[string]*ExpectedAttributeValue) *PutItemInput
SetExpected sets the Expected field's value.
func (s *PutItemInput) SetExpressionAttributeNames(v map[string]*string) *PutItemInput
SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.
func (s *PutItemInput) SetExpressionAttributeValues(v map[string]*AttributeValue) *PutItemInput
SetExpressionAttributeValues sets the ExpressionAttributeValues field's value.
func (s *PutItemInput) SetItem(v map[string]*AttributeValue) *PutItemInput
SetItem sets the Item field's value.
func (s *PutItemInput) SetReturnConsumedCapacity(v string) *PutItemInput
SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.
func (s *PutItemInput) SetReturnItemCollectionMetrics(v string) *PutItemInput
SetReturnItemCollectionMetrics sets the ReturnItemCollectionMetrics field's value.
func (s *PutItemInput) SetReturnValues(v string) *PutItemInput
SetReturnValues sets the ReturnValues field's value.
func (s *PutItemInput) SetTableName(v string) *PutItemInput
SetTableName sets the TableName field's value.
func (s PutItemInput) String() string
String returns the string representation
func (s *PutItemInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutItemOutput struct { // The attribute values as they appeared before the PutItem operation, but only // if ReturnValues is specified as ALL_OLD in the request. Each element consists // of an attribute name and an attribute value. Attributes map[string]*AttributeValue `type:"map"` // The capacity units consumed by the PutItem operation. The data returned includes // the total provisioned throughput consumed, along with statistics for the // table and any indexes involved in the operation. ConsumedCapacity is only // returned if the ReturnConsumedCapacity parameter was specified. For more // information, see Read/Write Capacity Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) // in the Amazon DynamoDB Developer Guide. ConsumedCapacity *ConsumedCapacity `type:"structure"` // Information about item collections, if any, that were affected by the PutItem // operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics // parameter was specified. If the table does not have any local secondary indexes, // this information is not returned in the response. // // Each ItemCollectionMetrics element consists of: // // * ItemCollectionKey - The partition key value of the item collection. // This is the same as the partition key value of the item itself. // // * SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. // This value is a two-element array containing a lower bound and an upper // bound for the estimate. The estimate includes the size of all the items // in the table, plus the size of all attributes projected into all of the // local secondary indexes on that table. Use this estimate to measure whether // a local secondary index is approaching its size limit. The estimate is // subject to change over time; therefore, do not rely on the precision or // accuracy of the estimate. ItemCollectionMetrics *ItemCollectionMetrics `type:"structure"` // contains filtered or unexported fields }
Represents the output of a PutItem operation.
func (s PutItemOutput) GoString() string
GoString returns the string representation
func (s *PutItemOutput) SetAttributes(v map[string]*AttributeValue) *PutItemOutput
SetAttributes sets the Attributes field's value.
func (s *PutItemOutput) SetConsumedCapacity(v *ConsumedCapacity) *PutItemOutput
SetConsumedCapacity sets the ConsumedCapacity field's value.
func (s *PutItemOutput) SetItemCollectionMetrics(v *ItemCollectionMetrics) *PutItemOutput
SetItemCollectionMetrics sets the ItemCollectionMetrics field's value.
func (s PutItemOutput) String() string
String returns the string representation
type PutRequest struct { // A map of attribute name to attribute values, representing the primary key // of an item to be processed by PutItem. All of the table's primary key attributes // must be specified, and their data types must match those of the table's key // schema. If any attributes are present in the item that are part of an index // key schema for the table, their types must match the index key schema. // // Item is a required field Item map[string]*AttributeValue `type:"map" required:"true"` // contains filtered or unexported fields }
Represents a request to perform a PutItem operation on an item.
func (s PutRequest) GoString() string
GoString returns the string representation
func (s *PutRequest) SetItem(v map[string]*AttributeValue) *PutRequest
SetItem sets the Item field's value.
func (s PutRequest) String() string
String returns the string representation
type QueryInput struct { // This is a legacy parameter. Use ProjectionExpression instead. For more information, // see AttributesToGet (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html) // in the Amazon DynamoDB Developer Guide. AttributesToGet []*string `min:"1" type:"list"` // This is a legacy parameter. Use FilterExpression instead. For more information, // see ConditionalOperator (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html) // in the Amazon DynamoDB Developer Guide. ConditionalOperator *string `type:"string" enum:"ConditionalOperator"` // Determines the read consistency model: If set to true, then the operation // uses strongly consistent reads; otherwise, the operation uses eventually // consistent reads. // // Strongly consistent reads are not supported on global secondary indexes. // If you query a global secondary index with ConsistentRead set to true, you // will receive a ValidationException. ConsistentRead *bool `type:"boolean"` // The primary key of the first item that this operation will evaluate. Use // the value that was returned for LastEvaluatedKey in the previous operation. // // The data type for ExclusiveStartKey must be String, Number, or Binary. No // set data types are allowed. ExclusiveStartKey map[string]*AttributeValue `type:"map"` // One or more substitution tokens for attribute names in an expression. The // following are some use cases for using ExpressionAttributeNames: // // * To access an attribute whose name conflicts with a DynamoDB reserved // word. // // * To create a placeholder for repeating occurrences of an attribute name // in an expression. // // * To prevent special characters in an attribute name from being misinterpreted // in an expression. // // Use the # character in an expression to dereference an attribute name. For // example, consider the following attribute name: // // * Percentile // // The name of this attribute conflicts with a reserved word, so it cannot be // used directly in an expression. (For the complete list of reserved words, // see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) // in the Amazon DynamoDB Developer Guide). To work around this, you could specify // the following for ExpressionAttributeNames: // // * {"#P":"Percentile"} // // You could then use this substitution in an expression, as in this example: // // * #P = :val // // Tokens that begin with the : character are expression attribute values, which // are placeholders for the actual value at runtime. // // For more information on expression attribute names, see Specifying Item Attributes // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeNames map[string]*string `type:"map"` // One or more values that can be substituted in an expression. // // Use the : (colon) character in an expression to dereference an attribute // value. For example, suppose that you wanted to check whether the value of // the ProductStatus attribute was one of the following: // // Available | Backordered | Discontinued // // You would first need to specify ExpressionAttributeValues as follows: // // { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} // } // // You could then use these values in an expression, such as this: // // ProductStatus IN (:avail, :back, :disc) // // For more information on expression attribute values, see Specifying Conditions // (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html) // in the Amazon DynamoDB Developer Guide. ExpressionAttributeValues map[string]*AttributeValue `type:"map"` // A string that contains conditions that DynamoDB applies after the Query operation, // but before the data is returned to you. Items that do not satisfy the FilterExpression // criteria are not returned. // // A FilterExpression does not allow key attributes. You cannot define a filter // expression based on a partition key or a sort key. // // A FilterExpression is applied after the items have already been read; the // process of filtering does not consume any additional read capacity units. // // For more information, see Filter Expressions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#FilteringResults) // in the Amazon DynamoDB Developer Guide. FilterExpression *string `type:"string"` // The name of an index to query. This index can be any local secondary index // or global secondary index on the table. Note that if you use the IndexName // parameter, you must also provide TableName. IndexName *string `min:"3" type:"string"` // The condition that specifies the key values for items to be retrieved by // the Query action. // // The condition must perform an equality test on a single partition key value. // // The condition can optionally perform one of several comparison tests on a // single sort key value. This allows Query to retrieve one item with a given // partition key value and sort key value, or several items that have the same // partition key value but different sort key values. // // The partition key equality test is required, and must be specified in the // following format: // // partitionKeyName = :partitionkeyval // // If you also want to provide a condition for the sort key, it must be combined // using AND with the condition for the sort key. Following is an example, using // the = comparison operator for the sort key: // // partitionKeyName = :partitionkeyval AND sortKeyName = :sortkeyval // // Valid comparisons for the sort key condition are as follows: // // * sortKeyName = :sortkeyval - true if the sort key value is equal to :sortkeyval. // // * sortKeyName < :sortkeyval - true if the sort key value is less than // :sortkeyval. // // * sortKeyName <= :sortkeyval - true if the sort key value is less than // or equal to :sortkeyval. // // * sortKeyName > :sortkeyval - true if the sort key value is greater than // :sortkeyval. // // * sortKeyName >= :sortkeyval - true if the sort key value is greater than // or equal to :sortkeyval. // // * sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2 - true if the sort // key value is greater than or equal to :sortkeyval1, and less than or equal // to :sortkeyval2. // // * begins_with ( sortKeyName, :sortkeyval ) - true if the sort key value // begins with a particular operand. (You cannot use this function with a // sort key that is of type Number.) Note that the function name begins_with // is case-sensitive. // // Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval // and :sortval with actual values at runtime. // // You can optionally use the ExpressionAttributeNames parameter to replace // the names of the partition key and sort key with placeholder tokens. This // option might be necessary if an attribute name conflicts with a DynamoDB // reserved word. For example, the following KeyConditionExpression parameter // causes an error because Size is a reserved word: // // * Size = :myval // // To work around this, define a placeholder (such a #S) to represent the attribute // name Size. KeyConditionExpression then is as follows: // // * #S = :myval // // For a list of reserved words, see Reserved Words (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html) // in the Amazon DynamoDB Developer Guide. // // For more information on ExpressionAttributeNames and ExpressionAttributeValues, // see Using Placeholders for Attribute Names and Values (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html) // in the Amazon DynamoDB Developer Guide. KeyConditionExpression *string `type:"string"` // This is a legacy parameter. Use KeyConditionExpression instead. For more // information, see KeyConditions (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html) // in the Amazon DynamoDB Developer Guide. KeyConditions map[string]*Condition `type:"map"` // The maximum number of items to evaluate (not necessarily the number of matching // items). If DynamoDB processes the number of items up to the limit while processing // the results, it stops the operation and returns the matching values up to // that point, and a key in LastEvaluatedKey to apply in a subsequent operation, // so that you can pick up where you left off. Also, if the processed dataset // size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation // and returns the matching values up to the limit, and a key in LastEvaluatedKey // to apply in a subsequent operation to continue the operation. For more information, // see Query and Scan (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html) // in the Amazon DynamoDB Developer Guide. Limit *int64 `min:"1" type:"integer"` // A string that identifies one or more attributes to retrieve from the table. // These attributes can include scalars, sets, or elements of a JSON document. // The attributes in the expression must be separated by commas. // // If no attribute names are specified, then all attributes will be returned. // If any of the requested attributes are not found, they will not appear in // the result. // // For more information, see Accessing Item Attributes (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html) // in the Amazon DynamoDB Developer Guide. ProjectionExpression *string `type:"string"` // This is a legacy parameter. Use FilterExpression instead. For more information, // see QueryFilter (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html) // in the Amazon DynamoDB Developer Guide. QueryFilter map[string]*Condition `type:"map"` // Determines the level of detail about provisioned throughput consumption that // is returned in the response: // // * INDEXES - The response includes the aggregate ConsumedCapacity for the // operation, together with ConsumedCapacity for each table and secondary // index that was accessed. Note that some operations, such as GetItem and // BatchGetItem, do not access any indexes at all. In these cases, specifying // INDEXES will only return ConsumedCapacity information for table(s). // // * TOTAL - The response includes only the aggregate ConsumedCapacity for // the operation. // // * NONE - No ConsumedCapacity details are included in the response. ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"` // Specifies the order for index traversal: If true (default), the traversal // is performed in ascending order; if false, the traversal is performed in // descending order. // // Items with the same partition key value are stored in sorted order by sort // key. If the sort key data type is Number, the results are stored in numeric // order. For type String, the results are stored in order of UTF-8 bytes. For // type Binary, DynamoDB treats each byte of the binary data as unsigned. // // If ScanIndexForward is true, DynamoDB returns the results in the order in // which they are stored (by sort key value). This is the default behavior. // If ScanIndexForward is false, DynamoDB reads the results in reverse order // by sort key value, and then returns the results to the client. ScanIndexForward *bool `type:"boolean"` // The attributes to be returned in the result. You can retrieve all item attributes, // specific item attributes, the count of matching items, or in the case of // an index, some or all of the attributes projected into the index. // // * ALL_ATTRIBUTES - Returns all of the item attributes from the specified // table or index. If you query a local secondary index, then for each matching // item in the index, DynamoDB fetches the entire item from the parent table. // If the index is configured to project all item attributes, then all of // the data can be obtained from the local secondary index, and no fetching // is required. // // * ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves // all attributes that have been projected into the index. If the index is // configured to project all attributes, this return value is equivalent // to specifying ALL_ATTRIBUTES. // // * COUNT - Returns the number of matching items, rather than the matching // items themselves. // // * SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. // This return value is equivalent to specifying AttributesToGet without // specifying any value for Select. If you query or scan a local secondary // index and request only attributes that are projected into that index, // the operation will read only the index and not the table. If any of the // requested attributes are not projected into the local secondary index, // DynamoDB fetches each of these attributes from the parent table. This // extra fetching incurs additional throughput cost and latency. If you query // or scan a global secondary index, you can only request attributes that // are projected into the index. Global secondary index queries cannot fetch // attributes from the parent table. // // If neither Select nor AttributesToGet are specified, DynamoDB defaults to // ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when // accessing an index. You cannot use both Select and AttributesToGet together // in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. // (This usage is equivalent to specifying AttributesToGet without any value // for Select.) // // If you use the ProjectionExpression parameter, then the value for Select // can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an // error. Select *string `type:"string" enum:"Select"` // The name of the table containing the requested items. // // TableName is a required field TableName *string `min:"3" type:"string" required:"true"` // contains filtered or unexported fields }
Represents the input of a Query operation.
func (s QueryInput) GoString() string
GoString returns the string representation
func (s *QueryInput) SetAttributesToGet(v []*string) *QueryInput
SetAttributesToGet sets the AttributesToGet field's value.
func (s *QueryInput) SetConditionalOperator(v string) *QueryInput
SetConditionalOperator sets the ConditionalOperator field's value.
func (s *QueryInput) SetConsistentRead(v bool) *QueryInput
SetConsistentRead sets the ConsistentRead field's value.
func (s *QueryInput) SetExclusiveStartKey(v map[string]*AttributeValue) *QueryInput
SetExclusiveStartKey sets the ExclusiveStartKey field's value.
func (s *QueryInput) SetExpressionAttributeNames(v map[string]*string) *QueryInput
SetExpressionAttributeNames sets the ExpressionAttributeNames field's value.
func (s *QueryInput) SetExpressionAttributeValues(v map[string]*AttributeValue) *QueryInput
SetExpressionAttributeValues sets the ExpressionAttributeValues field's value.
func (s *QueryInput) SetFilterExpression(v string) *QueryInput
SetFilterExpression sets the FilterExpression field's value.
func (s *QueryInput) SetIndexName(v string) *QueryInput
SetIndexName sets the IndexName field's value.
func (s *QueryInput) SetKeyConditionExpression(v string) *QueryInput
SetKeyConditionExpression sets the KeyConditionExpression field's value.
func (s *QueryInput) SetKeyConditions(v map[string]*Condition) *QueryInput
SetKeyConditions sets the KeyConditions field's value.
func (s *QueryInput) SetLimit(v int64) *QueryInput
SetLimit sets the Limit field's value.
func (s *QueryInput) SetProjectionExpression(v string) *QueryInput
SetProjectionExpression sets the ProjectionExpression field's value.
func (s *QueryInput) SetQueryFilter(v map[string]*Condition) *QueryInput
SetQueryFilter sets the QueryFilter field's value.
func (s *QueryInput) SetReturnConsumedCapacity(v string) *QueryInput
SetReturnConsumedCapacity sets the ReturnConsumedCapacity field's value.
func (s *QueryInput) SetScanIndexForward(v bool) *QueryInput
SetScanIndexForward sets the ScanIndexForward field's value.
func (s *QueryInput) SetSelect(v string) *QueryInput
SetSelect sets the Select field's value.
func (s *QueryInput) SetTableName(v string) *QueryInput
SetTableName sets the TableName field's value.
func (s QueryInput) String() string
String returns the string representation
func (s *QueryInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type QueryOutput struct { // The capacity units consumed by the Query operation. The data returned includes // the total provisioned throughput consumed, along with statistics for the // table and any indexes involved in the operation. ConsumedCapacity is only // returned if the ReturnConsumedCapacity parameter was specified. For more // information, see Provisioned Throughput (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html) // in the Amazon DynamoDB Developer Guide. ConsumedCapacity *ConsumedCapacity `type:"structure"` // The number of items in the response. // // If you used a QueryFilter in the request, then Count is the number of items // returned after the filter was applied, and ScannedCount is the number of // matching items before the filter was applied. // // If you did not use a filter in the request, then Count and ScannedCount are // the same. Count *int64 `type:"integer"` // An array of item attributes that match the query criteria. Each element in // this array consists of an attribute name and the value for that attribute. Items []map[string]*AttributeValue `type:"list"` // The primary key of the item where the operation stopped, inclusive of the // previous result set. Use this value to start a new operation, excluding this // value in the new request. // // If LastEvaluatedKey is empty, then the "last page" of results has been processed // and there is no more data to be retrieved. // // If LastEvaluatedKey is not empty, it does not necessarily mean that there // is more data in the result set. The only way to know when you have reached // the end of the result set is when LastEvaluatedKey is empty. LastEvaluatedKey map[string]*AttributeValue `type:"map"` // The number of items evaluated, before any QueryFilter is applied. A high // ScannedCount value with few, or no, Count results indicates an inefficient // Query operation. For more information, see Count and ScannedCount (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count) // in the Amazon DynamoDB Developer Guide. // // If you did not use a filter in the request, then ScannedCount is the same // as Count. ScannedCount *int64 `type:"integer"` // contains filtered or unexported fields }
Represents the output of a Query operation.
func (s QueryOutput) GoString() string
GoString returns the string representation
func (s *QueryOutput) SetConsumedCapacity(v *ConsumedCapacity) *QueryOutput
SetConsumedCapacity sets the ConsumedCapacity field's value.
func (s *QueryOutput) SetCount(v int64) *QueryOutput
SetCount sets the Count field's value.
func (s *QueryOutput) SetItems(v []map[string]*AttributeValue) *QueryOutput
SetItems sets the Items field's value.
func (s *QueryOutput) SetLastEvaluatedKey(v map[string]*AttributeValue) *QueryOutput
SetLastEvaluatedKey sets the LastEvaluatedKey field's value.
func (s *QueryOutput) SetScannedCount(v int64) *QueryOutput
SetScannedCount sets the ScannedCount field's value.
func (s QueryOutput) String() string
String returns the string representation
type Replica struct { // The Region where the replica needs to be created. RegionName *string `type:"string"` // contains filtered or unexported fields }
Represents the properties of a replica.
func (s Replica) GoString() string
GoString returns the string representation
func (s *Replica) SetRegionName(v string) *Replica
SetRegionName sets the RegionName field's value.
func (s Replica) String() string
String returns the string representation
type ReplicaAutoScalingDescription struct { // Replica-specific global secondary index auto scaling settings. GlobalSecondaryIndexes []*ReplicaGlobalSecondaryIndexAutoScalingDescription `type:"list"` // The Region where the replica exists. RegionName *string `type:"string"` // Represents the auto scaling settings for a global table or global secondary // index. ReplicaProvisionedReadCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"` // Represents the auto scaling settings for a global table or global secondary // index. ReplicaProvisionedWriteCapacityAutoScalingSettings *AutoScalingSettingsDescription `type:"structure"` // The current state of the replica: // // * CREATING - The replica is being created. // // * UPDATING - The replica is being updated. // // * DELETING - The replica is being deleted. // // * ACTIVE - The replica is ready for use. ReplicaStatus *string `type:"string" enum:"ReplicaStatus"` // contains filtered or unexported fields }
Represents the auto scaling settings of the replica.
func (s ReplicaAutoScalingDescription) GoString() string
GoString returns the string representation
func (s *ReplicaAutoScalingDescription) SetGlobalSecondaryIndexes(v []*ReplicaGlobalSecondaryIndexAutoScalingDescription) *ReplicaAutoScalingDescription
SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.
func (s *ReplicaAutoScalingDescription) SetRegionName(v string) *ReplicaAutoScalingDescription
SetRegionName sets the RegionName field's value.
func (s *ReplicaAutoScalingDescription) SetReplicaProvisionedReadCapacityAutoScalingSettings(v *AutoScalingSettingsDescription) *ReplicaAutoScalingDescription
SetReplicaProvisionedReadCapacityAutoScalingSettings sets the ReplicaProvisionedReadCapacityAutoScalingSettings field's value.
func (s *ReplicaAutoScalingDescription) SetReplicaProvisionedWriteCapacityAutoScalingSettings(v *AutoScalingSettingsDescription) *ReplicaAutoScalingDescription
SetReplicaProvisionedWriteCapacityAutoScalingSettings sets the ReplicaProvisionedWriteCapacityAutoScalingSettings field's value.
func (s *ReplicaAutoScalingDescription) SetReplicaStatus(v string) *ReplicaAutoScalingDescription
SetReplicaStatus sets the ReplicaStatus field's value.
func (s ReplicaAutoScalingDescription) String() string
String returns the string representation
type ReplicaAutoScalingUpdate struct { // The Region where the replica exists. // // RegionName is a required field RegionName *string `type:"string" required:"true"` // Represents the auto scaling settings of global secondary indexes that will // be modified. ReplicaGlobalSecondaryIndexUpdates []*ReplicaGlobalSecondaryIndexAutoScalingUpdate `type:"list"` // Represents the auto scaling settings to be modified for a global table or // global secondary index. ReplicaProvisionedReadCapacityAutoScalingUpdate *AutoScalingSettingsUpdate `type:"structure"` // contains filtered or unexported fields }
Represents the auto scaling settings of a replica that will be modified.
func (s ReplicaAutoScalingUpdate) GoString() string
GoString returns the string representation
func (s *ReplicaAutoScalingUpdate) SetRegionName(v string) *ReplicaAutoScalingUpdate
SetRegionName sets the RegionName field's value.
func (s *ReplicaAutoScalingUpdate) SetReplicaGlobalSecondaryIndexUpdates(v []*ReplicaGlobalSecondaryIndexAutoScalingUpdate) *ReplicaAutoScalingUpdate
SetReplicaGlobalSecondaryIndexUpdates sets the ReplicaGlobalSecondaryIndexUpdates field's value.
func (s *ReplicaAutoScalingUpdate) SetReplicaProvisionedReadCapacityAutoScalingUpdate(v *AutoScalingSettingsUpdate) *ReplicaAutoScalingUpdate
SetReplicaProvisionedReadCapacityAutoScalingUpdate sets the ReplicaProvisionedReadCapacityAutoScalingUpdate field's value.
func (s ReplicaAutoScalingUpdate) String() string
String returns the string representation
func (s *ReplicaAutoScalingUpdate) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ReplicaDescription struct { // Replica-specific global secondary index settings. GlobalSecondaryIndexes []*ReplicaGlobalSecondaryIndexDescription `type:"list"` // The AWS KMS customer master key (CMK) of the replica that will be used for // AWS KMS encryption. KMSMasterKeyId *string `type:"string"` // Replica-specific provisioned throughput. If not described, uses the source // table's provisioned throughput settings. ProvisionedThroughputOverride *ProvisionedThroughputOverride `type:"structure"` // The name of the Region. RegionName *string `type:"string"` // The current state of the replica: // // * CREATING - The replica is being created. // // * UPDATING - The replica is being updated. // // * DELETING - The replica is being deleted. // // * ACTIVE - The replica is ready for use. ReplicaStatus *string `type:"string" enum:"ReplicaStatus"` // Detailed information about the replica status. ReplicaStatusDescription *string `type:"string"` // Specifies the progress of a Create, Update, or Delete action on the replica // as a percentage. ReplicaStatusPercentProgress *string `type:"string"` // contains filtered or unexported fields }
Contains the details of the replica.
func (s ReplicaDescription) GoString() string
GoString returns the string representation
func (s *ReplicaDescription) SetGlobalSecondaryIndexes(v []*ReplicaGlobalSecondaryIndexDescription) *ReplicaDescription
SetGlobalSecondaryIndexes sets the GlobalSecondaryIndexes field's value.
func (s *ReplicaDescription) SetKMSMasterKeyId(v string) *ReplicaDescription
SetKMSMasterKeyId sets the KMSMasterKeyId field's value.
func (s *ReplicaDescription) SetProvisionedThroughputOverride(v *ProvisionedThroughputOverride) *ReplicaDescription
SetProvisionedThroughputOverride sets the ProvisionedThroughputOverride field's value.
func (s *ReplicaDescription) SetRegionName(v string) *ReplicaDescription
SetRegionName sets the RegionName field's value.
func (s *ReplicaDescription) SetReplicaStatus(v string) *ReplicaDescription
SetReplicaStatus sets the ReplicaStatus field's value.
func (s *ReplicaDescription) SetReplicaStatusDescription(v string) *ReplicaDescription
SetReplicaStatusDescription sets the ReplicaStatusDescription field's value.
func (s *ReplicaDescription) SetReplicaStatusPercentProgress(v string) *ReplicaDescription
SetReplicaStatusPercentProgress sets the ReplicaStatusPercentProgress field's value.
func (s ReplicaDescription) String() string
String returns the string representation
type ReplicaGlobalSecondaryIndex struct { // The name of the global secondary index. // // IndexName is a required field IndexName *string `min:"3" type:"string" required:"true"` // Replica table GSI-specific provisioned throughput. If not specified, uses // the source table GSI's read capacity settings. ProvisionedThroughputOverride *ProvisionedThroughputOverride `type:"structure"` // contains filtered or unexported fields }
Represents the properties of a replica global secondary index.
func (s ReplicaGlobalSecondaryIndex) GoString() string
GoString returns the string representation
func (s *ReplicaGlobalSecondaryIndex) SetIndexName(v string) *ReplicaGlobalSecondaryIndex
SetIndexName sets the IndexName field's value.
func (s *ReplicaGlobalSecondaryIn