Skip to content

Amazon DynamoDB API

by amazonaws.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

<fullname>Amazon DynamoDB</fullname> <p>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.</p> <p>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.</p> <p>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.</p>

Amazon DynamoDB is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 53 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Version
2012-08-10
Endpoints
53
Spec updated
2020-03-11

Endpoints

MethodPathWhat it does
POST/#X-Amz-Target=DynamoDB_20120810.BatchExecuteStatement<p>This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a <code>BatchExecuteStatement</c
POST/#X-Amz-Target=DynamoDB_20120810.BatchGetItem<p>The <code>BatchGetItem</code> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.</p>
POST/#X-Amz-Target=DynamoDB_20120810.BatchWriteItem<p>The <code>BatchWriteItem</code> operation puts or deletes multiple items in one or more tables. A single call to <code>BatchWriteItem</code> can transmit up
POST/#X-Amz-Target=DynamoDB_20120810.CreateBackup<p>Creates a backup for an existing table.</p> <p> Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number
POST/#X-Amz-Target=DynamoDB_20120810.CreateGlobalTable<p>Creates 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
POST/#X-Amz-Target=DynamoDB_20120810.CreateTable<p>The <code>CreateTable</code> operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. Th
POST/#X-Amz-Target=DynamoDB_20120810.DeleteBackup<p>Deletes an existing backup of a table.</p> <p>You can call <code>DeleteBackup</code> at a maximum rate of 10 times per second.</p>
POST/#X-Amz-Target=DynamoDB_20120810.DeleteItem<p>Deletes 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
POST/#X-Amz-Target=DynamoDB_20120810.DeleteTable<p>The <code>DeleteTable</code> operation deletes a table and all of its items. After a <code>DeleteTable</code> request, the specified table is in the <code>DE
POST/#X-Amz-Target=DynamoDB_20120810.DescribeBackup<p>Describes an existing backup of a table.</p> <p>You can call <code>DescribeBackup</code> at a maximum rate of 10 times per second.</p>
POST/#X-Amz-Target=DynamoDB_20120810.DescribeContinuousBackups<p>Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are <code>ENABLED</code> on all tables at table
POST/#X-Amz-Target=DynamoDB_20120810.DescribeContributorInsightsReturns information about contributor insights for a given table or global secondary index.
POST/#X-Amz-Target=DynamoDB_20120810.DescribeEndpointsReturns the regional endpoint information. This action must be included in your VPC endpoint policies, or access to the DescribeEndpoints API will be denied. Fo
POST/#X-Amz-Target=DynamoDB_20120810.DescribeExportDescribes an existing table export.
POST/#X-Amz-Target=DynamoDB_20120810.DescribeGlobalTable<p>Returns information about the specified global table.</p> <important> <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/l
POST/#X-Amz-Target=DynamoDB_20120810.DescribeGlobalTableSettings<p>Describes Region-specific settings for a global table.</p> <important> <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/
POST/#X-Amz-Target=DynamoDB_20120810.DescribeImportRepresents the properties of the import.
POST/#X-Amz-Target=DynamoDB_20120810.DescribeKinesisStreamingDestinationReturns information about the status of Kinesis streaming.
POST/#X-Amz-Target=DynamoDB_20120810.DescribeLimits<p>Returns 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 tab
POST/#X-Amz-Target=DynamoDB_20120810.DescribeTable<p>Returns 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.</p
POST/#X-Amz-Target=DynamoDB_20120810.DescribeTableReplicaAutoScaling<p>Describes auto scaling settings across replicas of the global table at once.</p> <important> <p>This operation only applies to <a href="https://docs.aws.amaz
POST/#X-Amz-Target=DynamoDB_20120810.DescribeTimeToLiveGives a description of the Time to Live (TTL) status on the specified table.
POST/#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.
POST/#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 im
POST/#X-Amz-Target=DynamoDB_20120810.ExecuteStatement<p>This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.</p> <p>For PartiQL reads (<code>SELECT</code> stat
POST/#X-Amz-Target=DynamoDB_20120810.ExecuteTransaction<p>This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.</p> <note> <p>The entire transaction must consi
POST/#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 recovery
POST/#X-Amz-Target=DynamoDB_20120810.GetItem<p>The <code>GetItem</code> operation returns a set of attributes for the item with the given primary key. If there is no matching item, <code>GetItem</code> do
POST/#X-Amz-Target=DynamoDB_20120810.ImportTableImports table data from an S3 bucket.
POST/#X-Amz-Target=DynamoDB_20120810.ListBackups<p>List backups associated with an Amazon Web Services account. To list backups for a given table, specify <code>TableName</code>. <code>ListBackups</code> retu
POST/#X-Amz-Target=DynamoDB_20120810.ListContributorInsightsReturns a list of ContributorInsightsSummary for a table and all its global secondary indexes.
POST/#X-Amz-Target=DynamoDB_20120810.ListExportsLists completed exports within the past 90 days.
POST/#X-Amz-Target=DynamoDB_20120810.ListGlobalTables<p>Lists all global tables that have a replica in the specified Region.</p> <important> <p>This operation only applies to <a href="https://docs.aws.amazon.com/a
POST/#X-Amz-Target=DynamoDB_20120810.ListImportsLists completed imports within the past 90 days.
POST/#X-Amz-Target=DynamoDB_20120810.ListTablesReturns an array of table names associated with the current account and endpoint. The output from <code>ListTables</code> is paginated, with each page returning
POST/#X-Amz-Target=DynamoDB_20120810.ListTagsOfResource<p>List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.</p> <p>For an overview on tagging Dynam
POST/#X-Amz-Target=DynamoDB_20120810.PutItem<p>Creates 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,
POST/#X-Amz-Target=DynamoDB_20120810.Query<p>You must provide the name of the partition key attribute and a single value for that attribute. <code>Query</code> returns all items with that partition key
POST/#X-Amz-Target=DynamoDB_20120810.RestoreTableFromBackup<p>Creates 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. </p> <p>Y
POST/#X-Amz-Target=DynamoDB_20120810.RestoreTableToPointInTime<p>Restores the specified table to the specified point in time within <code>EarliestRestorableDateTime</code> and <code>LatestRestorableDateTime</code>. You can
POST/#X-Amz-Target=DynamoDB_20120810.Scan<p>The <code>Scan</code> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB retur
POST/#X-Amz-Target=DynamoDB_20120810.TagResource<p>Associate 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 Managemen
POST/#X-Amz-Target=DynamoDB_20120810.TransactGetItems<p> <code>TransactGetItems</code> is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single
POST/#X-Amz-Target=DynamoDB_20120810.TransactWriteItems<p> <code>TransactWriteItems</code> is a synchronous write operation that groups up to 100 action requests. These actions can target items in different tables,
POST/#X-Amz-Target=DynamoDB_20120810.UntagResource<p>Removes the association of tags from an Amazon DynamoDB resource. You can call <code>UntagResource</code> up to five times per second, per account. </p> <p>F
POST/#X-Amz-Target=DynamoDB_20120810.UpdateContinuousBackups<p> <code>UpdateContinuousBackups</code> enables or disables point in time recovery for the specified table. A successful <code>UpdateContinuousBackups</code> c
POST/#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 (if
POST/#X-Amz-Target=DynamoDB_20120810.UpdateGlobalTable<p>Adds 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
POST/#X-Amz-Target=DynamoDB_20120810.UpdateGlobalTableSettings<p>Updates settings for a global table.</p> <important> <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developergu
POST/#X-Amz-Target=DynamoDB_20120810.UpdateItem<p>Edits 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
POST/#X-Amz-Target=DynamoDB_20120810.UpdateTable<p>Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.</p> <important> <p>This operation onl
POST/#X-Amz-Target=DynamoDB_20120810.UpdateTableReplicaAutoScaling<p>Updates auto scaling settings on your global tables at once.</p> <important> <p>This operation only applies to <a href="https://docs.aws.amazon.com/amazondyn
POST/#X-Amz-Target=DynamoDB_20120810.UpdateTimeToLive<p>The <code>UpdateTimeToLive</code> method enables or disables Time to Live (TTL) for the specified table. A successful <code>UpdateTimeToLive</code> call retu

Questions

Does the Amazon DynamoDB API need an API key?

Yes. The Amazon DynamoDB API uses API key authentication; the documentation explains how to get credentials.

Does the Amazon DynamoDB API support HTTPS?

Yes, the Amazon DynamoDB API is served over HTTPS.

How many endpoints does the Amazon DynamoDB API have?

Its OpenAPI description lists 53 endpoints in version 2012-08-10. All of them are shown on this page.

What are alternatives to the Amazon DynamoDB API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).