Amazon Redshift API
The Amazon Redshift API provides programmatic access to create and manage Amazon Redshift clusters and their associated resources including snapshots, parameter groups, subnet groups, and reserved nodes.
OpenAPI Specification
{
"openapi": "3.0.0",
"info": {
"version": "2012-12-01",
"x-release": "v4",
"title": "Amazon Redshift",
"description": "<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>",
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png",
"backgroundColor": "#FFFFFF"
},
"termsOfService": "https://aws.amazon.com/service-terms/",
"contact": {
"name": "Mike Ralphson",
"email": "[email protected]",
"url": "https://github.com/mermade/aws2openapi",
"x-twitter": "PermittedSoc"
},
"license": {
"name": "Apache 2.0 License",
"url": "http://www.apache.org/licenses/"
},
"x-providerName": "amazonaws.com",
"x-serviceName": "redshift",
"x-origin": [
{
"contentType": "application/json",
"url": "https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/redshift-2012-12-01.normal.json",
"converter": {
"url": "https://github.com/mermade/aws2openapi",
"version": "1.0.0"
},
"x-apisguru-driver": "external"
}
],
"x-apiClientRegistration": {
"url": "https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"
},
"x-apisguru-categories": [
"cloud"
],
"x-preferred": true
},
"externalDocs": {
"description": "Amazon Web Services documentation",
"url": "https://docs.aws.amazon.com/redshift/"
},
"servers": [
{
"url": "http://redshift.{region}.amazonaws.com",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
"us-gov-west-1",
"us-gov-east-1",
"ca-central-1",
"eu-north-1",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"eu-central-1",
"eu-south-1",
"af-south-1",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ap-southeast-1",
"ap-southeast-2",
"ap-east-1",
"ap-south-1",
"sa-east-1",
"me-south-1"
],
"default": "us-east-1"
}
},
"description": "The Amazon Redshift multi-region endpoint"
},
{
"url": "https://redshift.{region}.amazonaws.com",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
"us-gov-west-1",
"us-gov-east-1",
"ca-central-1",
"eu-north-1",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"eu-central-1",
"eu-south-1",
"af-south-1",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ap-southeast-1",
"ap-southeast-2",
"ap-east-1",
"ap-south-1",
"sa-east-1",
"me-south-1"
],
"default": "us-east-1"
}
},
"description": "The Amazon Redshift multi-region endpoint"
},
{
"url": "http://redshift.{region}.amazonaws.com.cn",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"cn-north-1",
"cn-northwest-1"
],
"default": "cn-north-1"
}
},
"description": "The Amazon Redshift endpoint for China (Beijing) and China (Ningxia)"
},
{
"url": "https://redshift.{region}.amazonaws.com.cn",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"cn-north-1",
"cn-northwest-1"
],
"default": "cn-north-1"
}
},
"description": "The Amazon Redshift endpoint for China (Beijing) and China (Ningxia)"
}
],
"x-hasEquivalentPaths": true,
"paths": {
"/#Action=AcceptReservedNodeExchange": {
"get": {
"x-aws-operation-name": "AcceptReservedNodeExchange",
"operationId": "GET_AcceptReservedNodeExchange",
"description": "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. ",
"responses": {
"200": {
"description": "Success",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/AcceptReservedNodeExchangeOutputMessage"
}
}
}
},
"480": {
"description": "ReservedNodeNotFoundFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/ReservedNodeNotFoundFault"
}
}
}
},
"481": {
"description": "InvalidReservedNodeStateFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/InvalidReservedNodeStateFault"
}
}
}
},
"482": {
"description": "ReservedNodeAlreadyMigratedFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/ReservedNodeAlreadyMigratedFault"
}
}
}
},
"483": {
"description": "ReservedNodeOfferingNotFoundFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/ReservedNodeOfferingNotFoundFault"
}
}
}
},
"484": {
"description": "UnsupportedOperationFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/UnsupportedOperationFault"
}
}
}
},
"485": {
"description": "DependentServiceUnavailableFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/DependentServiceUnavailableFault"
}
}
}
},
"486": {
"description": "ReservedNodeAlreadyExistsFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/ReservedNodeAlreadyExistsFault"
}
}
}
}
},
"parameters": [
{
"name": "ReservedNodeId",
"in": "query",
"required": true,
"description": "A string representing the node identifier of the DC1 Reserved Node to be exchanged.",
"schema": {
"type": "string",
"maxLength": 2147483647
}
},
{
"name": "TargetReservedNodeOfferingId",
"in": "query",
"required": true,
"description": "The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling <a>GetReservedNodeExchangeOfferings</a> ",
"schema": {
"type": "string",
"maxLength": 2147483647
}
},
{
"name": "Action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"AcceptReservedNodeExchange"
]
}
},
{
"name": "Version",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"2012-12-01"
]
}
}
],
"summary": "Amazon Redshift - G E T_ Accept Reserved Node Exchange",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
],
"post": {
"x-aws-operation-name": "AcceptReservedNodeExchange",
"operationId": "POST_AcceptReservedNodeExchange",
"description": "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. ",
"responses": {
"200": {
"description": "Success",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/AcceptReservedNodeExchangeOutputMessage"
}
}
}
},
"480": {
"description": "ReservedNodeNotFoundFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/ReservedNodeNotFoundFault"
}
}
}
},
"481": {
"description": "InvalidReservedNodeStateFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/InvalidReservedNodeStateFault"
}
}
}
},
"482": {
"description": "ReservedNodeAlreadyMigratedFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/ReservedNodeAlreadyMigratedFault"
}
}
}
},
"483": {
"description": "ReservedNodeOfferingNotFoundFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/ReservedNodeOfferingNotFoundFault"
}
}
}
},
"484": {
"description": "UnsupportedOperationFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/UnsupportedOperationFault"
}
}
}
},
"485": {
"description": "DependentServiceUnavailableFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/DependentServiceUnavailableFault"
}
}
}
},
"486": {
"description": "ReservedNodeAlreadyExistsFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/ReservedNodeAlreadyExistsFault"
}
}
}
}
},
"requestBody": {
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/AcceptReservedNodeExchangeInputMessage"
}
}
}
},
"parameters": [
{
"name": "Action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"AcceptReservedNodeExchange"
]
}
},
{
"name": "Version",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"2012-12-01"
]
}
}
],
"summary": "Amazon Redshift - P O S T_ Accept Reserved Node Exchange",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/#Action=AddPartner": {
"get": {
"x-aws-operation-name": "AddPartner",
"operationId": "GET_AddPartner",
"description": "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 also set up the integration on the partner website.",
"responses": {
"200": {
"description": "Success",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/PartnerIntegrationOutputMessage"
}
}
}
},
"480": {
"description": "PartnerNotFoundFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/PartnerNotFoundFault"
}
}
}
},
"481": {
"description": "ClusterNotFoundFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/ClusterNotFoundFault"
}
}
}
},
"482": {
"description": "UnauthorizedPartnerIntegrationFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedPartnerIntegrationFault"
}
}
}
}
},
"parameters": [
{
"name": "AccountId",
"in": "query",
"required": true,
"description": "The Amazon Web Services account ID that owns the cluster.",
"schema": {
"type": "string",
"pattern": "^[0-9]+$",
"minLength": 12,
"maxLength": 12
}
},
{
"name": "ClusterIdentifier",
"in": "query",
"required": true,
"description": "The cluster identifier of the cluster that receives data from the partner.",
"schema": {
"type": "string",
"pattern": "^[a-zA-Z0-9\\-]+$",
"maxLength": 63
}
},
{
"name": "DatabaseName",
"in": "query",
"required": true,
"description": "The name of the database that receives data from the partner.",
"schema": {
"type": "string",
"pattern": "^[\\p{L}_][\\p{L}\\p{N}@$#_]+$",
"maxLength": 127
}
},
{
"name": "PartnerName",
"in": "query",
"required": true,
"description": "The name of the partner that is authorized to send data.",
"schema": {
"type": "string",
"pattern": "^[a-zA-Z0-9\\-_]+$",
"maxLength": 255
}
},
{
"name": "Action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"AddPartner"
]
}
},
{
"name": "Version",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"2012-12-01"
]
}
}
],
"summary": "Amazon Redshift - G E T_ Add Partner",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
],
"post": {
"x-aws-operation-name": "AddPartner",
"operationId": "POST_AddPartner",
"description": "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 also set up the integration on the partner website.",
"responses": {
"200": {
"description": "Success",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/PartnerIntegrationOutputMessage"
}
}
}
},
"480": {
"description": "PartnerNotFoundFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/PartnerNotFoundFault"
}
}
}
},
"481": {
"description": "ClusterNotFoundFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/ClusterNotFoundFault"
}
}
}
},
"482": {
"description": "UnauthorizedPartnerIntegrationFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedPartnerIntegrationFault"
}
}
}
}
},
"requestBody": {
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/PartnerIntegrationInputMessage"
}
}
}
},
"parameters": [
{
"name": "Action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"AddPartner"
]
}
},
{
"name": "Version",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"2012-12-01"
]
}
}
],
"summary": "Amazon Redshift - P O S T_ Add Partner",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/#Action=AssociateDataShareConsumer": {
"get": {
"x-aws-operation-name": "AssociateDataShareConsumer",
"operationId": "GET_AssociateDataShareConsumer",
"description": "From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this association, the consumer can consume the datashare.",
"responses": {
"200": {
"description": "Success",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/DataShare"
}
}
}
},
"480": {
"description": "InvalidDataShareFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/InvalidDataShareFault"
}
}
}
},
"481": {
"description": "InvalidNamespaceFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/InvalidNamespaceFault"
}
}
}
}
},
"parameters": [
{
"name": "DataShareArn",
"in": "query",
"required": true,
"description": "The Amazon Resource Name (ARN) of the datashare that the consumer is to use with the account or the namespace.",
"schema": {
"type": "string",
"maxLength": 2147483647
}
},
{
"name": "AssociateEntireAccount",
"in": "query",
"required": false,
"description": "A value that specifies whether the datashare is associated with the entire account.",
"schema": {
"type": "boolean"
}
},
{
"name": "ConsumerArn",
"in": "query",
"required": false,
"description": "The Amazon Resource Name (ARN) of the consumer that is associated with the datashare.",
"schema": {
"type": "string",
"maxLength": 2147483647
}
},
{
"name": "ConsumerRegion",
"in": "query",
"required": false,
"description": "From a datashare consumer account, associates a datashare with all existing and future namespaces in the specified Amazon Web Services Region.",
"schema": {
"type": "string",
"maxLength": 2147483647
}
},
{
"name": "Action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"AssociateDataShareConsumer"
]
}
},
{
"name": "Version",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"2012-12-01"
]
}
}
],
"summary": "Amazon Redshift - G E T_ Associate Data Share Consumer",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
],
"post": {
"x-aws-operation-name": "AssociateDataShareConsumer",
"operationId": "POST_AssociateDataShareConsumer",
"description": "From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this association, the consumer can consume the datashare.",
"responses": {
"200": {
"description": "Success",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/DataShare"
}
}
}
},
"480": {
"description": "InvalidDataShareFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/InvalidDataShareFault"
}
}
}
},
"481": {
"description": "InvalidNamespaceFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/InvalidNamespaceFault"
}
}
}
}
},
"requestBody": {
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/AssociateDataShareConsumerMessage"
}
}
}
},
"parameters": [
{
"name": "Action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"AssociateDataShareConsumer"
]
}
},
{
"name": "Version",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"2012-12-01"
]
}
}
],
"summary": "Amazon Redshift - P O S T_ Associate Data Share Consumer",
"x-microcks-operation": {
"delay": 0,
"dispatcher": "FALLBACK"
}
}
},
"/#Action=AuthorizeClusterSecurityGroupIngress": {
"get": {
"x-aws-operation-name": "AuthorizeClusterSecurityGroupIngress",
"operationId": "GET_AuthorizeClusterSecurityGroupIngress",
"description": "<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 or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.</p> <p>If you authorize access to an Amazon EC2 security group, specify <i>EC2SecurityGroupName</i> and <i>EC2SecurityGroupOwnerId</i>. The Amazon EC2 security group and Amazon Redshift cluster must be in the same Amazon Web Services Region. </p> <p>If you authorize access to a CIDR/IP address range, specify <i>CIDRIP</i>. For an overview of CIDR blocks, see the Wikipedia article on <a href=\"http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing\">Classless Inter-Domain Routing</a>. </p> <p>You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-security-groups.html\">Working with Security Groups</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>",
"responses": {
"200": {
"description": "Success",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/AuthorizeClusterSecurityGroupIngressResult"
}
}
}
},
"480": {
"description": "ClusterSecurityGroupNotFoundFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/ClusterSecurityGroupNotFoundFault"
}
}
}
},
"481": {
"description": "InvalidClusterSecurityGroupStateFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/InvalidClusterSecurityGroupStateFault"
}
}
}
},
"482": {
"description": "AuthorizationAlreadyExistsFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/AuthorizationAlreadyExistsFault"
}
}
}
},
"483": {
"description": "AuthorizationQuotaExceededFault",
"content": {
"text/xml": {
"schema": {
"$ref": "#/components/schemas/AuthorizationQuotaExceededFault"
}
}
}
}
},
"parameters": [
{
"name": "ClusterSecurityGroupName",
"in": "query",
"required": true,
"description": "The name of the security group to which the ingress rule is added.",
"schema": {
"type": "string",
"maxLength": 2147483647
}
},
{
"name": "CIDRIP",
"in": "query",
"required": false,
"description": "The IP range to be added the Amazon Redshift security group.",
"schema": {
"type": "string",
"maxLength": 2147483647
}
},
{
"name": "EC2SecurityGroupName",
"in": "query",
"required": false,
"description": "The EC2 security group to be added the Amazon Redshift security group.",
"schema": {
"type": "string",
"maxLength": 2147483647
}
},
{
"name": "EC2SecurityGroupOwnerId",
"in": "query",
"required": false,
"description": "<p>The Amazon Web Services account number of the owner of the security group specified by the <i>EC2SecurityGroupName</i> parameter. The Amazon Web Services Access Key ID is not an acceptable value. </p> <p>Example: <code>111122223333</code> </p>",
"schema": {
"type": "string",
"maxLength": 2147483647
}
},
{
"name": "Action",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"AuthorizeClusterSecurityGroupIngress"
]
}
},
{
"name": "Version",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"2012-12-01"
]
}
}
],
"summary": "Amazon Redshift - G E T_ Authorize Cluster Security Group Ingress",
"x-microcks-operation": {
# --- truncated at 32 KB (1490 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aws-redshift/refs/heads/main/openapi/aws-redshift-openapi.json