aws-elixir v0.6.0 AWS.SMS View Source

AAWS Sever Migration Service

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:

  • [AWS Sever Migration Service product page](https://aws.amazon.com/server-migration-service/)
  • [AWS Sever Migration Service User Guide](https://docs.aws.amazon.com/server-migration-service/latest/userguide/server-migration.html)

Link to this section Summary

Functions

Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.

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).

Deletes an existing application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.

Deletes existing launch configuration for an application.

Deletes existing replication configuration for an application.

Deletes the specified replication job.

Deletes all servers from your server catalog.

Disassociates the specified connector from AWS SMS.

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 Amazon 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 an application.

Retrieves the application launch configuration associated with an application.

Retrieves an application replication configuration associatd with an application.

Describes the connectors registered with the AWS SMS.

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.

Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers that you want to import.

Launches an application stack.

Returns a list of summaries for all applications.

Creates a launch configuration for an application.

Creates or updates a replication configuration for an application.

Starts replicating an application.

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.

Stops replicating an application.

Terminates the stack for an application.

Updates the specified settings for the specified replication job.

Link to this section Functions

Link to this function

create_app(client, input, options \\ [])

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_replication_job(client, input, options \\ [])

View Source

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).

Link to this function

delete_app(client, input, options \\ [])

View Source

Deletes an existing application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.

Link to this function

delete_app_launch_configuration(client, input, options \\ [])

View Source

Deletes existing launch configuration for an application.

Link to this function

delete_app_replication_configuration(client, input, options \\ [])

View Source

Deletes existing replication configuration for an application.

Link to this function

delete_replication_job(client, input, options \\ [])

View Source

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.

Link to this function

delete_server_catalog(client, input, options \\ [])

View Source

Deletes all servers from your server catalog.

Link to this function

disassociate_connector(client, input, options \\ [])

View Source

Disassociates the specified connector from AWS SMS.

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

Link to this function

generate_change_set(client, input, options \\ [])

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_template(client, input, options \\ [])

View Source

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.

Link to this function

get_app(client, input, options \\ [])

View Source

Retrieve information about an application.

Link to this function

get_app_launch_configuration(client, input, options \\ [])

View Source

Retrieves the application launch configuration associated with an application.

Link to this function

get_app_replication_configuration(client, input, options \\ [])

View Source

Retrieves an application replication configuration associatd with an application.

Link to this function

get_connectors(client, input, options \\ [])

View Source

Describes the connectors registered with the AWS SMS.

Link to this function

get_replication_jobs(client, input, options \\ [])

View Source

Describes the specified replication job or all of your replication jobs.

Link to this function

get_replication_runs(client, input, options \\ [])

View Source

Describes the replication runs for the specified replication job.

Link to this function

get_servers(client, input, options \\ [])

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

import_server_catalog(client, input, options \\ [])

View Source

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.

Link to this function

launch_app(client, input, options \\ [])

View Source

Launches an application stack.

Link to this function

list_apps(client, input, options \\ [])

View Source

Returns a list of summaries for all applications.

Link to this function

put_app_launch_configuration(client, input, options \\ [])

View Source

Creates a launch configuration for an application.

Link to this function

put_app_replication_configuration(client, input, options \\ [])

View Source

Creates or updates a replication configuration for an application.

Link to this function

start_app_replication(client, input, options \\ [])

View Source

Starts replicating an application.

Link to this function

start_on_demand_replication_run(client, input, options \\ [])

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 you can request in a 24-hour period.

Link to this function

stop_app_replication(client, input, options \\ [])

View Source

Stops replicating an application.

Link to this function

terminate_app(client, input, options \\ [])

View Source

Terminates the stack for an application.

Link to this function

update_app(client, input, options \\ [])

View Source

Updates an application.

Link to this function

update_replication_job(client, input, options \\ [])

View Source

Updates the specified settings for the specified replication job.