2025/12/09 - Application Migration Service - 35 updated api methods
Changes Added parameters encryption, IPv4/IPv6 protocol configuration, and enhanced tagging support for replication operations.
{'dataReplicationInfo': {'replicatorId': '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(
sourceServerID='string',
lifeCycle={
'state': 'READY_FOR_TEST'|'READY_FOR_CUTOVER'|'CUTOVER'
},
accountID='string'
)
string
[REQUIRED]
The request to change the source server migration lifecycle state by source server 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
The request to change the source server migration account ID.
dict
Response Syntax
{
'sourceServerID': 'string',
'arn': 'string',
'isArchived': True|False,
'tags': {
'string': 'string'
},
'launchedInstance': {
'ec2InstanceID': 'string',
'jobID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED'
},
'dataReplicationInfo': {
'lagDuration': 'string',
'etaDateTime': 'string',
'replicatedDisks': [
{
'deviceName': 'string',
'totalStorageBytes': 123,
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'backloggedStorageBytes': 123
},
],
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'dataReplicationInitiation': {
'startDateTime': 'string',
'nextAttemptDateTime': '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'
},
]
},
'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'
},
'lastSnapshotDateTime': 'string',
'replicatorId': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'firstByteDateTime': 'string',
'elapsedReplicationDuration': 'string',
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'lastCutover': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'sourceProperties': {
'lastUpdatedDateTime': 'string',
'recommendedInstanceType': 'string',
'identificationHints': {
'fqdn': 'string',
'hostname': 'string',
'vmWareUuid': 'string',
'awsInstanceID': 'string',
'vmPath': 'string'
},
'networkInterfaces': [
{
'macAddress': 'string',
'ips': [
'string',
],
'isPrimary': True|False
},
],
'disks': [
{
'deviceName': 'string',
'bytes': 123
},
],
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'ramBytes': 123,
'os': {
'fullString': 'string'
}
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'vcenterClientID': 'string',
'applicationID': 'string',
'userProvidedID': 'string',
'fqdnForActionFramework': 'string',
'connectorAction': {
'credentialsSecretArn': 'string',
'connectorArn': 'string'
}
}
Response Structure
(dict) --
sourceServerID (string) --
Source server ID.
arn (string) --
Source server ARN.
isArchived (boolean) --
Source server archived status.
tags (dict) --
Source server Tags.
(string) --
(string) --
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
jobID (string) --
Launched instance Job ID.
firstBoot (string) --
Launched instance first boot.
dataReplicationInfo (dict) --
Source server data replication info.
lagDuration (string) --
Request to query data replication lag duration.
etaDateTime (string) --
Request to query the time when data replication will be complete.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
deviceName (string) --
Request to query device name.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
dataReplicationState (string) --
Request to query the data replication state.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
startDateTime (string) --
Request to query data initiation start date and time.
nextAttemptDateTime (string) --
Request to query next data initiation 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.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatorId (string) --
Replication server instance ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
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.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
lastCutover (dict) --
Lifecycle last Cutover.
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.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
state (string) --
Lifecycle state.
sourceProperties (dict) --
Source server properties.
lastUpdatedDateTime (string) --
Source server last update date and time.
recommendedInstanceType (string) --
Source server recommended instance type.
identificationHints (dict) --
Source server identification hints.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
awsInstanceID (string) --
AWS Instance ID identification hint.
vmPath (string) --
vCenter VM path identification hint.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
macAddress (string) --
Network interface Mac address.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
deviceName (string) --
The disk or device name.
bytes (integer) --
The amount of storage on the disk in bytes.
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.
ramBytes (integer) --
Source server RAM in bytes.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
replicationType (string) --
Source server replication type.
vcenterClientID (string) --
Source server vCenter client id.
applicationID (string) --
Source server application ID.
userProvidedID (string) --
Source server user provided ID.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
connectorAction (dict) --
Source Server connector action.
credentialsSecretArn (string) --
Source Server connector action credentials secret arn.
connectorArn (string) --
Source Server connector action connector arn.
{'enableParametersEncryption': 'boolean',
'parametersEncryptionKey': 'string',
'postLaunchActions': {'ssmDocuments': {'parameters': {'parameterType': {'SECURE_STRING'}}}}}
Creates a new Launch Configuration Template.
See also: AWS API Documentation
Request Syntax
client.create_launch_configuration_template(
postLaunchActions={
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'cloudWatchLogGroupName': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'ssmDocumentName': 'string',
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
}
},
]
},
enableMapAutoTagging=True|False,
mapAutoTaggingMpeID='string',
tags={
'string': 'string'
},
launchDisposition='STOPPED'|'STARTED',
targetInstanceTypeRightSizingMethod='NONE'|'BASIC',
copyPrivateIp=True|False,
associatePublicIpAddress=True|False,
copyTags=True|False,
licensing={
'osByol': True|False
},
bootMode='LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
smallVolumeMaxSize=123,
smallVolumeConf={
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
'iops': 123,
'throughput': 123
},
largeVolumeConf={
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
'iops': 123,
'throughput': 123
},
enableParametersEncryption=True|False,
parametersEncryptionKey='string'
)
dict
Launch configuration template post launch actions.
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.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) -- [REQUIRED]
User-friendly name for the AWS Systems Manager Document.
ssmDocumentName (string) -- [REQUIRED]
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
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.
parameterType (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter type.
parameterName (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter name.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
boolean
Enable map auto tagging.
string
Launch configuration template map auto tagging MPE ID.
dict
Request to associate tags during creation of a Launch Configuration Template.
(string) --
(string) --
string
Launch disposition.
string
Target instance type right-sizing method.
boolean
Copy private Ip.
boolean
Associate public Ip address.
boolean
Copy tags.
dict
Configure Licensing.
osByol (boolean) --
Configure BYOL OS licensing.
string
Launch configuration template boot mode.
integer
Small volume maximum size.
dict
Small volume config.
volumeType (string) --
Launch template disk volume type configuration.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
dict
Large volume config.
volumeType (string) --
Launch template disk volume type configuration.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
boolean
Enable parameters encryption.
string
Parameters encryption key.
dict
Response Syntax
{
'launchConfigurationTemplateID': 'string',
'arn': 'string',
'postLaunchActions': {
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'cloudWatchLogGroupName': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'ssmDocumentName': 'string',
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
}
},
]
},
'enableMapAutoTagging': True|False,
'mapAutoTaggingMpeID': 'string',
'tags': {
'string': 'string'
},
'ec2LaunchTemplateID': 'string',
'launchDisposition': 'STOPPED'|'STARTED',
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC',
'copyPrivateIp': True|False,
'associatePublicIpAddress': True|False,
'copyTags': True|False,
'licensing': {
'osByol': True|False
},
'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
'smallVolumeMaxSize': 123,
'smallVolumeConf': {
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
'iops': 123,
'throughput': 123
},
'largeVolumeConf': {
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
'iops': 123,
'throughput': 123
},
'enableParametersEncryption': True|False,
'parametersEncryptionKey': 'string'
}
Response Structure
(dict) --
launchConfigurationTemplateID (string) --
ID of the Launch Configuration Template.
arn (string) --
ARN of the Launch Configuration Template.
postLaunchActions (dict) --
Post Launch Actions of the Launch Configuration Template.
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.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
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.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
enableMapAutoTagging (boolean) --
Enable map auto tagging.
mapAutoTaggingMpeID (string) --
Launch configuration template map auto tagging MPE ID.
tags (dict) --
Tags of the Launch Configuration Template.
(string) --
(string) --
ec2LaunchTemplateID (string) --
EC2 launch template ID.
launchDisposition (string) --
Launch disposition.
targetInstanceTypeRightSizingMethod (string) --
Target instance type right-sizing method.
copyPrivateIp (boolean) --
Copy private Ip.
associatePublicIpAddress (boolean) --
Associate public Ip address.
copyTags (boolean) --
Copy tags.
licensing (dict) --
Configure Licensing.
osByol (boolean) --
Configure BYOL OS licensing.
bootMode (string) --
Launch configuration template boot mode.
smallVolumeMaxSize (integer) --
Small volume maximum size.
smallVolumeConf (dict) --
Small volume config.
volumeType (string) --
Launch template disk volume type configuration.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
largeVolumeConf (dict) --
Large volume config.
volumeType (string) --
Launch template disk volume type configuration.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
enableParametersEncryption (boolean) --
Enable parameters encryption.
parametersEncryptionKey (string) --
Parameters encryption key.
{'internetProtocol': 'IPV4 | IPV6'}
Creates a new ReplicationConfigurationTemplate.
See also: AWS API Documentation
Request Syntax
client.create_replication_configuration_template(
stagingAreaSubnetId='string',
associateDefaultSecurityGroup=True|False,
replicationServersSecurityGroupsIDs=[
'string',
],
replicationServerInstanceType='string',
useDedicatedReplicationServer=True|False,
defaultLargeStagingDiskType='GP2'|'ST1'|'GP3',
ebsEncryption='DEFAULT'|'CUSTOM',
ebsEncryptionKeyArn='string',
bandwidthThrottling=123,
dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP',
createPublicIP=True|False,
stagingAreaTags={
'string': 'string'
},
useFipsEndpoint=True|False,
tags={
'string': 'string'
},
internetProtocol='IPV4'|'IPV6'
)
string
[REQUIRED]
Request to configure the Staging Area subnet ID during Replication Settings template creation.
boolean
[REQUIRED]
Request to associate the default Application Migration Service Security group with the Replication Settings template.
list
[REQUIRED]
Request to configure the Replication Server Security group ID during Replication Settings template creation.
(string) --
string
[REQUIRED]
Request to configure the Replication Server instance type during Replication Settings template creation.
boolean
[REQUIRED]
Request to use Dedicated Replication Servers 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.
integer
[REQUIRED]
Request to configure bandwidth throttling during Replication Settings template creation.
string
[REQUIRED]
Request to configure data plane routing during Replication Settings template creation.
boolean
[REQUIRED]
Request to create Public IP during Replication Settings template creation.
dict
[REQUIRED]
Request to configure Staging Area tags during Replication Settings template creation.
(string) --
(string) --
boolean
Request to use Fips Endpoint during Replication Settings template creation.
dict
Request to configure tags during Replication Settings template creation.
(string) --
(string) --
string
Request to configure the internet protocol to IPv4 or IPv6.
dict
Response Syntax
{
'replicationConfigurationTemplateID': 'string',
'arn': 'string',
'stagingAreaSubnetId': 'string',
'associateDefaultSecurityGroup': True|False,
'replicationServersSecurityGroupsIDs': [
'string',
],
'replicationServerInstanceType': 'string',
'useDedicatedReplicationServer': True|False,
'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'bandwidthThrottling': 123,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'createPublicIP': True|False,
'stagingAreaTags': {
'string': 'string'
},
'useFipsEndpoint': True|False,
'tags': {
'string': 'string'
},
'internetProtocol': 'IPV4'|'IPV6'
}
Response Structure
(dict) --
replicationConfigurationTemplateID (string) --
Replication Configuration template ID.
arn (string) --
Replication Configuration template ARN.
stagingAreaSubnetId (string) --
Replication Configuration template Staging Area subnet ID.
associateDefaultSecurityGroup (boolean) --
Replication Configuration template associate default Application Migration Service Security group.
replicationServersSecurityGroupsIDs (list) --
Replication Configuration template server Security Groups IDs.
(string) --
replicationServerInstanceType (string) --
Replication Configuration template server instance type.
useDedicatedReplicationServer (boolean) --
Replication Configuration template use Dedicated Replication Server.
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.
bandwidthThrottling (integer) --
Replication Configuration template bandwidth throttling.
dataPlaneRouting (string) --
Replication Configuration template data plane routing.
createPublicIP (boolean) --
Replication Configuration template create Public IP.
stagingAreaTags (dict) --
Replication Configuration template Staging Area Tags.
(string) --
(string) --
useFipsEndpoint (boolean) --
Replication Configuration template use Fips Endpoint.
tags (dict) --
Replication Configuration template Tags.
(string) --
(string) --
internetProtocol (string) --
Replication Configuration template internet protocol.
{'items': {'eventData': {'attemptCount': 'integer',
'maxAttemptsCount': 'integer'}}}
Retrieves detailed job log items with paging.
See also: AWS API Documentation
Request Syntax
client.describe_job_log_items(
jobID='string',
maxResults=123,
nextToken='string',
accountID='string'
)
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.
string
Request to describe Job log Account ID.
dict
Response Syntax
{
'items': [
{
'logDateTime': 'string',
'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': {
'sourceServerID': 'string',
'conversionServerID': 'string',
'targetInstanceID': 'string',
'rawError': 'string',
'attemptCount': 123,
'maxAttemptsCount': 123
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to describe Job log response items.
(dict) --
Job log.
logDateTime (string) --
Job log event date and time.
event (string) --
Job log event.
eventData (dict) --
Job event data
sourceServerID (string) --
Job Event Source Server ID.
conversionServerID (string) --
Job Event conversion Server ID.
targetInstanceID (string) --
Job Event Target instance ID.
rawError (string) --
Job error.
attemptCount (integer) --
Retries for this operation.
maxAttemptsCount (integer) --
The maximum number of retries that will be attempted if this operation failed.
nextToken (string) --
Request to describe Job log response next token.
{'items': {'participatingServers': {'postLaunchActionsStatus': {'postLaunchActionsLaunchStatusList': {'ssmDocument': {'parameters': {'parameterType': {'SECURE_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(
filters={
'jobIDs': [
'string',
],
'fromDate': 'string',
'toDate': 'string'
},
maxResults=123,
nextToken='string',
accountID='string'
)
dict
Request to describe Job log filters.
jobIDs (list) --
Request to describe Job log filters by job ID.
(string) --
fromDate (string) --
Request to describe Job log filters by date.
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.
string
Request to describe job log items by Account ID.
dict
Response Syntax
{
'items': [
{
'jobID': 'string',
'arn': 'string',
'type': 'LAUNCH'|'TERMINATE',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'creationDateTime': 'string',
'endDateTime': 'string',
'status': 'PENDING'|'STARTED'|'COMPLETED',
'participatingServers': [
{
'sourceServerID': 'string',
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'ssmAgentDiscoveryDatetime': 'string',
'postLaunchActionsLaunchStatusList': [
{
'ssmDocument': {
'actionName': 'string',
'ssmDocumentName': 'string',
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
}
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND',
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string'
},
]
}
},
],
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to describe Job log items.
(dict) --
Job.
jobID (string) --
Job ID.
arn (string) --
the ARN of the specific Job.
type (string) --
Job type.
initiatedBy (string) --
Job initiated by field.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
status (string) --
Job status.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
sourceServerID (string) --
Participating server Source Server ID.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server's launched ec2 instance ID.
postLaunchActionsStatus (dict) --
Participating server's Post Launch Actions Status.
ssmAgentDiscoveryDatetime (string) --
Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.
postLaunchActionsLaunchStatusList (list) --
List of Post Launch Action status.
(dict) --
Launch Status of the Job Post Launch Actions.
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.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
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.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
ssmDocumentType (string) --
AWS Systems Manager Document type.
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.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
nextToken (string) --
Request to describe Job response by next token.
{'items': {'enableParametersEncryption': 'boolean',
'parametersEncryptionKey': 'string',
'postLaunchActions': {'ssmDocuments': {'parameters': {'parameterType': {'SECURE_STRING'}}}}}}
Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs
See also: AWS API Documentation
Request Syntax
client.describe_launch_configuration_templates(
launchConfigurationTemplateIDs=[
'string',
],
maxResults=123,
nextToken='string'
)
list
Request to filter Launch Configuration Templates list by Launch Configuration Template ID.
(string) --
integer
Maximum results to be returned in DescribeLaunchConfigurationTemplates.
string
Next pagination token returned from DescribeLaunchConfigurationTemplates.
dict
Response Syntax
{
'items': [
{
'launchConfigurationTemplateID': 'string',
'arn': 'string',
'postLaunchActions': {
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'cloudWatchLogGroupName': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'ssmDocumentName': 'string',
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
}
},
]
},
'enableMapAutoTagging': True|False,
'mapAutoTaggingMpeID': 'string',
'tags': {
'string': 'string'
},
'ec2LaunchTemplateID': 'string',
'launchDisposition': 'STOPPED'|'STARTED',
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC',
'copyPrivateIp': True|False,
'associatePublicIpAddress': True|False,
'copyTags': True|False,
'licensing': {
'osByol': True|False
},
'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
'smallVolumeMaxSize': 123,
'smallVolumeConf': {
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
'iops': 123,
'throughput': 123
},
'largeVolumeConf': {
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
'iops': 123,
'throughput': 123
},
'enableParametersEncryption': True|False,
'parametersEncryptionKey': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
List of items returned by DescribeLaunchConfigurationTemplates.
(dict) --
launchConfigurationTemplateID (string) --
ID of the Launch Configuration Template.
arn (string) --
ARN of the Launch Configuration Template.
postLaunchActions (dict) --
Post Launch Actions of the Launch Configuration Template.
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.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
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.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
enableMapAutoTagging (boolean) --
Enable map auto tagging.
mapAutoTaggingMpeID (string) --
Launch configuration template map auto tagging MPE ID.
tags (dict) --
Tags of the Launch Configuration Template.
(string) --
(string) --
ec2LaunchTemplateID (string) --
EC2 launch template ID.
launchDisposition (string) --
Launch disposition.
targetInstanceTypeRightSizingMethod (string) --
Target instance type right-sizing method.
copyPrivateIp (boolean) --
Copy private Ip.
associatePublicIpAddress (boolean) --
Associate public Ip address.
copyTags (boolean) --
Copy tags.
licensing (dict) --
Configure Licensing.
osByol (boolean) --
Configure BYOL OS licensing.
bootMode (string) --
Launch configuration template boot mode.
smallVolumeMaxSize (integer) --
Small volume maximum size.
smallVolumeConf (dict) --
Small volume config.
volumeType (string) --
Launch template disk volume type configuration.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
largeVolumeConf (dict) --
Large volume config.
volumeType (string) --
Launch template disk volume type configuration.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
enableParametersEncryption (boolean) --
Enable parameters encryption.
parametersEncryptionKey (string) --
Parameters encryption key.
nextToken (string) --
Next pagination token returned from DescribeLaunchConfigurationTemplates.
{'items': {'internetProtocol': 'IPV4 | IPV6'}}
Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
See also: AWS API Documentation
Request Syntax
client.describe_replication_configuration_templates(
replicationConfigurationTemplateIDs=[
'string',
],
maxResults=123,
nextToken='string'
)
list
Request to describe Replication Configuration template by template IDs.
(string) --
integer
Request to describe Replication Configuration template by max results.
string
Request to describe Replication Configuration template by next token.
dict
Response Syntax
{
'items': [
{
'replicationConfigurationTemplateID': 'string',
'arn': 'string',
'stagingAreaSubnetId': 'string',
'associateDefaultSecurityGroup': True|False,
'replicationServersSecurityGroupsIDs': [
'string',
],
'replicationServerInstanceType': 'string',
'useDedicatedReplicationServer': True|False,
'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'bandwidthThrottling': 123,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'createPublicIP': True|False,
'stagingAreaTags': {
'string': 'string'
},
'useFipsEndpoint': True|False,
'tags': {
'string': 'string'
},
'internetProtocol': 'IPV4'|'IPV6'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to describe Replication Configuration template by items.
(dict) --
replicationConfigurationTemplateID (string) --
Replication Configuration template ID.
arn (string) --
Replication Configuration template ARN.
stagingAreaSubnetId (string) --
Replication Configuration template Staging Area subnet ID.
associateDefaultSecurityGroup (boolean) --
Replication Configuration template associate default Application Migration Service Security group.
replicationServersSecurityGroupsIDs (list) --
Replication Configuration template server Security Groups IDs.
(string) --
replicationServerInstanceType (string) --
Replication Configuration template server instance type.
useDedicatedReplicationServer (boolean) --
Replication Configuration template use Dedicated Replication Server.
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.
bandwidthThrottling (integer) --
Replication Configuration template bandwidth throttling.
dataPlaneRouting (string) --
Replication Configuration template data plane routing.
createPublicIP (boolean) --
Replication Configuration template create Public IP.
stagingAreaTags (dict) --
Replication Configuration template Staging Area Tags.
(string) --
(string) --
useFipsEndpoint (boolean) --
Replication Configuration template use Fips Endpoint.
tags (dict) --
Replication Configuration template Tags.
(string) --
(string) --
internetProtocol (string) --
Replication Configuration template internet protocol.
nextToken (string) --
Request to describe Replication Configuration template by next token.
{'items': {'dataReplicationInfo': {'replicatorId': 'string'}}}
Retrieves all SourceServers or multiple SourceServers by ID.
See also: AWS API Documentation
Request Syntax
client.describe_source_servers(
filters={
'sourceServerIDs': [
'string',
],
'isArchived': True|False,
'replicationTypes': [
'AGENT_BASED'|'SNAPSHOT_SHIPPING',
],
'lifeCycleStates': [
'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION',
],
'applicationIDs': [
'string',
]
},
maxResults=123,
nextToken='string',
accountID='string'
)
dict
Request to filter Source Servers list.
sourceServerIDs (list) --
Request to filter Source Servers list by Source Server ID.
(string) --
isArchived (boolean) --
Request to filter Source Servers list by archived.
replicationTypes (list) --
Request to filter Source Servers list by replication type.
(string) --
lifeCycleStates (list) --
Request to filter Source Servers list by life cycle states.
(string) --
applicationIDs (list) --
Request to filter Source Servers list by application IDs.
(string) --
integer
Request to filter Source Servers list by maximum results.
string
Request to filter Source Servers list by next token.
string
Request to filter Source Servers list by Accoun ID.
dict
Response Syntax
{
'items': [
{
'sourceServerID': 'string',
'arn': 'string',
'isArchived': True|False,
'tags': {
'string': 'string'
},
'launchedInstance': {
'ec2InstanceID': 'string',
'jobID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED'
},
'dataReplicationInfo': {
'lagDuration': 'string',
'etaDateTime': 'string',
'replicatedDisks': [
{
'deviceName': 'string',
'totalStorageBytes': 123,
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'backloggedStorageBytes': 123
},
],
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'dataReplicationInitiation': {
'startDateTime': 'string',
'nextAttemptDateTime': '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'
},
]
},
'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'
},
'lastSnapshotDateTime': 'string',
'replicatorId': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'firstByteDateTime': 'string',
'elapsedReplicationDuration': 'string',
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'lastCutover': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'sourceProperties': {
'lastUpdatedDateTime': 'string',
'recommendedInstanceType': 'string',
'identificationHints': {
'fqdn': 'string',
'hostname': 'string',
'vmWareUuid': 'string',
'awsInstanceID': 'string',
'vmPath': 'string'
},
'networkInterfaces': [
{
'macAddress': 'string',
'ips': [
'string',
],
'isPrimary': True|False
},
],
'disks': [
{
'deviceName': 'string',
'bytes': 123
},
],
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'ramBytes': 123,
'os': {
'fullString': 'string'
}
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'vcenterClientID': 'string',
'applicationID': 'string',
'userProvidedID': 'string',
'fqdnForActionFramework': 'string',
'connectorAction': {
'credentialsSecretArn': 'string',
'connectorArn': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to filter Source Servers list by item.
(dict) --
sourceServerID (string) --
Source server ID.
arn (string) --
Source server ARN.
isArchived (boolean) --
Source server archived status.
tags (dict) --
Source server Tags.
(string) --
(string) --
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
jobID (string) --
Launched instance Job ID.
firstBoot (string) --
Launched instance first boot.
dataReplicationInfo (dict) --
Source server data replication info.
lagDuration (string) --
Request to query data replication lag duration.
etaDateTime (string) --
Request to query the time when data replication will be complete.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
deviceName (string) --
Request to query device name.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
dataReplicationState (string) --
Request to query the data replication state.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
startDateTime (string) --
Request to query data initiation start date and time.
nextAttemptDateTime (string) --
Request to query next data initiation 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.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatorId (string) --
Replication server instance ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
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.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
lastCutover (dict) --
Lifecycle last Cutover.
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.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
state (string) --
Lifecycle state.
sourceProperties (dict) --
Source server properties.
lastUpdatedDateTime (string) --
Source server last update date and time.
recommendedInstanceType (string) --
Source server recommended instance type.
identificationHints (dict) --
Source server identification hints.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
awsInstanceID (string) --
AWS Instance ID identification hint.
vmPath (string) --
vCenter VM path identification hint.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
macAddress (string) --
Network interface Mac address.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
deviceName (string) --
The disk or device name.
bytes (integer) --
The amount of storage on the disk in bytes.
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.
ramBytes (integer) --
Source server RAM in bytes.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
replicationType (string) --
Source server replication type.
vcenterClientID (string) --
Source server vCenter client id.
applicationID (string) --
Source server application ID.
userProvidedID (string) --
Source server user provided ID.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
connectorAction (dict) --
Source Server connector action.
credentialsSecretArn (string) --
Source Server connector action credentials secret arn.
connectorArn (string) --
Source Server connector action connector arn.
nextToken (string) --
Request to filter Source Servers next token.
{'dataReplicationInfo': {'replicatorId': '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(
sourceServerID='string',
accountID='string'
)
string
[REQUIRED]
Request to disconnect Source Server from service by Server ID.
string
Request to disconnect Source Server from service by Account ID.
dict
Response Syntax
{
'sourceServerID': 'string',
'arn': 'string',
'isArchived': True|False,
'tags': {
'string': 'string'
},
'launchedInstance': {
'ec2InstanceID': 'string',
'jobID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED'
},
'dataReplicationInfo': {
'lagDuration': 'string',
'etaDateTime': 'string',
'replicatedDisks': [
{
'deviceName': 'string',
'totalStorageBytes': 123,
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'backloggedStorageBytes': 123
},
],
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'dataReplicationInitiation': {
'startDateTime': 'string',
'nextAttemptDateTime': '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'
},
]
},
'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'
},
'lastSnapshotDateTime': 'string',
'replicatorId': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'firstByteDateTime': 'string',
'elapsedReplicationDuration': 'string',
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'lastCutover': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'sourceProperties': {
'lastUpdatedDateTime': 'string',
'recommendedInstanceType': 'string',
'identificationHints': {
'fqdn': 'string',
'hostname': 'string',
'vmWareUuid': 'string',
'awsInstanceID': 'string',
'vmPath': 'string'
},
'networkInterfaces': [
{
'macAddress': 'string',
'ips': [
'string',
],
'isPrimary': True|False
},
],
'disks': [
{
'deviceName': 'string',
'bytes': 123
},
],
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'ramBytes': 123,
'os': {
'fullString': 'string'
}
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'vcenterClientID': 'string',
'applicationID': 'string',
'userProvidedID': 'string',
'fqdnForActionFramework': 'string',
'connectorAction': {
'credentialsSecretArn': 'string',
'connectorArn': 'string'
}
}
Response Structure
(dict) --
sourceServerID (string) --
Source server ID.
arn (string) --
Source server ARN.
isArchived (boolean) --
Source server archived status.
tags (dict) --
Source server Tags.
(string) --
(string) --
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
jobID (string) --
Launched instance Job ID.
firstBoot (string) --
Launched instance first boot.
dataReplicationInfo (dict) --
Source server data replication info.
lagDuration (string) --
Request to query data replication lag duration.
etaDateTime (string) --
Request to query the time when data replication will be complete.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
deviceName (string) --
Request to query device name.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
dataReplicationState (string) --
Request to query the data replication state.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
startDateTime (string) --
Request to query data initiation start date and time.
nextAttemptDateTime (string) --
Request to query next data initiation 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.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatorId (string) --
Replication server instance ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
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.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
lastCutover (dict) --
Lifecycle last Cutover.
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.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
state (string) --
Lifecycle state.
sourceProperties (dict) --
Source server properties.
lastUpdatedDateTime (string) --
Source server last update date and time.
recommendedInstanceType (string) --
Source server recommended instance type.
identificationHints (dict) --
Source server identification hints.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
awsInstanceID (string) --
AWS Instance ID identification hint.
vmPath (string) --
vCenter VM path identification hint.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
macAddress (string) --
Network interface Mac address.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
deviceName (string) --
The disk or device name.
bytes (integer) --
The amount of storage on the disk in bytes.
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.
ramBytes (integer) --
Source server RAM in bytes.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
replicationType (string) --
Source server replication type.
vcenterClientID (string) --
Source server vCenter client id.
applicationID (string) --
Source server application ID.
userProvidedID (string) --
Source server user provided ID.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
connectorAction (dict) --
Source Server connector action.
credentialsSecretArn (string) --
Source Server connector action credentials secret arn.
connectorArn (string) --
Source Server connector action connector arn.
{'dataReplicationInfo': {'replicatorId': '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(
sourceServerID='string',
accountID='string'
)
string
[REQUIRED]
Request to finalize Cutover by Source Server ID.
string
Request to finalize Cutover by Source Account ID.
dict
Response Syntax
{
'sourceServerID': 'string',
'arn': 'string',
'isArchived': True|False,
'tags': {
'string': 'string'
},
'launchedInstance': {
'ec2InstanceID': 'string',
'jobID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED'
},
'dataReplicationInfo': {
'lagDuration': 'string',
'etaDateTime': 'string',
'replicatedDisks': [
{
'deviceName': 'string',
'totalStorageBytes': 123,
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'backloggedStorageBytes': 123
},
],
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'dataReplicationInitiation': {
'startDateTime': 'string',
'nextAttemptDateTime': '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'
},
]
},
'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'
},
'lastSnapshotDateTime': 'string',
'replicatorId': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'firstByteDateTime': 'string',
'elapsedReplicationDuration': 'string',
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'lastCutover': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'sourceProperties': {
'lastUpdatedDateTime': 'string',
'recommendedInstanceType': 'string',
'identificationHints': {
'fqdn': 'string',
'hostname': 'string',
'vmWareUuid': 'string',
'awsInstanceID': 'string',
'vmPath': 'string'
},
'networkInterfaces': [
{
'macAddress': 'string',
'ips': [
'string',
],
'isPrimary': True|False
},
],
'disks': [
{
'deviceName': 'string',
'bytes': 123
},
],
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'ramBytes': 123,
'os': {
'fullString': 'string'
}
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'vcenterClientID': 'string',
'applicationID': 'string',
'userProvidedID': 'string',
'fqdnForActionFramework': 'string',
'connectorAction': {
'credentialsSecretArn': 'string',
'connectorArn': 'string'
}
}
Response Structure
(dict) --
sourceServerID (string) --
Source server ID.
arn (string) --
Source server ARN.
isArchived (boolean) --
Source server archived status.
tags (dict) --
Source server Tags.
(string) --
(string) --
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
jobID (string) --
Launched instance Job ID.
firstBoot (string) --
Launched instance first boot.
dataReplicationInfo (dict) --
Source server data replication info.
lagDuration (string) --
Request to query data replication lag duration.
etaDateTime (string) --
Request to query the time when data replication will be complete.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
deviceName (string) --
Request to query device name.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
dataReplicationState (string) --
Request to query the data replication state.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
startDateTime (string) --
Request to query data initiation start date and time.
nextAttemptDateTime (string) --
Request to query next data initiation 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.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatorId (string) --
Replication server instance ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
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.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
lastCutover (dict) --
Lifecycle last Cutover.
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.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
state (string) --
Lifecycle state.
sourceProperties (dict) --
Source server properties.
lastUpdatedDateTime (string) --
Source server last update date and time.
recommendedInstanceType (string) --
Source server recommended instance type.
identificationHints (dict) --
Source server identification hints.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
awsInstanceID (string) --
AWS Instance ID identification hint.
vmPath (string) --
vCenter VM path identification hint.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
macAddress (string) --
Network interface Mac address.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
deviceName (string) --
The disk or device name.
bytes (integer) --
The amount of storage on the disk in bytes.
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.
ramBytes (integer) --
Source server RAM in bytes.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
replicationType (string) --
Source server replication type.
vcenterClientID (string) --
Source server vCenter client id.
applicationID (string) --
Source server application ID.
userProvidedID (string) --
Source server user provided ID.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
connectorAction (dict) --
Source Server connector action.
credentialsSecretArn (string) --
Source Server connector action credentials secret arn.
connectorArn (string) --
Source Server connector action connector arn.
{'postLaunchActions': {'ssmDocuments': {'parameters': {'parameterType': {'SECURE_STRING'}}}}}
Lists all LaunchConfigurations available, filtered by Source Server IDs.
See also: AWS API Documentation
Request Syntax
client.get_launch_configuration(
sourceServerID='string',
accountID='string'
)
string
[REQUIRED]
Request to get Launch Configuration information by Source Server ID.
string
Request to get Launch Configuration information by Account ID.
dict
Response Syntax
{
'sourceServerID': 'string',
'name': 'string',
'ec2LaunchTemplateID': 'string',
'launchDisposition': 'STOPPED'|'STARTED',
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC',
'copyPrivateIp': True|False,
'copyTags': True|False,
'licensing': {
'osByol': True|False
},
'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
'postLaunchActions': {
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'cloudWatchLogGroupName': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'ssmDocumentName': 'string',
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
}
},
]
},
'enableMapAutoTagging': True|False,
'mapAutoTaggingMpeID': 'string'
}
Response Structure
(dict) --
sourceServerID (string) --
Launch configuration Source Server ID.
name (string) --
Launch configuration name.
ec2LaunchTemplateID (string) --
Launch configuration EC2 Launch template ID.
launchDisposition (string) --
Launch disposition for launch configuration.
targetInstanceTypeRightSizingMethod (string) --
Launch configuration Target instance type right sizing method.
copyPrivateIp (boolean) --
Copy Private IP during Launch Configuration.
copyTags (boolean) --
Copy Tags during Launch Configuration.
licensing (dict) --
Launch configuration OS licensing.
osByol (boolean) --
Configure BYOL OS licensing.
bootMode (string) --
Launch configuration boot mode.
postLaunchActions (dict) --
Post Launch Actions to executed on the Test or Cutover instance.
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.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
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.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
enableMapAutoTagging (boolean) --
Enable map auto tagging.
mapAutoTaggingMpeID (string) --
Map auto tagging MPE ID.
{'internetProtocol': 'IPV4 | IPV6'}
Lists all ReplicationConfigurations, filtered by Source Server ID.
See also: AWS API Documentation
Request Syntax
client.get_replication_configuration(
sourceServerID='string',
accountID='string'
)
string
[REQUIRED]
Request to get Replication Configuration by Source Server ID.
string
Request to get Replication Configuration by Account ID.
dict
Response Syntax
{
'sourceServerID': 'string',
'name': 'string',
'stagingAreaSubnetId': 'string',
'associateDefaultSecurityGroup': True|False,
'replicationServersSecurityGroupsIDs': [
'string',
],
'replicationServerInstanceType': 'string',
'useDedicatedReplicationServer': True|False,
'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
'replicatedDisks': [
{
'deviceName': 'string',
'isBootDisk': True|False,
'stagingDiskType': 'AUTO'|'GP2'|'IO1'|'SC1'|'ST1'|'STANDARD'|'GP3'|'IO2',
'iops': 123,
'throughput': 123
},
],
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'bandwidthThrottling': 123,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'createPublicIP': True|False,
'stagingAreaTags': {
'string': 'string'
},
'useFipsEndpoint': True|False,
'internetProtocol': 'IPV4'|'IPV6'
}
Response Structure
(dict) --
sourceServerID (string) --
Replication Configuration Source Server ID.
name (string) --
Replication Configuration name.
stagingAreaSubnetId (string) --
Replication Configuration Staging Area subnet ID.
associateDefaultSecurityGroup (boolean) --
Replication Configuration associate default Application Migration Service Security Group.
replicationServersSecurityGroupsIDs (list) --
Replication Configuration Replication Server Security Group IDs.
(string) --
replicationServerInstanceType (string) --
Replication Configuration Replication Server instance type.
useDedicatedReplicationServer (boolean) --
Replication Configuration use Dedicated Replication Server.
defaultLargeStagingDiskType (string) --
Replication Configuration use default large Staging Disks.
replicatedDisks (list) --
Replication Configuration replicated disks.
(dict) --
Replication Configuration replicated disk.
deviceName (string) --
Replication Configuration replicated disk device name.
isBootDisk (boolean) --
Replication Configuration replicated disk boot disk.
stagingDiskType (string) --
Replication Configuration replicated disk staging disk type.
iops (integer) --
Replication Configuration replicated disk IOPs.
throughput (integer) --
Replication Configuration replicated disk throughput.
ebsEncryption (string) --
Replication Configuration EBS encryption.
ebsEncryptionKeyArn (string) --
Replication Configuration EBS encryption key ARN.
bandwidthThrottling (integer) --
Replication Configuration set bandwidth throttling.
dataPlaneRouting (string) --
Replication Configuration data plane routing.
createPublicIP (boolean) --
Replication Configuration create Public IP.
stagingAreaTags (dict) --
Replication Configuration Staging Area tags.
(string) --
(string) --
useFipsEndpoint (boolean) --
Replication Configuration use Fips Endpoint.
internetProtocol (string) --
Replication Configuration internet protocol.
{'items': {'arn': 'string', 'tags': {'string': 'string'}}}
List exports.
See also: AWS API Documentation
Request Syntax
client.list_exports(
filters={
'exportIDs': [
'string',
]
},
maxResults=123,
nextToken='string'
)
dict
List exports request filters.
exportIDs (list) --
List exports request filters export ids.
(string) --
integer
List export request max results.
string
List export request next token.
dict
Response Syntax
{
'items': [
{
'exportID': 'string',
'arn': 'string',
's3Bucket': 'string',
's3Key': 'string',
's3BucketOwner': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED',
'progressPercentage': ...,
'summary': {
'serversCount': 123,
'applicationsCount': 123,
'wavesCount': 123
},
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
List export response.
items (list) --
List export response items.
(dict) --
Export task.
exportID (string) --
Export task id.
arn (string) --
ExportTask arn.
s3Bucket (string) --
Export task s3 bucket.
s3Key (string) --
Export task s3 key.
s3BucketOwner (string) --
Export task s3 bucket owner.
creationDateTime (string) --
Export task creation datetime.
endDateTime (string) --
Export task end datetime.
status (string) --
Export task status.
progressPercentage (float) --
Export task progress percentage.
summary (dict) --
Export task summary.
serversCount (integer) --
Export task summary servers count.
applicationsCount (integer) --
Export task summary applications count.
wavesCount (integer) --
Export task summary waves count.
tags (dict) --
Export task tags.
(string) --
(string) --
nextToken (string) --
List export response next token.
{'items': {'arn': 'string', 'tags': {'string': 'string'}}}
List imports.
See also: AWS API Documentation
Request Syntax
client.list_imports(
filters={
'importIDs': [
'string',
]
},
maxResults=123,
nextToken='string'
)
dict
List imports request filters.
importIDs (list) --
List imports request filters import IDs.
(string) --
integer
List imports request max results.
string
List imports request next token.
dict
Response Syntax
{
'items': [
{
'importID': 'string',
'arn': 'string',
's3BucketSource': {
's3Bucket': 'string',
's3Key': 'string',
's3BucketOwner': 'string'
},
'creationDateTime': 'string',
'endDateTime': 'string',
'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED',
'progressPercentage': ...,
'summary': {
'waves': {
'createdCount': 123,
'modifiedCount': 123
},
'applications': {
'createdCount': 123,
'modifiedCount': 123
},
'servers': {
'createdCount': 123,
'modifiedCount': 123
}
},
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
List import response.
items (list) --
List import response items.
(dict) --
Import task.
importID (string) --
Import task id.
arn (string) --
ImportTask arn.
s3BucketSource (dict) --
Import task s3 bucket source.
s3Bucket (string) --
S3 bucket source s3 bucket.
s3Key (string) --
S3 bucket source s3 key.
s3BucketOwner (string) --
S3 bucket source s3 bucket owner.
creationDateTime (string) --
Import task creation datetime.
endDateTime (string) --
Import task end datetime.
status (string) --
Import task status.
progressPercentage (float) --
Import task progress percentage.
summary (dict) --
Import task summary.
waves (dict) --
Import task summary waves.
createdCount (integer) --
Import task summery waves created count.
modifiedCount (integer) --
Import task summery waves modified count.
applications (dict) --
Import task summary applications.
createdCount (integer) --
Import task summary applications created count.
modifiedCount (integer) --
Import task summary applications modified count.
servers (dict) --
Import task summary servers.
createdCount (integer) --
Import task summary servers created count.
modifiedCount (integer) --
Import task summary servers modified count.
tags (dict) --
Import task tags.
(string) --
(string) --
nextToken (string) --
List import response next token.
{'items': {'parameters': {'parameterType': {'SECURE_STRING'}}}}
List source server post migration custom actions.
See also: AWS API Documentation
Request Syntax
client.list_source_server_actions(
sourceServerID='string',
filters={
'actionIDs': [
'string',
]
},
maxResults=123,
nextToken='string',
accountID='string'
)
string
[REQUIRED]
Source server ID.
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
Account ID to return when listing source server post migration custom actions.
dict
Response Syntax
{
'items': [
{
'actionID': 'string',
'actionName': 'string',
'documentIdentifier': 'string',
'order': 123,
'documentVersion': 'string',
'active': True|False,
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'description': 'string',
'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER'
},
],
'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.
documentIdentifier (string) --
Source server post migration custom action document identifier.
order (integer) --
Source server post migration custom action order.
documentVersion (string) --
Source server post migration custom action document version.
active (boolean) --
Source server post migration custom action active status.
timeoutSeconds (integer) --
Source server post migration custom action timeout in seconds.
mustSucceedForCutover (boolean) --
Source server post migration custom action must succeed for cutover.
parameters (dict) --
Source server post migration custom action parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
externalParameters (dict) --
Source server post migration custom action external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
description (string) --
Source server post migration custom action description.
category (string) --
Source server post migration custom action category.
nextToken (string) --
Next token returned when listing source server post migration custom actions.
{'items': {'parameters': {'parameterType': {'SECURE_STRING'}}}}
List template post migration custom actions.
See also: AWS API Documentation
Request Syntax
client.list_template_actions(
launchConfigurationTemplateID='string',
filters={
'actionIDs': [
'string',
]
},
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
Launch configuration template ID.
dict
Filters to apply when listing template post migration custom actions.
actionIDs (list) --
Action IDs to filter template post migration custom actions by.
(string) --
integer
Maximum amount of items to return when listing template post migration custom actions.
string
Next token to use when listing template post migration custom actions.
dict
Response Syntax
{
'items': [
{
'actionID': 'string',
'actionName': 'string',
'documentIdentifier': 'string',
'order': 123,
'documentVersion': 'string',
'active': True|False,
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'operatingSystem': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'description': 'string',
'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
List of template post migration custom actions.
(dict) --
actionID (string) --
Template post migration custom action ID.
actionName (string) --
Template post migration custom action name.
documentIdentifier (string) --
Template post migration custom action document identifier.
order (integer) --
Template post migration custom action order.
documentVersion (string) --
Template post migration custom action document version.
active (boolean) --
Template post migration custom action active status.
timeoutSeconds (integer) --
Template post migration custom action timeout in seconds.
mustSucceedForCutover (boolean) --
Template post migration custom action must succeed for cutover.
parameters (dict) --
Template post migration custom action parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
operatingSystem (string) --
Operating system eligible for this template post migration custom action.
externalParameters (dict) --
Template post migration custom action external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
description (string) --
Template post migration custom action description.
category (string) --
Template post migration custom action category.
nextToken (string) --
Next token returned when listing template post migration custom actions.
{'dataReplicationInfo': {'replicatorId': '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(
sourceServerID='string',
accountID='string'
)
string
[REQUIRED]
Mark as archived by Source Server ID.
string
Mark as archived by Account ID.
dict
Response Syntax
{
'sourceServerID': 'string',
'arn': 'string',
'isArchived': True|False,
'tags': {
'string': 'string'
},
'launchedInstance': {
'ec2InstanceID': 'string',
'jobID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED'
},
'dataReplicationInfo': {
'lagDuration': 'string',
'etaDateTime': 'string',
'replicatedDisks': [
{
'deviceName': 'string',
'totalStorageBytes': 123,
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'backloggedStorageBytes': 123
},
],
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'dataReplicationInitiation': {
'startDateTime': 'string',
'nextAttemptDateTime': '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'
},
]
},
'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'
},
'lastSnapshotDateTime': 'string',
'replicatorId': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'firstByteDateTime': 'string',
'elapsedReplicationDuration': 'string',
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'lastCutover': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'sourceProperties': {
'lastUpdatedDateTime': 'string',
'recommendedInstanceType': 'string',
'identificationHints': {
'fqdn': 'string',
'hostname': 'string',
'vmWareUuid': 'string',
'awsInstanceID': 'string',
'vmPath': 'string'
},
'networkInterfaces': [
{
'macAddress': 'string',
'ips': [
'string',
],
'isPrimary': True|False
},
],
'disks': [
{
'deviceName': 'string',
'bytes': 123
},
],
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'ramBytes': 123,
'os': {
'fullString': 'string'
}
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'vcenterClientID': 'string',
'applicationID': 'string',
'userProvidedID': 'string',
'fqdnForActionFramework': 'string',
'connectorAction': {
'credentialsSecretArn': 'string',
'connectorArn': 'string'
}
}
Response Structure
(dict) --
sourceServerID (string) --
Source server ID.
arn (string) --
Source server ARN.
isArchived (boolean) --
Source server archived status.
tags (dict) --
Source server Tags.
(string) --
(string) --
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
jobID (string) --
Launched instance Job ID.
firstBoot (string) --
Launched instance first boot.
dataReplicationInfo (dict) --
Source server data replication info.
lagDuration (string) --
Request to query data replication lag duration.
etaDateTime (string) --
Request to query the time when data replication will be complete.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
deviceName (string) --
Request to query device name.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
dataReplicationState (string) --
Request to query the data replication state.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
startDateTime (string) --
Request to query data initiation start date and time.
nextAttemptDateTime (string) --
Request to query next data initiation 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.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatorId (string) --
Replication server instance ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
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.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
lastCutover (dict) --
Lifecycle last Cutover.
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.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
state (string) --
Lifecycle state.
sourceProperties (dict) --
Source server properties.
lastUpdatedDateTime (string) --
Source server last update date and time.
recommendedInstanceType (string) --
Source server recommended instance type.
identificationHints (dict) --
Source server identification hints.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
awsInstanceID (string) --
AWS Instance ID identification hint.
vmPath (string) --
vCenter VM path identification hint.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
macAddress (string) --
Network interface Mac address.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
deviceName (string) --
The disk or device name.
bytes (integer) --
The amount of storage on the disk in bytes.
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.
ramBytes (integer) --
Source server RAM in bytes.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
replicationType (string) --
Source server replication type.
vcenterClientID (string) --
Source server vCenter client id.
applicationID (string) --
Source server application ID.
userProvidedID (string) --
Source server user provided ID.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
connectorAction (dict) --
Source Server connector action.
credentialsSecretArn (string) --
Source Server connector action credentials secret arn.
connectorArn (string) --
Source Server connector action connector arn.
{'dataReplicationInfo': {'replicatorId': 'string'}}
Pause Replication.
See also: AWS API Documentation
Request Syntax
client.pause_replication(
sourceServerID='string',
accountID='string'
)
string
[REQUIRED]
Pause Replication Request source server ID.
string
Pause Replication Request account ID.
dict
Response Syntax
{
'sourceServerID': 'string',
'arn': 'string',
'isArchived': True|False,
'tags': {
'string': 'string'
},
'launchedInstance': {
'ec2InstanceID': 'string',
'jobID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED'
},
'dataReplicationInfo': {
'lagDuration': 'string',
'etaDateTime': 'string',
'replicatedDisks': [
{
'deviceName': 'string',
'totalStorageBytes': 123,
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'backloggedStorageBytes': 123
},
],
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'dataReplicationInitiation': {
'startDateTime': 'string',
'nextAttemptDateTime': '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'
},
]
},
'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'
},
'lastSnapshotDateTime': 'string',
'replicatorId': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'firstByteDateTime': 'string',
'elapsedReplicationDuration': 'string',
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'lastCutover': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'sourceProperties': {
'lastUpdatedDateTime': 'string',
'recommendedInstanceType': 'string',
'identificationHints': {
'fqdn': 'string',
'hostname': 'string',
'vmWareUuid': 'string',
'awsInstanceID': 'string',
'vmPath': 'string'
},
'networkInterfaces': [
{
'macAddress': 'string',
'ips': [
'string',
],
'isPrimary': True|False
},
],
'disks': [
{
'deviceName': 'string',
'bytes': 123
},
],
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'ramBytes': 123,
'os': {
'fullString': 'string'
}
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'vcenterClientID': 'string',
'applicationID': 'string',
'userProvidedID': 'string',
'fqdnForActionFramework': 'string',
'connectorAction': {
'credentialsSecretArn': 'string',
'connectorArn': 'string'
}
}
Response Structure
(dict) --
sourceServerID (string) --
Source server ID.
arn (string) --
Source server ARN.
isArchived (boolean) --
Source server archived status.
tags (dict) --
Source server Tags.
(string) --
(string) --
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
jobID (string) --
Launched instance Job ID.
firstBoot (string) --
Launched instance first boot.
dataReplicationInfo (dict) --
Source server data replication info.
lagDuration (string) --
Request to query data replication lag duration.
etaDateTime (string) --
Request to query the time when data replication will be complete.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
deviceName (string) --
Request to query device name.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
dataReplicationState (string) --
Request to query the data replication state.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
startDateTime (string) --
Request to query data initiation start date and time.
nextAttemptDateTime (string) --
Request to query next data initiation 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.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatorId (string) --
Replication server instance ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
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.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
lastCutover (dict) --
Lifecycle last Cutover.
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.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
state (string) --
Lifecycle state.
sourceProperties (dict) --
Source server properties.
lastUpdatedDateTime (string) --
Source server last update date and time.
recommendedInstanceType (string) --
Source server recommended instance type.
identificationHints (dict) --
Source server identification hints.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
awsInstanceID (string) --
AWS Instance ID identification hint.
vmPath (string) --
vCenter VM path identification hint.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
macAddress (string) --
Network interface Mac address.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
deviceName (string) --
The disk or device name.
bytes (integer) --
The amount of storage on the disk in bytes.
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.
ramBytes (integer) --
Source server RAM in bytes.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
replicationType (string) --
Source server replication type.
vcenterClientID (string) --
Source server vCenter client id.
applicationID (string) --
Source server application ID.
userProvidedID (string) --
Source server user provided ID.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
connectorAction (dict) --
Source Server connector action.
credentialsSecretArn (string) --
Source Server connector action credentials secret arn.
connectorArn (string) --
Source Server connector action connector arn.
{'parameters': {'parameterType': {'SECURE_STRING'}}}
Put source server post migration custom action.
See also: AWS API Documentation
Request Syntax
client.put_source_server_action(
sourceServerID='string',
actionName='string',
documentIdentifier='string',
order=123,
actionID='string',
documentVersion='string',
active=True|False,
timeoutSeconds=123,
mustSucceedForCutover=True|False,
parameters={
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
externalParameters={
'string': {
'dynamicPath': 'string'
}
},
description='string',
category='DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER',
accountID='string'
)
string
[REQUIRED]
Source server ID.
string
[REQUIRED]
Source server post migration custom action name.
string
[REQUIRED]
Source server post migration custom action document identifier.
integer
[REQUIRED]
Source server post migration custom action order.
string
[REQUIRED]
Source server post migration custom action ID.
string
Source server post migration custom action document version.
boolean
Source server post migration custom action active status.
integer
Source server post migration custom action timeout in seconds.
boolean
Source server post migration custom action must succeed for cutover.
dict
Source server post migration custom action parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterType (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter type.
parameterName (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter name.
dict
Source server post migration custom action external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
string
Source server post migration custom action description.
string
Source server post migration custom action category.
string
Source server post migration custom account ID.
dict
Response Syntax
{
'actionID': 'string',
'actionName': 'string',
'documentIdentifier': 'string',
'order': 123,
'documentVersion': 'string',
'active': True|False,
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'description': 'string',
'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER'
}
Response Structure
(dict) --
actionID (string) --
Source server post migration custom action ID.
actionName (string) --
Source server post migration custom action name.
documentIdentifier (string) --
Source server post migration custom action document identifier.
order (integer) --
Source server post migration custom action order.
documentVersion (string) --
Source server post migration custom action document version.
active (boolean) --
Source server post migration custom action active status.
timeoutSeconds (integer) --
Source server post migration custom action timeout in seconds.
mustSucceedForCutover (boolean) --
Source server post migration custom action must succeed for cutover.
parameters (dict) --
Source server post migration custom action parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
externalParameters (dict) --
Source server post migration custom action external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
description (string) --
Source server post migration custom action description.
category (string) --
Source server post migration custom action category.
{'parameters': {'parameterType': {'SECURE_STRING'}}}
Put template post migration custom action.
See also: AWS API Documentation
Request Syntax
client.put_template_action(
launchConfigurationTemplateID='string',
actionName='string',
documentIdentifier='string',
order=123,
actionID='string',
documentVersion='string',
active=True|False,
timeoutSeconds=123,
mustSucceedForCutover=True|False,
parameters={
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
operatingSystem='string',
externalParameters={
'string': {
'dynamicPath': 'string'
}
},
description='string',
category='DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER'
)
string
[REQUIRED]
Launch configuration template ID.
string
[REQUIRED]
Template post migration custom action name.
string
[REQUIRED]
Template post migration custom action document identifier.
integer
[REQUIRED]
Template post migration custom action order.
string
[REQUIRED]
Template post migration custom action ID.
string
Template post migration custom action document version.
boolean
Template post migration custom action active status.
integer
Template post migration custom action timeout in seconds.
boolean
Template post migration custom action must succeed for cutover.
dict
Template post migration custom action parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterType (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter type.
parameterName (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter name.
string
Operating system eligible for this template post migration custom action.
dict
Template post migration custom action external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
string
Template post migration custom action description.
string
Template post migration custom action category.
dict
Response Syntax
{
'actionID': 'string',
'actionName': 'string',
'documentIdentifier': 'string',
'order': 123,
'documentVersion': 'string',
'active': True|False,
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'operatingSystem': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'description': 'string',
'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'REFACTORING'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER'
}
Response Structure
(dict) --
actionID (string) --
Template post migration custom action ID.
actionName (string) --
Template post migration custom action name.
documentIdentifier (string) --
Template post migration custom action document identifier.
order (integer) --
Template post migration custom action order.
documentVersion (string) --
Template post migration custom action document version.
active (boolean) --
Template post migration custom action active status.
timeoutSeconds (integer) --
Template post migration custom action timeout in seconds.
mustSucceedForCutover (boolean) --
Template post migration custom action must succeed for cutover.
parameters (dict) --
Template post migration custom action parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
operatingSystem (string) --
Operating system eligible for this template post migration custom action.
externalParameters (dict) --
Template post migration custom action external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
description (string) --
Template post migration custom action description.
category (string) --
Template post migration custom action category.
{'dataReplicationInfo': {'replicatorId': 'string'}}
Resume Replication.
See also: AWS API Documentation
Request Syntax
client.resume_replication(
sourceServerID='string',
accountID='string'
)
string
[REQUIRED]
Resume Replication Request source server ID.
string
Resume Replication Request account ID.
dict
Response Syntax
{
'sourceServerID': 'string',
'arn': 'string',
'isArchived': True|False,
'tags': {
'string': 'string'
},
'launchedInstance': {
'ec2InstanceID': 'string',
'jobID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED'
},
'dataReplicationInfo': {
'lagDuration': 'string',
'etaDateTime': 'string',
'replicatedDisks': [
{
'deviceName': 'string',
'totalStorageBytes': 123,
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'backloggedStorageBytes': 123
},
],
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'dataReplicationInitiation': {
'startDateTime': 'string',
'nextAttemptDateTime': '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'
},
]
},
'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'
},
'lastSnapshotDateTime': 'string',
'replicatorId': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'firstByteDateTime': 'string',
'elapsedReplicationDuration': 'string',
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'lastCutover': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'sourceProperties': {
'lastUpdatedDateTime': 'string',
'recommendedInstanceType': 'string',
'identificationHints': {
'fqdn': 'string',
'hostname': 'string',
'vmWareUuid': 'string',
'awsInstanceID': 'string',
'vmPath': 'string'
},
'networkInterfaces': [
{
'macAddress': 'string',
'ips': [
'string',
],
'isPrimary': True|False
},
],
'disks': [
{
'deviceName': 'string',
'bytes': 123
},
],
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'ramBytes': 123,
'os': {
'fullString': 'string'
}
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'vcenterClientID': 'string',
'applicationID': 'string',
'userProvidedID': 'string',
'fqdnForActionFramework': 'string',
'connectorAction': {
'credentialsSecretArn': 'string',
'connectorArn': 'string'
}
}
Response Structure
(dict) --
sourceServerID (string) --
Source server ID.
arn (string) --
Source server ARN.
isArchived (boolean) --
Source server archived status.
tags (dict) --
Source server Tags.
(string) --
(string) --
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
jobID (string) --
Launched instance Job ID.
firstBoot (string) --
Launched instance first boot.
dataReplicationInfo (dict) --
Source server data replication info.
lagDuration (string) --
Request to query data replication lag duration.
etaDateTime (string) --
Request to query the time when data replication will be complete.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
deviceName (string) --
Request to query device name.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
dataReplicationState (string) --
Request to query the data replication state.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
startDateTime (string) --
Request to query data initiation start date and time.
nextAttemptDateTime (string) --
Request to query next data initiation 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.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatorId (string) --
Replication server instance ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
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.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
lastCutover (dict) --
Lifecycle last Cutover.
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.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
state (string) --
Lifecycle state.
sourceProperties (dict) --
Source server properties.
lastUpdatedDateTime (string) --
Source server last update date and time.
recommendedInstanceType (string) --
Source server recommended instance type.
identificationHints (dict) --
Source server identification hints.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
awsInstanceID (string) --
AWS Instance ID identification hint.
vmPath (string) --
vCenter VM path identification hint.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
macAddress (string) --
Network interface Mac address.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
deviceName (string) --
The disk or device name.
bytes (integer) --
The amount of storage on the disk in bytes.
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.
ramBytes (integer) --
Source server RAM in bytes.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
replicationType (string) --
Source server replication type.
vcenterClientID (string) --
Source server vCenter client id.
applicationID (string) --
Source server application ID.
userProvidedID (string) --
Source server user provided ID.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
connectorAction (dict) --
Source Server connector action.
credentialsSecretArn (string) --
Source Server connector action credentials secret arn.
connectorArn (string) --
Source Server connector action connector arn.
{'dataReplicationInfo': {'replicatorId': '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(
sourceServerID='string',
accountID='string'
)
string
[REQUIRED]
Retry data replication for Source Server ID.
string
Retry data replication for Account ID.
dict
Response Syntax
{
'sourceServerID': 'string',
'arn': 'string',
'isArchived': True|False,
'tags': {
'string': 'string'
},
'launchedInstance': {
'ec2InstanceID': 'string',
'jobID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED'
},
'dataReplicationInfo': {
'lagDuration': 'string',
'etaDateTime': 'string',
'replicatedDisks': [
{
'deviceName': 'string',
'totalStorageBytes': 123,
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'backloggedStorageBytes': 123
},
],
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'dataReplicationInitiation': {
'startDateTime': 'string',
'nextAttemptDateTime': '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'
},
]
},
'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'
},
'lastSnapshotDateTime': 'string',
'replicatorId': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'firstByteDateTime': 'string',
'elapsedReplicationDuration': 'string',
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'lastCutover': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'sourceProperties': {
'lastUpdatedDateTime': 'string',
'recommendedInstanceType': 'string',
'identificationHints': {
'fqdn': 'string',
'hostname': 'string',
'vmWareUuid': 'string',
'awsInstanceID': 'string',
'vmPath': 'string'
},
'networkInterfaces': [
{
'macAddress': 'string',
'ips': [
'string',
],
'isPrimary': True|False
},
],
'disks': [
{
'deviceName': 'string',
'bytes': 123
},
],
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'ramBytes': 123,
'os': {
'fullString': 'string'
}
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'vcenterClientID': 'string',
'applicationID': 'string',
'userProvidedID': 'string',
'fqdnForActionFramework': 'string',
'connectorAction': {
'credentialsSecretArn': 'string',
'connectorArn': 'string'
}
}
Response Structure
(dict) --
sourceServerID (string) --
Source server ID.
arn (string) --
Source server ARN.
isArchived (boolean) --
Source server archived status.
tags (dict) --
Source server Tags.
(string) --
(string) --
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
jobID (string) --
Launched instance Job ID.
firstBoot (string) --
Launched instance first boot.
dataReplicationInfo (dict) --
Source server data replication info.
lagDuration (string) --
Request to query data replication lag duration.
etaDateTime (string) --
Request to query the time when data replication will be complete.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
deviceName (string) --
Request to query device name.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
dataReplicationState (string) --
Request to query the data replication state.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
startDateTime (string) --
Request to query data initiation start date and time.
nextAttemptDateTime (string) --
Request to query next data initiation 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.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatorId (string) --
Replication server instance ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
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.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
lastCutover (dict) --
Lifecycle last Cutover.
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.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
state (string) --
Lifecycle state.
sourceProperties (dict) --
Source server properties.
lastUpdatedDateTime (string) --
Source server last update date and time.
recommendedInstanceType (string) --
Source server recommended instance type.
identificationHints (dict) --
Source server identification hints.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
awsInstanceID (string) --
AWS Instance ID identification hint.
vmPath (string) --
vCenter VM path identification hint.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
macAddress (string) --
Network interface Mac address.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
deviceName (string) --
The disk or device name.
bytes (integer) --
The amount of storage on the disk in bytes.
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.
ramBytes (integer) --
Source server RAM in bytes.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
replicationType (string) --
Source server replication type.
vcenterClientID (string) --
Source server vCenter client id.
applicationID (string) --
Source server application ID.
userProvidedID (string) --
Source server user provided ID.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
connectorAction (dict) --
Source Server connector action.
credentialsSecretArn (string) --
Source Server connector action credentials secret arn.
connectorArn (string) --
Source Server connector action connector arn.
{'job': {'participatingServers': {'postLaunchActionsStatus': {'postLaunchActionsLaunchStatusList': {'ssmDocument': {'parameters': {'parameterType': {'SECURE_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(
sourceServerIDs=[
'string',
],
tags={
'string': 'string'
},
accountID='string'
)
list
[REQUIRED]
Start Cutover by Source Server IDs.
(string) --
dict
Start Cutover by Tags.
(string) --
(string) --
string
Start Cutover by Account IDs
dict
Response Syntax
{
'job': {
'jobID': 'string',
'arn': 'string',
'type': 'LAUNCH'|'TERMINATE',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'creationDateTime': 'string',
'endDateTime': 'string',
'status': 'PENDING'|'STARTED'|'COMPLETED',
'participatingServers': [
{
'sourceServerID': 'string',
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'ssmAgentDiscoveryDatetime': 'string',
'postLaunchActionsLaunchStatusList': [
{
'ssmDocument': {
'actionName': 'string',
'ssmDocumentName': 'string',
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
}
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND',
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string'
},
]
}
},
],
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
job (dict) --
Start Cutover Job response.
jobID (string) --
Job ID.
arn (string) --
the ARN of the specific Job.
type (string) --
Job type.
initiatedBy (string) --
Job initiated by field.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
status (string) --
Job status.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
sourceServerID (string) --
Participating server Source Server ID.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server's launched ec2 instance ID.
postLaunchActionsStatus (dict) --
Participating server's Post Launch Actions Status.
ssmAgentDiscoveryDatetime (string) --
Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.
postLaunchActionsLaunchStatusList (list) --
List of Post Launch Action status.
(dict) --
Launch Status of the Job Post Launch Actions.
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.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
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.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
ssmDocumentType (string) --
AWS Systems Manager Document type.
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.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
{'tags': {'string': 'string'}}
Response {'exportTask': {'arn': 'string', 'tags': {'string': 'string'}}}
Start export.
See also: AWS API Documentation
Request Syntax
client.start_export(
s3Bucket='string',
s3Key='string',
s3BucketOwner='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
Start export request s3 bucket.
string
[REQUIRED]
Start export request s3key.
string
Start export request s3 bucket owner.
dict
Start import request tags.
(string) --
(string) --
dict
Response Syntax
{
'exportTask': {
'exportID': 'string',
'arn': 'string',
's3Bucket': 'string',
's3Key': 'string',
's3BucketOwner': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED',
'progressPercentage': ...,
'summary': {
'serversCount': 123,
'applicationsCount': 123,
'wavesCount': 123
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
Start export response.
exportTask (dict) --
Start export response export task.
exportID (string) --
Export task id.
arn (string) --
ExportTask arn.
s3Bucket (string) --
Export task s3 bucket.
s3Key (string) --
Export task s3 key.
s3BucketOwner (string) --
Export task s3 bucket owner.
creationDateTime (string) --
Export task creation datetime.
endDateTime (string) --
Export task end datetime.
status (string) --
Export task status.
progressPercentage (float) --
Export task progress percentage.
summary (dict) --
Export task summary.
serversCount (integer) --
Export task summary servers count.
applicationsCount (integer) --
Export task summary applications count.
wavesCount (integer) --
Export task summary waves count.
tags (dict) --
Export task tags.
(string) --
(string) --
{'tags': {'string': 'string'}}
Response {'importTask': {'arn': 'string', 'tags': {'string': 'string'}}}
Start import.
See also: AWS API Documentation
Request Syntax
client.start_import(
clientToken='string',
s3BucketSource={
's3Bucket': 'string',
's3Key': 'string',
's3BucketOwner': 'string'
},
tags={
'string': 'string'
}
)
string
Start import request client token.
This field is autopopulated if not provided.
dict
[REQUIRED]
Start import request s3 bucket source.
s3Bucket (string) -- [REQUIRED]
S3 bucket source s3 bucket.
s3Key (string) -- [REQUIRED]
S3 bucket source s3 key.
s3BucketOwner (string) --
S3 bucket source s3 bucket owner.
dict
Start import request tags.
(string) --
(string) --
dict
Response Syntax
{
'importTask': {
'importID': 'string',
'arn': 'string',
's3BucketSource': {
's3Bucket': 'string',
's3Key': 'string',
's3BucketOwner': 'string'
},
'creationDateTime': 'string',
'endDateTime': 'string',
'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED',
'progressPercentage': ...,
'summary': {
'waves': {
'createdCount': 123,
'modifiedCount': 123
},
'applications': {
'createdCount': 123,
'modifiedCount': 123
},
'servers': {
'createdCount': 123,
'modifiedCount': 123
}
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
Start import response.
importTask (dict) --
Start import response import task.
importID (string) --
Import task id.
arn (string) --
ImportTask arn.
s3BucketSource (dict) --
Import task s3 bucket source.
s3Bucket (string) --
S3 bucket source s3 bucket.
s3Key (string) --
S3 bucket source s3 key.
s3BucketOwner (string) --
S3 bucket source s3 bucket owner.
creationDateTime (string) --
Import task creation datetime.
endDateTime (string) --
Import task end datetime.
status (string) --
Import task status.
progressPercentage (float) --
Import task progress percentage.
summary (dict) --
Import task summary.
waves (dict) --
Import task summary waves.
createdCount (integer) --
Import task summery waves created count.
modifiedCount (integer) --
Import task summery waves modified count.
applications (dict) --
Import task summary applications.
createdCount (integer) --
Import task summary applications created count.
modifiedCount (integer) --
Import task summary applications modified count.
servers (dict) --
Import task summary servers.
createdCount (integer) --
Import task summary servers created count.
modifiedCount (integer) --
Import task summary servers modified count.
tags (dict) --
Import task tags.
(string) --
(string) --
{'dataReplicationInfo': {'replicatorId': 'string'}}
Start replication for source server irrespective of its replication type.
See also: AWS API Documentation
Request Syntax
client.start_replication(
sourceServerID='string',
accountID='string'
)
string
[REQUIRED]
ID of source server on which to start replication.
string
Account ID on which to start replication.
dict
Response Syntax
{
'sourceServerID': 'string',
'arn': 'string',
'isArchived': True|False,
'tags': {
'string': 'string'
},
'launchedInstance': {
'ec2InstanceID': 'string',
'jobID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED'
},
'dataReplicationInfo': {
'lagDuration': 'string',
'etaDateTime': 'string',
'replicatedDisks': [
{
'deviceName': 'string',
'totalStorageBytes': 123,
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'backloggedStorageBytes': 123
},
],
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'dataReplicationInitiation': {
'startDateTime': 'string',
'nextAttemptDateTime': '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'
},
]
},
'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'
},
'lastSnapshotDateTime': 'string',
'replicatorId': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'firstByteDateTime': 'string',
'elapsedReplicationDuration': 'string',
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'lastCutover': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'sourceProperties': {
'lastUpdatedDateTime': 'string',
'recommendedInstanceType': 'string',
'identificationHints': {
'fqdn': 'string',
'hostname': 'string',
'vmWareUuid': 'string',
'awsInstanceID': 'string',
'vmPath': 'string'
},
'networkInterfaces': [
{
'macAddress': 'string',
'ips': [
'string',
],
'isPrimary': True|False
},
],
'disks': [
{
'deviceName': 'string',
'bytes': 123
},
],
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'ramBytes': 123,
'os': {
'fullString': 'string'
}
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'vcenterClientID': 'string',
'applicationID': 'string',
'userProvidedID': 'string',
'fqdnForActionFramework': 'string',
'connectorAction': {
'credentialsSecretArn': 'string',
'connectorArn': 'string'
}
}
Response Structure
(dict) --
sourceServerID (string) --
Source server ID.
arn (string) --
Source server ARN.
isArchived (boolean) --
Source server archived status.
tags (dict) --
Source server Tags.
(string) --
(string) --
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
jobID (string) --
Launched instance Job ID.
firstBoot (string) --
Launched instance first boot.
dataReplicationInfo (dict) --
Source server data replication info.
lagDuration (string) --
Request to query data replication lag duration.
etaDateTime (string) --
Request to query the time when data replication will be complete.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
deviceName (string) --
Request to query device name.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
dataReplicationState (string) --
Request to query the data replication state.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
startDateTime (string) --
Request to query data initiation start date and time.
nextAttemptDateTime (string) --
Request to query next data initiation 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.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatorId (string) --
Replication server instance ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
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.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
lastCutover (dict) --
Lifecycle last Cutover.
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.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
state (string) --
Lifecycle state.
sourceProperties (dict) --
Source server properties.
lastUpdatedDateTime (string) --
Source server last update date and time.
recommendedInstanceType (string) --
Source server recommended instance type.
identificationHints (dict) --
Source server identification hints.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
awsInstanceID (string) --
AWS Instance ID identification hint.
vmPath (string) --
vCenter VM path identification hint.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
macAddress (string) --
Network interface Mac address.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
deviceName (string) --
The disk or device name.
bytes (integer) --
The amount of storage on the disk in bytes.
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.
ramBytes (integer) --
Source server RAM in bytes.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
replicationType (string) --
Source server replication type.
vcenterClientID (string) --
Source server vCenter client id.
applicationID (string) --
Source server application ID.
userProvidedID (string) --
Source server user provided ID.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
connectorAction (dict) --
Source Server connector action.
credentialsSecretArn (string) --
Source Server connector action credentials secret arn.
connectorArn (string) --
Source Server connector action connector arn.
{'job': {'participatingServers': {'postLaunchActionsStatus': {'postLaunchActionsLaunchStatusList': {'ssmDocument': {'parameters': {'parameterType': {'SECURE_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(
sourceServerIDs=[
'string',
],
tags={
'string': 'string'
},
accountID='string'
)
list
[REQUIRED]
Start Test for Source Server IDs.
(string) --
dict
Start Test by Tags.
(string) --
(string) --
string
Start Test for Account ID.
dict
Response Syntax
{
'job': {
'jobID': 'string',
'arn': 'string',
'type': 'LAUNCH'|'TERMINATE',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'creationDateTime': 'string',
'endDateTime': 'string',
'status': 'PENDING'|'STARTED'|'COMPLETED',
'participatingServers': [
{
'sourceServerID': 'string',
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'ssmAgentDiscoveryDatetime': 'string',
'postLaunchActionsLaunchStatusList': [
{
'ssmDocument': {
'actionName': 'string',
'ssmDocumentName': 'string',
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
}
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND',
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string'
},
]
}
},
],
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
job (dict) --
Start Test Job response.
jobID (string) --
Job ID.
arn (string) --
the ARN of the specific Job.
type (string) --
Job type.
initiatedBy (string) --
Job initiated by field.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
status (string) --
Job status.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
sourceServerID (string) --
Participating server Source Server ID.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server's launched ec2 instance ID.
postLaunchActionsStatus (dict) --
Participating server's Post Launch Actions Status.
ssmAgentDiscoveryDatetime (string) --
Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.
postLaunchActionsLaunchStatusList (list) --
List of Post Launch Action status.
(dict) --
Launch Status of the Job Post Launch Actions.
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.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
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.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
ssmDocumentType (string) --
AWS Systems Manager Document type.
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.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
{'dataReplicationInfo': {'replicatorId': 'string'}}
Stop Replication.
See also: AWS API Documentation
Request Syntax
client.stop_replication(
sourceServerID='string',
accountID='string'
)
string
[REQUIRED]
Stop Replication Request source server ID.
string
Stop Replication Request account ID.
dict
Response Syntax
{
'sourceServerID': 'string',
'arn': 'string',
'isArchived': True|False,
'tags': {
'string': 'string'
},
'launchedInstance': {
'ec2InstanceID': 'string',
'jobID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED'
},
'dataReplicationInfo': {
'lagDuration': 'string',
'etaDateTime': 'string',
'replicatedDisks': [
{
'deviceName': 'string',
'totalStorageBytes': 123,
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'backloggedStorageBytes': 123
},
],
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'dataReplicationInitiation': {
'startDateTime': 'string',
'nextAttemptDateTime': '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'
},
]
},
'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'
},
'lastSnapshotDateTime': 'string',
'replicatorId': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'firstByteDateTime': 'string',
'elapsedReplicationDuration': 'string',
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'lastCutover': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'sourceProperties': {
'lastUpdatedDateTime': 'string',
'recommendedInstanceType': 'string',
'identificationHints': {
'fqdn': 'string',
'hostname': 'string',
'vmWareUuid': 'string',
'awsInstanceID': 'string',
'vmPath': 'string'
},
'networkInterfaces': [
{
'macAddress': 'string',
'ips': [
'string',
],
'isPrimary': True|False
},
],
'disks': [
{
'deviceName': 'string',
'bytes': 123
},
],
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'ramBytes': 123,
'os': {
'fullString': 'string'
}
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'vcenterClientID': 'string',
'applicationID': 'string',
'userProvidedID': 'string',
'fqdnForActionFramework': 'string',
'connectorAction': {
'credentialsSecretArn': 'string',
'connectorArn': 'string'
}
}
Response Structure
(dict) --
sourceServerID (string) --
Source server ID.
arn (string) --
Source server ARN.
isArchived (boolean) --
Source server archived status.
tags (dict) --
Source server Tags.
(string) --
(string) --
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
jobID (string) --
Launched instance Job ID.
firstBoot (string) --
Launched instance first boot.
dataReplicationInfo (dict) --
Source server data replication info.
lagDuration (string) --
Request to query data replication lag duration.
etaDateTime (string) --
Request to query the time when data replication will be complete.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
deviceName (string) --
Request to query device name.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
dataReplicationState (string) --
Request to query the data replication state.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
startDateTime (string) --
Request to query data initiation start date and time.
nextAttemptDateTime (string) --
Request to query next data initiation 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.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatorId (string) --
Replication server instance ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
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.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
lastCutover (dict) --
Lifecycle last Cutover.
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.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
state (string) --
Lifecycle state.
sourceProperties (dict) --
Source server properties.
lastUpdatedDateTime (string) --
Source server last update date and time.
recommendedInstanceType (string) --
Source server recommended instance type.
identificationHints (dict) --
Source server identification hints.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
awsInstanceID (string) --
AWS Instance ID identification hint.
vmPath (string) --
vCenter VM path identification hint.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
macAddress (string) --
Network interface Mac address.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
deviceName (string) --
The disk or device name.
bytes (integer) --
The amount of storage on the disk in bytes.
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.
ramBytes (integer) --
Source server RAM in bytes.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
replicationType (string) --
Source server replication type.
vcenterClientID (string) --
Source server vCenter client id.
applicationID (string) --
Source server application ID.
userProvidedID (string) --
Source server user provided ID.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
connectorAction (dict) --
Source Server connector action.
credentialsSecretArn (string) --
Source Server connector action credentials secret arn.
connectorArn (string) --
Source Server connector action connector arn.
{'job': {'participatingServers': {'postLaunchActionsStatus': {'postLaunchActionsLaunchStatusList': {'ssmDocument': {'parameters': {'parameterType': {'SECURE_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(
sourceServerIDs=[
'string',
],
tags={
'string': 'string'
},
accountID='string'
)
list
[REQUIRED]
Terminate Target instance by Source Server IDs.
(string) --
dict
Terminate Target instance by Tags.
(string) --
(string) --
string
Terminate Target instance by Account ID
dict
Response Syntax
{
'job': {
'jobID': 'string',
'arn': 'string',
'type': 'LAUNCH'|'TERMINATE',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'creationDateTime': 'string',
'endDateTime': 'string',
'status': 'PENDING'|'STARTED'|'COMPLETED',
'participatingServers': [
{
'sourceServerID': 'string',
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'ssmAgentDiscoveryDatetime': 'string',
'postLaunchActionsLaunchStatusList': [
{
'ssmDocument': {
'actionName': 'string',
'ssmDocumentName': 'string',
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
}
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND',
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string'
},
]
}
},
],
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
job (dict) --
Terminate Target instance Job response.
jobID (string) --
Job ID.
arn (string) --
the ARN of the specific Job.
type (string) --
Job type.
initiatedBy (string) --
Job initiated by field.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
status (string) --
Job status.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
sourceServerID (string) --
Participating server Source Server ID.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server's launched ec2 instance ID.
postLaunchActionsStatus (dict) --
Participating server's Post Launch Actions Status.
ssmAgentDiscoveryDatetime (string) --
Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.
postLaunchActionsLaunchStatusList (list) --
List of Post Launch Action status.
(dict) --
Launch Status of the Job Post Launch Actions.
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.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
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.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
ssmDocumentType (string) --
AWS Systems Manager Document type.
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.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
{'postLaunchActions': {'ssmDocuments': {'parameters': {'parameterType': {'SECURE_STRING'}}}}}
Updates multiple LaunchConfigurations by Source Server ID.
See also: AWS API Documentation
Request Syntax
client.update_launch_configuration(
sourceServerID='string',
name='string',
launchDisposition='STOPPED'|'STARTED',
targetInstanceTypeRightSizingMethod='NONE'|'BASIC',
copyPrivateIp=True|False,
copyTags=True|False,
licensing={
'osByol': True|False
},
bootMode='LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
postLaunchActions={
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'cloudWatchLogGroupName': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'ssmDocumentName': 'string',
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
}
},
]
},
enableMapAutoTagging=True|False,
mapAutoTaggingMpeID='string',
accountID='string'
)
string
[REQUIRED]
Update Launch configuration by Source Server ID request.
string
Update Launch configuration name request.
string
Update Launch configuration launch disposition request.
string
Update Launch configuration Target instance right sizing request.
boolean
Update Launch configuration copy Private IP request.
boolean
Update Launch configuration copy Tags request.
dict
Update Launch configuration licensing request.
osByol (boolean) --
Configure BYOL OS licensing.
string
Update Launch configuration boot mode request.
dict
Post Launch Actions to executed on the Test or Cutover instance.
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.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) -- [REQUIRED]
User-friendly name for the AWS Systems Manager Document.
ssmDocumentName (string) -- [REQUIRED]
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
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.
parameterType (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter type.
parameterName (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter name.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
boolean
Enable map auto tagging.
string
Launch configuration map auto tagging MPE ID.
string
Update Launch configuration Account ID.
dict
Response Syntax
{
'sourceServerID': 'string',
'name': 'string',
'ec2LaunchTemplateID': 'string',
'launchDisposition': 'STOPPED'|'STARTED',
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC',
'copyPrivateIp': True|False,
'copyTags': True|False,
'licensing': {
'osByol': True|False
},
'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
'postLaunchActions': {
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'cloudWatchLogGroupName': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'ssmDocumentName': 'string',
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
}
},
]
},
'enableMapAutoTagging': True|False,
'mapAutoTaggingMpeID': 'string'
}
Response Structure
(dict) --
sourceServerID (string) --
Launch configuration Source Server ID.
name (string) --
Launch configuration name.
ec2LaunchTemplateID (string) --
Launch configuration EC2 Launch template ID.
launchDisposition (string) --
Launch disposition for launch configuration.
targetInstanceTypeRightSizingMethod (string) --
Launch configuration Target instance type right sizing method.
copyPrivateIp (boolean) --
Copy Private IP during Launch Configuration.
copyTags (boolean) --
Copy Tags during Launch Configuration.
licensing (dict) --
Launch configuration OS licensing.
osByol (boolean) --
Configure BYOL OS licensing.
bootMode (string) --
Launch configuration boot mode.
postLaunchActions (dict) --
Post Launch Actions to executed on the Test or Cutover instance.
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.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
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.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
enableMapAutoTagging (boolean) --
Enable map auto tagging.
mapAutoTaggingMpeID (string) --
Map auto tagging MPE ID.
{'enableParametersEncryption': 'boolean',
'parametersEncryptionKey': 'string',
'postLaunchActions': {'ssmDocuments': {'parameters': {'parameterType': {'SECURE_STRING'}}}}}
Updates an existing Launch Configuration Template by ID.
See also: AWS API Documentation
Request Syntax
client.update_launch_configuration_template(
launchConfigurationTemplateID='string',
postLaunchActions={
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'cloudWatchLogGroupName': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'ssmDocumentName': 'string',
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
}
},
]
},
enableMapAutoTagging=True|False,
mapAutoTaggingMpeID='string',
launchDisposition='STOPPED'|'STARTED',
targetInstanceTypeRightSizingMethod='NONE'|'BASIC',
copyPrivateIp=True|False,
associatePublicIpAddress=True|False,
copyTags=True|False,
licensing={
'osByol': True|False
},
bootMode='LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
smallVolumeMaxSize=123,
smallVolumeConf={
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
'iops': 123,
'throughput': 123
},
largeVolumeConf={
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
'iops': 123,
'throughput': 123
},
enableParametersEncryption=True|False,
parametersEncryptionKey='string'
)
string
[REQUIRED]
Launch Configuration Template ID.
dict
Post Launch Action to execute on the Test or Cutover instance.
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.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) -- [REQUIRED]
User-friendly name for the AWS Systems Manager Document.
ssmDocumentName (string) -- [REQUIRED]
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
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.
parameterType (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter type.
parameterName (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter name.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
boolean
Enable map auto tagging.
string
Launch configuration template map auto tagging MPE ID.
string
Launch disposition.
string
Target instance type right-sizing method.
boolean
Copy private Ip.
boolean
Associate public Ip address.
boolean
Copy tags.
dict
Configure Licensing.
osByol (boolean) --
Configure BYOL OS licensing.
string
Launch configuration template boot mode.
integer
Small volume maximum size.
dict
Small volume config.
volumeType (string) --
Launch template disk volume type configuration.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
dict
Large volume config.
volumeType (string) --
Launch template disk volume type configuration.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
boolean
Enable parameters encryption.
string
Parameters encryption key.
dict
Response Syntax
{
'launchConfigurationTemplateID': 'string',
'arn': 'string',
'postLaunchActions': {
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'cloudWatchLogGroupName': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'ssmDocumentName': 'string',
'timeoutSeconds': 123,
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterType': 'STRING'|'SECURE_STRING',
'parameterName': 'string'
},
]
},
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
}
},
]
},
'enableMapAutoTagging': True|False,
'mapAutoTaggingMpeID': 'string',
'tags': {
'string': 'string'
},
'ec2LaunchTemplateID': 'string',
'launchDisposition': 'STOPPED'|'STARTED',
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC',
'copyPrivateIp': True|False,
'associatePublicIpAddress': True|False,
'copyTags': True|False,
'licensing': {
'osByol': True|False
},
'bootMode': 'LEGACY_BIOS'|'UEFI'|'USE_SOURCE',
'smallVolumeMaxSize': 123,
'smallVolumeConf': {
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
'iops': 123,
'throughput': 123
},
'largeVolumeConf': {
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard',
'iops': 123,
'throughput': 123
},
'enableParametersEncryption': True|False,
'parametersEncryptionKey': 'string'
}
Response Structure
(dict) --
launchConfigurationTemplateID (string) --
ID of the Launch Configuration Template.
arn (string) --
ARN of the Launch Configuration Template.
postLaunchActions (dict) --
Post Launch Actions of the Launch Configuration Template.
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.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
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.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
enableMapAutoTagging (boolean) --
Enable map auto tagging.
mapAutoTaggingMpeID (string) --
Launch configuration template map auto tagging MPE ID.
tags (dict) --
Tags of the Launch Configuration Template.
(string) --
(string) --
ec2LaunchTemplateID (string) --
EC2 launch template ID.
launchDisposition (string) --
Launch disposition.
targetInstanceTypeRightSizingMethod (string) --
Target instance type right-sizing method.
copyPrivateIp (boolean) --
Copy private Ip.
associatePublicIpAddress (boolean) --
Associate public Ip address.
copyTags (boolean) --
Copy tags.
licensing (dict) --
Configure Licensing.
osByol (boolean) --
Configure BYOL OS licensing.
bootMode (string) --
Launch configuration template boot mode.
smallVolumeMaxSize (integer) --
Small volume maximum size.
smallVolumeConf (dict) --
Small volume config.
volumeType (string) --
Launch template disk volume type configuration.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
largeVolumeConf (dict) --
Large volume config.
volumeType (string) --
Launch template disk volume type configuration.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
enableParametersEncryption (boolean) --
Enable parameters encryption.
parametersEncryptionKey (string) --
Parameters encryption key.
{'internetProtocol': 'IPV4 | IPV6'}
Allows you to update multiple ReplicationConfigurations by Source Server ID.
See also: AWS API Documentation
Request Syntax
client.update_replication_configuration(
sourceServerID='string',
name='string',
stagingAreaSubnetId='string',
associateDefaultSecurityGroup=True|False,
replicationServersSecurityGroupsIDs=[
'string',
],
replicationServerInstanceType='string',
useDedicatedReplicationServer=True|False,
defaultLargeStagingDiskType='GP2'|'ST1'|'GP3',
replicatedDisks=[
{
'deviceName': 'string',
'isBootDisk': True|False,
'stagingDiskType': 'AUTO'|'GP2'|'IO1'|'SC1'|'ST1'|'STANDARD'|'GP3'|'IO2',
'iops': 123,
'throughput': 123
},
],
ebsEncryption='DEFAULT'|'CUSTOM',
ebsEncryptionKeyArn='string',
bandwidthThrottling=123,
dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP',
createPublicIP=True|False,
stagingAreaTags={
'string': 'string'
},
useFipsEndpoint=True|False,
accountID='string',
internetProtocol='IPV4'|'IPV6'
)
string
[REQUIRED]
Update replication configuration Source Server ID request.
string
Update replication configuration name request.
string
Update replication configuration Staging Area subnet request.
boolean
Update replication configuration associate default Application Migration Service Security group request.
list
Update replication configuration Replication Server Security Groups IDs request.
(string) --
string
Update replication configuration Replication Server instance type request.
boolean
Update replication configuration use dedicated Replication Server request.
string
Update replication configuration use default large Staging Disk type request.
list
Update replication configuration replicated disks request.
(dict) --
Replication Configuration replicated disk.
deviceName (string) --
Replication Configuration replicated disk device name.
isBootDisk (boolean) --
Replication Configuration replicated disk boot disk.
stagingDiskType (string) --
Replication Configuration replicated disk staging disk type.
iops (integer) --
Replication Configuration replicated disk IOPs.
throughput (integer) --
Replication Configuration replicated disk throughput.
string
Update replication configuration EBS encryption request.
string
Update replication configuration EBS encryption key ARN request.
integer
Update replication configuration bandwidth throttling request.
string
Update replication configuration data plane routing request.
boolean
Update replication configuration create Public IP request.
dict
Update replication configuration Staging Area Tags request.
(string) --
(string) --
boolean
Update replication configuration use Fips Endpoint.
string
Update replication configuration Account ID request.
string
Update replication configuration internet protocol.
dict
Response Syntax
{
'sourceServerID': 'string',
'name': 'string',
'stagingAreaSubnetId': 'string',
'associateDefaultSecurityGroup': True|False,
'replicationServersSecurityGroupsIDs': [
'string',
],
'replicationServerInstanceType': 'string',
'useDedicatedReplicationServer': True|False,
'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
'replicatedDisks': [
{
'deviceName': 'string',
'isBootDisk': True|False,
'stagingDiskType': 'AUTO'|'GP2'|'IO1'|'SC1'|'ST1'|'STANDARD'|'GP3'|'IO2',
'iops': 123,
'throughput': 123
},
],
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'bandwidthThrottling': 123,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'createPublicIP': True|False,
'stagingAreaTags': {
'string': 'string'
},
'useFipsEndpoint': True|False,
'internetProtocol': 'IPV4'|'IPV6'
}
Response Structure
(dict) --
sourceServerID (string) --
Replication Configuration Source Server ID.
name (string) --
Replication Configuration name.
stagingAreaSubnetId (string) --
Replication Configuration Staging Area subnet ID.
associateDefaultSecurityGroup (boolean) --
Replication Configuration associate default Application Migration Service Security Group.
replicationServersSecurityGroupsIDs (list) --
Replication Configuration Replication Server Security Group IDs.
(string) --
replicationServerInstanceType (string) --
Replication Configuration Replication Server instance type.
useDedicatedReplicationServer (boolean) --
Replication Configuration use Dedicated Replication Server.
defaultLargeStagingDiskType (string) --
Replication Configuration use default large Staging Disks.
replicatedDisks (list) --
Replication Configuration replicated disks.
(dict) --
Replication Configuration replicated disk.
deviceName (string) --
Replication Configuration replicated disk device name.
isBootDisk (boolean) --
Replication Configuration replicated disk boot disk.
stagingDiskType (string) --
Replication Configuration replicated disk staging disk type.
iops (integer) --
Replication Configuration replicated disk IOPs.
throughput (integer) --
Replication Configuration replicated disk throughput.
ebsEncryption (string) --
Replication Configuration EBS encryption.
ebsEncryptionKeyArn (string) --
Replication Configuration EBS encryption key ARN.
bandwidthThrottling (integer) --
Replication Configuration set bandwidth throttling.
dataPlaneRouting (string) --
Replication Configuration data plane routing.
createPublicIP (boolean) --
Replication Configuration create Public IP.
stagingAreaTags (dict) --
Replication Configuration Staging Area tags.
(string) --
(string) --
useFipsEndpoint (boolean) --
Replication Configuration use Fips Endpoint.
internetProtocol (string) --
Replication Configuration internet protocol.
{'internetProtocol': 'IPV4 | IPV6'}
Updates multiple ReplicationConfigurationTemplates by ID.
See also: AWS API Documentation
Request Syntax
client.update_replication_configuration_template(
replicationConfigurationTemplateID='string',
arn='string',
stagingAreaSubnetId='string',
associateDefaultSecurityGroup=True|False,
replicationServersSecurityGroupsIDs=[
'string',
],
replicationServerInstanceType='string',
useDedicatedReplicationServer=True|False,
defaultLargeStagingDiskType='GP2'|'ST1'|'GP3',
ebsEncryption='DEFAULT'|'CUSTOM',
ebsEncryptionKeyArn='string',
bandwidthThrottling=123,
dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP',
createPublicIP=True|False,
stagingAreaTags={
'string': 'string'
},
useFipsEndpoint=True|False,
internetProtocol='IPV4'|'IPV6'
)
string
[REQUIRED]
Update replication configuration template template ID request.
string
Update replication configuration template ARN request.
string
Update replication configuration template Staging Area subnet ID request.
boolean
Update replication configuration template associate default Application Migration Service Security group request.
list
Update replication configuration template Replication Server Security groups IDs request.
(string) --
string
Update replication configuration template Replication Server instance type request.
boolean
Update replication configuration template use dedicated Replication Server 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.
integer
Update replication configuration template bandwidth throttling request.
string
Update replication configuration template data plane routing request.
boolean
Update replication configuration template create Public IP request.
dict
Update replication configuration template Staging Area Tags request.
(string) --
(string) --
boolean
Update replication configuration template use Fips Endpoint request.
string
Update replication configuration template internet protocol request.
dict
Response Syntax
{
'replicationConfigurationTemplateID': 'string',
'arn': 'string',
'stagingAreaSubnetId': 'string',
'associateDefaultSecurityGroup': True|False,
'replicationServersSecurityGroupsIDs': [
'string',
],
'replicationServerInstanceType': 'string',
'useDedicatedReplicationServer': True|False,
'defaultLargeStagingDiskType': 'GP2'|'ST1'|'GP3',
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'bandwidthThrottling': 123,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'createPublicIP': True|False,
'stagingAreaTags': {
'string': 'string'
},
'useFipsEndpoint': True|False,
'tags': {
'string': 'string'
},
'internetProtocol': 'IPV4'|'IPV6'
}
Response Structure
(dict) --
replicationConfigurationTemplateID (string) --
Replication Configuration template ID.
arn (string) --
Replication Configuration template ARN.
stagingAreaSubnetId (string) --
Replication Configuration template Staging Area subnet ID.
associateDefaultSecurityGroup (boolean) --
Replication Configuration template associate default Application Migration Service Security group.
replicationServersSecurityGroupsIDs (list) --
Replication Configuration template server Security Groups IDs.
(string) --
replicationServerInstanceType (string) --
Replication Configuration template server instance type.
useDedicatedReplicationServer (boolean) --
Replication Configuration template use Dedicated Replication Server.
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.
bandwidthThrottling (integer) --
Replication Configuration template bandwidth throttling.
dataPlaneRouting (string) --
Replication Configuration template data plane routing.
createPublicIP (boolean) --
Replication Configuration template create Public IP.
stagingAreaTags (dict) --
Replication Configuration template Staging Area Tags.
(string) --
(string) --
useFipsEndpoint (boolean) --
Replication Configuration template use Fips Endpoint.
tags (dict) --
Replication Configuration template Tags.
(string) --
(string) --
internetProtocol (string) --
Replication Configuration template internet protocol.
{'dataReplicationInfo': {'replicatorId': 'string'}}
Update Source Server.
See also: AWS API Documentation
Request Syntax
client.update_source_server(
accountID='string',
sourceServerID='string',
connectorAction={
'credentialsSecretArn': 'string',
'connectorArn': 'string'
}
)
string
Update Source Server request account ID.
string
[REQUIRED]
Update Source Server request source server ID.
dict
Update Source Server request connector action.
credentialsSecretArn (string) --
Source Server connector action credentials secret arn.
connectorArn (string) --
Source Server connector action connector arn.
dict
Response Syntax
{
'sourceServerID': 'string',
'arn': 'string',
'isArchived': True|False,
'tags': {
'string': 'string'
},
'launchedInstance': {
'ec2InstanceID': 'string',
'jobID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED'
},
'dataReplicationInfo': {
'lagDuration': 'string',
'etaDateTime': 'string',
'replicatedDisks': [
{
'deviceName': 'string',
'totalStorageBytes': 123,
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'backloggedStorageBytes': 123
},
],
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'dataReplicationInitiation': {
'startDateTime': 'string',
'nextAttemptDateTime': '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'
},
]
},
'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'
},
'lastSnapshotDateTime': 'string',
'replicatorId': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'firstByteDateTime': 'string',
'elapsedReplicationDuration': 'string',
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'lastCutover': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'sourceProperties': {
'lastUpdatedDateTime': 'string',
'recommendedInstanceType': 'string',
'identificationHints': {
'fqdn': 'string',
'hostname': 'string',
'vmWareUuid': 'string',
'awsInstanceID': 'string',
'vmPath': 'string'
},
'networkInterfaces': [
{
'macAddress': 'string',
'ips': [
'string',
],
'isPrimary': True|False
},
],
'disks': [
{
'deviceName': 'string',
'bytes': 123
},
],
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'ramBytes': 123,
'os': {
'fullString': 'string'
}
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'vcenterClientID': 'string',
'applicationID': 'string',
'userProvidedID': 'string',
'fqdnForActionFramework': 'string',
'connectorAction': {
'credentialsSecretArn': 'string',
'connectorArn': 'string'
}
}
Response Structure
(dict) --
sourceServerID (string) --
Source server ID.
arn (string) --
Source server ARN.
isArchived (boolean) --
Source server archived status.
tags (dict) --
Source server Tags.
(string) --
(string) --
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
jobID (string) --
Launched instance Job ID.
firstBoot (string) --
Launched instance first boot.
dataReplicationInfo (dict) --
Source server data replication info.
lagDuration (string) --
Request to query data replication lag duration.
etaDateTime (string) --
Request to query the time when data replication will be complete.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
deviceName (string) --
Request to query device name.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
dataReplicationState (string) --
Request to query the data replication state.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
startDateTime (string) --
Request to query data initiation start date and time.
nextAttemptDateTime (string) --
Request to query next data initiation 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.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatorId (string) --
Replication server instance ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
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.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
lastCutover (dict) --
Lifecycle last Cutover.
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.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
state (string) --
Lifecycle state.
sourceProperties (dict) --
Source server properties.
lastUpdatedDateTime (string) --
Source server last update date and time.
recommendedInstanceType (string) --
Source server recommended instance type.
identificationHints (dict) --
Source server identification hints.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
awsInstanceID (string) --
AWS Instance ID identification hint.
vmPath (string) --
vCenter VM path identification hint.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
macAddress (string) --
Network interface Mac address.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
deviceName (string) --
The disk or device name.
bytes (integer) --
The amount of storage on the disk in bytes.
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.
ramBytes (integer) --
Source server RAM in bytes.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
replicationType (string) --
Source server replication type.
vcenterClientID (string) --
Source server vCenter client id.
applicationID (string) --
Source server application ID.
userProvidedID (string) --
Source server user provided ID.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
connectorAction (dict) --
Source Server connector action.
credentialsSecretArn (string) --
Source Server connector action credentials secret arn.
connectorArn (string) --
Source Server connector action connector arn.
{'dataReplicationInfo': {'replicatorId': 'string'}}
Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.
SNAPSHOT_SHIPPING should be used for agentless replication.
See also: AWS API Documentation
Request Syntax
client.update_source_server_replication_type(
sourceServerID='string',
replicationType='AGENT_BASED'|'SNAPSHOT_SHIPPING',
accountID='string'
)
string
[REQUIRED]
ID of source server on which to update replication type.
string
[REQUIRED]
Replication type to which to update source server.
string
Account ID on which to update replication type.
dict
Response Syntax
{
'sourceServerID': 'string',
'arn': 'string',
'isArchived': True|False,
'tags': {
'string': 'string'
},
'launchedInstance': {
'ec2InstanceID': 'string',
'jobID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED'
},
'dataReplicationInfo': {
'lagDuration': 'string',
'etaDateTime': 'string',
'replicatedDisks': [
{
'deviceName': 'string',
'totalStorageBytes': 123,
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'backloggedStorageBytes': 123
},
],
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'dataReplicationInitiation': {
'startDateTime': 'string',
'nextAttemptDateTime': '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'
},
]
},
'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'
},
'lastSnapshotDateTime': 'string',
'replicatorId': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'firstByteDateTime': 'string',
'elapsedReplicationDuration': 'string',
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'lastCutover': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
},
'finalized': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'sourceProperties': {
'lastUpdatedDateTime': 'string',
'recommendedInstanceType': 'string',
'identificationHints': {
'fqdn': 'string',
'hostname': 'string',
'vmWareUuid': 'string',
'awsInstanceID': 'string',
'vmPath': 'string'
},
'networkInterfaces': [
{
'macAddress': 'string',
'ips': [
'string',
],
'isPrimary': True|False
},
],
'disks': [
{
'deviceName': 'string',
'bytes': 123
},
],
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'ramBytes': 123,
'os': {
'fullString': 'string'
}
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'vcenterClientID': 'string',
'applicationID': 'string',
'userProvidedID': 'string',
'fqdnForActionFramework': 'string',
'connectorAction': {
'credentialsSecretArn': 'string',
'connectorArn': 'string'
}
}
Response Structure
(dict) --
sourceServerID (string) --
Source server ID.
arn (string) --
Source server ARN.
isArchived (boolean) --
Source server archived status.
tags (dict) --
Source server Tags.
(string) --
(string) --
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
jobID (string) --
Launched instance Job ID.
firstBoot (string) --
Launched instance first boot.
dataReplicationInfo (dict) --
Source server data replication info.
lagDuration (string) --
Request to query data replication lag duration.
etaDateTime (string) --
Request to query the time when data replication will be complete.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
deviceName (string) --
Request to query device name.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
dataReplicationState (string) --
Request to query the data replication state.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
startDateTime (string) --
Request to query data initiation start date and time.
nextAttemptDateTime (string) --
Request to query next data initiation 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.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatorId (string) --
Replication server instance ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
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.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
lastCutover (dict) --
Lifecycle last Cutover.
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.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
state (string) --
Lifecycle state.
sourceProperties (dict) --
Source server properties.
lastUpdatedDateTime (string) --
Source server last update date and time.
recommendedInstanceType (string) --
Source server recommended instance type.
identificationHints (dict) --
Source server identification hints.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
awsInstanceID (string) --
AWS Instance ID identification hint.
vmPath (string) --
vCenter VM path identification hint.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
macAddress (string) --
Network interface Mac address.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
deviceName (string) --
The disk or device name.
bytes (integer) --
The amount of storage on the disk in bytes.
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.
ramBytes (integer) --
Source server RAM in bytes.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
replicationType (string) --
Source server replication type.
vcenterClientID (string) --
Source server vCenter client id.
applicationID (string) --
Source server application ID.
userProvidedID (string) --
Source server user provided ID.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
connectorAction (dict) --
Source Server connector action.
credentialsSecretArn (string) --
Source Server connector action credentials secret arn.
connectorArn (string) --
Source Server connector action connector arn.