View Source AWS.Mgn (aws-elixir v0.13.3)

The Application Migration Service service.

Link to this section Summary

Functions

Associate source servers to application.

Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER.

Creates a new Launch Configuration Template.

Creates a new ReplicationConfigurationTemplate.

Deletes a single Job by ID.

Deletes a single Launch Configuration Template by ID.

Deletes a single Replication Configuration Template by ID

Deletes a single source server by ID.

Deletes a given vCenter client by ID.

Retrieves detailed job log items with paging.

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

Retrieves all SourceServers or multiple SourceServers by ID.

Disassociate applications from wave.

Disassociate source servers from application.

Disconnects specific Source Servers from Application Migration Service.

Finalizes the cutover immediately for specific Source Servers.

Lists all LaunchConfigurations available, filtered by Source Server IDs.

Lists all ReplicationConfigurations, filtered by Source Server ID.

Initialize Application Migration Service.

Retrieves all applications or multiple applications by ID.

List source server post migration custom actions.

List all tags for your Application Migration Service resources.

List template post migration custom actions.

Retrieves all waves or multiple waves by ID.

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID.

Put source server post migration custom action.

Put template post migration custom action.

Remove source server post migration custom action.

Remove template post migration custom action.

Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started.

Launches a Cutover Instance for specific Source Servers.

Starts replication for SNAPSHOT_SHIPPING agents.

Launches a Test Instance for specific Source Servers.

Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources.

Starts a job that terminates specific launched EC2 Test and Cutover instances.

Deletes the specified set of tags from the specified set of Application Migration Service resources.

Updates multiple LaunchConfigurations by Source Server ID.

Updates an existing Launch Configuration Template by ID.

Allows you to update multiple ReplicationConfigurations by Source Server ID.

Updates multiple ReplicationConfigurationTemplates by ID.

Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.

Link to this section Functions

Link to this function

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

View Source

Archive application.

Link to this function

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

View Source

Archive wave.

Link to this function

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

View Source

Associate applications to wave.

Link to this function

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

View Source

Associate source servers to application.

Link to this function

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

View Source

Allows the user to set the SourceServer.LifeCycle.state property for specific Source Server IDs to one of the following: READY_FOR_TEST or READY_FOR_CUTOVER.

This command only works if the Source Server is already launchable (dataReplicationInfo.lagDuration is not null.)

Link to this function

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

View Source

Create application.

Link to this function

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

View Source

Creates a new Launch Configuration Template.

Link to this function

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

View Source

Creates a new ReplicationConfigurationTemplate.

Link to this function

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

View Source

Create wave.

Link to this function

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

View Source

Delete application.

Link to this function

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

View Source

Deletes a single Job by ID.

Link to this function

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

View Source

Deletes a single Launch Configuration Template by ID.

Link to this function

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

View Source

Deletes a single Replication Configuration Template by ID

Link to this function

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

View Source

Deletes a single source server by ID.

Link to this function

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

View Source

Deletes a given vCenter client by ID.

Link to this function

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

View Source

Delete wave.

Link to this function

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

View Source

Retrieves detailed job log items with paging.

Link to this function

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

View Source

Returns a list of Jobs.

Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to Support and only used in response to relevant support tickets.

Link to this function

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

View Source

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

Link to this function

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

View Source

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

Link to this function

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

View Source

Retrieves all SourceServers or multiple SourceServers by ID.

Link to this function

describe_vcenter_clients(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a list of the installed vCenter clients.

Link to this function

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

View Source

Disassociate applications from wave.

Link to this function

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

View Source

Disassociate source servers from application.

Link to this function

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

View Source

Disconnects specific Source Servers from Application Migration Service.

Data replication is stopped immediately. All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. If the agent on the source server has not been prevented from communicating with the Application Migration Service service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

Link to this function

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

View Source

Finalizes the cutover immediately for specific Source Servers.

All AWS resources created by Application Migration Service for enabling the replication of these source servers will be terminated / deleted within 90 minutes. Launched Test or Cutover instances will NOT be terminated. The AWS Replication Agent will receive a command to uninstall itself (within 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be changed to DISCONNECTED; The SourceServer.lifeCycle.state will be changed to CUTOVER; The totalStorageBytes property fo each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

Link to this function

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

View Source

Lists all LaunchConfigurations available, filtered by Source Server IDs.

Link to this function

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

View Source

Lists all ReplicationConfigurations, filtered by Source Server ID.

Link to this function

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

View Source

Initialize Application Migration Service.

Link to this function

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

View Source

Retrieves all applications or multiple applications by ID.

Link to this function

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

View Source

List export errors.

Link to this function

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

View Source

List exports.

Link to this function

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

View Source

List import errors.

Link to this function

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

View Source

List imports.

Link to this function

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

View Source

List source server post migration custom actions.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

List all tags for your Application Migration Service resources.

Link to this function

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

View Source

List template post migration custom actions.

Link to this function

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

View Source

Retrieves all waves or multiple waves by ID.

Link to this function

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

View Source

Archives specific Source Servers by setting the SourceServer.isArchived property to true for specified SourceServers by ID.

This command only works for SourceServers with a lifecycle. state which equals DISCONNECTED or CUTOVER.

Link to this function

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

View Source

Put source server post migration custom action.

Link to this function

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

View Source

Put template post migration custom action.

Link to this function

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

View Source

Remove source server post migration custom action.

Link to this function

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

View Source

Remove template post migration custom action.

Link to this function

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

View Source

Causes the data replication initiation sequence to begin immediately upon next Handshake for specified SourceServer IDs, regardless of when the previous initiation started.

This command will not work if the SourceServer is not stalled or is in a DISCONNECTED or STOPPED state.

Link to this function

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

View Source

Launches a Cutover Instance for specific Source Servers.

This command starts a LAUNCH job whose initiatedBy property is StartCutover and changes the SourceServer.lifeCycle.state property to CUTTING_OVER.

Link to this function

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

View Source

Start export.

Link to this function

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

View Source

Start import.

Link to this function

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

View Source

Starts replication for SNAPSHOT_SHIPPING agents.

Link to this function

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

View Source

Launches a Test Instance for specific Source Servers.

This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds or overwrites only the specified tags for the specified Application Migration Service resource or resources.

When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.

Link to this function

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

View Source

Starts a job that terminates specific launched EC2 Test and Cutover instances.

This command will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER.

Link to this function

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

View Source

Unarchive application.

Link to this function

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

View Source

Unarchive wave.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Deletes the specified set of tags from the specified set of Application Migration Service resources.

Link to this function

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

View Source

Update application.

Link to this function

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

View Source

Updates multiple LaunchConfigurations by Source Server ID.

Link to this function

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

View Source

Updates an existing Launch Configuration Template by ID.

Link to this function

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

View Source

Allows you to update multiple ReplicationConfigurations by Source Server ID.

Link to this function

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

View Source

Updates multiple ReplicationConfigurationTemplates by ID.

Link to this function

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

View Source

Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.

Link to this function

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

View Source

Update wave.