TransactGetItems method
Written by
Updated at February 10, 2023
A synchronous operation that atomically retrieves multiple items from tables.
The output is paginated. Up to 25 objects can be returned at a time, each of which contains a Get
structure. You can retrieve up to 4 MB of data per transaction.
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 |
An ordered array of objects of the TransactGetItem type, each of which contains a Get structure.Type: Array of TransactGetItem objectsArray items: 1-25. Required: Yes |
ReturnConsumedCapacity |
Indicates whether to return information about the consumed capacity.
Type: String Possible values: TOTAL | NONE Required: No |
Response
If successful, HTTP code 200 is returned.
The response is returned 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. Returned only if the ReturnConsumedCapacity parameter set to TOTAL is specified in the request.Type: Object of the ConsumedCapacity type. |
Responses |
An 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 isn't possible to get the item, the corresponding object's value is Null . If the item has no attributes, the corresponding object is empty.Type: Array of ItemResponse objectsArray size: 1-25 items. |
Errors
Parameter | Description |
---|---|
InternalServerError |
An internal error occurred on the server side. HTTP status code: 500 |
ProvisionedThroughputExceededException |
You're sending requests too often. Try to increase the interval between requests. If their number is not too large, Managed Service for YDB tries to process them all. HTTP status code: 400 |
RequestLimitExceeded |
The bandwidth exceeds the set quota. HTTP status code: 400 |
ResourceNotFoundException |
The specified table doesn't exist. HTTP status code: 400 |
TransactionCanceledException |
The entire request was canceled. This may happen in the following cases:
HTTP status code: 400 |
There may be common errors as well. These are errors that are common to all methods.