Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-dynamodb:amazon-dynamodb-transactions-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: Amazon DynamoDB Transactions API
version: '2012-08-10'
description: Generated from AWS's published Smithy model for Amazon DynamoDB. 3 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://dynamodb.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/#ExecuteTransaction:
post:
operationId: ExecuteTransaction
summary: Execute Transaction
description: This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.
The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction.
The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a
similar manner to ConditionCheck in the TransactWriteItems API.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ExecuteTransactionOutput'
'400':
description: IdempotentParameterMismatchException; ProvisionedThroughputExceededException; RequestLimitExceeded;
ResourceNotFoundException; ThrottlingException; TransactionCanceledException; TransactionInProgressException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/IdempotentParameterMismatchException'
'500':
description: InternalServerError
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerError'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- DynamoDB_20120810.ExecuteTransaction
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ExecuteTransactionInput'
tags:
- Transactions
/#TransactGetItems:
post:
operationId: TransactGetItems
summary: Transact Get Items
description: 'TransactGetItems is a synchronous operation that atomically retrieves multiple items from one or more
tables (but not from indexes) in a single account and Region. A TransactGetItems call can contain up to 100 TransactGetItem
objects, each of which contains a Get structure that specifies an item to retrieve from a table in the account and
Region. A call to TransactGetItems cannot retrieve items from tables in more than one Amazon Web Services account
or Region. The aggregate size of the items in the transaction cannot exceed 4 MB. DynamoDB rejects the entire TransactGetItems
request if any of the following is true: A conflicting operation is in the process of updating an item to be read.
There is insufficient provisioned capacity for the transaction to be completed. There is a user error, such as an
invalid data format. The aggregate size of the items in the transaction exceeded 4 MB.'
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/TransactGetItemsOutput'
'500':
description: InternalServerError
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerError'
'421':
description: InvalidEndpointException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InvalidEndpointException'
'400':
description: ProvisionedThroughputExceededException; RequestLimitExceeded; ResourceNotFoundException; ThrottlingException;
TransactionCanceledException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ProvisionedThroughputExceededException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- DynamoDB_20120810.TransactGetItems
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/TransactGetItemsInput'
tags:
- Transactions
/#TransactWriteItems:
post:
operationId: TransactWriteItems
summary: Transact Write Items
description: 'TransactWriteItems is a synchronous write operation that groups up to 100 action requests. These actions
can target items in different tables, but not in different Amazon Web Services accounts or Regions, and no two actions
can target the same item. For example, you cannot both ConditionCheck and Update the same item. The aggregate size
of the items in the transaction cannot exceed 4 MB. The actions are completed atomically so that either all of them
succeed, or all of them fail. They are defined by the following objects: Put — Initiates a PutItem operation to write
a new item. This structure specifies the primary key of the item to be written, the name of the table to write it
in, an optional condition expression that must be satisfied for the write to succeed, a list of the item''s attributes,
and a field indicating whether to retrieve the item''s attributes if the condition is not met. Update — Initiates
an UpdateItem operation to update an existing item. This structure specifies the primary key of the item to be updated,
the name of the table where it resides, an optional condition expression that must be satisfied for the update to
succeed, an expression that defines one or more'
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/TransactWriteItemsOutput'
'400':
description: IdempotentParameterMismatchException; ProvisionedThroughputExceededException; RequestLimitExceeded;
ResourceNotFoundException; ThrottlingException; TransactionCanceledException; TransactionInProgressException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/IdempotentParameterMismatchException'
'500':
description: InternalServerError
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerError'
'421':
description: InvalidEndpointException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InvalidEndpointException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- DynamoDB_20120810.TransactWriteItems
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/TransactWriteItemsInput'
tags:
- Transactions
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: dynamodb
schemas:
AttributeValue:
type: object
properties:
S:
type: string
description: 'An attribute of type String. For example: "S": "Hello"'
N:
type: string
description: 'An attribute of type Number. For example: "N": "123.45" Numbers are sent across the network to DynamoDB
as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number
type attributes for mathematical operations.'
B:
type: string
format: byte
description: 'An attribute of type Binary. For example: "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"'
SS:
type: array
items:
type: string
description: 'An attribute of type String Set. For example: "SS": ["Giraffe", "Hippo" ,"Zebra"]'
NS:
type: array
items:
type: string
description: 'An attribute of type Number Set. For example: "NS": ["42.2", "-19", "7.5", "3.14"] Numbers are sent
across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However,
DynamoDB treats them as number type attributes for mathematical operations.'
BS:
type: array
items:
type: string
format: byte
description: 'An attribute of type Binary Set. For example: "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]'
M:
type: object
additionalProperties:
$ref: '#/components/schemas/AttributeValue'
description: 'An attribute of type Map. For example: "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}'
L:
type: array
items:
$ref: '#/components/schemas/AttributeValue'
description: 'An attribute of type List. For example: "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]'
'NULL':
type: boolean
description: 'An attribute of type Null. For example: "NULL": true'
BOOL:
type: boolean
description: 'An attribute of type Boolean. For example: "BOOL": true'
description: Exactly one member is set.
Capacity:
type: object
properties:
ReadCapacityUnits:
type: number
description: The total number of read capacity units consumed on a table or an index.
WriteCapacityUnits:
type: number
description: The total number of write capacity units consumed on a table or an index.
CapacityUnits:
type: number
description: The total number of capacity units consumed on a table or an index.
ConditionCheck:
type: object
properties:
Key:
type: object
additionalProperties:
$ref: '#/components/schemas/AttributeValue'
description: The primary key of the item to be checked. Each element consists of an attribute name and a value for
that attribute.
TableName:
type: string
description: Name of the table for the check item request. You can also provide the Amazon Resource Name (ARN) of
the table in this parameter.
ConditionExpression:
type: string
description: A condition that must be satisfied in order for a conditional update to succeed. For more information,
see Condition expressions in the Amazon DynamoDB Developer Guide.
ExpressionAttributeNames:
type: object
additionalProperties:
type: string
description: One or more substitution tokens for attribute names in an expression. For more information, see Expression
attribute names in the Amazon DynamoDB Developer Guide.
ExpressionAttributeValues:
type: object
additionalProperties:
$ref: '#/components/schemas/AttributeValue'
description: One or more values that can be substituted in an expression. For more information, see Condition expressions
in the Amazon DynamoDB Developer Guide.
ReturnValuesOnConditionCheckFailure:
type: string
enum:
- ALL_OLD
- NONE
description: 'Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition
fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.'
required:
- Key
- TableName
- ConditionExpression
ConsumedCapacity:
type: object
properties:
TableName:
type: string
description: The name of the table that was affected by the operation. If you had specified the Amazon Resource
Name (ARN) of a table in the input, you'll see the table ARN in the response.
CapacityUnits:
type: number
description: The total number of capacity units consumed by the operation.
ReadCapacityUnits:
type: number
description: The total number of read capacity units consumed by the operation.
WriteCapacityUnits:
type: number
description: The total number of write capacity units consumed by the operation.
Table:
$ref: '#/components/schemas/Capacity'
LocalSecondaryIndexes:
type: object
additionalProperties:
$ref: '#/components/schemas/Capacity'
description: The amount of throughput consumed on each local index affected by the operation.
GlobalSecondaryIndexes:
type: object
additionalProperties:
$ref: '#/components/schemas/Capacity'
description: The amount of throughput consumed on each global index affected by the operation.
VectorIndexes:
type: object
additionalProperties:
$ref: '#/components/schemas/VectorCapacity'
description: The amount of throughput consumed on each vector index affected by the operation. Each entry contains
VectorWriteRequestBytes (for write operations) or VectorSearchRequestBytes (for search operations).
Delete:
type: object
properties:
Key:
type: object
additionalProperties:
$ref: '#/components/schemas/AttributeValue'
description: The primary key of the item to be deleted. Each element consists of an attribute name and a value for
that attribute.
TableName:
type: string
description: Name of the table in which the item to be deleted resides. You can also provide the Amazon Resource
Name (ARN) of the table in this parameter.
ConditionExpression:
type: string
description: A condition that must be satisfied in order for a conditional delete to succeed.
ExpressionAttributeNames:
type: object
additionalProperties:
type: string
description: One or more substitution tokens for attribute names in an expression.
ExpressionAttributeValues:
type: object
additionalProperties:
$ref: '#/components/schemas/AttributeValue'
description: One or more values that can be substituted in an expression.
ReturnValuesOnConditionCheckFailure:
type: string
enum:
- ALL_OLD
- NONE
description: 'Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails.
For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.'
required:
- Key
- TableName
ExecuteTransactionInput:
type: object
properties:
TransactStatements:
type: array
items:
$ref: '#/components/schemas/ParameterizedStatement'
description: The list of PartiQL statements representing the transaction to run.
ClientRequestToken:
type: string
description: Set this value to get remaining results, if NextToken was returned in the statement response.
ReturnConsumedCapacity:
type: string
enum:
- INDEXES
- TOTAL
- NONE
description: Determines the level of detail about either provisioned or on-demand throughput consumption that is
returned in the response. For more information, see TransactGetItems and TransactWriteItems.
required:
- TransactStatements
ExecuteTransactionOutput:
type: object
properties:
Responses:
type: array
items:
$ref: '#/components/schemas/ItemResponse'
description: The response to a PartiQL transaction.
ConsumedCapacity:
type: array
items:
$ref: '#/components/schemas/ConsumedCapacity'
description: The capacity units consumed by the entire operation. The values of the list are ordered according to
the ordering of the statements.
Get:
type: object
properties:
Key:
type: object
additionalProperties:
$ref: '#/components/schemas/AttributeValue'
description: A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve.
TableName:
type: string
description: The name of the table from which to retrieve the specified item. You can also provide the Amazon Resource
Name (ARN) of the table in this parameter.
ProjectionExpression:
type: string
description: A string that identifies one or more attributes of the specified item to retrieve from the table. The
attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes
of the specified item are returned. If any of the requested attributes are not found, they do not appear in the
result.
ExpressionAttributeNames:
type: object
additionalProperties:
type: string
description: One or more substitution tokens for attribute names in the ProjectionExpression parameter.
required:
- Key
- TableName
IdempotentParameterMismatchException:
type: object
properties:
Message:
type: string
InternalServerError:
type: object
properties:
message:
type: string
description: The server encountered an internal error trying to fulfill the request.
InvalidEndpointException:
type: object
properties:
Message:
type: string
ItemCollectionMetrics:
type: object
properties:
ItemCollectionKey:
type: object
additionalProperties:
$ref: '#/components/schemas/AttributeValue'
description: The partition key value of the item collection. This value is the same as the partition key value of
the item.
SizeEstimateRangeGB:
type: array
items:
type: number
description: An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower
bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus
the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate
to measure whether a local secondary index is approaching its size limit. The estimate is subject to change over
time; therefore, do not rely on the precision or accuracy of the estimate.
ItemResponse:
type: object
properties:
Item:
type: object
additionalProperties:
$ref: '#/components/schemas/AttributeValue'
description: Map of attribute data consisting of the data type and attribute value.
ParameterizedStatement:
type: object
properties:
Statement:
type: string
description: A PartiQL statement that uses parameters.
Parameters:
type: array
items:
$ref: '#/components/schemas/AttributeValue'
description: The parameter values.
ReturnValuesOnConditionCheckFailure:
type: string
enum:
- ALL_OLD
- NONE
description: An optional parameter that returns the item attributes for a PartiQL ParameterizedStatement operation
that failed a condition check. There is no additional cost associated with requesting a return value aside from
the small network and processing overhead of receiving a larger response. No read capacity units are consumed.
required:
- Statement
ProvisionedThroughputExceededException:
type: object
properties:
message:
type: string
description: You exceeded your maximum allowed provisioned throughput.
ThrottlingReasons:
type: array
items:
$ref: '#/components/schemas/ThrottlingReason'
description: A list of ThrottlingReason that provide detailed diagnostic information about why the request was throttled.
Put:
type: object
properties:
Item:
type: object
additionalProperties:
$ref: '#/components/schemas/AttributeValue'
description: A map of attribute name to attribute values, representing the primary key of the item to be written
by PutItem. All of the table's primary key attributes must be specified, and their data types must match those
of the table's key schema. If any attributes are present in the item that are part of an index key schema for
the table, their types must match the index key schema.
TableName:
type: string
description: Name of the table in which to write the item. You can also provide the Amazon Resource Name (ARN) of
the table in this parameter.
ConditionExpression:
type: string
description: A condition that must be satisfied in order for a conditional update to succeed.
ExpressionAttributeNames:
type: object
additionalProperties:
type: string
description: One or more substitution tokens for attribute names in an expression.
ExpressionAttributeValues:
type: object
additionalProperties:
$ref: '#/components/schemas/AttributeValue'
description: One or more values that can be substituted in an expression.
ReturnValuesOnConditionCheckFailure:
type: string
enum:
- ALL_OLD
- NONE
description: 'Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails. For
ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.'
required:
- Item
- TableName
ThrottlingReason:
type: object
properties:
reason:
type: string
description: 'The reason for throttling. The throttling reason follows a specific format: ResourceType+OperationType+LimitType:
Resource Type (What is being throttled): Table or Index Operation Type (What kind of operation): Read or Write
Limit Type (Why the throttling occurred): ProvisionedThroughputExceeded: The request rate is exceeding the provisioned
throughput capacity (read or write capacity units) configured for a table or a global secondary index (GSI) in
provisioned capacity mode. AccountLimitExceeded: The request rate has caused a table or global secondary index
(GSI) in on-demand mode to exceed '
resource:
type: string
description: The Amazon Resource Name (ARN) of the DynamoDB table or index that experienced the throttling event.
TransactGetItem:
type: object
properties:
Get:
$ref: '#/components/schemas/Get'
required:
- Get
TransactGetItemsInput:
type: object
properties:
TransactItems:
type: array
items:
$ref: '#/components/schemas/TransactGetItem'
description: An ordered array of up to 100 TransactGetItem objects, each of which contains a Get structure.
ReturnConsumedCapacity:
type: string
enum:
- INDEXES
- TOTAL
- NONE
description: A value of TOTAL causes consumed capacity information to be returned, and a value of NONE prevents
that information from being returned. No other value is valid.
required:
- TransactItems
TransactGetItemsOutput:
type: object
properties:
ConsumedCapacity:
type: array
items:
$ref: '#/components/schemas/ConsumedCapacity'
description: If the ReturnConsumedCapacity value was TOTAL, this is an array of ConsumedCapacity objects, one for
each table addressed by TransactGetItem objects in the TransactItems parameter. These ConsumedCapacity objects
report the read-capacity units consumed by the TransactGetItems call in that table.
Responses:
type: array
items:
$ref: '#/components/schemas/ItemResponse'
description: An ordered array of up to 100 ItemResponse objects, each of which corresponds to the TransactGetItem
object in the same position in the TransactItems array. Each ItemResponse object contains a Map of the name-value
pairs that are the projected attributes of the requested item. If a requested item could not be retrieved, the
corresponding ItemResponse object is Null, or if the requested item has no projected attributes, the corresponding
ItemResponse object is an empty Map.
TransactWriteItem:
type: object
properties:
ConditionCheck:
$ref: '#/components/schemas/ConditionCheck'
Put:
$ref: '#/components/schemas/Put'
Delete:
$ref: '#/components/schemas/Delete'
Update:
$ref: '#/components/schemas/Update'
TransactWriteItemsInput:
type: object
properties:
TransactItems:
type: array
items:
$ref: '#/components/schemas/TransactWriteItem'
description: An ordered array of up to 100 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
Amazon Web Services account and Region, and no two of them can operate on the same item.
ReturnConsumedCapacity:
type: string
enum:
- INDEXES
- TOTAL
- NONE
ReturnItemCollectionMetrics:
type: string
enum:
- SIZE
- NONE
description: 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.
ClientRequestToken:
type: string
description: 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 un
required:
- TransactItems
TransactWriteItemsOutput:
type: object
properties:
ConsumedCapacity:
type: array
items:
$ref: '#/components/schemas/ConsumedCapacity'
description: The capacity units consumed by the entire TransactWriteItems operation. The values of the list are
ordered according to the ordering of the TransactItems request parameter. If the table has vector indexes, each
element also includes a VectorIndexes field with VectorWriteRequestBytes consumed for each affected vector index.
ItemCollectionMetrics:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/ItemCollectionMetrics'
description: A list of tables that were processed by TransactWriteItems and, for each table, information about any
item collections that were affected by individual UpdateItem, PutItem, or DeleteItem operations.
Update:
type: object
properties:
Key:
type: object
additionalProperties:
$ref: '#/components/schemas/AttributeValue'
description: The primary key of the item to be updated. Each element consists of an attribute name and a value for
that attribute.
UpdateExpression:
type: string
description: An expression that defines one or more attributes to be updated, the action to be performed on them,
and new value(s) for them.
TableName:
type: string
description: Name of the table for the UpdateItem request. You can also provide the Amazon Resource Name (ARN) of
the table in this parameter.
ConditionExpression:
type: string
description: A condition that must be satisfied in order for a conditional update to succeed.
ExpressionAttributeNames:
type: object
additionalProperties:
type: string
description: One or more substitution tokens for attribute names in an expression.
ExpressionAttributeValues:
type: object
additionalProperties:
$ref: '#/components/schemas/AttributeValue'
description: One or more values that can be substituted in an expression.
ReturnValuesOnConditionCheckFailure:
type: string
enum:
- ALL_OLD
- NONE
description: 'Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails.
For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.'
required:
- Key
- UpdateExpression
- TableName
VectorCapacity:
type: object
properties:
VectorSearchRequestBytes:
type: number
description: The number of vector search request bytes consumed by a SearchVectors operation.
VectorWriteRequestBytes:
type: number
description: The number of vector write request bytes consumed when writing to a vector index. Reported for write
operations that modify attributes indexed by a vector index.
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/dynamodb/service/2012-08-10/dynamodb-2012-08-10.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)