Class: Aws::SMS::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::SMS::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb
Overview
An API client for SMS. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::SMS::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_app(params = {}) ⇒ Types::CreateAppResponse
Creates an application.
-
#create_replication_job(params = {}) ⇒ Types::CreateReplicationJobResponse
Creates a replication job.
-
#delete_app(params = {}) ⇒ Struct
Deletes the specified application.
-
#delete_app_launch_configuration(params = {}) ⇒ Struct
Deletes the launch configuration for the specified application.
-
#delete_app_replication_configuration(params = {}) ⇒ Struct
Deletes the replication configuration for the specified application.
-
#delete_app_validation_configuration(params = {}) ⇒ Struct
Deletes the validation configuration for the specified application.
-
#delete_replication_job(params = {}) ⇒ Struct
Deletes the specified replication job.
-
#delete_server_catalog(params = {}) ⇒ Struct
Deletes all servers from your server catalog.
-
#disassociate_connector(params = {}) ⇒ Struct
Disassociates the specified connector from Server Migration Service.
-
#generate_change_set(params = {}) ⇒ Types::GenerateChangeSetResponse
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.
-
#generate_template(params = {}) ⇒ Types::GenerateTemplateResponse
Generates an CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
-
#get_app(params = {}) ⇒ Types::GetAppResponse
Retrieve information about the specified application.
-
#get_app_launch_configuration(params = {}) ⇒ Types::GetAppLaunchConfigurationResponse
Retrieves the application launch configuration associated with the specified application.
-
#get_app_replication_configuration(params = {}) ⇒ Types::GetAppReplicationConfigurationResponse
Retrieves the application replication configuration associated with the specified application.
-
#get_app_validation_configuration(params = {}) ⇒ Types::GetAppValidationConfigurationResponse
Retrieves information about a configuration for validating an application.
-
#get_app_validation_output(params = {}) ⇒ Types::GetAppValidationOutputResponse
Retrieves output from validating an application.
-
#get_connectors(params = {}) ⇒ Types::GetConnectorsResponse
Describes the connectors registered with the Server Migration Service.
-
#get_replication_jobs(params = {}) ⇒ Types::GetReplicationJobsResponse
Describes the specified replication job or all of your replication jobs.
-
#get_replication_runs(params = {}) ⇒ Types::GetReplicationRunsResponse
Describes the replication runs for the specified replication job.
-
#get_servers(params = {}) ⇒ Types::GetServersResponse
Describes the servers in your server catalog.
-
#import_app_catalog(params = {}) ⇒ Struct
Allows application import from Migration Hub.
-
#import_server_catalog(params = {}) ⇒ Struct
Gathers a complete list of on-premises servers.
-
#launch_app(params = {}) ⇒ Struct
Launches the specified application as a stack in CloudFormation.
-
#list_apps(params = {}) ⇒ Types::ListAppsResponse
Retrieves summaries for all applications.
-
#notify_app_validation_output(params = {}) ⇒ Struct
Provides information to Server Migration Service about whether application validation is successful.
-
#put_app_launch_configuration(params = {}) ⇒ Struct
Creates or updates the launch configuration for the specified application.
-
#put_app_replication_configuration(params = {}) ⇒ Struct
Creates or updates the replication configuration for the specified application.
-
#put_app_validation_configuration(params = {}) ⇒ Struct
Creates or updates a validation configuration for the specified application.
-
#start_app_replication(params = {}) ⇒ Struct
Starts replicating the specified application by creating replication jobs for each server in the application.
-
#start_on_demand_app_replication(params = {}) ⇒ Struct
Starts an on-demand replication run for the specified application.
-
#start_on_demand_replication_run(params = {}) ⇒ Types::StartOnDemandReplicationRunResponse
Starts an on-demand replication run for the specified replication job.
-
#stop_app_replication(params = {}) ⇒ Struct
Stops replicating the specified application by deleting the replication job for each server in the application.
-
#terminate_app(params = {}) ⇒ Struct
Terminates the stack for the specified application.
-
#update_app(params = {}) ⇒ Types::UpdateAppResponse
Updates the specified application.
-
#update_replication_job(params = {}) ⇒ Struct
Updates the specified settings for the specified replication job.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
453 454 455 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 453 def initialize(*args) super end |
Instance Method Details
#create_app(params = {}) ⇒ Types::CreateAppResponse
Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.
572 573 574 575 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 572 def create_app(params = {}, = {}) req = build_request(:create_app, params) req.send_request() end |
#create_replication_job(params = {}) ⇒ Types::CreateReplicationJobResponse
Creates a replication job. The replication job schedules periodic replication runs to replicate your server to Amazon Web Services. Each replication run creates an Amazon Machine Image (AMI).
652 653 654 655 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 652 def create_replication_job(params = {}, = {}) req = build_request(:create_replication_job, params) req.send_request() end |
#delete_app(params = {}) ⇒ Struct
Deletes the specified application. Optionally deletes the launched stack associated with the application and all Server Migration Service replication jobs for servers in the application.
686 687 688 689 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 686 def delete_app(params = {}, = {}) req = build_request(:delete_app, params) req.send_request() end |
#delete_app_launch_configuration(params = {}) ⇒ Struct
Deletes the launch configuration for the specified application.
708 709 710 711 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 708 def delete_app_launch_configuration(params = {}, = {}) req = build_request(:delete_app_launch_configuration, params) req.send_request() end |
#delete_app_replication_configuration(params = {}) ⇒ Struct
Deletes the replication configuration for the specified application.
730 731 732 733 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 730 def delete_app_replication_configuration(params = {}, = {}) req = build_request(:delete_app_replication_configuration, params) req.send_request() end |
#delete_app_validation_configuration(params = {}) ⇒ Struct
Deletes the validation configuration for the specified application.
752 753 754 755 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 752 def delete_app_validation_configuration(params = {}, = {}) req = build_request(:delete_app_validation_configuration, params) req.send_request() end |
#delete_replication_job(params = {}) ⇒ Struct
Deletes the specified replication job.
After you delete a replication job, there are no further replication runs. Amazon Web Services deletes the contents of the Amazon S3 bucket used to store Server Migration Service artifacts. The AMIs created by the replication runs are not deleted.
779 780 781 782 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 779 def delete_replication_job(params = {}, = {}) req = build_request(:delete_replication_job, params) req.send_request() end |
#delete_server_catalog(params = {}) ⇒ Struct
Deletes all servers from your server catalog.
792 793 794 795 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 792 def delete_server_catalog(params = {}, = {}) req = build_request(:delete_server_catalog, params) req.send_request() end |
#disassociate_connector(params = {}) ⇒ Struct
Disassociates the specified connector from Server Migration Service.
After you disassociate a connector, it is no longer available to support replication jobs.
817 818 819 820 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 817 def disassociate_connector(params = {}, = {}) req = build_request(:disassociate_connector, params) req.send_request() end |
#generate_change_set(params = {}) ⇒ Types::GenerateChangeSetResponse
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.
851 852 853 854 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 851 def generate_change_set(params = {}, = {}) req = build_request(:generate_change_set, params) req.send_request() end |
#generate_template(params = {}) ⇒ Types::GenerateTemplateResponse
Generates an CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
886 887 888 889 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 886 def generate_template(params = {}, = {}) req = build_request(:generate_template, params) req.send_request() end |
#get_app(params = {}) ⇒ Types::GetAppResponse
Retrieve information about the specified application.
953 954 955 956 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 953 def get_app(params = {}, = {}) req = build_request(:get_app, params) req.send_request() end |
#get_app_launch_configuration(params = {}) ⇒ Types::GetAppLaunchConfigurationResponse
Retrieves the application launch configuration associated with the specified application.
1014 1015 1016 1017 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1014 def get_app_launch_configuration(params = {}, = {}) req = build_request(:get_app_launch_configuration, params) req.send_request() end |
#get_app_replication_configuration(params = {}) ⇒ Types::GetAppReplicationConfigurationResponse
Retrieves the application replication configuration associated with the specified application.
1062 1063 1064 1065 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1062 def get_app_replication_configuration(params = {}, = {}) req = build_request(:get_app_replication_configuration, params) req.send_request() end |
#get_app_validation_configuration(params = {}) ⇒ Types::GetAppValidationConfigurationResponse
Retrieves information about a configuration for validating an application.
1121 1122 1123 1124 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1121 def get_app_validation_configuration(params = {}, = {}) req = build_request(:get_app_validation_configuration, params) req.send_request() end |
#get_app_validation_output(params = {}) ⇒ Types::GetAppValidationOutputResponse
Retrieves output from validating an application.
1166 1167 1168 1169 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1166 def get_app_validation_output(params = {}, = {}) req = build_request(:get_app_validation_output, params) req.send_request() end |
#get_connectors(params = {}) ⇒ Types::GetConnectorsResponse
Describes the connectors registered with the Server Migration Service.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1215 1216 1217 1218 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1215 def get_connectors(params = {}, = {}) req = build_request(:get_connectors, params) req.send_request() end |
#get_replication_jobs(params = {}) ⇒ Types::GetReplicationJobsResponse
Describes the specified replication job or all of your replication jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1293 1294 1295 1296 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1293 def get_replication_jobs(params = {}, = {}) req = build_request(:get_replication_jobs, params) req.send_request() end |
#get_replication_runs(params = {}) ⇒ Types::GetReplicationRunsResponse
Describes the replication runs for the specified replication job.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1383 1384 1385 1386 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1383 def get_replication_runs(params = {}, = {}) req = build_request(:get_replication_runs, params) req.send_request() end |
#get_servers(params = {}) ⇒ Types::GetServersResponse
Describes the servers in your server catalog.
Before you can describe your servers, you must import them using ImportServerCatalog.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1447 1448 1449 1450 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1447 def get_servers(params = {}, = {}) req = build_request(:get_servers, params) req.send_request() end |
#import_app_catalog(params = {}) ⇒ Struct
Allows application import from Migration Hub.
1476 1477 1478 1479 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1476 def import_app_catalog(params = {}, = {}) req = build_request(:import_app_catalog, params) req.send_request() end |
#import_server_catalog(params = {}) ⇒ Struct
Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers to import.
This call returns immediately, but might take additional time to retrieve all the servers.
1493 1494 1495 1496 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1493 def import_server_catalog(params = {}, = {}) req = build_request(:import_server_catalog, params) req.send_request() end |
#launch_app(params = {}) ⇒ Struct
Launches the specified application as a stack in CloudFormation.
1515 1516 1517 1518 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1515 def launch_app(params = {}, = {}) req = build_request(:launch_app, params) req.send_request() end |
#list_apps(params = {}) ⇒ Types::ListAppsResponse
Retrieves summaries for all applications.
1576 1577 1578 1579 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1576 def list_apps(params = {}, = {}) req = build_request(:list_apps, params) req.send_request() end |
#notify_app_validation_output(params = {}) ⇒ Struct
Provides information to Server Migration Service about whether application validation is successful.
1607 1608 1609 1610 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1607 def notify_app_validation_output(params = {}, = {}) req = build_request(:notify_app_validation_output, params) req.send_request() end |
#put_app_launch_configuration(params = {}) ⇒ Struct
Creates or updates the launch configuration for the specified application.
1689 1690 1691 1692 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1689 def put_app_launch_configuration(params = {}, = {}) req = build_request(:put_app_launch_configuration, params) req.send_request() end |
#put_app_replication_configuration(params = {}) ⇒ Struct
Creates or updates the replication configuration for the specified application.
1750 1751 1752 1753 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1750 def put_app_replication_configuration(params = {}, = {}) req = build_request(:put_app_replication_configuration, params) req.send_request() end |
#put_app_validation_configuration(params = {}) ⇒ Struct
Creates or updates a validation configuration for the specified application.
1836 1837 1838 1839 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1836 def put_app_validation_configuration(params = {}, = {}) req = build_request(:put_app_validation_configuration, params) req.send_request() end |
#start_app_replication(params = {}) ⇒ Struct
Starts replicating the specified application by creating replication jobs for each server in the application.
1859 1860 1861 1862 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1859 def start_app_replication(params = {}, = {}) req = build_request(:start_app_replication, params) req.send_request() end |
#start_on_demand_app_replication(params = {}) ⇒ Struct
Starts an on-demand replication run for the specified application.
1885 1886 1887 1888 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1885 def start_on_demand_app_replication(params = {}, = {}) req = build_request(:start_on_demand_app_replication, params) req.send_request() end |
#start_on_demand_replication_run(params = {}) ⇒ Types::StartOnDemandReplicationRunResponse
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.
There is a limit on the number of on-demand replications runs that you can request in a 24-hour period.
1922 1923 1924 1925 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1922 def start_on_demand_replication_run(params = {}, = {}) req = build_request(:start_on_demand_replication_run, params) req.send_request() end |
#stop_app_replication(params = {}) ⇒ Struct
Stops replicating the specified application by deleting the replication job for each server in the application.
1945 1946 1947 1948 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1945 def stop_app_replication(params = {}, = {}) req = build_request(:stop_app_replication, params) req.send_request() end |
#terminate_app(params = {}) ⇒ Struct
Terminates the stack for the specified application.
1967 1968 1969 1970 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1967 def terminate_app(params = {}, = {}) req = build_request(:terminate_app, params) req.send_request() end |
#update_app(params = {}) ⇒ Types::UpdateAppResponse
Updates the specified application.
2083 2084 2085 2086 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 2083 def update_app(params = {}, = {}) req = build_request(:update_app, params) req.send_request() end |
#update_replication_job(params = {}) ⇒ Struct
Updates the specified settings for the specified replication job.
2152 2153 2154 2155 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 2152 def update_replication_job(params = {}, = {}) req = build_request(:update_replication_job, params) req.send_request() end |