Open documentation ↗Overview
<fullname>Amazon Redshift</fullname> <p> <b>Overview</b> </p> <p>This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/using-aws-sdk.html">Using the Amazon Redshift Management Interfaces</a>.</p> <p>Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers.</p> <p>If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the <a href="https://docs.aws.amazon.com/redshift/latest/gsg/getting-started.html">Amazon Redshift Getting Started Guide</a>.</p> <p>If you are a database developer, the <a href="https://docs.aws.amazon.com/redshift/latest/dg/welcome.html">Amazon Redshift Database Developer Guide</a> explains how to design, build, query, and maintain the databases that make up your data warehouse. </p>
Amazon Redshift is a cloud platforms API from amazonaws.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 238 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Cloud Platforms
- Version
- 2012-12-01
- Endpoints
- 238
- OpenAPI
- Specification ↗
- Spec updated
- 2020-04-22
Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /#Action=AcceptReservedNodeExchange | Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs. |
| POST | /#Action=AcceptReservedNodeExchange | Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs. |
| GET | /#Action=AddPartner | Adds a partner integration to a cluster. This operation authorizes a partner to push status updates for the specified database. To complete the integration, you |
| POST | /#Action=AddPartner | Adds a partner integration to a cluster. This operation authorizes a partner to push status updates for the specified database. To complete the integration, you |
| GET | /#Action=AssociateDataShareConsumer | From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this a |
| POST | /#Action=AssociateDataShareConsumer | From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this a |
| GET | /#Action=AuthorizeClusterSecurityGroupIngress | <p>Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet o |
| POST | /#Action=AuthorizeClusterSecurityGroupIngress | <p>Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet o |
| GET | /#Action=AuthorizeDataShare | From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities. To authorize a datashare for a data |
| POST | /#Action=AuthorizeDataShare | From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts or managing entities. To authorize a datashare for a data |
| GET | /#Action=AuthorizeEndpointAccess | Grants access to a cluster. |
| POST | /#Action=AuthorizeEndpointAccess | Grants access to a cluster. |
| GET | /#Action=AuthorizeSnapshotAccess | <p>Authorizes the specified Amazon Web Services account to restore the specified snapshot.</p> <p> For more information about working with snapshots, go to <a h |
| POST | /#Action=AuthorizeSnapshotAccess | <p>Authorizes the specified Amazon Web Services account to restore the specified snapshot.</p> <p> For more information about working with snapshots, go to <a h |
| GET | /#Action=BatchDeleteClusterSnapshots | Deletes a set of cluster snapshots. |
| POST | /#Action=BatchDeleteClusterSnapshots | Deletes a set of cluster snapshots. |
| GET | /#Action=BatchModifyClusterSnapshots | Modifies the settings for a set of cluster snapshots. |
| POST | /#Action=BatchModifyClusterSnapshots | Modifies the settings for a set of cluster snapshots. |
| GET | /#Action=CancelResize | Cancels a resize operation for a cluster. |
| POST | /#Action=CancelResize | Cancels a resize operation for a cluster. |
| GET | /#Action=CopyClusterSnapshot | <p>Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available st |
| POST | /#Action=CopyClusterSnapshot | <p>Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available st |
| GET | /#Action=CreateAuthenticationProfile | Creates an authentication profile with the specified parameters. |
| POST | /#Action=CreateAuthenticationProfile | Creates an authentication profile with the specified parameters. |
| GET | /#Action=CreateCluster | <p>Creates a new cluster with the specified parameters.</p> <p>To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. |
| POST | /#Action=CreateCluster | <p>Creates a new cluster with the specified parameters.</p> <p>To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. |
| GET | /#Action=CreateClusterParameterGroup | <p>Creates an Amazon Redshift parameter group.</p> <p>Creating parameter groups is independent of creating clusters. You can associate a cluster with a paramete |
| POST | /#Action=CreateClusterParameterGroup | <p>Creates an Amazon Redshift parameter group.</p> <p>Creating parameter groups is independent of creating clusters. You can associate a cluster with a paramete |
| GET | /#Action=CreateClusterSecurityGroup | <p>Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.</p> <p> For information about managing security |
| POST | /#Action=CreateClusterSecurityGroup | <p>Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.</p> <p> For information about managing security |
| GET | /#Action=CreateClusterSnapshot | <p>Creates a manual snapshot of the specified cluster. The cluster must be in the <code>available</code> state. </p> <p> For more information about working with |
| POST | /#Action=CreateClusterSnapshot | <p>Creates a manual snapshot of the specified cluster. The cluster must be in the <code>available</code> state. </p> <p> For more information about working with |
| GET | /#Action=CreateClusterSubnetGroup | <p>Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when cr |
| POST | /#Action=CreateClusterSubnetGroup | <p>Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when cr |
| GET | /#Action=CreateEndpointAccess | Creates a Redshift-managed VPC endpoint. |
| POST | /#Action=CreateEndpointAccess | Creates a Redshift-managed VPC endpoint. |
| GET | /#Action=CreateEventSubscription | <p>Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the A |
| POST | /#Action=CreateEventSubscription | <p>Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the A |
| GET | /#Action=CreateHsmClientCertificate | <p>Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to enc |
| POST | /#Action=CreateHsmClientCertificate | <p>Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to enc |
| GET | /#Action=CreateHsmConfiguration | <p>Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Sec |
| POST | /#Action=CreateHsmConfiguration | <p>Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Sec |
| GET | /#Action=CreateScheduledAction | Creates 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 the |
| POST | /#Action=CreateScheduledAction | Creates 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 the |
| GET | /#Action=CreateSnapshotCopyGrant | <p>Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from Key Management Service (KMS) to encrypt copied snapshots in |
| POST | /#Action=CreateSnapshotCopyGrant | <p>Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from Key Management Service (KMS) to encrypt copied snapshots in |
| GET | /#Action=CreateSnapshotSchedule | Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule. |
| POST | /#Action=CreateSnapshotSchedule | Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule. |
| GET | /#Action=CreateTags | <p>Adds tags to a cluster.</p> <p>A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the at |
| POST | /#Action=CreateTags | <p>Adds tags to a cluster.</p> <p>A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the at |
| GET | /#Action=CreateUsageLimit | Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier. |
| POST | /#Action=CreateUsageLimit | Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier. |
| GET | /#Action=DeauthorizeDataShare | From a datashare producer account, removes authorization from the specified datashare. |
| POST | /#Action=DeauthorizeDataShare | From a datashare producer account, removes authorization from the specified datashare. |
| GET | /#Action=DeleteAuthenticationProfile | Deletes an authentication profile. |
| POST | /#Action=DeleteAuthenticationProfile | Deletes an authentication profile. |
| GET | /#Action=DeleteCluster | <p>Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was |
| POST | /#Action=DeleteCluster | <p>Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was |
| GET | /#Action=DeleteClusterParameterGroup | <p>Deletes a specified Amazon Redshift parameter group.</p> <note> <p>You cannot delete a parameter group if it is associated with a cluster.</p> </note> |
| POST | /#Action=DeleteClusterParameterGroup | <p>Deletes a specified Amazon Redshift parameter group.</p> <note> <p>You cannot delete a parameter group if it is associated with a cluster.</p> </note> |
| GET | /#Action=DeleteClusterSecurityGroup | <p>Deletes an Amazon Redshift security group.</p> <note> <p>You cannot delete a security group that is associated with any clusters. You cannot delete the defau |
| POST | /#Action=DeleteClusterSecurityGroup | <p>Deletes an Amazon Redshift security group.</p> <note> <p>You cannot delete a security group that is associated with any clusters. You cannot delete the defau |
| GET | /#Action=DeleteClusterSnapshot | <p>Deletes the specified manual snapshot. The snapshot must be in the <code>available</code> state, with no other users authorized to access the snapshot. </p> |
| POST | /#Action=DeleteClusterSnapshot | <p>Deletes the specified manual snapshot. The snapshot must be in the <code>available</code> state, with no other users authorized to access the snapshot. </p> |
| GET | /#Action=DeleteClusterSubnetGroup | Deletes the specified cluster subnet group. |
| POST | /#Action=DeleteClusterSubnetGroup | Deletes the specified cluster subnet group. |
| GET | /#Action=DeleteEndpointAccess | Deletes a Redshift-managed VPC endpoint. |
| POST | /#Action=DeleteEndpointAccess | Deletes a Redshift-managed VPC endpoint. |
| GET | /#Action=DeleteEventSubscription | Deletes an Amazon Redshift event notification subscription. |
| POST | /#Action=DeleteEventSubscription | Deletes an Amazon Redshift event notification subscription. |
| GET | /#Action=DeleteHsmClientCertificate | Deletes the specified HSM client certificate. |
| POST | /#Action=DeleteHsmClientCertificate | Deletes the specified HSM client certificate. |
| GET | /#Action=DeleteHsmConfiguration | Deletes the specified Amazon Redshift HSM configuration. |
| POST | /#Action=DeleteHsmConfiguration | Deletes the specified Amazon Redshift HSM configuration. |
| GET | /#Action=DeletePartner | Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website. |
| POST | /#Action=DeletePartner | Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website. |
| GET | /#Action=DeleteScheduledAction | Deletes a scheduled action. |
| POST | /#Action=DeleteScheduledAction | Deletes a scheduled action. |
| GET | /#Action=DeleteSnapshotCopyGrant | Deletes the specified snapshot copy grant. |
| POST | /#Action=DeleteSnapshotCopyGrant | Deletes the specified snapshot copy grant. |
| GET | /#Action=DeleteSnapshotSchedule | Deletes a snapshot schedule. |
| POST | /#Action=DeleteSnapshotSchedule | Deletes a snapshot schedule. |
| GET | /#Action=DeleteTags | Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags. |
| POST | /#Action=DeleteTags | Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags. |
| GET | /#Action=DeleteUsageLimit | Deletes a usage limit from a cluster. |
| POST | /#Action=DeleteUsageLimit | Deletes a usage limit from a cluster. |
| GET | /#Action=DescribeAccountAttributes | Returns a list of attributes attached to an account |
| POST | /#Action=DescribeAccountAttributes | Returns a list of attributes attached to an account |
| GET | /#Action=DescribeAuthenticationProfiles | Describes an authentication profile. |
| POST | /#Action=DescribeAuthenticationProfiles | Describes an authentication profile. |
| GET | /#Action=DescribeClusterDbRevisions | Returns an array of <code>ClusterDbRevision</code> objects. |
| POST | /#Action=DescribeClusterDbRevisions | Returns an array of <code>ClusterDbRevision</code> objects. |
| GET | /#Action=DescribeClusterParameterGroups | <p>Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the res |
| POST | /#Action=DescribeClusterParameterGroups | <p>Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the res |
| GET | /#Action=DescribeClusterParameters | <p>Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information su |
| POST | /#Action=DescribeClusterParameters | <p>Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information su |
| GET | /#Action=DescribeClusterSecurityGroups | <p>Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about onl |
| POST | /#Action=DescribeClusterSecurityGroups | <p>Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about onl |
| GET | /#Action=DescribeClusterSnapshots | <p>Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots |
| POST | /#Action=DescribeClusterSnapshots | <p>Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots |
Showing the first 100 of 238 endpoints; the full list is in the documentation.
Questions
Does the Amazon Redshift API need an API key?
Yes. The Amazon Redshift API uses API key authentication; the documentation explains how to get credentials.
Does the Amazon Redshift API support HTTPS?
Yes, the Amazon Redshift API is served over HTTPS.
How many endpoints does the Amazon Redshift API have?
Its OpenAPI description lists 238 endpoints in version 2012-12-01. The first 100 are shown on this page.
What are alternatives to the Amazon Redshift API?
Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.
Similar cloud platforms APIs
Compare alternatives →Remote Settings PROD
Cloud PlatformsFirefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.
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
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
Vercel API
Cloud PlatformsVercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.
Platform API
Cloud PlatformsThe [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.
Azure Data Lake Storage
Cloud PlatformsAzure Data Lake Storage provides storage for Hadoop and other big data workloads.
Listed from APIs.guru (CC0).