1{ 2 "version": "2.0", 3 "service": "<fullname>AAWS Sever Migration Service</fullname> <p>This is the <i>AWS Sever Migration Service API Reference</i>. It provides descriptions, syntax, and usage examples for each of the actions and data types for the AWS Sever Migration Service (AWS SMS). The topic for each action shows the Query API request parameters and the XML response. You can also view the XML request elements in the WSDL.</p> <p>Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> <p>To learn more about the Server Migration Service, see the following resources:</p> <ul> <li> <p> <a href=\"https://aws.amazon.com/server-migration-service/\">AWS Sever Migration Service product page</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/server-migration-service/latest/userguide/server-migration.html\">AWS Sever Migration Service User Guide</a> </p> </li> </ul>", 4 "operations": { 5 "CreateApp": "<p>Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.</p>", 6 "CreateReplicationJob": "<p>Creates a replication job. The replication job schedules periodic replication runs to replicate your server to AWS. Each replication run creates an Amazon Machine Image (AMI).</p>", 7 "DeleteApp": "<p>Deletes an existing application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.</p>", 8 "DeleteAppLaunchConfiguration": "<p>Deletes existing launch configuration for an application.</p>", 9 "DeleteAppReplicationConfiguration": "<p>Deletes existing replication configuration for an application.</p>", 10 "DeleteReplicationJob": "<p>Deletes the specified replication job.</p> <p>After you delete a replication job, there are no further replication runs. AWS deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created by the replication runs are not deleted.</p>", 11 "DeleteServerCatalog": "<p>Deletes all servers from your server catalog.</p>", 12 "DisassociateConnector": "<p>Disassociates the specified connector from AWS SMS.</p> <p>After you disassociate a connector, it is no longer available to support replication jobs.</p>", 13 "GenerateChangeSet": "<p>Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.</p>", 14 "GenerateTemplate": "<p>Generates an Amazon CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.</p>", 15 "GetApp": "<p>Retrieve information about an application.</p>", 16 "GetAppLaunchConfiguration": "<p>Retrieves the application launch configuration associated with an application.</p>", 17 "GetAppReplicationConfiguration": "<p>Retrieves an application replication configuration associatd with an application.</p>", 18 "GetConnectors": "<p>Describes the connectors registered with the AWS SMS.</p>", 19 "GetReplicationJobs": "<p>Describes the specified replication job or all of your replication jobs.</p>", 20 "GetReplicationRuns": "<p>Describes the replication runs for the specified replication job.</p>", 21 "GetServers": "<p>Describes the servers in your server catalog.</p> <p>Before you can describe your servers, you must import them using <a>ImportServerCatalog</a>.</p>", 22 "ImportServerCatalog": "<p>Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers that you want to import.</p> <p>This call returns immediately, but might take additional time to retrieve all the servers.</p>", 23 "LaunchApp": "<p>Launches an application stack.</p>", 24 "ListApps": "<p>Returns a list of summaries for all applications.</p>", 25 "PutAppLaunchConfiguration": "<p>Creates a launch configuration for an application.</p>", 26 "PutAppReplicationConfiguration": "<p>Creates or updates a replication configuration for an application.</p>", 27 "StartAppReplication": "<p>Starts replicating an application.</p>", 28 "StartOnDemandReplicationRun": "<p>Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled.</p> <p>There is a limit on the number of on-demand replications runs you can request in a 24-hour period.</p>", 29 "StopAppReplication": "<p>Stops replicating an application.</p>", 30 "TerminateApp": "<p>Terminates the stack for an application.</p>", 31 "UpdateApp": "<p>Updates an application.</p>", 32 "UpdateReplicationJob": "<p>Updates the specified settings for the specified replication job.</p>" 33 }, 34 "shapes": { 35 "AmiId": { 36 "base": null, 37 "refs": { 38 "ReplicationJob$latestAmiId": "<p>The ID of the latest Amazon Machine Image (AMI).</p>", 39 "ReplicationRun$amiId": "<p>The identifier of the Amazon Machine Image (AMI) from the replication run.</p>" 40 } 41 }, 42 "AppDescription": { 43 "base": null, 44 "refs": { 45 "AppSummary$description": "<p>Description of the application.</p>", 46 "CreateAppRequest$description": "<p>Description of the new application</p>", 47 "UpdateAppRequest$description": "<p>New description of the application.</p>" 48 } 49 }, 50 "AppId": { 51 "base": null, 52 "refs": { 53 "AppIds$member": null, 54 "AppSummary$appId": "<p>Unique ID of the application.</p>", 55 "DeleteAppLaunchConfigurationRequest$appId": "<p>ID of the application associated with the launch configuration.</p>", 56 "DeleteAppReplicationConfigurationRequest$appId": "<p>ID of the application associated with the replication configuration.</p>", 57 "DeleteAppRequest$appId": "<p>ID of the application to delete.</p>", 58 "GenerateChangeSetRequest$appId": "<p>ID of the application associated with the change set.</p>", 59 "GenerateTemplateRequest$appId": "<p>ID of the application associated with the Amazon CloudFormation template.</p>", 60 "GetAppLaunchConfigurationRequest$appId": "<p>ID of the application launch configuration.</p>", 61 "GetAppLaunchConfigurationResponse$appId": "<p>ID of the application associated with the launch configuration.</p>", 62 "GetAppReplicationConfigurationRequest$appId": "<p>ID of the application associated with the replication configuration.</p>", 63 "GetAppRequest$appId": "<p>ID of the application whose information is being retrieved.</p>", 64 "LaunchAppRequest$appId": "<p>ID of the application to launch.</p>", 65 "PutAppLaunchConfigurationRequest$appId": "<p>ID of the application associated with the launch configuration.</p>", 66 "PutAppReplicationConfigurationRequest$appId": "<p>ID of the application tassociated with the replication configuration.</p>", 67 "StartAppReplicationRequest$appId": "<p>ID of the application to replicate.</p>", 68 "StopAppReplicationRequest$appId": "<p>ID of the application to stop replicating.</p>", 69 "TerminateAppRequest$appId": "<p>ID of the application to terminate.</p>", 70 "UpdateAppRequest$appId": "<p>ID of the application to update.</p>" 71 } 72 }, 73 "AppIds": { 74 "base": null, 75 "refs": { 76 "ListAppsRequest$appIds": "<p/>" 77 } 78 }, 79 "AppLaunchStatus": { 80 "base": null, 81 "refs": { 82 "AppSummary$launchStatus": "<p>Launch status of the application.</p>" 83 } 84 }, 85 "AppLaunchStatusMessage": { 86 "base": null, 87 "refs": { 88 "AppSummary$launchStatusMessage": "<p>A message related to the launch status of the application.</p>" 89 } 90 }, 91 "AppName": { 92 "base": null, 93 "refs": { 94 "AppSummary$name": "<p>Name of the application.</p>", 95 "CreateAppRequest$name": "<p>Name of the new application.</p>", 96 "UpdateAppRequest$name": "<p>New name of the application.</p>" 97 } 98 }, 99 "AppReplicationStatus": { 100 "base": null, 101 "refs": { 102 "AppSummary$replicationStatus": "<p>Replication status of the application.</p>" 103 } 104 }, 105 "AppReplicationStatusMessage": { 106 "base": null, 107 "refs": { 108 "AppSummary$replicationStatusMessage": "<p>A message related to the replication status of the application.</p>" 109 } 110 }, 111 "AppStatus": { 112 "base": null, 113 "refs": { 114 "AppSummary$status": "<p>Status of the application.</p>" 115 } 116 }, 117 "AppStatusMessage": { 118 "base": null, 119 "refs": { 120 "AppSummary$statusMessage": "<p>A message related to the status of the application</p>" 121 } 122 }, 123 "AppSummary": { 124 "base": "<p>Information about the application.</p>", 125 "refs": { 126 "Apps$member": null, 127 "CreateAppResponse$appSummary": "<p>Summary description of the application.</p>", 128 "GetAppResponse$appSummary": "<p>Information about the application.</p>", 129 "UpdateAppResponse$appSummary": "<p>Summary description of the application.</p>" 130 } 131 }, 132 "Apps": { 133 "base": null, 134 "refs": { 135 "ListAppsResponse$apps": "<p>A list of application summaries.</p>" 136 } 137 }, 138 "AssociatePublicIpAddress": { 139 "base": null, 140 "refs": { 141 "ServerLaunchConfiguration$associatePublicIpAddress": "<p>If true, a publicly accessible IP address is created when launching the server.</p>" 142 } 143 }, 144 "BucketName": { 145 "base": null, 146 "refs": { 147 "S3Location$bucket": "<p>Amazon S3 bucket name.</p>" 148 } 149 }, 150 "ClientToken": { 151 "base": null, 152 "refs": { 153 "CreateAppRequest$clientToken": "<p>A unique, case-sensitive identifier you provide to ensure idempotency of application creation.</p>" 154 } 155 }, 156 "Connector": { 157 "base": "<p>Represents a connector.</p>", 158 "refs": { 159 "ConnectorList$member": null 160 } 161 }, 162 "ConnectorCapability": { 163 "base": null, 164 "refs": { 165 "ConnectorCapabilityList$member": null 166 } 167 }, 168 "ConnectorCapabilityList": { 169 "base": null, 170 "refs": { 171 "Connector$capabilityList": "<p>The capabilities of the connector.</p>" 172 } 173 }, 174 "ConnectorId": { 175 "base": null, 176 "refs": { 177 "Connector$connectorId": "<p>The identifier of the connector.</p>", 178 "DisassociateConnectorRequest$connectorId": "<p>The identifier of the connector.</p>" 179 } 180 }, 181 "ConnectorList": { 182 "base": null, 183 "refs": { 184 "GetConnectorsResponse$connectorList": "<p>Information about the registered connectors.</p>" 185 } 186 }, 187 "ConnectorStatus": { 188 "base": null, 189 "refs": { 190 "Connector$status": "<p>The status of the connector.</p>" 191 } 192 }, 193 "ConnectorVersion": { 194 "base": null, 195 "refs": { 196 "Connector$version": "<p>The connector version.</p>" 197 } 198 }, 199 "CreateAppRequest": { 200 "base": null, 201 "refs": { 202 } 203 }, 204 "CreateAppResponse": { 205 "base": null, 206 "refs": { 207 } 208 }, 209 "CreateReplicationJobRequest": { 210 "base": null, 211 "refs": { 212 } 213 }, 214 "CreateReplicationJobResponse": { 215 "base": null, 216 "refs": { 217 } 218 }, 219 "DeleteAppLaunchConfigurationRequest": { 220 "base": null, 221 "refs": { 222 } 223 }, 224 "DeleteAppLaunchConfigurationResponse": { 225 "base": null, 226 "refs": { 227 } 228 }, 229 "DeleteAppReplicationConfigurationRequest": { 230 "base": null, 231 "refs": { 232 } 233 }, 234 "DeleteAppReplicationConfigurationResponse": { 235 "base": null, 236 "refs": { 237 } 238 }, 239 "DeleteAppRequest": { 240 "base": null, 241 "refs": { 242 } 243 }, 244 "DeleteAppResponse": { 245 "base": null, 246 "refs": { 247 } 248 }, 249 "DeleteReplicationJobRequest": { 250 "base": null, 251 "refs": { 252 } 253 }, 254 "DeleteReplicationJobResponse": { 255 "base": null, 256 "refs": { 257 } 258 }, 259 "DeleteServerCatalogRequest": { 260 "base": null, 261 "refs": { 262 } 263 }, 264 "DeleteServerCatalogResponse": { 265 "base": null, 266 "refs": { 267 } 268 }, 269 "Description": { 270 "base": null, 271 "refs": { 272 "CreateReplicationJobRequest$description": "<p>The description of the replication job.</p>", 273 "ReplicationJob$description": "<p>The description of the replication job.</p>", 274 "ReplicationRun$description": "<p>The description of the replication run.</p>", 275 "StartOnDemandReplicationRunRequest$description": "<p>The description of the replication run.</p>", 276 "UpdateReplicationJobRequest$description": "<p>The description of the replication job.</p>" 277 } 278 }, 279 "DisassociateConnectorRequest": { 280 "base": null, 281 "refs": { 282 } 283 }, 284 "DisassociateConnectorResponse": { 285 "base": null, 286 "refs": { 287 } 288 }, 289 "EC2KeyName": { 290 "base": null, 291 "refs": { 292 "ServerLaunchConfiguration$ec2KeyName": "<p>Name of the EC2 SSH Key to be used for connecting to the launched server.</p>" 293 } 294 }, 295 "Encrypted": { 296 "base": null, 297 "refs": { 298 "CreateReplicationJobRequest$encrypted": "<p>When <i>true</i>, the replication job produces encrypted AMIs. See also <code>KmsKeyId</code> below.</p>", 299 "ReplicationJob$encrypted": "<p>Whether the replication job should produce encrypted AMIs or not. See also <code>KmsKeyId</code> below.</p>", 300 "ReplicationRun$encrypted": "<p>Whether the replication run should produce encrypted AMI or not. See also <code>KmsKeyId</code> below.</p>", 301 "ServerReplicationParameters$encrypted": "<p>When true, the replication job produces encrypted AMIs. See also <code>KmsKeyId</code> below.</p>", 302 "UpdateReplicationJobRequest$encrypted": "<p>When true, the replication job produces encrypted AMIs . See also <code>KmsKeyId</code> below.</p>" 303 } 304 }, 305 "ErrorMessage": { 306 "base": null, 307 "refs": { 308 "InternalError$message": null, 309 "InvalidParameterException$message": null, 310 "MissingRequiredParameterException$message": null, 311 "NoConnectorsAvailableException$message": null, 312 "OperationNotPermittedException$message": null, 313 "ReplicationJobAlreadyExistsException$message": null, 314 "ReplicationJobNotFoundException$message": null, 315 "ReplicationRunLimitExceededException$message": null, 316 "ServerCannotBeReplicatedException$message": null, 317 "UnauthorizedOperationException$message": null 318 } 319 }, 320 "ForceStopAppReplication": { 321 "base": null, 322 "refs": { 323 "DeleteAppRequest$forceStopAppReplication": "<p>While deleting the application, stop all replication jobs corresponding to the servers in the application.</p>" 324 } 325 }, 326 "ForceTerminateApp": { 327 "base": null, 328 "refs": { 329 "DeleteAppRequest$forceTerminateApp": "<p>While deleting the application, terminate the stack corresponding to the application.</p>" 330 } 331 }, 332 "Frequency": { 333 "base": null, 334 "refs": { 335 "CreateReplicationJobRequest$frequency": "<p>The time between consecutive replication runs, in hours.</p>", 336 "ReplicationJob$frequency": "<p>The time between consecutive replication runs, in hours.</p>", 337 "ServerReplicationParameters$frequency": "<p>Frequency of creating replication jobs for the server.</p>", 338 "UpdateReplicationJobRequest$frequency": "<p>The time between consecutive replication runs, in hours.</p>" 339 } 340 }, 341 "GenerateChangeSetRequest": { 342 "base": null, 343 "refs": { 344 } 345 }, 346 "GenerateChangeSetResponse": { 347 "base": null, 348 "refs": { 349 } 350 }, 351 "GenerateTemplateRequest": { 352 "base": null, 353 "refs": { 354 } 355 }, 356 "GenerateTemplateResponse": { 357 "base": null, 358 "refs": { 359 } 360 }, 361 "GetAppLaunchConfigurationRequest": { 362 "base": null, 363 "refs": { 364 } 365 }, 366 "GetAppLaunchConfigurationResponse": { 367 "base": null, 368 "refs": { 369 } 370 }, 371 "GetAppReplicationConfigurationRequest": { 372 "base": null, 373 "refs": { 374 } 375 }, 376 "GetAppReplicationConfigurationResponse": { 377 "base": null, 378 "refs": { 379 } 380 }, 381 "GetAppRequest": { 382 "base": null, 383 "refs": { 384 } 385 }, 386 "GetAppResponse": { 387 "base": null, 388 "refs": { 389 } 390 }, 391 "GetConnectorsRequest": { 392 "base": null, 393 "refs": { 394 } 395 }, 396 "GetConnectorsResponse": { 397 "base": null, 398 "refs": { 399 } 400 }, 401 "GetReplicationJobsRequest": { 402 "base": null, 403 "refs": { 404 } 405 }, 406 "GetReplicationJobsResponse": { 407 "base": null, 408 "refs": { 409 } 410 }, 411 "GetReplicationRunsRequest": { 412 "base": null, 413 "refs": { 414 } 415 }, 416 "GetReplicationRunsResponse": { 417 "base": null, 418 "refs": { 419 } 420 }, 421 "GetServersRequest": { 422 "base": null, 423 "refs": { 424 } 425 }, 426 "GetServersResponse": { 427 "base": null, 428 "refs": { 429 } 430 }, 431 "ImportServerCatalogRequest": { 432 "base": null, 433 "refs": { 434 } 435 }, 436 "ImportServerCatalogResponse": { 437 "base": null, 438 "refs": { 439 } 440 }, 441 "InstanceType": { 442 "base": null, 443 "refs": { 444 "ServerLaunchConfiguration$instanceType": "<p>Instance type to be used for launching the server.</p>" 445 } 446 }, 447 "InternalError": { 448 "base": "<p>An internal error occurred.</p>", 449 "refs": { 450 } 451 }, 452 "InvalidParameterException": { 453 "base": "<p>A specified parameter is not valid.</p>", 454 "refs": { 455 } 456 }, 457 "IpAddress": { 458 "base": null, 459 "refs": { 460 "Connector$ipAddress": "<p>The IP address of the connector.</p>" 461 } 462 }, 463 "KeyName": { 464 "base": null, 465 "refs": { 466 "S3Location$key": "<p>Amazon S3 bucket key.</p>" 467 } 468 }, 469 "KmsKeyId": { 470 "base": null, 471 "refs": { 472 "CreateReplicationJobRequest$kmsKeyId": "<p>KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following: </p> <ul> <li> <p>KMS key ID</p> </li> <li> <p>KMS key alias</p> </li> <li> <p>ARN referring to KMS key ID</p> </li> <li> <p>ARN referring to KMS key alias</p> </li> </ul> <p> If encrypted is <i>true</i> but a KMS key id is not specified, the customer's default KMS key for EBS is used. </p>", 473 "ReplicationJob$kmsKeyId": "<p>KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following: </p> <ul> <li> <p>KMS key ID</p> </li> <li> <p>KMS key alias</p> </li> <li> <p>ARN referring to KMS key ID</p> </li> <li> <p>ARN referring to KMS key alias</p> </li> </ul> <p> If encrypted is <i>true</i> but a KMS key id is not specified, the customer's default KMS key for EBS is used. </p>", 474 "ReplicationRun$kmsKeyId": "<p>KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following: </p> <ul> <li> <p>KMS key ID</p> </li> <li> <p>KMS key alias</p> </li> <li> <p>ARN referring to KMS key ID</p> </li> <li> <p>ARN referring to KMS key alias</p> </li> </ul> <p> If encrypted is <i>true</i> but a KMS key id is not specified, the customer's default KMS key for EBS is used. </p>", 475 "ServerReplicationParameters$kmsKeyId": "<p/> <p>KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following: </p> <ul> <li> <p>KMS key ID</p> </li> <li> <p>KMS key alias</p> </li> <li> <p>ARN referring to KMS key ID</p> </li> <li> <p>ARN referring to KMS key alias</p> </li> </ul> <p> If encrypted is <i>true</i> but a KMS key id is not specified, the customer's default KMS key for EBS is used. </p>", 476 "UpdateReplicationJobRequest$kmsKeyId": "<p/> <p>KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following: </p> <ul> <li> <p>KMS key ID</p> </li> <li> <p>KMS key alias</p> </li> <li> <p>ARN referring to KMS key ID</p> </li> <li> <p>ARN referring to KMS key alias</p> </li> </ul> <p> If encrypted is <i>true</i> but a KMS key id is not specified, the customer's default KMS key for EBS is used. </p>" 477 } 478 }, 479 "LaunchAppRequest": { 480 "base": null, 481 "refs": { 482 } 483 }, 484 "LaunchAppResponse": { 485 "base": null, 486 "refs": { 487 } 488 }, 489 "LaunchDetails": { 490 "base": "<p>Details about the latest launch of an application.</p>", 491 "refs": { 492 "AppSummary$launchDetails": "<p>Details about the latest launch of the application.</p>" 493 } 494 }, 495 "LaunchOrder": { 496 "base": null, 497 "refs": { 498 "ServerGroupLaunchConfiguration$launchOrder": "<p>Launch order of servers in the server group.</p>" 499 } 500 }, 501 "LicenseType": { 502 "base": null, 503 "refs": { 504 "CreateReplicationJobRequest$licenseType": "<p>The license type to be used for the AMI created by a successful replication run.</p>", 505 "ReplicationJob$licenseType": "<p>The license type to be used for the AMI created by a successful replication run.</p>", 506 "ServerReplicationParameters$licenseType": "<p>License type for creating a replication job for the server.</p>", 507 "UpdateReplicationJobRequest$licenseType": "<p>The license type to be used for the AMI created by a successful replication run.</p>" 508 } 509 }, 510 "ListAppsRequest": { 511 "base": null, 512 "refs": { 513 } 514 }, 515 "ListAppsResponse": { 516 "base": null, 517 "refs": { 518 } 519 }, 520 "LogicalId": { 521 "base": null, 522 "refs": { 523 "ServerLaunchConfiguration$logicalId": "<p>Logical ID of the server in the Amazon CloudFormation template.</p>" 524 } 525 }, 526 "MacAddress": { 527 "base": null, 528 "refs": { 529 "Connector$macAddress": "<p>The MAC address of the connector.</p>" 530 } 531 }, 532 "MaxResults": { 533 "base": null, 534 "refs": { 535 "GetConnectorsRequest$maxResults": "<p>The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>", 536 "GetReplicationJobsRequest$maxResults": "<p>The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>", 537 "GetReplicationRunsRequest$maxResults": "<p>The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>", 538 "GetServersRequest$maxResults": "<p>The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>", 539 "ListAppsRequest$maxResults": "<p>The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value. </p>" 540 } 541 }, 542 "MissingRequiredParameterException": { 543 "base": "<p>A required parameter is missing.</p>", 544 "refs": { 545 } 546 }, 547 "NextToken": { 548 "base": null, 549 "refs": { 550 "GetConnectorsRequest$nextToken": "<p>The token for the next set of results.</p>", 551 "GetConnectorsResponse$nextToken": "<p>The token required to retrieve the next set of results. This value is null when there are no more results to return.</p>", 552 "GetReplicationJobsRequest$nextToken": "<p>The token for the next set of results.</p>", 553 "GetReplicationJobsResponse$nextToken": "<p>The token required to retrieve the next set of results. This value is null when there are no more results to return.</p>", 554 "GetReplicationRunsRequest$nextToken": "<p>The token for the next set of results.</p>", 555 "GetReplicationRunsResponse$nextToken": "<p>The token required to retrieve the next set of results. This value is null when there are no more results to return.</p>", 556 "GetServersRequest$nextToken": "<p>The token for the next set of results.</p>", 557 "GetServersResponse$nextToken": "<p>The token required to retrieve the next set of results. This value is null when there are no more results to return.</p>", 558 "ListAppsRequest$nextToken": "<p>The token for the next set of results.</p>", 559 "ListAppsResponse$nextToken": "<p>The token required to retrieve the next set of results. This value is null when there are no more results to return.</p>" 560 } 561 }, 562 "NoConnectorsAvailableException": { 563 "base": "<p>There are no connectors available.</p>", 564 "refs": { 565 } 566 }, 567 "NumberOfRecentAmisToKeep": { 568 "base": null, 569 "refs": { 570 "CreateReplicationJobRequest$numberOfRecentAmisToKeep": "<p>The maximum number of SMS-created AMIs to retain. The oldest will be deleted once the maximum number is reached and a new AMI is created.</p>", 571 "ReplicationJob$numberOfRecentAmisToKeep": "<p>Number of recent AMIs to keep in the customer's account for a replication job. By default the value is set to zero, meaning that all AMIs are kept.</p>", 572 "ServerReplicationParameters$numberOfRecentAmisToKeep": "<p>Number of recent AMIs to keep when creating a replication job for this server.</p>", 573 "UpdateReplicationJobRequest$numberOfRecentAmisToKeep": "<p>The maximum number of SMS-created AMIs to retain. The oldest will be deleted once the maximum number is reached and a new AMI is created.</p>" 574 } 575 }, 576 "OperationNotPermittedException": { 577 "base": "<p>This operation is not allowed.</p>", 578 "refs": { 579 } 580 }, 581 "OutputFormat": { 582 "base": null, 583 "refs": { 584 "GenerateChangeSetRequest$changesetFormat": "<p>Format for the change set.</p>", 585 "GenerateTemplateRequest$templateFormat": "<p>Format for generating the Amazon CloudFormation template.</p>" 586 } 587 }, 588 "PutAppLaunchConfigurationRequest": { 589 "base": null, 590 "refs": { 591 } 592 }, 593 "PutAppLaunchConfigurationResponse": { 594 "base": null, 595 "refs": { 596 } 597 }, 598 "PutAppReplicationConfigurationRequest": { 599 "base": null, 600 "refs": { 601 } 602 }, 603 "PutAppReplicationConfigurationResponse": { 604 "base": null, 605 "refs": { 606 } 607 }, 608 "ReplicationJob": { 609 "base": "<p>Represents a replication job.</p>", 610 "refs": { 611 "GetReplicationRunsResponse$replicationJob": "<p>Information about the replication job.</p>", 612 "ReplicationJobList$member": null 613 } 614 }, 615 "ReplicationJobAlreadyExistsException": { 616 "base": "<p>The specified replication job already exists.</p>", 617 "refs": { 618 } 619 }, 620 "ReplicationJobId": { 621 "base": null, 622 "refs": { 623 "CreateReplicationJobResponse$replicationJobId": "<p>The unique identifier of the replication job.</p>", 624 "DeleteReplicationJobRequest$replicationJobId": "<p>The identifier of the replication job.</p>", 625 "GetReplicationJobsRequest$replicationJobId": "<p>The identifier of the replication job.</p>", 626 "GetReplicationRunsRequest$replicationJobId": "<p>The identifier of the replication job.</p>", 627 "ReplicationJob$replicationJobId": "<p>The identifier of the replication job.</p>", 628 "Server$replicationJobId": "<p>The identifier of the replication job.</p>", 629 "StartOnDemandReplicationRunRequest$replicationJobId": "<p>The identifier of the replication job.</p>", 630 "UpdateReplicationJobRequest$replicationJobId": "<p>The identifier of the replication job.</p>" 631 } 632 }, 633 "ReplicationJobList": { 634 "base": null, 635 "refs": { 636 "GetReplicationJobsResponse$replicationJobList": "<p>Information about the replication jobs.</p>" 637 } 638 }, 639 "ReplicationJobNotFoundException": { 640 "base": "<p>The specified replication job does not exist.</p>", 641 "refs": { 642 } 643 }, 644 "ReplicationJobState": { 645 "base": null, 646 "refs": { 647 "ReplicationJob$state": "<p>The state of the replication job.</p>" 648 } 649 }, 650 "ReplicationJobStatusMessage": { 651 "base": null, 652 "refs": { 653 "ReplicationJob$statusMessage": "<p>The description of the current status of the replication job.</p>" 654 } 655 }, 656 "ReplicationJobTerminated": { 657 "base": null, 658 "refs": { 659 "Server$replicationJobTerminated": "<p>Indicates whether the replication job is deleted or failed.</p>" 660 } 661 }, 662 "ReplicationRun": { 663 "base": "<p>Represents a replication run.</p>", 664 "refs": { 665 "ReplicationRunList$member": null 666 } 667 }, 668 "ReplicationRunId": { 669 "base": null, 670 "refs": { 671 "ReplicationRun$replicationRunId": "<p>The identifier of the replication run.</p>", 672 "StartOnDemandReplicationRunResponse$replicationRunId": "<p>The identifier of the replication run.</p>" 673 } 674 }, 675 "ReplicationRunLimitExceededException": { 676 "base": "<p>You have exceeded the number of on-demand replication runs you can request in a 24-hour period.</p>", 677 "refs": { 678 } 679 }, 680 "ReplicationRunList": { 681 "base": null, 682 "refs": { 683 "GetReplicationRunsResponse$replicationRunList": "<p>Information about the replication runs.</p>", 684 "ReplicationJob$replicationRunList": "<p>Information about the replication runs.</p>" 685 } 686 }, 687 "ReplicationRunStage": { 688 "base": null, 689 "refs": { 690 "ReplicationRunStageDetails$stage": "<p>String describing the current stage of a replication run.</p>" 691 } 692 }, 693 "ReplicationRunStageDetails": { 694 "base": "<p>Details of the current stage of a replication run.</p>", 695 "refs": { 696 "ReplicationRun$stageDetails": "<p>Details of the current stage of the replication run.</p>" 697 } 698 }, 699 "ReplicationRunStageProgress": { 700 "base": null, 701 "refs": { 702 "ReplicationRunStageDetails$stageProgress": "<p>String describing the progress of the current stage of a replication run.</p>" 703 } 704 }, 705 "ReplicationRunState": { 706 "base": null, 707 "refs": { 708 "ReplicationRun$state": "<p>The state of the replication run.</p>" 709 } 710 }, 711 "ReplicationRunStatusMessage": { 712 "base": null, 713 "refs": { 714 "ReplicationRun$statusMessage": "<p>The description of the current status of the replication job.</p>" 715 } 716 }, 717 "ReplicationRunType": { 718 "base": null, 719 "refs": { 720 "ReplicationRun$type": "<p>The type of replication run.</p>" 721 } 722 }, 723 "RoleName": { 724 "base": null, 725 "refs": { 726 "AppSummary$roleName": "<p>Name of the service role in the customer's account used by AWS SMS.</p>", 727 "CreateAppRequest$roleName": "<p>Name of service role in customer's account to be used by AWS SMS.</p>", 728 "CreateReplicationJobRequest$roleName": "<p>The name of the IAM role to be used by the AWS SMS.</p>", 729 "GetAppLaunchConfigurationResponse$roleName": "<p>Name of the service role in the customer's account that Amazon CloudFormation uses to launch the application.</p>", 730 "PutAppLaunchConfigurationRequest$roleName": "<p>Name of service role in the customer's account that Amazon CloudFormation uses to launch the application.</p>", 731 "ReplicationJob$roleName": "<p>The name of the IAM role to be used by the Server Migration Service.</p>", 732 "UpdateAppRequest$roleName": "<p>Name of the service role in the customer's account used by AWS SMS.</p>", 733 "UpdateReplicationJobRequest$roleName": "<p>The name of the IAM role to be used by AWS SMS.</p>" 734 } 735 }, 736 "RunOnce": { 737 "base": null, 738 "refs": { 739 "CreateReplicationJobRequest$runOnce": "<p/>", 740 "ReplicationJob$runOnce": "<p/>", 741 "ServerReplicationParameters$runOnce": "<p/>" 742 } 743 }, 744 "S3Location": { 745 "base": "<p>Location of the Amazon S3 object in the customer's account.</p>", 746 "refs": { 747 "GenerateChangeSetResponse$s3Location": "<p>Location of the Amazon S3 object.</p>", 748 "GenerateTemplateResponse$s3Location": "<p>Location of the Amazon S3 object.</p>", 749 "UserData$s3Location": "<p>Amazon S3 location of the user-data script.</p>" 750 } 751 }, 752 "SecurityGroup": { 753 "base": null, 754 "refs": { 755 "ServerLaunchConfiguration$securityGroup": "<p>Identifier of the security group that applies to the launched server.</p>" 756 } 757 }, 758 "Server": { 759 "base": "<p>Represents a server.</p>", 760 "refs": { 761 "ServerLaunchConfiguration$server": "<p>Identifier of the server the launch configuration is associated with.</p>", 762 "ServerList$member": null, 763 "ServerReplicationConfiguration$server": "<p>Identifier of the server this replication configuration is associated with.</p>" 764 } 765 }, 766 "ServerCannotBeReplicatedException": { 767 "base": "<p>The specified server cannot be replicated.</p>", 768 "refs": { 769 } 770 }, 771 "ServerCatalogStatus": { 772 "base": null, 773 "refs": { 774 "GetServersResponse$serverCatalogStatus": "<p>The status of the server catalog.</p>" 775 } 776 }, 777 "ServerGroup": { 778 "base": "<p>A logical grouping of servers.</p>", 779 "refs": { 780 "ServerGroups$member": null 781 } 782 }, 783 "ServerGroupId": { 784 "base": null, 785 "refs": { 786 "ServerGroup$serverGroupId": "<p>Identifier of a server group.</p>", 787 "ServerGroupLaunchConfiguration$serverGroupId": "<p>Identifier of the server group the launch configuration is associated with.</p>", 788 "ServerGroupReplicationConfiguration$serverGroupId": "<p>Identifier of the server group this replication configuration is associated with.</p>" 789 } 790 }, 791 "ServerGroupLaunchConfiguration": { 792 "base": "<p>Launch configuration for a server group.</p>", 793 "refs": { 794 "ServerGroupLaunchConfigurations$member": null 795 } 796 }, 797 "ServerGroupLaunchConfigurations": { 798 "base": null, 799 "refs": { 800 "GetAppLaunchConfigurationResponse$serverGroupLaunchConfigurations": "<p>List of launch configurations for server groups in this application.</p>", 801 "PutAppLaunchConfigurationRequest$serverGroupLaunchConfigurations": "<p>Launch configurations for server groups in the application.</p>" 802 } 803 }, 804 "ServerGroupName": { 805 "base": null, 806 "refs": { 807 "ServerGroup$name": "<p>Name of a server group.</p>" 808 } 809 }, 810 "ServerGroupReplicationConfiguration": { 811 "base": "<p>Replication configuration for a server group.</p>", 812 "refs": { 813 "ServerGroupReplicationConfigurations$member": null 814 } 815 }, 816 "ServerGroupReplicationConfigurations": { 817 "base": null, 818 "refs": { 819 "GetAppReplicationConfigurationResponse$serverGroupReplicationConfigurations": "<p>Replication configurations associated with server groups in this application.</p>", 820 "PutAppReplicationConfigurationRequest$serverGroupReplicationConfigurations": "<p>Replication configurations for server groups in the application.</p>" 821 } 822 }, 823 "ServerGroups": { 824 "base": null, 825 "refs": { 826 "CreateAppRequest$serverGroups": "<p>List of server groups to include in the application.</p>", 827 "CreateAppResponse$serverGroups": "<p>List of server groups included in the application.</p>", 828 "GetAppResponse$serverGroups": "<p>List of server groups belonging to the application.</p>", 829 "UpdateAppRequest$serverGroups": "<p>List of server groups in the application to update.</p>", 830 "UpdateAppResponse$serverGroups": "<p>List of updated server groups in the application.</p>" 831 } 832 }, 833 "ServerId": { 834 "base": null, 835 "refs": { 836 "CreateReplicationJobRequest$serverId": "<p>The identifier of the server.</p>", 837 "ReplicationJob$serverId": "<p>The identifier of the server.</p>", 838 "Server$serverId": "<p>The identifier of the server.</p>" 839 } 840 }, 841 "ServerLaunchConfiguration": { 842 "base": "<p>Launch configuration for a server.</p>", 843 "refs": { 844 "ServerLaunchConfigurations$member": null 845 } 846 }, 847 "ServerLaunchConfigurations": { 848 "base": null, 849 "refs": { 850 "ServerGroupLaunchConfiguration$serverLaunchConfigurations": "<p>Launch configuration for servers in the server group.</p>" 851 } 852 }, 853 "ServerList": { 854 "base": null, 855 "refs": { 856 "GetServersResponse$serverList": "<p>Information about the servers.</p>", 857 "ServerGroup$serverList": "<p>List of servers belonging to a server group.</p>" 858 } 859 }, 860 "ServerReplicationConfiguration": { 861 "base": "<p>Replication configuration of a server.</p>", 862 "refs": { 863 "ServerReplicationConfigurations$member": null 864 } 865 }, 866 "ServerReplicationConfigurations": { 867 "base": null, 868 "refs": { 869 "ServerGroupReplicationConfiguration$serverReplicationConfigurations": "<p>Replication configuration for servers in the server group.</p>" 870 } 871 }, 872 "ServerReplicationParameters": { 873 "base": "<p>Replication parameters for replicating a server.</p>", 874 "refs": { 875 "ServerReplicationConfiguration$serverReplicationParameters": "<p>Parameters for replicating the server.</p>" 876 } 877 }, 878 "ServerType": { 879 "base": null, 880 "refs": { 881 "ReplicationJob$serverType": "<p>The type of server.</p>", 882 "Server$serverType": "<p>The type of server.</p>" 883 } 884 }, 885 "StackId": { 886 "base": null, 887 "refs": { 888 "LaunchDetails$stackId": "<p>Identifier of the latest stack launched for this application.</p>" 889 } 890 }, 891 "StackName": { 892 "base": null, 893 "refs": { 894 "LaunchDetails$stackName": "<p>Name of the latest stack launched for this application.</p>" 895 } 896 }, 897 "StartAppReplicationRequest": { 898 "base": null, 899 "refs": { 900 } 901 }, 902 "StartAppReplicationResponse": { 903 "base": null, 904 "refs": { 905 } 906 }, 907 "StartOnDemandReplicationRunRequest": { 908 "base": null, 909 "refs": { 910 } 911 }, 912 "StartOnDemandReplicationRunResponse": { 913 "base": null, 914 "refs": { 915 } 916 }, 917 "StopAppReplicationRequest": { 918 "base": null, 919 "refs": { 920 } 921 }, 922 "StopAppReplicationResponse": { 923 "base": null, 924 "refs": { 925 } 926 }, 927 "Subnet": { 928 "base": null, 929 "refs": { 930 "ServerLaunchConfiguration$subnet": "<p>Identifier of the subnet the server should be launched into.</p>" 931 } 932 }, 933 "Tag": { 934 "base": "<p>A label that can be assigned to an application.</p>", 935 "refs": { 936 "Tags$member": null 937 } 938 }, 939 "TagKey": { 940 "base": null, 941 "refs": { 942 "Tag$key": "<p>Tag key.</p>" 943 } 944 }, 945 "TagValue": { 946 "base": null, 947 "refs": { 948 "Tag$value": "<p>Tag value.</p>" 949 } 950 }, 951 "Tags": { 952 "base": null, 953 "refs": { 954 "CreateAppRequest$tags": "<p>List of tags to be associated with the application.</p>", 955 "CreateAppResponse$tags": "<p>List of taags associated with the application.</p>", 956 "GetAppResponse$tags": "<p>List of tags associated with the application.</p>", 957 "UpdateAppRequest$tags": "<p>List of tags to associate with the application.</p>", 958 "UpdateAppResponse$tags": "<p>List of tags associated with the application.</p>" 959 } 960 }, 961 "TemporarilyUnavailableException": { 962 "base": "<p>The service is temporarily unavailable.</p>", 963 "refs": { 964 } 965 }, 966 "TerminateAppRequest": { 967 "base": null, 968 "refs": { 969 } 970 }, 971 "TerminateAppResponse": { 972 "base": null, 973 "refs": { 974 } 975 }, 976 "Timestamp": { 977 "base": null, 978 "refs": { 979 "AppSummary$latestReplicationTime": "<p>Timestamp of the application's most recent successful replication.</p>", 980 "AppSummary$creationTime": "<p>Time of creation of this application.</p>", 981 "AppSummary$lastModified": "<p>Timestamp of the application's creation.</p>", 982 "Connector$associatedOn": "<p>The time the connector was associated.</p>", 983 "CreateReplicationJobRequest$seedReplicationTime": "<p>The seed replication time.</p>", 984 "GetServersResponse$lastModifiedOn": "<p>The time when the server was last modified.</p>", 985 "LaunchDetails$latestLaunchTime": "<p>Latest time this application was launched successfully.</p>", 986 "ReplicationJob$seedReplicationTime": "<p>The seed replication time.</p>", 987 "ReplicationJob$nextReplicationRunStartTime": "<p>The start time of the next replication run.</p>", 988 "ReplicationRun$scheduledStartTime": "<p>The start time of the next replication run.</p>", 989 "ReplicationRun$completedTime": "<p>The completion time of the last replication run.</p>", 990 "ServerReplicationParameters$seedTime": "<p>Seed time for creating a replication job for the server.</p>", 991 "UpdateReplicationJobRequest$nextReplicationRunStartTime": "<p>The start time of the next replication run.</p>" 992 } 993 }, 994 "TotalServerGroups": { 995 "base": null, 996 "refs": { 997 "AppSummary$totalServerGroups": "<p>Number of server groups present in the application.</p>" 998 } 999 }, 1000 "TotalServers": { 1001 "base": null, 1002 "refs": { 1003 "AppSummary$totalServers": "<p>Number of servers present in the application.</p>" 1004 } 1005 }, 1006 "UnauthorizedOperationException": { 1007 "base": "<p>You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.</p>", 1008 "refs": { 1009 } 1010 }, 1011 "UpdateAppRequest": { 1012 "base": null, 1013 "refs": { 1014 } 1015 }, 1016 "UpdateAppResponse": { 1017 "base": null, 1018 "refs": { 1019 } 1020 }, 1021 "UpdateReplicationJobRequest": { 1022 "base": null, 1023 "refs": { 1024 } 1025 }, 1026 "UpdateReplicationJobResponse": { 1027 "base": null, 1028 "refs": { 1029 } 1030 }, 1031 "UserData": { 1032 "base": "<p>A script that runs on first launch of an Amazon EC2 instance. Used for configuring the server during launch.</p>", 1033 "refs": { 1034 "ServerLaunchConfiguration$userData": "<p>Location of the user-data script to be executed when launching the server.</p>" 1035 } 1036 }, 1037 "VPC": { 1038 "base": null, 1039 "refs": { 1040 "ServerLaunchConfiguration$vpc": "<p>Identifier of the VPC the server should be launched into.</p>" 1041 } 1042 }, 1043 "VmId": { 1044 "base": null, 1045 "refs": { 1046 "VmServerAddress$vmId": "<p>The identifier of the VM.</p>" 1047 } 1048 }, 1049 "VmManagerId": { 1050 "base": null, 1051 "refs": { 1052 "Connector$vmManagerId": "<p>The identifier of the VM manager.</p>", 1053 "VmServerAddress$vmManagerId": "<p>The identifier of the VM manager.</p>" 1054 } 1055 }, 1056 "VmManagerName": { 1057 "base": null, 1058 "refs": { 1059 "Connector$vmManagerName": "<p>The name of the VM manager.</p>", 1060 "VmServer$vmManagerName": "<p>The name of the VM manager.</p>" 1061 } 1062 }, 1063 "VmManagerType": { 1064 "base": null, 1065 "refs": { 1066 "Connector$vmManagerType": "<p>The VM management product.</p>", 1067 "VmServer$vmManagerType": "<p>The type of VM management product.</p>" 1068 } 1069 }, 1070 "VmName": { 1071 "base": null, 1072 "refs": { 1073 "VmServer$vmName": "<p>The name of the VM.</p>" 1074 } 1075 }, 1076 "VmPath": { 1077 "base": null, 1078 "refs": { 1079 "VmServer$vmPath": "<p>The VM folder path in the vCenter Server virtual machine inventory tree.</p>" 1080 } 1081 }, 1082 "VmServer": { 1083 "base": "<p>Represents a VM server.</p>", 1084 "refs": { 1085 "ReplicationJob$vmServer": "<p>Information about the VM server.</p>", 1086 "Server$vmServer": "<p>Information about the VM server.</p>" 1087 } 1088 }, 1089 "VmServerAddress": { 1090 "base": "<p>Represents a VM server location.</p>", 1091 "refs": { 1092 "VmServer$vmServerAddress": "<p>Information about the VM server location.</p>", 1093 "VmServerAddressList$member": null 1094 } 1095 }, 1096 "VmServerAddressList": { 1097 "base": null, 1098 "refs": { 1099 "GetServersRequest$vmServerAddressList": "<p>List of <code>VmServerAddress</code> objects</p>" 1100 } 1101 } 1102 } 1103} 1104