aws_sms
This is the AWS Sever Migration Service API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types for the AWS Sever Migration Service (AWS SMS). The topic for each action shows the Query API request parameters and the XML response. You can also view the XML request elements in the WSDL.
Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.
To learn more about the Server Migration Service, see the following resources:
Summary
Functions
-
create_app(Client, Input)
Creates an application.
- create_app(Client, Input, Options)
-
create_replication_job(Client, Input)
Creates a replication job.
- create_replication_job(Client, Input, Options)
-
delete_app(Client, Input)
Deletes an existing application.
- delete_app(Client, Input, Options)
-
delete_app_launch_configuration(Client, Input)
Deletes existing launch configuration for an application.
- delete_app_launch_configuration(Client, Input, Options)
-
delete_app_replication_configuration(Client, Input)
Deletes existing replication configuration for an application.
- delete_app_replication_configuration(Client, Input, Options)
-
delete_replication_job(Client, Input)
Deletes the specified replication job.
- delete_replication_job(Client, Input, Options)
-
delete_server_catalog(Client, Input)
Deletes all servers from your server catalog.
- delete_server_catalog(Client, Input, Options)
-
disassociate_connector(Client, Input)
Disassociates the specified connector from AWS SMS.
- disassociate_connector(Client, Input, Options)
-
generate_change_set(Client, Input)
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_change_set(Client, Input, Options)
-
generate_template(Client, Input)
Generates an Amazon CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
- generate_template(Client, Input, Options)
-
get_app(Client, Input)
Retrieve information about an application.
- get_app(Client, Input, Options)
-
get_app_launch_configuration(Client, Input)
Retrieves the application launch configuration associated with an application.
- get_app_launch_configuration(Client, Input, Options)
-
get_app_replication_configuration(Client, Input)
Retrieves an application replication configuration associatd with an application.
- get_app_replication_configuration(Client, Input, Options)
-
get_connectors(Client, Input)
Describes the connectors registered with the AWS SMS.
- get_connectors(Client, Input, Options)
-
get_replication_jobs(Client, Input)
Describes the specified replication job or all of your replication jobs.
- get_replication_jobs(Client, Input, Options)
-
get_replication_runs(Client, Input)
Describes the replication runs for the specified replication job.
- get_replication_runs(Client, Input, Options)
-
get_servers(Client, Input)
Describes the servers in your server catalog.
- get_servers(Client, Input, Options)
-
import_server_catalog(Client, Input)
Gathers a complete list of on-premises servers.
- import_server_catalog(Client, Input, Options)
-
launch_app(Client, Input)
Launches an application stack.
- launch_app(Client, Input, Options)
-
list_apps(Client, Input)
Returns a list of summaries for all applications.
- list_apps(Client, Input, Options)
-
put_app_launch_configuration(Client, Input)
Creates a launch configuration for an application.
- put_app_launch_configuration(Client, Input, Options)
-
put_app_replication_configuration(Client, Input)
Creates or updates a replication configuration for an application.
- put_app_replication_configuration(Client, Input, Options)
-
start_app_replication(Client, Input)
Starts replicating an application.
- start_app_replication(Client, Input, Options)
-
start_on_demand_replication_run(Client, Input)
Starts an on-demand replication run for the specified replication job.
- start_on_demand_replication_run(Client, Input, Options)
-
stop_app_replication(Client, Input)
Stops replicating an application.
- stop_app_replication(Client, Input, Options)
-
terminate_app(Client, Input)
Terminates the stack for an application.
- terminate_app(Client, Input, Options)
-
update_app(Client, Input)
Updates an application.
- update_app(Client, Input, Options)
-
update_replication_job(Client, Input)
Updates the specified settings for the specified replication job.
- update_replication_job(Client, Input, Options)
Functions
create_app(Client, Input)
Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.
create_app(Client, Input, Options)
create_replication_job(Client, Input)
Creates a replication job. The replication job schedules periodic replication runs to replicate your server to AWS. Each replication run creates an Amazon Machine Image (AMI).
create_replication_job(Client, Input, Options)
delete_app(Client, Input)
Deletes an existing application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.
delete_app(Client, Input, Options)
delete_app_launch_configuration(Client, Input)
Deletes existing launch configuration for an application.
delete_app_launch_configuration(Client, Input, Options)
delete_app_replication_configuration(Client, Input)
Deletes existing replication configuration for an application.
delete_app_replication_configuration(Client, Input, Options)
delete_replication_job(Client, Input)
Deletes the specified replication job.
After you delete a replication job, there are no further replication runs. AWS deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created by the replication runs are not deleted.delete_replication_job(Client, Input, Options)
delete_server_catalog(Client, Input)
Deletes all servers from your server catalog.
delete_server_catalog(Client, Input, Options)
disassociate_connector(Client, Input)
Disassociates the specified connector from AWS SMS.
After you disassociate a connector, it is no longer available to support replication jobs.disassociate_connector(Client, Input, Options)
generate_change_set(Client, Input)
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_change_set(Client, Input, Options)
generate_template(Client, Input)
Generates an Amazon CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.
generate_template(Client, Input, Options)
get_app(Client, Input)
Retrieve information about an application.
get_app(Client, Input, Options)
get_app_launch_configuration(Client, Input)
Retrieves the application launch configuration associated with an application.
get_app_launch_configuration(Client, Input, Options)
get_app_replication_configuration(Client, Input)
Retrieves an application replication configuration associatd with an application.
get_app_replication_configuration(Client, Input, Options)
get_connectors(Client, Input)
Describes the connectors registered with the AWS SMS.
get_connectors(Client, Input, Options)
get_replication_jobs(Client, Input)
Describes the specified replication job or all of your replication jobs.
get_replication_jobs(Client, Input, Options)
get_replication_runs(Client, Input)
Describes the replication runs for the specified replication job.
get_replication_runs(Client, Input, Options)
get_servers(Client, Input)
Describes the servers in your server catalog.
Before you can describe your servers, you must import them using ImportServerCatalog.get_servers(Client, Input, Options)
import_server_catalog(Client, Input)
Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers that you want to import.
This call returns immediately, but might take additional time to retrieve all the servers.import_server_catalog(Client, Input, Options)
launch_app(Client, Input)
Launches an application stack.
launch_app(Client, Input, Options)
list_apps(Client, Input)
Returns a list of summaries for all applications.
list_apps(Client, Input, Options)
put_app_launch_configuration(Client, Input)
Creates a launch configuration for an application.
put_app_launch_configuration(Client, Input, Options)
put_app_replication_configuration(Client, Input)
Creates or updates a replication configuration for an application.
put_app_replication_configuration(Client, Input, Options)
start_app_replication(Client, Input)
Starts replicating an application.
start_app_replication(Client, Input, Options)
start_on_demand_replication_run(Client, Input)
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 you can request in a 24-hour period.start_on_demand_replication_run(Client, Input, Options)
stop_app_replication(Client, Input)
Stops replicating an application.
stop_app_replication(Client, Input, Options)
terminate_app(Client, Input)
Terminates the stack for an application.
terminate_app(Client, Input, Options)
update_app(Client, Input)
Updates an application.
update_app(Client, Input, Options)
update_replication_job(Client, Input)
Updates the specified settings for the specified replication job.