Table of Contents
mgn.Client¶A low-level client representing Application Migration Service (mgn)
The Application Migration Service service.
import boto3
client = boto3.client('mgn')
These are the available methods:
can_paginate()change_server_life_cycle_state()close()create_launch_configuration_template()create_replication_configuration_template()delete_job()delete_launch_configuration_template()delete_replication_configuration_template()delete_source_server()delete_vcenter_client()describe_job_log_items()describe_jobs()describe_launch_configuration_templates()describe_replication_configuration_templates()describe_source_servers()describe_vcenter_clients()disconnect_from_service()finalize_cutover()get_launch_configuration()get_paginator()get_replication_configuration()get_waiter()initialize_service()list_tags_for_resource()mark_as_archived()retry_data_replication()start_cutover()start_replication()start_test()tag_resource()terminate_target_instances()untag_resource()update_launch_configuration()update_launch_configuration_template()update_replication_configuration()update_replication_configuration_template()update_source_server_replication_type()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.change_server_life_cycle_state(**kwargs)¶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.)
See also: AWS API Documentation
Request Syntax
response = client.change_server_life_cycle_state(
lifeCycle={
'state': 'READY_FOR_TEST'|'READY_FOR_CUTOVER'|'CUTOVER'
},
sourceServerID='string'
)
[REQUIRED]
The request to change the source server migration lifecycle state.
The request to change the source server migration lifecycle state.
[REQUIRED]
The request to change the source server migration lifecycle state by source server ID.
dict
Response Syntax
{
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
}
Response Structure
(dict) --
arn (string) --
Source server ARN.
dataReplicationInfo (dict) --
Source server data replication info.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
nextAttemptDateTime (string) --
Request to query next data initiation date and time.
startDateTime (string) --
Request to query data initiation start date and time.
steps (list) --
Request to query data initiation steps.
(dict) --
Data replication initiation step.
name (string) --
Request to query data initiation step name.
status (string) --
Request to query data initiation status.
dataReplicationState (string) --
Request to query the data replication state.
etaDateTime (string) --
Request to query the time when data replication will be complete.
lagDuration (string) --
Request to query data replication lag duration.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
deviceName (string) --
Request to query device name.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
isArchived (boolean) --
Source server archived status.
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
firstBoot (string) --
Launched instance first boot.
jobID (string) --
Launched instance Job ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
lastCutover (dict) --
Lifecycle last Cutover.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
initiated (dict) --
Lifecycle last Cutover initiated.
apiCallDateTime (string) --
jobID (string) --
Lifecycle last Cutover initiated by Job ID.
reverted (dict) --
Lifecycle last Cutover reverted.
apiCallDateTime (string) --
Lifecycle last Cutover reverted API call date time.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
initiated (dict) --
Lifecycle last Test initiated.
apiCallDateTime (string) --
Lifecycle last Test initiated API call date and time.
jobID (string) --
Lifecycle last Test initiated Job ID.
reverted (dict) --
Lifecycle last Test reverted.
apiCallDateTime (string) --
Lifecycle last Test reverted API call date and time.
state (string) --
Lifecycle state.
replicationType (string) --
Source server replication type.
sourceProperties (dict) --
Source server properties.
cpus (list) --
Source Server CPUs.
(dict) --
Source server CPU information.
cores (integer) --
The number of CPU cores on the source server.
modelName (string) --
The source server's CPU model name.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
bytes (integer) --
The amount of storage on the disk in bytes.
deviceName (string) --
The disk or device name.
identificationHints (dict) --
Source server identification hints.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmPath (string) --
vCenter VM path identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
lastUpdatedDateTime (string) --
Source server last update date and time.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
isPrimary (boolean) --
Network interface primary IP.
macAddress (string) --
Network interface Mac address.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
ramBytes (integer) --
Source server RAM in bytes.
recommendedInstanceType (string) --
Source server recommended instance type.
sourceServerID (string) --
Source server ID.
tags (dict) --
Source server Tags.
vcenterClientID (string) --
Source server vCenter client id.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.ConflictExceptionclose()¶Closes underlying endpoint connections.
create_launch_configuration_template(**kwargs)¶Creates a new ReplicationConfigurationTemplate.
See also: AWS API Documentation
Request Syntax
response = client.create_launch_configuration_template(
postLaunchActions={
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
tags={
'string': 'string'
}
)
Request to associate the default Application Migration Service Security group with the Replication Settings template.
Server participating in Job.
Server participating in Job.
Server participating in Job.
Server participating in Job.
Server participating in Job.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Request to associate the default Application Migration Service Security group with the Replication Settings template.
dict
Response Syntax
{
'arn': 'string',
'launchConfigurationTemplateID': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
Copy Private IP during Launch Configuration.
launchConfigurationTemplateID (string) --
Copy Private IP during Launch Configuration.
postLaunchActions (dict) --
Copy Private IP during Launch Configuration.
cloudWatchLogGroupName (string) --
Server participating in Job.
deployment (string) --
Server participating in Job.
s3LogBucket (string) --
Server participating in Job.
s3OutputKeyPrefix (string) --
Server participating in Job.
ssmDocuments (list) --
Server participating in Job.
(dict) --
Source server replication type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
tags (dict) --
Copy Private IP during Launch Configuration.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.AccessDeniedExceptioncreate_replication_configuration_template(**kwargs)¶Creates a new ReplicationConfigurationTemplate.
See also: AWS API Documentation
Request Syntax
response = client.create_replication_configuration_template(
associateDefaultSecurityGroup=True|False,
bandwidthThrottling=123,
createPublicIP=True|False,
dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP',
defaultLargeStagingDiskType='GP2'|'ST1'|'GP3',
ebsEncryption='DEFAULT'|'CUSTOM',
ebsEncryptionKeyArn='string',
replicationServerInstanceType='string',
replicationServersSecurityGroupsIDs=[
'string',
],
stagingAreaSubnetId='string',
stagingAreaTags={
'string': 'string'
},
tags={
'string': 'string'
},
useDedicatedReplicationServer=True|False
)
[REQUIRED]
Request to associate the default Application Migration Service Security group with the Replication Settings template.
[REQUIRED]
Request to configure bandwidth throttling during Replication Settings template creation.
[REQUIRED]
Request to create Public IP during Replication Settings template creation.
[REQUIRED]
Request to configure data plane routing during Replication Settings template creation.
[REQUIRED]
Request to configure the default large staging disk EBS volume type during Replication Settings template creation.
[REQUIRED]
Request to configure EBS encryption during Replication Settings template creation.
[REQUIRED]
Request to configure the Replication Server instance type during Replication Settings template creation.
[REQUIRED]
Request to configure the Replication Server Security group ID during Replication Settings template creation.
[REQUIRED]
Request to configure the Staging Area subnet ID during Replication Settings template creation.
[REQUIRED]
Request to configure Staging Area tags during Replication Settings template creation.
Request to configure tags during Replication Settings template creation.
[REQUIRED]
Request to use Dedicated Replication Servers during Replication Settings template creation.
dict
Response Syntax
{
'arn': 'string',
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'replicationConfigurationTemplateID': 'string',
'replicationServerInstanceType': 'string',
'replicationServersSecurityGroupsIDs': [
'string',
],
'stagingAreaSubnetId': 'string',
'stagingAreaTags': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'useDedicatedReplicationServer': True|False
}
Response Structure
(dict) --
arn (string) --
Replication Configuration template ARN.
associateDefaultSecurityGroup (boolean) --
Replication Configuration template associate default Application Migration Service Security group.
bandwidthThrottling (integer) --
Replication Configuration template bandwidth throttling.
createPublicIP (boolean) --
Replication Configuration template create Public IP.
dataPlaneRouting (string) --
Replication Configuration template data plane routing.
defaultLargeStagingDiskType (string) --
Replication Configuration template use default large Staging Disk type.
ebsEncryption (string) --
Replication Configuration template EBS encryption.
ebsEncryptionKeyArn (string) --
Replication Configuration template EBS encryption key ARN.
replicationConfigurationTemplateID (string) --
Replication Configuration template ID.
replicationServerInstanceType (string) --
Replication Configuration template server instance type.
replicationServersSecurityGroupsIDs (list) --
Replication Configuration template server Security Groups IDs.
stagingAreaSubnetId (string) --
Replication Configuration template Staging Area subnet ID.
stagingAreaTags (dict) --
Replication Configuration template Staging Area Tags.
tags (dict) --
Replication Configuration template Tags.
useDedicatedReplicationServer (boolean) --
Replication Configuration template use Dedicated Replication Server.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.AccessDeniedExceptiondelete_job(**kwargs)¶Deletes a single Job by ID.
See also: AWS API Documentation
Request Syntax
response = client.delete_job(
jobID='string'
)
[REQUIRED]
Request to delete Job from service by Job ID.
{}
Response Structure
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ConflictExceptiondelete_launch_configuration_template(**kwargs)¶Creates a new ReplicationConfigurationTemplate.
See also: AWS API Documentation
Request Syntax
response = client.delete_launch_configuration_template(
launchConfigurationTemplateID='string'
)
[REQUIRED]
ID of resource to be deleted.
{}
Response Structure
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ConflictExceptiondelete_replication_configuration_template(**kwargs)¶Deletes a single Replication Configuration Template by ID
See also: AWS API Documentation
Request Syntax
response = client.delete_replication_configuration_template(
replicationConfigurationTemplateID='string'
)
[REQUIRED]
Request to delete Replication Configuration Template from service by Replication Configuration Template ID.
{}
Response Structure
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ConflictExceptiondelete_source_server(**kwargs)¶Deletes a single source server by ID.
See also: AWS API Documentation
Request Syntax
response = client.delete_source_server(
sourceServerID='string'
)
[REQUIRED]
Request to delete Source Server from service by Server ID.
{}
Response Structure
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ConflictExceptiondelete_vcenter_client(**kwargs)¶Deletes a given vCenter client by ID.
See also: AWS API Documentation
Request Syntax
response = client.delete_vcenter_client(
vcenterClientID='string'
)
[REQUIRED]
ID of resource to be deleted.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ValidationExceptiondescribe_job_log_items(**kwargs)¶Retrieves detailed job log items with paging.
See also: AWS API Documentation
Request Syntax
response = client.describe_job_log_items(
jobID='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
Request to describe Job log job ID.
dict
Response Syntax
{
'items': [
{
'event': 'JOB_START'|'SERVER_SKIPPED'|'CLEANUP_START'|'CLEANUP_END'|'CLEANUP_FAIL'|'SNAPSHOT_START'|'SNAPSHOT_END'|'SNAPSHOT_FAIL'|'USING_PREVIOUS_SNAPSHOT'|'CONVERSION_START'|'CONVERSION_END'|'CONVERSION_FAIL'|'LAUNCH_START'|'LAUNCH_FAILED'|'JOB_CANCEL'|'JOB_END',
'eventData': {
'conversionServerID': 'string',
'rawError': 'string',
'sourceServerID': 'string',
'targetInstanceID': 'string'
},
'logDateTime': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to describe Job log response items.
(dict) --
Job log.
event (string) --
Job log event.
eventData (dict) --
Job event data
conversionServerID (string) --
Job Event conversion Server ID.
rawError (string) --
Job error.
sourceServerID (string) --
Job Event Source Server ID.
targetInstanceID (string) --
Job Event Target instance ID.
logDateTime (string) --
Job log event date and time.
nextToken (string) --
Request to describe Job log response next token.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ValidationExceptiondescribe_jobs(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_jobs(
filters={
'fromDate': 'string',
'jobIDs': [
'string',
],
'toDate': 'string'
},
maxResults=123,
nextToken='string'
)
Request to describe Job log filters.
Request to describe Job log filters by date.
Request to describe Job log filters by job ID.
Request to describe job log items by last date.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'postLaunchActionsLaunchStatusList': [
{
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string',
'ssmDocument': {
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND'
},
],
'ssmAgentDiscoveryDatetime': 'string'
},
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to describe Job log items.
(dict) --
Job.
arn (string) --
the ARN of the specific Job.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
initiatedBy (string) --
Job initiated by field.
jobID (string) --
Job ID.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server Source Server ID.
postLaunchActionsStatus (dict) --
Participating server Source Server ID.
postLaunchActionsLaunchStatusList (list) --
Server participating in Job.
(dict) --
Job type.
executionID (string) --
Job type.
executionStatus (string) --
Job type.
failureReason (string) --
Job type.
ssmDocument (dict) --
Job type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
ssmDocumentType (string) --
Job type.
ssmAgentDiscoveryDatetime (string) --
Server participating in Job.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
type (string) --
Job type.
nextToken (string) --
Request to describe Job response by next token.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ValidationExceptiondescribe_launch_configuration_templates(**kwargs)¶Creates a new ReplicationConfigurationTemplate.
See also: AWS API Documentation
Request Syntax
response = client.describe_launch_configuration_templates(
launchConfigurationTemplateIDs=[
'string',
],
maxResults=123,
nextToken='string'
)
Request to disconnect Source Server from service by Server ID.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'launchConfigurationTemplateID': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to disconnect Source Server from service by Server ID.
(dict) --
arn (string) --
Copy Private IP during Launch Configuration.
launchConfigurationTemplateID (string) --
Copy Private IP during Launch Configuration.
postLaunchActions (dict) --
Copy Private IP during Launch Configuration.
cloudWatchLogGroupName (string) --
Server participating in Job.
deployment (string) --
Server participating in Job.
s3LogBucket (string) --
Server participating in Job.
s3OutputKeyPrefix (string) --
Server participating in Job.
ssmDocuments (list) --
Server participating in Job.
(dict) --
Source server replication type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
tags (dict) --
Copy Private IP during Launch Configuration.
nextToken (string) --
Request to disconnect Source Server from service by Server ID.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ValidationExceptiondescribe_replication_configuration_templates(**kwargs)¶Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
See also: AWS API Documentation
Request Syntax
response = client.describe_replication_configuration_templates(
maxResults=123,
nextToken='string',
replicationConfigurationTemplateIDs=[
'string',
]
)
Request to describe Replication Configuration template by template IDs.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'replicationConfigurationTemplateID': 'string',
'replicationServerInstanceType': 'string',
'replicationServersSecurityGroupsIDs': [
'string',
],
'stagingAreaSubnetId': 'string',
'stagingAreaTags': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'useDedicatedReplicationServer': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to describe Replication Configuration template by items.
(dict) --
arn (string) --
Replication Configuration template ARN.
associateDefaultSecurityGroup (boolean) --
Replication Configuration template associate default Application Migration Service Security group.
bandwidthThrottling (integer) --
Replication Configuration template bandwidth throttling.
createPublicIP (boolean) --
Replication Configuration template create Public IP.
dataPlaneRouting (string) --
Replication Configuration template data plane routing.
defaultLargeStagingDiskType (string) --
Replication Configuration template use default large Staging Disk type.
ebsEncryption (string) --
Replication Configuration template EBS encryption.
ebsEncryptionKeyArn (string) --
Replication Configuration template EBS encryption key ARN.
replicationConfigurationTemplateID (string) --
Replication Configuration template ID.
replicationServerInstanceType (string) --
Replication Configuration template server instance type.
replicationServersSecurityGroupsIDs (list) --
Replication Configuration template server Security Groups IDs.
stagingAreaSubnetId (string) --
Replication Configuration template Staging Area subnet ID.
stagingAreaTags (dict) --
Replication Configuration template Staging Area Tags.
tags (dict) --
Replication Configuration template Tags.
useDedicatedReplicationServer (boolean) --
Replication Configuration template use Dedicated Replication Server.
nextToken (string) --
Request to describe Replication Configuration template by next token.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ValidationExceptiondescribe_source_servers(**kwargs)¶Retrieves all SourceServers or multiple SourceServers by ID.
See also: AWS API Documentation
Request Syntax
response = client.describe_source_servers(
filters={
'isArchived': True|False,
'lifeCycleStates': [
'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED',
],
'replicationTypes': [
'AGENT_BASED'|'SNAPSHOT_SHIPPING',
],
'sourceServerIDs': [
'string',
]
},
maxResults=123,
nextToken='string'
)
Request to filter Source Servers list.
Request to filter Source Servers list by archived.
Request to filter Source Servers list by life cycle states.
Request to filter Source Servers list by replication type.
Request to filter Source Servers list by Source Server ID.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to filter Source Servers list by item.
(dict) --
arn (string) --
Source server ARN.
dataReplicationInfo (dict) --
Source server data replication info.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
nextAttemptDateTime (string) --
Request to query next data initiation date and time.
startDateTime (string) --
Request to query data initiation start date and time.
steps (list) --
Request to query data initiation steps.
(dict) --
Data replication initiation step.
name (string) --
Request to query data initiation step name.
status (string) --
Request to query data initiation status.
dataReplicationState (string) --
Request to query the data replication state.
etaDateTime (string) --
Request to query the time when data replication will be complete.
lagDuration (string) --
Request to query data replication lag duration.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
deviceName (string) --
Request to query device name.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
isArchived (boolean) --
Source server archived status.
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
firstBoot (string) --
Launched instance first boot.
jobID (string) --
Launched instance Job ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
lastCutover (dict) --
Lifecycle last Cutover.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
initiated (dict) --
Lifecycle last Cutover initiated.
apiCallDateTime (string) --
jobID (string) --
Lifecycle last Cutover initiated by Job ID.
reverted (dict) --
Lifecycle last Cutover reverted.
apiCallDateTime (string) --
Lifecycle last Cutover reverted API call date time.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
initiated (dict) --
Lifecycle last Test initiated.
apiCallDateTime (string) --
Lifecycle last Test initiated API call date and time.
jobID (string) --
Lifecycle last Test initiated Job ID.
reverted (dict) --
Lifecycle last Test reverted.
apiCallDateTime (string) --
Lifecycle last Test reverted API call date and time.
state (string) --
Lifecycle state.
replicationType (string) --
Source server replication type.
sourceProperties (dict) --
Source server properties.
cpus (list) --
Source Server CPUs.
(dict) --
Source server CPU information.
cores (integer) --
The number of CPU cores on the source server.
modelName (string) --
The source server's CPU model name.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
bytes (integer) --
The amount of storage on the disk in bytes.
deviceName (string) --
The disk or device name.
identificationHints (dict) --
Source server identification hints.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmPath (string) --
vCenter VM path identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
lastUpdatedDateTime (string) --
Source server last update date and time.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
isPrimary (boolean) --
Network interface primary IP.
macAddress (string) --
Network interface Mac address.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
ramBytes (integer) --
Source server RAM in bytes.
recommendedInstanceType (string) --
Source server recommended instance type.
sourceServerID (string) --
Source server ID.
tags (dict) --
Source server Tags.
vcenterClientID (string) --
Source server vCenter client id.
nextToken (string) --
Request to filter Source Servers next token.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ValidationExceptiondescribe_vcenter_clients(**kwargs)¶Returns a list of the installed vCenter clients.
See also: AWS API Documentation
Request Syntax
response = client.describe_vcenter_clients(
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'datacenterName': 'string',
'hostname': 'string',
'lastSeenDatetime': 'string',
'sourceServerTags': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'vcenterClientID': 'string',
'vcenterUUID': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
List of items returned by DescribeVcenterClients.
(dict) --
vCenter client.
arn (string) --
Arn of vCenter client.
datacenterName (string) --
Datacenter name of vCenter client.
hostname (string) --
Hostname of vCenter client .
lastSeenDatetime (string) --
Last seen time of vCenter client.
sourceServerTags (dict) --
Tags for Source Server of vCenter client.
tags (dict) --
Tags for vCenter client.
vcenterClientID (string) --
ID of vCenter client.
vcenterUUID (string) --
Vcenter UUID of vCenter client.
nextToken (string) --
Next pagination token returned from DescribeVcenterClients.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ValidationExceptiondisconnect_from_service(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.disconnect_from_service(
sourceServerID='string'
)
[REQUIRED]
Request to disconnect Source Server from service by Server ID.
{
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
}
Response Structure
Source server ARN.
Source server data replication info.
Error in obtaining data replication info.
Error in data replication.
Error in data replication.
Request to query whether data replication has been initiated.
Request to query next data initiation date and time.
Request to query data initiation start date and time.
Request to query data initiation steps.
Data replication initiation step.
Request to query data initiation step name.
Request to query data initiation status.
Request to query the data replication state.
Request to query the time when data replication will be complete.
Request to query data replication lag duration.
Request to query data replication last snapshot time.
Request to query disks replicated.
Request to query disks replicated.
Request to query data replication backlog size in bytes.
Request to query device name.
Request to query amount of data replicated in bytes.
Request to query amount of data rescanned in bytes.
Request to query total amount of data replicated in bytes.
Source server archived status.
Source server launched instance.
Launched instance EC2 ID.
Launched instance first boot.
Launched instance Job ID.
Source server lifecycle state.
Lifecycle added to service data and time.
Lifecycle elapsed time and duration.
Lifecycle replication initiation date and time.
Lifecycle last Cutover.
Lifecycle Cutover finalized date and time.
Lifecycle Cutover finalized date and time.
Lifecycle last Cutover initiated.
Lifecycle last Cutover initiated by Job ID.
Lifecycle last Cutover reverted.
Lifecycle last Cutover reverted API call date time.
Lifecycle last seen date and time.
Lifecycle last Test.
Lifecycle last Test finalized.
Lifecycle Test failed API call date and time.
Lifecycle last Test initiated.
Lifecycle last Test initiated API call date and time.
Lifecycle last Test initiated Job ID.
Lifecycle last Test reverted.
Lifecycle last Test reverted API call date and time.
Lifecycle state.
Source server replication type.
Source server properties.
Source Server CPUs.
Source server CPU information.
The number of CPU cores on the source server.
The source server's CPU model name.
Source Server disks.
The disk identifier.
The amount of storage on the disk in bytes.
The disk or device name.
Source server identification hints.
AWS Instance ID identification hint.
FQDN address identification hint.
Hostname identification hint.
vCenter VM path identification hint.
vmWare UUID identification hint.
Source server last update date and time.
Source server network interfaces.
Network interface.
Network interface IPs.
Network interface primary IP.
Network interface Mac address.
Source server OS.
OS full string.
Source server RAM in bytes.
Source server recommended instance type.
Source server ID.
Source server Tags.
Source server vCenter client id.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ConflictExceptionfinalize_cutover(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.finalize_cutover(
sourceServerID='string'
)
[REQUIRED]
Request to finalize Cutover by Source Server ID.
{
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
}
Response Structure
Source server ARN.
Source server data replication info.
Error in obtaining data replication info.
Error in data replication.
Error in data replication.
Request to query whether data replication has been initiated.
Request to query next data initiation date and time.
Request to query data initiation start date and time.
Request to query data initiation steps.
Data replication initiation step.
Request to query data initiation step name.
Request to query data initiation status.
Request to query the data replication state.
Request to query the time when data replication will be complete.
Request to query data replication lag duration.
Request to query data replication last snapshot time.
Request to query disks replicated.
Request to query disks replicated.
Request to query data replication backlog size in bytes.
Request to query device name.
Request to query amount of data replicated in bytes.
Request to query amount of data rescanned in bytes.
Request to query total amount of data replicated in bytes.
Source server archived status.
Source server launched instance.
Launched instance EC2 ID.
Launched instance first boot.
Launched instance Job ID.
Source server lifecycle state.
Lifecycle added to service data and time.
Lifecycle elapsed time and duration.
Lifecycle replication initiation date and time.
Lifecycle last Cutover.
Lifecycle Cutover finalized date and time.
Lifecycle Cutover finalized date and time.
Lifecycle last Cutover initiated.
Lifecycle last Cutover initiated by Job ID.
Lifecycle last Cutover reverted.
Lifecycle last Cutover reverted API call date time.
Lifecycle last seen date and time.
Lifecycle last Test.
Lifecycle last Test finalized.
Lifecycle Test failed API call date and time.
Lifecycle last Test initiated.
Lifecycle last Test initiated API call date and time.
Lifecycle last Test initiated Job ID.
Lifecycle last Test reverted.
Lifecycle last Test reverted API call date and time.
Lifecycle state.
Source server replication type.
Source server properties.
Source Server CPUs.
Source server CPU information.
The number of CPU cores on the source server.
The source server's CPU model name.
Source Server disks.
The disk identifier.
The amount of storage on the disk in bytes.
The disk or device name.
Source server identification hints.
AWS Instance ID identification hint.
FQDN address identification hint.
Hostname identification hint.
vCenter VM path identification hint.
vmWare UUID identification hint.
Source server last update date and time.
Source server network interfaces.
Network interface.
Network interface IPs.
Network interface primary IP.
Network interface Mac address.
Source server OS.
OS full string.
Source server RAM in bytes.
Source server recommended instance type.
Source server ID.
Source server Tags.
Source server vCenter client id.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.ConflictExceptionget_launch_configuration(**kwargs)¶Lists all LaunchConfigurations available, filtered by Source Server IDs.
See also: AWS API Documentation
Request Syntax
response = client.get_launch_configuration(
sourceServerID='string'
)
[REQUIRED]
Request to get Launch Configuration information by Source Server ID.
{
'bootMode': 'LEGACY_BIOS'|'UEFI',
'copyPrivateIp': True|False,
'copyTags': True|False,
'ec2LaunchTemplateID': 'string',
'launchDisposition': 'STOPPED'|'STARTED',
'licensing': {
'osByol': True|False
},
'name': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'sourceServerID': 'string',
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'
}
Response Structure
Launch configuration boot mode.
Copy Private IP during Launch Configuration.
Copy Tags during Launch Configuration.
Launch configuration EC2 Launch template ID.
Launch disposition for launch configuration.
Launch configuration OS licensing.
Configure BYOL OS licensing.
Launch configuration name.
Server participating in Job.
Server participating in Job.
Server participating in Job.
Server participating in Job.
Server participating in Job.
Server participating in Job.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Launch configuration Source Server ID.
Launch configuration Target instance type right sizing method.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_replication_configuration(**kwargs)¶Lists all ReplicationConfigurations, filtered by Source Server ID.
See also: AWS API Documentation
Request Syntax
response = client.get_replication_configuration(
sourceServerID='string'
)
[REQUIRED]
Request to get Replication Configuration by Source Server ID.
{
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'name': 'string',
'replicatedDisks': [
{
'deviceName': 'string',
'iops': 123,
'isBootDisk': True|False,
'stagingDiskType': 'AUTO'|'GP2'|'IO1'|'SC1'|'ST1'|'STANDARD'|'GP3'|'IO2',
'throughput': 123
},
],
'replicationServerInstanceType': 'string',
'replicationServersSecurityGroupsIDs': [
'string',
],
'sourceServerID': 'string',
'stagingAreaSubnetId': 'string',
'stagingAreaTags': {
'string': 'string'
},
'useDedicatedReplicationServer': True|False
}
Response Structure
Replication Configuration associate default Application Migration Service Security Group.
Replication Configuration set bandwidth throttling.
Replication Configuration create Public IP.
Replication Configuration data plane routing.
Replication Configuration use default large Staging Disks.
Replication Configuration EBS encryption.
Replication Configuration EBS encryption key ARN.
Replication Configuration name.
Replication Configuration replicated disks.
Replication Configuration replicated disk.
Replication Configuration replicated disk device name.
Replication Configuration replicated disk IOPs.
Replication Configuration replicated disk boot disk.
Replication Configuration replicated disk staging disk type.
Replication Configuration replicated disk throughput.
Replication Configuration Replication Server instance type.
Replication Configuration Replication Server Security Group IDs.
Replication Configuration Source Server ID.
Replication Configuration Staging Area subnet ID.
Replication Configuration Staging Area tags.
Replication Configuration use Dedicated Replication Server.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
initialize_service()¶Initialize Application Migration Service.
See also: AWS API Documentation
Request Syntax
response = client.initialize_service()
{}
Response Structure
Exceptions
mgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.AccessDeniedExceptionList all tags for your Application Migration Service resources.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
List tags for resource request by ARN.
{
'tags': {
'string': 'string'
}
}
Response Structure
List tags for resource response.
Exceptions
mgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ThrottlingExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.AccessDeniedExceptionmgn.Client.exceptions.InternalServerExceptionmark_as_archived(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.mark_as_archived(
sourceServerID='string'
)
[REQUIRED]
Mark as archived by Source Server ID.
{
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
}
Response Structure
Source server ARN.
Source server data replication info.
Error in obtaining data replication info.
Error in data replication.
Error in data replication.
Request to query whether data replication has been initiated.
Request to query next data initiation date and time.
Request to query data initiation start date and time.
Request to query data initiation steps.
Data replication initiation step.
Request to query data initiation step name.
Request to query data initiation status.
Request to query the data replication state.
Request to query the time when data replication will be complete.
Request to query data replication lag duration.
Request to query data replication last snapshot time.
Request to query disks replicated.
Request to query disks replicated.
Request to query data replication backlog size in bytes.
Request to query device name.
Request to query amount of data replicated in bytes.
Request to query amount of data rescanned in bytes.
Request to query total amount of data replicated in bytes.
Source server archived status.
Source server launched instance.
Launched instance EC2 ID.
Launched instance first boot.
Launched instance Job ID.
Source server lifecycle state.
Lifecycle added to service data and time.
Lifecycle elapsed time and duration.
Lifecycle replication initiation date and time.
Lifecycle last Cutover.
Lifecycle Cutover finalized date and time.
Lifecycle Cutover finalized date and time.
Lifecycle last Cutover initiated.
Lifecycle last Cutover initiated by Job ID.
Lifecycle last Cutover reverted.
Lifecycle last Cutover reverted API call date time.
Lifecycle last seen date and time.
Lifecycle last Test.
Lifecycle last Test finalized.
Lifecycle Test failed API call date and time.
Lifecycle last Test initiated.
Lifecycle last Test initiated API call date and time.
Lifecycle last Test initiated Job ID.
Lifecycle last Test reverted.
Lifecycle last Test reverted API call date and time.
Lifecycle state.
Source server replication type.
Source server properties.
Source Server CPUs.
Source server CPU information.
The number of CPU cores on the source server.
The source server's CPU model name.
Source Server disks.
The disk identifier.
The amount of storage on the disk in bytes.
The disk or device name.
Source server identification hints.
AWS Instance ID identification hint.
FQDN address identification hint.
Hostname identification hint.
vCenter VM path identification hint.
vmWare UUID identification hint.
Source server last update date and time.
Source server network interfaces.
Network interface.
Network interface IPs.
Network interface primary IP.
Network interface Mac address.
Source server OS.
OS full string.
Source server RAM in bytes.
Source server recommended instance type.
Source server ID.
Source server Tags.
Source server vCenter client id.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ConflictExceptionretry_data_replication(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.retry_data_replication(
sourceServerID='string'
)
[REQUIRED]
Retry data replication for Source Server ID.
{
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
}
Response Structure
Source server ARN.
Source server data replication info.
Error in obtaining data replication info.
Error in data replication.
Error in data replication.
Request to query whether data replication has been initiated.
Request to query next data initiation date and time.
Request to query data initiation start date and time.
Request to query data initiation steps.
Data replication initiation step.
Request to query data initiation step name.
Request to query data initiation status.
Request to query the data replication state.
Request to query the time when data replication will be complete.
Request to query data replication lag duration.
Request to query data replication last snapshot time.
Request to query disks replicated.
Request to query disks replicated.
Request to query data replication backlog size in bytes.
Request to query device name.
Request to query amount of data replicated in bytes.
Request to query amount of data rescanned in bytes.
Request to query total amount of data replicated in bytes.
Source server archived status.
Source server launched instance.
Launched instance EC2 ID.
Launched instance first boot.
Launched instance Job ID.
Source server lifecycle state.
Lifecycle added to service data and time.
Lifecycle elapsed time and duration.
Lifecycle replication initiation date and time.
Lifecycle last Cutover.
Lifecycle Cutover finalized date and time.
Lifecycle Cutover finalized date and time.
Lifecycle last Cutover initiated.
Lifecycle last Cutover initiated by Job ID.
Lifecycle last Cutover reverted.
Lifecycle last Cutover reverted API call date time.
Lifecycle last seen date and time.
Lifecycle last Test.
Lifecycle last Test finalized.
Lifecycle Test failed API call date and time.
Lifecycle last Test initiated.
Lifecycle last Test initiated API call date and time.
Lifecycle last Test initiated Job ID.
Lifecycle last Test reverted.
Lifecycle last Test reverted API call date and time.
Lifecycle state.
Source server replication type.
Source server properties.
Source Server CPUs.
Source server CPU information.
The number of CPU cores on the source server.
The source server's CPU model name.
Source Server disks.
The disk identifier.
The amount of storage on the disk in bytes.
The disk or device name.
Source server identification hints.
AWS Instance ID identification hint.
FQDN address identification hint.
Hostname identification hint.
vCenter VM path identification hint.
vmWare UUID identification hint.
Source server last update date and time.
Source server network interfaces.
Network interface.
Network interface IPs.
Network interface primary IP.
Network interface Mac address.
Source server OS.
OS full string.
Source server RAM in bytes.
Source server recommended instance type.
Source server ID.
Source server Tags.
Source server vCenter client id.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ValidationExceptionstart_cutover(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.start_cutover(
sourceServerIDs=[
'string',
],
tags={
'string': 'string'
}
)
[REQUIRED]
Start Cutover by Source Server IDs.
Start Cutover by Tags.
dict
Response Syntax
{
'job': {
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'postLaunchActionsLaunchStatusList': [
{
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string',
'ssmDocument': {
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND'
},
],
'ssmAgentDiscoveryDatetime': 'string'
},
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
}
}
Response Structure
(dict) --
job (dict) --
Start Cutover Job response.
arn (string) --
the ARN of the specific Job.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
initiatedBy (string) --
Job initiated by field.
jobID (string) --
Job ID.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server Source Server ID.
postLaunchActionsStatus (dict) --
Participating server Source Server ID.
postLaunchActionsLaunchStatusList (list) --
Server participating in Job.
(dict) --
Job type.
executionID (string) --
Job type.
executionStatus (string) --
Job type.
failureReason (string) --
Job type.
ssmDocument (dict) --
Job type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
ssmDocumentType (string) --
Job type.
ssmAgentDiscoveryDatetime (string) --
Server participating in Job.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
type (string) --
Job type.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.ConflictExceptionstart_replication(**kwargs)¶Starts replication for SNAPSHOT_SHIPPING agents.
See also: AWS API Documentation
Request Syntax
response = client.start_replication(
sourceServerID='string'
)
[REQUIRED]
ID of source server on which to start replication.
{
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
}
Response Structure
Source server ARN.
Source server data replication info.
Error in obtaining data replication info.
Error in data replication.
Error in data replication.
Request to query whether data replication has been initiated.
Request to query next data initiation date and time.
Request to query data initiation start date and time.
Request to query data initiation steps.
Data replication initiation step.
Request to query data initiation step name.
Request to query data initiation status.
Request to query the data replication state.
Request to query the time when data replication will be complete.
Request to query data replication lag duration.
Request to query data replication last snapshot time.
Request to query disks replicated.
Request to query disks replicated.
Request to query data replication backlog size in bytes.
Request to query device name.
Request to query amount of data replicated in bytes.
Request to query amount of data rescanned in bytes.
Request to query total amount of data replicated in bytes.
Source server archived status.
Source server launched instance.
Launched instance EC2 ID.
Launched instance first boot.
Launched instance Job ID.
Source server lifecycle state.
Lifecycle added to service data and time.
Lifecycle elapsed time and duration.
Lifecycle replication initiation date and time.
Lifecycle last Cutover.
Lifecycle Cutover finalized date and time.
Lifecycle Cutover finalized date and time.
Lifecycle last Cutover initiated.
Lifecycle last Cutover initiated by Job ID.
Lifecycle last Cutover reverted.
Lifecycle last Cutover reverted API call date time.
Lifecycle last seen date and time.
Lifecycle last Test.
Lifecycle last Test finalized.
Lifecycle Test failed API call date and time.
Lifecycle last Test initiated.
Lifecycle last Test initiated API call date and time.
Lifecycle last Test initiated Job ID.
Lifecycle last Test reverted.
Lifecycle last Test reverted API call date and time.
Lifecycle state.
Source server replication type.
Source server properties.
Source Server CPUs.
Source server CPU information.
The number of CPU cores on the source server.
The source server's CPU model name.
Source Server disks.
The disk identifier.
The amount of storage on the disk in bytes.
The disk or device name.
Source server identification hints.
AWS Instance ID identification hint.
FQDN address identification hint.
Hostname identification hint.
vCenter VM path identification hint.
vmWare UUID identification hint.
Source server last update date and time.
Source server network interfaces.
Network interface.
Network interface IPs.
Network interface primary IP.
Network interface Mac address.
Source server OS.
OS full string.
Source server RAM in bytes.
Source server recommended instance type.
Source server ID.
Source server Tags.
Source server vCenter client id.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.ServiceQuotaExceededExceptionmgn.Client.exceptions.ConflictExceptionstart_test(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.start_test(
sourceServerIDs=[
'string',
],
tags={
'string': 'string'
}
)
[REQUIRED]
Start Test for Source Server IDs.
Start Test by Tags.
dict
Response Syntax
{
'job': {
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'postLaunchActionsLaunchStatusList': [
{
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string',
'ssmDocument': {
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND'
},
],
'ssmAgentDiscoveryDatetime': 'string'
},
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
}
}
Response Structure
(dict) --
job (dict) --
Start Test Job response.
arn (string) --
the ARN of the specific Job.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
initiatedBy (string) --
Job initiated by field.
jobID (string) --
Job ID.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server Source Server ID.
postLaunchActionsStatus (dict) --
Participating server Source Server ID.
postLaunchActionsLaunchStatusList (list) --
Server participating in Job.
(dict) --
Job type.
executionID (string) --
Job type.
executionStatus (string) --
Job type.
failureReason (string) --
Job type.
ssmDocument (dict) --
Job type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
ssmDocumentType (string) --
Job type.
ssmAgentDiscoveryDatetime (string) --
Server participating in Job.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
type (string) --
Job type.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.ConflictExceptiontag_resource(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
Tag resource by ARN.
[REQUIRED]
Tag resource by Tags.
None
Exceptions
mgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ThrottlingExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.AccessDeniedExceptionmgn.Client.exceptions.InternalServerExceptionterminate_target_instances(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.terminate_target_instances(
sourceServerIDs=[
'string',
],
tags={
'string': 'string'
}
)
[REQUIRED]
Terminate Target instance by Source Server IDs.
Terminate Target instance by Tags.
dict
Response Syntax
{
'job': {
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'postLaunchActionsLaunchStatusList': [
{
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string',
'ssmDocument': {
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND'
},
],
'ssmAgentDiscoveryDatetime': 'string'
},
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
}
}
Response Structure
(dict) --
job (dict) --
Terminate Target instance Job response.
arn (string) --
the ARN of the specific Job.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
initiatedBy (string) --
Job initiated by field.
jobID (string) --
Job ID.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server Source Server ID.
postLaunchActionsStatus (dict) --
Participating server Source Server ID.
postLaunchActionsLaunchStatusList (list) --
Server participating in Job.
(dict) --
Job type.
executionID (string) --
Job type.
executionStatus (string) --
Job type.
failureReason (string) --
Job type.
ssmDocument (dict) --
Job type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
ssmDocumentType (string) --
Job type.
ssmAgentDiscoveryDatetime (string) --
Server participating in Job.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
type (string) --
Job type.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.ConflictExceptionuntag_resource(**kwargs)¶Deletes the specified set of tags from the specified set of Application Migration Service resources.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
Untag resource by ARN.
[REQUIRED]
Untag resource by Keys.
None
Exceptions
mgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ThrottlingExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.AccessDeniedExceptionmgn.Client.exceptions.InternalServerExceptionupdate_launch_configuration(**kwargs)¶Updates multiple LaunchConfigurations by Source Server ID.
See also: AWS API Documentation
Request Syntax
response = client.update_launch_configuration(
bootMode='LEGACY_BIOS'|'UEFI',
copyPrivateIp=True|False,
copyTags=True|False,
launchDisposition='STOPPED'|'STARTED',
licensing={
'osByol': True|False
},
name='string',
postLaunchActions={
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
sourceServerID='string',
targetInstanceTypeRightSizingMethod='NONE'|'BASIC'
)
Update Launch configuration licensing request.
Configure BYOL OS licensing.
Server participating in Job.
Server participating in Job.
Server participating in Job.
Server participating in Job.
Server participating in Job.
Server participating in Job.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
[REQUIRED]
Update Launch configuration by Source Server ID request.
dict
Response Syntax
{
'bootMode': 'LEGACY_BIOS'|'UEFI',
'copyPrivateIp': True|False,
'copyTags': True|False,
'ec2LaunchTemplateID': 'string',
'launchDisposition': 'STOPPED'|'STARTED',
'licensing': {
'osByol': True|False
},
'name': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'sourceServerID': 'string',
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'
}
Response Structure
(dict) --
bootMode (string) --
Launch configuration boot mode.
copyPrivateIp (boolean) --
Copy Private IP during Launch Configuration.
copyTags (boolean) --
Copy Tags during Launch Configuration.
ec2LaunchTemplateID (string) --
Launch configuration EC2 Launch template ID.
launchDisposition (string) --
Launch disposition for launch configuration.
licensing (dict) --
Launch configuration OS licensing.
osByol (boolean) --
Configure BYOL OS licensing.
name (string) --
Launch configuration name.
postLaunchActions (dict) --
Server participating in Job.
cloudWatchLogGroupName (string) --
Server participating in Job.
deployment (string) --
Server participating in Job.
s3LogBucket (string) --
Server participating in Job.
s3OutputKeyPrefix (string) --
Server participating in Job.
ssmDocuments (list) --
Server participating in Job.
(dict) --
Source server replication type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
sourceServerID (string) --
Launch configuration Source Server ID.
targetInstanceTypeRightSizingMethod (string) --
Launch configuration Target instance type right sizing method.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.ConflictExceptionupdate_launch_configuration_template(**kwargs)¶Creates a new ReplicationConfigurationTemplate.
See also: AWS API Documentation
Request Syntax
response = client.update_launch_configuration_template(
launchConfigurationTemplateID='string',
postLaunchActions={
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
}
)
[REQUIRED]
Update Launch configuration Target instance right sizing request.
Update Launch configuration Target instance right sizing request.
Server participating in Job.
Server participating in Job.
Server participating in Job.
Server participating in Job.
Server participating in Job.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
Source server replication type.
dict
Response Syntax
{
'arn': 'string',
'launchConfigurationTemplateID': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
Copy Private IP during Launch Configuration.
launchConfigurationTemplateID (string) --
Copy Private IP during Launch Configuration.
postLaunchActions (dict) --
Copy Private IP during Launch Configuration.
cloudWatchLogGroupName (string) --
Server participating in Job.
deployment (string) --
Server participating in Job.
s3LogBucket (string) --
Server participating in Job.
s3OutputKeyPrefix (string) --
Server participating in Job.
ssmDocuments (list) --
Server participating in Job.
(dict) --
Source server replication type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
tags (dict) --
Copy Private IP during Launch Configuration.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.AccessDeniedExceptionupdate_replication_configuration(**kwargs)¶Allows you to update multiple ReplicationConfigurations by Source Server ID.
See also: AWS API Documentation
Request Syntax
response = client.update_replication_configuration(
associateDefaultSecurityGroup=True|False,
bandwidthThrottling=123,
createPublicIP=True|False,
dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP',
defaultLargeStagingDiskType='GP2'|'ST1'|'GP3',
ebsEncryption='DEFAULT'|'CUSTOM',
ebsEncryptionKeyArn='string',
name='string',
replicatedDisks=[
{
'deviceName': 'string',
'iops': 123,
'isBootDisk': True|False,
'stagingDiskType': 'AUTO'|'GP2'|'IO1'|'SC1'|'ST1'|'STANDARD'|'GP3'|'IO2',
'throughput': 123
},
],
replicationServerInstanceType='string',
replicationServersSecurityGroupsIDs=[
'string',
],
sourceServerID='string',
stagingAreaSubnetId='string',
stagingAreaTags={
'string': 'string'
},
useDedicatedReplicationServer=True|False
)
Update replication configuration replicated disks request.
Replication Configuration replicated disk.
Replication Configuration replicated disk device name.
Replication Configuration replicated disk IOPs.
Replication Configuration replicated disk boot disk.
Replication Configuration replicated disk staging disk type.
Replication Configuration replicated disk throughput.
Update replication configuration Replication Server Security Groups IDs request.
[REQUIRED]
Update replication configuration Source Server ID request.
Update replication configuration Staging Area Tags request.
dict
Response Syntax
{
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'name': 'string',
'replicatedDisks': [
{
'deviceName': 'string',
'iops': 123,
'isBootDisk': True|False,
'stagingDiskType': 'AUTO'|'GP2'|'IO1'|'SC1'|'ST1'|'STANDARD'|'GP3'|'IO2',
'throughput': 123
},
],
'replicationServerInstanceType': 'string',
'replicationServersSecurityGroupsIDs': [
'string',
],
'sourceServerID': 'string',
'stagingAreaSubnetId': 'string',
'stagingAreaTags': {
'string': 'string'
},
'useDedicatedReplicationServer': True|False
}
Response Structure
(dict) --
associateDefaultSecurityGroup (boolean) --
Replication Configuration associate default Application Migration Service Security Group.
bandwidthThrottling (integer) --
Replication Configuration set bandwidth throttling.
createPublicIP (boolean) --
Replication Configuration create Public IP.
dataPlaneRouting (string) --
Replication Configuration data plane routing.
defaultLargeStagingDiskType (string) --
Replication Configuration use default large Staging Disks.
ebsEncryption (string) --
Replication Configuration EBS encryption.
ebsEncryptionKeyArn (string) --
Replication Configuration EBS encryption key ARN.
name (string) --
Replication Configuration name.
replicatedDisks (list) --
Replication Configuration replicated disks.
(dict) --
Replication Configuration replicated disk.
deviceName (string) --
Replication Configuration replicated disk device name.
iops (integer) --
Replication Configuration replicated disk IOPs.
isBootDisk (boolean) --
Replication Configuration replicated disk boot disk.
stagingDiskType (string) --
Replication Configuration replicated disk staging disk type.
throughput (integer) --
Replication Configuration replicated disk throughput.
replicationServerInstanceType (string) --
Replication Configuration Replication Server instance type.
replicationServersSecurityGroupsIDs (list) --
Replication Configuration Replication Server Security Group IDs.
sourceServerID (string) --
Replication Configuration Source Server ID.
stagingAreaSubnetId (string) --
Replication Configuration Staging Area subnet ID.
stagingAreaTags (dict) --
Replication Configuration Staging Area tags.
useDedicatedReplicationServer (boolean) --
Replication Configuration use Dedicated Replication Server.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.AccessDeniedExceptionmgn.Client.exceptions.ConflictExceptionupdate_replication_configuration_template(**kwargs)¶Updates multiple ReplicationConfigurationTemplates by ID.
See also: AWS API Documentation
Request Syntax
response = client.update_replication_configuration_template(
arn='string',
associateDefaultSecurityGroup=True|False,
bandwidthThrottling=123,
createPublicIP=True|False,
dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP',
defaultLargeStagingDiskType='GP2'|'ST1'|'GP3',
ebsEncryption='DEFAULT'|'CUSTOM',
ebsEncryptionKeyArn='string',
replicationConfigurationTemplateID='string',
replicationServerInstanceType='string',
replicationServersSecurityGroupsIDs=[
'string',
],
stagingAreaSubnetId='string',
stagingAreaTags={
'string': 'string'
},
useDedicatedReplicationServer=True|False
)
[REQUIRED]
Update replication configuration template template ID request.
Update replication configuration template Replication Server Security groups IDs request.
Update replication configuration template Staging Area Tags request.
dict
Response Syntax
{
'arn': 'string',
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'replicationConfigurationTemplateID': 'string',
'replicationServerInstanceType': 'string',
'replicationServersSecurityGroupsIDs': [
'string',
],
'stagingAreaSubnetId': 'string',
'stagingAreaTags': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'useDedicatedReplicationServer': True|False
}
Response Structure
(dict) --
arn (string) --
Replication Configuration template ARN.
associateDefaultSecurityGroup (boolean) --
Replication Configuration template associate default Application Migration Service Security group.
bandwidthThrottling (integer) --
Replication Configuration template bandwidth throttling.
createPublicIP (boolean) --
Replication Configuration template create Public IP.
dataPlaneRouting (string) --
Replication Configuration template data plane routing.
defaultLargeStagingDiskType (string) --
Replication Configuration template use default large Staging Disk type.
ebsEncryption (string) --
Replication Configuration template EBS encryption.
ebsEncryptionKeyArn (string) --
Replication Configuration template EBS encryption key ARN.
replicationConfigurationTemplateID (string) --
Replication Configuration template ID.
replicationServerInstanceType (string) --
Replication Configuration template server instance type.
replicationServersSecurityGroupsIDs (list) --
Replication Configuration template server Security Groups IDs.
stagingAreaSubnetId (string) --
Replication Configuration template Staging Area subnet ID.
stagingAreaTags (dict) --
Replication Configuration template Staging Area Tags.
tags (dict) --
Replication Configuration template Tags.
useDedicatedReplicationServer (boolean) --
Replication Configuration template use Dedicated Replication Server.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.AccessDeniedExceptionupdate_source_server_replication_type(**kwargs)¶Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.
See also: AWS API Documentation
Request Syntax
response = client.update_source_server_replication_type(
replicationType='AGENT_BASED'|'SNAPSHOT_SHIPPING',
sourceServerID='string'
)
[REQUIRED]
Replication type to which to update source server.
[REQUIRED]
ID of source server on which to update replication type.
dict
Response Syntax
{
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
}
Response Structure
(dict) --
arn (string) --
Source server ARN.
dataReplicationInfo (dict) --
Source server data replication info.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
nextAttemptDateTime (string) --
Request to query next data initiation date and time.
startDateTime (string) --
Request to query data initiation start date and time.
steps (list) --
Request to query data initiation steps.
(dict) --
Data replication initiation step.
name (string) --
Request to query data initiation step name.
status (string) --
Request to query data initiation status.
dataReplicationState (string) --
Request to query the data replication state.
etaDateTime (string) --
Request to query the time when data replication will be complete.
lagDuration (string) --
Request to query data replication lag duration.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
deviceName (string) --
Request to query device name.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
isArchived (boolean) --
Source server archived status.
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
firstBoot (string) --
Launched instance first boot.
jobID (string) --
Launched instance Job ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
lastCutover (dict) --
Lifecycle last Cutover.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
initiated (dict) --
Lifecycle last Cutover initiated.
apiCallDateTime (string) --
jobID (string) --
Lifecycle last Cutover initiated by Job ID.
reverted (dict) --
Lifecycle last Cutover reverted.
apiCallDateTime (string) --
Lifecycle last Cutover reverted API call date time.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
initiated (dict) --
Lifecycle last Test initiated.
apiCallDateTime (string) --
Lifecycle last Test initiated API call date and time.
jobID (string) --
Lifecycle last Test initiated Job ID.
reverted (dict) --
Lifecycle last Test reverted.
apiCallDateTime (string) --
Lifecycle last Test reverted API call date and time.
state (string) --
Lifecycle state.
replicationType (string) --
Source server replication type.
sourceProperties (dict) --
Source server properties.
cpus (list) --
Source Server CPUs.
(dict) --
Source server CPU information.
cores (integer) --
The number of CPU cores on the source server.
modelName (string) --
The source server's CPU model name.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
bytes (integer) --
The amount of storage on the disk in bytes.
deviceName (string) --
The disk or device name.
identificationHints (dict) --
Source server identification hints.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmPath (string) --
vCenter VM path identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
lastUpdatedDateTime (string) --
Source server last update date and time.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
isPrimary (boolean) --
Network interface primary IP.
macAddress (string) --
Network interface Mac address.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
ramBytes (integer) --
Source server RAM in bytes.
recommendedInstanceType (string) --
Source server recommended instance type.
sourceServerID (string) --
Source server ID.
tags (dict) --
Source server Tags.
vcenterClientID (string) --
Source server vCenter client id.
Exceptions
mgn.Client.exceptions.UninitializedAccountExceptionmgn.Client.exceptions.ResourceNotFoundExceptionmgn.Client.exceptions.ValidationExceptionmgn.Client.exceptions.ConflictExceptionThe available paginators are:
mgn.Paginator.DescribeJobLogItemsmgn.Paginator.DescribeJobsmgn.Paginator.DescribeLaunchConfigurationTemplatesmgn.Paginator.DescribeReplicationConfigurationTemplatesmgn.Paginator.DescribeSourceServersmgn.Paginator.DescribeVcenterClientsmgn.Paginator.DescribeJobLogItems¶paginator = client.get_paginator('describe_job_log_items')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from mgn.Client.describe_job_log_items().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
jobID='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Request to describe Job log job ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'items': [
{
'event': 'JOB_START'|'SERVER_SKIPPED'|'CLEANUP_START'|'CLEANUP_END'|'CLEANUP_FAIL'|'SNAPSHOT_START'|'SNAPSHOT_END'|'SNAPSHOT_FAIL'|'USING_PREVIOUS_SNAPSHOT'|'CONVERSION_START'|'CONVERSION_END'|'CONVERSION_FAIL'|'LAUNCH_START'|'LAUNCH_FAILED'|'JOB_CANCEL'|'JOB_END',
'eventData': {
'conversionServerID': 'string',
'rawError': 'string',
'sourceServerID': 'string',
'targetInstanceID': 'string'
},
'logDateTime': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to describe Job log response items.
(dict) --
Job log.
event (string) --
Job log event.
eventData (dict) --
Job event data
conversionServerID (string) --
Job Event conversion Server ID.
rawError (string) --
Job error.
sourceServerID (string) --
Job Event Source Server ID.
targetInstanceID (string) --
Job Event Target instance ID.
logDateTime (string) --
Job log event date and time.
NextToken (string) --
A token to resume pagination.
mgn.Paginator.DescribeJobs¶paginator = client.get_paginator('describe_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from mgn.Client.describe_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters={
'fromDate': 'string',
'jobIDs': [
'string',
],
'toDate': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Request to describe Job log filters.
Request to describe Job log filters by date.
Request to describe Job log filters by job ID.
Request to describe job log items by last date.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'postLaunchActionsLaunchStatusList': [
{
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string',
'ssmDocument': {
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND'
},
],
'ssmAgentDiscoveryDatetime': 'string'
},
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to describe Job log items.
(dict) --
Job.
arn (string) --
the ARN of the specific Job.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
initiatedBy (string) --
Job initiated by field.
jobID (string) --
Job ID.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server Source Server ID.
postLaunchActionsStatus (dict) --
Participating server Source Server ID.
postLaunchActionsLaunchStatusList (list) --
Server participating in Job.
(dict) --
Job type.
executionID (string) --
Job type.
executionStatus (string) --
Job type.
failureReason (string) --
Job type.
ssmDocument (dict) --
Job type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
ssmDocumentType (string) --
Job type.
ssmAgentDiscoveryDatetime (string) --
Server participating in Job.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
type (string) --
Job type.
NextToken (string) --
A token to resume pagination.
mgn.Paginator.DescribeLaunchConfigurationTemplates¶paginator = client.get_paginator('describe_launch_configuration_templates')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from mgn.Client.describe_launch_configuration_templates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
launchConfigurationTemplateIDs=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Request to disconnect Source Server from service by Server ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'launchConfigurationTemplateID': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to disconnect Source Server from service by Server ID.
(dict) --
arn (string) --
Copy Private IP during Launch Configuration.
launchConfigurationTemplateID (string) --
Copy Private IP during Launch Configuration.
postLaunchActions (dict) --
Copy Private IP during Launch Configuration.
cloudWatchLogGroupName (string) --
Server participating in Job.
deployment (string) --
Server participating in Job.
s3LogBucket (string) --
Server participating in Job.
s3OutputKeyPrefix (string) --
Server participating in Job.
ssmDocuments (list) --
Server participating in Job.
(dict) --
Source server replication type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
tags (dict) --
Copy Private IP during Launch Configuration.
NextToken (string) --
A token to resume pagination.
mgn.Paginator.DescribeReplicationConfigurationTemplates¶paginator = client.get_paginator('describe_replication_configuration_templates')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from mgn.Client.describe_replication_configuration_templates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
replicationConfigurationTemplateIDs=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Request to describe Replication Configuration template by template IDs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'replicationConfigurationTemplateID': 'string',
'replicationServerInstanceType': 'string',
'replicationServersSecurityGroupsIDs': [
'string',
],
'stagingAreaSubnetId': 'string',
'stagingAreaTags': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'useDedicatedReplicationServer': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to describe Replication Configuration template by items.
(dict) --
arn (string) --
Replication Configuration template ARN.
associateDefaultSecurityGroup (boolean) --
Replication Configuration template associate default Application Migration Service Security group.
bandwidthThrottling (integer) --
Replication Configuration template bandwidth throttling.
createPublicIP (boolean) --
Replication Configuration template create Public IP.
dataPlaneRouting (string) --
Replication Configuration template data plane routing.
defaultLargeStagingDiskType (string) --
Replication Configuration template use default large Staging Disk type.
ebsEncryption (string) --
Replication Configuration template EBS encryption.
ebsEncryptionKeyArn (string) --
Replication Configuration template EBS encryption key ARN.
replicationConfigurationTemplateID (string) --
Replication Configuration template ID.
replicationServerInstanceType (string) --
Replication Configuration template server instance type.
replicationServersSecurityGroupsIDs (list) --
Replication Configuration template server Security Groups IDs.
stagingAreaSubnetId (string) --
Replication Configuration template Staging Area subnet ID.
stagingAreaTags (dict) --
Replication Configuration template Staging Area Tags.
tags (dict) --
Replication Configuration template Tags.
useDedicatedReplicationServer (boolean) --
Replication Configuration template use Dedicated Replication Server.
NextToken (string) --
A token to resume pagination.
mgn.Paginator.DescribeSourceServers¶paginator = client.get_paginator('describe_source_servers')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from mgn.Client.describe_source_servers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters={
'isArchived': True|False,
'lifeCycleStates': [
'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED',
],
'replicationTypes': [
'AGENT_BASED'|'SNAPSHOT_SHIPPING',
],
'sourceServerIDs': [
'string',
]
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Request to filter Source Servers list.
Request to filter Source Servers list by archived.
Request to filter Source Servers list by life cycle states.
Request to filter Source Servers list by replication type.
Request to filter Source Servers list by Source Server ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to filter Source Servers list by item.
(dict) --
arn (string) --
Source server ARN.
dataReplicationInfo (dict) --
Source server data replication info.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
nextAttemptDateTime (string) --
Request to query next data initiation date and time.
startDateTime (string) --
Request to query data initiation start date and time.
steps (list) --
Request to query data initiation steps.
(dict) --
Data replication initiation step.
name (string) --
Request to query data initiation step name.
status (string) --
Request to query data initiation status.
dataReplicationState (string) --
Request to query the data replication state.
etaDateTime (string) --
Request to query the time when data replication will be complete.
lagDuration (string) --
Request to query data replication lag duration.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
deviceName (string) --
Request to query device name.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
isArchived (boolean) --
Source server archived status.
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
firstBoot (string) --
Launched instance first boot.
jobID (string) --
Launched instance Job ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
lastCutover (dict) --
Lifecycle last Cutover.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
initiated (dict) --
Lifecycle last Cutover initiated.
apiCallDateTime (string) --
jobID (string) --
Lifecycle last Cutover initiated by Job ID.
reverted (dict) --
Lifecycle last Cutover reverted.
apiCallDateTime (string) --
Lifecycle last Cutover reverted API call date time.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
initiated (dict) --
Lifecycle last Test initiated.
apiCallDateTime (string) --
Lifecycle last Test initiated API call date and time.
jobID (string) --
Lifecycle last Test initiated Job ID.
reverted (dict) --
Lifecycle last Test reverted.
apiCallDateTime (string) --
Lifecycle last Test reverted API call date and time.
state (string) --
Lifecycle state.
replicationType (string) --
Source server replication type.
sourceProperties (dict) --
Source server properties.
cpus (list) --
Source Server CPUs.
(dict) --
Source server CPU information.
cores (integer) --
The number of CPU cores on the source server.
modelName (string) --
The source server's CPU model name.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
bytes (integer) --
The amount of storage on the disk in bytes.
deviceName (string) --
The disk or device name.
identificationHints (dict) --
Source server identification hints.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmPath (string) --
vCenter VM path identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
lastUpdatedDateTime (string) --
Source server last update date and time.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
isPrimary (boolean) --
Network interface primary IP.
macAddress (string) --
Network interface Mac address.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
ramBytes (integer) --
Source server RAM in bytes.
recommendedInstanceType (string) --
Source server recommended instance type.
sourceServerID (string) --
Source server ID.
tags (dict) --
Source server Tags.
vcenterClientID (string) --
Source server vCenter client id.
NextToken (string) --
A token to resume pagination.
mgn.Paginator.DescribeVcenterClients¶paginator = client.get_paginator('describe_vcenter_clients')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from mgn.Client.describe_vcenter_clients().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'items': [
{
'arn': 'string',
'datacenterName': 'string',
'hostname': 'string',
'lastSeenDatetime': 'string',
'sourceServerTags': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'vcenterClientID': 'string',
'vcenterUUID': 'string'
},
],
'NextToken': 'string'
}
Response Structure
List of items returned by DescribeVcenterClients.
vCenter client.
Arn of vCenter client.
Datacenter name of vCenter client.
Hostname of vCenter client .
Last seen time of vCenter client.
Tags for Source Server of vCenter client.
Tags for vCenter client.
ID of vCenter client.
Vcenter UUID of vCenter client.
A token to resume pagination.