Amazon Web Services, Inc.

Amazon Aurora DSQL

This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the programming or command line interfaces you can use to manage…

Developer tools#openapi

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

This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Aurora DSQL. Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size. is available in both single-Region and multi-Region configurations, so your clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. lets you focus on using your data to acquire new insights for your business and customers.

Endpoints 16

Cluster

  • GETList clusters/cluster?max-results=0&next-token=stringRetrieves information about a list of clusters.
  • POSTCreate cluster/clusterThe CreateCluster API allows you to create both single-Region clusters and multi-Region clusters. With the addition of the multiRegionProperties parameter,…
  • GETGet cluster/cluster/:identifierRetrieves information about a cluster.
  • POSTUpdate cluster/cluster/:identifierThe UpdateCluster API allows you to modify both single-Region and multi-Region cluster configurations. With the multiRegionProperties parameter, you can add…
  • DELETEDelete cluster/cluster/:identifier?client-token=stringDeletes a cluster in Amazon Aurora DSQL.
  • GETGet cluster policy/cluster/:identifier/policyRetrieves the resource-based policy document attached to a cluster. This policy defines the access permissions and conditions for the cluster.
  • POSTPut cluster policy/cluster/:identifier/policyAttaches a resource-based policy to a cluster. This policy defines access permissions and conditions for the cluster, allowing you to control which principals…
  • DELETEDelete cluster policy/cluster/:identifier/policy?expected-policy-version=string&client-token=stringDeletes the resource-based policy attached to a cluster. This removes all access permissions defined by the policy, reverting to default access controls.
  • GETGet vpc endpoint service name/clusters/:identifier/vpc-endpoint-service-nameRetrieves the VPC endpoint service name.

Stream

  • GETList streams/stream/:clusterIdentifier?max-results=0&next-token=stringRetrieves information about a list of streams for a cluster.
  • POSTCreate stream/stream/:clusterIdentifierCreates a new change data capture (CDC) stream for a cluster. The stream captures database changes and delivers them to the specified target destination.…
  • GETGet stream/stream/:clusterIdentifier/:streamIdentifierRetrieves information about a stream.
  • DELETEDelete stream/stream/:clusterIdentifier/:streamIdentifier?client-token=stringDeletes a stream from a cluster.
  • GETList tags for resource/tags/:resourceArnLists all of the tags for a resource.
  • POSTTag resource/tags/:resourceArnTags a resource with a map of key and value pairs.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes a tag from a resource.

API details

Base URL
https://dsql.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
16 operations on 7 pathsGET 7POST 5DELETE 4
Main resources
Cluster 9Stream 4
Description format
AWS Smithy model, API version 2018-05-10

How to test the Amazon Aurora DSQL 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 Aurora DSQL 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 “List clusters” (GET /cluster?max-results=0&next-token=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Aurora DSQL?

This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the programming or command line interfaces you can use to manage… It is listed under Developer tools and has 16 endpoints.

Who publishes the Amazon Aurora DSQL?

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 Aurora DSQL?

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

How do I authenticate with the Amazon Aurora DSQL?

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

How many endpoints does the Amazon Aurora DSQL have?

16 operations on 7 paths (7 GET, 5 POST, 4 DELETE). The largest groups are Cluster, Stream.

Is forking the Amazon Aurora DSQL 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.