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.
395 396 397 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 395 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.
514 515 516 517 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 514 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).
594 595 596 597 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 594 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.
628 629 630 631 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 628 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.
650 651 652 653 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 650 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.
672 673 674 675 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 672 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.
694 695 696 697 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 694 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.
721 722 723 724 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 721 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.
734 735 736 737 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 734 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.
759 760 761 762 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 759 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.
793 794 795 796 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 793 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.
828 829 830 831 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 828 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.
895 896 897 898 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 895 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.
956 957 958 959 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 956 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.
1004 1005 1006 1007 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1004 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.
1063 1064 1065 1066 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1063 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.
1108 1109 1110 1111 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1108 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.
1157 1158 1159 1160 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1157 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.
1235 1236 1237 1238 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1235 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.
1325 1326 1327 1328 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1325 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.
1389 1390 1391 1392 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1389 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.
1418 1419 1420 1421 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1418 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.
1435 1436 1437 1438 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1435 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.
1457 1458 1459 1460 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1457 def launch_app(params = {}, = {}) req = build_request(:launch_app, params) req.send_request() end |
#list_apps(params = {}) ⇒ Types::ListAppsResponse
Retrieves summaries for all applications.
1518 1519 1520 1521 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1518 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.
1549 1550 1551 1552 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1549 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.
1631 1632 1633 1634 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1631 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.
1692 1693 1694 1695 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1692 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.
1778 1779 1780 1781 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1778 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.
1801 1802 1803 1804 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1801 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.
1827 1828 1829 1830 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1827 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.
1864 1865 1866 1867 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1864 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.
1887 1888 1889 1890 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1887 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.
1909 1910 1911 1912 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1909 def terminate_app(params = {}, = {}) req = build_request(:terminate_app, params) req.send_request() end |
#update_app(params = {}) ⇒ Types::UpdateAppResponse
Updates the specified application.
2025 2026 2027 2028 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 2025 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.
2094 2095 2096 2097 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 2094 def update_replication_job(params = {}, = {}) req = build_request(:update_replication_job, params) req.send_request() end |