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

#include <DeleteItemRequest.h>

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

Public Member Functions

 DeleteItemRequest ()
 
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)
 
DeleteItemRequestWithTableName (const Aws::String &value)
 
DeleteItemRequestWithTableName (Aws::String &&value)
 
DeleteItemRequestWithTableName (const char *value)
 
const Aws::Map< Aws::String, AttributeValue > & GetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (const Aws::Map< Aws::String, AttributeValue > &value)
 
void SetKey (Aws::Map< Aws::String, AttributeValue > &&value)
 
DeleteItemRequestWithKey (const Aws::Map< Aws::String, AttributeValue > &value)
 
DeleteItemRequestWithKey (Aws::Map< Aws::String, AttributeValue > &&value)
 
DeleteItemRequestAddKey (const Aws::String &key, const AttributeValue &value)
 
DeleteItemRequestAddKey (Aws::String &&key, const AttributeValue &value)
 
DeleteItemRequestAddKey (const Aws::String &key, AttributeValue &&value)
 
DeleteItemRequestAddKey (Aws::String &&key, AttributeValue &&value)
 
DeleteItemRequestAddKey (const char *key, AttributeValue &&value)
 
DeleteItemRequestAddKey (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)
 
DeleteItemRequestWithExpected (const Aws::Map< Aws::String, ExpectedAttributeValue > &value)
 
DeleteItemRequestWithExpected (Aws::Map< Aws::String, ExpectedAttributeValue > &&value)
 
DeleteItemRequestAddExpected (const Aws::String &key, const ExpectedAttributeValue &value)
 
DeleteItemRequestAddExpected (Aws::String &&key, const ExpectedAttributeValue &value)
 
DeleteItemRequestAddExpected (const Aws::String &key, ExpectedAttributeValue &&value)
 
DeleteItemRequestAddExpected (Aws::String &&key, ExpectedAttributeValue &&value)
 
DeleteItemRequestAddExpected (const char *key, ExpectedAttributeValue &&value)
 
DeleteItemRequestAddExpected (const char *key, const ExpectedAttributeValue &value)
 
const ConditionalOperatorGetConditionalOperator () const
 
bool ConditionalOperatorHasBeenSet () const
 
void SetConditionalOperator (const ConditionalOperator &value)
 
void SetConditionalOperator (ConditionalOperator &&value)
 
DeleteItemRequestWithConditionalOperator (const ConditionalOperator &value)
 
DeleteItemRequestWithConditionalOperator (ConditionalOperator &&value)
 
const ReturnValueGetReturnValues () const
 
bool ReturnValuesHasBeenSet () const
 
void SetReturnValues (const ReturnValue &value)
 
void SetReturnValues (ReturnValue &&value)
 
DeleteItemRequestWithReturnValues (const ReturnValue &value)
 
DeleteItemRequestWithReturnValues (ReturnValue &&value)
 
const ReturnConsumedCapacityGetReturnConsumedCapacity () const
 
bool ReturnConsumedCapacityHasBeenSet () const
 
void SetReturnConsumedCapacity (const ReturnConsumedCapacity &value)
 
void SetReturnConsumedCapacity (ReturnConsumedCapacity &&value)
 
DeleteItemRequestWithReturnConsumedCapacity (const ReturnConsumedCapacity &value)
 
DeleteItemRequestWithReturnConsumedCapacity (ReturnConsumedCapacity &&value)
 
const ReturnItemCollectionMetricsGetReturnItemCollectionMetrics () const
 
bool ReturnItemCollectionMetricsHasBeenSet () const
 
void SetReturnItemCollectionMetrics (const ReturnItemCollectionMetrics &value)
 
void SetReturnItemCollectionMetrics (ReturnItemCollectionMetrics &&value)
 
DeleteItemRequestWithReturnItemCollectionMetrics (const ReturnItemCollectionMetrics &value)
 
DeleteItemRequestWithReturnItemCollectionMetrics (ReturnItemCollectionMetrics &&value)
 
const Aws::StringGetConditionExpression () const
 
bool ConditionExpressionHasBeenSet () const
 
void SetConditionExpression (const Aws::String &value)
 
void SetConditionExpression (Aws::String &&value)
 
void SetConditionExpression (const char *value)
 
DeleteItemRequestWithConditionExpression (const Aws::String &value)
 
DeleteItemRequestWithConditionExpression (Aws::String &&value)
 
DeleteItemRequestWithConditionExpression (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)
 
DeleteItemRequestWithExpressionAttributeNames (const Aws::Map< Aws::String, Aws::String > &value)
 
DeleteItemRequestWithExpressionAttributeNames (Aws::Map< Aws::String, Aws::String > &&value)
 
DeleteItemRequestAddExpressionAttributeNames (const Aws::String &key, const Aws::String &value)
 
DeleteItemRequestAddExpressionAttributeNames (Aws::String &&key, const Aws::String &value)
 
DeleteItemRequestAddExpressionAttributeNames (const Aws::String &key, Aws::String &&value)
 
DeleteItemRequestAddExpressionAttributeNames (Aws::String &&key, Aws::String &&value)
 
DeleteItemRequestAddExpressionAttributeNames (const char *key, Aws::String &&value)
 
DeleteItemRequestAddExpressionAttributeNames (Aws::String &&key, const char *value)
 
DeleteItemRequestAddExpressionAttributeNames (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)
 
DeleteItemRequestWithExpressionAttributeValues (const Aws::Map< Aws::String, AttributeValue > &value)
 
DeleteItemRequestWithExpressionAttributeValues (Aws::Map< Aws::String, AttributeValue > &&value)
 
DeleteItemRequestAddExpressionAttributeValues (const Aws::String &key, const AttributeValue &value)
 
DeleteItemRequestAddExpressionAttributeValues (Aws::String &&key, const AttributeValue &value)
 
DeleteItemRequestAddExpressionAttributeValues (const Aws::String &key, AttributeValue &&value)
 
DeleteItemRequestAddExpressionAttributeValues (Aws::String &&key, AttributeValue &&value)
 
DeleteItemRequestAddExpressionAttributeValues (const char *key, AttributeValue &&value)
 
DeleteItemRequestAddExpressionAttributeValues (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 DeleteItem operation.

See Also:

AWS API Reference

Definition at line 32 of file DeleteItemRequest.h.

Constructor & Destructor Documentation

◆ DeleteItemRequest()

Aws::DynamoDB::Model::DeleteItemRequest::DeleteItemRequest ( )

Member Function Documentation

◆ AddExpected() [1/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 252 of file DeleteItemRequest.h.

◆ AddExpected() [2/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 260 of file DeleteItemRequest.h.

◆ AddExpected() [3/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 268 of file DeleteItemRequest.h.

◆ AddExpected() [4/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 276 of file DeleteItemRequest.h.

◆ AddExpected() [5/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 284 of file DeleteItemRequest.h.

◆ AddExpected() [6/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 292 of file DeleteItemRequest.h.

◆ AddExpressionAttributeNames() [1/7]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 791 of file DeleteItemRequest.h.

◆ AddExpressionAttributeNames() [2/7]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 818 of file DeleteItemRequest.h.

◆ AddExpressionAttributeNames() [3/7]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 845 of file DeleteItemRequest.h.

◆ AddExpressionAttributeNames() [4/7]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 872 of file DeleteItemRequest.h.

◆ AddExpressionAttributeNames() [5/7]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 899 of file DeleteItemRequest.h.

◆ AddExpressionAttributeNames() [6/7]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 926 of file DeleteItemRequest.h.

◆ AddExpressionAttributeNames() [7/7]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 953 of file DeleteItemRequest.h.

◆ AddExpressionAttributeValues() [1/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 1073 of file DeleteItemRequest.h.

◆ AddExpressionAttributeValues() [2/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 1090 of file DeleteItemRequest.h.

◆ AddExpressionAttributeValues() [3/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 1107 of file DeleteItemRequest.h.

◆ AddExpressionAttributeValues() [4/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 1124 of file DeleteItemRequest.h.

◆ AddExpressionAttributeValues() [5/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 1141 of file DeleteItemRequest.h.

◆ AddExpressionAttributeValues() [6/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 1158 of file DeleteItemRequest.h.

◆ AddKey() [1/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::AddKey ( const Aws::String key,
const AttributeValue value 
)
inline

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.

Definition at line 150 of file DeleteItemRequest.h.

◆ AddKey() [2/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::AddKey ( Aws::String &&  key,
const AttributeValue value 
)
inline

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.

Definition at line 159 of file DeleteItemRequest.h.

◆ AddKey() [3/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::AddKey ( const Aws::String key,
AttributeValue &&  value 
)
inline

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.

Definition at line 168 of file DeleteItemRequest.h.

◆ AddKey() [4/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::AddKey ( Aws::String &&  key,
AttributeValue &&  value 
)
inline

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.

Definition at line 177 of file DeleteItemRequest.h.

◆ AddKey() [5/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::AddKey ( const char *  key,
AttributeValue &&  value 
)
inline

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.

Definition at line 186 of file DeleteItemRequest.h.

◆ AddKey() [6/6]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::AddKey ( const char *  key,
const AttributeValue value 
)
inline

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.

Definition at line 195 of file DeleteItemRequest.h.

◆ ConditionalOperatorHasBeenSet()

bool Aws::DynamoDB::Model::DeleteItemRequest::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 309 of file DeleteItemRequest.h.

◆ ConditionExpressionHasBeenSet()

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

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

Definition at line 517 of file DeleteItemRequest.h.

◆ ExpectedHasBeenSet()

bool Aws::DynamoDB::Model::DeleteItemRequest::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 212 of file DeleteItemRequest.h.

◆ ExpressionAttributeNamesHasBeenSet()

bool Aws::DynamoDB::Model::DeleteItemRequest::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 656 of file DeleteItemRequest.h.

◆ ExpressionAttributeValuesHasBeenSet()

bool Aws::DynamoDB::Model::DeleteItemRequest::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 988 of file DeleteItemRequest.h.

◆ GetConditionalOperator()

const ConditionalOperator& Aws::DynamoDB::Model::DeleteItemRequest::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 301 of file DeleteItemRequest.h.

◆ GetConditionExpression()

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

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

Definition at line 503 of file DeleteItemRequest.h.

◆ GetExpected()

const Aws::Map<Aws::String, ExpectedAttributeValue>& Aws::DynamoDB::Model::DeleteItemRequest::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 204 of file DeleteItemRequest.h.

◆ GetExpressionAttributeNames()

const Aws::Map<Aws::String, Aws::String>& Aws::DynamoDB::Model::DeleteItemRequest::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 629 of file DeleteItemRequest.h.

◆ GetExpressionAttributeValues()

const Aws::Map<Aws::String, AttributeValue>& Aws::DynamoDB::Model::DeleteItemRequest::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 971 of file DeleteItemRequest.h.

◆ GetKey()

const Aws::Map<Aws::String, AttributeValue>& Aws::DynamoDB::Model::DeleteItemRequest::GetKey ( ) const
inline

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.

Definition at line 96 of file DeleteItemRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::DynamoDB::DynamoDBRequest.

◆ GetReturnConsumedCapacity()

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

Definition at line 424 of file DeleteItemRequest.h.

◆ GetReturnItemCollectionMetrics()

const ReturnItemCollectionMetrics& Aws::DynamoDB::Model::DeleteItemRequest::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 448 of file DeleteItemRequest.h.

◆ GetReturnValues()

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

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.

Definition at line 355 of file DeleteItemRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 41 of file DeleteItemRequest.h.

◆ GetTableName()

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

The name of the table from which to delete the item.

Definition at line 51 of file DeleteItemRequest.h.

◆ KeyHasBeenSet()

bool Aws::DynamoDB::Model::DeleteItemRequest::KeyHasBeenSet ( ) const
inline

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.

Definition at line 105 of file DeleteItemRequest.h.

◆ ReturnConsumedCapacityHasBeenSet()

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

Definition at line 427 of file DeleteItemRequest.h.

◆ ReturnItemCollectionMetricsHasBeenSet()

bool Aws::DynamoDB::Model::DeleteItemRequest::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 456 of file DeleteItemRequest.h.

◆ ReturnValuesHasBeenSet()

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

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.

Definition at line 368 of file DeleteItemRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetConditionalOperator() [1/2]

void Aws::DynamoDB::Model::DeleteItemRequest::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 317 of file DeleteItemRequest.h.

◆ SetConditionalOperator() [2/2]

void Aws::DynamoDB::Model::DeleteItemRequest::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 325 of file DeleteItemRequest.h.

◆ SetConditionExpression() [1/3]

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

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

Definition at line 531 of file DeleteItemRequest.h.

◆ SetConditionExpression() [2/3]

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

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

Definition at line 545 of file DeleteItemRequest.h.

◆ SetConditionExpression() [3/3]

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

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

Definition at line 559 of file DeleteItemRequest.h.

◆ SetExpected() [1/2]

void Aws::DynamoDB::Model::DeleteItemRequest::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 220 of file DeleteItemRequest.h.

◆ SetExpected() [2/2]

void Aws::DynamoDB::Model::DeleteItemRequest::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 228 of file DeleteItemRequest.h.

◆ SetExpressionAttributeNames() [1/2]

void Aws::DynamoDB::Model::DeleteItemRequest::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 683 of file DeleteItemRequest.h.

◆ SetExpressionAttributeNames() [2/2]

void Aws::DynamoDB::Model::DeleteItemRequest::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 710 of file DeleteItemRequest.h.

◆ SetExpressionAttributeValues() [1/2]

void Aws::DynamoDB::Model::DeleteItemRequest::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 1005 of file DeleteItemRequest.h.

◆ SetExpressionAttributeValues() [2/2]

void Aws::DynamoDB::Model::DeleteItemRequest::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 1022 of file DeleteItemRequest.h.

◆ SetKey() [1/2]

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

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.

Definition at line 114 of file DeleteItemRequest.h.

◆ SetKey() [2/2]

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

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.

Definition at line 123 of file DeleteItemRequest.h.

◆ SetReturnConsumedCapacity() [1/2]

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

Definition at line 430 of file DeleteItemRequest.h.

◆ SetReturnConsumedCapacity() [2/2]

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

Definition at line 433 of file DeleteItemRequest.h.

◆ SetReturnItemCollectionMetrics() [1/2]

void Aws::DynamoDB::Model::DeleteItemRequest::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 464 of file DeleteItemRequest.h.

◆ SetReturnItemCollectionMetrics() [2/2]

void Aws::DynamoDB::Model::DeleteItemRequest::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 472 of file DeleteItemRequest.h.

◆ SetReturnValues() [1/2]

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

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.

Definition at line 381 of file DeleteItemRequest.h.

◆ SetReturnValues() [2/2]

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

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.

Definition at line 394 of file DeleteItemRequest.h.

◆ SetTableName() [1/3]

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

The name of the table from which to delete the item.

Definition at line 61 of file DeleteItemRequest.h.

◆ SetTableName() [2/3]

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

The name of the table from which to delete the item.

Definition at line 66 of file DeleteItemRequest.h.

◆ SetTableName() [3/3]

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

The name of the table from which to delete the item.

Definition at line 71 of file DeleteItemRequest.h.

◆ TableNameHasBeenSet()

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

The name of the table from which to delete the item.

Definition at line 56 of file DeleteItemRequest.h.

◆ WithConditionalOperator() [1/2]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 333 of file DeleteItemRequest.h.

◆ WithConditionalOperator() [2/2]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 341 of file DeleteItemRequest.h.

◆ WithConditionExpression() [1/3]

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

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

Definition at line 573 of file DeleteItemRequest.h.

◆ WithConditionExpression() [2/3]

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

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

Definition at line 587 of file DeleteItemRequest.h.

◆ WithConditionExpression() [3/3]

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

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

Definition at line 601 of file DeleteItemRequest.h.

◆ WithExpected() [1/2]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 236 of file DeleteItemRequest.h.

◆ WithExpected() [2/2]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 244 of file DeleteItemRequest.h.

◆ WithExpressionAttributeNames() [1/2]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 737 of file DeleteItemRequest.h.

◆ WithExpressionAttributeNames() [2/2]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 764 of file DeleteItemRequest.h.

◆ WithExpressionAttributeValues() [1/2]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 1039 of file DeleteItemRequest.h.

◆ WithExpressionAttributeValues() [2/2]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 1056 of file DeleteItemRequest.h.

◆ WithKey() [1/2]

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

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.

Definition at line 132 of file DeleteItemRequest.h.

◆ WithKey() [2/2]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::WithKey ( Aws::Map< Aws::String, AttributeValue > &&  value)
inline

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.

Definition at line 141 of file DeleteItemRequest.h.

◆ WithReturnConsumedCapacity() [1/2]

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

Definition at line 436 of file DeleteItemRequest.h.

◆ WithReturnConsumedCapacity() [2/2]

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

Definition at line 439 of file DeleteItemRequest.h.

◆ WithReturnItemCollectionMetrics() [1/2]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 480 of file DeleteItemRequest.h.

◆ WithReturnItemCollectionMetrics() [2/2]

DeleteItemRequest& Aws::DynamoDB::Model::DeleteItemRequest::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 488 of file DeleteItemRequest.h.

◆ WithReturnValues() [1/2]

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

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.

Definition at line 407 of file DeleteItemRequest.h.

◆ WithReturnValues() [2/2]

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

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.

Definition at line 420 of file DeleteItemRequest.h.

◆ WithTableName() [1/3]

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

The name of the table from which to delete the item.

Definition at line 76 of file DeleteItemRequest.h.

◆ WithTableName() [2/3]

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

The name of the table from which to delete the item.

Definition at line 81 of file DeleteItemRequest.h.

◆ WithTableName() [3/3]

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

The name of the table from which to delete the item.

Definition at line 86 of file DeleteItemRequest.h.


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