dynamodb/aws.sdk.kotlin.services.dynamodb.model/UpdateItemRequest/Builder

Builder

Properties

var attributeUpdates: Map<String, AttributeValueUpdate>?

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

conditionalOperator

var conditionalOperator: ConditionalOperator?

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

conditionExpression

var conditionExpression: String?

A condition that must be satisfied in order for a conditional update to succeed.

expected

var expected: Map<String, ExpectedAttributeValue>?

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

expressionAttributeNames

var expressionAttributeNames: Map<String, String>?

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

expressionAttributeValues

var expressionAttributeValues: Map<String, AttributeValue>?

One or more values that can be substituted in an expression.

key

var key: Map<String, AttributeValue>?

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

returnConsumedCapacity

var returnConsumedCapacity: ReturnConsumedCapacity?

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

returnItemCollectionMetrics

var returnItemCollectionMetrics: ReturnItemCollectionMetrics?

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.

returnValues

var returnValues: ReturnValue?

Use ReturnValues if you want to get the item attributes as they appear before or after they are successfully updated. For UpdateItem, the valid values are:

returnValuesOnConditionCheckFailure

var returnValuesOnConditionCheckFailure: ReturnValuesOnConditionCheckFailure?

An optional parameter that returns the item attributes for an UpdateItem operation that failed a condition check.

tableName

var tableName: String?

The name of the table containing the item to update. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

updateExpression

var updateExpression: String?

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.