2023/03/21 - Application Migration Service - 6 new 21 updated api methods
Changes This release introduces the Import and export feature and expansion of the post-launch actions
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': [
{
'creationDateTime': 'string',
'endDateTime': 'string',
'importID': 'string',
'progressPercentage': ...,
's3BucketSource': {
's3Bucket': 'string',
's3BucketOwner': 'string',
's3Key': 'string'
},
'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED',
'summary': {
'applications': {
'createdCount': 123,
'modifiedCount': 123
},
'servers': {
'createdCount': 123,
'modifiedCount': 123
},
'waves': {
'createdCount': 123,
'modifiedCount': 123
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
List import response.
items (list) --
List import response items.
(dict) --
Import task.
creationDateTime (string) --
Import task creation datetime.
endDateTime (string) --
Import task end datetime.
importID (string) --
Import task id.
progressPercentage (float) --
Import task progress percentage.
s3BucketSource (dict) --
Import task s3 bucket source.
s3Bucket (string) --
S3 bucket source s3 bucket.
s3BucketOwner (string) --
S3 bucket source s3 bucket owner.
s3Key (string) --
S3 bucket source s3 key.
status (string) --
Import task status.
summary (dict) --
Import task summary.
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.
waves (dict) --
Import task summary waves.
createdCount (integer) --
Import task summery waves created count.
modifiedCount (integer) --
Import task summery waves modified count.
nextToken (string) --
List import response next token.
Start import.
See also: AWS API Documentation
Request Syntax
client.start_import(
clientToken='string',
s3BucketSource={
's3Bucket': 'string',
's3BucketOwner': 'string',
's3Key': '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.
s3BucketOwner (string) --
S3 bucket source s3 bucket owner.
s3Key (string) -- [REQUIRED]
S3 bucket source s3 key.
dict
Response Syntax
{
'importTask': {
'creationDateTime': 'string',
'endDateTime': 'string',
'importID': 'string',
'progressPercentage': ...,
's3BucketSource': {
's3Bucket': 'string',
's3BucketOwner': 'string',
's3Key': 'string'
},
'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED',
'summary': {
'applications': {
'createdCount': 123,
'modifiedCount': 123
},
'servers': {
'createdCount': 123,
'modifiedCount': 123
},
'waves': {
'createdCount': 123,
'modifiedCount': 123
}
}
}
}
Response Structure
(dict) --
Start import response.
importTask (dict) --
Start import response import task.
creationDateTime (string) --
Import task creation datetime.
endDateTime (string) --
Import task end datetime.
importID (string) --
Import task id.
progressPercentage (float) --
Import task progress percentage.
s3BucketSource (dict) --
Import task s3 bucket source.
s3Bucket (string) --
S3 bucket source s3 bucket.
s3BucketOwner (string) --
S3 bucket source s3 bucket owner.
s3Key (string) --
S3 bucket source s3 key.
status (string) --
Import task status.
summary (dict) --
Import task summary.
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.
waves (dict) --
Import task summary waves.
createdCount (integer) --
Import task summery waves created count.
modifiedCount (integer) --
Import task summery waves modified count.
List import errors.
See also: AWS API Documentation
Request Syntax
client.list_import_errors(
importID='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
List import errors request import id.
integer
List import errors request max results.
string
List import errors request next token.
dict
Response Syntax
{
'items': [
{
'errorData': {
'applicationID': 'string',
'ec2LaunchTemplateID': 'string',
'rawError': 'string',
'rowNumber': 123,
'sourceServerID': 'string',
'waveID': 'string'
},
'errorDateTime': 'string',
'errorType': 'VALIDATION_ERROR'|'PROCESSING_ERROR'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
List imports errors response.
items (list) --
List imports errors response items.
(dict) --
Import task error.
errorData (dict) --
Import task error data.
applicationID (string) --
Import error data application ID.
ec2LaunchTemplateID (string) --
Import error data ec2 LaunchTemplate ID.
rawError (string) --
Import error data raw error.
rowNumber (integer) --
Import error data row number.
sourceServerID (string) --
Import error data source server ID.
waveID (string) --
Import error data wave id.
errorDateTime (string) --
Import task error datetime.
errorType (string) --
Import task error type.
nextToken (string) --
List imports errors response next token.
List export errors.
See also: AWS API Documentation
Request Syntax
client.list_export_errors(
exportID='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
List export errors request export id.
integer
List export errors request max results.
string
List export errors request next token.
dict
Response Syntax
{
'items': [
{
'errorData': {
'rawError': 'string'
},
'errorDateTime': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
List export errors response.
items (list) --
List export errors response items.
(dict) --
Export task error.
errorData (dict) --
Export task error data.
rawError (string) --
Export errors data raw error.
errorDateTime (string) --
Export task error datetime.
nextToken (string) --
List export errors response next token.
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': [
{
'creationDateTime': 'string',
'endDateTime': 'string',
'exportID': 'string',
'progressPercentage': ...,
's3Bucket': 'string',
's3BucketOwner': 'string',
's3Key': 'string',
'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED',
'summary': {
'applicationsCount': 123,
'serversCount': 123,
'wavesCount': 123
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
List export response.
items (list) --
List export response items.
(dict) --
Export task.
creationDateTime (string) --
Export task creation datetime.
endDateTime (string) --
Export task end datetime.
exportID (string) --
Export task id.
progressPercentage (float) --
Export task progress percentage.
s3Bucket (string) --
Export task s3 bucket.
s3BucketOwner (string) --
Export task s3 bucket owner.
s3Key (string) --
Export task s3 key.
status (string) --
Export task status.
summary (dict) --
Export task summary.
applicationsCount (integer) --
Export task summary applications count.
serversCount (integer) --
Export task summary servers count.
wavesCount (integer) --
Export task summary waves count.
nextToken (string) --
List export response next token.
Start export.
See also: AWS API Documentation
Request Syntax
client.start_export(
s3Bucket='string',
s3BucketOwner='string',
s3Key='string'
)
string
[REQUIRED]
Start export request s3 bucket.
string
Start export request s3 bucket owner.
string
[REQUIRED]
Start export request s3key.
dict
Response Syntax
{
'exportTask': {
'creationDateTime': 'string',
'endDateTime': 'string',
'exportID': 'string',
'progressPercentage': ...,
's3Bucket': 'string',
's3BucketOwner': 'string',
's3Key': 'string',
'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED',
'summary': {
'applicationsCount': 123,
'serversCount': 123,
'wavesCount': 123
}
}
}
Response Structure
(dict) --
Start export response.
exportTask (dict) --
Start export response export task.
creationDateTime (string) --
Export task creation datetime.
endDateTime (string) --
Export task end datetime.
exportID (string) --
Export task id.
progressPercentage (float) --
Export task progress percentage.
s3Bucket (string) --
Export task s3 bucket.
s3BucketOwner (string) --
Export task s3 bucket owner.
s3Key (string) --
Export task s3 key.
status (string) --
Export task status.
summary (dict) --
Export task summary.
applicationsCount (integer) --
Export task summary applications count.
serversCount (integer) --
Export task summary servers count.
wavesCount (integer) --
Export task summary waves count.
{'fqdnForActionFramework': 'string',
'lifeCycle': {'state': {'PENDING_INSTALLATION'}},
'userProvidedID': '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(
lifeCycle={
'state': 'READY_FOR_TEST'|'READY_FOR_CUTOVER'|'CUTOVER'
},
sourceServerID='string'
)
dict
[REQUIRED]
The request to change the source server migration lifecycle state.
state (string) -- [REQUIRED]
The request to change the source server migration lifecycle state.
string
[REQUIRED]
The request to change the source server migration lifecycle state by source server ID.
dict
Response Syntax
{
'applicationID': 'string',
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'fqdnForActionFramework': 'string',
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
arn (string) --
Source server ARN.
dataReplicationInfo (dict) --
Source server data replication info.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
nextAttemptDateTime (string) --
Request to query next data initiation date and time.
startDateTime (string) --
Request to query data initiation start date and time.
steps (list) --
Request to query data initiation steps.
(dict) --
Data replication initiation step.
name (string) --
Request to query data initiation step name.
status (string) --
Request to query data initiation status.
dataReplicationState (string) --
Request to query the data replication state.
etaDateTime (string) --
Request to query the time when data replication will be complete.
lagDuration (string) --
Request to query data replication lag duration.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
deviceName (string) --
Request to query device name.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
isArchived (boolean) --
Source server archived status.
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
firstBoot (string) --
Launched instance first boot.
jobID (string) --
Launched instance Job ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
lastCutover (dict) --
Lifecycle last Cutover.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
initiated (dict) --
Lifecycle last Cutover initiated.
apiCallDateTime (string) --
jobID (string) --
Lifecycle last Cutover initiated by Job ID.
reverted (dict) --
Lifecycle last Cutover reverted.
apiCallDateTime (string) --
Lifecycle last Cutover reverted API call date time.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
initiated (dict) --
Lifecycle last Test initiated.
apiCallDateTime (string) --
Lifecycle last Test initiated API call date and time.
jobID (string) --
Lifecycle last Test initiated Job ID.
reverted (dict) --
Lifecycle last Test reverted.
apiCallDateTime (string) --
Lifecycle last Test reverted API call date and time.
state (string) --
Lifecycle state.
replicationType (string) --
Source server replication type.
sourceProperties (dict) --
Source server properties.
cpus (list) --
Source Server CPUs.
(dict) --
Source server CPU information.
cores (integer) --
The number of CPU cores on the source server.
modelName (string) --
The source server's CPU model name.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
bytes (integer) --
The amount of storage on the disk in bytes.
deviceName (string) --
The disk or device name.
identificationHints (dict) --
Source server identification hints.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmPath (string) --
vCenter VM path identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
lastUpdatedDateTime (string) --
Source server last update date and time.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
macAddress (string) --
Network interface Mac address.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
ramBytes (integer) --
Source server RAM in bytes.
recommendedInstanceType (string) --
Source server recommended instance type.
sourceServerID (string) --
Source server ID.
tags (dict) --
Source server Tags.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
{'postLaunchActions': {'ssmDocuments': {'externalParameters': {'string': {'dynamicPath': 'string'}}}}}
Creates a new Launch Configuration Template.
See also: AWS API Documentation
Request Syntax
client.create_launch_configuration_template(
associatePublicIpAddress=True|False,
bootMode='LEGACY_BIOS'|'UEFI',
copyPrivateIp=True|False,
copyTags=True|False,
enableMapAutoTagging=True|False,
largeVolumeConf={
'iops': 123,
'throughput': 123,
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard'
},
launchDisposition='STOPPED'|'STARTED',
licensing={
'osByol': True|False
},
mapAutoTaggingMpeID='string',
postLaunchActions={
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
smallVolumeConf={
'iops': 123,
'throughput': 123,
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard'
},
smallVolumeMaxSize=123,
tags={
'string': 'string'
},
targetInstanceTypeRightSizingMethod='NONE'|'BASIC'
)
boolean
Associate public Ip address.
string
Launch configuration template boot mode.
boolean
Copy private Ip.
boolean
Copy tags.
boolean
Enable map auto tagging.
dict
Large volume config.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
volumeType (string) --
Launch template disk volume type configuration.
string
Launch disposition.
dict
Configure Licensing.
osByol (boolean) --
Configure BYOL OS licensing.
string
Launch configuration template map auto tagging MPE ID.
dict
Launch configuration template post launch actions.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
deployment (string) --
Deployment type in which AWS Systems Manager Documents will be executed.
s3LogBucket (string) --
AWS Systems Manager Command's logs S3 log bucket.
s3OutputKeyPrefix (string) --
AWS Systems Manager Command's logs S3 output key prefix.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) -- [REQUIRED]
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: dynamicPath.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter name.
parameterType (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) -- [REQUIRED]
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
dict
Small volume config.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
volumeType (string) --
Launch template disk volume type configuration.
integer
Small volume maximum size.
dict
Request to associate tags during creation of a Launch Configuration Template.
(string) --
(string) --
string
Target instance type right-sizing method.
dict
Response Syntax
{
'arn': 'string',
'associatePublicIpAddress': True|False,
'bootMode': 'LEGACY_BIOS'|'UEFI',
'copyPrivateIp': True|False,
'copyTags': True|False,
'ec2LaunchTemplateID': 'string',
'enableMapAutoTagging': True|False,
'largeVolumeConf': {
'iops': 123,
'throughput': 123,
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard'
},
'launchConfigurationTemplateID': 'string',
'launchDisposition': 'STOPPED'|'STARTED',
'licensing': {
'osByol': True|False
},
'mapAutoTaggingMpeID': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'smallVolumeConf': {
'iops': 123,
'throughput': 123,
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard'
},
'smallVolumeMaxSize': 123,
'tags': {
'string': 'string'
},
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'
}
Response Structure
(dict) --
arn (string) --
ARN of the Launch Configuration Template.
associatePublicIpAddress (boolean) --
Associate public Ip address.
bootMode (string) --
Launch configuration template boot mode.
copyPrivateIp (boolean) --
Copy private Ip.
copyTags (boolean) --
Copy tags.
ec2LaunchTemplateID (string) --
EC2 launch template ID.
enableMapAutoTagging (boolean) --
Enable map auto tagging.
largeVolumeConf (dict) --
Large volume config.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
volumeType (string) --
Launch template disk volume type configuration.
launchConfigurationTemplateID (string) --
ID of the Launch Configuration Template.
launchDisposition (string) --
Launch disposition.
licensing (dict) --
Configure Licensing.
osByol (boolean) --
Configure BYOL OS licensing.
mapAutoTaggingMpeID (string) --
Launch configuration template map auto tagging MPE ID.
postLaunchActions (dict) --
Post Launch Actions of the Launch Configuration Template.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
deployment (string) --
Deployment type in which AWS Systems Manager Documents will be executed.
s3LogBucket (string) --
AWS Systems Manager Command's logs S3 log bucket.
s3OutputKeyPrefix (string) --
AWS Systems Manager Command's logs S3 output key prefix.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
smallVolumeConf (dict) --
Small volume config.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
volumeType (string) --
Launch template disk volume type configuration.
smallVolumeMaxSize (integer) --
Small volume maximum size.
tags (dict) --
Tags of the Launch Configuration Template.
(string) --
(string) --
targetInstanceTypeRightSizingMethod (string) --
Target instance type right-sizing method.
{'items': {'participatingServers': {'postLaunchActionsStatus': {'postLaunchActionsLaunchStatusList': {'ssmDocument': {'externalParameters': {'string': {'dynamicPath': '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={
'fromDate': 'string',
'jobIDs': [
'string',
],
'toDate': 'string'
},
maxResults=123,
nextToken='string'
)
dict
Request to describe Job log filters.
fromDate (string) --
Request to describe Job log filters by date.
jobIDs (list) --
Request to describe Job log filters by job ID.
(string) --
toDate (string) --
Request to describe job log items by last date.
integer
Request to describe job log items by max results.
string
Request to describe job log items by next token.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'postLaunchActionsLaunchStatusList': [
{
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string',
'ssmDocument': {
'actionName': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND'
},
],
'ssmAgentDiscoveryDatetime': 'string'
},
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to describe Job log items.
(dict) --
Job.
arn (string) --
the ARN of the specific Job.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
initiatedBy (string) --
Job initiated by field.
jobID (string) --
Job ID.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server's launched ec2 instance ID.
postLaunchActionsStatus (dict) --
Participating server's Post Launch Actions Status.
postLaunchActionsLaunchStatusList (list) --
List of Post Launch Action status.
(dict) --
Launch Status of the Job Post Launch Actions.
executionID (string) --
AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions.
executionStatus (string) --
AWS Systems Manager Document's execution status.
failureReason (string) --
AWS Systems Manager Document's failure reason.
ssmDocument (dict) --
AWS Systems Manager's Document of the of the Job Post Launch Actions.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
ssmDocumentType (string) --
AWS Systems Manager Document type.
ssmAgentDiscoveryDatetime (string) --
Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
type (string) --
Job type.
nextToken (string) --
Request to describe Job response by next token.
{'items': {'postLaunchActions': {'ssmDocuments': {'externalParameters': {'string': {'dynamicPath': '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': [
{
'arn': 'string',
'associatePublicIpAddress': True|False,
'bootMode': 'LEGACY_BIOS'|'UEFI',
'copyPrivateIp': True|False,
'copyTags': True|False,
'ec2LaunchTemplateID': 'string',
'enableMapAutoTagging': True|False,
'largeVolumeConf': {
'iops': 123,
'throughput': 123,
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard'
},
'launchConfigurationTemplateID': 'string',
'launchDisposition': 'STOPPED'|'STARTED',
'licensing': {
'osByol': True|False
},
'mapAutoTaggingMpeID': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'smallVolumeConf': {
'iops': 123,
'throughput': 123,
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard'
},
'smallVolumeMaxSize': 123,
'tags': {
'string': 'string'
},
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
List of items returned by DescribeLaunchConfigurationTemplates.
(dict) --
arn (string) --
ARN of the Launch Configuration Template.
associatePublicIpAddress (boolean) --
Associate public Ip address.
bootMode (string) --
Launch configuration template boot mode.
copyPrivateIp (boolean) --
Copy private Ip.
copyTags (boolean) --
Copy tags.
ec2LaunchTemplateID (string) --
EC2 launch template ID.
enableMapAutoTagging (boolean) --
Enable map auto tagging.
largeVolumeConf (dict) --
Large volume config.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
volumeType (string) --
Launch template disk volume type configuration.
launchConfigurationTemplateID (string) --
ID of the Launch Configuration Template.
launchDisposition (string) --
Launch disposition.
licensing (dict) --
Configure Licensing.
osByol (boolean) --
Configure BYOL OS licensing.
mapAutoTaggingMpeID (string) --
Launch configuration template map auto tagging MPE ID.
postLaunchActions (dict) --
Post Launch Actions of the Launch Configuration Template.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
deployment (string) --
Deployment type in which AWS Systems Manager Documents will be executed.
s3LogBucket (string) --
AWS Systems Manager Command's logs S3 log bucket.
s3OutputKeyPrefix (string) --
AWS Systems Manager Command's logs S3 output key prefix.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
smallVolumeConf (dict) --
Small volume config.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
volumeType (string) --
Launch template disk volume type configuration.
smallVolumeMaxSize (integer) --
Small volume maximum size.
tags (dict) --
Tags of the Launch Configuration Template.
(string) --
(string) --
targetInstanceTypeRightSizingMethod (string) --
Target instance type right-sizing method.
nextToken (string) --
Next pagination token returned from DescribeLaunchConfigurationTemplates.
{'filters': {'lifeCycleStates': {'PENDING_INSTALLATION'}}}
Response {'items': {'fqdnForActionFramework': 'string',
'lifeCycle': {'state': {'PENDING_INSTALLATION'}},
'userProvidedID': 'string'}}
Retrieves all SourceServers or multiple SourceServers by ID.
See also: AWS API Documentation
Request Syntax
client.describe_source_servers(
filters={
'applicationIDs': [
'string',
],
'isArchived': True|False,
'lifeCycleStates': [
'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION',
],
'replicationTypes': [
'AGENT_BASED'|'SNAPSHOT_SHIPPING',
],
'sourceServerIDs': [
'string',
]
},
maxResults=123,
nextToken='string'
)
dict
Request to filter Source Servers list.
applicationIDs (list) --
Request to filter Source Servers list by application IDs.
(string) --
isArchived (boolean) --
Request to filter Source Servers list by archived.
lifeCycleStates (list) --
Request to filter Source Servers list by life cycle states.
(string) --
replicationTypes (list) --
Request to filter Source Servers list by replication type.
(string) --
sourceServerIDs (list) --
Request to filter Source Servers list by Source Server ID.
(string) --
integer
Request to filter Source Servers list by maximum results.
string
Request to filter Source Servers list by next token.
dict
Response Syntax
{
'items': [
{
'applicationID': 'string',
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'fqdnForActionFramework': 'string',
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to filter Source Servers list by item.
(dict) --
applicationID (string) --
Source server application ID.
arn (string) --
Source server ARN.
dataReplicationInfo (dict) --
Source server data replication info.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
nextAttemptDateTime (string) --
Request to query next data initiation date and time.
startDateTime (string) --
Request to query data initiation start date and time.
steps (list) --
Request to query data initiation steps.
(dict) --
Data replication initiation step.
name (string) --
Request to query data initiation step name.
status (string) --
Request to query data initiation status.
dataReplicationState (string) --
Request to query the data replication state.
etaDateTime (string) --
Request to query the time when data replication will be complete.
lagDuration (string) --
Request to query data replication lag duration.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
deviceName (string) --
Request to query device name.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
isArchived (boolean) --
Source server archived status.
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
firstBoot (string) --
Launched instance first boot.
jobID (string) --
Launched instance Job ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
lastCutover (dict) --
Lifecycle last Cutover.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
initiated (dict) --
Lifecycle last Cutover initiated.
apiCallDateTime (string) --
jobID (string) --
Lifecycle last Cutover initiated by Job ID.
reverted (dict) --
Lifecycle last Cutover reverted.
apiCallDateTime (string) --
Lifecycle last Cutover reverted API call date time.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
initiated (dict) --
Lifecycle last Test initiated.
apiCallDateTime (string) --
Lifecycle last Test initiated API call date and time.
jobID (string) --
Lifecycle last Test initiated Job ID.
reverted (dict) --
Lifecycle last Test reverted.
apiCallDateTime (string) --
Lifecycle last Test reverted API call date and time.
state (string) --
Lifecycle state.
replicationType (string) --
Source server replication type.
sourceProperties (dict) --
Source server properties.
cpus (list) --
Source Server CPUs.
(dict) --
Source server CPU information.
cores (integer) --
The number of CPU cores on the source server.
modelName (string) --
The source server's CPU model name.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
bytes (integer) --
The amount of storage on the disk in bytes.
deviceName (string) --
The disk or device name.
identificationHints (dict) --
Source server identification hints.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmPath (string) --
vCenter VM path identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
lastUpdatedDateTime (string) --
Source server last update date and time.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
macAddress (string) --
Network interface Mac address.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
ramBytes (integer) --
Source server RAM in bytes.
recommendedInstanceType (string) --
Source server recommended instance type.
sourceServerID (string) --
Source server ID.
tags (dict) --
Source server Tags.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
nextToken (string) --
Request to filter Source Servers next token.
{'fqdnForActionFramework': 'string',
'lifeCycle': {'state': {'PENDING_INSTALLATION'}},
'userProvidedID': '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'
)
string
[REQUIRED]
Request to disconnect Source Server from service by Server ID.
dict
Response Syntax
{
'applicationID': 'string',
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'fqdnForActionFramework': 'string',
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
arn (string) --
Source server ARN.
dataReplicationInfo (dict) --
Source server data replication info.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
nextAttemptDateTime (string) --
Request to query next data initiation date and time.
startDateTime (string) --
Request to query data initiation start date and time.
steps (list) --
Request to query data initiation steps.
(dict) --
Data replication initiation step.
name (string) --
Request to query data initiation step name.
status (string) --
Request to query data initiation status.
dataReplicationState (string) --
Request to query the data replication state.
etaDateTime (string) --
Request to query the time when data replication will be complete.
lagDuration (string) --
Request to query data replication lag duration.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
deviceName (string) --
Request to query device name.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
isArchived (boolean) --
Source server archived status.
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
firstBoot (string) --
Launched instance first boot.
jobID (string) --
Launched instance Job ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
lastCutover (dict) --
Lifecycle last Cutover.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
initiated (dict) --
Lifecycle last Cutover initiated.
apiCallDateTime (string) --
jobID (string) --
Lifecycle last Cutover initiated by Job ID.
reverted (dict) --
Lifecycle last Cutover reverted.
apiCallDateTime (string) --
Lifecycle last Cutover reverted API call date time.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
initiated (dict) --
Lifecycle last Test initiated.
apiCallDateTime (string) --
Lifecycle last Test initiated API call date and time.
jobID (string) --
Lifecycle last Test initiated Job ID.
reverted (dict) --
Lifecycle last Test reverted.
apiCallDateTime (string) --
Lifecycle last Test reverted API call date and time.
state (string) --
Lifecycle state.
replicationType (string) --
Source server replication type.
sourceProperties (dict) --
Source server properties.
cpus (list) --
Source Server CPUs.
(dict) --
Source server CPU information.
cores (integer) --
The number of CPU cores on the source server.
modelName (string) --
The source server's CPU model name.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
bytes (integer) --
The amount of storage on the disk in bytes.
deviceName (string) --
The disk or device name.
identificationHints (dict) --
Source server identification hints.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmPath (string) --
vCenter VM path identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
lastUpdatedDateTime (string) --
Source server last update date and time.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
macAddress (string) --
Network interface Mac address.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
ramBytes (integer) --
Source server RAM in bytes.
recommendedInstanceType (string) --
Source server recommended instance type.
sourceServerID (string) --
Source server ID.
tags (dict) --
Source server Tags.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
{'fqdnForActionFramework': 'string',
'lifeCycle': {'state': {'PENDING_INSTALLATION'}},
'userProvidedID': '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'
)
string
[REQUIRED]
Request to finalize Cutover by Source Server ID.
dict
Response Syntax
{
'applicationID': 'string',
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'fqdnForActionFramework': 'string',
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
arn (string) --
Source server ARN.
dataReplicationInfo (dict) --
Source server data replication info.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
nextAttemptDateTime (string) --
Request to query next data initiation date and time.
startDateTime (string) --
Request to query data initiation start date and time.
steps (list) --
Request to query data initiation steps.
(dict) --
Data replication initiation step.
name (string) --
Request to query data initiation step name.
status (string) --
Request to query data initiation status.
dataReplicationState (string) --
Request to query the data replication state.
etaDateTime (string) --
Request to query the time when data replication will be complete.
lagDuration (string) --
Request to query data replication lag duration.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
deviceName (string) --
Request to query device name.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
isArchived (boolean) --
Source server archived status.
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
firstBoot (string) --
Launched instance first boot.
jobID (string) --
Launched instance Job ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
lastCutover (dict) --
Lifecycle last Cutover.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
initiated (dict) --
Lifecycle last Cutover initiated.
apiCallDateTime (string) --
jobID (string) --
Lifecycle last Cutover initiated by Job ID.
reverted (dict) --
Lifecycle last Cutover reverted.
apiCallDateTime (string) --
Lifecycle last Cutover reverted API call date time.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
initiated (dict) --
Lifecycle last Test initiated.
apiCallDateTime (string) --
Lifecycle last Test initiated API call date and time.
jobID (string) --
Lifecycle last Test initiated Job ID.
reverted (dict) --
Lifecycle last Test reverted.
apiCallDateTime (string) --
Lifecycle last Test reverted API call date and time.
state (string) --
Lifecycle state.
replicationType (string) --
Source server replication type.
sourceProperties (dict) --
Source server properties.
cpus (list) --
Source Server CPUs.
(dict) --
Source server CPU information.
cores (integer) --
The number of CPU cores on the source server.
modelName (string) --
The source server's CPU model name.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
bytes (integer) --
The amount of storage on the disk in bytes.
deviceName (string) --
The disk or device name.
identificationHints (dict) --
Source server identification hints.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmPath (string) --
vCenter VM path identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
lastUpdatedDateTime (string) --
Source server last update date and time.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
macAddress (string) --
Network interface Mac address.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
ramBytes (integer) --
Source server RAM in bytes.
recommendedInstanceType (string) --
Source server recommended instance type.
sourceServerID (string) --
Source server ID.
tags (dict) --
Source server Tags.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
{'postLaunchActions': {'ssmDocuments': {'externalParameters': {'string': {'dynamicPath': 'string'}}}}}
Lists all LaunchConfigurations available, filtered by Source Server IDs.
See also: AWS API Documentation
Request Syntax
client.get_launch_configuration(
sourceServerID='string'
)
string
[REQUIRED]
Request to get Launch Configuration information by Source Server ID.
dict
Response Syntax
{
'bootMode': 'LEGACY_BIOS'|'UEFI',
'copyPrivateIp': True|False,
'copyTags': True|False,
'ec2LaunchTemplateID': 'string',
'enableMapAutoTagging': True|False,
'launchDisposition': 'STOPPED'|'STARTED',
'licensing': {
'osByol': True|False
},
'mapAutoTaggingMpeID': 'string',
'name': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'sourceServerID': 'string',
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'
}
Response Structure
(dict) --
bootMode (string) --
Launch configuration boot mode.
copyPrivateIp (boolean) --
Copy Private IP during Launch Configuration.
copyTags (boolean) --
Copy Tags during Launch Configuration.
ec2LaunchTemplateID (string) --
Launch configuration EC2 Launch template ID.
enableMapAutoTagging (boolean) --
Enable map auto tagging.
launchDisposition (string) --
Launch disposition for launch configuration.
licensing (dict) --
Launch configuration OS licensing.
osByol (boolean) --
Configure BYOL OS licensing.
mapAutoTaggingMpeID (string) --
Map auto tagging MPE ID.
name (string) --
Launch configuration name.
postLaunchActions (dict) --
Post Launch Actions to executed on the Test or Cutover instance.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
deployment (string) --
Deployment type in which AWS Systems Manager Documents will be executed.
s3LogBucket (string) --
AWS Systems Manager Command's logs S3 log bucket.
s3OutputKeyPrefix (string) --
AWS Systems Manager Command's logs S3 output key prefix.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
sourceServerID (string) --
Launch configuration Source Server ID.
targetInstanceTypeRightSizingMethod (string) --
Launch configuration Target instance type right sizing method.
{'items': {'category': 'DISASTER_RECOVERY | OPERATING_SYSTEM | '
'LICENSE_AND_SUBSCRIPTION | VALIDATION | OBSERVABILITY '
'| SECURITY | NETWORKING | CONFIGURATION | BACKUP | '
'OTHER',
'description': 'string',
'externalParameters': {'string': {'dynamicPath': 'string'}}}}
List source server post migration custom actions.
See also: AWS API Documentation
Request Syntax
client.list_source_server_actions(
filters={
'actionIDs': [
'string',
]
},
maxResults=123,
nextToken='string',
sourceServerID='string'
)
dict
Filters to apply when listing source server post migration custom actions.
actionIDs (list) --
Action IDs to filter source server post migration custom actions by.
(string) --
integer
Maximum amount of items to return when listing source server post migration custom actions.
string
Next token to use when listing source server post migration custom actions.
string
[REQUIRED]
Source server ID.
dict
Response Syntax
{
'items': [
{
'actionID': 'string',
'actionName': 'string',
'active': True|False,
'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER',
'description': 'string',
'documentIdentifier': 'string',
'documentVersion': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'order': 123,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'timeoutSeconds': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
List of source server post migration custom actions.
(dict) --
actionID (string) --
Source server post migration custom action ID.
actionName (string) --
Source server post migration custom action name.
active (boolean) --
Source server post migration custom action active status.
category (string) --
Source server post migration custom action category.
description (string) --
Source server post migration custom action description.
documentIdentifier (string) --
Source server post migration custom action document identifier.
documentVersion (string) --
Source server post migration custom action document version.
externalParameters (dict) --
Source server post migration custom action external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
Source server post migration custom action must succeed for cutover.
order (integer) --
Source server post migration custom action order.
parameters (dict) --
Source server post migration custom action parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
timeoutSeconds (integer) --
Source server post migration custom action timeout in seconds.
nextToken (string) --
Next token returned when listing source server post migration custom actions.
{'items': {'category': 'DISASTER_RECOVERY | OPERATING_SYSTEM | '
'LICENSE_AND_SUBSCRIPTION | VALIDATION | OBSERVABILITY '
'| SECURITY | NETWORKING | CONFIGURATION | BACKUP | '
'OTHER',
'description': 'string',
'externalParameters': {'string': {'dynamicPath': 'string'}}}}
List template post migration custom actions.
See also: AWS API Documentation
Request Syntax
client.list_template_actions(
filters={
'actionIDs': [
'string',
]
},
launchConfigurationTemplateID='string',
maxResults=123,
nextToken='string'
)
dict
Filters to apply when listing template post migration custom actions.
actionIDs (list) --
Action IDs to filter template post migration custom actions by.
(string) --
string
[REQUIRED]
Launch configuration template ID.
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',
'active': True|False,
'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER',
'description': 'string',
'documentIdentifier': 'string',
'documentVersion': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'operatingSystem': 'string',
'order': 123,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'timeoutSeconds': 123
},
],
'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.
active (boolean) --
Template post migration custom action active status.
category (string) --
Template post migration custom action category.
description (string) --
Template post migration custom action description.
documentIdentifier (string) --
Template post migration custom action document identifier.
documentVersion (string) --
Template post migration custom action document version.
externalParameters (dict) --
Template post migration custom action external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
Template post migration custom action must succeed for cutover.
operatingSystem (string) --
Operating system eligible for this template post migration custom action.
order (integer) --
Template post migration custom action order.
parameters (dict) --
Template post migration custom action parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
timeoutSeconds (integer) --
Template post migration custom action timeout in seconds.
nextToken (string) --
Next token returned when listing template post migration custom actions.
{'fqdnForActionFramework': 'string',
'lifeCycle': {'state': {'PENDING_INSTALLATION'}},
'userProvidedID': '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'
)
string
[REQUIRED]
Mark as archived by Source Server ID.
dict
Response Syntax
{
'applicationID': 'string',
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'fqdnForActionFramework': 'string',
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
arn (string) --
Source server ARN.
dataReplicationInfo (dict) --
Source server data replication info.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
nextAttemptDateTime (string) --
Request to query next data initiation date and time.
startDateTime (string) --
Request to query data initiation start date and time.
steps (list) --
Request to query data initiation steps.
(dict) --
Data replication initiation step.
name (string) --
Request to query data initiation step name.
status (string) --
Request to query data initiation status.
dataReplicationState (string) --
Request to query the data replication state.
etaDateTime (string) --
Request to query the time when data replication will be complete.
lagDuration (string) --
Request to query data replication lag duration.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
deviceName (string) --
Request to query device name.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
isArchived (boolean) --
Source server archived status.
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
firstBoot (string) --
Launched instance first boot.
jobID (string) --
Launched instance Job ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
lastCutover (dict) --
Lifecycle last Cutover.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
initiated (dict) --
Lifecycle last Cutover initiated.
apiCallDateTime (string) --
jobID (string) --
Lifecycle last Cutover initiated by Job ID.
reverted (dict) --
Lifecycle last Cutover reverted.
apiCallDateTime (string) --
Lifecycle last Cutover reverted API call date time.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
initiated (dict) --
Lifecycle last Test initiated.
apiCallDateTime (string) --
Lifecycle last Test initiated API call date and time.
jobID (string) --
Lifecycle last Test initiated Job ID.
reverted (dict) --
Lifecycle last Test reverted.
apiCallDateTime (string) --
Lifecycle last Test reverted API call date and time.
state (string) --
Lifecycle state.
replicationType (string) --
Source server replication type.
sourceProperties (dict) --
Source server properties.
cpus (list) --
Source Server CPUs.
(dict) --
Source server CPU information.
cores (integer) --
The number of CPU cores on the source server.
modelName (string) --
The source server's CPU model name.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
bytes (integer) --
The amount of storage on the disk in bytes.
deviceName (string) --
The disk or device name.
identificationHints (dict) --
Source server identification hints.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmPath (string) --
vCenter VM path identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
lastUpdatedDateTime (string) --
Source server last update date and time.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
macAddress (string) --
Network interface Mac address.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
ramBytes (integer) --
Source server RAM in bytes.
recommendedInstanceType (string) --
Source server recommended instance type.
sourceServerID (string) --
Source server ID.
tags (dict) --
Source server Tags.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
{'category': 'DISASTER_RECOVERY | OPERATING_SYSTEM | LICENSE_AND_SUBSCRIPTION '
'| VALIDATION | OBSERVABILITY | SECURITY | NETWORKING | '
'CONFIGURATION | BACKUP | OTHER',
'description': 'string',
'externalParameters': {'string': {'dynamicPath': 'string'}}}
Put source server post migration custom action.
See also: AWS API Documentation
Request Syntax
client.put_source_server_action(
actionID='string',
actionName='string',
active=True|False,
category='DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER',
description='string',
documentIdentifier='string',
documentVersion='string',
externalParameters={
'string': {
'dynamicPath': 'string'
}
},
mustSucceedForCutover=True|False,
order=123,
parameters={
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
sourceServerID='string',
timeoutSeconds=123
)
string
[REQUIRED]
Source server post migration custom action ID.
string
[REQUIRED]
Source server post migration custom action name.
boolean
Source server post migration custom action active status.
string
Source server post migration custom action category.
string
Source server post migration custom action description.
string
[REQUIRED]
Source server post migration custom action document identifier.
string
Source server post migration custom action document version.
dict
Source server post migration custom action external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: dynamicPath.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
boolean
Source server post migration custom action must succeed for cutover.
integer
[REQUIRED]
Source server post migration custom action order.
dict
Source server post migration custom action parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter name.
parameterType (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter type.
string
[REQUIRED]
Source server ID.
integer
Source server post migration custom action timeout in seconds.
dict
Response Syntax
{
'actionID': 'string',
'actionName': 'string',
'active': True|False,
'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER',
'description': 'string',
'documentIdentifier': 'string',
'documentVersion': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'order': 123,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'timeoutSeconds': 123
}
Response Structure
(dict) --
actionID (string) --
Source server post migration custom action ID.
actionName (string) --
Source server post migration custom action name.
active (boolean) --
Source server post migration custom action active status.
category (string) --
Source server post migration custom action category.
description (string) --
Source server post migration custom action description.
documentIdentifier (string) --
Source server post migration custom action document identifier.
documentVersion (string) --
Source server post migration custom action document version.
externalParameters (dict) --
Source server post migration custom action external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
Source server post migration custom action must succeed for cutover.
order (integer) --
Source server post migration custom action order.
parameters (dict) --
Source server post migration custom action parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
timeoutSeconds (integer) --
Source server post migration custom action timeout in seconds.
{'category': 'DISASTER_RECOVERY | OPERATING_SYSTEM | LICENSE_AND_SUBSCRIPTION '
'| VALIDATION | OBSERVABILITY | SECURITY | NETWORKING | '
'CONFIGURATION | BACKUP | OTHER',
'description': 'string',
'externalParameters': {'string': {'dynamicPath': 'string'}}}
Put template post migration custom action.
See also: AWS API Documentation
Request Syntax
client.put_template_action(
actionID='string',
actionName='string',
active=True|False,
category='DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER',
description='string',
documentIdentifier='string',
documentVersion='string',
externalParameters={
'string': {
'dynamicPath': 'string'
}
},
launchConfigurationTemplateID='string',
mustSucceedForCutover=True|False,
operatingSystem='string',
order=123,
parameters={
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
timeoutSeconds=123
)
string
[REQUIRED]
Template post migration custom action ID.
string
[REQUIRED]
Template post migration custom action name.
boolean
Template post migration custom action active status.
string
Template post migration custom action category.
string
Template post migration custom action description.
string
[REQUIRED]
Template post migration custom action document identifier.
string
Template post migration custom action document version.
dict
Template post migration custom action external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: dynamicPath.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
string
[REQUIRED]
Launch configuration template ID.
boolean
Template post migration custom action must succeed for cutover.
string
Operating system eligible for this template post migration custom action.
integer
[REQUIRED]
Template post migration custom action order.
dict
Template post migration custom action parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter name.
parameterType (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter type.
integer
Template post migration custom action timeout in seconds.
dict
Response Syntax
{
'actionID': 'string',
'actionName': 'string',
'active': True|False,
'category': 'DISASTER_RECOVERY'|'OPERATING_SYSTEM'|'LICENSE_AND_SUBSCRIPTION'|'VALIDATION'|'OBSERVABILITY'|'SECURITY'|'NETWORKING'|'CONFIGURATION'|'BACKUP'|'OTHER',
'description': 'string',
'documentIdentifier': 'string',
'documentVersion': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'operatingSystem': 'string',
'order': 123,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'timeoutSeconds': 123
}
Response Structure
(dict) --
actionID (string) --
Template post migration custom action ID.
actionName (string) --
Template post migration custom action name.
active (boolean) --
Template post migration custom action active status.
category (string) --
Template post migration custom action category.
description (string) --
Template post migration custom action description.
documentIdentifier (string) --
Template post migration custom action document identifier.
documentVersion (string) --
Template post migration custom action document version.
externalParameters (dict) --
Template post migration custom action external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
Template post migration custom action must succeed for cutover.
operatingSystem (string) --
Operating system eligible for this template post migration custom action.
order (integer) --
Template post migration custom action order.
parameters (dict) --
Template post migration custom action parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
timeoutSeconds (integer) --
Template post migration custom action timeout in seconds.
{'fqdnForActionFramework': 'string',
'lifeCycle': {'state': {'PENDING_INSTALLATION'}},
'userProvidedID': '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'
)
string
[REQUIRED]
Retry data replication for Source Server ID.
dict
Response Syntax
{
'applicationID': 'string',
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'fqdnForActionFramework': 'string',
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
arn (string) --
Source server ARN.
dataReplicationInfo (dict) --
Source server data replication info.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
nextAttemptDateTime (string) --
Request to query next data initiation date and time.
startDateTime (string) --
Request to query data initiation start date and time.
steps (list) --
Request to query data initiation steps.
(dict) --
Data replication initiation step.
name (string) --
Request to query data initiation step name.
status (string) --
Request to query data initiation status.
dataReplicationState (string) --
Request to query the data replication state.
etaDateTime (string) --
Request to query the time when data replication will be complete.
lagDuration (string) --
Request to query data replication lag duration.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
deviceName (string) --
Request to query device name.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
isArchived (boolean) --
Source server archived status.
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
firstBoot (string) --
Launched instance first boot.
jobID (string) --
Launched instance Job ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
lastCutover (dict) --
Lifecycle last Cutover.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
initiated (dict) --
Lifecycle last Cutover initiated.
apiCallDateTime (string) --
jobID (string) --
Lifecycle last Cutover initiated by Job ID.
reverted (dict) --
Lifecycle last Cutover reverted.
apiCallDateTime (string) --
Lifecycle last Cutover reverted API call date time.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
initiated (dict) --
Lifecycle last Test initiated.
apiCallDateTime (string) --
Lifecycle last Test initiated API call date and time.
jobID (string) --
Lifecycle last Test initiated Job ID.
reverted (dict) --
Lifecycle last Test reverted.
apiCallDateTime (string) --
Lifecycle last Test reverted API call date and time.
state (string) --
Lifecycle state.
replicationType (string) --
Source server replication type.
sourceProperties (dict) --
Source server properties.
cpus (list) --
Source Server CPUs.
(dict) --
Source server CPU information.
cores (integer) --
The number of CPU cores on the source server.
modelName (string) --
The source server's CPU model name.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
bytes (integer) --
The amount of storage on the disk in bytes.
deviceName (string) --
The disk or device name.
identificationHints (dict) --
Source server identification hints.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmPath (string) --
vCenter VM path identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
lastUpdatedDateTime (string) --
Source server last update date and time.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
macAddress (string) --
Network interface Mac address.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
ramBytes (integer) --
Source server RAM in bytes.
recommendedInstanceType (string) --
Source server recommended instance type.
sourceServerID (string) --
Source server ID.
tags (dict) --
Source server Tags.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
{'job': {'participatingServers': {'postLaunchActionsStatus': {'postLaunchActionsLaunchStatusList': {'ssmDocument': {'externalParameters': {'string': {'dynamicPath': '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'
}
)
list
[REQUIRED]
Start Cutover by Source Server IDs.
(string) --
dict
Start Cutover by Tags.
(string) --
(string) --
dict
Response Syntax
{
'job': {
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'postLaunchActionsLaunchStatusList': [
{
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string',
'ssmDocument': {
'actionName': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND'
},
],
'ssmAgentDiscoveryDatetime': 'string'
},
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
}
}
Response Structure
(dict) --
job (dict) --
Start Cutover Job response.
arn (string) --
the ARN of the specific Job.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
initiatedBy (string) --
Job initiated by field.
jobID (string) --
Job ID.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server's launched ec2 instance ID.
postLaunchActionsStatus (dict) --
Participating server's Post Launch Actions Status.
postLaunchActionsLaunchStatusList (list) --
List of Post Launch Action status.
(dict) --
Launch Status of the Job Post Launch Actions.
executionID (string) --
AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions.
executionStatus (string) --
AWS Systems Manager Document's execution status.
failureReason (string) --
AWS Systems Manager Document's failure reason.
ssmDocument (dict) --
AWS Systems Manager's Document of the of the Job Post Launch Actions.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
ssmDocumentType (string) --
AWS Systems Manager Document type.
ssmAgentDiscoveryDatetime (string) --
Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
type (string) --
Job type.
{'fqdnForActionFramework': 'string',
'lifeCycle': {'state': {'PENDING_INSTALLATION'}},
'userProvidedID': 'string'}
Starts replication for SNAPSHOT_SHIPPING agents.
See also: AWS API Documentation
Request Syntax
client.start_replication(
sourceServerID='string'
)
string
[REQUIRED]
ID of source server on which to start replication.
dict
Response Syntax
{
'applicationID': 'string',
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'fqdnForActionFramework': 'string',
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
arn (string) --
Source server ARN.
dataReplicationInfo (dict) --
Source server data replication info.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
nextAttemptDateTime (string) --
Request to query next data initiation date and time.
startDateTime (string) --
Request to query data initiation start date and time.
steps (list) --
Request to query data initiation steps.
(dict) --
Data replication initiation step.
name (string) --
Request to query data initiation step name.
status (string) --
Request to query data initiation status.
dataReplicationState (string) --
Request to query the data replication state.
etaDateTime (string) --
Request to query the time when data replication will be complete.
lagDuration (string) --
Request to query data replication lag duration.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
deviceName (string) --
Request to query device name.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
isArchived (boolean) --
Source server archived status.
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
firstBoot (string) --
Launched instance first boot.
jobID (string) --
Launched instance Job ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
lastCutover (dict) --
Lifecycle last Cutover.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
initiated (dict) --
Lifecycle last Cutover initiated.
apiCallDateTime (string) --
jobID (string) --
Lifecycle last Cutover initiated by Job ID.
reverted (dict) --
Lifecycle last Cutover reverted.
apiCallDateTime (string) --
Lifecycle last Cutover reverted API call date time.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
initiated (dict) --
Lifecycle last Test initiated.
apiCallDateTime (string) --
Lifecycle last Test initiated API call date and time.
jobID (string) --
Lifecycle last Test initiated Job ID.
reverted (dict) --
Lifecycle last Test reverted.
apiCallDateTime (string) --
Lifecycle last Test reverted API call date and time.
state (string) --
Lifecycle state.
replicationType (string) --
Source server replication type.
sourceProperties (dict) --
Source server properties.
cpus (list) --
Source Server CPUs.
(dict) --
Source server CPU information.
cores (integer) --
The number of CPU cores on the source server.
modelName (string) --
The source server's CPU model name.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
bytes (integer) --
The amount of storage on the disk in bytes.
deviceName (string) --
The disk or device name.
identificationHints (dict) --
Source server identification hints.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmPath (string) --
vCenter VM path identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
lastUpdatedDateTime (string) --
Source server last update date and time.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
macAddress (string) --
Network interface Mac address.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
ramBytes (integer) --
Source server RAM in bytes.
recommendedInstanceType (string) --
Source server recommended instance type.
sourceServerID (string) --
Source server ID.
tags (dict) --
Source server Tags.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.
{'job': {'participatingServers': {'postLaunchActionsStatus': {'postLaunchActionsLaunchStatusList': {'ssmDocument': {'externalParameters': {'string': {'dynamicPath': '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'
}
)
list
[REQUIRED]
Start Test for Source Server IDs.
(string) --
dict
Start Test by Tags.
(string) --
(string) --
dict
Response Syntax
{
'job': {
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'postLaunchActionsLaunchStatusList': [
{
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string',
'ssmDocument': {
'actionName': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND'
},
],
'ssmAgentDiscoveryDatetime': 'string'
},
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
}
}
Response Structure
(dict) --
job (dict) --
Start Test Job response.
arn (string) --
the ARN of the specific Job.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
initiatedBy (string) --
Job initiated by field.
jobID (string) --
Job ID.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server's launched ec2 instance ID.
postLaunchActionsStatus (dict) --
Participating server's Post Launch Actions Status.
postLaunchActionsLaunchStatusList (list) --
List of Post Launch Action status.
(dict) --
Launch Status of the Job Post Launch Actions.
executionID (string) --
AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions.
executionStatus (string) --
AWS Systems Manager Document's execution status.
failureReason (string) --
AWS Systems Manager Document's failure reason.
ssmDocument (dict) --
AWS Systems Manager's Document of the of the Job Post Launch Actions.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
ssmDocumentType (string) --
AWS Systems Manager Document type.
ssmAgentDiscoveryDatetime (string) --
Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
type (string) --
Job type.
{'job': {'participatingServers': {'postLaunchActionsStatus': {'postLaunchActionsLaunchStatusList': {'ssmDocument': {'externalParameters': {'string': {'dynamicPath': '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'
}
)
list
[REQUIRED]
Terminate Target instance by Source Server IDs.
(string) --
dict
Terminate Target instance by Tags.
(string) --
(string) --
dict
Response Syntax
{
'job': {
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'postLaunchActionsLaunchStatusList': [
{
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string',
'ssmDocument': {
'actionName': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND'
},
],
'ssmAgentDiscoveryDatetime': 'string'
},
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
}
}
Response Structure
(dict) --
job (dict) --
Terminate Target instance Job response.
arn (string) --
the ARN of the specific Job.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
initiatedBy (string) --
Job initiated by field.
jobID (string) --
Job ID.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server's launched ec2 instance ID.
postLaunchActionsStatus (dict) --
Participating server's Post Launch Actions Status.
postLaunchActionsLaunchStatusList (list) --
List of Post Launch Action status.
(dict) --
Launch Status of the Job Post Launch Actions.
executionID (string) --
AWS Systems Manager Document's execution ID of the of the Job Post Launch Actions.
executionStatus (string) --
AWS Systems Manager Document's execution status.
failureReason (string) --
AWS Systems Manager Document's failure reason.
ssmDocument (dict) --
AWS Systems Manager's Document of the of the Job Post Launch Actions.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
ssmDocumentType (string) --
AWS Systems Manager Document type.
ssmAgentDiscoveryDatetime (string) --
Time where the AWS Systems Manager was detected as running on the Test or Cutover instance.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
type (string) --
Job type.
{'postLaunchActions': {'ssmDocuments': {'externalParameters': {'string': {'dynamicPath': 'string'}}}}}
Updates multiple LaunchConfigurations by Source Server ID.
See also: AWS API Documentation
Request Syntax
client.update_launch_configuration(
bootMode='LEGACY_BIOS'|'UEFI',
copyPrivateIp=True|False,
copyTags=True|False,
enableMapAutoTagging=True|False,
launchDisposition='STOPPED'|'STARTED',
licensing={
'osByol': True|False
},
mapAutoTaggingMpeID='string',
name='string',
postLaunchActions={
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
sourceServerID='string',
targetInstanceTypeRightSizingMethod='NONE'|'BASIC'
)
string
Update Launch configuration boot mode request.
boolean
Update Launch configuration copy Private IP request.
boolean
Update Launch configuration copy Tags request.
boolean
Enable map auto tagging.
string
Update Launch configuration launch disposition request.
dict
Update Launch configuration licensing request.
osByol (boolean) --
Configure BYOL OS licensing.
string
Launch configuration map auto tagging MPE ID.
string
Update Launch configuration name request.
dict
Post Launch Actions to executed on the Test or Cutover instance.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
deployment (string) --
Deployment type in which AWS Systems Manager Documents will be executed.
s3LogBucket (string) --
AWS Systems Manager Command's logs S3 log bucket.
s3OutputKeyPrefix (string) --
AWS Systems Manager Command's logs S3 output key prefix.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) -- [REQUIRED]
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: dynamicPath.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter name.
parameterType (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) -- [REQUIRED]
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
string
[REQUIRED]
Update Launch configuration by Source Server ID request.
string
Update Launch configuration Target instance right sizing request.
dict
Response Syntax
{
'bootMode': 'LEGACY_BIOS'|'UEFI',
'copyPrivateIp': True|False,
'copyTags': True|False,
'ec2LaunchTemplateID': 'string',
'enableMapAutoTagging': True|False,
'launchDisposition': 'STOPPED'|'STARTED',
'licensing': {
'osByol': True|False
},
'mapAutoTaggingMpeID': 'string',
'name': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'sourceServerID': 'string',
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'
}
Response Structure
(dict) --
bootMode (string) --
Launch configuration boot mode.
copyPrivateIp (boolean) --
Copy Private IP during Launch Configuration.
copyTags (boolean) --
Copy Tags during Launch Configuration.
ec2LaunchTemplateID (string) --
Launch configuration EC2 Launch template ID.
enableMapAutoTagging (boolean) --
Enable map auto tagging.
launchDisposition (string) --
Launch disposition for launch configuration.
licensing (dict) --
Launch configuration OS licensing.
osByol (boolean) --
Configure BYOL OS licensing.
mapAutoTaggingMpeID (string) --
Map auto tagging MPE ID.
name (string) --
Launch configuration name.
postLaunchActions (dict) --
Post Launch Actions to executed on the Test or Cutover instance.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
deployment (string) --
Deployment type in which AWS Systems Manager Documents will be executed.
s3LogBucket (string) --
AWS Systems Manager Command's logs S3 log bucket.
s3OutputKeyPrefix (string) --
AWS Systems Manager Command's logs S3 output key prefix.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
sourceServerID (string) --
Launch configuration Source Server ID.
targetInstanceTypeRightSizingMethod (string) --
Launch configuration Target instance type right sizing method.
{'postLaunchActions': {'ssmDocuments': {'externalParameters': {'string': {'dynamicPath': 'string'}}}}}
Updates an existing Launch Configuration Template by ID.
See also: AWS API Documentation
Request Syntax
client.update_launch_configuration_template(
associatePublicIpAddress=True|False,
bootMode='LEGACY_BIOS'|'UEFI',
copyPrivateIp=True|False,
copyTags=True|False,
enableMapAutoTagging=True|False,
largeVolumeConf={
'iops': 123,
'throughput': 123,
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard'
},
launchConfigurationTemplateID='string',
launchDisposition='STOPPED'|'STARTED',
licensing={
'osByol': True|False
},
mapAutoTaggingMpeID='string',
postLaunchActions={
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
smallVolumeConf={
'iops': 123,
'throughput': 123,
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard'
},
smallVolumeMaxSize=123,
targetInstanceTypeRightSizingMethod='NONE'|'BASIC'
)
boolean
Associate public Ip address.
string
Launch configuration template boot mode.
boolean
Copy private Ip.
boolean
Copy tags.
boolean
Enable map auto tagging.
dict
Large volume config.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
volumeType (string) --
Launch template disk volume type configuration.
string
[REQUIRED]
Launch Configuration Template ID.
string
Launch disposition.
dict
Configure Licensing.
osByol (boolean) --
Configure BYOL OS licensing.
string
Launch configuration template map auto tagging MPE ID.
dict
Post Launch Action to execute on the Test or Cutover instance.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
deployment (string) --
Deployment type in which AWS Systems Manager Documents will be executed.
s3LogBucket (string) --
AWS Systems Manager Command's logs S3 log bucket.
s3OutputKeyPrefix (string) --
AWS Systems Manager Command's logs S3 output key prefix.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) -- [REQUIRED]
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: dynamicPath.
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter name.
parameterType (string) -- [REQUIRED]
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) -- [REQUIRED]
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
dict
Small volume config.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
volumeType (string) --
Launch template disk volume type configuration.
integer
Small volume maximum size.
string
Target instance type right-sizing method.
dict
Response Syntax
{
'arn': 'string',
'associatePublicIpAddress': True|False,
'bootMode': 'LEGACY_BIOS'|'UEFI',
'copyPrivateIp': True|False,
'copyTags': True|False,
'ec2LaunchTemplateID': 'string',
'enableMapAutoTagging': True|False,
'largeVolumeConf': {
'iops': 123,
'throughput': 123,
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard'
},
'launchConfigurationTemplateID': 'string',
'launchDisposition': 'STOPPED'|'STARTED',
'licensing': {
'osByol': True|False
},
'mapAutoTaggingMpeID': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'externalParameters': {
'string': {
'dynamicPath': 'string'
}
},
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'smallVolumeConf': {
'iops': 123,
'throughput': 123,
'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard'
},
'smallVolumeMaxSize': 123,
'tags': {
'string': 'string'
},
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'
}
Response Structure
(dict) --
arn (string) --
ARN of the Launch Configuration Template.
associatePublicIpAddress (boolean) --
Associate public Ip address.
bootMode (string) --
Launch configuration template boot mode.
copyPrivateIp (boolean) --
Copy private Ip.
copyTags (boolean) --
Copy tags.
ec2LaunchTemplateID (string) --
EC2 launch template ID.
enableMapAutoTagging (boolean) --
Enable map auto tagging.
largeVolumeConf (dict) --
Large volume config.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
volumeType (string) --
Launch template disk volume type configuration.
launchConfigurationTemplateID (string) --
ID of the Launch Configuration Template.
launchDisposition (string) --
Launch disposition.
licensing (dict) --
Configure Licensing.
osByol (boolean) --
Configure BYOL OS licensing.
mapAutoTaggingMpeID (string) --
Launch configuration template map auto tagging MPE ID.
postLaunchActions (dict) --
Post Launch Actions of the Launch Configuration Template.
cloudWatchLogGroupName (string) --
AWS Systems Manager Command's CloudWatch log group name.
deployment (string) --
Deployment type in which AWS Systems Manager Documents will be executed.
s3LogBucket (string) --
AWS Systems Manager Command's logs S3 log bucket.
s3OutputKeyPrefix (string) --
AWS Systems Manager Command's logs S3 output key prefix.
ssmDocuments (list) --
AWS Systems Manager Documents.
(dict) --
AWS Systems Manager Document.
actionName (string) --
User-friendly name for the AWS Systems Manager Document.
externalParameters (dict) --
AWS Systems Manager Document external parameters.
(string) --
(dict) --
AWS Systems Manager Document external parameter.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
dynamicPath (string) --
AWS Systems Manager Document external parameters dynamic path.
mustSucceedForCutover (boolean) --
If true, Cutover will not be enabled if the document has failed.
parameters (dict) --
AWS Systems Manager Document parameters.
(string) --
(list) --
(dict) --
AWS Systems Manager Parameter Store parameter.
parameterName (string) --
AWS Systems Manager Parameter Store parameter name.
parameterType (string) --
AWS Systems Manager Parameter Store parameter type.
ssmDocumentName (string) --
AWS Systems Manager Document name or full ARN.
timeoutSeconds (integer) --
AWS Systems Manager Document timeout seconds.
smallVolumeConf (dict) --
Small volume config.
iops (integer) --
Launch template disk iops configuration.
throughput (integer) --
Launch template disk throughput configuration.
volumeType (string) --
Launch template disk volume type configuration.
smallVolumeMaxSize (integer) --
Small volume maximum size.
tags (dict) --
Tags of the Launch Configuration Template.
(string) --
(string) --
targetInstanceTypeRightSizingMethod (string) --
Target instance type right-sizing method.
{'fqdnForActionFramework': 'string',
'lifeCycle': {'state': {'PENDING_INSTALLATION'}},
'userProvidedID': 'string'}
Allows you to change between the AGENT_BASED replication type and the SNAPSHOT_SHIPPING replication type.
See also: AWS API Documentation
Request Syntax
client.update_source_server_replication_type(
replicationType='AGENT_BASED'|'SNAPSHOT_SHIPPING',
sourceServerID='string'
)
string
[REQUIRED]
Replication type to which to update source server.
string
[REQUIRED]
ID of source server on which to update replication type.
dict
Response Syntax
{
'applicationID': 'string',
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER'|'UNSUPPORTED_VM_CONFIGURATION'|'LAST_SNAPSHOT_JOB_FAILED',
'rawError': 'string'
},
'dataReplicationInitiation': {
'nextAttemptDateTime': 'string',
'startDateTime': 'string',
'steps': [
{
'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED'|'PENDING_SNAPSHOT_SHIPPING'|'SHIPPING_SNAPSHOT',
'etaDateTime': 'string',
'lagDuration': 'string',
'lastSnapshotDateTime': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'fqdnForActionFramework': 'string',
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'|'PENDING_INSTALLATION'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'userProvidedID': 'string',
'vcenterClientID': 'string'
}
Response Structure
(dict) --
applicationID (string) --
Source server application ID.
arn (string) --
Source server ARN.
dataReplicationInfo (dict) --
Source server data replication info.
dataReplicationError (dict) --
Error in obtaining data replication info.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Request to query whether data replication has been initiated.
nextAttemptDateTime (string) --
Request to query next data initiation date and time.
startDateTime (string) --
Request to query data initiation start date and time.
steps (list) --
Request to query data initiation steps.
(dict) --
Data replication initiation step.
name (string) --
Request to query data initiation step name.
status (string) --
Request to query data initiation status.
dataReplicationState (string) --
Request to query the data replication state.
etaDateTime (string) --
Request to query the time when data replication will be complete.
lagDuration (string) --
Request to query data replication lag duration.
lastSnapshotDateTime (string) --
Request to query data replication last snapshot time.
replicatedDisks (list) --
Request to query disks replicated.
(dict) --
Request to query disks replicated.
backloggedStorageBytes (integer) --
Request to query data replication backlog size in bytes.
deviceName (string) --
Request to query device name.
replicatedStorageBytes (integer) --
Request to query amount of data replicated in bytes.
rescannedStorageBytes (integer) --
Request to query amount of data rescanned in bytes.
totalStorageBytes (integer) --
Request to query total amount of data replicated in bytes.
fqdnForActionFramework (string) --
Source server fqdn for action framework.
isArchived (boolean) --
Source server archived status.
launchedInstance (dict) --
Source server launched instance.
ec2InstanceID (string) --
Launched instance EC2 ID.
firstBoot (string) --
Launched instance first boot.
jobID (string) --
Launched instance Job ID.
lifeCycle (dict) --
Source server lifecycle state.
addedToServiceDateTime (string) --
Lifecycle added to service data and time.
elapsedReplicationDuration (string) --
Lifecycle elapsed time and duration.
firstByteDateTime (string) --
Lifecycle replication initiation date and time.
lastCutover (dict) --
Lifecycle last Cutover.
finalized (dict) --
Lifecycle Cutover finalized date and time.
apiCallDateTime (string) --
Lifecycle Cutover finalized date and time.
initiated (dict) --
Lifecycle last Cutover initiated.
apiCallDateTime (string) --
jobID (string) --
Lifecycle last Cutover initiated by Job ID.
reverted (dict) --
Lifecycle last Cutover reverted.
apiCallDateTime (string) --
Lifecycle last Cutover reverted API call date time.
lastSeenByServiceDateTime (string) --
Lifecycle last seen date and time.
lastTest (dict) --
Lifecycle last Test.
finalized (dict) --
Lifecycle last Test finalized.
apiCallDateTime (string) --
Lifecycle Test failed API call date and time.
initiated (dict) --
Lifecycle last Test initiated.
apiCallDateTime (string) --
Lifecycle last Test initiated API call date and time.
jobID (string) --
Lifecycle last Test initiated Job ID.
reverted (dict) --
Lifecycle last Test reverted.
apiCallDateTime (string) --
Lifecycle last Test reverted API call date and time.
state (string) --
Lifecycle state.
replicationType (string) --
Source server replication type.
sourceProperties (dict) --
Source server properties.
cpus (list) --
Source Server CPUs.
(dict) --
Source server CPU information.
cores (integer) --
The number of CPU cores on the source server.
modelName (string) --
The source server's CPU model name.
disks (list) --
Source Server disks.
(dict) --
The disk identifier.
bytes (integer) --
The amount of storage on the disk in bytes.
deviceName (string) --
The disk or device name.
identificationHints (dict) --
Source server identification hints.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
FQDN address identification hint.
hostname (string) --
Hostname identification hint.
vmPath (string) --
vCenter VM path identification hint.
vmWareUuid (string) --
vmWare UUID identification hint.
lastUpdatedDateTime (string) --
Source server last update date and time.
networkInterfaces (list) --
Source server network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Network interface primary IP.
macAddress (string) --
Network interface Mac address.
os (dict) --
Source server OS.
fullString (string) --
OS full string.
ramBytes (integer) --
Source server RAM in bytes.
recommendedInstanceType (string) --
Source server recommended instance type.
sourceServerID (string) --
Source server ID.
tags (dict) --
Source server Tags.
(string) --
(string) --
userProvidedID (string) --
Source server user provided ID.
vcenterClientID (string) --
Source server vCenter client id.