Amazon Web Services, Inc.

Amazon DynamoDB

Amazon DynamoDB Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB…

Data & analytics#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon DynamoDB
Amazon DynamoDB is a fully managed NoSQL database service that provides fast
and predictable performance with seamless scalability. DynamoDB lets you
offload the administrative burdens of operating and scaling a distributed database, so
that you don't have to worry about hardware provisioning, setup and configuration,
replication, software patching, or cluster scaling.
With DynamoDB, you can create database tables that can store and retrieve
any amount of data, and serve any level of request traffic. You can scale up or scale
down your tables' throughput capacity without downtime or performance degradation, and
use the Amazon Web Services Management Console to monitor resource utilization and performance
metrics.
DynamoDB automatically spreads the data and traffic for your tables over
a sufficient number of servers to handle your throughput and storage requirements, while
maintaining consistent and fast performance. All of your data is stored on solid state
disks (SSDs) and automatically replicated across multiple Availability Zones in an
Amazon Web Services Region, providing built-in high availability and data
durability.

Endpoints 62

  • POSTBatch execute statement/#X-Amz-Target=DynamoDB_20120810.BatchExecuteStatementThis operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must…
  • POSTBatch get item/#X-Amz-Target=DynamoDB_20120810.BatchGetItemThe BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key. A single…
  • POSTBatch write item/#X-Amz-Target=DynamoDB_20120810.BatchWriteItemThe BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the…
  • POSTCancel bulk operation/#X-Amz-Target=DynamoDB_20120810.CancelBulkOperationCancels an in-progress bulk operation asynchronously. Cancellation doesn't remove items that the operation has already written. Use DescribeBulkOperation to…
  • POSTCreate backup/#X-Amz-Target=DynamoDB_20120810.CreateBackupCreates a backup for an existing table. Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of…
  • POSTCreate global table/#X-Amz-Target=DynamoDB_20120810.CreateGlobalTableCreates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name…
  • POSTCreate table/#X-Amz-Target=DynamoDB_20120810.CreateTableThe CreateTable operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can…
  • POSTDelete backup/#X-Amz-Target=DynamoDB_20120810.DeleteBackupDeletes an existing backup of a table. You can call DeleteBackup at a maximum rate of 10 times per second.
  • POSTDelete item/#X-Amz-Target=DynamoDB_20120810.DeleteItemDeletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected…
  • POSTDelete resource policy/#X-Amz-Target=DynamoDB_20120810.DeleteResourcePolicyDeletes the resource-based policy attached to the resource, which can be a table or stream. DeleteResourcePolicy is an idempotent operation; running it…
  • POSTDelete table/#X-Amz-Target=DynamoDB_20120810.DeleteTableThe DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB…
  • POSTDescribe backup/#X-Amz-Target=DynamoDB_20120810.DescribeBackupDescribes an existing backup of a table. You can call DescribeBackup at a maximum rate of 10 times per second.
  • POSTDescribe bulk operation/#X-Amz-Target=DynamoDB_20120810.DescribeBulkOperationDescribes the specified bulk operation.
  • POSTDescribe continuous backups/#X-Amz-Target=DynamoDB_20120810.DescribeContinuousBackupsChecks the status of continuous backups and point in time recovery on the specified table. Continuous backups are ENABLED on all tables at table creation. If…
  • POSTDescribe contributor insights/#X-Amz-Target=DynamoDB_20120810.DescribeContributorInsightsReturns information about contributor insights for a given table or global secondary index.
  • POSTDescribe endpoints/#X-Amz-Target=DynamoDB_20120810.DescribeEndpointsReturns the regional endpoint information. For more information on policy permissions, please see Internetwork traffic privacy .
  • POSTDescribe export/#X-Amz-Target=DynamoDB_20120810.DescribeExportDescribes an existing table export.
  • POSTDescribe global table/#X-Amz-Target=DynamoDB_20120810.DescribeGlobalTableReturns information about the specified global table. This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new…
  • POSTDescribe global table settings/#X-Amz-Target=DynamoDB_20120810.DescribeGlobalTableSettingsDescribes Region-specific settings for a global table. This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new…
  • POSTDescribe import/#X-Amz-Target=DynamoDB_20120810.DescribeImportRepresents the properties of the import.
  • POSTDescribe kinesis streaming destination/#X-Amz-Target=DynamoDB_20120810.DescribeKinesisStreamingDestinationReturns information about the status of Kinesis streaming.
  • POSTDescribe limits/#X-Amz-Target=DynamoDB_20120810.DescribeLimitsReturns the current provisioned-capacity quotas for your Amazon Web Services account in a Region, both for the Region as a whole and for any one DynamoDB…
  • POSTDescribe table/#X-Amz-Target=DynamoDB_20120810.DescribeTableReturns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table. If…
  • POSTDescribe table replica auto scaling/#X-Amz-Target=DynamoDB_20120810.DescribeTableReplicaAutoScalingDescribes auto scaling settings across replicas of the global table at once.
  • POSTDescribe time to live/#X-Amz-Target=DynamoDB_20120810.DescribeTimeToLiveGives a description of the Time to Live (TTL) status on the specified table.
  • POSTDisable kinesis streaming destination/#X-Amz-Target=DynamoDB_20120810.DisableKinesisStreamingDestinationStops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources.
  • POSTEnable kinesis streaming destination/#X-Amz-Target=DynamoDB_20120810.EnableKinesisStreamingDestinationStarts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow. If this operation doesn't return results…
  • POSTExecute statement/#X-Amz-Target=DynamoDB_20120810.ExecuteStatementThis operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL. For PartiQL reads ( SELECT statement), if the total…
  • POSTExecute transaction/#X-Amz-Target=DynamoDB_20120810.ExecuteTransactionThis operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL. The entire transaction must consist of either…
  • POSTExport table to point in time/#X-Amz-Target=DynamoDB_20120810.ExportTableToPointInTimeExports table data to an S3 bucket. The table must have point in time recovery enabled, and you can export data from any time within the point in time…
  • POSTGet item/#X-Amz-Target=DynamoDB_20120810.GetItemThe GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data and…
  • POSTGet resource policy/#X-Amz-Target=DynamoDB_20120810.GetResourcePolicyReturns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format. GetResourcePolicy follows an eventually…
  • POSTImport table/#X-Amz-Target=DynamoDB_20120810.ImportTableImports table data from an S3 bucket.
  • POSTList backups/#X-Amz-Target=DynamoDB_20120810.ListBackupsList DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup. To list these backups for a…
  • POSTList bulk operations/#X-Amz-Target=DynamoDB_20120810.ListBulkOperationsLists bulk operations that started within the past 90 days for the current Amazon Web Services account and Amazon Web Services Region, with the most recent…
  • POSTList contributor insights/#X-Amz-Target=DynamoDB_20120810.ListContributorInsightsReturns a list of ContributorInsightsSummary for a table and all its global secondary indexes.
  • POSTList exports/#X-Amz-Target=DynamoDB_20120810.ListExportsLists completed exports within the past 90 days, in reverse alphanumeric order of ExportArn .
  • POSTList global tables/#X-Amz-Target=DynamoDB_20120810.ListGlobalTablesLists all global tables that have a replica in the specified Region. This documentation is for version 2017.11.29 (Legacy) of global tables, which should be…
  • POSTList imports/#X-Amz-Target=DynamoDB_20120810.ListImportsLists completed imports within the past 90 days.
  • POSTList tables/#X-Amz-Target=DynamoDB_20120810.ListTablesReturns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum…
  • POSTList tags of resource/#X-Amz-Target=DynamoDB_20120810.ListTagsOfResourceList all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account. For an overview on tagging DynamoDB…
  • POSTPut item/#X-Amz-Target=DynamoDB_20120810.PutItemCreates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table,…
  • POSTPut resource policy/#X-Amz-Target=DynamoDB_20120810.PutResourcePolicyAttaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy…
  • POSTQuery/#X-Amz-Target=DynamoDB_20120810.QueryYou must provide the name of the partition key attribute and a single value for that attribute. Query returns all items with that partition key value.…
  • POSTRestore table from backup/#X-Amz-Target=DynamoDB_20120810.RestoreTableFromBackupCreates a new table from an existing backup. Any number of users can execute up to 50 concurrent restores (any type of restore) in a given account. You can…
  • POSTRestore table to point in time/#X-Amz-Target=DynamoDB_20120810.RestoreTableToPointInTimeRestores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime . You can restore your table to any…
  • POSTScan/#X-Amz-Target=DynamoDB_20120810.ScanThe Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items,…
  • POSTSearch vectors/#X-Amz-Target=DynamoDB_20120810.SearchVectorsPerforms a vector similarity search on a vector index associated with an Amazon DynamoDB table, and returns the most similar items sorted by similarity score…
  • POSTStart bulk put items/#X-Amz-Target=DynamoDB_20120810.StartBulkPutItemsStarts an asynchronous bulk operation that reads items from Amazon S3 and writes them to an existing DynamoDB table, so you can efficiently load or migrate…
  • POSTTag resource/#X-Amz-Target=DynamoDB_20120810.TagResourceAssociate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management…
  • POSTTransact get items/#X-Amz-Target=DynamoDB_20120810.TransactGetItemsTransactGetItems is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and…
  • POSTTransact write items/#X-Amz-Target=DynamoDB_20120810.TransactWriteItemsTransactWriteItems is a synchronous write operation that groups up to 100 action requests. These actions can target items in different tables, but not in…
  • POSTUntag resource/#X-Amz-Target=DynamoDB_20120810.UntagResourceRemoves the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to five times per second, per account. UntagResource is an…
  • POSTUpdate continuous backups/#X-Amz-Target=DynamoDB_20120810.UpdateContinuousBackupsUpdateContinuousBackups enables or disables point in time recovery for the specified table. A successful UpdateContinuousBackups call returns the current…
  • POSTUpdate contributor insights/#X-Amz-Target=DynamoDB_20120810.UpdateContributorInsightsUpdates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and…
  • POSTUpdate global table/#X-Amz-Target=DynamoDB_20120810.UpdateGlobalTableAdds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be…
  • POSTUpdate global table settings/#X-Amz-Target=DynamoDB_20120810.UpdateGlobalTableSettingsUpdates settings for a global table. This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables.…
  • POSTUpdate item/#X-Amz-Target=DynamoDB_20120810.UpdateItemEdits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also…
  • POSTUpdate kinesis streaming destination/#X-Amz-Target=DynamoDB_20120810.UpdateKinesisStreamingDestinationThe command to update the Kinesis stream destination.
  • POSTUpdate table/#X-Amz-Target=DynamoDB_20120810.UpdateTableModifies the provisioned throughput settings, global secondary indexes, DynamoDB Streams settings, or global table replica settings for a given table. You can…
  • POSTUpdate table replica auto scaling/#X-Amz-Target=DynamoDB_20120810.UpdateTableReplicaAutoScalingUpdates auto scaling settings on your global tables at once.
  • POSTUpdate time to live/#X-Amz-Target=DynamoDB_20120810.UpdateTimeToLiveThe UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current…

API details

Base URL
https://dynamodb.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
62 operations on 62 pathsPOST 62
Description format
AWS Smithy model, API version 2012-08-10

How to test the Amazon DynamoDB in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon DynamoDB collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Batch execute statement” (POST /#X-Amz-Target=DynamoDB_20120810.BatchExecuteStatement), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon DynamoDB?

Amazon DynamoDB Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB… It is listed under Data & analytics and has 62 endpoints.

Who publishes the Amazon DynamoDB?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon DynamoDB?

Requests go to https://dynamodb.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon DynamoDB?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon DynamoDB have?

62 operations on 62 paths (62 POST).

Is forking the Amazon DynamoDB free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.