aws-sdk-sms 1.6.0 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 7ecfe1a47a80fc8ffdf8435da2d82e3c6bd18825
4
- data.tar.gz: 337bc692120674683c55f675cbb44d3f59e8643c
3
+ metadata.gz: 57d722bcb5a686c1cafad40657e8e4ac6373aea2
4
+ data.tar.gz: 0ac16f262b973cc4b1b1e6e753ff6aaf25574b1c
5
5
  SHA512:
6
- metadata.gz: 8a0f5683b1b5b7bd325022140bf815ead02c47cb63a935b9890e24b2b487502707e95a321f3ebe1145fd44cad0ed05ade8443726484c274eba9fe5c3a07a325d
7
- data.tar.gz: b49dc8ce76c45b8c30ba10f0252b5ec4bd7743271cc3f6784265f5a3619aa7da24fc76e4added59e5ffbee0c5b373d15cb66621c027fad9fa858db0ade861933
6
+ metadata.gz: e2e229f432995e79e56954ea0810fe6f74e04d38e80cc1af735177f44b54160fb23ad04d6bda20082d53cd1e06c09a3ac894747282397a241f13ea192ccac430
7
+ data.tar.gz: c62ecc133c8fc01cc2d5065399cc1139aa5182ce097357afc4a39a8ee0a05f4a07d54b406244e848b03cd2969a58e117f0fdf3d10185cdf92fe0b05994bde588
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-sms/customizations'
42
42
  # @service
43
43
  module Aws::SMS
44
44
 
45
- GEM_VERSION = '1.6.0'
45
+ GEM_VERSION = '1.7.0'
46
46
 
47
47
  end
@@ -215,31 +215,167 @@ module Aws::SMS
215
215
 
216
216
  # @!group API Operations
217
217
 
218
- # The CreateReplicationJob API is used to create a ReplicationJob to
219
- # replicate a server on AWS. Call this API to first create a
220
- # ReplicationJob, which will then schedule periodic ReplicationRuns to
221
- # replicate your server to AWS. Each ReplicationRun will result in the
222
- # creation of an AWS AMI.
218
+ # Creates an application. An application consists of one or more server
219
+ # groups. Each server group contain one or more servers.
220
+ #
221
+ # @option params [String] :name
222
+ # Name of the new application.
223
+ #
224
+ # @option params [String] :description
225
+ # Description of the new application
226
+ #
227
+ # @option params [String] :role_name
228
+ # Name of service role in customer's account to be used by AWS SMS.
229
+ #
230
+ # @option params [String] :client_token
231
+ # A unique, case-sensitive identifier you provide to ensure idempotency
232
+ # of application creation.
233
+ #
234
+ # @option params [Array<Types::ServerGroup>] :server_groups
235
+ # List of server groups to include in the application.
236
+ #
237
+ # @option params [Array<Types::Tag>] :tags
238
+ # List of tags to be associated with the application.
239
+ #
240
+ # @return [Types::CreateAppResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
241
+ #
242
+ # * {Types::CreateAppResponse#app_summary #app_summary} => Types::AppSummary
243
+ # * {Types::CreateAppResponse#server_groups #server_groups} => Array&lt;Types::ServerGroup&gt;
244
+ # * {Types::CreateAppResponse#tags #tags} => Array&lt;Types::Tag&gt;
245
+ #
246
+ # @example Request syntax with placeholder values
247
+ #
248
+ # resp = client.create_app({
249
+ # name: "AppName",
250
+ # description: "AppDescription",
251
+ # role_name: "RoleName",
252
+ # client_token: "ClientToken",
253
+ # server_groups: [
254
+ # {
255
+ # server_group_id: "ServerGroupId",
256
+ # name: "ServerGroupName",
257
+ # server_list: [
258
+ # {
259
+ # server_id: "ServerId",
260
+ # server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
261
+ # vm_server: {
262
+ # vm_server_address: {
263
+ # vm_manager_id: "VmManagerId",
264
+ # vm_id: "VmId",
265
+ # },
266
+ # vm_name: "VmName",
267
+ # vm_manager_name: "VmManagerName",
268
+ # vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
269
+ # vm_path: "VmPath",
270
+ # },
271
+ # replication_job_id: "ReplicationJobId",
272
+ # replication_job_terminated: false,
273
+ # },
274
+ # ],
275
+ # },
276
+ # ],
277
+ # tags: [
278
+ # {
279
+ # key: "TagKey",
280
+ # value: "TagValue",
281
+ # },
282
+ # ],
283
+ # })
284
+ #
285
+ # @example Response structure
286
+ #
287
+ # resp.app_summary.app_id #=> String
288
+ # resp.app_summary.name #=> String
289
+ # resp.app_summary.description #=> String
290
+ # resp.app_summary.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
291
+ # resp.app_summary.status_message #=> String
292
+ # resp.app_summary.replication_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_REPLICATION", "VALIDATION_IN_PROGRESS", "REPLICATION_PENDING", "REPLICATION_IN_PROGRESS", "REPLICATED", "DELTA_REPLICATION_IN_PROGRESS", "DELTA_REPLICATED", "DELTA_REPLICATION_FAILED", "REPLICATION_FAILED", "REPLICATION_STOPPING", "REPLICATION_STOP_FAILED", "REPLICATION_STOPPED"
293
+ # resp.app_summary.replication_status_message #=> String
294
+ # resp.app_summary.latest_replication_time #=> Time
295
+ # resp.app_summary.launch_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_LAUNCH", "VALIDATION_IN_PROGRESS", "LAUNCH_PENDING", "LAUNCH_IN_PROGRESS", "LAUNCHED", "DELTA_LAUNCH_IN_PROGRESS", "DELTA_LAUNCH_FAILED", "LAUNCH_FAILED", "TERMINATE_IN_PROGRESS", "TERMINATE_FAILED", "TERMINATED"
296
+ # resp.app_summary.launch_status_message #=> String
297
+ # resp.app_summary.launch_details.latest_launch_time #=> Time
298
+ # resp.app_summary.launch_details.stack_name #=> String
299
+ # resp.app_summary.launch_details.stack_id #=> String
300
+ # resp.app_summary.creation_time #=> Time
301
+ # resp.app_summary.last_modified #=> Time
302
+ # resp.app_summary.role_name #=> String
303
+ # resp.app_summary.total_server_groups #=> Integer
304
+ # resp.app_summary.total_servers #=> Integer
305
+ # resp.server_groups #=> Array
306
+ # resp.server_groups[0].server_group_id #=> String
307
+ # resp.server_groups[0].name #=> String
308
+ # resp.server_groups[0].server_list #=> Array
309
+ # resp.server_groups[0].server_list[0].server_id #=> String
310
+ # resp.server_groups[0].server_list[0].server_type #=> String, one of "VIRTUAL_MACHINE"
311
+ # resp.server_groups[0].server_list[0].vm_server.vm_server_address.vm_manager_id #=> String
312
+ # resp.server_groups[0].server_list[0].vm_server.vm_server_address.vm_id #=> String
313
+ # resp.server_groups[0].server_list[0].vm_server.vm_name #=> String
314
+ # resp.server_groups[0].server_list[0].vm_server.vm_manager_name #=> String
315
+ # resp.server_groups[0].server_list[0].vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
316
+ # resp.server_groups[0].server_list[0].vm_server.vm_path #=> String
317
+ # resp.server_groups[0].server_list[0].replication_job_id #=> String
318
+ # resp.server_groups[0].server_list[0].replication_job_terminated #=> Boolean
319
+ # resp.tags #=> Array
320
+ # resp.tags[0].key #=> String
321
+ # resp.tags[0].value #=> String
322
+ #
323
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/CreateApp AWS API Documentation
324
+ #
325
+ # @overload create_app(params = {})
326
+ # @param [Hash] params ({})
327
+ def create_app(params = {}, options = {})
328
+ req = build_request(:create_app, params)
329
+ req.send_request(options)
330
+ end
331
+
332
+ # Creates a replication job. The replication job schedules periodic
333
+ # replication runs to replicate your server to AWS. Each replication run
334
+ # creates an Amazon Machine Image (AMI).
223
335
  #
224
336
  # @option params [required, String] :server_id
225
- # Unique Identifier for a server
337
+ # The identifier of the server.
226
338
  #
227
339
  # @option params [required, Time,DateTime,Date,Integer,String] :seed_replication_time
228
- # Timestamp of an operation
340
+ # The seed replication time.
341
+ #
342
+ # @option params [Integer] :frequency
343
+ # The time between consecutive replication runs, in hours.
229
344
  #
230
- # @option params [required, Integer] :frequency
231
- # Interval between Replication Runs. This value is specified in hours,
232
- # and represents the time between consecutive Replication Runs.
345
+ # @option params [Boolean] :run_once
233
346
  #
234
347
  # @option params [String] :license_type
235
- # The license type to be used for the Amazon Machine Image (AMI) created
236
- # after a successful ReplicationRun.
348
+ # The license type to be used for the AMI created by a successful
349
+ # replication run.
237
350
  #
238
351
  # @option params [String] :role_name
239
- # Name of service role in customer's account to be used by SMS service.
352
+ # The name of the IAM role to be used by the AWS SMS.
240
353
  #
241
354
  # @option params [String] :description
242
- # The description for a Replication Job/Run.
355
+ # The description of the replication job.
356
+ #
357
+ # @option params [Integer] :number_of_recent_amis_to_keep
358
+ # The maximum number of SMS-created AMIs to retain. The oldest will be
359
+ # deleted once the maximum number is reached and a new AMI is created.
360
+ #
361
+ # @option params [Boolean] :encrypted
362
+ # When *true*, the replication job produces encrypted AMIs. See also
363
+ # `KmsKeyId` below.
364
+ #
365
+ # @option params [String] :kms_key_id
366
+ # KMS key ID for replication jobs that produce encrypted AMIs. Can be
367
+ # any of the following:
368
+ #
369
+ # * KMS key ID
370
+ #
371
+ # * KMS key alias
372
+ #
373
+ # * ARN referring to KMS key ID
374
+ #
375
+ # * ARN referring to KMS key alias
376
+ #
377
+ # If encrypted is *true* but a KMS key id is not specified, the
378
+ # customer's default KMS key for EBS is used.
243
379
  #
244
380
  # @return [Types::CreateReplicationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
245
381
  #
@@ -250,10 +386,14 @@ module Aws::SMS
250
386
  # resp = client.create_replication_job({
251
387
  # server_id: "ServerId", # required
252
388
  # seed_replication_time: Time.now, # required
253
- # frequency: 1, # required
389
+ # frequency: 1,
390
+ # run_once: false,
254
391
  # license_type: "AWS", # accepts AWS, BYOL
255
392
  # role_name: "RoleName",
256
393
  # description: "Description",
394
+ # number_of_recent_amis_to_keep: 1,
395
+ # encrypted: false,
396
+ # kms_key_id: "KmsKeyId",
257
397
  # })
258
398
  #
259
399
  # @example Response structure
@@ -269,13 +409,93 @@ module Aws::SMS
269
409
  req.send_request(options)
270
410
  end
271
411
 
272
- # The DeleteReplicationJob API is used to delete a ReplicationJob,
273
- # resulting in no further ReplicationRuns. This will delete the contents
274
- # of the S3 bucket used to store SMS artifacts, but will not delete any
275
- # AMIs created by the SMS service.
412
+ # Deletes an existing application. Optionally deletes the launched stack
413
+ # associated with the application and all AWS SMS replication jobs for
414
+ # servers in the application.
415
+ #
416
+ # @option params [String] :app_id
417
+ # ID of the application to delete.
418
+ #
419
+ # @option params [Boolean] :force_stop_app_replication
420
+ # While deleting the application, stop all replication jobs
421
+ # corresponding to the servers in the application.
422
+ #
423
+ # @option params [Boolean] :force_terminate_app
424
+ # While deleting the application, terminate the stack corresponding to
425
+ # the application.
426
+ #
427
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
428
+ #
429
+ # @example Request syntax with placeholder values
430
+ #
431
+ # resp = client.delete_app({
432
+ # app_id: "AppId",
433
+ # force_stop_app_replication: false,
434
+ # force_terminate_app: false,
435
+ # })
436
+ #
437
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteApp AWS API Documentation
438
+ #
439
+ # @overload delete_app(params = {})
440
+ # @param [Hash] params ({})
441
+ def delete_app(params = {}, options = {})
442
+ req = build_request(:delete_app, params)
443
+ req.send_request(options)
444
+ end
445
+
446
+ # Deletes existing launch configuration for an application.
447
+ #
448
+ # @option params [String] :app_id
449
+ # ID of the application associated with the launch configuration.
450
+ #
451
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
452
+ #
453
+ # @example Request syntax with placeholder values
454
+ #
455
+ # resp = client.delete_app_launch_configuration({
456
+ # app_id: "AppId",
457
+ # })
458
+ #
459
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteAppLaunchConfiguration AWS API Documentation
460
+ #
461
+ # @overload delete_app_launch_configuration(params = {})
462
+ # @param [Hash] params ({})
463
+ def delete_app_launch_configuration(params = {}, options = {})
464
+ req = build_request(:delete_app_launch_configuration, params)
465
+ req.send_request(options)
466
+ end
467
+
468
+ # Deletes existing replication configuration for an application.
469
+ #
470
+ # @option params [String] :app_id
471
+ # ID of the application associated with the replication configuration.
472
+ #
473
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
474
+ #
475
+ # @example Request syntax with placeholder values
476
+ #
477
+ # resp = client.delete_app_replication_configuration({
478
+ # app_id: "AppId",
479
+ # })
480
+ #
481
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/DeleteAppReplicationConfiguration AWS API Documentation
482
+ #
483
+ # @overload delete_app_replication_configuration(params = {})
484
+ # @param [Hash] params ({})
485
+ def delete_app_replication_configuration(params = {}, options = {})
486
+ req = build_request(:delete_app_replication_configuration, params)
487
+ req.send_request(options)
488
+ end
489
+
490
+ # Deletes the specified replication job.
491
+ #
492
+ # After you delete a replication job, there are no further replication
493
+ # runs. AWS deletes the contents of the Amazon S3 bucket used to store
494
+ # AWS SMS artifacts. The AMIs created by the replication runs are not
495
+ # deleted.
276
496
  #
277
497
  # @option params [required, String] :replication_job_id
278
- # The unique identifier for a Replication Job.
498
+ # The identifier of the replication job.
279
499
  #
280
500
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
281
501
  #
@@ -294,9 +514,7 @@ module Aws::SMS
294
514
  req.send_request(options)
295
515
  end
296
516
 
297
- # The DeleteServerCatalog API clears all servers from your server
298
- # catalog. This means that these servers will no longer be accessible to
299
- # the Server Migration Service.
517
+ # Deletes all servers from your server catalog.
300
518
  #
301
519
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
302
520
  #
@@ -309,12 +527,13 @@ module Aws::SMS
309
527
  req.send_request(options)
310
528
  end
311
529
 
312
- # The DisassociateConnector API will disassociate a connector from the
313
- # Server Migration Service, rendering it unavailable to support
314
- # replication jobs.
530
+ # Disassociates the specified connector from AWS SMS.
531
+ #
532
+ # After you disassociate a connector, it is no longer available to
533
+ # support replication jobs.
315
534
  #
316
535
  # @option params [required, String] :connector_id
317
- # Unique Identifier for Connector
536
+ # The identifier of the connector.
318
537
  #
319
538
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
320
539
  #
@@ -333,15 +552,252 @@ module Aws::SMS
333
552
  req.send_request(options)
334
553
  end
335
554
 
336
- # The GetConnectors API returns a list of connectors that are registered
337
- # with the Server Migration Service.
555
+ # Generates a target change set for a currently launched stack and
556
+ # writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
557
+ #
558
+ # @option params [String] :app_id
559
+ # ID of the application associated with the change set.
560
+ #
561
+ # @option params [String] :changeset_format
562
+ # Format for the change set.
563
+ #
564
+ # @return [Types::GenerateChangeSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
565
+ #
566
+ # * {Types::GenerateChangeSetResponse#s3_location #s3_location} => Types::S3Location
567
+ #
568
+ # @example Request syntax with placeholder values
569
+ #
570
+ # resp = client.generate_change_set({
571
+ # app_id: "AppId",
572
+ # changeset_format: "JSON", # accepts JSON, YAML
573
+ # })
574
+ #
575
+ # @example Response structure
576
+ #
577
+ # resp.s3_location.bucket #=> String
578
+ # resp.s3_location.key #=> String
579
+ #
580
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GenerateChangeSet AWS API Documentation
581
+ #
582
+ # @overload generate_change_set(params = {})
583
+ # @param [Hash] params ({})
584
+ def generate_change_set(params = {}, options = {})
585
+ req = build_request(:generate_change_set, params)
586
+ req.send_request(options)
587
+ end
588
+
589
+ # Generates an Amazon CloudFormation template based on the current
590
+ # launch configuration and writes it to an Amazon S3 object in the
591
+ # customer’s Amazon S3 bucket.
592
+ #
593
+ # @option params [String] :app_id
594
+ # ID of the application associated with the Amazon CloudFormation
595
+ # template.
596
+ #
597
+ # @option params [String] :template_format
598
+ # Format for generating the Amazon CloudFormation template.
599
+ #
600
+ # @return [Types::GenerateTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
601
+ #
602
+ # * {Types::GenerateTemplateResponse#s3_location #s3_location} => Types::S3Location
603
+ #
604
+ # @example Request syntax with placeholder values
605
+ #
606
+ # resp = client.generate_template({
607
+ # app_id: "AppId",
608
+ # template_format: "JSON", # accepts JSON, YAML
609
+ # })
610
+ #
611
+ # @example Response structure
612
+ #
613
+ # resp.s3_location.bucket #=> String
614
+ # resp.s3_location.key #=> String
615
+ #
616
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GenerateTemplate AWS API Documentation
617
+ #
618
+ # @overload generate_template(params = {})
619
+ # @param [Hash] params ({})
620
+ def generate_template(params = {}, options = {})
621
+ req = build_request(:generate_template, params)
622
+ req.send_request(options)
623
+ end
624
+
625
+ # Retrieve information about an application.
626
+ #
627
+ # @option params [String] :app_id
628
+ # ID of the application whose information is being retrieved.
629
+ #
630
+ # @return [Types::GetAppResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
631
+ #
632
+ # * {Types::GetAppResponse#app_summary #app_summary} => Types::AppSummary
633
+ # * {Types::GetAppResponse#server_groups #server_groups} => Array&lt;Types::ServerGroup&gt;
634
+ # * {Types::GetAppResponse#tags #tags} => Array&lt;Types::Tag&gt;
635
+ #
636
+ # @example Request syntax with placeholder values
637
+ #
638
+ # resp = client.get_app({
639
+ # app_id: "AppId",
640
+ # })
641
+ #
642
+ # @example Response structure
643
+ #
644
+ # resp.app_summary.app_id #=> String
645
+ # resp.app_summary.name #=> String
646
+ # resp.app_summary.description #=> String
647
+ # resp.app_summary.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
648
+ # resp.app_summary.status_message #=> String
649
+ # resp.app_summary.replication_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_REPLICATION", "VALIDATION_IN_PROGRESS", "REPLICATION_PENDING", "REPLICATION_IN_PROGRESS", "REPLICATED", "DELTA_REPLICATION_IN_PROGRESS", "DELTA_REPLICATED", "DELTA_REPLICATION_FAILED", "REPLICATION_FAILED", "REPLICATION_STOPPING", "REPLICATION_STOP_FAILED", "REPLICATION_STOPPED"
650
+ # resp.app_summary.replication_status_message #=> String
651
+ # resp.app_summary.latest_replication_time #=> Time
652
+ # resp.app_summary.launch_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_LAUNCH", "VALIDATION_IN_PROGRESS", "LAUNCH_PENDING", "LAUNCH_IN_PROGRESS", "LAUNCHED", "DELTA_LAUNCH_IN_PROGRESS", "DELTA_LAUNCH_FAILED", "LAUNCH_FAILED", "TERMINATE_IN_PROGRESS", "TERMINATE_FAILED", "TERMINATED"
653
+ # resp.app_summary.launch_status_message #=> String
654
+ # resp.app_summary.launch_details.latest_launch_time #=> Time
655
+ # resp.app_summary.launch_details.stack_name #=> String
656
+ # resp.app_summary.launch_details.stack_id #=> String
657
+ # resp.app_summary.creation_time #=> Time
658
+ # resp.app_summary.last_modified #=> Time
659
+ # resp.app_summary.role_name #=> String
660
+ # resp.app_summary.total_server_groups #=> Integer
661
+ # resp.app_summary.total_servers #=> Integer
662
+ # resp.server_groups #=> Array
663
+ # resp.server_groups[0].server_group_id #=> String
664
+ # resp.server_groups[0].name #=> String
665
+ # resp.server_groups[0].server_list #=> Array
666
+ # resp.server_groups[0].server_list[0].server_id #=> String
667
+ # resp.server_groups[0].server_list[0].server_type #=> String, one of "VIRTUAL_MACHINE"
668
+ # resp.server_groups[0].server_list[0].vm_server.vm_server_address.vm_manager_id #=> String
669
+ # resp.server_groups[0].server_list[0].vm_server.vm_server_address.vm_id #=> String
670
+ # resp.server_groups[0].server_list[0].vm_server.vm_name #=> String
671
+ # resp.server_groups[0].server_list[0].vm_server.vm_manager_name #=> String
672
+ # resp.server_groups[0].server_list[0].vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
673
+ # resp.server_groups[0].server_list[0].vm_server.vm_path #=> String
674
+ # resp.server_groups[0].server_list[0].replication_job_id #=> String
675
+ # resp.server_groups[0].server_list[0].replication_job_terminated #=> Boolean
676
+ # resp.tags #=> Array
677
+ # resp.tags[0].key #=> String
678
+ # resp.tags[0].value #=> String
679
+ #
680
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetApp AWS API Documentation
681
+ #
682
+ # @overload get_app(params = {})
683
+ # @param [Hash] params ({})
684
+ def get_app(params = {}, options = {})
685
+ req = build_request(:get_app, params)
686
+ req.send_request(options)
687
+ end
688
+
689
+ # Retrieves the application launch configuration associated with an
690
+ # application.
691
+ #
692
+ # @option params [String] :app_id
693
+ # ID of the application launch configuration.
694
+ #
695
+ # @return [Types::GetAppLaunchConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
696
+ #
697
+ # * {Types::GetAppLaunchConfigurationResponse#app_id #app_id} => String
698
+ # * {Types::GetAppLaunchConfigurationResponse#role_name #role_name} => String
699
+ # * {Types::GetAppLaunchConfigurationResponse#server_group_launch_configurations #server_group_launch_configurations} => Array&lt;Types::ServerGroupLaunchConfiguration&gt;
700
+ #
701
+ # @example Request syntax with placeholder values
702
+ #
703
+ # resp = client.get_app_launch_configuration({
704
+ # app_id: "AppId",
705
+ # })
706
+ #
707
+ # @example Response structure
708
+ #
709
+ # resp.app_id #=> String
710
+ # resp.role_name #=> String
711
+ # resp.server_group_launch_configurations #=> Array
712
+ # resp.server_group_launch_configurations[0].server_group_id #=> String
713
+ # resp.server_group_launch_configurations[0].launch_order #=> Integer
714
+ # resp.server_group_launch_configurations[0].server_launch_configurations #=> Array
715
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].server.server_id #=> String
716
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].server.server_type #=> String, one of "VIRTUAL_MACHINE"
717
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].server.vm_server.vm_server_address.vm_manager_id #=> String
718
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].server.vm_server.vm_server_address.vm_id #=> String
719
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].server.vm_server.vm_name #=> String
720
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].server.vm_server.vm_manager_name #=> String
721
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].server.vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
722
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].server.vm_server.vm_path #=> String
723
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].server.replication_job_id #=> String
724
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].server.replication_job_terminated #=> Boolean
725
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].logical_id #=> String
726
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].vpc #=> String
727
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].subnet #=> String
728
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].security_group #=> String
729
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].ec2_key_name #=> String
730
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].user_data.s3_location.bucket #=> String
731
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].user_data.s3_location.key #=> String
732
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].instance_type #=> String
733
+ # resp.server_group_launch_configurations[0].server_launch_configurations[0].associate_public_ip_address #=> Boolean
734
+ #
735
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetAppLaunchConfiguration AWS API Documentation
736
+ #
737
+ # @overload get_app_launch_configuration(params = {})
738
+ # @param [Hash] params ({})
739
+ def get_app_launch_configuration(params = {}, options = {})
740
+ req = build_request(:get_app_launch_configuration, params)
741
+ req.send_request(options)
742
+ end
743
+
744
+ # Retrieves an application replication configuration associatd with an
745
+ # application.
746
+ #
747
+ # @option params [String] :app_id
748
+ # ID of the application associated with the replication configuration.
749
+ #
750
+ # @return [Types::GetAppReplicationConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
751
+ #
752
+ # * {Types::GetAppReplicationConfigurationResponse#server_group_replication_configurations #server_group_replication_configurations} => Array&lt;Types::ServerGroupReplicationConfiguration&gt;
753
+ #
754
+ # @example Request syntax with placeholder values
755
+ #
756
+ # resp = client.get_app_replication_configuration({
757
+ # app_id: "AppId",
758
+ # })
759
+ #
760
+ # @example Response structure
761
+ #
762
+ # resp.server_group_replication_configurations #=> Array
763
+ # resp.server_group_replication_configurations[0].server_group_id #=> String
764
+ # resp.server_group_replication_configurations[0].server_replication_configurations #=> Array
765
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server.server_id #=> String
766
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server.server_type #=> String, one of "VIRTUAL_MACHINE"
767
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server.vm_server.vm_server_address.vm_manager_id #=> String
768
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server.vm_server.vm_server_address.vm_id #=> String
769
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server.vm_server.vm_name #=> String
770
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server.vm_server.vm_manager_name #=> String
771
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server.vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
772
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server.vm_server.vm_path #=> String
773
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server.replication_job_id #=> String
774
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server.replication_job_terminated #=> Boolean
775
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server_replication_parameters.seed_time #=> Time
776
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server_replication_parameters.frequency #=> Integer
777
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server_replication_parameters.run_once #=> Boolean
778
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server_replication_parameters.license_type #=> String, one of "AWS", "BYOL"
779
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server_replication_parameters.number_of_recent_amis_to_keep #=> Integer
780
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server_replication_parameters.encrypted #=> Boolean
781
+ # resp.server_group_replication_configurations[0].server_replication_configurations[0].server_replication_parameters.kms_key_id #=> String
782
+ #
783
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetAppReplicationConfiguration AWS API Documentation
784
+ #
785
+ # @overload get_app_replication_configuration(params = {})
786
+ # @param [Hash] params ({})
787
+ def get_app_replication_configuration(params = {}, options = {})
788
+ req = build_request(:get_app_replication_configuration, params)
789
+ req.send_request(options)
790
+ end
791
+
792
+ # Describes the connectors registered with the AWS SMS.
338
793
  #
339
794
  # @option params [String] :next_token
340
- # Pagination token to pass as input to API call
795
+ # The token for the next set of results.
341
796
  #
342
797
  # @option params [Integer] :max_results
343
- # The maximum number of results to return in one API call. If left
344
- # empty, this will default to 50.
798
+ # The maximum number of results to return in a single call. The default
799
+ # value is 50. To retrieve the remaining results, make another call with
800
+ # the returned `NextToken` value.
345
801
  #
346
802
  # @return [Types::GetConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
347
803
  #
@@ -362,9 +818,9 @@ module Aws::SMS
362
818
  # resp.connector_list[0].version #=> String
363
819
  # resp.connector_list[0].status #=> String, one of "HEALTHY", "UNHEALTHY"
364
820
  # resp.connector_list[0].capability_list #=> Array
365
- # resp.connector_list[0].capability_list[0] #=> String, one of "VSPHERE"
821
+ # resp.connector_list[0].capability_list[0] #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER", "SNAPSHOT_BATCHING"
366
822
  # resp.connector_list[0].vm_manager_name #=> String
367
- # resp.connector_list[0].vm_manager_type #=> String, one of "VSPHERE"
823
+ # resp.connector_list[0].vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
368
824
  # resp.connector_list[0].vm_manager_id #=> String
369
825
  # resp.connector_list[0].ip_address #=> String
370
826
  # resp.connector_list[0].mac_address #=> String
@@ -380,19 +836,19 @@ module Aws::SMS
380
836
  req.send_request(options)
381
837
  end
382
838
 
383
- # The GetReplicationJobs API will return all of your ReplicationJobs and
384
- # their details. This API returns a paginated list, that may be
385
- # consecutively called with nextToken to retrieve all ReplicationJobs.
839
+ # Describes the specified replication job or all of your replication
840
+ # jobs.
386
841
  #
387
842
  # @option params [String] :replication_job_id
388
- # The unique identifier for a Replication Job.
843
+ # The identifier of the replication job.
389
844
  #
390
845
  # @option params [String] :next_token
391
- # Pagination token to pass as input to API call
846
+ # The token for the next set of results.
392
847
  #
393
848
  # @option params [Integer] :max_results
394
- # The maximum number of results to return in one API call. If left
395
- # empty, this will default to 50.
849
+ # The maximum number of results to return in a single call. The default
850
+ # value is 50. To retrieve the remaining results, make another call with
851
+ # the returned `NextToken` value.
396
852
  #
397
853
  # @return [Types::GetReplicationJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
398
854
  #
@@ -417,26 +873,34 @@ module Aws::SMS
417
873
  # resp.replication_job_list[0].vm_server.vm_server_address.vm_id #=> String
418
874
  # resp.replication_job_list[0].vm_server.vm_name #=> String
419
875
  # resp.replication_job_list[0].vm_server.vm_manager_name #=> String
420
- # resp.replication_job_list[0].vm_server.vm_manager_type #=> String, one of "VSPHERE"
876
+ # resp.replication_job_list[0].vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
421
877
  # resp.replication_job_list[0].vm_server.vm_path #=> String
422
878
  # resp.replication_job_list[0].seed_replication_time #=> Time
423
879
  # resp.replication_job_list[0].frequency #=> Integer
880
+ # resp.replication_job_list[0].run_once #=> Boolean
424
881
  # resp.replication_job_list[0].next_replication_run_start_time #=> Time
425
882
  # resp.replication_job_list[0].license_type #=> String, one of "AWS", "BYOL"
426
883
  # resp.replication_job_list[0].role_name #=> String
427
884
  # resp.replication_job_list[0].latest_ami_id #=> String
428
- # resp.replication_job_list[0].state #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING", "DELETED"
885
+ # resp.replication_job_list[0].state #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING", "DELETED", "COMPLETED", "PAUSED_ON_FAILURE", "FAILING"
429
886
  # resp.replication_job_list[0].status_message #=> String
430
887
  # resp.replication_job_list[0].description #=> String
888
+ # resp.replication_job_list[0].number_of_recent_amis_to_keep #=> Integer
889
+ # resp.replication_job_list[0].encrypted #=> Boolean
890
+ # resp.replication_job_list[0].kms_key_id #=> String
431
891
  # resp.replication_job_list[0].replication_run_list #=> Array
432
892
  # resp.replication_job_list[0].replication_run_list[0].replication_run_id #=> String
433
893
  # resp.replication_job_list[0].replication_run_list[0].state #=> String, one of "PENDING", "MISSED", "ACTIVE", "FAILED", "COMPLETED", "DELETING", "DELETED"
434
894
  # resp.replication_job_list[0].replication_run_list[0].type #=> String, one of "ON_DEMAND", "AUTOMATIC"
895
+ # resp.replication_job_list[0].replication_run_list[0].stage_details.stage #=> String
896
+ # resp.replication_job_list[0].replication_run_list[0].stage_details.stage_progress #=> String
435
897
  # resp.replication_job_list[0].replication_run_list[0].status_message #=> String
436
898
  # resp.replication_job_list[0].replication_run_list[0].ami_id #=> String
437
899
  # resp.replication_job_list[0].replication_run_list[0].scheduled_start_time #=> Time
438
900
  # resp.replication_job_list[0].replication_run_list[0].completed_time #=> Time
439
901
  # resp.replication_job_list[0].replication_run_list[0].description #=> String
902
+ # resp.replication_job_list[0].replication_run_list[0].encrypted #=> Boolean
903
+ # resp.replication_job_list[0].replication_run_list[0].kms_key_id #=> String
440
904
  # resp.next_token #=> String
441
905
  #
442
906
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetReplicationJobs AWS API Documentation
@@ -448,20 +912,18 @@ module Aws::SMS
448
912
  req.send_request(options)
449
913
  end
450
914
 
451
- # The GetReplicationRuns API will return all ReplicationRuns for a given
452
- # ReplicationJob. This API returns a paginated list, that may be
453
- # consecutively called with nextToken to retrieve all ReplicationRuns
454
- # for a ReplicationJob.
915
+ # Describes the replication runs for the specified replication job.
455
916
  #
456
917
  # @option params [required, String] :replication_job_id
457
- # The unique identifier for a Replication Job.
918
+ # The identifier of the replication job.
458
919
  #
459
920
  # @option params [String] :next_token
460
- # Pagination token to pass as input to API call
921
+ # The token for the next set of results.
461
922
  #
462
923
  # @option params [Integer] :max_results
463
- # The maximum number of results to return in one API call. If left
464
- # empty, this will default to 50.
924
+ # The maximum number of results to return in a single call. The default
925
+ # value is 50. To retrieve the remaining results, make another call with
926
+ # the returned `NextToken` value.
465
927
  #
466
928
  # @return [Types::GetReplicationRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
467
929
  #
@@ -486,35 +948,47 @@ module Aws::SMS
486
948
  # resp.replication_job.vm_server.vm_server_address.vm_id #=> String
487
949
  # resp.replication_job.vm_server.vm_name #=> String
488
950
  # resp.replication_job.vm_server.vm_manager_name #=> String
489
- # resp.replication_job.vm_server.vm_manager_type #=> String, one of "VSPHERE"
951
+ # resp.replication_job.vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
490
952
  # resp.replication_job.vm_server.vm_path #=> String
491
953
  # resp.replication_job.seed_replication_time #=> Time
492
954
  # resp.replication_job.frequency #=> Integer
955
+ # resp.replication_job.run_once #=> Boolean
493
956
  # resp.replication_job.next_replication_run_start_time #=> Time
494
957
  # resp.replication_job.license_type #=> String, one of "AWS", "BYOL"
495
958
  # resp.replication_job.role_name #=> String
496
959
  # resp.replication_job.latest_ami_id #=> String
497
- # resp.replication_job.state #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING", "DELETED"
960
+ # resp.replication_job.state #=> String, one of "PENDING", "ACTIVE", "FAILED", "DELETING", "DELETED", "COMPLETED", "PAUSED_ON_FAILURE", "FAILING"
498
961
  # resp.replication_job.status_message #=> String
499
962
  # resp.replication_job.description #=> String
963
+ # resp.replication_job.number_of_recent_amis_to_keep #=> Integer
964
+ # resp.replication_job.encrypted #=> Boolean
965
+ # resp.replication_job.kms_key_id #=> String
500
966
  # resp.replication_job.replication_run_list #=> Array
501
967
  # resp.replication_job.replication_run_list[0].replication_run_id #=> String
502
968
  # resp.replication_job.replication_run_list[0].state #=> String, one of "PENDING", "MISSED", "ACTIVE", "FAILED", "COMPLETED", "DELETING", "DELETED"
503
969
  # resp.replication_job.replication_run_list[0].type #=> String, one of "ON_DEMAND", "AUTOMATIC"
970
+ # resp.replication_job.replication_run_list[0].stage_details.stage #=> String
971
+ # resp.replication_job.replication_run_list[0].stage_details.stage_progress #=> String
504
972
  # resp.replication_job.replication_run_list[0].status_message #=> String
505
973
  # resp.replication_job.replication_run_list[0].ami_id #=> String
506
974
  # resp.replication_job.replication_run_list[0].scheduled_start_time #=> Time
507
975
  # resp.replication_job.replication_run_list[0].completed_time #=> Time
508
976
  # resp.replication_job.replication_run_list[0].description #=> String
977
+ # resp.replication_job.replication_run_list[0].encrypted #=> Boolean
978
+ # resp.replication_job.replication_run_list[0].kms_key_id #=> String
509
979
  # resp.replication_run_list #=> Array
510
980
  # resp.replication_run_list[0].replication_run_id #=> String
511
981
  # resp.replication_run_list[0].state #=> String, one of "PENDING", "MISSED", "ACTIVE", "FAILED", "COMPLETED", "DELETING", "DELETED"
512
982
  # resp.replication_run_list[0].type #=> String, one of "ON_DEMAND", "AUTOMATIC"
983
+ # resp.replication_run_list[0].stage_details.stage #=> String
984
+ # resp.replication_run_list[0].stage_details.stage_progress #=> String
513
985
  # resp.replication_run_list[0].status_message #=> String
514
986
  # resp.replication_run_list[0].ami_id #=> String
515
987
  # resp.replication_run_list[0].scheduled_start_time #=> Time
516
988
  # resp.replication_run_list[0].completed_time #=> Time
517
989
  # resp.replication_run_list[0].description #=> String
990
+ # resp.replication_run_list[0].encrypted #=> Boolean
991
+ # resp.replication_run_list[0].kms_key_id #=> String
518
992
  # resp.next_token #=> String
519
993
  #
520
994
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/GetReplicationRuns AWS API Documentation
@@ -526,16 +1000,21 @@ module Aws::SMS
526
1000
  req.send_request(options)
527
1001
  end
528
1002
 
529
- # The GetServers API returns a list of all servers in your server
530
- # catalog. For this call to succeed, you must previously have called
1003
+ # Describes the servers in your server catalog.
1004
+ #
1005
+ # Before you can describe your servers, you must import them using
531
1006
  # ImportServerCatalog.
532
1007
  #
533
1008
  # @option params [String] :next_token
534
- # Pagination token to pass as input to API call
1009
+ # The token for the next set of results.
535
1010
  #
536
1011
  # @option params [Integer] :max_results
537
- # The maximum number of results to return in one API call. If left
538
- # empty, this will default to 50.
1012
+ # The maximum number of results to return in a single call. The default
1013
+ # value is 50. To retrieve the remaining results, make another call with
1014
+ # the returned `NextToken` value.
1015
+ #
1016
+ # @option params [Array<Types::VmServerAddress>] :vm_server_address_list
1017
+ # List of `VmServerAddress` objects
539
1018
  #
540
1019
  # @return [Types::GetServersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
541
1020
  #
@@ -549,6 +1028,12 @@ module Aws::SMS
549
1028
  # resp = client.get_servers({
550
1029
  # next_token: "NextToken",
551
1030
  # max_results: 1,
1031
+ # vm_server_address_list: [
1032
+ # {
1033
+ # vm_manager_id: "VmManagerId",
1034
+ # vm_id: "VmId",
1035
+ # },
1036
+ # ],
552
1037
  # })
553
1038
  #
554
1039
  # @example Response structure
@@ -562,7 +1047,7 @@ module Aws::SMS
562
1047
  # resp.server_list[0].vm_server.vm_server_address.vm_id #=> String
563
1048
  # resp.server_list[0].vm_server.vm_name #=> String
564
1049
  # resp.server_list[0].vm_server.vm_manager_name #=> String
565
- # resp.server_list[0].vm_server.vm_manager_type #=> String, one of "VSPHERE"
1050
+ # resp.server_list[0].vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
566
1051
  # resp.server_list[0].vm_server.vm_path #=> String
567
1052
  # resp.server_list[0].replication_job_id #=> String
568
1053
  # resp.server_list[0].replication_job_terminated #=> Boolean
@@ -577,11 +1062,11 @@ module Aws::SMS
577
1062
  req.send_request(options)
578
1063
  end
579
1064
 
580
- # The ImportServerCatalog API is used to gather the complete list of
581
- # on-premises servers on your premises. This API call requires
582
- # connectors to be installed and monitoring all servers you would like
583
- # imported. This API call returns immediately, but may take some time to
584
- # retrieve all of the servers.
1065
+ # Gathers a complete list of on-premises servers. Connectors must be
1066
+ # installed and monitoring all servers that you want to import.
1067
+ #
1068
+ # This call returns immediately, but might take additional time to
1069
+ # retrieve all the servers.
585
1070
  #
586
1071
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
587
1072
  #
@@ -594,17 +1079,247 @@ module Aws::SMS
594
1079
  req.send_request(options)
595
1080
  end
596
1081
 
597
- # The StartOnDemandReplicationRun API is used to start a ReplicationRun
598
- # on demand (in addition to those that are scheduled based on your
599
- # frequency). This ReplicationRun will start immediately.
600
- # StartOnDemandReplicationRun is subject to limits on how many on demand
601
- # ReplicationRuns you may call per 24-hour period.
1082
+ # Launches an application stack.
1083
+ #
1084
+ # @option params [String] :app_id
1085
+ # ID of the application to launch.
1086
+ #
1087
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1088
+ #
1089
+ # @example Request syntax with placeholder values
1090
+ #
1091
+ # resp = client.launch_app({
1092
+ # app_id: "AppId",
1093
+ # })
1094
+ #
1095
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/LaunchApp AWS API Documentation
1096
+ #
1097
+ # @overload launch_app(params = {})
1098
+ # @param [Hash] params ({})
1099
+ def launch_app(params = {}, options = {})
1100
+ req = build_request(:launch_app, params)
1101
+ req.send_request(options)
1102
+ end
1103
+
1104
+ # Returns a list of summaries for all applications.
1105
+ #
1106
+ # @option params [Array<String>] :app_ids
1107
+ #
1108
+ # @option params [String] :next_token
1109
+ # The token for the next set of results.
1110
+ #
1111
+ # @option params [Integer] :max_results
1112
+ # The maximum number of results to return in a single call. The default
1113
+ # value is 50. To retrieve the remaining results, make another call with
1114
+ # the returned `NextToken` value.
1115
+ #
1116
+ # @return [Types::ListAppsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1117
+ #
1118
+ # * {Types::ListAppsResponse#apps #apps} => Array&lt;Types::AppSummary&gt;
1119
+ # * {Types::ListAppsResponse#next_token #next_token} => String
1120
+ #
1121
+ # @example Request syntax with placeholder values
1122
+ #
1123
+ # resp = client.list_apps({
1124
+ # app_ids: ["AppId"],
1125
+ # next_token: "NextToken",
1126
+ # max_results: 1,
1127
+ # })
1128
+ #
1129
+ # @example Response structure
1130
+ #
1131
+ # resp.apps #=> Array
1132
+ # resp.apps[0].app_id #=> String
1133
+ # resp.apps[0].name #=> String
1134
+ # resp.apps[0].description #=> String
1135
+ # resp.apps[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
1136
+ # resp.apps[0].status_message #=> String
1137
+ # resp.apps[0].replication_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_REPLICATION", "VALIDATION_IN_PROGRESS", "REPLICATION_PENDING", "REPLICATION_IN_PROGRESS", "REPLICATED", "DELTA_REPLICATION_IN_PROGRESS", "DELTA_REPLICATED", "DELTA_REPLICATION_FAILED", "REPLICATION_FAILED", "REPLICATION_STOPPING", "REPLICATION_STOP_FAILED", "REPLICATION_STOPPED"
1138
+ # resp.apps[0].replication_status_message #=> String
1139
+ # resp.apps[0].latest_replication_time #=> Time
1140
+ # resp.apps[0].launch_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_LAUNCH", "VALIDATION_IN_PROGRESS", "LAUNCH_PENDING", "LAUNCH_IN_PROGRESS", "LAUNCHED", "DELTA_LAUNCH_IN_PROGRESS", "DELTA_LAUNCH_FAILED", "LAUNCH_FAILED", "TERMINATE_IN_PROGRESS", "TERMINATE_FAILED", "TERMINATED"
1141
+ # resp.apps[0].launch_status_message #=> String
1142
+ # resp.apps[0].launch_details.latest_launch_time #=> Time
1143
+ # resp.apps[0].launch_details.stack_name #=> String
1144
+ # resp.apps[0].launch_details.stack_id #=> String
1145
+ # resp.apps[0].creation_time #=> Time
1146
+ # resp.apps[0].last_modified #=> Time
1147
+ # resp.apps[0].role_name #=> String
1148
+ # resp.apps[0].total_server_groups #=> Integer
1149
+ # resp.apps[0].total_servers #=> Integer
1150
+ # resp.next_token #=> String
1151
+ #
1152
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/ListApps AWS API Documentation
1153
+ #
1154
+ # @overload list_apps(params = {})
1155
+ # @param [Hash] params ({})
1156
+ def list_apps(params = {}, options = {})
1157
+ req = build_request(:list_apps, params)
1158
+ req.send_request(options)
1159
+ end
1160
+
1161
+ # Creates a launch configuration for an application.
1162
+ #
1163
+ # @option params [String] :app_id
1164
+ # ID of the application associated with the launch configuration.
1165
+ #
1166
+ # @option params [String] :role_name
1167
+ # Name of service role in the customer's account that Amazon
1168
+ # CloudFormation uses to launch the application.
1169
+ #
1170
+ # @option params [Array<Types::ServerGroupLaunchConfiguration>] :server_group_launch_configurations
1171
+ # Launch configurations for server groups in the application.
1172
+ #
1173
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1174
+ #
1175
+ # @example Request syntax with placeholder values
1176
+ #
1177
+ # resp = client.put_app_launch_configuration({
1178
+ # app_id: "AppId",
1179
+ # role_name: "RoleName",
1180
+ # server_group_launch_configurations: [
1181
+ # {
1182
+ # server_group_id: "ServerGroupId",
1183
+ # launch_order: 1,
1184
+ # server_launch_configurations: [
1185
+ # {
1186
+ # server: {
1187
+ # server_id: "ServerId",
1188
+ # server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
1189
+ # vm_server: {
1190
+ # vm_server_address: {
1191
+ # vm_manager_id: "VmManagerId",
1192
+ # vm_id: "VmId",
1193
+ # },
1194
+ # vm_name: "VmName",
1195
+ # vm_manager_name: "VmManagerName",
1196
+ # vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
1197
+ # vm_path: "VmPath",
1198
+ # },
1199
+ # replication_job_id: "ReplicationJobId",
1200
+ # replication_job_terminated: false,
1201
+ # },
1202
+ # logical_id: "LogicalId",
1203
+ # vpc: "VPC",
1204
+ # subnet: "Subnet",
1205
+ # security_group: "SecurityGroup",
1206
+ # ec2_key_name: "EC2KeyName",
1207
+ # user_data: {
1208
+ # s3_location: {
1209
+ # bucket: "BucketName",
1210
+ # key: "KeyName",
1211
+ # },
1212
+ # },
1213
+ # instance_type: "InstanceType",
1214
+ # associate_public_ip_address: false,
1215
+ # },
1216
+ # ],
1217
+ # },
1218
+ # ],
1219
+ # })
1220
+ #
1221
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/PutAppLaunchConfiguration AWS API Documentation
1222
+ #
1223
+ # @overload put_app_launch_configuration(params = {})
1224
+ # @param [Hash] params ({})
1225
+ def put_app_launch_configuration(params = {}, options = {})
1226
+ req = build_request(:put_app_launch_configuration, params)
1227
+ req.send_request(options)
1228
+ end
1229
+
1230
+ # Creates or updates a replication configuration for an application.
1231
+ #
1232
+ # @option params [String] :app_id
1233
+ # ID of the application tassociated with the replication configuration.
1234
+ #
1235
+ # @option params [Array<Types::ServerGroupReplicationConfiguration>] :server_group_replication_configurations
1236
+ # Replication configurations for server groups in the application.
1237
+ #
1238
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1239
+ #
1240
+ # @example Request syntax with placeholder values
1241
+ #
1242
+ # resp = client.put_app_replication_configuration({
1243
+ # app_id: "AppId",
1244
+ # server_group_replication_configurations: [
1245
+ # {
1246
+ # server_group_id: "ServerGroupId",
1247
+ # server_replication_configurations: [
1248
+ # {
1249
+ # server: {
1250
+ # server_id: "ServerId",
1251
+ # server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
1252
+ # vm_server: {
1253
+ # vm_server_address: {
1254
+ # vm_manager_id: "VmManagerId",
1255
+ # vm_id: "VmId",
1256
+ # },
1257
+ # vm_name: "VmName",
1258
+ # vm_manager_name: "VmManagerName",
1259
+ # vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
1260
+ # vm_path: "VmPath",
1261
+ # },
1262
+ # replication_job_id: "ReplicationJobId",
1263
+ # replication_job_terminated: false,
1264
+ # },
1265
+ # server_replication_parameters: {
1266
+ # seed_time: Time.now,
1267
+ # frequency: 1,
1268
+ # run_once: false,
1269
+ # license_type: "AWS", # accepts AWS, BYOL
1270
+ # number_of_recent_amis_to_keep: 1,
1271
+ # encrypted: false,
1272
+ # kms_key_id: "KmsKeyId",
1273
+ # },
1274
+ # },
1275
+ # ],
1276
+ # },
1277
+ # ],
1278
+ # })
1279
+ #
1280
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/PutAppReplicationConfiguration AWS API Documentation
1281
+ #
1282
+ # @overload put_app_replication_configuration(params = {})
1283
+ # @param [Hash] params ({})
1284
+ def put_app_replication_configuration(params = {}, options = {})
1285
+ req = build_request(:put_app_replication_configuration, params)
1286
+ req.send_request(options)
1287
+ end
1288
+
1289
+ # Starts replicating an application.
1290
+ #
1291
+ # @option params [String] :app_id
1292
+ # ID of the application to replicate.
1293
+ #
1294
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1295
+ #
1296
+ # @example Request syntax with placeholder values
1297
+ #
1298
+ # resp = client.start_app_replication({
1299
+ # app_id: "AppId",
1300
+ # })
1301
+ #
1302
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/StartAppReplication AWS API Documentation
1303
+ #
1304
+ # @overload start_app_replication(params = {})
1305
+ # @param [Hash] params ({})
1306
+ def start_app_replication(params = {}, options = {})
1307
+ req = build_request(:start_app_replication, params)
1308
+ req.send_request(options)
1309
+ end
1310
+
1311
+ # Starts an on-demand replication run for the specified replication job.
1312
+ # This replication run starts immediately. This replication run is in
1313
+ # addition to the ones already scheduled.
1314
+ #
1315
+ # There is a limit on the number of on-demand replications runs you can
1316
+ # request in a 24-hour period.
602
1317
  #
603
1318
  # @option params [required, String] :replication_job_id
604
- # The unique identifier for a Replication Job.
1319
+ # The identifier of the replication job.
605
1320
  #
606
1321
  # @option params [String] :description
607
- # The description for a Replication Job/Run.
1322
+ # The description of the replication run.
608
1323
  #
609
1324
  # @return [Types::StartOnDemandReplicationRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
610
1325
  #
@@ -630,29 +1345,205 @@ module Aws::SMS
630
1345
  req.send_request(options)
631
1346
  end
632
1347
 
633
- # The UpdateReplicationJob API is used to change the settings of your
634
- # existing ReplicationJob created using CreateReplicationJob. Calling
635
- # this API will affect the next scheduled ReplicationRun.
1348
+ # Stops replicating an application.
1349
+ #
1350
+ # @option params [String] :app_id
1351
+ # ID of the application to stop replicating.
1352
+ #
1353
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1354
+ #
1355
+ # @example Request syntax with placeholder values
1356
+ #
1357
+ # resp = client.stop_app_replication({
1358
+ # app_id: "AppId",
1359
+ # })
1360
+ #
1361
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/StopAppReplication AWS API Documentation
1362
+ #
1363
+ # @overload stop_app_replication(params = {})
1364
+ # @param [Hash] params ({})
1365
+ def stop_app_replication(params = {}, options = {})
1366
+ req = build_request(:stop_app_replication, params)
1367
+ req.send_request(options)
1368
+ end
1369
+
1370
+ # Terminates the stack for an application.
1371
+ #
1372
+ # @option params [String] :app_id
1373
+ # ID of the application to terminate.
1374
+ #
1375
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1376
+ #
1377
+ # @example Request syntax with placeholder values
1378
+ #
1379
+ # resp = client.terminate_app({
1380
+ # app_id: "AppId",
1381
+ # })
1382
+ #
1383
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/TerminateApp AWS API Documentation
1384
+ #
1385
+ # @overload terminate_app(params = {})
1386
+ # @param [Hash] params ({})
1387
+ def terminate_app(params = {}, options = {})
1388
+ req = build_request(:terminate_app, params)
1389
+ req.send_request(options)
1390
+ end
1391
+
1392
+ # Updates an application.
1393
+ #
1394
+ # @option params [String] :app_id
1395
+ # ID of the application to update.
1396
+ #
1397
+ # @option params [String] :name
1398
+ # New name of the application.
1399
+ #
1400
+ # @option params [String] :description
1401
+ # New description of the application.
1402
+ #
1403
+ # @option params [String] :role_name
1404
+ # Name of the service role in the customer's account used by AWS SMS.
1405
+ #
1406
+ # @option params [Array<Types::ServerGroup>] :server_groups
1407
+ # List of server groups in the application to update.
1408
+ #
1409
+ # @option params [Array<Types::Tag>] :tags
1410
+ # List of tags to associate with the application.
1411
+ #
1412
+ # @return [Types::UpdateAppResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1413
+ #
1414
+ # * {Types::UpdateAppResponse#app_summary #app_summary} => Types::AppSummary
1415
+ # * {Types::UpdateAppResponse#server_groups #server_groups} => Array&lt;Types::ServerGroup&gt;
1416
+ # * {Types::UpdateAppResponse#tags #tags} => Array&lt;Types::Tag&gt;
1417
+ #
1418
+ # @example Request syntax with placeholder values
1419
+ #
1420
+ # resp = client.update_app({
1421
+ # app_id: "AppId",
1422
+ # name: "AppName",
1423
+ # description: "AppDescription",
1424
+ # role_name: "RoleName",
1425
+ # server_groups: [
1426
+ # {
1427
+ # server_group_id: "ServerGroupId",
1428
+ # name: "ServerGroupName",
1429
+ # server_list: [
1430
+ # {
1431
+ # server_id: "ServerId",
1432
+ # server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
1433
+ # vm_server: {
1434
+ # vm_server_address: {
1435
+ # vm_manager_id: "VmManagerId",
1436
+ # vm_id: "VmId",
1437
+ # },
1438
+ # vm_name: "VmName",
1439
+ # vm_manager_name: "VmManagerName",
1440
+ # vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
1441
+ # vm_path: "VmPath",
1442
+ # },
1443
+ # replication_job_id: "ReplicationJobId",
1444
+ # replication_job_terminated: false,
1445
+ # },
1446
+ # ],
1447
+ # },
1448
+ # ],
1449
+ # tags: [
1450
+ # {
1451
+ # key: "TagKey",
1452
+ # value: "TagValue",
1453
+ # },
1454
+ # ],
1455
+ # })
1456
+ #
1457
+ # @example Response structure
1458
+ #
1459
+ # resp.app_summary.app_id #=> String
1460
+ # resp.app_summary.name #=> String
1461
+ # resp.app_summary.description #=> String
1462
+ # resp.app_summary.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "DELETED", "DELETE_FAILED"
1463
+ # resp.app_summary.status_message #=> String
1464
+ # resp.app_summary.replication_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_REPLICATION", "VALIDATION_IN_PROGRESS", "REPLICATION_PENDING", "REPLICATION_IN_PROGRESS", "REPLICATED", "DELTA_REPLICATION_IN_PROGRESS", "DELTA_REPLICATED", "DELTA_REPLICATION_FAILED", "REPLICATION_FAILED", "REPLICATION_STOPPING", "REPLICATION_STOP_FAILED", "REPLICATION_STOPPED"
1465
+ # resp.app_summary.replication_status_message #=> String
1466
+ # resp.app_summary.latest_replication_time #=> Time
1467
+ # resp.app_summary.launch_status #=> String, one of "READY_FOR_CONFIGURATION", "CONFIGURATION_IN_PROGRESS", "CONFIGURATION_INVALID", "READY_FOR_LAUNCH", "VALIDATION_IN_PROGRESS", "LAUNCH_PENDING", "LAUNCH_IN_PROGRESS", "LAUNCHED", "DELTA_LAUNCH_IN_PROGRESS", "DELTA_LAUNCH_FAILED", "LAUNCH_FAILED", "TERMINATE_IN_PROGRESS", "TERMINATE_FAILED", "TERMINATED"
1468
+ # resp.app_summary.launch_status_message #=> String
1469
+ # resp.app_summary.launch_details.latest_launch_time #=> Time
1470
+ # resp.app_summary.launch_details.stack_name #=> String
1471
+ # resp.app_summary.launch_details.stack_id #=> String
1472
+ # resp.app_summary.creation_time #=> Time
1473
+ # resp.app_summary.last_modified #=> Time
1474
+ # resp.app_summary.role_name #=> String
1475
+ # resp.app_summary.total_server_groups #=> Integer
1476
+ # resp.app_summary.total_servers #=> Integer
1477
+ # resp.server_groups #=> Array
1478
+ # resp.server_groups[0].server_group_id #=> String
1479
+ # resp.server_groups[0].name #=> String
1480
+ # resp.server_groups[0].server_list #=> Array
1481
+ # resp.server_groups[0].server_list[0].server_id #=> String
1482
+ # resp.server_groups[0].server_list[0].server_type #=> String, one of "VIRTUAL_MACHINE"
1483
+ # resp.server_groups[0].server_list[0].vm_server.vm_server_address.vm_manager_id #=> String
1484
+ # resp.server_groups[0].server_list[0].vm_server.vm_server_address.vm_id #=> String
1485
+ # resp.server_groups[0].server_list[0].vm_server.vm_name #=> String
1486
+ # resp.server_groups[0].server_list[0].vm_server.vm_manager_name #=> String
1487
+ # resp.server_groups[0].server_list[0].vm_server.vm_manager_type #=> String, one of "VSPHERE", "SCVMM", "HYPERV-MANAGER"
1488
+ # resp.server_groups[0].server_list[0].vm_server.vm_path #=> String
1489
+ # resp.server_groups[0].server_list[0].replication_job_id #=> String
1490
+ # resp.server_groups[0].server_list[0].replication_job_terminated #=> Boolean
1491
+ # resp.tags #=> Array
1492
+ # resp.tags[0].key #=> String
1493
+ # resp.tags[0].value #=> String
1494
+ #
1495
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/UpdateApp AWS API Documentation
1496
+ #
1497
+ # @overload update_app(params = {})
1498
+ # @param [Hash] params ({})
1499
+ def update_app(params = {}, options = {})
1500
+ req = build_request(:update_app, params)
1501
+ req.send_request(options)
1502
+ end
1503
+
1504
+ # Updates the specified settings for the specified replication job.
636
1505
  #
637
1506
  # @option params [required, String] :replication_job_id
638
- # The unique identifier for a Replication Job.
1507
+ # The identifier of the replication job.
639
1508
  #
640
1509
  # @option params [Integer] :frequency
641
- # Interval between Replication Runs. This value is specified in hours,
642
- # and represents the time between consecutive Replication Runs.
1510
+ # The time between consecutive replication runs, in hours.
643
1511
  #
644
1512
  # @option params [Time,DateTime,Date,Integer,String] :next_replication_run_start_time
645
- # Timestamp of an operation
1513
+ # The start time of the next replication run.
646
1514
  #
647
1515
  # @option params [String] :license_type
648
- # The license type to be used for the Amazon Machine Image (AMI) created
649
- # after a successful ReplicationRun.
1516
+ # The license type to be used for the AMI created by a successful
1517
+ # replication run.
650
1518
  #
651
1519
  # @option params [String] :role_name
652
- # Name of service role in customer's account to be used by SMS service.
1520
+ # The name of the IAM role to be used by AWS SMS.
653
1521
  #
654
1522
  # @option params [String] :description
655
- # The description for a Replication Job/Run.
1523
+ # The description of the replication job.
1524
+ #
1525
+ # @option params [Integer] :number_of_recent_amis_to_keep
1526
+ # The maximum number of SMS-created AMIs to retain. The oldest will be
1527
+ # deleted once the maximum number is reached and a new AMI is created.
1528
+ #
1529
+ # @option params [Boolean] :encrypted
1530
+ # When true, the replication job produces encrypted AMIs . See also
1531
+ # `KmsKeyId` below.
1532
+ #
1533
+ # @option params [String] :kms_key_id
1534
+ # KMS key ID for replication jobs that produce encrypted AMIs. Can be
1535
+ # any of the following:
1536
+ #
1537
+ # * KMS key ID
1538
+ #
1539
+ # * KMS key alias
1540
+ #
1541
+ # * ARN referring to KMS key ID
1542
+ #
1543
+ # * ARN referring to KMS key alias
1544
+ #
1545
+ # If encrypted is *true* but a KMS key id is not specified, the
1546
+ # customer's default KMS key for EBS is used.
656
1547
  #
657
1548
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
658
1549
  #
@@ -665,6 +1556,9 @@ module Aws::SMS
665
1556
  # license_type: "AWS", # accepts AWS, BYOL
666
1557
  # role_name: "RoleName",
667
1558
  # description: "Description",
1559
+ # number_of_recent_amis_to_keep: 1,
1560
+ # encrypted: false,
1561
+ # kms_key_id: "KmsKeyId",
668
1562
  # })
669
1563
  #
670
1564
  # @see http://docs.aws.amazon.com/goto/WebAPI/sms-2016-10-24/UpdateReplicationJob AWS API Documentation
@@ -689,7 +1583,7 @@ module Aws::SMS
689
1583
  params: params,
690
1584
  config: config)
691
1585
  context[:gem_name] = 'aws-sdk-sms'
692
- context[:gem_version] = '1.6.0'
1586
+ context[:gem_version] = '1.7.0'
693
1587
  Seahorse::Client::Request.new(handlers, context)
694
1588
  end
695
1589