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.
419 420 421 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 419 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.
538 539 540 541 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 538 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).
618 619 620 621 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 618 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.
652 653 654 655 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 652 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.
674 675 676 677 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 674 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.
696 697 698 699 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 696 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.
718 719 720 721 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 718 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.
745 746 747 748 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 745 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.
758 759 760 761 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 758 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.
783 784 785 786 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 783 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.
817 818 819 820 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 817 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.
852 853 854 855 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 852 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.
919 920 921 922 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 919 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.
980 981 982 983 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 980 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.
1028 1029 1030 1031 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1028 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.
1087 1088 1089 1090 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1087 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.
1132 1133 1134 1135 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1132 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.
1181 1182 1183 1184 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1181 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.
1259 1260 1261 1262 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1259 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.
1349 1350 1351 1352 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1349 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.
1413 1414 1415 1416 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1413 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.
1442 1443 1444 1445 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1442 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.
1459 1460 1461 1462 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1459 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.
1481 1482 1483 1484 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1481 def launch_app(params = {}, = {}) req = build_request(:launch_app, params) req.send_request() end |
#list_apps(params = {}) ⇒ Types::ListAppsResponse
Retrieves summaries for all applications.
1542 1543 1544 1545 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1542 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.
1573 1574 1575 1576 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1573 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.
1655 1656 1657 1658 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1655 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.
1716 1717 1718 1719 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1716 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.
1802 1803 1804 1805 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1802 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.
1825 1826 1827 1828 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1825 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.
1851 1852 1853 1854 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1851 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.
1888 1889 1890 1891 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1888 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.
1911 1912 1913 1914 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1911 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.
1933 1934 1935 1936 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 1933 def terminate_app(params = {}, = {}) req = build_request(:terminate_app, params) req.send_request() end |
#update_app(params = {}) ⇒ Types::UpdateAppResponse
Updates the specified application.
2049 2050 2051 2052 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 2049 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.
2118 2119 2120 2121 |
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/client.rb', line 2118 def update_replication_job(params = {}, = {}) req = build_request(:update_replication_job, params) req.send_request() end |