View Source aws_sms (aws v1.0.4)

Product update

We recommend Amazon Web Services Application Migration Service: http://aws.amazon.com/application-migration-service (Amazon Web Services MGN) as the primary migration service for lift-and-shift migrations.

If Amazon Web Services MGN is unavailable in a specific Amazon Web Services Region, you can use the Server Migration Service APIs through March 2023.

Server Migration Service (Server Migration Service) makes it easier and faster for you to migrate your on-premises workloads to Amazon Web Services. To learn more about Server Migration Service, see the following resources:

  • Server Migration Service product page: http://aws.amazon.com/server-migration-service/

  • Server Migration Service User Guide: https://docs.aws.amazon.com/server-migration-service/latest/userguide/

Summary

Functions

Creates an application.

Creates a replication job.

Deletes the specified application.

Deletes the launch configuration for the specified application.
Deletes the replication configuration for the specified application.
Deletes the validation configuration for the specified application.

Deletes the specified replication job.

Deletes all servers from your server catalog.

Disassociates the specified connector from Server Migration Service.

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.
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.
Retrieve information about the specified application.
Retrieves the application launch configuration associated with the specified application.
Retrieves the application replication configuration associated with the specified application.
Retrieves information about a configuration for validating an application.
Retrieves output from validating an application.
Describes the connectors registered with the Server Migration Service.
Describes the specified replication job or all of your replication jobs.
Describes the replication runs for the specified replication job.

Describes the servers in your server catalog.

Allows application import from Migration Hub.

Gathers a complete list of on-premises servers.

Launches the specified application as a stack in CloudFormation.
Retrieves summaries for all applications.
Provides information to Server Migration Service about whether application validation is successful.
Creates or updates the launch configuration for the specified application.
Creates or updates the replication configuration for the specified application.
Creates or updates a validation configuration for the specified application.
Starts replicating the specified application by creating replication jobs for each server in the application.
Starts an on-demand replication run for the specified application.

Starts an on-demand replication run for the specified replication job.

Stops replicating the specified application by deleting the replication job for each server in the application.
Terminates the stack for the specified application.
Updates the specified application.
Updates the specified settings for the specified replication job.

Functions

Link to this function

create_app(Client, Input)

View Source

Creates an application.

An application consists of one or more server groups. Each server group contain one or more servers.
Link to this function

create_app(Client, Input, Options)

View Source
Link to this function

create_replication_job(Client, Input)

View Source

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).
Link to this function

create_replication_job(Client, Input, Options)

View Source
Link to this function

delete_app(Client, Input)

View Source

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.
Link to this function

delete_app(Client, Input, Options)

View Source
Link to this function

delete_app_launch_configuration(Client, Input)

View Source
Deletes the launch configuration for the specified application.
Link to this function

delete_app_launch_configuration(Client, Input, Options)

View Source
Link to this function

delete_app_replication_configuration(Client, Input)

View Source
Deletes the replication configuration for the specified application.
Link to this function

delete_app_replication_configuration(Client, Input, Options)

View Source
Link to this function

delete_app_validation_configuration(Client, Input)

View Source
Deletes the validation configuration for the specified application.
Link to this function

delete_app_validation_configuration(Client, Input, Options)

View Source
Link to this function

delete_replication_job(Client, Input)

View Source

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.
Link to this function

delete_replication_job(Client, Input, Options)

View Source
Link to this function

delete_server_catalog(Client, Input)

View Source
Deletes all servers from your server catalog.
Link to this function

delete_server_catalog(Client, Input, Options)

View Source
Link to this function

disassociate_connector(Client, Input)

View Source

Disassociates the specified connector from Server Migration Service.

After you disassociate a connector, it is no longer available to support replication jobs.
Link to this function

disassociate_connector(Client, Input, Options)

View Source
Link to this function

generate_change_set(Client, Input)

View Source
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.
Link to this function

generate_change_set(Client, Input, Options)

View Source
Link to this function

generate_template(Client, Input)

View Source
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.
Link to this function

generate_template(Client, Input, Options)

View Source
Retrieve information about the specified application.
Link to this function

get_app(Client, Input, Options)

View Source
Link to this function

get_app_launch_configuration(Client, Input)

View Source
Retrieves the application launch configuration associated with the specified application.
Link to this function

get_app_launch_configuration(Client, Input, Options)

View Source
Link to this function

get_app_replication_configuration(Client, Input)

View Source
Retrieves the application replication configuration associated with the specified application.
Link to this function

get_app_replication_configuration(Client, Input, Options)

View Source
Link to this function

get_app_validation_configuration(Client, Input)

View Source
Retrieves information about a configuration for validating an application.
Link to this function

get_app_validation_configuration(Client, Input, Options)

View Source
Link to this function

get_app_validation_output(Client, Input)

View Source
Retrieves output from validating an application.
Link to this function

get_app_validation_output(Client, Input, Options)

View Source
Link to this function

get_connectors(Client, Input)

View Source
Describes the connectors registered with the Server Migration Service.
Link to this function

get_connectors(Client, Input, Options)

View Source
Link to this function

get_replication_jobs(Client, Input)

View Source
Describes the specified replication job or all of your replication jobs.
Link to this function

get_replication_jobs(Client, Input, Options)

View Source
Link to this function

get_replication_runs(Client, Input)

View Source
Describes the replication runs for the specified replication job.
Link to this function

get_replication_runs(Client, Input, Options)

View Source
Link to this function

get_servers(Client, Input)

View Source

Describes the servers in your server catalog.

Before you can describe your servers, you must import them using ImportServerCatalog.
Link to this function

get_servers(Client, Input, Options)

View Source
Link to this function

import_app_catalog(Client, Input)

View Source
Allows application import from Migration Hub.
Link to this function

import_app_catalog(Client, Input, Options)

View Source
Link to this function

import_server_catalog(Client, Input)

View Source

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.
Link to this function

import_server_catalog(Client, Input, Options)

View Source
Link to this function

launch_app(Client, Input)

View Source
Launches the specified application as a stack in CloudFormation.
Link to this function

launch_app(Client, Input, Options)

View Source
Link to this function

list_apps(Client, Input)

View Source
Retrieves summaries for all applications.
Link to this function

list_apps(Client, Input, Options)

View Source
Link to this function

notify_app_validation_output(Client, Input)

View Source
Provides information to Server Migration Service about whether application validation is successful.
Link to this function

notify_app_validation_output(Client, Input, Options)

View Source
Link to this function

put_app_launch_configuration(Client, Input)

View Source
Creates or updates the launch configuration for the specified application.
Link to this function

put_app_launch_configuration(Client, Input, Options)

View Source
Link to this function

put_app_replication_configuration(Client, Input)

View Source
Creates or updates the replication configuration for the specified application.
Link to this function

put_app_replication_configuration(Client, Input, Options)

View Source
Link to this function

put_app_validation_configuration(Client, Input)

View Source
Creates or updates a validation configuration for the specified application.
Link to this function

put_app_validation_configuration(Client, Input, Options)

View Source
Link to this function

start_app_replication(Client, Input)

View Source
Starts replicating the specified application by creating replication jobs for each server in the application.
Link to this function

start_app_replication(Client, Input, Options)

View Source
Link to this function

start_on_demand_app_replication(Client, Input)

View Source
Starts an on-demand replication run for the specified application.
Link to this function

start_on_demand_app_replication(Client, Input, Options)

View Source
Link to this function

start_on_demand_replication_run(Client, Input)

View Source

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.
Link to this function

start_on_demand_replication_run(Client, Input, Options)

View Source
Link to this function

stop_app_replication(Client, Input)

View Source
Stops replicating the specified application by deleting the replication job for each server in the application.
Link to this function

stop_app_replication(Client, Input, Options)

View Source
Link to this function

terminate_app(Client, Input)

View Source
Terminates the stack for the specified application.
Link to this function

terminate_app(Client, Input, Options)

View Source
Link to this function

update_app(Client, Input)

View Source
Updates the specified application.
Link to this function

update_app(Client, Input, Options)

View Source
Link to this function

update_replication_job(Client, Input)

View Source
Updates the specified settings for the specified replication job.
Link to this function

update_replication_job(Client, Input, Options)

View Source