2023/07/05 - Application Migration Service - 4 new 42 updated api methods
Changes This release introduces the Global view feature and new Replication state APIs.
Resume Replication.
See also: AWS API Documentation
Request Syntax
client.resume_replication(
accountID='string',
sourceServerID='string'
)
string
Resume Replication Request account ID.
string
[REQUIRED]
Resume Replication Request source server ID.
dict
Response Syntax
{
'applicationID': 'string',
'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
},
]
},
'fqdnForActionFramework': 'string',
'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'|'PENDING_INSTALLATION'
},
'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'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
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.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
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.
(string) --
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.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
List Managed Accounts.
See also: AWS API Documentation
Request Syntax
client.list_managed_accounts(
maxResults=123,
nextToken='string'
)
integer
List managed accounts request max results.
string
List managed accounts request next token.
dict
Response Syntax
{
'items': [
{
'accountId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
List managed accounts response.
items (list) --
List managed accounts response items.
(dict) --
Managed account.
accountId (string) --
Managed account, account ID.
nextToken (string) --
List managed accounts response next token.
Pause Replication.
See also: AWS API Documentation
Request Syntax
client.pause_replication(
accountID='string',
sourceServerID='string'
)
string
Pause Replication Request account ID.
string
[REQUIRED]
Pause Replication Request source server ID.
dict
Response Syntax
{
'applicationID': 'string',
'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
},
]
},
'fqdnForActionFramework': 'string',
'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'|'PENDING_INSTALLATION'
},
'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'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
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.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
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.
(string) --
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.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
Stop Replication.
See also: AWS API Documentation
Request Syntax
client.stop_replication(
accountID='string',
sourceServerID='string'
)
string
Stop Replication Request account ID.
string
[REQUIRED]
Stop Replication Request source server ID.
dict
Response Syntax
{
'applicationID': 'string',
'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
},
]
},
'fqdnForActionFramework': 'string',
'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'|'PENDING_INSTALLATION'
},
'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'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
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.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
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.
(string) --
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.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
{'accountID': 'string'}
Archive application.
See also: AWS API Documentation
Request Syntax
client.archive_application(
accountID='string',
applicationID='string'
)
string
Account ID.
string
[REQUIRED]
Application ID.
dict
Response Syntax
{
'applicationAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'totalSourceServers': 123
},
'applicationID': 'string',
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveID': 'string'
}
Response Structure
(dict) --
applicationAggregatedStatus (dict) --
Application aggregated status.
healthStatus (string) --
Application aggregated status health status.
lastUpdateDateTime (string) --
Application aggregated status last update dateTime.
progressStatus (string) --
Application aggregated status progress status.
totalSourceServers (integer) --
Application aggregated status total source servers amount.
applicationID (string) --
Application ID.
arn (string) --
Application ARN.
creationDateTime (string) --
Application creation dateTime.
description (string) --
Application description.
isArchived (boolean) --
Application archival status.
lastModifiedDateTime (string) --
Application last modified dateTime.
name (string) --
Application name.
tags (dict) --
Application tags.
(string) --
(string) --
waveID (string) --
Application wave ID.
{'accountID': 'string'}
Archive wave.
See also: AWS API Documentation
Request Syntax
client.archive_wave(
accountID='string',
waveID='string'
)
string
Account ID.
string
[REQUIRED]
Wave ID.
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'replicationStartedDateTime': 'string',
'totalApplications': 123
},
'waveID': 'string'
}
Response Structure
(dict) --
arn (string) --
Wave ARN.
creationDateTime (string) --
Wave creation dateTime.
description (string) --
Wave description.
isArchived (boolean) --
Wave archival status.
lastModifiedDateTime (string) --
Wave last modified dateTime.
name (string) --
Wave name.
tags (dict) --
Wave tags.
(string) --
(string) --
waveAggregatedStatus (dict) --
Wave aggregated status.
healthStatus (string) --
Wave aggregated status health status.
lastUpdateDateTime (string) --
Wave aggregated status last update dateTime.
progressStatus (string) --
Wave aggregated status progress status.
replicationStartedDateTime (string) --
DateTime marking when the first source server in the wave started replication.
totalApplications (integer) --
Wave aggregated status total applications amount.
waveID (string) --
Wave ID.
{'accountID': 'string'}
Associate applications to wave.
See also: AWS API Documentation
Request Syntax
client.associate_applications(
accountID='string',
applicationIDs=[
'string',
],
waveID='string'
)
string
Account ID.
list
[REQUIRED]
Application IDs list.
(string) --
string
[REQUIRED]
Wave ID.
dict
Response Syntax
{}
Response Structure
(dict) --
{'accountID': 'string'}
Associate source servers to application.
See also: AWS API Documentation
Request Syntax
client.associate_source_servers(
accountID='string',
applicationID='string',
sourceServerIDs=[
'string',
]
)
string
Account ID.
string
[REQUIRED]
Application ID.
list
[REQUIRED]
Source server IDs list.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
{'accountID': 'string'}
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
client.change_server_life_cycle_state(
accountID='string',
lifeCycle={
'state': 'READY_FOR_TEST'|'READY_FOR_CUTOVER'|'CUTOVER'
},
sourceServerID='string'
)
string
The request to change the source server migration account ID.
dict
[REQUIRED]
The request to change the source server migration lifecycle state.
state (string) -- [REQUIRED]
The request to change the source server migration lifecycle state.
string
[REQUIRED]
The request to change the source server migration lifecycle state by source server ID.
dict
Response Syntax
{
'applicationID': 'string',
'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
},
]
},
'fqdnForActionFramework': 'string',
'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'|'PENDING_INSTALLATION'
},
'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'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
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.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
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.
(string) --
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.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
{'accountID': 'string'}
Create application.
See also: AWS API Documentation
Request Syntax
client.create_application(
accountID='string',
description='string',
name='string',
tags={
'string': 'string'
}
)
string
Account ID.
string
Application description.
string
[REQUIRED]
Application name.
dict
Application tags.
(string) --
(string) --
dict
Response Syntax
{
'applicationAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'totalSourceServers': 123
},
'applicationID': 'string',
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveID': 'string'
}
Response Structure
(dict) --
applicationAggregatedStatus (dict) --
Application aggregated status.
healthStatus (string) --
Application aggregated status health status.
lastUpdateDateTime (string) --
Application aggregated status last update dateTime.
progressStatus (string) --
Application aggregated status progress status.
totalSourceServers (integer) --
Application aggregated status total source servers amount.
applicationID (string) --
Application ID.
arn (string) --
Application ARN.
creationDateTime (string) --
Application creation dateTime.
description (string) --
Application description.
isArchived (boolean) --
Application archival status.
lastModifiedDateTime (string) --
Application last modified dateTime.
name (string) --
Application name.
tags (dict) --
Application tags.
(string) --
(string) --
waveID (string) --
Application wave ID.
{'useFipsEndpoint': 'boolean'}
Creates a new ReplicationConfigurationTemplate.
See also: AWS API Documentation
Request Syntax
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,
useFipsEndpoint=True|False
)
boolean
[REQUIRED]
Request to associate the default Application Migration Service Security group with the Replication Settings template.
integer
[REQUIRED]
Request to configure bandwidth throttling during Replication Settings template creation.
boolean
[REQUIRED]
Request to create Public IP during Replication Settings template creation.
string
[REQUIRED]
Request to configure data plane routing during Replication Settings template creation.
string
[REQUIRED]
Request to configure the default large staging disk EBS volume type during Replication Settings template creation.
string
[REQUIRED]
Request to configure EBS encryption during Replication Settings template creation.
string
Request to configure an EBS encryption key during Replication Settings template creation.
string
[REQUIRED]
Request to configure the Replication Server instance type during Replication Settings template creation.
list
[REQUIRED]
Request to configure the Replication Server Security group ID during Replication Settings template creation.
(string) --
string
[REQUIRED]
Request to configure the Staging Area subnet ID during Replication Settings template creation.
dict
[REQUIRED]
Request to configure Staging Area tags during Replication Settings template creation.
(string) --
(string) --
dict
Request to configure tags during Replication Settings template creation.
(string) --
(string) --
boolean
[REQUIRED]
Request to use Dedicated Replication Servers during Replication Settings template creation.
boolean
Request to use Fips Endpoint 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,
'useFipsEndpoint': 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.
(string) --
stagingAreaSubnetId (string) --
Replication Configuration template Staging Area subnet ID.
stagingAreaTags (dict) --
Replication Configuration template Staging Area Tags.
(string) --
(string) --
tags (dict) --
Replication Configuration template Tags.
(string) --
(string) --
useDedicatedReplicationServer (boolean) --
Replication Configuration template use Dedicated Replication Server.
useFipsEndpoint (boolean) --
Replication Configuration template use Fips Endpoint.
{'accountID': 'string'}
Create wave.
See also: AWS API Documentation
Request Syntax
client.create_wave(
accountID='string',
description='string',
name='string',
tags={
'string': 'string'
}
)
string
Account ID.
string
Wave description.
string
[REQUIRED]
Wave name.
dict
Wave tags.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'replicationStartedDateTime': 'string',
'totalApplications': 123
},
'waveID': 'string'
}
Response Structure
(dict) --
arn (string) --
Wave ARN.
creationDateTime (string) --
Wave creation dateTime.
description (string) --
Wave description.
isArchived (boolean) --
Wave archival status.
lastModifiedDateTime (string) --
Wave last modified dateTime.
name (string) --
Wave name.
tags (dict) --
Wave tags.
(string) --
(string) --
waveAggregatedStatus (dict) --
Wave aggregated status.
healthStatus (string) --
Wave aggregated status health status.
lastUpdateDateTime (string) --
Wave aggregated status last update dateTime.
progressStatus (string) --
Wave aggregated status progress status.
replicationStartedDateTime (string) --
DateTime marking when the first source server in the wave started replication.
totalApplications (integer) --
Wave aggregated status total applications amount.
waveID (string) --
Wave ID.
{'accountID': 'string'}
Delete application.
See also: AWS API Documentation
Request Syntax
client.delete_application(
accountID='string',
applicationID='string'
)
string
Account ID.
string
[REQUIRED]
Application ID.
dict
Response Syntax
{}
Response Structure
(dict) --
{'accountID': 'string'}
Deletes a single Job by ID.
See also: AWS API Documentation
Request Syntax
client.delete_job(
accountID='string',
jobID='string'
)
string
Request to delete Job from service by Account ID.
string
[REQUIRED]
Request to delete Job from service by Job ID.
dict
Response Syntax
{}
Response Structure
(dict) --
{'accountID': 'string'}
Deletes a single source server by ID.
See also: AWS API Documentation
Request Syntax
client.delete_source_server(
accountID='string',
sourceServerID='string'
)
string
Request to delete Source Server from service by Account ID.
string
[REQUIRED]
Request to delete Source Server from service by Server ID.
dict
Response Syntax
{}
Response Structure
(dict) --
{'accountID': 'string'}
Delete wave.
See also: AWS API Documentation
Request Syntax
client.delete_wave(
accountID='string',
waveID='string'
)
string
Account ID.
string
[REQUIRED]
Wave ID.
dict
Response Syntax
{}
Response Structure
(dict) --
{'accountID': 'string'}
Retrieves detailed job log items with paging.
See also: AWS API Documentation
Request Syntax
client.describe_job_log_items(
accountID='string',
jobID='string',
maxResults=123,
nextToken='string'
)
string
Request to describe Job log Account ID.
string
[REQUIRED]
Request to describe Job log job ID.
integer
Request to describe Job log item maximum results.
string
Request to describe Job log next token.
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.
{'accountID': 'string'}
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
client.describe_jobs(
accountID='string',
filters={
'fromDate': 'string',
'jobIDs': [
'string',
],
'toDate': 'string'
},
maxResults=123,
nextToken='string'
)
string
Request to describe job log items by Account ID.
dict
Request to describe Job log filters.
fromDate (string) --
Request to describe Job log filters by date.
jobIDs (list) --
Request to describe Job log filters by job ID.
(string) --
toDate (string) --
Request to describe job log items by last date.
integer
Request to describe job log items by max results.
string
Request to describe job log items by next token.
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',
'externalParameters': {
'string': {
'dynamicPath': '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's launched ec2 instance ID.
postLaunchActionsStatus (dict) --
Participating server's Post Launch Actions Status.
postLaunchActionsLaunchStatusList (list) --
List of Post Launch Action status.
(dict) --
Launch Status of the Job Post Launch Actions.
executionID (string) --
AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions.
executionStatus (string) --
AWS Systems Manager Document's execution status.
failureReason (string) --
AWS Systems Manager Document's failure reason.
ssmDocument (dict) --
AWS Systems Manager's Document of the of the Job Post Launch Actions.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
ssmDocumentType (string) --
AWS Systems Manager Document type.
ssmAgentDiscoveryDatetime (string) --
Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
type (string) --
Job type.
nextToken (string) --
Request to describe Job response by next token.
{'items': {'useFipsEndpoint': 'boolean'}}
Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
See also: AWS API Documentation
Request Syntax
client.describe_replication_configuration_templates(
maxResults=123,
nextToken='string',
replicationConfigurationTemplateIDs=[
'string',
]
)
integer
Request to describe Replication Configuration template by max results.
string
Request to describe Replication Configuration template by next token.
list
Request to describe Replication Configuration template by template IDs.
(string) --
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,
'useFipsEndpoint': 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.
(string) --
stagingAreaSubnetId (string) --
Replication Configuration template Staging Area subnet ID.
stagingAreaTags (dict) --
Replication Configuration template Staging Area Tags.
(string) --
(string) --
tags (dict) --
Replication Configuration template Tags.
(string) --
(string) --
useDedicatedReplicationServer (boolean) --
Replication Configuration template use Dedicated Replication Server.
useFipsEndpoint (boolean) --
Replication Configuration template use Fips Endpoint.
nextToken (string) --
Request to describe Replication Configuration template by next token.
{'accountID': 'string'}
Retrieves all SourceServers or multiple SourceServers by ID.
See also: AWS API Documentation
Request Syntax
client.describe_source_servers(
accountID='string',
filters={
'applicationIDs': [
'string',
],
'isArchived': True|False,
'lifeCycleStates': [
'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION',
],
'replicationTypes': [
'AGENT_BASED'|'SNAPSHOT_SHIPPING',
],
'sourceServerIDs': [
'string',
]
},
maxResults=123,
nextToken='string'
)
string
Request to filter Source Servers list by Accoun ID.
dict
Request to filter Source Servers list.
applicationIDs (list) --
Request to filter Source Servers list by application IDs.
(string) --
isArchived (boolean) --
Request to filter Source Servers list by archived.
lifeCycleStates (list) --
Request to filter Source Servers list by life cycle states.
(string) --
replicationTypes (list) --
Request to filter Source Servers list by replication type.
(string) --
sourceServerIDs (list) --
Request to filter Source Servers list by Source Server ID.
(string) --
integer
Request to filter Source Servers list by maximum results.
string
Request to filter Source Servers list by next token.
dict
Response Syntax
{
'items': [
{
'applicationID': 'string',
'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
},
]
},
'fqdnForActionFramework': 'string',
'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'|'PENDING_INSTALLATION'
},
'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'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to filter Source Servers list by item.
(dict) --
applicationID (string) --
Source server application ID.
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.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
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.
(string) --
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.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
nextToken (string) --
Request to filter Source Servers next token.
{'accountID': 'string'}
Disassociate applications from wave.
See also: AWS API Documentation
Request Syntax
client.disassociate_applications(
accountID='string',
applicationIDs=[
'string',
],
waveID='string'
)
string
Account ID.
list
[REQUIRED]
Application IDs list.
(string) --
string
[REQUIRED]
Wave ID.
dict
Response Syntax
{}
Response Structure
(dict) --
{'accountID': 'string'}
Disassociate source servers from application.
See also: AWS API Documentation
Request Syntax
client.disassociate_source_servers(
accountID='string',
applicationID='string',
sourceServerIDs=[
'string',
]
)
string
Account ID.
string
[REQUIRED]
Application ID.
list
[REQUIRED]
Source server IDs list.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
{'accountID': 'string'}
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
client.disconnect_from_service(
accountID='string',
sourceServerID='string'
)
string
Request to disconnect Source Server from service by Account ID.
string
[REQUIRED]
Request to disconnect Source Server from service by Server ID.
dict
Response Syntax
{
'applicationID': 'string',
'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
},
]
},
'fqdnForActionFramework': 'string',
'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'|'PENDING_INSTALLATION'
},
'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'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
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.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
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.
(string) --
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.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
{'accountID': 'string'}
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
client.finalize_cutover(
accountID='string',
sourceServerID='string'
)
string
Request to finalize Cutover by Source Account ID.
string
[REQUIRED]
Request to finalize Cutover by Source Server ID.
dict
Response Syntax
{
'applicationID': 'string',
'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
},
]
},
'fqdnForActionFramework': 'string',
'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'|'PENDING_INSTALLATION'
},
'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'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
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.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
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.
(string) --
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.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
{'accountID': 'string'}
Lists all LaunchConfigurations available, filtered by Source Server IDs.
See also: AWS API Documentation
Request Syntax
client.get_launch_configuration(
accountID='string',
sourceServerID='string'
)
string
Request to get Launch Configuration information by Account ID.
string
[REQUIRED]
Request to get Launch Configuration information by Source Server ID.
dict
Response Syntax
{
'bootMode': 'LEGACY_BIOS'|'UEFI',
'copyPrivateIp': True|False,
'copyTags': True|False,
'ec2LaunchTemplateID': 'string',
'enableMapAutoTagging': True|False,
'launchDisposition': 'STOPPED'|'STARTED',
'licensing': {
'osByol': True|False
},
'mapAutoTaggingMpeID': 'string',
'name': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'externalParameters': {
'string': {
'dynamicPath': '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.
enableMapAutoTagging (boolean) --
Enable map auto tagging.
launchDisposition (string) --
Launch disposition for launch configuration.
licensing (dict) --
Launch configuration OS licensing.
osByol (boolean) --
Configure BYOL OS licensing.
mapAutoTaggingMpeID (string) --
Map auto tagging MPE ID.
name (string) --
Launch configuration name.
postLaunchActions (dict) --
Post Launch Actions to executed on the Test or Cutover instance.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
deployment (string) --
Deployment type in which AWS Systems Manager Documents will be executed.
s3LogBucket (string) --
AWS Systems Manager Command's logs S3 log bucket.
s3OutputKeyPrefix (string) --
AWS Systems Manager Command's logs S3 output key prefix.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
sourceServerID (string) --
Launch configuration Source Server ID.
targetInstanceTypeRightSizingMethod (string) --
Launch configuration Target instance type right sizing method.
{'accountID': 'string'}
Response {'useFipsEndpoint': 'boolean'}
Lists all ReplicationConfigurations, filtered by Source Server ID.
See also: AWS API Documentation
Request Syntax
client.get_replication_configuration(
accountID='string',
sourceServerID='string'
)
string
Request to get Replication Configuration by Account ID.
string
[REQUIRED]
Request to get Replication Configuration by Source Server ID.
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,
'useFipsEndpoint': 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.
(string) --
sourceServerID (string) --
Replication Configuration Source Server ID.
stagingAreaSubnetId (string) --
Replication Configuration Staging Area subnet ID.
stagingAreaTags (dict) --
Replication Configuration Staging Area tags.
(string) --
(string) --
useDedicatedReplicationServer (boolean) --
Replication Configuration use Dedicated Replication Server.
useFipsEndpoint (boolean) --
Replication Configuration use Fips Endpoint.
{'accountID': 'string'}
Retrieves all applications or multiple applications by ID.
See also: AWS API Documentation
Request Syntax
client.list_applications(
accountID='string',
filters={
'applicationIDs': [
'string',
],
'isArchived': True|False,
'waveIDs': [
'string',
]
},
maxResults=123,
nextToken='string'
)
string
Applications list Account ID.
dict
Applications list filters.
applicationIDs (list) --
Filter applications list by application ID.
(string) --
isArchived (boolean) --
Filter applications list by archival status.
waveIDs (list) --
Filter applications list by wave ID.
(string) --
integer
Maximum results to return when listing applications.
string
Request next token.
dict
Response Syntax
{
'items': [
{
'applicationAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'totalSourceServers': 123
},
'applicationID': 'string',
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveID': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Applications list.
(dict) --
applicationAggregatedStatus (dict) --
Application aggregated status.
healthStatus (string) --
Application aggregated status health status.
lastUpdateDateTime (string) --
Application aggregated status last update dateTime.
progressStatus (string) --
Application aggregated status progress status.
totalSourceServers (integer) --
Application aggregated status total source servers amount.
applicationID (string) --
Application ID.
arn (string) --
Application ARN.
creationDateTime (string) --
Application creation dateTime.
description (string) --
Application description.
isArchived (boolean) --
Application archival status.
lastModifiedDateTime (string) --
Application last modified dateTime.
name (string) --
Application name.
tags (dict) --
Application tags.
(string) --
(string) --
waveID (string) --
Application wave ID.
nextToken (string) --
Response next token.
{'items': {'errorData': {'accountID': 'string'}}}
List import errors.
See also: AWS API Documentation
Request Syntax
client.list_import_errors(
importID='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
List import errors request import id.
integer
List import errors request max results.
string
List import errors request next token.
dict
Response Syntax
{
'items': [
{
'errorData': {
'accountID': 'string',
'applicationID': 'string',
'ec2LaunchTemplateID': 'string',
'rawError': 'string',
'rowNumber': 123,
'sourceServerID': 'string',
'waveID': 'string'
},
'errorDateTime': 'string',
'errorType': 'VALIDATION_ERROR'|'PROCESSING_ERROR'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
List imports errors response.
items (list) --
List imports errors response items.
(dict) --
Import task error.
errorData (dict) --
Import task error data.
accountID (string) --
Import error data source account ID.
applicationID (string) --
Import error data application ID.
ec2LaunchTemplateID (string) --
Import error data ec2 LaunchTemplate ID.
rawError (string) --
Import error data raw error.
rowNumber (integer) --
Import error data row number.
sourceServerID (string) --
Import error data source server ID.
waveID (string) --
Import error data wave id.
errorDateTime (string) --
Import task error datetime.
errorType (string) --
Import task error type.
nextToken (string) --
List imports errors response next token.
{'accountID': 'string'}
List source server post migration custom actions.
See also: AWS API Documentation
Request Syntax
client.list_source_server_actions(
accountID='string',
filters={
'actionIDs': [
'string',
]
},
maxResults=123,
nextToken='string',
sourceServerID='string'
)
string
Account ID to return when listing source server post migration custom actions.
dict
Filters to apply when listing source server post migration custom actions.
actionIDs (list) --
Action IDs to filter source server post migration custom actions by.
(string) --
integer
Maximum amount of items to return when listing source server post migration custom actions.
string
Next token to use when listing source server post migration custom actions.
string
[REQUIRED]
Source server ID.
dict
Response Syntax
{
'items': [
{
'actionID': 'string',
'actionName': 'string',
'active': True|False,
'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER',
'description': 'string',
'documentIdentifier': 'string',
'documentVersion': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'order': 123,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'timeoutSeconds': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
List of source server post migration custom actions.
(dict) --
actionID (string) --
Source server post migration custom action ID.
actionName (string) --
Source server post migration custom action name.
active (boolean) --
Source server post migration custom action active status.
category (string) --
Source server post migration custom action category.
description (string) --
Source server post migration custom action description.
documentIdentifier (string) --
Source server post migration custom action document identifier.
documentVersion (string) --
Source server post migration custom action document version.
externalParameters (dict) --
Source server post migration custom action external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
Source server post migration custom action must succeed for cutover.
order (integer) --
Source server post migration custom action order.
parameters (dict) --
Source server post migration custom action parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
timeoutSeconds (integer) --
Source server post migration custom action timeout in seconds.
nextToken (string) --
Next token returned when listing source server post migration custom actions.
{'accountID': 'string'}
Retrieves all waves or multiple waves by ID.
See also: AWS API Documentation
Request Syntax
client.list_waves(
accountID='string',
filters={
'isArchived': True|False,
'waveIDs': [
'string',
]
},
maxResults=123,
nextToken='string'
)
string
Request account ID.
dict
Waves list filters.
isArchived (boolean) --
Filter waves list by archival status.
waveIDs (list) --
Filter waves list by wave ID.
(string) --
integer
Maximum results to return when listing waves.
string
Request next token.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'replicationStartedDateTime': 'string',
'totalApplications': 123
},
'waveID': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Waves list.
(dict) --
arn (string) --
Wave ARN.
creationDateTime (string) --
Wave creation dateTime.
description (string) --
Wave description.
isArchived (boolean) --
Wave archival status.
lastModifiedDateTime (string) --
Wave last modified dateTime.
name (string) --
Wave name.
tags (dict) --
Wave tags.
(string) --
(string) --
waveAggregatedStatus (dict) --
Wave aggregated status.
healthStatus (string) --
Wave aggregated status health status.
lastUpdateDateTime (string) --
Wave aggregated status last update dateTime.
progressStatus (string) --
Wave aggregated status progress status.
replicationStartedDateTime (string) --
DateTime marking when the first source server in the wave started replication.
totalApplications (integer) --
Wave aggregated status total applications amount.
waveID (string) --
Wave ID.
nextToken (string) --
Response next token.
{'accountID': 'string'}
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
client.mark_as_archived(
accountID='string',
sourceServerID='string'
)
string
Mark as archived by Account ID.
string
[REQUIRED]
Mark as archived by Source Server ID.
dict
Response Syntax
{
'applicationID': 'string',
'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
},
]
},
'fqdnForActionFramework': 'string',
'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'|'PENDING_INSTALLATION'
},
'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'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
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.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
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.
(string) --
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.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
{'accountID': 'string'}
Put source server post migration custom action.
See also: AWS API Documentation
Request Syntax
client.put_source_server_action(
accountID='string',
actionID='string',
actionName='string',
active=True|False,
category='DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER',
description='string',
documentIdentifier='string',
documentVersion='string',
externalParameters={
'string': {
'dynamicPath': 'string'
}
},
mustSucceedForCutover=True|False,
order=123,
parameters={
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
sourceServerID='string',
timeoutSeconds=123
)
string
Source server post migration custom account ID.
string
[REQUIRED]
Source server post migration custom action ID.
string
[REQUIRED]
Source server post migration custom action name.
boolean
Source server post migration custom action active status.
string
Source server post migration custom action category.
string
Source server post migration custom action description.
string
[REQUIRED]
Source server post migration custom action document identifier.
string
Source server post migration custom action document version.
dict
Source server post migration custom action external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: dynamicPath.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
boolean
Source server post migration custom action must succeed for cutover.
integer
[REQUIRED]
Source server post migration custom action order.
dict
Source server post migration custom action parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter name.
parameterType (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter type.
string
[REQUIRED]
Source server ID.
integer
Source server post migration custom action timeout in seconds.
dict
Response Syntax
{
'actionID': 'string',
'actionName': 'string',
'active': True|False,
'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER',
'description': 'string',
'documentIdentifier': 'string',
'documentVersion': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'order': 123,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'timeoutSeconds': 123
}
Response Structure
(dict) --
actionID (string) --
Source server post migration custom action ID.
actionName (string) --
Source server post migration custom action name.
active (boolean) --
Source server post migration custom action active status.
category (string) --
Source server post migration custom action category.
description (string) --
Source server post migration custom action description.
documentIdentifier (string) --
Source server post migration custom action document identifier.
documentVersion (string) --
Source server post migration custom action document version.
externalParameters (dict) --
Source server post migration custom action external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
Source server post migration custom action must succeed for cutover.
order (integer) --
Source server post migration custom action order.
parameters (dict) --
Source server post migration custom action parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
timeoutSeconds (integer) --
Source server post migration custom action timeout in seconds.
{'accountID': 'string'}
Remove source server post migration custom action.
See also: AWS API Documentation
Request Syntax
client.remove_source_server_action(
accountID='string',
actionID='string',
sourceServerID='string'
)
string
Source server post migration account ID.
string
[REQUIRED]
Source server post migration custom action ID to remove.
string
[REQUIRED]
Source server ID of the post migration custom action to remove.
dict
Response Syntax
{}
Response Structure
(dict) --
{'accountID': 'string'}
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
client.retry_data_replication(
accountID='string',
sourceServerID='string'
)
string
Retry data replication for Account ID.
string
[REQUIRED]
Retry data replication for Source Server ID.
dict
Response Syntax
{
'applicationID': 'string',
'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
},
]
},
'fqdnForActionFramework': 'string',
'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'|'PENDING_INSTALLATION'
},
'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'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
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.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
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.
(string) --
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.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
{'accountID': 'string'}
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
client.start_cutover(
accountID='string',
sourceServerIDs=[
'string',
],
tags={
'string': 'string'
}
)
string
Start Cutover by Account IDs
list
[REQUIRED]
Start Cutover by Source Server IDs.
(string) --
dict
Start Cutover by Tags.
(string) --
(string) --
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',
'externalParameters': {
'string': {
'dynamicPath': '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's launched ec2 instance ID.
postLaunchActionsStatus (dict) --
Participating server's Post Launch Actions Status.
postLaunchActionsLaunchStatusList (list) --
List of Post Launch Action status.
(dict) --
Launch Status of the Job Post Launch Actions.
executionID (string) --
AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions.
executionStatus (string) --
AWS Systems Manager Document's execution status.
failureReason (string) --
AWS Systems Manager Document's failure reason.
ssmDocument (dict) --
AWS Systems Manager's Document of the of the Job Post Launch Actions.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
ssmDocumentType (string) --
AWS Systems Manager Document type.
ssmAgentDiscoveryDatetime (string) --
Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
type (string) --
Job type.
{'accountID': 'string'}
Starts replication for SNAPSHOT_SHIPPING agents.
See also: AWS API Documentation
Request Syntax
client.start_replication(
accountID='string',
sourceServerID='string'
)
string
Account ID on which to start replication.
string
[REQUIRED]
ID of source server on which to start replication.
dict
Response Syntax
{
'applicationID': 'string',
'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
},
]
},
'fqdnForActionFramework': 'string',
'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'|'PENDING_INSTALLATION'
},
'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'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
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.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
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.
(string) --
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.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
{'accountID': 'string'}
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
client.start_test(
accountID='string',
sourceServerIDs=[
'string',
],
tags={
'string': 'string'
}
)
string
Start Test for Account ID.
list
[REQUIRED]
Start Test for Source Server IDs.
(string) --
dict
Start Test by Tags.
(string) --
(string) --
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',
'externalParameters': {
'string': {
'dynamicPath': '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's launched ec2 instance ID.
postLaunchActionsStatus (dict) --
Participating server's Post Launch Actions Status.
postLaunchActionsLaunchStatusList (list) --
List of Post Launch Action status.
(dict) --
Launch Status of the Job Post Launch Actions.
executionID (string) --
AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions.
executionStatus (string) --
AWS Systems Manager Document's execution status.
failureReason (string) --
AWS Systems Manager Document's failure reason.
ssmDocument (dict) --
AWS Systems Manager's Document of the of the Job Post Launch Actions.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
ssmDocumentType (string) --
AWS Systems Manager Document type.
ssmAgentDiscoveryDatetime (string) --
Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
type (string) --
Job type.
{'accountID': 'string'}
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
client.terminate_target_instances(
accountID='string',
sourceServerIDs=[
'string',
],
tags={
'string': 'string'
}
)
string
Terminate Target instance by Account ID
list
[REQUIRED]
Terminate Target instance by Source Server IDs.
(string) --
dict
Terminate Target instance by Tags.
(string) --
(string) --
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',
'externalParameters': {
'string': {
'dynamicPath': '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's launched ec2 instance ID.
postLaunchActionsStatus (dict) --
Participating server's Post Launch Actions Status.
postLaunchActionsLaunchStatusList (list) --
List of Post Launch Action status.
(dict) --
Launch Status of the Job Post Launch Actions.
executionID (string) --
AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions.
executionStatus (string) --
AWS Systems Manager Document's execution status.
failureReason (string) --
AWS Systems Manager Document's failure reason.
ssmDocument (dict) --
AWS Systems Manager's Document of the of the Job Post Launch Actions.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
ssmDocumentType (string) --
AWS Systems Manager Document type.
ssmAgentDiscoveryDatetime (string) --
Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
type (string) --
Job type.
{'accountID': 'string'}
Unarchive application.
See also: AWS API Documentation
Request Syntax
client.unarchive_application(
accountID='string',
applicationID='string'
)
string
Account ID.
string
[REQUIRED]
Application ID.
dict
Response Syntax
{
'applicationAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'totalSourceServers': 123
},
'applicationID': 'string',
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveID': 'string'
}
Response Structure
(dict) --
applicationAggregatedStatus (dict) --
Application aggregated status.
healthStatus (string) --
Application aggregated status health status.
lastUpdateDateTime (string) --
Application aggregated status last update dateTime.
progressStatus (string) --
Application aggregated status progress status.
totalSourceServers (integer) --
Application aggregated status total source servers amount.
applicationID (string) --
Application ID.
arn (string) --
Application ARN.
creationDateTime (string) --
Application creation dateTime.
description (string) --
Application description.
isArchived (boolean) --
Application archival status.
lastModifiedDateTime (string) --
Application last modified dateTime.
name (string) --
Application name.
tags (dict) --
Application tags.
(string) --
(string) --
waveID (string) --
Application wave ID.
{'accountID': 'string'}
Unarchive wave.
See also: AWS API Documentation
Request Syntax
client.unarchive_wave(
accountID='string',
waveID='string'
)
string
Account ID.
string
[REQUIRED]
Wave ID.
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'replicationStartedDateTime': 'string',
'totalApplications': 123
},
'waveID': 'string'
}
Response Structure
(dict) --
arn (string) --
Wave ARN.
creationDateTime (string) --
Wave creation dateTime.
description (string) --
Wave description.
isArchived (boolean) --
Wave archival status.
lastModifiedDateTime (string) --
Wave last modified dateTime.
name (string) --
Wave name.
tags (dict) --
Wave tags.
(string) --
(string) --
waveAggregatedStatus (dict) --
Wave aggregated status.
healthStatus (string) --
Wave aggregated status health status.
lastUpdateDateTime (string) --
Wave aggregated status last update dateTime.
progressStatus (string) --
Wave aggregated status progress status.
replicationStartedDateTime (string) --
DateTime marking when the first source server in the wave started replication.
totalApplications (integer) --
Wave aggregated status total applications amount.
waveID (string) --
Wave ID.
{'accountID': 'string'}
Update application.
See also: AWS API Documentation
Request Syntax
client.update_application(
accountID='string',
applicationID='string',
description='string',
name='string'
)
string
Account ID.
string
[REQUIRED]
Application ID.
string
Application description.
string
Application name.
dict
Response Syntax
{
'applicationAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'totalSourceServers': 123
},
'applicationID': 'string',
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveID': 'string'
}
Response Structure
(dict) --
applicationAggregatedStatus (dict) --
Application aggregated status.
healthStatus (string) --
Application aggregated status health status.
lastUpdateDateTime (string) --
Application aggregated status last update dateTime.
progressStatus (string) --
Application aggregated status progress status.
totalSourceServers (integer) --
Application aggregated status total source servers amount.
applicationID (string) --
Application ID.
arn (string) --
Application ARN.
creationDateTime (string) --
Application creation dateTime.
description (string) --
Application description.
isArchived (boolean) --
Application archival status.
lastModifiedDateTime (string) --
Application last modified dateTime.
name (string) --
Application name.
tags (dict) --
Application tags.
(string) --
(string) --
waveID (string) --
Application wave ID.
{'accountID': 'string'}
Updates multiple LaunchConfigurations by Source Server ID.
See also: AWS API Documentation
Request Syntax
client.update_launch_configuration(
accountID='string',
bootMode='LEGACY_BIOS'|'UEFI',
copyPrivateIp=True|False,
copyTags=True|False,
enableMapAutoTagging=True|False,
launchDisposition='STOPPED'|'STARTED',
licensing={
'osByol': True|False
},
mapAutoTaggingMpeID='string',
name='string',
postLaunchActions={
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
sourceServerID='string',
targetInstanceTypeRightSizingMethod='NONE'|'BASIC'
)
string
Update Launch configuration Account ID.
string
Update Launch configuration boot mode request.
boolean
Update Launch configuration copy Private IP request.
boolean
Update Launch configuration copy Tags request.
boolean
Enable map auto tagging.
string
Update Launch configuration launch disposition request.
dict
Update Launch configuration licensing request.
osByol (boolean) --
Configure BYOL OS licensing.
string
Launch configuration map auto tagging MPE ID.
string
Update Launch configuration name request.
dict
Post Launch Actions to executed on the Test or Cutover instance.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
deployment (string) --
Deployment type in which AWS Systems Manager Documents will be executed.
s3LogBucket (string) --
AWS Systems Manager Command's logs S3 log bucket.
s3OutputKeyPrefix (string) --
AWS Systems Manager Command's logs S3 output key prefix.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) -- [REQUIRED]
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: dynamicPath.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter name.
parameterType (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) -- [REQUIRED]
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
string
[REQUIRED]
Update Launch configuration by Source Server ID request.
string
Update Launch configuration Target instance right sizing request.
dict
Response Syntax
{
'bootMode': 'LEGACY_BIOS'|'UEFI',
'copyPrivateIp': True|False,
'copyTags': True|False,
'ec2LaunchTemplateID': 'string',
'enableMapAutoTagging': True|False,
'launchDisposition': 'STOPPED'|'STARTED',
'licensing': {
'osByol': True|False
},
'mapAutoTaggingMpeID': 'string',
'name': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'externalParameters': {
'string': {
'dynamicPath': '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.
enableMapAutoTagging (boolean) --
Enable map auto tagging.
launchDisposition (string) --
Launch disposition for launch configuration.
licensing (dict) --
Launch configuration OS licensing.
osByol (boolean) --
Configure BYOL OS licensing.
mapAutoTaggingMpeID (string) --
Map auto tagging MPE ID.
name (string) --
Launch configuration name.
postLaunchActions (dict) --
Post Launch Actions to executed on the Test or Cutover instance.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
deployment (string) --
Deployment type in which AWS Systems Manager Documents will be executed.
s3LogBucket (string) --
AWS Systems Manager Command's logs S3 log bucket.
s3OutputKeyPrefix (string) --
AWS Systems Manager Command's logs S3 output key prefix.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
sourceServerID (string) --
Launch configuration Source Server ID.
targetInstanceTypeRightSizingMethod (string) --
Launch configuration Target instance type right sizing method.
{'accountID': 'string', 'useFipsEndpoint': 'boolean'}
Response {'useFipsEndpoint': 'boolean'}
Allows you to update multiple ReplicationConfigurations by Source Server ID.
See also: AWS API Documentation
Request Syntax
client.update_replication_configuration(
accountID='string',
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,
useFipsEndpoint=True|False
)
string
Update replication configuration Account ID request.
boolean
Update replication configuration associate default Application Migration Service Security group request.
integer
Update replication configuration bandwidth throttling request.
boolean
Update replication configuration create Public IP request.
string
Update replication configuration data plane routing request.
string
Update replication configuration use default large Staging Disk type request.
string
Update replication configuration EBS encryption request.
string
Update replication configuration EBS encryption key ARN request.
string
Update replication configuration name request.
list
Update replication configuration replicated disks request.
(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.
string
Update replication configuration Replication Server instance type request.
list
Update replication configuration Replication Server Security Groups IDs request.
(string) --
string
[REQUIRED]
Update replication configuration Source Server ID request.
string
Update replication configuration Staging Area subnet request.
dict
Update replication configuration Staging Area Tags request.
(string) --
(string) --
boolean
Update replication configuration use dedicated Replication Server request.
boolean
Update replication configuration use Fips Endpoint.
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,
'useFipsEndpoint': 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.
(string) --
sourceServerID (string) --
Replication Configuration Source Server ID.
stagingAreaSubnetId (string) --
Replication Configuration Staging Area subnet ID.
stagingAreaTags (dict) --
Replication Configuration Staging Area tags.
(string) --
(string) --
useDedicatedReplicationServer (boolean) --
Replication Configuration use Dedicated Replication Server.
useFipsEndpoint (boolean) --
Replication Configuration use Fips Endpoint.
{'useFipsEndpoint': 'boolean'}
Updates multiple ReplicationConfigurationTemplates by ID.
See also: AWS API Documentation
Request Syntax
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,
useFipsEndpoint=True|False
)
string
Update replication configuration template ARN request.
boolean
Update replication configuration template associate default Application Migration Service Security group request.
integer
Update replication configuration template bandwidth throttling request.
boolean
Update replication configuration template create Public IP request.
string
Update replication configuration template data plane routing request.
string
Update replication configuration template use default large Staging Disk type request.
string
Update replication configuration template EBS encryption request.
string
Update replication configuration template EBS encryption key ARN request.
string
[REQUIRED]
Update replication configuration template template ID request.
string
Update replication configuration template Replication Server instance type request.
list
Update replication configuration template Replication Server Security groups IDs request.
(string) --
string
Update replication configuration template Staging Area subnet ID request.
dict
Update replication configuration template Staging Area Tags request.
(string) --
(string) --
boolean
Update replication configuration template use dedicated Replication Server request.
boolean
Update replication configuration template use Fips Endpoint 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,
'useFipsEndpoint': 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.
(string) --
stagingAreaSubnetId (string) --
Replication Configuration template Staging Area subnet ID.
stagingAreaTags (dict) --
Replication Configuration template Staging Area Tags.
(string) --
(string) --
tags (dict) --
Replication Configuration template Tags.
(string) --
(string) --
useDedicatedReplicationServer (boolean) --
Replication Configuration template use Dedicated Replication Server.
useFipsEndpoint (boolean) --
Replication Configuration template use Fips Endpoint.
{'accountID': 'string'}
Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.
See also: AWS API Documentation
Request Syntax
client.update_source_server_replication_type(
accountID='string',
replicationType='AGENT_BASED'|'SNAPSHOT_SHIPPING',
sourceServerID='string'
)
string
Account ID on which to update replication type.
string
[REQUIRED]
Replication type to which to update source server.
string
[REQUIRED]
ID of source server on which to update replication type.
dict
Response Syntax
{
'applicationID': 'string',
'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
},
]
},
'fqdnForActionFramework': 'string',
'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'|'PENDING_INSTALLATION'
},
'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'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
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.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
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.
(string) --
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.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
{'accountID': 'string'}
Update wave.
See also: AWS API Documentation
Request Syntax
client.update_wave(
accountID='string',
description='string',
name='string',
waveID='string'
)
string
Account ID.
string
Wave description.
string
Wave name.
string
[REQUIRED]
Wave ID.
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'replicationStartedDateTime': 'string',
'totalApplications': 123
},
'waveID': 'string'
}
Response Structure
(dict) --
arn (string) --
Wave ARN.
creationDateTime (string) --
Wave creation dateTime.
description (string) --
Wave description.
isArchived (boolean) --
Wave archival status.
lastModifiedDateTime (string) --
Wave last modified dateTime.
name (string) --
Wave name.
tags (dict) --
Wave tags.
(string) --
(string) --
waveAggregatedStatus (dict) --
Wave aggregated status.
healthStatus (string) --
Wave aggregated status health status.
lastUpdateDateTime (string) --
Wave aggregated status last update dateTime.
progressStatus (string) --
Wave aggregated status progress status.
replicationStartedDateTime (string) --
DateTime marking when the first source server in the wave started replication.
totalApplications (integer) --
Wave aggregated status total applications amount.
waveID (string) --
Wave ID.