Amazon Redshift - API Reference PDF
Preview Amazon Redshift - API Reference
Amazon Redshift API Reference API Version 2012-12-01 Amazon Redshift API Reference Amazon Redshift: API Reference Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. 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 Table of Contents Welcome........................................................................................................................................... 1 Actions............................................................................................................................................. 2 AcceptReservedNodeExchange..................................................................................................... 5 Request Parameters............................................................................................................ 5 Response Elements............................................................................................................. 5 Errors............................................................................................................................... 5 Examples........................................................................................................................... 6 See Also............................................................................................................................ 7 AddPartner................................................................................................................................ 8 Request Parameters............................................................................................................ 8 Response Elements............................................................................................................. 8 Errors............................................................................................................................... 9 See Also............................................................................................................................ 9 AssociateDataShareConsumer.................................................................................................... 10 Request Parameters.......................................................................................................... 10 Response Elements........................................................................................................... 10 Errors.............................................................................................................................. 11 Examples......................................................................................................................... 11 See Also.......................................................................................................................... 12 AuthorizeClusterSecurityGroupIngress......................................................................................... 13 Request Parameters.......................................................................................................... 13 Response Elements........................................................................................................... 14 Errors.............................................................................................................................. 14 Examples......................................................................................................................... 14 See Also.......................................................................................................................... 15 AuthorizeDataShare.................................................................................................................. 16 Request Parameters.......................................................................................................... 16 Response Elements........................................................................................................... 16 Errors.............................................................................................................................. 17 Examples......................................................................................................................... 17 See Also.......................................................................................................................... 18 AuthorizeEndpointAccess........................................................................................................... 19 Request Parameters.......................................................................................................... 19 Response Elements........................................................................................................... 19 Errors.............................................................................................................................. 20 See Also.......................................................................................................................... 21 AuthorizeSnapshotAccess.......................................................................................................... 22 Request Parameters.......................................................................................................... 22 Response Elements........................................................................................................... 22 Errors.............................................................................................................................. 23 See Also.......................................................................................................................... 23 BatchDeleteClusterSnapshots..................................................................................................... 25 Request Parameters.......................................................................................................... 25 Response Elements........................................................................................................... 25 Errors.............................................................................................................................. 25 Examples......................................................................................................................... 25 See Also.......................................................................................................................... 26 BatchModifyClusterSnapshots.................................................................................................... 27 Request Parameters.......................................................................................................... 27 Response Elements........................................................................................................... 27 Errors.............................................................................................................................. 28 Examples......................................................................................................................... 28 See Also.......................................................................................................................... 28 CancelResize............................................................................................................................ 30 API Version 2012-12-01 iii Amazon Redshift API Reference Request Parameters.......................................................................................................... 30 Response Elements........................................................................................................... 30 Errors.............................................................................................................................. 32 Examples......................................................................................................................... 32 See Also.......................................................................................................................... 33 CopyClusterSnapshot................................................................................................................ 34 Request Parameters.......................................................................................................... 34 Response Elements........................................................................................................... 35 Errors.............................................................................................................................. 35 Examples......................................................................................................................... 36 See Also.......................................................................................................................... 37 CreateAuthenticationProfile....................................................................................................... 38 Request Parameters.......................................................................................................... 38 Response Elements........................................................................................................... 38 Errors.............................................................................................................................. 38 See Also.......................................................................................................................... 39 CreateCluster........................................................................................................................... 40 Request Parameters.......................................................................................................... 40 Response Elements........................................................................................................... 47 Errors.............................................................................................................................. 47 Examples......................................................................................................................... 49 See Also.......................................................................................................................... 50 CreateClusterParameterGroup.................................................................................................... 52 Request Parameters.......................................................................................................... 52 Response Elements........................................................................................................... 53 Errors.............................................................................................................................. 53 Examples......................................................................................................................... 53 See Also.......................................................................................................................... 54 CreateClusterSecurityGroup....................................................................................................... 55 Request Parameters.......................................................................................................... 55 Response Elements........................................................................................................... 55 Errors.............................................................................................................................. 56 Examples......................................................................................................................... 56 See Also.......................................................................................................................... 57 CreateClusterSnapshot.............................................................................................................. 58 Request Parameters.......................................................................................................... 58 Response Elements........................................................................................................... 59 Errors.............................................................................................................................. 59 Examples......................................................................................................................... 59 See Also.......................................................................................................................... 60 CreateClusterSubnetGroup......................................................................................................... 62 Request Parameters.......................................................................................................... 62 Response Elements........................................................................................................... 62 Errors.............................................................................................................................. 63 Examples......................................................................................................................... 64 See Also.......................................................................................................................... 64 CreateEndpointAccess............................................................................................................... 66 Request Parameters.......................................................................................................... 66 Response Elements........................................................................................................... 67 Errors.............................................................................................................................. 68 See Also.......................................................................................................................... 69 CreateEventSubscription............................................................................................................ 70 Request Parameters.......................................................................................................... 70 Response Elements........................................................................................................... 72 Errors.............................................................................................................................. 72 Examples......................................................................................................................... 73 See Also.......................................................................................................................... 74 API Version 2012-12-01 iv Amazon Redshift API Reference CreateHsmClientCertificate........................................................................................................ 75 Request Parameters.......................................................................................................... 75 Response Elements........................................................................................................... 75 Errors.............................................................................................................................. 75 Examples......................................................................................................................... 76 See Also.......................................................................................................................... 77 CreateHsmConfiguration........................................................................................................... 78 Request Parameters.......................................................................................................... 78 Response Elements........................................................................................................... 79 Errors.............................................................................................................................. 79 Examples......................................................................................................................... 80 See Also.......................................................................................................................... 80 CreateScheduledAction.............................................................................................................. 81 Request Parameters.......................................................................................................... 81 Response Elements........................................................................................................... 82 Errors.............................................................................................................................. 83 See Also.......................................................................................................................... 84 CreateSnapshotCopyGrant......................................................................................................... 85 Request Parameters.......................................................................................................... 85 Response Elements........................................................................................................... 85 Errors.............................................................................................................................. 86 Examples......................................................................................................................... 86 See Also.......................................................................................................................... 87 CreateSnapshotSchedule........................................................................................................... 88 Request Parameters.......................................................................................................... 88 Response Elements........................................................................................................... 89 Errors.............................................................................................................................. 89 Examples......................................................................................................................... 90 See Also.......................................................................................................................... 91 CreateTags............................................................................................................................... 92 Request Parameters.......................................................................................................... 92 Errors.............................................................................................................................. 92 Examples......................................................................................................................... 93 See Also.......................................................................................................................... 93 CreateUsageLimit..................................................................................................................... 94 Request Parameters.......................................................................................................... 94 Response Elements........................................................................................................... 95 Errors.............................................................................................................................. 96 See Also.......................................................................................................................... 97 DeauthorizeDataShare............................................................................................................... 98 Request Parameters.......................................................................................................... 98 Response Elements........................................................................................................... 98 Errors.............................................................................................................................. 99 Examples......................................................................................................................... 99 See Also........................................................................................................................ 100 DeleteAuthenticationProfile..................................................................................................... 101 Request Parameters........................................................................................................ 101 Response Elements......................................................................................................... 101 Errors............................................................................................................................ 101 See Also........................................................................................................................ 101 DeleteCluster......................................................................................................................... 103 Request Parameters........................................................................................................ 103 Response Elements......................................................................................................... 104 Errors............................................................................................................................ 104 Examples....................................................................................................................... 105 See Also........................................................................................................................ 106 DeleteClusterParameterGroup.................................................................................................. 107 API Version 2012-12-01 v Amazon Redshift API Reference Request Parameters........................................................................................................ 107 Errors............................................................................................................................ 107 Examples....................................................................................................................... 107 See Also........................................................................................................................ 108 DeleteClusterSecurityGroup..................................................................................................... 109 Request Parameters........................................................................................................ 109 Errors............................................................................................................................ 109 Examples....................................................................................................................... 109 See Also........................................................................................................................ 110 DeleteClusterSnapshot............................................................................................................ 111 Request Parameters........................................................................................................ 111 Response Elements......................................................................................................... 111 Errors............................................................................................................................ 111 Examples....................................................................................................................... 112 See Also........................................................................................................................ 113 DeleteClusterSubnetGroup....................................................................................................... 114 Request Parameters........................................................................................................ 114 Errors............................................................................................................................ 114 Examples....................................................................................................................... 114 See Also........................................................................................................................ 115 DeleteEndpointAccess............................................................................................................. 116 Request Parameters........................................................................................................ 116 Response Elements......................................................................................................... 116 Errors............................................................................................................................ 117 See Also........................................................................................................................ 118 DeleteEventSubscription.......................................................................................................... 119 Request Parameters........................................................................................................ 119 Errors............................................................................................................................ 119 Examples....................................................................................................................... 119 See Also........................................................................................................................ 120 DeleteHsmClientCertificate...................................................................................................... 121 Request Parameters........................................................................................................ 121 Errors............................................................................................................................ 121 Examples....................................................................................................................... 121 See Also........................................................................................................................ 122 DeleteHsmConfiguration.......................................................................................................... 123 Request Parameters........................................................................................................ 123 Errors............................................................................................................................ 123 Examples....................................................................................................................... 123 See Also........................................................................................................................ 124 DeletePartner......................................................................................................................... 125 Request Parameters........................................................................................................ 125 Response Elements......................................................................................................... 125 Errors............................................................................................................................ 126 See Also........................................................................................................................ 126 DeleteScheduledAction............................................................................................................ 127 Request Parameters........................................................................................................ 127 Errors............................................................................................................................ 127 Examples....................................................................................................................... 127 See Also........................................................................................................................ 128 DeleteSnapshotCopyGrant....................................................................................................... 129 Request Parameters........................................................................................................ 129 Errors............................................................................................................................ 129 Examples....................................................................................................................... 129 See Also........................................................................................................................ 130 DeleteSnapshotSchedule......................................................................................................... 131 Request Parameters........................................................................................................ 131 API Version 2012-12-01 vi Amazon Redshift API Reference Errors............................................................................................................................ 131 Examples....................................................................................................................... 131 See Also........................................................................................................................ 132 DeleteTags............................................................................................................................. 133 Request Parameters........................................................................................................ 133 Errors............................................................................................................................ 133 Examples....................................................................................................................... 133 See Also........................................................................................................................ 134 DeleteUsageLimit................................................................................................................... 135 Request Parameters........................................................................................................ 135 Errors............................................................................................................................ 135 See Also........................................................................................................................ 135 DescribeAccountAttributes....................................................................................................... 136 Request Parameters........................................................................................................ 136 Response Elements......................................................................................................... 136 Errors............................................................................................................................ 136 Examples....................................................................................................................... 136 See Also........................................................................................................................ 137 DescribeAuthenticationProfiles................................................................................................. 138 Request Parameters........................................................................................................ 138 Response Elements......................................................................................................... 138 Errors............................................................................................................................ 138 See Also........................................................................................................................ 138 DescribeClusterDbRevisions...................................................................................................... 140 Request Parameters........................................................................................................ 140 Response Elements......................................................................................................... 140 Errors............................................................................................................................ 141 Examples....................................................................................................................... 141 See Also........................................................................................................................ 142 DescribeClusterParameterGroups.............................................................................................. 143 Request Parameters........................................................................................................ 143 Response Elements......................................................................................................... 144 Errors............................................................................................................................ 144 Examples....................................................................................................................... 145 See Also........................................................................................................................ 145 DescribeClusterParameters....................................................................................................... 147 Request Parameters........................................................................................................ 147 Response Elements......................................................................................................... 148 Errors............................................................................................................................ 148 Examples....................................................................................................................... 148 See Also........................................................................................................................ 151 DescribeClusters..................................................................................................................... 152 Request Parameters........................................................................................................ 152 Response Elements......................................................................................................... 153 Errors............................................................................................................................ 153 Examples....................................................................................................................... 154 See Also........................................................................................................................ 155 DescribeClusterSecurityGroups................................................................................................. 156 Request Parameters........................................................................................................ 156 Response Elements......................................................................................................... 157 Errors............................................................................................................................ 157 Examples....................................................................................................................... 158 See Also........................................................................................................................ 158 DescribeClusterSnapshots........................................................................................................ 160 Request Parameters........................................................................................................ 160 Response Elements......................................................................................................... 162 Errors............................................................................................................................ 163 API Version 2012-12-01 vii Amazon Redshift API Reference Examples....................................................................................................................... 163 See Also........................................................................................................................ 164 DescribeClusterSubnetGroups................................................................................................... 166 Request Parameters........................................................................................................ 166 Response Elements......................................................................................................... 167 Errors............................................................................................................................ 167 Examples....................................................................................................................... 168 See Also........................................................................................................................ 169 DescribeClusterTracks.............................................................................................................. 170 Request Parameters........................................................................................................ 170 Response Elements......................................................................................................... 170 Errors............................................................................................................................ 171 Examples....................................................................................................................... 171 See Also........................................................................................................................ 172 DescribeClusterVersions........................................................................................................... 173 Request Parameters........................................................................................................ 173 Response Elements......................................................................................................... 174 Errors............................................................................................................................ 174 Examples....................................................................................................................... 174 See Also........................................................................................................................ 175 DescribeDataShares................................................................................................................. 176 Request Parameters........................................................................................................ 176 Response Elements......................................................................................................... 176 Errors............................................................................................................................ 177 Examples....................................................................................................................... 177 See Also........................................................................................................................ 178 DescribeDataSharesForConsumer.............................................................................................. 179 Request Parameters........................................................................................................ 179 Response Elements......................................................................................................... 179 Errors............................................................................................................................ 180 See Also........................................................................................................................ 180 DescribeDataSharesForProducer................................................................................................ 181 Request Parameters........................................................................................................ 181 Response Elements......................................................................................................... 181 Errors............................................................................................................................ 182 See Also........................................................................................................................ 182 DescribeDefaultClusterParameters............................................................................................ 183 Request Parameters........................................................................................................ 183 Response Elements......................................................................................................... 183 Errors............................................................................................................................ 184 Examples....................................................................................................................... 184 See Also........................................................................................................................ 186 DescribeEndpointAccess........................................................................................................... 187 Request Parameters........................................................................................................ 187 Response Elements......................................................................................................... 188 Errors............................................................................................................................ 188 See Also........................................................................................................................ 188 DescribeEndpointAuthorization................................................................................................. 190 Request Parameters........................................................................................................ 190 Response Elements......................................................................................................... 191 Errors............................................................................................................................ 191 See Also........................................................................................................................ 191 DescribeEventCategories.......................................................................................................... 192 Request Parameters........................................................................................................ 192 Response Elements......................................................................................................... 192 Errors............................................................................................................................ 192 Examples....................................................................................................................... 192 API Version 2012-12-01 viii Amazon Redshift API Reference See Also........................................................................................................................ 193 DescribeEvents....................................................................................................................... 194 Request Parameters........................................................................................................ 194 Response Elements......................................................................................................... 195 Errors............................................................................................................................ 196 Examples....................................................................................................................... 196 See Also........................................................................................................................ 197 DescribeEventSubscriptions...................................................................................................... 199 Request Parameters........................................................................................................ 199 Response Elements......................................................................................................... 200 Errors............................................................................................................................ 200 Examples....................................................................................................................... 201 See Also........................................................................................................................ 201 DescribeHsmClientCertificates.................................................................................................. 203 Request Parameters........................................................................................................ 203 Response Elements......................................................................................................... 204 Errors............................................................................................................................ 204 Examples....................................................................................................................... 205 See Also........................................................................................................................ 205 DescribeHsmConfigurations..................................................................................................... 207 Request Parameters........................................................................................................ 207 Response Elements......................................................................................................... 208 Errors............................................................................................................................ 208 Examples....................................................................................................................... 209 See Also........................................................................................................................ 209 DescribeLoggingStatus............................................................................................................ 210 Request Parameters........................................................................................................ 210 Response Elements......................................................................................................... 210 Errors............................................................................................................................ 211 Examples....................................................................................................................... 211 See Also........................................................................................................................ 212 DescribeNodeConfigurationOptions........................................................................................... 213 Request Parameters........................................................................................................ 213 Response Elements......................................................................................................... 214 Errors............................................................................................................................ 214 Examples....................................................................................................................... 215 See Also........................................................................................................................ 216 DescribeOrderableClusterOptions............................................................................................. 217 Request Parameters........................................................................................................ 217 Response Elements......................................................................................................... 218 Errors............................................................................................................................ 218 Examples....................................................................................................................... 218 See Also........................................................................................................................ 220 DescribePartners..................................................................................................................... 221 Request Parameters........................................................................................................ 221 Response Elements......................................................................................................... 221 Errors............................................................................................................................ 222 See Also........................................................................................................................ 222 DescribeReservedNodeExchangeStatus...................................................................................... 223 Request Parameters........................................................................................................ 223 Response Elements......................................................................................................... 223 Errors............................................................................................................................ 224 See Also........................................................................................................................ 224 DescribeReservedNodeOfferings............................................................................................... 225 Request Parameters........................................................................................................ 225 Response Elements......................................................................................................... 225 Errors............................................................................................................................ 226 API Version 2012-12-01 ix Amazon Redshift API Reference Examples....................................................................................................................... 226 See Also........................................................................................................................ 227 DescribeReservedNodes........................................................................................................... 229 Request Parameters........................................................................................................ 229 Response Elements......................................................................................................... 229 Errors............................................................................................................................ 230 Examples....................................................................................................................... 230 See Also........................................................................................................................ 231 DescribeResize........................................................................................................................ 232 Request Parameters........................................................................................................ 232 Response Elements......................................................................................................... 232 Errors............................................................................................................................ 234 Examples....................................................................................................................... 234 See Also........................................................................................................................ 235 DescribeScheduledActions........................................................................................................ 236 Request Parameters........................................................................................................ 236 Response Elements......................................................................................................... 237 Errors............................................................................................................................ 237 Examples....................................................................................................................... 238 See Also........................................................................................................................ 238 DescribeSnapshotCopyGrants................................................................................................... 240 Request Parameters........................................................................................................ 240 Response Elements......................................................................................................... 241 Errors............................................................................................................................ 241 Examples....................................................................................................................... 242 See Also........................................................................................................................ 242 DescribeSnapshotSchedules..................................................................................................... 243 Request Parameters........................................................................................................ 243 Response Elements......................................................................................................... 244 Errors............................................................................................................................ 244 Examples....................................................................................................................... 244 See Also........................................................................................................................ 245 DescribeStorage..................................................................................................................... 246 Response Elements......................................................................................................... 246 Errors............................................................................................................................ 246 Examples....................................................................................................................... 246 See Also........................................................................................................................ 247 DescribeTableRestoreStatus..................................................................................................... 248 Request Parameters........................................................................................................ 248 Response Elements......................................................................................................... 248 Errors............................................................................................................................ 249 Examples....................................................................................................................... 249 See Also........................................................................................................................ 250 DescribeTags.......................................................................................................................... 251 Request Parameters........................................................................................................ 251 Response Elements......................................................................................................... 252 Errors............................................................................................................................ 253 Examples....................................................................................................................... 253 See Also........................................................................................................................ 254 DescribeUsageLimits............................................................................................................... 255 Request Parameters........................................................................................................ 255 Response Elements......................................................................................................... 256 Errors............................................................................................................................ 257 See Also........................................................................................................................ 257 DisableLogging....................................................................................................................... 258 Request Parameters........................................................................................................ 258 Response Elements......................................................................................................... 258 API Version 2012-12-01 x
Description:The list of books you might like
