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

#include <TransactWriteItemsRequest.h>

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

Public Member Functions

 TransactWriteItemsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< TransactWriteItem > & GetTransactItems () const
 
bool TransactItemsHasBeenSet () const
 
void SetTransactItems (const Aws::Vector< TransactWriteItem > &value)
 
void SetTransactItems (Aws::Vector< TransactWriteItem > &&value)
 
TransactWriteItemsRequestWithTransactItems (const Aws::Vector< TransactWriteItem > &value)
 
TransactWriteItemsRequestWithTransactItems (Aws::Vector< TransactWriteItem > &&value)
 
TransactWriteItemsRequestAddTransactItems (const TransactWriteItem &value)
 
TransactWriteItemsRequestAddTransactItems (TransactWriteItem &&value)
 
const ReturnConsumedCapacityGetReturnConsumedCapacity () const
 
bool ReturnConsumedCapacityHasBeenSet () const
 
void SetReturnConsumedCapacity (const ReturnConsumedCapacity &value)
 
void SetReturnConsumedCapacity (ReturnConsumedCapacity &&value)
 
TransactWriteItemsRequestWithReturnConsumedCapacity (const ReturnConsumedCapacity &value)
 
TransactWriteItemsRequestWithReturnConsumedCapacity (ReturnConsumedCapacity &&value)
 
const ReturnItemCollectionMetricsGetReturnItemCollectionMetrics () const
 
bool ReturnItemCollectionMetricsHasBeenSet () const
 
void SetReturnItemCollectionMetrics (const ReturnItemCollectionMetrics &value)
 
void SetReturnItemCollectionMetrics (ReturnItemCollectionMetrics &&value)
 
TransactWriteItemsRequestWithReturnItemCollectionMetrics (const ReturnItemCollectionMetrics &value)
 
TransactWriteItemsRequestWithReturnItemCollectionMetrics (ReturnItemCollectionMetrics &&value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
TransactWriteItemsRequestWithClientRequestToken (const Aws::String &value)
 
TransactWriteItemsRequestWithClientRequestToken (Aws::String &&value)
 
TransactWriteItemsRequestWithClientRequestToken (const char *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

Definition at line 26 of file TransactWriteItemsRequest.h.

Constructor & Destructor Documentation

◆ TransactWriteItemsRequest()

Aws::DynamoDB::Model::TransactWriteItemsRequest::TransactWriteItemsRequest ( )

Member Function Documentation

◆ AddTransactItems() [1/2]

TransactWriteItemsRequest& Aws::DynamoDB::Model::TransactWriteItemsRequest::AddTransactItems ( const TransactWriteItem value)
inline

An ordered array of up to 25 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same AWS account and Region, and no two of them can operate on the same item.

Definition at line 103 of file TransactWriteItemsRequest.h.

◆ AddTransactItems() [2/2]

TransactWriteItemsRequest& Aws::DynamoDB::Model::TransactWriteItemsRequest::AddTransactItems ( TransactWriteItem &&  value)
inline

An ordered array of up to 25 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same AWS account and Region, and no two of them can operate on the same item.

Definition at line 112 of file TransactWriteItemsRequest.h.

◆ ClientRequestTokenHasBeenSet()

bool Aws::DynamoDB::Model::TransactWriteItemsRequest::ClientRequestTokenHasBeenSet ( ) const
inline

Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.

Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls might not be the same. If the ReturnConsumedCapacity> parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes. Subsequent TransactWriteItems calls with the same client token return the number of read capacity units consumed in reading the item.

A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

Definition at line 223 of file TransactWriteItemsRequest.h.

◆ GetClientRequestToken()

const Aws::String& Aws::DynamoDB::Model::TransactWriteItemsRequest::GetClientRequestToken ( ) const
inline

Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.

Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls might not be the same. If the ReturnConsumedCapacity> parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes. Subsequent TransactWriteItems calls with the same client token return the number of read capacity units consumed in reading the item.

A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

Definition at line 202 of file TransactWriteItemsRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::DynamoDB::DynamoDBRequest.

◆ GetReturnConsumedCapacity()

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

Definition at line 116 of file TransactWriteItemsRequest.h.

◆ GetReturnItemCollectionMetrics()

const ReturnItemCollectionMetrics& Aws::DynamoDB::Model::TransactWriteItemsRequest::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 and are returned in the response. If set to NONE (the default), no statistics are returned.

Definition at line 140 of file TransactWriteItemsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file TransactWriteItemsRequest.h.

◆ GetTransactItems()

const Aws::Vector<TransactWriteItem>& Aws::DynamoDB::Model::TransactWriteItemsRequest::GetTransactItems ( ) const
inline

An ordered array of up to 25 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same AWS account and Region, and no two of them can operate on the same item.

Definition at line 49 of file TransactWriteItemsRequest.h.

◆ ReturnConsumedCapacityHasBeenSet()

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

Definition at line 119 of file TransactWriteItemsRequest.h.

◆ ReturnItemCollectionMetricsHasBeenSet()

bool Aws::DynamoDB::Model::TransactWriteItemsRequest::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 and are returned in the response. If set to NONE (the default), no statistics are returned.

Definition at line 148 of file TransactWriteItemsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

void Aws::DynamoDB::Model::TransactWriteItemsRequest::SetClientRequestToken ( const Aws::String value)
inline

Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.

Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls might not be the same. If the ReturnConsumedCapacity> parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes. Subsequent TransactWriteItems calls with the same client token return the number of read capacity units consumed in reading the item.

A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

Definition at line 244 of file TransactWriteItemsRequest.h.

◆ SetClientRequestToken() [2/3]

void Aws::DynamoDB::Model::TransactWriteItemsRequest::SetClientRequestToken ( Aws::String &&  value)
inline

Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.

Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls might not be the same. If the ReturnConsumedCapacity> parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes. Subsequent TransactWriteItems calls with the same client token return the number of read capacity units consumed in reading the item.

A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

Definition at line 265 of file TransactWriteItemsRequest.h.

◆ SetClientRequestToken() [3/3]

void Aws::DynamoDB::Model::TransactWriteItemsRequest::SetClientRequestToken ( const char *  value)
inline

Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.

Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls might not be the same. If the ReturnConsumedCapacity> parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes. Subsequent TransactWriteItems calls with the same client token return the number of read capacity units consumed in reading the item.

A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

Definition at line 286 of file TransactWriteItemsRequest.h.

◆ SetReturnConsumedCapacity() [1/2]

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

Definition at line 122 of file TransactWriteItemsRequest.h.

◆ SetReturnConsumedCapacity() [2/2]

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

Definition at line 125 of file TransactWriteItemsRequest.h.

◆ SetReturnItemCollectionMetrics() [1/2]

void Aws::DynamoDB::Model::TransactWriteItemsRequest::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 and are returned in the response. If set to NONE (the default), no statistics are returned.

Definition at line 156 of file TransactWriteItemsRequest.h.

◆ SetReturnItemCollectionMetrics() [2/2]

void Aws::DynamoDB::Model::TransactWriteItemsRequest::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 and are returned in the response. If set to NONE (the default), no statistics are returned.

Definition at line 164 of file TransactWriteItemsRequest.h.

◆ SetTransactItems() [1/2]

void Aws::DynamoDB::Model::TransactWriteItemsRequest::SetTransactItems ( const Aws::Vector< TransactWriteItem > &  value)
inline

An ordered array of up to 25 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same AWS account and Region, and no two of them can operate on the same item.

Definition at line 67 of file TransactWriteItemsRequest.h.

◆ SetTransactItems() [2/2]

void Aws::DynamoDB::Model::TransactWriteItemsRequest::SetTransactItems ( Aws::Vector< TransactWriteItem > &&  value)
inline

An ordered array of up to 25 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same AWS account and Region, and no two of them can operate on the same item.

Definition at line 76 of file TransactWriteItemsRequest.h.

◆ TransactItemsHasBeenSet()

bool Aws::DynamoDB::Model::TransactWriteItemsRequest::TransactItemsHasBeenSet ( ) const
inline

An ordered array of up to 25 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same AWS account and Region, and no two of them can operate on the same item.

Definition at line 58 of file TransactWriteItemsRequest.h.

◆ WithClientRequestToken() [1/3]

TransactWriteItemsRequest& Aws::DynamoDB::Model::TransactWriteItemsRequest::WithClientRequestToken ( const Aws::String value)
inline

Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.

Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls might not be the same. If the ReturnConsumedCapacity> parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes. Subsequent TransactWriteItems calls with the same client token return the number of read capacity units consumed in reading the item.

A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

Definition at line 307 of file TransactWriteItemsRequest.h.

◆ WithClientRequestToken() [2/3]

TransactWriteItemsRequest& Aws::DynamoDB::Model::TransactWriteItemsRequest::WithClientRequestToken ( Aws::String &&  value)
inline

Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.

Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls might not be the same. If the ReturnConsumedCapacity> parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes. Subsequent TransactWriteItems calls with the same client token return the number of read capacity units consumed in reading the item.

A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

Definition at line 328 of file TransactWriteItemsRequest.h.

◆ WithClientRequestToken() [3/3]

TransactWriteItemsRequest& Aws::DynamoDB::Model::TransactWriteItemsRequest::WithClientRequestToken ( const char *  value)
inline

Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.

Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls might not be the same. If the ReturnConsumedCapacity> parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes. Subsequent TransactWriteItems calls with the same client token return the number of read capacity units consumed in reading the item.

A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

Definition at line 349 of file TransactWriteItemsRequest.h.

◆ WithReturnConsumedCapacity() [1/2]

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

Definition at line 128 of file TransactWriteItemsRequest.h.

◆ WithReturnConsumedCapacity() [2/2]

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

Definition at line 131 of file TransactWriteItemsRequest.h.

◆ WithReturnItemCollectionMetrics() [1/2]

TransactWriteItemsRequest& Aws::DynamoDB::Model::TransactWriteItemsRequest::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 and are returned in the response. If set to NONE (the default), no statistics are returned.

Definition at line 172 of file TransactWriteItemsRequest.h.

◆ WithReturnItemCollectionMetrics() [2/2]

TransactWriteItemsRequest& Aws::DynamoDB::Model::TransactWriteItemsRequest::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 and are returned in the response. If set to NONE (the default), no statistics are returned.

Definition at line 180 of file TransactWriteItemsRequest.h.

◆ WithTransactItems() [1/2]

TransactWriteItemsRequest& Aws::DynamoDB::Model::TransactWriteItemsRequest::WithTransactItems ( const Aws::Vector< TransactWriteItem > &  value)
inline

An ordered array of up to 25 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same AWS account and Region, and no two of them can operate on the same item.

Definition at line 85 of file TransactWriteItemsRequest.h.

◆ WithTransactItems() [2/2]

TransactWriteItemsRequest& Aws::DynamoDB::Model::TransactWriteItemsRequest::WithTransactItems ( Aws::Vector< TransactWriteItem > &&  value)
inline

An ordered array of up to 25 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same AWS account and Region, and no two of them can operate on the same item.

Definition at line 94 of file TransactWriteItemsRequest.h.


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