AWS SDK for C++  1.8.54
AWS SDK for C++
Public Member Functions | List of all members
Aws::DynamoDB::Model::PutItemRequest Class Reference

#include <PutItemRequest.h>

+ Inheritance diagram for Aws::DynamoDB::Model::PutItemRequest:

Public Member Functions

 PutItemRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetTableName () const
 
bool TableNameHasBeenSet () const
 
void SetTableName (const Aws::String &value)
 
void SetTableName (Aws::String &&value)
 
void SetTableName (const char *value)
 
PutItemRequestWithTableName (const Aws::String &value)
 
PutItemRequestWithTableName (Aws::String &&value)
 
PutItemRequestWithTableName (const char *value)
 
const Aws::Map< Aws::String, AttributeValue > & GetItem () const
 
bool ItemHasBeenSet () const
 
void SetItem (const Aws::Map< Aws::String, AttributeValue > &value)
 
void SetItem (Aws::Map< Aws::String, AttributeValue > &&value)
 
PutItemRequestWithItem (const Aws::Map< Aws::String, AttributeValue > &value)
 
PutItemRequestWithItem (Aws::Map< Aws::String, AttributeValue > &&value)
 
PutItemRequestAddItem (const Aws::String &key, const AttributeValue &value)
 
PutItemRequestAddItem (Aws::String &&key, const AttributeValue &value)
 
PutItemRequestAddItem (const Aws::String &key, AttributeValue &&value)
 
PutItemRequestAddItem (Aws::String &&key, AttributeValue &&value)
 
PutItemRequestAddItem (const char *key, AttributeValue &&value)
 
PutItemRequestAddItem (const char *key, const AttributeValue &value)
 
const Aws::Map< Aws::String, ExpectedAttributeValue > & GetExpected () const
 
bool ExpectedHasBeenSet () const
 
void SetExpected (const Aws::Map< Aws::String, ExpectedAttributeValue > &value)
 
void SetExpected (Aws::Map< Aws::String, ExpectedAttributeValue > &&value)
 
PutItemRequestWithExpected (const Aws::Map< Aws::String, ExpectedAttributeValue > &value)
 
PutItemRequestWithExpected (Aws::Map< Aws::String, ExpectedAttributeValue > &&value)
 
PutItemRequestAddExpected (const Aws::String &key, const ExpectedAttributeValue &value)
 
PutItemRequestAddExpected (Aws::String &&key, const ExpectedAttributeValue &value)
 
PutItemRequestAddExpected (const Aws::String &key, ExpectedAttributeValue &&value)
 
PutItemRequestAddExpected (Aws::String &&key, ExpectedAttributeValue &&value)
 
PutItemRequestAddExpected (const char *key, ExpectedAttributeValue &&value)
 
PutItemRequestAddExpected (const char *key, const ExpectedAttributeValue &value)
 
const ReturnValueGetReturnValues () const
 
bool ReturnValuesHasBeenSet () const
 
void SetReturnValues (const ReturnValue &value)
 
void SetReturnValues (ReturnValue &&value)
 
PutItemRequestWithReturnValues (const ReturnValue &value)
 
PutItemRequestWithReturnValues (ReturnValue &&value)
 
const ReturnConsumedCapacityGetReturnConsumedCapacity () const
 
bool ReturnConsumedCapacityHasBeenSet () const
 
void SetReturnConsumedCapacity (const ReturnConsumedCapacity &value)
 
void SetReturnConsumedCapacity (ReturnConsumedCapacity &&value)
 
PutItemRequestWithReturnConsumedCapacity (const ReturnConsumedCapacity &value)
 
PutItemRequestWithReturnConsumedCapacity (ReturnConsumedCapacity &&value)
 
const ReturnItemCollectionMetricsGetReturnItemCollectionMetrics () const
 
bool ReturnItemCollectionMetricsHasBeenSet () const
 
void SetReturnItemCollectionMetrics (const ReturnItemCollectionMetrics &value)
 
void SetReturnItemCollectionMetrics (ReturnItemCollectionMetrics &&value)
 
PutItemRequestWithReturnItemCollectionMetrics (const ReturnItemCollectionMetrics &value)
 
PutItemRequestWithReturnItemCollectionMetrics (ReturnItemCollectionMetrics &&value)
 
const ConditionalOperatorGetConditionalOperator () const
 
bool ConditionalOperatorHasBeenSet () const
 
void SetConditionalOperator (const ConditionalOperator &value)
 
void SetConditionalOperator (ConditionalOperator &&value)
 
PutItemRequestWithConditionalOperator (const ConditionalOperator &value)
 
PutItemRequestWithConditionalOperator (ConditionalOperator &&value)
 
const Aws::StringGetConditionExpression () const
 
bool ConditionExpressionHasBeenSet () const
 
void SetConditionExpression (const Aws::String &value)
 
void SetConditionExpression (Aws::String &&value)
 
void SetConditionExpression (const char *value)
 
PutItemRequestWithConditionExpression (const Aws::String &value)
 
PutItemRequestWithConditionExpression (Aws::String &&value)
 
PutItemRequestWithConditionExpression (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetExpressionAttributeNames () const
 
bool ExpressionAttributeNamesHasBeenSet () const
 
void SetExpressionAttributeNames (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetExpressionAttributeNames (Aws::Map< Aws::String, Aws::String > &&value)
 
PutItemRequestWithExpressionAttributeNames (const Aws::Map< Aws::String, Aws::String > &value)
 
PutItemRequestWithExpressionAttributeNames (Aws::Map< Aws::String, Aws::String > &&value)
 
PutItemRequestAddExpressionAttributeNames (const Aws::String &key, const Aws::String &value)
 
PutItemRequestAddExpressionAttributeNames (Aws::String &&key, const Aws::String &value)
 
PutItemRequestAddExpressionAttributeNames (const Aws::String &key, Aws::String &&value)
 
PutItemRequestAddExpressionAttributeNames (Aws::String &&key, Aws::String &&value)
 
PutItemRequestAddExpressionAttributeNames (const char *key, Aws::String &&value)
 
PutItemRequestAddExpressionAttributeNames (Aws::String &&key, const char *value)
 
PutItemRequestAddExpressionAttributeNames (const char *key, const char *value)
 
const Aws::Map< Aws::String, AttributeValue > & GetExpressionAttributeValues () const
 
bool ExpressionAttributeValuesHasBeenSet () const
 
void SetExpressionAttributeValues (const Aws::Map< Aws::String, AttributeValue > &value)
 
void SetExpressionAttributeValues (Aws::Map< Aws::String, AttributeValue > &&value)
 
PutItemRequestWithExpressionAttributeValues (const Aws::Map< Aws::String, AttributeValue > &value)
 
PutItemRequestWithExpressionAttributeValues (Aws::Map< Aws::String, AttributeValue > &&value)
 
PutItemRequestAddExpressionAttributeValues (const Aws::String &key, const AttributeValue &value)
 
PutItemRequestAddExpressionAttributeValues (Aws::String &&key, const AttributeValue &value)
 
PutItemRequestAddExpressionAttributeValues (const Aws::String &key, AttributeValue &&value)
 
PutItemRequestAddExpressionAttributeValues (Aws::String &&key, AttributeValue &&value)
 
PutItemRequestAddExpressionAttributeValues (const char *key, AttributeValue &&value)
 
PutItemRequestAddExpressionAttributeValues (const char *key, const AttributeValue &value)
 
- Public Member Functions inherited from Aws::DynamoDB::DynamoDBRequest
virtual ~DynamoDBRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Represents the input of a PutItem operation.

See Also:

AWS API Reference

Definition at line 32 of file PutItemRequest.h.

Constructor & Destructor Documentation

◆ PutItemRequest()

Aws::DynamoDB::Model::PutItemRequest::PutItemRequest ( )

Member Function Documentation

◆ AddExpected() [1/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpected ( const Aws::String key,
const ExpectedAttributeValue value 
)
inline

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

Definition at line 372 of file PutItemRequest.h.

◆ AddExpected() [2/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpected ( Aws::String &&  key,
const ExpectedAttributeValue value 
)
inline

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

Definition at line 380 of file PutItemRequest.h.

◆ AddExpected() [3/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpected ( const Aws::String key,
ExpectedAttributeValue &&  value 
)
inline

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

Definition at line 388 of file PutItemRequest.h.

◆ AddExpected() [4/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpected ( Aws::String &&  key,
ExpectedAttributeValue &&  value 
)
inline

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

Definition at line 396 of file PutItemRequest.h.

◆ AddExpected() [5/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpected ( const char *  key,
ExpectedAttributeValue &&  value 
)
inline

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

Definition at line 404 of file PutItemRequest.h.

◆ AddExpected() [6/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpected ( const char *  key,
const ExpectedAttributeValue value 
)
inline

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

Definition at line 412 of file PutItemRequest.h.

◆ AddExpressionAttributeNames() [1/7]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpressionAttributeNames ( const Aws::String key,
const Aws::String value 
)
inline

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 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 in the Amazon DynamoDB Developer Guide.

Definition at line 923 of file PutItemRequest.h.

◆ AddExpressionAttributeNames() [2/7]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpressionAttributeNames ( Aws::String &&  key,
const Aws::String value 
)
inline

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 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 in the Amazon DynamoDB Developer Guide.

Definition at line 950 of file PutItemRequest.h.

◆ AddExpressionAttributeNames() [3/7]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpressionAttributeNames ( const Aws::String key,
Aws::String &&  value 
)
inline

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 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 in the Amazon DynamoDB Developer Guide.

Definition at line 977 of file PutItemRequest.h.

◆ AddExpressionAttributeNames() [4/7]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpressionAttributeNames ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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 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 in the Amazon DynamoDB Developer Guide.

Definition at line 1004 of file PutItemRequest.h.

◆ AddExpressionAttributeNames() [5/7]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpressionAttributeNames ( const char *  key,
Aws::String &&  value 
)
inline

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 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 in the Amazon DynamoDB Developer Guide.

Definition at line 1031 of file PutItemRequest.h.

◆ AddExpressionAttributeNames() [6/7]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpressionAttributeNames ( Aws::String &&  key,
const char *  value 
)
inline

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 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 in the Amazon DynamoDB Developer Guide.

Definition at line 1058 of file PutItemRequest.h.

◆ AddExpressionAttributeNames() [7/7]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpressionAttributeNames ( const char *  key,
const char *  value 
)
inline

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 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 in the Amazon DynamoDB Developer Guide.

Definition at line 1085 of file PutItemRequest.h.

◆ AddExpressionAttributeValues() [1/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpressionAttributeValues ( const Aws::String key,
const AttributeValue value 
)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 1205 of file PutItemRequest.h.

◆ AddExpressionAttributeValues() [2/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpressionAttributeValues ( Aws::String &&  key,
const AttributeValue value 
)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 1222 of file PutItemRequest.h.

◆ AddExpressionAttributeValues() [3/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpressionAttributeValues ( const Aws::String key,
AttributeValue &&  value 
)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 1239 of file PutItemRequest.h.

◆ AddExpressionAttributeValues() [4/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpressionAttributeValues ( Aws::String &&  key,
AttributeValue &&  value 
)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 1256 of file PutItemRequest.h.

◆ AddExpressionAttributeValues() [5/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpressionAttributeValues ( const char *  key,
AttributeValue &&  value 
)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 1273 of file PutItemRequest.h.

◆ AddExpressionAttributeValues() [6/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddExpressionAttributeValues ( const char *  key,
const AttributeValue value 
)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 1290 of file PutItemRequest.h.

◆ AddItem() [1/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddItem ( const Aws::String key,
const AttributeValue value 
)
inline

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Definition at line 220 of file PutItemRequest.h.

◆ AddItem() [2/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddItem ( Aws::String &&  key,
const AttributeValue value 
)
inline

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Definition at line 239 of file PutItemRequest.h.

◆ AddItem() [3/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddItem ( const Aws::String key,
AttributeValue &&  value 
)
inline

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Definition at line 258 of file PutItemRequest.h.

◆ AddItem() [4/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddItem ( Aws::String &&  key,
AttributeValue &&  value 
)
inline

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Definition at line 277 of file PutItemRequest.h.

◆ AddItem() [5/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddItem ( const char *  key,
AttributeValue &&  value 
)
inline

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Definition at line 296 of file PutItemRequest.h.

◆ AddItem() [6/6]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::AddItem ( const char *  key,
const AttributeValue value 
)
inline

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Definition at line 315 of file PutItemRequest.h.

◆ ConditionalOperatorHasBeenSet()

bool Aws::DynamoDB::Model::PutItemRequest::ConditionalOperatorHasBeenSet ( ) const
inline

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

Definition at line 588 of file PutItemRequest.h.

◆ ConditionExpressionHasBeenSet()

bool Aws::DynamoDB::Model::PutItemRequest::ConditionExpressionHasBeenSet ( ) const
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 649 of file PutItemRequest.h.

◆ ExpectedHasBeenSet()

bool Aws::DynamoDB::Model::PutItemRequest::ExpectedHasBeenSet ( ) const
inline

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

Definition at line 332 of file PutItemRequest.h.

◆ ExpressionAttributeNamesHasBeenSet()

bool Aws::DynamoDB::Model::PutItemRequest::ExpressionAttributeNamesHasBeenSet ( ) const
inline

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 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 in the Amazon DynamoDB Developer Guide.

Definition at line 788 of file PutItemRequest.h.

◆ ExpressionAttributeValuesHasBeenSet()

bool Aws::DynamoDB::Model::PutItemRequest::ExpressionAttributeValuesHasBeenSet ( ) const
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 1120 of file PutItemRequest.h.

◆ GetConditionalOperator()

const ConditionalOperator& Aws::DynamoDB::Model::PutItemRequest::GetConditionalOperator ( ) const
inline

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

Definition at line 580 of file PutItemRequest.h.

◆ GetConditionExpression()

const Aws::String& Aws::DynamoDB::Model::PutItemRequest::GetConditionExpression ( ) const
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 635 of file PutItemRequest.h.

◆ GetExpected()

const Aws::Map<Aws::String, ExpectedAttributeValue>& Aws::DynamoDB::Model::PutItemRequest::GetExpected ( ) const
inline

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

Definition at line 324 of file PutItemRequest.h.

◆ GetExpressionAttributeNames()

const Aws::Map<Aws::String, Aws::String>& Aws::DynamoDB::Model::PutItemRequest::GetExpressionAttributeNames ( ) const
inline

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 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 in the Amazon DynamoDB Developer Guide.

Definition at line 761 of file PutItemRequest.h.

◆ GetExpressionAttributeValues()

const Aws::Map<Aws::String, AttributeValue>& Aws::DynamoDB::Model::PutItemRequest::GetExpressionAttributeValues ( ) const
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 1103 of file PutItemRequest.h.

◆ GetItem()

const Aws::Map<Aws::String, AttributeValue>& Aws::DynamoDB::Model::PutItemRequest::GetItem ( ) const
inline

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Definition at line 106 of file PutItemRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::DynamoDB::Model::PutItemRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::DynamoDB::DynamoDBRequest.

◆ GetReturnConsumedCapacity()

const ReturnConsumedCapacity& Aws::DynamoDB::Model::PutItemRequest::GetReturnConsumedCapacity ( ) const
inline

Definition at line 507 of file PutItemRequest.h.

◆ GetReturnItemCollectionMetrics()

const ReturnItemCollectionMetrics& Aws::DynamoDB::Model::PutItemRequest::GetReturnItemCollectionMetrics ( ) const
inline

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.

Definition at line 531 of file PutItemRequest.h.

◆ GetReturnValues()

const ReturnValue& Aws::DynamoDB::Model::PutItemRequest::GetReturnValues ( ) const
inline

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.

Definition at line 428 of file PutItemRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::DynamoDB::Model::PutItemRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 41 of file PutItemRequest.h.

◆ GetTableName()

const Aws::String& Aws::DynamoDB::Model::PutItemRequest::GetTableName ( ) const
inline

The name of the table to contain the item.

Definition at line 51 of file PutItemRequest.h.

◆ ItemHasBeenSet()

bool Aws::DynamoDB::Model::PutItemRequest::ItemHasBeenSet ( ) const
inline

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Definition at line 125 of file PutItemRequest.h.

◆ ReturnConsumedCapacityHasBeenSet()

bool Aws::DynamoDB::Model::PutItemRequest::ReturnConsumedCapacityHasBeenSet ( ) const
inline

Definition at line 510 of file PutItemRequest.h.

◆ ReturnItemCollectionMetricsHasBeenSet()

bool Aws::DynamoDB::Model::PutItemRequest::ReturnItemCollectionMetricsHasBeenSet ( ) const
inline

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.

Definition at line 539 of file PutItemRequest.h.

◆ ReturnValuesHasBeenSet()

bool Aws::DynamoDB::Model::PutItemRequest::ReturnValuesHasBeenSet ( ) const
inline

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.

Definition at line 443 of file PutItemRequest.h.

◆ SerializePayload()

Aws::String Aws::DynamoDB::Model::PutItemRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetConditionalOperator() [1/2]

void Aws::DynamoDB::Model::PutItemRequest::SetConditionalOperator ( const ConditionalOperator value)
inline

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

Definition at line 596 of file PutItemRequest.h.

◆ SetConditionalOperator() [2/2]

void Aws::DynamoDB::Model::PutItemRequest::SetConditionalOperator ( ConditionalOperator &&  value)
inline

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

Definition at line 604 of file PutItemRequest.h.

◆ SetConditionExpression() [1/3]

void Aws::DynamoDB::Model::PutItemRequest::SetConditionExpression ( const Aws::String value)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 663 of file PutItemRequest.h.

◆ SetConditionExpression() [2/3]

void Aws::DynamoDB::Model::PutItemRequest::SetConditionExpression ( Aws::String &&  value)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 677 of file PutItemRequest.h.

◆ SetConditionExpression() [3/3]

void Aws::DynamoDB::Model::PutItemRequest::SetConditionExpression ( const char *  value)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 691 of file PutItemRequest.h.

◆ SetExpected() [1/2]

void Aws::DynamoDB::Model::PutItemRequest::SetExpected ( const Aws::Map< Aws::String, ExpectedAttributeValue > &  value)
inline

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

Definition at line 340 of file PutItemRequest.h.

◆ SetExpected() [2/2]

void Aws::DynamoDB::Model::PutItemRequest::SetExpected ( Aws::Map< Aws::String, ExpectedAttributeValue > &&  value)
inline

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

Definition at line 348 of file PutItemRequest.h.

◆ SetExpressionAttributeNames() [1/2]

void Aws::DynamoDB::Model::PutItemRequest::SetExpressionAttributeNames ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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 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 in the Amazon DynamoDB Developer Guide.

Definition at line 815 of file PutItemRequest.h.

◆ SetExpressionAttributeNames() [2/2]

void Aws::DynamoDB::Model::PutItemRequest::SetExpressionAttributeNames ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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 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 in the Amazon DynamoDB Developer Guide.

Definition at line 842 of file PutItemRequest.h.

◆ SetExpressionAttributeValues() [1/2]

void Aws::DynamoDB::Model::PutItemRequest::SetExpressionAttributeValues ( const Aws::Map< Aws::String, AttributeValue > &  value)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 1137 of file PutItemRequest.h.

◆ SetExpressionAttributeValues() [2/2]

void Aws::DynamoDB::Model::PutItemRequest::SetExpressionAttributeValues ( Aws::Map< Aws::String, AttributeValue > &&  value)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 1154 of file PutItemRequest.h.

◆ SetItem() [1/2]

void Aws::DynamoDB::Model::PutItemRequest::SetItem ( const Aws::Map< Aws::String, AttributeValue > &  value)
inline

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Definition at line 144 of file PutItemRequest.h.

◆ SetItem() [2/2]

void Aws::DynamoDB::Model::PutItemRequest::SetItem ( Aws::Map< Aws::String, AttributeValue > &&  value)
inline

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Definition at line 163 of file PutItemRequest.h.

◆ SetReturnConsumedCapacity() [1/2]

void Aws::DynamoDB::Model::PutItemRequest::SetReturnConsumedCapacity ( const ReturnConsumedCapacity value)
inline

Definition at line 513 of file PutItemRequest.h.

◆ SetReturnConsumedCapacity() [2/2]

void Aws::DynamoDB::Model::PutItemRequest::SetReturnConsumedCapacity ( ReturnConsumedCapacity &&  value)
inline

Definition at line 516 of file PutItemRequest.h.

◆ SetReturnItemCollectionMetrics() [1/2]

void Aws::DynamoDB::Model::PutItemRequest::SetReturnItemCollectionMetrics ( const ReturnItemCollectionMetrics value)
inline

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.

Definition at line 547 of file PutItemRequest.h.

◆ SetReturnItemCollectionMetrics() [2/2]

void Aws::DynamoDB::Model::PutItemRequest::SetReturnItemCollectionMetrics ( ReturnItemCollectionMetrics &&  value)
inline

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.

Definition at line 555 of file PutItemRequest.h.

◆ SetReturnValues() [1/2]

void Aws::DynamoDB::Model::PutItemRequest::SetReturnValues ( const ReturnValue value)
inline

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.

Definition at line 458 of file PutItemRequest.h.

◆ SetReturnValues() [2/2]

void Aws::DynamoDB::Model::PutItemRequest::SetReturnValues ( ReturnValue &&  value)
inline

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.

Definition at line 473 of file PutItemRequest.h.

◆ SetTableName() [1/3]

void Aws::DynamoDB::Model::PutItemRequest::SetTableName ( const Aws::String value)
inline

The name of the table to contain the item.

Definition at line 61 of file PutItemRequest.h.

◆ SetTableName() [2/3]

void Aws::DynamoDB::Model::PutItemRequest::SetTableName ( Aws::String &&  value)
inline

The name of the table to contain the item.

Definition at line 66 of file PutItemRequest.h.

◆ SetTableName() [3/3]

void Aws::DynamoDB::Model::PutItemRequest::SetTableName ( const char *  value)
inline

The name of the table to contain the item.

Definition at line 71 of file PutItemRequest.h.

◆ TableNameHasBeenSet()

bool Aws::DynamoDB::Model::PutItemRequest::TableNameHasBeenSet ( ) const
inline

The name of the table to contain the item.

Definition at line 56 of file PutItemRequest.h.

◆ WithConditionalOperator() [1/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithConditionalOperator ( const ConditionalOperator value)
inline

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

Definition at line 612 of file PutItemRequest.h.

◆ WithConditionalOperator() [2/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithConditionalOperator ( ConditionalOperator &&  value)
inline

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

Definition at line 620 of file PutItemRequest.h.

◆ WithConditionExpression() [1/3]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithConditionExpression ( const Aws::String value)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 705 of file PutItemRequest.h.

◆ WithConditionExpression() [2/3]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithConditionExpression ( Aws::String &&  value)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 719 of file PutItemRequest.h.

◆ WithConditionExpression() [3/3]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithConditionExpression ( const char *  value)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 733 of file PutItemRequest.h.

◆ WithExpected() [1/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithExpected ( const Aws::Map< Aws::String, ExpectedAttributeValue > &  value)
inline

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

Definition at line 356 of file PutItemRequest.h.

◆ WithExpected() [2/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithExpected ( Aws::Map< Aws::String, ExpectedAttributeValue > &&  value)
inline

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

Definition at line 364 of file PutItemRequest.h.

◆ WithExpressionAttributeNames() [1/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithExpressionAttributeNames ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

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 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 in the Amazon DynamoDB Developer Guide.

Definition at line 869 of file PutItemRequest.h.

◆ WithExpressionAttributeNames() [2/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithExpressionAttributeNames ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

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 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 in the Amazon DynamoDB Developer Guide.

Definition at line 896 of file PutItemRequest.h.

◆ WithExpressionAttributeValues() [1/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithExpressionAttributeValues ( const Aws::Map< Aws::String, AttributeValue > &  value)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 1171 of file PutItemRequest.h.

◆ WithExpressionAttributeValues() [2/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithExpressionAttributeValues ( Aws::Map< Aws::String, AttributeValue > &&  value)
inline

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 in the Amazon DynamoDB Developer Guide.

Definition at line 1188 of file PutItemRequest.h.

◆ WithItem() [1/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithItem ( const Aws::Map< Aws::String, AttributeValue > &  value)
inline

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Definition at line 182 of file PutItemRequest.h.

◆ WithItem() [2/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithItem ( Aws::Map< Aws::String, AttributeValue > &&  value)
inline

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

Definition at line 201 of file PutItemRequest.h.

◆ WithReturnConsumedCapacity() [1/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithReturnConsumedCapacity ( const ReturnConsumedCapacity value)
inline

Definition at line 519 of file PutItemRequest.h.

◆ WithReturnConsumedCapacity() [2/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithReturnConsumedCapacity ( ReturnConsumedCapacity &&  value)
inline

Definition at line 522 of file PutItemRequest.h.

◆ WithReturnItemCollectionMetrics() [1/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithReturnItemCollectionMetrics ( const ReturnItemCollectionMetrics value)
inline

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.

Definition at line 563 of file PutItemRequest.h.

◆ WithReturnItemCollectionMetrics() [2/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithReturnItemCollectionMetrics ( ReturnItemCollectionMetrics &&  value)
inline

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.

Definition at line 571 of file PutItemRequest.h.

◆ WithReturnValues() [1/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithReturnValues ( const ReturnValue value)
inline

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.

Definition at line 488 of file PutItemRequest.h.

◆ WithReturnValues() [2/2]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithReturnValues ( ReturnValue &&  value)
inline

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.

Definition at line 503 of file PutItemRequest.h.

◆ WithTableName() [1/3]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithTableName ( const Aws::String value)
inline

The name of the table to contain the item.

Definition at line 76 of file PutItemRequest.h.

◆ WithTableName() [2/3]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithTableName ( Aws::String &&  value)
inline

The name of the table to contain the item.

Definition at line 81 of file PutItemRequest.h.

◆ WithTableName() [3/3]

PutItemRequest& Aws::DynamoDB::Model::PutItemRequest::WithTableName ( const char *  value)
inline

The name of the table to contain the item.

Definition at line 86 of file PutItemRequest.h.


The documentation for this class was generated from the following file: