Amazon Web Services, Inc.

Redshift Serverless

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

Data & analytics#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 Redshift Serverless. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift Serverless. Amazon Redshift Serverless automatically provisions data warehouse capacity and intelligently scales the underlying resources based on workload demands. Amazon Redshift Serverless adjusts capacity in seconds to deliver consistently high performance and simplified operations for even the most demanding and volatile workloads. Amazon Redshift Serverless lets you focus on using your data to acquire new insights for your business and customers. To learn more about Amazon Redshift Serverless, see What is Amazon Redshift Serverless? .

Endpoints 65

Recovery point

  • POSTConvert recovery point to snapshot/#X-Amz-Target=RedshiftServerless.ConvertRecoveryPointToSnapshotConverts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points .
  • POSTGet recovery point/#X-Amz-Target=RedshiftServerless.GetRecoveryPointReturns information about a recovery point.
  • POSTList recovery points/#X-Amz-Target=RedshiftServerless.ListRecoveryPointsReturns an array of recovery points.
  • POSTRestore from recovery point/#X-Amz-Target=RedshiftServerless.RestoreFromRecoveryPointRestore the data from a recovery point.
  • POSTRestore table from recovery point/#X-Amz-Target=RedshiftServerless.RestoreTableFromRecoveryPointRestores a table from a recovery point to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.

Cross vpc endpoint

  • POSTCreate endpoint access/#X-Amz-Target=RedshiftServerless.CreateEndpointAccessCreates an Amazon Redshift Serverless managed VPC endpoint.
  • POSTDelete endpoint access/#X-Amz-Target=RedshiftServerless.DeleteEndpointAccessDeletes an Amazon Redshift Serverless managed VPC endpoint.
  • POSTGet endpoint access/#X-Amz-Target=RedshiftServerless.GetEndpointAccessReturns information, such as the name, about a VPC endpoint.
  • POSTList endpoint access/#X-Amz-Target=RedshiftServerless.ListEndpointAccessReturns an array of EndpointAccess objects and relevant information.
  • POSTUpdate endpoint access/#X-Amz-Target=RedshiftServerless.UpdateEndpointAccessUpdates an Amazon Redshift Serverless managed endpoint.

Namespace

  • POSTCreate namespace/#X-Amz-Target=RedshiftServerless.CreateNamespaceCreates a namespace in Amazon Redshift Serverless.
  • POSTDelete namespace/#X-Amz-Target=RedshiftServerless.DeleteNamespaceDeletes a namespace from Amazon Redshift Serverless. Before you delete the namespace, you can create a final snapshot that has all of the data within the…
  • POSTGet namespace/#X-Amz-Target=RedshiftServerless.GetNamespaceReturns information about a namespace in Amazon Redshift Serverless.
  • POSTList namespaces/#X-Amz-Target=RedshiftServerless.ListNamespacesReturns information about a list of specified namespaces.
  • POSTUpdate lakehouse configuration/#X-Amz-Target=RedshiftServerless.UpdateLakehouseConfigurationModifies the lakehouse configuration for a namespace. This operation allows you to manage Amazon Redshift federated permissions and Amazon Web Services IAM…
  • POSTUpdate namespace/#X-Amz-Target=RedshiftServerless.UpdateNamespaceUpdates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both…

Reservation

  • POSTCreate reservation/#X-Amz-Target=RedshiftServerless.CreateReservationCreates an Amazon Redshift Serverless reservation, which gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a year…
  • POSTGet reservation/#X-Amz-Target=RedshiftServerless.GetReservationGets an Amazon Redshift Serverless reservation. A reservation gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a…
  • POSTGet reservation offering/#X-Amz-Target=RedshiftServerless.GetReservationOfferingReturns the reservation offering. The offering determines the payment schedule for the reservation.
  • POSTList reservation offerings/#X-Amz-Target=RedshiftServerless.ListReservationOfferingsReturns the current reservation offerings in your account.
  • POSTList reservations/#X-Amz-Target=RedshiftServerless.ListReservationsReturns a list of Reservation objects.

Scheduled action

  • POSTCreate scheduled action/#X-Amz-Target=RedshiftServerless.CreateScheduledActionCreates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run…
  • POSTDelete scheduled action/#X-Amz-Target=RedshiftServerless.DeleteScheduledActionDeletes a scheduled action.
  • POSTGet scheduled action/#X-Amz-Target=RedshiftServerless.GetScheduledActionReturns information about a scheduled action.
  • POSTList scheduled actions/#X-Amz-Target=RedshiftServerless.ListScheduledActionsReturns a list of scheduled actions. You can use the flags to filter the list of returned scheduled actions.
  • POSTUpdate scheduled action/#X-Amz-Target=RedshiftServerless.UpdateScheduledActionUpdates a scheduled action.

Snapshot

  • POSTCreate snapshot/#X-Amz-Target=RedshiftServerless.CreateSnapshotCreates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points .
  • POSTCreate snapshot copy configuration/#X-Amz-Target=RedshiftServerless.CreateSnapshotCopyConfigurationCreates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.
  • POSTDelete snapshot/#X-Amz-Target=RedshiftServerless.DeleteSnapshotDeletes a snapshot from Amazon Redshift Serverless.
  • POSTDelete snapshot copy configuration/#X-Amz-Target=RedshiftServerless.DeleteSnapshotCopyConfigurationDeletes a snapshot copy configuration
  • POSTGet snapshot/#X-Amz-Target=RedshiftServerless.GetSnapshotReturns information about a specific snapshot.
  • POSTGet table restore status/#X-Amz-Target=RedshiftServerless.GetTableRestoreStatusReturns information about a TableRestoreStatus object.
  • POSTList snapshot copy configurations/#X-Amz-Target=RedshiftServerless.ListSnapshotCopyConfigurationsReturns a list of snapshot copy configurations.
  • POSTList snapshots/#X-Amz-Target=RedshiftServerless.ListSnapshotsReturns a list of snapshots.
  • POSTList table restore status/#X-Amz-Target=RedshiftServerless.ListTableRestoreStatusReturns information about an array of TableRestoreStatus objects.
  • POSTRestore from snapshot/#X-Amz-Target=RedshiftServerless.RestoreFromSnapshotRestores a namespace from a snapshot.
  • POSTRestore table from snapshot/#X-Amz-Target=RedshiftServerless.RestoreTableFromSnapshotRestores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys .
  • POSTUpdate snapshot/#X-Amz-Target=RedshiftServerless.UpdateSnapshotUpdates a snapshot.
  • POSTUpdate snapshot copy configuration/#X-Amz-Target=RedshiftServerless.UpdateSnapshotCopyConfigurationUpdates a snapshot copy configuration.

Usage limit

  • POSTCreate usage limit/#X-Amz-Target=RedshiftServerless.CreateUsageLimitCreates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.
  • POSTDelete usage limit/#X-Amz-Target=RedshiftServerless.DeleteUsageLimitDeletes a usage limit from Amazon Redshift Serverless.
  • POSTGet usage limit/#X-Amz-Target=RedshiftServerless.GetUsageLimitReturns information about a usage limit.
  • POSTList usage limits/#X-Amz-Target=RedshiftServerless.ListUsageLimitsLists all usage limits within Amazon Redshift Serverless.
  • POSTUpdate usage limit/#X-Amz-Target=RedshiftServerless.UpdateUsageLimitUpdate a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.

Workgroup

  • POSTCreate workgroup/#X-Amz-Target=RedshiftServerless.CreateWorkgroupCreates an workgroup in Amazon Redshift Serverless. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region…
  • POSTDelete workgroup/#X-Amz-Target=RedshiftServerless.DeleteWorkgroupDeletes a workgroup.
  • POSTGet workgroup/#X-Amz-Target=RedshiftServerless.GetWorkgroupReturns information about a specific workgroup.
  • POSTList workgroups/#X-Amz-Target=RedshiftServerless.ListWorkgroupsReturns information about a list of specified workgroups.
  • POSTUpdate workgroup/#X-Amz-Target=RedshiftServerless.UpdateWorkgroupUpdates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update baseCapacity…

Managed workgroup

  • POSTList managed workgroups/#X-Amz-Target=RedshiftServerless.ListManagedWorkgroupsReturns information about a list of specified managed workgroups in your account.
  • POSTCreate custom domain association/#X-Amz-Target=RedshiftServerless.CreateCustomDomainAssociationCreates a custom domain association for Amazon Redshift Serverless.
  • POSTDelete custom domain association/#X-Amz-Target=RedshiftServerless.DeleteCustomDomainAssociationDeletes a custom domain association for Amazon Redshift Serverless.
  • POSTDelete resource policy/#X-Amz-Target=RedshiftServerless.DeleteResourcePolicyDeletes the specified resource policy.
  • POSTGet credentials/#X-Amz-Target=RedshiftServerless.GetCredentialsReturns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless. By default, the temporary…
  • POSTGet custom domain association/#X-Amz-Target=RedshiftServerless.GetCustomDomainAssociationGets information about a specific custom domain association.
  • POSTGet identity center auth token/#X-Amz-Target=RedshiftServerless.GetIdentityCenterAuthTokenReturns an Identity Center authentication token for accessing Amazon Redshift Serverless workgroups. The token provides secure access to data within the…
  • POSTGet resource policy/#X-Amz-Target=RedshiftServerless.GetResourcePolicyReturns a resource policy.
  • POSTGet track/#X-Amz-Target=RedshiftServerless.GetTrackGet the Redshift Serverless version for a specified track.
  • POSTList custom domain associations/#X-Amz-Target=RedshiftServerless.ListCustomDomainAssociationsLists custom domain associations for Amazon Redshift Serverless.
  • POSTList tags for resource/#X-Amz-Target=RedshiftServerless.ListTagsForResourceLists the tags assigned to a resource.
  • POSTList tracks/#X-Amz-Target=RedshiftServerless.ListTracksList the Amazon Redshift Serverless versions.
  • POSTPut resource policy/#X-Amz-Target=RedshiftServerless.PutResourcePolicyCreates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.
  • POSTTag resource/#X-Amz-Target=RedshiftServerless.TagResourceAssigns one or more tags to a resource.
  • POSTUntag resource/#X-Amz-Target=RedshiftServerless.UntagResourceRemoves a tag or set of tags from a resource.
  • POSTUpdate custom domain association/#X-Amz-Target=RedshiftServerless.UpdateCustomDomainAssociationUpdates an Amazon Redshift Serverless certificate associated with a custom domain.

API details

Base URL
https://redshift-serverless.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
65 operations on 65 pathsPOST 65
Main resources
Snapshot 13Namespace 6Cross vpc endpoint 5Recovery point 5Reservation 5Scheduled action 5Usage limit 5Workgroup 5Managed workgroup 1
Description format
AWS Smithy model, API version 2021-04-21

How to test the Redshift Serverless 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 Redshift Serverless 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 “Convert recovery point to snapshot” (POST /#X-Amz-Target=RedshiftServerless.ConvertRecoveryPointToSnapshot), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Redshift Serverless?

This is an interface reference for Amazon Redshift Serverless. It contains documentation for one of the programming or command line interfaces you can use to… It is listed under Data & analytics and has 65 endpoints.

Who publishes the Redshift Serverless?

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 Redshift Serverless?

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

How do I authenticate with the Redshift Serverless?

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

How many endpoints does the Redshift Serverless have?

65 operations on 65 paths (65 POST). The largest groups are Snapshot, Namespace, Cross vpc endpoint, Recovery point.

Is forking the Redshift Serverless 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.