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.
420 421 422 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 420 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.
539 540 541 542 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 539 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).
619 620 621 622 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 619 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.
653 654 655 656 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 653 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.
675 676 677 678 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 675 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.
697 698 699 700 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 697 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.
719 720 721 722 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 719 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.
746 747 748 749 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 746 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.
759 760 761 762 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 759 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.
784 785 786 787 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 784 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.
818 819 820 821 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 818 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.
853 854 855 856 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 853 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.
920 921 922 923 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 920 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.
981 982 983 984 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 981 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.
1029 1030 1031 1032 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1029 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.
1088 1089 1090 1091 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1088 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.
1133 1134 1135 1136 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1133 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.
1182 1183 1184 1185 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1182 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.
1260 1261 1262 1263 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1260 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.
1350 1351 1352 1353 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1350 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.
1414 1415 1416 1417 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1414 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.
1443 1444 1445 1446 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1443 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.
1460 1461 1462 1463 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1460 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.
1482 1483 1484 1485 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1482 def launch_app(params = {}, = {}) req = build_request(:launch_app, params) req.send_request() end |
#list_apps(params = {}) ⇒ Types::ListAppsResponse
Retrieves summaries for all applications.
1543 1544 1545 1546 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1543 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.
1574 1575 1576 1577 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1574 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.
1656 1657 1658 1659 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1656 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.
1717 1718 1719 1720 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1717 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.
1803 1804 1805 1806 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1803 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.
1826 1827 1828 1829 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1826 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.
1852 1853 1854 1855 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1852 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.
1889 1890 1891 1892 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1889 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.
1912 1913 1914 1915 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1912 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.
1934 1935 1936 1937 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1934 def terminate_app(params = {}, = {}) req = build_request(:terminate_app, params) req.send_request() end |
#update_app(params = {}) ⇒ Types::UpdateAppResponse
Updates the specified application.
2050 2051 2052 2053 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 2050 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.
2119 2120 2121 2122 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 2119 def update_replication_job(params = {}, = {}) req = build_request(:update_replication_job, params) req.send_request() end |