Amazon Redshift
Amazon Redshift Overview This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces…
Data & analytics#openapi#cloud
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
Amazon Redshift
Overview
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
Using the
Amazon Redshift Management Interfaces .
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.
If you are a first-time user of Amazon Redshift, we recommend that you begin by reading
the Amazon Redshift Getting Started Guide .
If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design,
build, query, and maintain the databases that make up your data warehouse.
Endpoints 145
- POSTAccept reserved node exchange
/#Action=AcceptReservedNodeExchange?Action=AcceptReservedNodeExchange&Version=2012-12-01Exchanges 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. - POSTAdd partner
/#Action=AddPartner?Action=AddPartner&Version=2012-12-01Adds a partner integration to a cluster. This operation authorizes a partner to push status updates for the specified database. To complete the integration,… - POSTAssociate data share consumer
/#Action=AssociateDataShareConsumer?Action=AssociateDataShareConsumer&Version=2012-12-01From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this… - POSTAuthorize cluster security group ingress
/#Action=AuthorizeClusterSecurityGroupIngress?Action=AuthorizeClusterSecurityGroupIngress&Version=2012-12-01Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or… - POSTAuthorize data share
/#Action=AuthorizeDataShare?Action=AuthorizeDataShare&Version=2012-12-01From 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… - POSTAuthorize endpoint access
/#Action=AuthorizeEndpointAccess?Action=AuthorizeEndpointAccess&Version=2012-12-01Grants access to a cluster. - POSTAuthorize snapshot access
/#Action=AuthorizeSnapshotAccess?Action=AuthorizeSnapshotAccess&Version=2012-12-01Authorizes the specified Amazon Web Services account to restore the specified snapshot. For more information about working with snapshots, go to Amazon… - POSTBatch delete cluster snapshots
/#Action=BatchDeleteClusterSnapshots?Action=BatchDeleteClusterSnapshots&Version=2012-12-01Deletes a set of cluster snapshots. - POSTBatch modify cluster snapshots
/#Action=BatchModifyClusterSnapshots?Action=BatchModifyClusterSnapshots&Version=2012-12-01Modifies the settings for a set of cluster snapshots. - POSTCancel resize
/#Action=CancelResize?Action=CancelResize&Version=2012-12-01Cancels a resize operation for a cluster. - POSTCopy cluster snapshot
/#Action=CopyClusterSnapshot?Action=CopyClusterSnapshot&Version=2012-12-01Copies 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… - POSTCreate authentication profile
/#Action=CreateAuthenticationProfile?Action=CreateAuthenticationProfile&Version=2012-12-01Creates an authentication profile with the specified parameters. - POSTCreate cluster
/#Action=CreateCluster?Action=CreateCluster&Version=2012-12-01Creates a new cluster with the specified parameters. To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The… - POSTCreate cluster parameter group
/#Action=CreateClusterParameterGroup?Action=CreateClusterParameterGroup&Version=2012-12-01Creates an Amazon Redshift parameter group. Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group… - POSTCreate cluster security group
/#Action=CreateClusterSecurityGroup?Action=CreateClusterSecurityGroup&Version=2012-12-01Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters. For information about managing security groups,… - POSTCreate cluster snapshot
/#Action=CreateClusterSnapshot?Action=CreateClusterSnapshot&Version=2012-12-01Creates a manual snapshot of the specified cluster. The cluster must be in the available state. For more information about working with snapshots, go to… - POSTCreate cluster subnet group
/#Action=CreateClusterSubnetGroup?Action=CreateClusterSubnetGroup&Version=2012-12-01Creates 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… - POSTCreate custom domain association
/#Action=CreateCustomDomainAssociation?Action=CreateCustomDomainAssociation&Version=2012-12-01Used to create a custom domain name for a cluster. Properties include the custom domain name, the cluster the custom domain is associated with, and the… - POSTCreate endpoint access
/#Action=CreateEndpointAccess?Action=CreateEndpointAccess&Version=2012-12-01Creates a Redshift-managed VPC endpoint. - POSTCreate event subscription
/#Action=CreateEventSubscription?Action=CreateEventSubscription&Version=2012-12-01Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the… - POSTCreate hsm client certificate
/#Action=CreateHsmClientCertificate?Action=CreateHsmClientCertificate&Version=2012-12-01Creates 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… - POSTCreate hsm configuration
/#Action=CreateHsmConfiguration?Action=CreateHsmConfiguration&Version=2012-12-01Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware… - POSTCreate integration
/#Action=CreateIntegration?Action=CreateIntegration&Version=2012-12-01Creates a zero-ETL integration or S3 event integration with Amazon Redshift. - POSTCreate qev2 idc application
/#Action=CreateQev2IdcApplication?Action=CreateQev2IdcApplication&Version=2012-12-01Creates an Amazon Redshift Query Editor (QEV2) IAM Identity Center application. - POSTCreate redshift idc application
/#Action=CreateRedshiftIdcApplication?Action=CreateRedshiftIdcApplication&Version=2012-12-01Creates an Amazon Redshift application for use with IAM Identity Center. - POSTCreate scheduled action
/#Action=CreateScheduledAction?Action=CreateScheduledAction&Version=2012-12-01Creates 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… - POSTCreate snapshot copy grant
/#Action=CreateSnapshotCopyGrant?Action=CreateSnapshotCopyGrant&Version=2012-12-01Creates a snapshot copy grant that permits Amazon Redshift to use an encrypted symmetric key from Key Management Service (KMS) to encrypt copied snapshots in… - POSTCreate snapshot schedule
/#Action=CreateSnapshotSchedule?Action=CreateSnapshotSchedule&Version=2012-12-01Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule. - POSTCreate tags
/#Action=CreateTags?Action=CreateTags&Version=2012-12-01Adds tags to a cluster. 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 attempt… - POSTCreate usage limit
/#Action=CreateUsageLimit?Action=CreateUsageLimit&Version=2012-12-01Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier. - POSTDeauthorize data share
/#Action=DeauthorizeDataShare?Action=DeauthorizeDataShare&Version=2012-12-01From a datashare producer account, removes authorization from the specified datashare. - POSTDelete authentication profile
/#Action=DeleteAuthenticationProfile?Action=DeleteAuthenticationProfile&Version=2012-12-01Deletes an authentication profile. - POSTDelete cluster
/#Action=DeleteCluster?Action=DeleteCluster&Version=2012-12-01Deletes a previously provisioned cluster without its final snapshot being created. A successful response from the web service indicates that the request was… - POSTDelete cluster parameter group
/#Action=DeleteClusterParameterGroup?Action=DeleteClusterParameterGroup&Version=2012-12-01Deletes a specified Amazon Redshift parameter group. You cannot delete a parameter group if it is associated with a cluster. - POSTDelete cluster security group
/#Action=DeleteClusterSecurityGroup?Action=DeleteClusterSecurityGroup&Version=2012-12-01Deletes an Amazon Redshift security group. You cannot delete a security group that is associated with any clusters. You cannot delete the default security… - POSTDelete cluster snapshot
/#Action=DeleteClusterSnapshot?Action=DeleteClusterSnapshot&Version=2012-12-01Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot. Unlike automated… - POSTDelete cluster subnet group
/#Action=DeleteClusterSubnetGroup?Action=DeleteClusterSubnetGroup&Version=2012-12-01Deletes the specified cluster subnet group. - POSTDelete custom domain association
/#Action=DeleteCustomDomainAssociation?Action=DeleteCustomDomainAssociation&Version=2012-12-01Contains information about deleting a custom domain association for a cluster. - POSTDelete endpoint access
/#Action=DeleteEndpointAccess?Action=DeleteEndpointAccess&Version=2012-12-01Deletes a Redshift-managed VPC endpoint. - POSTDelete event subscription
/#Action=DeleteEventSubscription?Action=DeleteEventSubscription&Version=2012-12-01Deletes an Amazon Redshift event notification subscription. - POSTDelete hsm client certificate
/#Action=DeleteHsmClientCertificate?Action=DeleteHsmClientCertificate&Version=2012-12-01Deletes the specified HSM client certificate. - POSTDelete hsm configuration
/#Action=DeleteHsmConfiguration?Action=DeleteHsmConfiguration&Version=2012-12-01Deletes the specified Amazon Redshift HSM configuration. - POSTDelete integration
/#Action=DeleteIntegration?Action=DeleteIntegration&Version=2012-12-01Deletes a zero-ETL integration or S3 event integration with Amazon Redshift. - POSTDelete partner
/#Action=DeletePartner?Action=DeletePartner&Version=2012-12-01Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website. - POSTDelete qev2 idc application
/#Action=DeleteQev2IdcApplication?Action=DeleteQev2IdcApplication&Version=2012-12-01Deletes an Amazon Redshift Query Editor (QEV2) IAM Identity Center application. - POSTDelete redshift idc application
/#Action=DeleteRedshiftIdcApplication?Action=DeleteRedshiftIdcApplication&Version=2012-12-01Deletes an Amazon Redshift IAM Identity Center application. - POSTDelete resource policy
/#Action=DeleteResourcePolicy?Action=DeleteResourcePolicy&Version=2012-12-01Deletes the resource policy for a specified resource. - POSTDelete scheduled action
/#Action=DeleteScheduledAction?Action=DeleteScheduledAction&Version=2012-12-01Deletes a scheduled action. - POSTDelete snapshot copy grant
/#Action=DeleteSnapshotCopyGrant?Action=DeleteSnapshotCopyGrant&Version=2012-12-01Deletes the specified snapshot copy grant. - POSTDelete snapshot schedule
/#Action=DeleteSnapshotSchedule?Action=DeleteSnapshotSchedule&Version=2012-12-01Deletes a snapshot schedule. - POSTDelete tags
/#Action=DeleteTags?Action=DeleteTags&Version=2012-12-01Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags. - POSTDelete usage limit
/#Action=DeleteUsageLimit?Action=DeleteUsageLimit&Version=2012-12-01Deletes a usage limit from a cluster. - POSTDeregister namespace
/#Action=DeregisterNamespace?Action=DeregisterNamespace&Version=2012-12-01Deregisters a cluster or serverless namespace from the Amazon Web Services Glue Data Catalog. - POSTDescribe account attributes
/#Action=DescribeAccountAttributes?Action=DescribeAccountAttributes&Version=2012-12-01Returns a list of attributes attached to an account - POSTDescribe authentication profiles
/#Action=DescribeAuthenticationProfiles?Action=DescribeAuthenticationProfiles&Version=2012-12-01Describes an authentication profile. - POSTDescribe cluster db revisions
/#Action=DescribeClusterDbRevisions?Action=DescribeClusterDbRevisions&Version=2012-12-01Returns an array of ClusterDbRevision objects. - POSTDescribe cluster parameter groups
/#Action=DescribeClusterParameterGroups?Action=DescribeClusterParameterGroups&Version=2012-12-01Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the… - POSTDescribe cluster parameters
/#Action=DescribeClusterParameters?Action=DescribeClusterParameters&Version=2012-12-01Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information… - POSTDescribe cluster security groups
/#Action=DescribeClusterSecurityGroups?Action=DescribeClusterSecurityGroups&Version=2012-12-01Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only… - POSTDescribe cluster snapshots
/#Action=DescribeClusterSnapshots?Action=DescribeClusterSnapshots&Version=2012-12-01Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots… - POSTDescribe cluster subnet groups
/#Action=DescribeClusterSubnetGroups?Action=DescribeClusterSubnetGroups&Version=2012-12-01Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information… - POSTDescribe cluster tracks
/#Action=DescribeClusterTracks?Action=DescribeClusterTracks&Version=2012-12-01Returns a list of all the available maintenance tracks. - POSTDescribe cluster versions
/#Action=DescribeClusterVersions?Action=DescribeClusterVersions&Version=2012-12-01Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the… - POSTDescribe clusters
/#Action=DescribeClusters?Action=DescribeClusters&Version=2012-12-01Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security… - POSTDescribe custom domain associations
/#Action=DescribeCustomDomainAssociations?Action=DescribeCustomDomainAssociations&Version=2012-12-01Contains information about custom domain associations for a cluster. - POSTDescribe data shares
/#Action=DescribeDataShares?Action=DescribeDataShares&Version=2012-12-01Shows the status of any inbound or outbound datashares available in the specified account. - POSTDescribe data shares for consumer
/#Action=DescribeDataSharesForConsumer?Action=DescribeDataSharesForConsumer&Version=2012-12-01Returns a list of datashares where the account identifier being called is a consumer account identifier. - POSTDescribe data shares for producer
/#Action=DescribeDataSharesForProducer?Action=DescribeDataSharesForProducer&Version=2012-12-01Returns a list of datashares when the account identifier being called is a producer account identifier. - POSTDescribe default cluster parameters
/#Action=DescribeDefaultClusterParameters?Action=DescribeDefaultClusterParameters&Version=2012-12-01Returns a list of parameter settings for the specified parameter group family. For more information about parameters and parameter groups, go to Amazon… - POSTDescribe endpoint access
/#Action=DescribeEndpointAccess?Action=DescribeEndpointAccess&Version=2012-12-01Describes a Redshift-managed VPC endpoint. - POSTDescribe endpoint authorization
/#Action=DescribeEndpointAuthorization?Action=DescribeEndpointAuthorization&Version=2012-12-01Describes an endpoint authorization. - POSTDescribe event categories
/#Action=DescribeEventCategories?Action=DescribeEventCategories&Version=2012-12-01Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to… - POSTDescribe event subscriptions
/#Action=DescribeEventSubscriptions?Action=DescribeEventSubscriptions&Version=2012-12-01Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the… - POSTDescribe events
/#Action=DescribeEvents?Action=DescribeEvents&Version=2012-12-01Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security… - POSTDescribe hsm client certificates
/#Action=DescribeHsmClientCertificates?Action=DescribeHsmClientCertificates&Version=2012-12-01Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by… - POSTDescribe hsm configurations
/#Action=DescribeHsmConfigurations?Action=DescribeHsmConfigurations&Version=2012-12-01Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM… - POSTDescribe inbound integrations
/#Action=DescribeInboundIntegrations?Action=DescribeInboundIntegrations&Version=2012-12-01Returns a list of inbound integrations. - POSTDescribe integrations
/#Action=DescribeIntegrations?Action=DescribeIntegrations&Version=2012-12-01Describes one or more zero-ETL or S3 event integrations with Amazon Redshift. - POSTDescribe logging status
/#Action=DescribeLoggingStatus?Action=DescribeLoggingStatus&Version=2012-12-01Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster. - POSTDescribe node configuration options
/#Action=DescribeNodeConfigurationOptions?Action=DescribeNodeConfigurationOptions&Version=2012-12-01Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type. - POSTDescribe orderable cluster options
/#Action=DescribeOrderableClusterOptions?Action=DescribeOrderableClusterOptions&Version=2012-12-01Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2… - POSTDescribe partners
/#Action=DescribePartners?Action=DescribePartners&Version=2012-12-01Returns information about the partner integrations defined for a cluster. - POSTDescribe qev2 idc applications
/#Action=DescribeQev2IdcApplications?Action=DescribeQev2IdcApplications&Version=2012-12-01Lists the Amazon Redshift Query Editor (QEV2) IAM Identity Center applications. To retrieve additional results, use the MaxRecords and Marker parameters. - POSTDescribe redshift idc applications
/#Action=DescribeRedshiftIdcApplications?Action=DescribeRedshiftIdcApplications&Version=2012-12-01Lists the Amazon Redshift IAM Identity Center applications. - POSTDescribe reserved node exchange status
/#Action=DescribeReservedNodeExchangeStatus?Action=DescribeReservedNodeExchangeStatus&Version=2012-12-01Returns exchange status details and associated metadata for a reserved-node exchange. Statuses include such values as in progress and requested. - POSTDescribe reserved node offerings
/#Action=DescribeReservedNodeOfferings?Action=DescribeReservedNodeOfferings&Version=2012-12-01Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of… - POSTDescribe reserved nodes
/#Action=DescribeReservedNodes?Action=DescribeReservedNodes&Version=2012-12-01Returns the descriptions of the reserved nodes. - POSTDescribe resize
/#Action=DescribeResize?Action=DescribeResize&Version=2012-12-01Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a… - POSTDescribe scheduled actions
/#Action=DescribeScheduledActions?Action=DescribeScheduledActions&Version=2012-12-01Describes properties of scheduled actions. - POSTDescribe snapshot copy grants
/#Action=DescribeSnapshotCopyGrants?Action=DescribeSnapshotCopyGrants&Version=2012-12-01Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region. For more information about managing snapshot copy… - POSTDescribe snapshot schedules
/#Action=DescribeSnapshotSchedules?Action=DescribeSnapshotSchedules&Version=2012-12-01Returns a list of snapshot schedules. - POSTDescribe storage
/#Action=DescribeStorage?Action=DescribeStorage&Version=2012-12-01Returns account level backups storage size and provisional storage. - POSTDescribe table restore status
/#Action=DescribeTableRestoreStatus?Action=DescribeTableRestoreStatus&Version=2012-12-01Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the… - POSTDescribe tags
/#Action=DescribeTags?Action=DescribeTags&Version=2012-12-01Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as… - POSTDescribe usage limits
/#Action=DescribeUsageLimits?Action=DescribeUsageLimits&Version=2012-12-01Shows usage limits on a cluster. Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type… - POSTDisable logging
/#Action=DisableLogging?Action=DisableLogging&Version=2012-12-01Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. - POSTDisable snapshot copy
/#Action=DisableSnapshotCopy?Action=DisableSnapshotCopy&Version=2012-12-01Disables the automatic copying of snapshots from one region to another region for a specified cluster. If your cluster and its snapshots are encrypted using… - POSTDisassociate data share consumer
/#Action=DisassociateDataShareConsumer?Action=DisassociateDataShareConsumer&Version=2012-12-01From a datashare consumer account, remove association for the specified datashare. - POSTEnable logging
/#Action=EnableLogging?Action=EnableLogging&Version=2012-12-01Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster. - POSTEnable snapshot copy
/#Action=EnableSnapshotCopy?Action=EnableSnapshotCopy&Version=2012-12-01Enables the automatic copy of snapshots from one region to another region for a specified cluster. - POSTFailover primary compute
/#Action=FailoverPrimaryCompute?Action=FailoverPrimaryCompute&Version=2012-12-01Fails over the primary compute unit of the specified Multi-AZ cluster to another Availability Zone. - POSTGet cluster credentials
/#Action=GetClusterCredentials?Action=GetClusterCredentials&Version=2012-12-01Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database… - POSTGet cluster credentials with iAM
/#Action=GetClusterCredentialsWithIAM?Action=GetClusterCredentialsWithIAM&Version=2012-12-01Returns a database user name and temporary password with temporary authorization to log in to an Amazon Redshift database. The database user is mapped 1:1 to… - POSTGet identity center auth token
/#Action=GetIdentityCenterAuthToken?Action=GetIdentityCenterAuthToken&Version=2012-12-01Generates an encrypted authentication token that propagates the caller's Amazon Web Services IAM Identity Center identity to Amazon Redshift clusters. This… - POSTGet reserved node exchange configuration options
/#Action=GetReservedNodeExchangeConfigurationOptions?Action=GetReservedNodeExchangeConfigurationOptions&Version=2012-12-01Gets the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node… - POSTGet reserved node exchange offerings
/#Action=GetReservedNodeExchangeOfferings?Action=GetReservedNodeExchangeOfferings&Version=2012-12-01Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node. - POSTGet resource policy
/#Action=GetResourcePolicy?Action=GetResourcePolicy&Version=2012-12-01Get the resource policy for a specified resource. - POSTList recommendations
/#Action=ListRecommendations?Action=ListRecommendations&Version=2012-12-01List the Amazon Redshift Advisor recommendations for one or multiple Amazon Redshift clusters in an Amazon Web Services account. - POSTModify aqua configuration
/#Action=ModifyAquaConfiguration?Action=ModifyAquaConfiguration&Version=2012-12-01This operation is retired. Calling this operation does not change AQUA configuration. Amazon Redshift automatically determines whether to use AQUA (Advanced… - POSTModify authentication profile
/#Action=ModifyAuthenticationProfile?Action=ModifyAuthenticationProfile&Version=2012-12-01Modifies an authentication profile. - POSTModify cluster
/#Action=ModifyCluster?Action=ModifyCluster&Version=2012-12-01Modifies the settings for a cluster. You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must… - POSTModify cluster db revision
/#Action=ModifyClusterDbRevision?Action=ModifyClusterDbRevision&Version=2012-12-01Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster. - POSTModify cluster iam roles
/#Action=ModifyClusterIamRoles?Action=ModifyClusterIamRoles&Version=2012-12-01Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. The maximum… - POSTModify cluster maintenance
/#Action=ModifyClusterMaintenance?Action=ModifyClusterMaintenance&Version=2012-12-01Modifies the maintenance settings of a cluster. - POSTModify cluster parameter group
/#Action=ModifyClusterParameterGroup?Action=ModifyClusterParameterGroup&Version=2012-12-01Modifies the parameters of a parameter group. For the parameters parameter, it can't contain ASCII characters. For more information about parameters and… - POSTModify cluster snapshot
/#Action=ModifyClusterSnapshot?Action=ModifyClusterSnapshot&Version=2012-12-01Modifies the settings for a snapshot. This exanmple modifies the manual retention period setting for a cluster snapshot. - POSTModify cluster snapshot schedule
/#Action=ModifyClusterSnapshotSchedule?Action=ModifyClusterSnapshotSchedule&Version=2012-12-01Modifies a snapshot schedule for a cluster. - POSTModify cluster subnet group
/#Action=ModifyClusterSubnetGroup?Action=ModifyClusterSubnetGroup&Version=2012-12-01Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of… - POSTModify custom domain association
/#Action=ModifyCustomDomainAssociation?Action=ModifyCustomDomainAssociation&Version=2012-12-01Contains information for changing a custom domain association. - POSTModify endpoint access
/#Action=ModifyEndpointAccess?Action=ModifyEndpointAccess&Version=2012-12-01Modifies a Redshift-managed VPC endpoint. - POSTModify event subscription
/#Action=ModifyEventSubscription?Action=ModifyEventSubscription&Version=2012-12-01Modifies an existing Amazon Redshift event notification subscription. - POSTModify integration
/#Action=ModifyIntegration?Action=ModifyIntegration&Version=2012-12-01Modifies a zero-ETL integration or S3 event integration with Amazon Redshift. - POSTModify lakehouse configuration
/#Action=ModifyLakehouseConfiguration?Action=ModifyLakehouseConfiguration&Version=2012-12-01Modifies the lakehouse configuration for a cluster. This operation allows you to manage Amazon Redshift federated permissions and Amazon Web Services IAM… - POSTModify qev2 idc application
/#Action=ModifyQev2IdcApplication?Action=ModifyQev2IdcApplication&Version=2012-12-01Modifies an Amazon Redshift Query Editor (QEV2) IAM Identity Center application. - POSTModify redshift idc application
/#Action=ModifyRedshiftIdcApplication?Action=ModifyRedshiftIdcApplication&Version=2012-12-01Changes an existing Amazon Redshift IAM Identity Center application. - POSTModify scheduled action
/#Action=ModifyScheduledAction?Action=ModifyScheduledAction&Version=2012-12-01Modifies a scheduled action. - POSTModify snapshot copy retention period
/#Action=ModifySnapshotCopyRetentionPeriod?Action=ModifySnapshotCopyRetentionPeriod&Version=2012-12-01Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services… - POSTModify snapshot schedule
/#Action=ModifySnapshotSchedule?Action=ModifySnapshotSchedule&Version=2012-12-01Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously. - POSTModify usage limit
/#Action=ModifyUsageLimit?Action=ModifyUsageLimit&Version=2012-12-01Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit. - POSTPause cluster
/#Action=PauseCluster?Action=PauseCluster&Version=2012-12-01Pauses a cluster. - POSTPurchase reserved node offering
/#Action=PurchaseReservedNodeOffering?Action=PurchaseReservedNodeOffering&Version=2012-12-01Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You… - POSTPut resource policy
/#Action=PutResourcePolicy?Action=PutResourcePolicy&Version=2012-12-01Updates the resource policy for a specified resource. - POSTReboot cluster
/#Action=RebootCluster?Action=RebootCluster&Version=2012-12-01Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to… - POSTRegister namespace
/#Action=RegisterNamespace?Action=RegisterNamespace&Version=2012-12-01Registers a cluster or serverless namespace to the Amazon Web Services Glue Data Catalog. - POSTReject data share
/#Action=RejectDataShare?Action=RejectDataShare&Version=2012-12-01From a datashare consumer account, rejects the specified datashare. - POSTReset cluster parameter group
/#Action=ResetClusterParameterGroup?Action=ResetClusterParameterGroup&Version=2012-12-01Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To… - POSTResize cluster
/#Action=ResizeCluster?Action=ResizeCluster&Version=2012-12-01Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize… - POSTRestore from cluster snapshot
/#Action=RestoreFromClusterSnapshot?Action=RestoreFromClusterSnapshot&Version=2012-12-01Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from… - POSTRestore table from cluster snapshot
/#Action=RestoreTableFromClusterSnapshot?Action=RestoreTableFromClusterSnapshot&Version=2012-12-01Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot… - POSTResume cluster
/#Action=ResumeCluster?Action=ResumeCluster&Version=2012-12-01Resumes a paused cluster. - POSTRevoke cluster security group ingress
/#Action=RevokeClusterSecurityGroupIngress?Action=RevokeClusterSecurityGroupIngress&Version=2012-12-01Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see… - POSTRevoke endpoint access
/#Action=RevokeEndpointAccess?Action=RevokeEndpointAccess&Version=2012-12-01Revokes access to a cluster. - POSTRevoke snapshot access
/#Action=RevokeSnapshotAccess?Action=RevokeSnapshotAccess&Version=2012-12-01Removes the ability of the specified Amazon Web Services account to restore the specified snapshot. If the account is currently restoring the snapshot, the… - POSTRotate encryption key
/#Action=RotateEncryptionKey?Action=RotateEncryptionKey&Version=2012-12-01Rotates the encryption keys for a cluster. - POSTUpdate partner status
/#Action=UpdatePartnerStatus?Action=UpdatePartnerStatus&Version=2012-12-01Updates the status of a partner integration.
API details
- Base URL
https://redshift.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 145 operations on 145 pathsPOST 145
- Description format
- AWS Smithy model, API version
2012-12-01 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Redshift in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Redshift collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Accept reserved node exchange” (POST /#Action=AcceptReservedNodeExchange?Action=AcceptReservedNodeExchange&Version=2012-12-01), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Redshift?
Amazon Redshift Overview This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces… It is listed under Data & analytics and has 145 endpoints.
Who publishes the Amazon Redshift?
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 Redshift?
Requests go to https://redshift.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Redshift?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Redshift have?
145 operations on 145 paths (145 POST).
Is forking the Amazon Redshift free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.