Amazon Redshift API Reference API Version 2012-12-01 Amazon Redshift API Reference Amazon Redshift: API Reference Copyright © 2014 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. The following are trademarks of Amazon Web Services, Inc.: Amazon, Amazon Web Services Design, AWS, Amazon CloudFront, Cloudfront, Amazon DevPay, DynamoDB, ElastiCache, Amazon EC2, Amazon Elastic Compute Cloud, Amazon Glacier, Kindle, Kindle Fire, AWS Marketplace Design, Mechanical Turk, Amazon Redshift, Amazon Route 53, Amazon S3, Amazon VPC. In addition, Amazon.com graphics, logos, page headers, button icons, scripts, and service names are trademarks, or trade dress of Amazon in the U.S. and/or other countries. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon Redshift API Reference Welcome................................................................................................................................................. 1 Actions .................................................................................................................................................... 2 AuthorizeClusterSecurityGroupIngress .................................................................................................. 4 AuthorizeSnapshotAccess...................................................................................................................... 7 CopyClusterSnapshot........................................................................................................................... 11 CreateCluster........................................................................................................................................16 CreateClusterParameterGroup ............................................................................................................. 27 CreateClusterSecurityGroup ................................................................................................................ 30 CreateClusterSnapshot ........................................................................................................................ 32 CreateClusterSubnetGroup .................................................................................................................. 36 CreateEventSubscription ...................................................................................................................... 39 CreateHsmClientCertificate .................................................................................................................. 43 CreateHsmConfiguration ...................................................................................................................... 44 DeleteCluster ........................................................................................................................................ 46 DeleteClusterParameterGroup ............................................................................................................. 52 DeleteClusterSecurityGroup ................................................................................................................. 54 DeleteClusterSnapshot.........................................................................................................................56 DeleteClusterSubnetGroup...................................................................................................................60 DeleteEventSubscription ...................................................................................................................... 62 DeleteHsmClientCertificate .................................................................................................................. 63 DeleteHsmConfiguration.......................................................................................................................64 DescribeClusterParameterGroups........................................................................................................65 DescribeClusterParameters..................................................................................................................68 DescribeClusterSecurityGroups ........................................................................................................... 72 DescribeClusterSnapshots ................................................................................................................... 75 DescribeClusterSubnetGroups ............................................................................................................. 79 DescribeClusterVersions ...................................................................................................................... 82 DescribeClusters .................................................................................................................................. 84 DescribeDefaultClusterParameters ...................................................................................................... 87 DescribeEventCategories ..................................................................................................................... 90 DescribeEventSubscriptions.................................................................................................................91 DescribeEvents.....................................................................................................................................93 DescribeHsmClientCertificates.............................................................................................................96 DescribeHsmConfigurations ................................................................................................................. 98 DescribeLoggingStatus ...................................................................................................................... 100 DescribeOrderableClusterOptions......................................................................................................102 DescribeReservedNodeOfferings ....................................................................................................... 105 DescribeReservedNodes....................................................................................................................108 DescribeResize...................................................................................................................................111 DisableLogging ................................................................................................................................... 114 DisableSnapshotCopy ........................................................................................................................ 116 EnableLogging....................................................................................................................................120 EnableSnapshotCopy ......................................................................................................................... 122 ModifyCluster......................................................................................................................................126 ModifyClusterParameterGroup ........................................................................................................... 135 ModifyClusterSubnetGroup ................................................................................................................ 137 ModifyEventSubscription .................................................................................................................... 139 ModifySnapshotCopyRetentionPeriod ................................................................................................ 143 PurchaseReservedNodeOffering........................................................................................................147 RebootCluster.....................................................................................................................................150 ResetClusterParameterGroup ............................................................................................................ 155 RestoreFromClusterSnapshot ............................................................................................................ 157 RevokeClusterSecurityGroupIngress..................................................................................................166 RevokeSnapshotAccess ..................................................................................................................... 169 RotateEncryptionKey .......................................................................................................................... 173 Data Types..........................................................................................................................................177 AccountWithRestoreAccess ............................................................................................................... 178 AvailabilityZone...................................................................................................................................179 API Version 2012-12-01 3 Amazon Redshift API Reference Cluster ................................................................................................................................................ 179 ClusterNode........................................................................................................................................182 ClusterParameterGroup......................................................................................................................183 ClusterParameterGroupStatus............................................................................................................184 ClusterSecurityGroup ......................................................................................................................... 184 ClusterSecurityGroupMembership ..................................................................................................... 185 ClusterSnapshotCopyStatus...............................................................................................................185 ClusterSubnetGroup ........................................................................................................................... 186 ClusterVersion .................................................................................................................................... 187 DefaultClusterParameters...................................................................................................................187 DescribeClusterParameterGroupsResult ........................................................................................... 188 DescribeClusterParametersResult ..................................................................................................... 188 DescribeClusterSecurityGroupsResult ............................................................................................... 189 DescribeClusterSnapshotsResult ....................................................................................................... 189 DescribeClusterSubnetGroupsResult.................................................................................................190 DescribeClusterVersionsResult .......................................................................................................... 190 DescribeClustersResult ...................................................................................................................... 191 DescribeEventCategoriesResult.........................................................................................................192 DescribeEventSubscriptionsResult.....................................................................................................192 DescribeEventsResult ........................................................................................................................ 192 DescribeHsmClientCertificatesResult.................................................................................................193 DescribeHsmConfigurationsResult.....................................................................................................194 DescribeLoggingStatusResult ............................................................................................................ 194 DescribeOrderableClusterOptionsResult............................................................................................195 DescribeReservedNodeOfferingsResult.............................................................................................196 DescribeReservedNodesResult ......................................................................................................... 196 DescribeResizeResult ........................................................................................................................ 197 DisableLoggingResult.........................................................................................................................198 EC2SecurityGroup..............................................................................................................................199 ElasticIpStatus .................................................................................................................................... 200 EnableLoggingResult..........................................................................................................................200 Endpoint ............................................................................................................................................. 201 Event...................................................................................................................................................202 EventCategoriesMap .......................................................................................................................... 203 EventInfoMap......................................................................................................................................203 EventSubscription...............................................................................................................................204 HsmClientCertificate...........................................................................................................................205 HsmConfiguration ............................................................................................................................... 206 HsmStatus .......................................................................................................................................... 207 IPRange..............................................................................................................................................207 ModifyClusterParameterGroupResult ................................................................................................. 208 OrderableClusterOption...................................................................................................................... 208 Parameter ........................................................................................................................................... 209 PendingModifiedValues ...................................................................................................................... 210 RecurringCharge ................................................................................................................................ 211 ReservedNode....................................................................................................................................211 ReservedNodeOffering ....................................................................................................................... 213 ResetClusterParameterGroupResult .................................................................................................. 214 RestoreStatus ..................................................................................................................................... 215 Snapshot ............................................................................................................................................ 216 Subnet ................................................................................................................................................ 219 VpcSecurityGroupMembership...........................................................................................................219 Common Parameters..........................................................................................................................221 Common Errors .................................................................................................................................. 223 API Version 2012-12-01 4 Amazon Redshift API Reference Welcome 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 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. This document was last updated on May 30, 2014. API Version 2012-12-01 1 Amazon Redshift API Reference Actions The following actions are supported: • AuthorizeClusterSecurityGroupIngress (p.4) • AuthorizeSnapshotAccess (p.7) • CopyClusterSnapshot (p.11) • CreateCluster (p.16) • CreateClusterParameterGroup (p.27) • CreateClusterSecurityGroup (p.30) • CreateClusterSnapshot (p.32) • CreateClusterSubnetGroup (p.36) • CreateEventSubscription (p.39) • CreateHsmClientCertificate (p.43) • CreateHsmConfiguration (p.44) • DeleteCluster (p.46) • DeleteClusterParameterGroup (p.52) • DeleteClusterSecurityGroup (p.54) • DeleteClusterSnapshot (p.56) • DeleteClusterSubnetGroup (p.60) • DeleteEventSubscription (p.62) • DeleteHsmClientCertificate (p.63) • DeleteHsmConfiguration (p.64) • DescribeClusterParameterGroups (p.65) • DescribeClusterParameters (p.68) • DescribeClusterSecurityGroups (p.72) • DescribeClusterSnapshots (p.75) • DescribeClusterSubnetGroups (p.79) • DescribeClusterVersions (p.82) • DescribeClusters (p.84) • DescribeDefaultClusterParameters (p.87) • DescribeEventCategories (p.90) • DescribeEventSubscriptions (p.91) • DescribeEvents (p.93) API Version 2012-12-01 2 Amazon Redshift API Reference • DescribeHsmClientCertificates (p.96) • DescribeHsmConfigurations (p.98) • DescribeLoggingStatus (p.100) • DescribeOrderableClusterOptions (p.102) • DescribeReservedNodeOfferings (p.105) • DescribeReservedNodes (p.108) • DescribeResize (p.111) • DisableLogging (p.114) • DisableSnapshotCopy (p.116) • EnableLogging (p.120) • EnableSnapshotCopy (p.122) • ModifyCluster (p.126) • ModifyClusterParameterGroup (p.135) • ModifyClusterSubnetGroup (p.137) • ModifyEventSubscription (p.139) • ModifySnapshotCopyRetentionPeriod (p.143) • PurchaseReservedNodeOffering (p.147) • RebootCluster (p.150) • ResetClusterParameterGroup (p.155) • RestoreFromClusterSnapshot (p.157) • RevokeClusterSecurityGroupIngress (p.166) • RevokeSnapshotAccess (p.169) • RotateEncryptionKey (p.173) API Version 2012-12-01 3 Amazon Redshift API Reference AuthorizeClusterSecurityGroupIngress AuthorizeClusterSecurityGroupIngress Description 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 EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR) IP address range or an EC2 security group.You can add as many as 20 ingress rules to an Amazon Redshift security group. Note The EC2 security group must be defined in the AWS region where the cluster resides. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing. 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 Working with Security Groups in the Amazon Redshift Management Guide. Request Parameters For information about the common parameters that all actions use, see Common Parameters (p.221). Note In the following list, the required parameters are described first. ClusterSecurityGroupName The name of the security group to which the ingress rule is added. Type: String Required:Yes CIDRIP The IP range to be added the Amazon Redshift security group. Type: String Required: No EC2SecurityGroupName The EC2 security group to be added the Amazon Redshift security group. Type: String Required: No EC2SecurityGroupOwnerId The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter.The AWS Access Key ID is not an acceptable value. Example:111122223333 Type: String Required: No Response Elements The following elements are returned in a structure named ClusterSecurityGroup. API Version 2012-12-01 4 Amazon Redshift API Reference Errors ClusterSecurityGroupName The name of the cluster security group to which the operation was applied. Type: String Description A description of the security group. Type: String EC2SecurityGroups A list of EC2 security groups that are permitted to access clusters associated with this cluster security group. Type:EC2SecurityGroup (p.199) list IPRanges A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group. Type:IPRange (p.207) list Errors For information about the errors that are common to all actions, see Common Errors (p.223). AuthorizationAlreadyExists The specified CIDR block or EC2 security group is already authorized for the specified cluster security group. HTTP Status Code: 400 AuthorizationQuotaExceeded The authorization quota for the cluster security group has been reached. HTTP Status Code: 400 ClusterSecurityGroupNotFound The cluster security group name does not refer to an existing cluster security group. HTTP Status Code: 404 InvalidClusterSecurityGroupState The state of the cluster security group is not available. HTTP Status Code: 400 Examples Sample Request https://redshift.us-east-1.amazonaws.com/ ?Action=AuthorizeClusterSecurityGroupIngress &CIDRIP=192.168.40.3/32 &ClusterSecurityGroupName=securitygroup1 &Version=2012-12-01 &x-amz-algorithm=AWS4-HMAC-SHA256 &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_re quest API Version 2012-12-01 5 Amazon Redshift API Reference Examples &x-amz-date=20130123T020649Z &x-amz-signedheaders=content-type;host;x-amz-date Sample Response <AuthorizeClusterSecurityGroupIngressResponse xmlns="http://redshift.amazon aws.com/doc/2012-12-01/"> <AuthorizeClusterSecurityGroupIngressResult> <ClusterSecurityGroup> <EC2SecurityGroups/> <IPRanges> <IPRange> <CIDRIP>192.168.40.3/32</CIDRIP> <Status>authorized</Status> </IPRange> </IPRanges> <Description>my security group</Description> <ClusterSecurityGroupName>securitygroup1</ClusterSecurityGroupName> </ClusterSecurityGroup> </AuthorizeClusterSecurityGroupIngressResult> <ResponseMetadata> <RequestId>8c7cd4c8-6501-11e2-a8da-655adc216806</RequestId> </ResponseMetadata> </AuthorizeClusterSecurityGroupIngressResponse> API Version 2012-12-01 6