Contact UsTry it for free
© 2026 Direct Cursus Technology L.L.C.

TransactGetItems method

Written by
Updated at April 24, 2026

Performs a synchronous operation that atomically retrieves multiple items from tables.
The output is paginated. You can get up to 25 objects, each containing the Get structure, per method call. You can retrieve up to 4 MB of data per method call.

The method can be completely rejected with the reason described in the TransactionCanceledException error message.

Request

The request contains data in JSON format.

{
   "ReturnConsumedCapacity": "string",
   "TransactItems": [
      {
         "Get": {
            "ExpressionAttributeNames": {
               "string" : "string"
            },
            "Key": {
               "string" : {
                  "B": blob,
                  "BOOL": boolean,
                  "BS": [ blob ],
                  "L": [
                     "AttributeValue"
                  ],
                  "M": {
                     "string" : "AttributeValue"
                  },
                  "N": "string",
                  "NS": [ "string" ],
                  "NULL": boolean,
                  "S": "string",
                  "SS": [ "string" ]
               }
            },
            "ProjectionExpression": "string",
            "TableName": "string"
         }
      }
   ]
}

Parameters

Parameter Description
TransactItems Ordered array of objects of the TransactGetItem type, each of which contains the Get structure.

Type: Array of TransactGetItem objects
Array items: 1 to 25 items.
Required: Yes
ReturnConsumedCapacity Sets whether to return information about the consumed capacity.
  • TOTAL: Return.
  • NONE: Do not return.

Type: String
Possible values: TOTAL | NONE
Required: No

Response

If successful, HTTP code 200 is returned.
You will get data in JSON format.

{
   "ConsumedCapacity": [
      {
         "CapacityUnits": number,
         "GlobalSecondaryIndexes": {
            "string" : {
               "CapacityUnits": number,
               "ReadCapacityUnits": number,
               "WriteCapacityUnits": number
            }
         },
         "LocalSecondaryIndexes": {
            "string" : {
               "CapacityUnits": number,
               "ReadCapacityUnits": number,
               "WriteCapacityUnits": number
            }
         },
         "ReadCapacityUnits": number,
         "Table": {
            "CapacityUnits": number,
            "ReadCapacityUnits": number,
            "WriteCapacityUnits": number
         },
         "TableName": "string",
         "WriteCapacityUnits": number
      }
   ],
   "Responses": [
      {
         "Item": {
            "string" : {
               "B": blob,
               "BOOL": boolean,
               "BS": [ blob ],
               "L": [
                  "AttributeValue"
               ],
               "M": {
                  "string" : "AttributeValue"
               },
               "N": "string",
               "NS": [ "string" ],
               "NULL": boolean,
               "S": "string",
               "SS": [ "string" ]
            }
         }
      }
   ]
}

Parameters

Parameter Description
ConsumedCapacity Capacity units consumed by a delete operation.
It is returned only if you provide ReturnConsumedCapacity set to TOTAL in the request.

Type: Object of the ConsumedCapacity type.
Responses Ordered array of objects of the ItemResponse type.
Each object contains an associative array of key/value pairs that are attributes of the requested item.
If it is not possible to get the item, the matching object's value is Null. If the item has no attributes, the matching object is empty.

Type: Array of ItemResponse
Array size: 1 to 25 items.

Errors

Parameter Description
InternalServerError An internal error occurred on the server side.

HTTP status code: 500
ProvisionedThroughputExceededException Your request rate is too high. Try to reduce the frequency of requests.
If their number is not too large, Managed Service for YDB will try to process them all.

HTTP status code: 400
RequestLimitExceeded The throughput capacity exceeds the set quota.

HTTP status code: 400
ResourceNotFoundException The requested table does not exist.

HTTP status code: 400
TransactionCanceledException The entire request was canceled. This may happen in the following cases:
  • There is another ongoing TransactGetItems operation that conflicts with a concurrent PutItem, UpdateItem, DeleteItem, or TransactWriteItems request.
  • The provisioned capacity is insufficient to complete the transaction.
  • A user error occurred, such as invalid data format.


HTTP status code: 400

There may be some common errors as well shared by all methods.

Previous
Scan
Next
TransactWriteItems