AWS Database Migration Service API Reference API Version 2016-01-01 AWS Database Migration Service API Reference AWS Database Migration Service: 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. AWS Database Migration Service API Reference Table of Contents Welcome........................................................................................................................................... 1 Actions............................................................................................................................................. 2 AddTagsToResource.................................................................................................................... 4 Request Syntax.................................................................................................................. 4 Request Parameters............................................................................................................ 4 Response Elements............................................................................................................. 4 Errors............................................................................................................................... 4 Examples........................................................................................................................... 5 See Also............................................................................................................................ 5 ApplyPendingMaintenanceAction.................................................................................................. 6 Request Syntax.................................................................................................................. 6 Request Parameters............................................................................................................ 6 Response Syntax................................................................................................................ 6 Response Elements............................................................................................................. 7 Errors............................................................................................................................... 7 See Also............................................................................................................................ 7 CancelReplicationTaskAssessmentRun........................................................................................... 8 Request Syntax.................................................................................................................. 8 Request Parameters............................................................................................................ 8 Response Syntax................................................................................................................ 8 Response Elements............................................................................................................. 8 Errors............................................................................................................................... 9 Examples........................................................................................................................... 9 See Also.......................................................................................................................... 10 CreateEndpoint........................................................................................................................ 11 Request Syntax................................................................................................................ 11 Request Parameters.......................................................................................................... 16 Response Syntax.............................................................................................................. 21 Response Elements........................................................................................................... 26 Errors.............................................................................................................................. 26 Examples......................................................................................................................... 27 See Also.......................................................................................................................... 28 CreateEventSubscription............................................................................................................ 29 Request Syntax................................................................................................................ 29 Request Parameters.......................................................................................................... 29 Response Syntax.............................................................................................................. 30 Response Elements........................................................................................................... 31 Errors.............................................................................................................................. 31 See Also.......................................................................................................................... 32 CreateFleetAdvisorCollector....................................................................................................... 33 Request Syntax................................................................................................................ 33 Request Parameters.......................................................................................................... 33 Response Syntax.............................................................................................................. 33 Response Elements........................................................................................................... 34 Errors.............................................................................................................................. 34 See Also.......................................................................................................................... 35 CreateReplicationInstance.......................................................................................................... 36 Request Syntax................................................................................................................ 36 Request Parameters.......................................................................................................... 36 Response Syntax.............................................................................................................. 39 Response Elements........................................................................................................... 40 Errors.............................................................................................................................. 40 Examples......................................................................................................................... 41 See Also.......................................................................................................................... 43 API Version 2016-01-01 iii AWS Database Migration Service API Reference CreateReplicationSubnetGroup................................................................................................... 44 Request Syntax................................................................................................................ 44 Request Parameters.......................................................................................................... 44 Response Syntax.............................................................................................................. 45 Response Elements........................................................................................................... 45 Errors.............................................................................................................................. 45 Examples......................................................................................................................... 46 See Also.......................................................................................................................... 47 CreateReplicationTask............................................................................................................... 48 Request Syntax................................................................................................................ 48 Request Parameters.......................................................................................................... 48 Response Syntax.............................................................................................................. 50 Response Elements........................................................................................................... 51 Errors.............................................................................................................................. 51 Examples......................................................................................................................... 52 See Also.......................................................................................................................... 53 DeleteCertificate...................................................................................................................... 55 Request Syntax................................................................................................................ 55 Request Parameters.......................................................................................................... 55 Response Syntax.............................................................................................................. 55 Response Elements........................................................................................................... 55 Errors.............................................................................................................................. 56 See Also.......................................................................................................................... 56 DeleteConnection..................................................................................................................... 57 Request Syntax................................................................................................................ 57 Request Parameters.......................................................................................................... 57 Response Syntax.............................................................................................................. 57 Response Elements........................................................................................................... 57 Errors.............................................................................................................................. 58 Examples......................................................................................................................... 58 See Also.......................................................................................................................... 59 DeleteEndpoint........................................................................................................................ 60 Request Syntax................................................................................................................ 60 Request Parameters.......................................................................................................... 60 Response Syntax.............................................................................................................. 60 Response Elements........................................................................................................... 65 Errors.............................................................................................................................. 65 Examples......................................................................................................................... 66 See Also.......................................................................................................................... 66 DeleteEventSubscription............................................................................................................ 68 Request Syntax................................................................................................................ 68 Request Parameters.......................................................................................................... 68 Response Syntax.............................................................................................................. 68 Response Elements........................................................................................................... 68 Errors.............................................................................................................................. 69 See Also.......................................................................................................................... 69 DeleteFleetAdvisorCollector....................................................................................................... 70 Request Syntax................................................................................................................ 70 Request Parameters.......................................................................................................... 70 Response Elements........................................................................................................... 70 Errors.............................................................................................................................. 70 See Also.......................................................................................................................... 70 DeleteFleetAdvisorDatabases..................................................................................................... 72 Request Syntax................................................................................................................ 72 Request Parameters.......................................................................................................... 72 Response Syntax.............................................................................................................. 72 Response Elements........................................................................................................... 72 API Version 2016-01-01 iv AWS Database Migration Service API Reference Errors.............................................................................................................................. 72 See Also.......................................................................................................................... 73 DeleteReplicationInstance.......................................................................................................... 74 Request Syntax................................................................................................................ 74 Request Parameters.......................................................................................................... 74 Response Syntax.............................................................................................................. 74 Response Elements........................................................................................................... 75 Errors.............................................................................................................................. 75 Examples......................................................................................................................... 76 See Also.......................................................................................................................... 77 DeleteReplicationSubnetGroup................................................................................................... 78 Request Syntax................................................................................................................ 78 Request Parameters.......................................................................................................... 78 Response Elements........................................................................................................... 78 Errors.............................................................................................................................. 78 Examples......................................................................................................................... 78 See Also.......................................................................................................................... 79 DeleteReplicationTask............................................................................................................... 80 Request Syntax................................................................................................................ 80 Request Parameters.......................................................................................................... 80 Response Syntax.............................................................................................................. 80 Response Elements........................................................................................................... 81 Errors.............................................................................................................................. 81 See Also.......................................................................................................................... 81 DeleteReplicationTaskAssessmentRun.......................................................................................... 82 Request Syntax................................................................................................................ 82 Request Parameters.......................................................................................................... 82 Response Syntax.............................................................................................................. 82 Response Elements........................................................................................................... 82 Errors.............................................................................................................................. 83 Examples......................................................................................................................... 83 See Also.......................................................................................................................... 84 DescribeAccountAttributes......................................................................................................... 85 Response Syntax.............................................................................................................. 85 Response Elements........................................................................................................... 85 Errors.............................................................................................................................. 85 Examples......................................................................................................................... 86 See Also.......................................................................................................................... 87 DescribeApplicableIndividualAssessments.................................................................................... 88 Request Syntax................................................................................................................ 88 Request Parameters.......................................................................................................... 88 Response Syntax.............................................................................................................. 89 Response Elements........................................................................................................... 89 Errors.............................................................................................................................. 90 Examples......................................................................................................................... 90 See Also.......................................................................................................................... 91 DescribeCertificates.................................................................................................................. 92 Request Syntax................................................................................................................ 92 Request Parameters.......................................................................................................... 92 Response Syntax.............................................................................................................. 92 Response Elements........................................................................................................... 93 Errors.............................................................................................................................. 93 See Also.......................................................................................................................... 93 DescribeConnections................................................................................................................. 95 Request Syntax................................................................................................................ 95 Request Parameters.......................................................................................................... 95 Response Syntax.............................................................................................................. 96 API Version 2016-01-01 v AWS Database Migration Service API Reference Response Elements........................................................................................................... 96 Errors.............................................................................................................................. 96 Examples......................................................................................................................... 96 See Also.......................................................................................................................... 97 DescribeEndpoints.................................................................................................................... 99 Request Syntax................................................................................................................ 99 Request Parameters.......................................................................................................... 99 Response Syntax.............................................................................................................. 99 Response Elements......................................................................................................... 105 Errors............................................................................................................................ 105 Examples....................................................................................................................... 105 See Also........................................................................................................................ 106 DescribeEndpointSettings........................................................................................................ 108 Request Syntax.............................................................................................................. 108 Request Parameters........................................................................................................ 108 Response Syntax............................................................................................................ 108 Response Elements......................................................................................................... 109 Errors............................................................................................................................ 109 Examples....................................................................................................................... 109 See Also........................................................................................................................ 111 DescribeEndpointTypes............................................................................................................ 112 Request Syntax.............................................................................................................. 112 Request Parameters........................................................................................................ 112 Response Syntax............................................................................................................ 112 Response Elements......................................................................................................... 113 Errors............................................................................................................................ 113 Examples....................................................................................................................... 113 See Also........................................................................................................................ 117 DescribeEventCategories.......................................................................................................... 118 Request Syntax.............................................................................................................. 118 Request Parameters........................................................................................................ 118 Response Syntax............................................................................................................ 118 Response Elements......................................................................................................... 118 Errors............................................................................................................................ 119 See Also........................................................................................................................ 119 DescribeEvents....................................................................................................................... 120 Request Syntax.............................................................................................................. 120 Request Parameters........................................................................................................ 120 Response Syntax............................................................................................................ 121 Response Elements......................................................................................................... 122 Errors............................................................................................................................ 122 See Also........................................................................................................................ 122 DescribeEventSubscriptions...................................................................................................... 123 Request Syntax.............................................................................................................. 123 Request Parameters........................................................................................................ 123 Response Syntax............................................................................................................ 124 Response Elements......................................................................................................... 124 Errors............................................................................................................................ 124 See Also........................................................................................................................ 125 DescribeFleetAdvisorCollectors................................................................................................. 126 Request Syntax.............................................................................................................. 126 Request Parameters........................................................................................................ 126 Response Syntax............................................................................................................ 127 Response Elements......................................................................................................... 127 Errors............................................................................................................................ 127 See Also........................................................................................................................ 128 DescribeFleetAdvisorDatabases................................................................................................. 129 API Version 2016-01-01 vi AWS Database Migration Service API Reference Request Syntax.............................................................................................................. 129 Request Parameters........................................................................................................ 129 Response Syntax............................................................................................................ 130 Response Elements......................................................................................................... 130 Errors............................................................................................................................ 130 See Also........................................................................................................................ 131 DescribeFleetAdvisorLsaAnalysis............................................................................................... 132 Request Syntax.............................................................................................................. 132 Request Parameters........................................................................................................ 132 Response Syntax............................................................................................................ 132 Response Elements......................................................................................................... 132 Errors............................................................................................................................ 133 See Also........................................................................................................................ 133 DescribeFleetAdvisorSchemaObjectSummary............................................................................. 134 Request Syntax.............................................................................................................. 134 Request Parameters........................................................................................................ 134 Response Syntax............................................................................................................ 134 Response Elements......................................................................................................... 135 Errors............................................................................................................................ 135 See Also........................................................................................................................ 135 DescribeFleetAdvisorSchemas................................................................................................... 137 Request Syntax.............................................................................................................. 137 Request Parameters........................................................................................................ 137 Response Syntax............................................................................................................ 138 Response Elements......................................................................................................... 138 Errors............................................................................................................................ 139 See Also........................................................................................................................ 139 DescribeOrderableReplicationInstances...................................................................................... 140 Request Syntax.............................................................................................................. 140 Request Parameters........................................................................................................ 140 Response Syntax............................................................................................................ 140 Response Elements......................................................................................................... 141 Errors............................................................................................................................ 141 Examples....................................................................................................................... 141 See Also........................................................................................................................ 145 DescribePendingMaintenanceActions......................................................................................... 147 Request Syntax.............................................................................................................. 147 Request Parameters........................................................................................................ 147 Response Syntax............................................................................................................ 148 Response Elements......................................................................................................... 148 Errors............................................................................................................................ 148 See Also........................................................................................................................ 148 DescribeRefreshSchemasStatus................................................................................................. 150 Request Syntax.............................................................................................................. 150 Request Parameters........................................................................................................ 150 Response Syntax............................................................................................................ 150 Response Elements......................................................................................................... 150 Errors............................................................................................................................ 150 Examples....................................................................................................................... 151 See Also........................................................................................................................ 152 DescribeReplicationInstances.................................................................................................... 153 Request Syntax.............................................................................................................. 153 Request Parameters........................................................................................................ 153 Response Syntax............................................................................................................ 154 Response Elements......................................................................................................... 155 Errors............................................................................................................................ 155 Examples....................................................................................................................... 155 API Version 2016-01-01 vii AWS Database Migration Service API Reference See Also........................................................................................................................ 157 DescribeReplicationInstanceTaskLogs......................................................................................... 158 Request Syntax.............................................................................................................. 158 Request Parameters........................................................................................................ 158 Response Syntax............................................................................................................ 158 Response Elements......................................................................................................... 159 Errors............................................................................................................................ 159 Examples....................................................................................................................... 159 See Also........................................................................................................................ 160 DescribeReplicationSubnetGroups............................................................................................. 162 Request Syntax.............................................................................................................. 162 Request Parameters........................................................................................................ 162 Response Syntax............................................................................................................ 163 Response Elements......................................................................................................... 163 Errors............................................................................................................................ 163 Examples....................................................................................................................... 163 See Also........................................................................................................................ 165 DescribeReplicationTaskAssessmentResults................................................................................ 166 Request Syntax.............................................................................................................. 166 Request Parameters........................................................................................................ 166 Response Syntax............................................................................................................ 166 Response Elements......................................................................................................... 167 Errors............................................................................................................................ 167 See Also........................................................................................................................ 167 DescribeReplicationTaskAssessmentRuns.................................................................................... 169 Request Syntax.............................................................................................................. 169 Request Parameters........................................................................................................ 169 Response Syntax............................................................................................................ 170 Response Elements......................................................................................................... 170 Errors............................................................................................................................ 170 Examples....................................................................................................................... 171 See Also........................................................................................................................ 172 DescribeReplicationTaskIndividualAssessments........................................................................... 173 Request Syntax.............................................................................................................. 173 Request Parameters........................................................................................................ 173 Response Syntax............................................................................................................ 174 Response Elements......................................................................................................... 174 Errors............................................................................................................................ 174 Examples....................................................................................................................... 174 See Also........................................................................................................................ 176 DescribeReplicationTasks......................................................................................................... 177 Request Syntax.............................................................................................................. 177 Request Parameters........................................................................................................ 177 Response Syntax............................................................................................................ 178 Response Elements......................................................................................................... 178 Errors............................................................................................................................ 179 Examples....................................................................................................................... 179 See Also........................................................................................................................ 180 DescribeSchemas.................................................................................................................... 182 Request Syntax.............................................................................................................. 182 Request Parameters........................................................................................................ 182 Response Syntax............................................................................................................ 182 Response Elements......................................................................................................... 183 Errors............................................................................................................................ 183 Examples....................................................................................................................... 183 See Also........................................................................................................................ 184 DescribeTableStatistics............................................................................................................ 185 API Version 2016-01-01 viii AWS Database Migration Service API Reference Request Syntax.............................................................................................................. 185 Request Parameters........................................................................................................ 185 Response Syntax............................................................................................................ 186 Response Elements......................................................................................................... 186 Errors............................................................................................................................ 187 Examples....................................................................................................................... 187 See Also........................................................................................................................ 189 ImportCertificate.................................................................................................................... 190 Request Syntax.............................................................................................................. 190 Request Parameters........................................................................................................ 190 Response Syntax............................................................................................................ 191 Response Elements......................................................................................................... 191 Errors............................................................................................................................ 191 See Also........................................................................................................................ 191 ListTagsForResource................................................................................................................ 193 Request Syntax.............................................................................................................. 193 Request Parameters........................................................................................................ 193 Response Syntax............................................................................................................ 193 Response Elements......................................................................................................... 193 Errors............................................................................................................................ 194 Examples....................................................................................................................... 194 See Also........................................................................................................................ 195 ModifyEndpoint...................................................................................................................... 196 Request Syntax.............................................................................................................. 196 Request Parameters........................................................................................................ 201 Response Syntax............................................................................................................ 206 Response Elements......................................................................................................... 211 Errors............................................................................................................................ 211 Examples....................................................................................................................... 212 See Also........................................................................................................................ 213 ModifyEventSubscription......................................................................................................... 214 Request Syntax.............................................................................................................. 214 Request Parameters........................................................................................................ 214 Response Syntax............................................................................................................ 215 Response Elements......................................................................................................... 215 Errors............................................................................................................................ 215 See Also........................................................................................................................ 216 ModifyReplicationInstance....................................................................................................... 217 Request Syntax.............................................................................................................. 217 Request Parameters........................................................................................................ 217 Response Syntax............................................................................................................ 219 Response Elements......................................................................................................... 220 Errors............................................................................................................................ 220 Examples....................................................................................................................... 221 See Also........................................................................................................................ 223 ModifyReplicationSubnetGroup................................................................................................ 224 Request Syntax.............................................................................................................. 224 Request Parameters........................................................................................................ 224 Response Syntax............................................................................................................ 224 Response Elements......................................................................................................... 225 Errors............................................................................................................................ 225 Examples....................................................................................................................... 226 See Also........................................................................................................................ 227 ModifyReplicationTask............................................................................................................. 228 Request Syntax.............................................................................................................. 228 Request Parameters........................................................................................................ 228 Response Syntax............................................................................................................ 230 API Version 2016-01-01 ix AWS Database Migration Service API Reference Response Elements......................................................................................................... 230 Errors............................................................................................................................ 231 Examples....................................................................................................................... 231 See Also........................................................................................................................ 232 MoveReplicationTask............................................................................................................... 234 Request Syntax.............................................................................................................. 234 Request Parameters........................................................................................................ 234 Response Syntax............................................................................................................ 234 Response Elements......................................................................................................... 235 Errors............................................................................................................................ 235 Examples....................................................................................................................... 236 See Also........................................................................................................................ 237 RebootReplicationInstance....................................................................................................... 238 Request Syntax.............................................................................................................. 238 Request Parameters........................................................................................................ 238 Response Syntax............................................................................................................ 238 Response Elements......................................................................................................... 239 Errors............................................................................................................................ 240 See Also........................................................................................................................ 240 RefreshSchemas..................................................................................................................... 241 Request Syntax.............................................................................................................. 241 Request Parameters........................................................................................................ 241 Response Syntax............................................................................................................ 241 Response Elements......................................................................................................... 241 Errors............................................................................................................................ 242 See Also........................................................................................................................ 242 ReloadTables.......................................................................................................................... 243 Request Syntax.............................................................................................................. 243 Request Parameters........................................................................................................ 243 Response Syntax............................................................................................................ 244 Response Elements......................................................................................................... 244 Errors............................................................................................................................ 244 See Also........................................................................................................................ 244 RemoveTagsFromResource....................................................................................................... 245 Request Syntax.............................................................................................................. 245 Request Parameters........................................................................................................ 245 Response Elements......................................................................................................... 245 Errors............................................................................................................................ 245 Examples....................................................................................................................... 245 See Also........................................................................................................................ 246 RunFleetAdvisorLsaAnalysis...................................................................................................... 247 Response Syntax............................................................................................................ 247 Response Elements......................................................................................................... 247 Errors............................................................................................................................ 247 See Also........................................................................................................................ 247 StartReplicationTask............................................................................................................... 249 Request Syntax.............................................................................................................. 249 Request Parameters........................................................................................................ 249 Response Syntax............................................................................................................ 250 Response Elements......................................................................................................... 251 Errors............................................................................................................................ 251 Examples....................................................................................................................... 252 See Also........................................................................................................................ 253 StartReplicationTaskAssessment............................................................................................... 254 Request Syntax.............................................................................................................. 254 Request Parameters........................................................................................................ 254 Response Syntax............................................................................................................ 254 API Version 2016-01-01 x
Description: