2022/11/28 - Application Migration Service - 22 new 13 updated api methods
Changes This release adds support for Application and Wave management. We also now support custom post-launch actions.
Remove template post migration custom action.
See also: AWS API Documentation
Request Syntax
client.remove_template_action(
actionID='string',
launchConfigurationTemplateID='string'
)
string
[REQUIRED]
Template post migration custom action ID to remove.
string
[REQUIRED]
Launch configuration template ID of the post migration custom action to remove.
dict
Response Syntax
{}
Response Structure
(dict) --
Unarchive application.
See also: AWS API Documentation
Request Syntax
client.unarchive_application(
applicationID='string'
)
string
[REQUIRED]
Application ID.
dict
Response Syntax
{
'applicationAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'totalSourceServers': 123
},
'applicationID': 'string',
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveID': 'string'
}
Response Structure
(dict) --
applicationAggregatedStatus (dict) --
Application aggregated status.
healthStatus (string) --
Application aggregated status health status.
lastUpdateDateTime (string) --
Application aggregated status last update dateTime.
progressStatus (string) --
Application aggregated status progress status.
totalSourceServers (integer) --
Application aggregated status total source servers amount.
applicationID (string) --
Application ID.
arn (string) --
Application ARN.
creationDateTime (string) --
Application creation dateTime.
description (string) --
Application description.
isArchived (boolean) --
Application archival status.
lastModifiedDateTime (string) --
Application last modified dateTime.
name (string) --
Application name.
tags (dict) --
Application tags.
(string) --
(string) --
waveID (string) --
Application wave ID.
Unarchive wave.
See also: AWS API Documentation
Request Syntax
client.unarchive_wave(
waveID='string'
)
string
[REQUIRED]
Wave ID.
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'replicationStartedDateTime': 'string',
'totalApplications': 123
},
'waveID': 'string'
}
Response Structure
(dict) --
arn (string) --
Wave ARN.
creationDateTime (string) --
Wave creation dateTime.
description (string) --
Wave description.
isArchived (boolean) --
Wave archival status.
lastModifiedDateTime (string) --
Wave last modified dateTime.
name (string) --
Wave name.
tags (dict) --
Wave tags.
(string) --
(string) --
waveAggregatedStatus (dict) --
Wave aggregated status.
healthStatus (string) --
Wave aggregated status health status.
lastUpdateDateTime (string) --
Wave aggregated status last update dateTime.
progressStatus (string) --
Wave aggregated status progress status.
replicationStartedDateTime (string) --
DateTime marking when the first source server in the wave started replication.
totalApplications (integer) --
Wave aggregated status total applications amount.
waveID (string) --
Wave ID.
Delete wave.
See also: AWS API Documentation
Request Syntax
client.delete_wave(
waveID='string'
)
string
[REQUIRED]
Wave ID.
dict
Response Syntax
{}
Response Structure
(dict) --
Create application.
See also: AWS API Documentation
Request Syntax
client.create_application(
description='string',
name='string',
tags={
'string': 'string'
}
)
string
Application description.
string
[REQUIRED]
Application name.
dict
Application tags.
(string) --
(string) --
dict
Response Syntax
{
'applicationAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'totalSourceServers': 123
},
'applicationID': 'string',
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveID': 'string'
}
Response Structure
(dict) --
applicationAggregatedStatus (dict) --
Application aggregated status.
healthStatus (string) --
Application aggregated status health status.
lastUpdateDateTime (string) --
Application aggregated status last update dateTime.
progressStatus (string) --
Application aggregated status progress status.
totalSourceServers (integer) --
Application aggregated status total source servers amount.
applicationID (string) --
Application ID.
arn (string) --
Application ARN.
creationDateTime (string) --
Application creation dateTime.
description (string) --
Application description.
isArchived (boolean) --
Application archival status.
lastModifiedDateTime (string) --
Application last modified dateTime.
name (string) --
Application name.
tags (dict) --
Application tags.
(string) --
(string) --
waveID (string) --
Application wave ID.
Archive application.
See also: AWS API Documentation
Request Syntax
client.archive_application(
applicationID='string'
)
string
[REQUIRED]
Application ID.
dict
Response Syntax
{
'applicationAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'totalSourceServers': 123
},
'applicationID': 'string',
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveID': 'string'
}
Response Structure
(dict) --
applicationAggregatedStatus (dict) --
Application aggregated status.
healthStatus (string) --
Application aggregated status health status.
lastUpdateDateTime (string) --
Application aggregated status last update dateTime.
progressStatus (string) --
Application aggregated status progress status.
totalSourceServers (integer) --
Application aggregated status total source servers amount.
applicationID (string) --
Application ID.
arn (string) --
Application ARN.
creationDateTime (string) --
Application creation dateTime.
description (string) --
Application description.
isArchived (boolean) --
Application archival status.
lastModifiedDateTime (string) --
Application last modified dateTime.
name (string) --
Application name.
tags (dict) --
Application tags.
(string) --
(string) --
waveID (string) --
Application wave ID.
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,
'documentIdentifier': 'string',
'documentVersion': '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.
documentIdentifier (string) --
Template post migration custom action document identifier.
documentVersion (string) --
Template post migration custom action document version.
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.
Disassociate source servers from application.
See also: AWS API Documentation
Request Syntax
client.disassociate_source_servers(
applicationID='string',
sourceServerIDs=[
'string',
]
)
string
[REQUIRED]
Application ID.
list
[REQUIRED]
Source server IDs list.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves all applications or multiple applications by ID.
See also: AWS API Documentation
Request Syntax
client.list_applications(
filters={
'applicationIDs': [
'string',
],
'isArchived': True|False,
'waveIDs': [
'string',
]
},
maxResults=123,
nextToken='string'
)
dict
Applications list filters.
applicationIDs (list) --
Filter applications list by application ID.
(string) --
isArchived (boolean) --
Filter applications list by archival status.
waveIDs (list) --
Filter applications list by wave ID.
(string) --
integer
Maximum results to return when listing applications.
string
Request next token.
dict
Response Syntax
{
'items': [
{
'applicationAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'totalSourceServers': 123
},
'applicationID': 'string',
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveID': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Applications list.
(dict) --
applicationAggregatedStatus (dict) --
Application aggregated status.
healthStatus (string) --
Application aggregated status health status.
lastUpdateDateTime (string) --
Application aggregated status last update dateTime.
progressStatus (string) --
Application aggregated status progress status.
totalSourceServers (integer) --
Application aggregated status total source servers amount.
applicationID (string) --
Application ID.
arn (string) --
Application ARN.
creationDateTime (string) --
Application creation dateTime.
description (string) --
Application description.
isArchived (boolean) --
Application archival status.
lastModifiedDateTime (string) --
Application last modified dateTime.
name (string) --
Application name.
tags (dict) --
Application tags.
(string) --
(string) --
waveID (string) --
Application wave ID.
nextToken (string) --
Response next token.
Archive wave.
See also: AWS API Documentation
Request Syntax
client.archive_wave(
waveID='string'
)
string
[REQUIRED]
Wave ID.
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'replicationStartedDateTime': 'string',
'totalApplications': 123
},
'waveID': 'string'
}
Response Structure
(dict) --
arn (string) --
Wave ARN.
creationDateTime (string) --
Wave creation dateTime.
description (string) --
Wave description.
isArchived (boolean) --
Wave archival status.
lastModifiedDateTime (string) --
Wave last modified dateTime.
name (string) --
Wave name.
tags (dict) --
Wave tags.
(string) --
(string) --
waveAggregatedStatus (dict) --
Wave aggregated status.
healthStatus (string) --
Wave aggregated status health status.
lastUpdateDateTime (string) --
Wave aggregated status last update dateTime.
progressStatus (string) --
Wave aggregated status progress status.
replicationStartedDateTime (string) --
DateTime marking when the first source server in the wave started replication.
totalApplications (integer) --
Wave aggregated status total applications amount.
waveID (string) --
Wave ID.
Update wave.
See also: AWS API Documentation
Request Syntax
client.update_wave(
description='string',
name='string',
waveID='string'
)
string
Wave description.
string
Wave name.
string
[REQUIRED]
Wave ID.
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'replicationStartedDateTime': 'string',
'totalApplications': 123
},
'waveID': 'string'
}
Response Structure
(dict) --
arn (string) --
Wave ARN.
creationDateTime (string) --
Wave creation dateTime.
description (string) --
Wave description.
isArchived (boolean) --
Wave archival status.
lastModifiedDateTime (string) --
Wave last modified dateTime.
name (string) --
Wave name.
tags (dict) --
Wave tags.
(string) --
(string) --
waveAggregatedStatus (dict) --
Wave aggregated status.
healthStatus (string) --
Wave aggregated status health status.
lastUpdateDateTime (string) --
Wave aggregated status last update dateTime.
progressStatus (string) --
Wave aggregated status progress status.
replicationStartedDateTime (string) --
DateTime marking when the first source server in the wave started replication.
totalApplications (integer) --
Wave aggregated status total applications amount.
waveID (string) --
Wave ID.
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,
documentIdentifier='string',
documentVersion='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
[REQUIRED]
Source server post migration custom action document identifier.
string
Source server post migration custom action document version.
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,
'documentIdentifier': 'string',
'documentVersion': '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.
documentIdentifier (string) --
Source server post migration custom action document identifier.
documentVersion (string) --
Source server post migration custom action document version.
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.
Associate applications to wave.
See also: AWS API Documentation
Request Syntax
client.associate_applications(
applicationIDs=[
'string',
],
waveID='string'
)
list
[REQUIRED]
Application IDs list.
(string) --
string
[REQUIRED]
Wave ID.
dict
Response Syntax
{}
Response Structure
(dict) --
Delete application.
See also: AWS API Documentation
Request Syntax
client.delete_application(
applicationID='string'
)
string
[REQUIRED]
Application ID.
dict
Response Syntax
{}
Response Structure
(dict) --
Disassociate applications from wave.
See also: AWS API Documentation
Request Syntax
client.disassociate_applications(
applicationIDs=[
'string',
],
waveID='string'
)
list
[REQUIRED]
Application IDs list.
(string) --
string
[REQUIRED]
Wave ID.
dict
Response Syntax
{}
Response Structure
(dict) --
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,
'documentIdentifier': 'string',
'documentVersion': '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.
documentIdentifier (string) --
Source server post migration custom action document identifier.
documentVersion (string) --
Source server post migration custom action document version.
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.
Retrieves all waves or multiple waves by ID.
See also: AWS API Documentation
Request Syntax
client.list_waves(
filters={
'isArchived': True|False,
'waveIDs': [
'string',
]
},
maxResults=123,
nextToken='string'
)
dict
Waves list filters.
isArchived (boolean) --
Filter waves list by archival status.
waveIDs (list) --
Filter waves list by wave ID.
(string) --
integer
Maximum results to return when listing waves.
string
Request next token.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'replicationStartedDateTime': 'string',
'totalApplications': 123
},
'waveID': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Waves list.
(dict) --
arn (string) --
Wave ARN.
creationDateTime (string) --
Wave creation dateTime.
description (string) --
Wave description.
isArchived (boolean) --
Wave archival status.
lastModifiedDateTime (string) --
Wave last modified dateTime.
name (string) --
Wave name.
tags (dict) --
Wave tags.
(string) --
(string) --
waveAggregatedStatus (dict) --
Wave aggregated status.
healthStatus (string) --
Wave aggregated status health status.
lastUpdateDateTime (string) --
Wave aggregated status last update dateTime.
progressStatus (string) --
Wave aggregated status progress status.
replicationStartedDateTime (string) --
DateTime marking when the first source server in the wave started replication.
totalApplications (integer) --
Wave aggregated status total applications amount.
waveID (string) --
Wave ID.
nextToken (string) --
Response next token.
Create wave.
See also: AWS API Documentation
Request Syntax
client.create_wave(
description='string',
name='string',
tags={
'string': 'string'
}
)
string
Wave description.
string
[REQUIRED]
Wave name.
dict
Wave tags.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'replicationStartedDateTime': 'string',
'totalApplications': 123
},
'waveID': 'string'
}
Response Structure
(dict) --
arn (string) --
Wave ARN.
creationDateTime (string) --
Wave creation dateTime.
description (string) --
Wave description.
isArchived (boolean) --
Wave archival status.
lastModifiedDateTime (string) --
Wave last modified dateTime.
name (string) --
Wave name.
tags (dict) --
Wave tags.
(string) --
(string) --
waveAggregatedStatus (dict) --
Wave aggregated status.
healthStatus (string) --
Wave aggregated status health status.
lastUpdateDateTime (string) --
Wave aggregated status last update dateTime.
progressStatus (string) --
Wave aggregated status progress status.
replicationStartedDateTime (string) --
DateTime marking when the first source server in the wave started replication.
totalApplications (integer) --
Wave aggregated status total applications amount.
waveID (string) --
Wave ID.
Remove source server post migration custom action.
See also: AWS API Documentation
Request Syntax
client.remove_source_server_action(
actionID='string',
sourceServerID='string'
)
string
[REQUIRED]
Source server post migration custom action ID to remove.
string
[REQUIRED]
Source server ID of the post migration custom action to remove.
dict
Response Syntax
{}
Response Structure
(dict) --
Put template post migration custom action.
See also: AWS API Documentation
Request Syntax
client.put_template_action(
actionID='string',
actionName='string',
active=True|False,
documentIdentifier='string',
documentVersion='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
[REQUIRED]
Template post migration custom action document identifier.
string
Template post migration custom action document version.
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,
'documentIdentifier': 'string',
'documentVersion': '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.
documentIdentifier (string) --
Template post migration custom action document identifier.
documentVersion (string) --
Template post migration custom action document version.
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.
Update application.
See also: AWS API Documentation
Request Syntax
client.update_application(
applicationID='string',
description='string',
name='string'
)
string
[REQUIRED]
Application ID.
string
Application description.
string
Application name.
dict
Response Syntax
{
'applicationAggregatedStatus': {
'healthStatus': 'HEALTHY'|'LAGGING'|'ERROR',
'lastUpdateDateTime': 'string',
'progressStatus': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED',
'totalSourceServers': 123
},
'applicationID': 'string',
'arn': 'string',
'creationDateTime': 'string',
'description': 'string',
'isArchived': True|False,
'lastModifiedDateTime': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'waveID': 'string'
}
Response Structure
(dict) --
applicationAggregatedStatus (dict) --
Application aggregated status.
healthStatus (string) --
Application aggregated status health status.
lastUpdateDateTime (string) --
Application aggregated status last update dateTime.
progressStatus (string) --
Application aggregated status progress status.
totalSourceServers (integer) --
Application aggregated status total source servers amount.
applicationID (string) --
Application ID.
arn (string) --
Application ARN.
creationDateTime (string) --
Application creation dateTime.
description (string) --
Application description.
isArchived (boolean) --
Application archival status.
lastModifiedDateTime (string) --
Application last modified dateTime.
name (string) --
Application name.
tags (dict) --
Application tags.
(string) --
(string) --
waveID (string) --
Application wave ID.
Associate source servers to application.
See also: AWS API Documentation
Request Syntax
client.associate_source_servers(
applicationID='string',
sourceServerIDs=[
'string',
]
)
string
[REQUIRED]
Application ID.
list
[REQUIRED]
Source server IDs list.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
{'applicationID': '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
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
}
Response Structure
(dict) --
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.
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) --
vcenterClientID (string) --
Source server vCenter client id.
{'associatePublicIpAddress': 'boolean',
'bootMode': 'LEGACY_BIOS | UEFI',
'copyPrivateIp': 'boolean',
'copyTags': 'boolean',
'enableMapAutoTagging': 'boolean',
'largeVolumeConf': {'iops': 'long',
'throughput': 'long',
'volumeType': 'io1 | io2 | gp3 | gp2 | st1 | sc1 | '
'standard'},
'launchDisposition': 'STOPPED | STARTED',
'licensing': {'osByol': 'boolean'},
'mapAutoTaggingMpeID': 'string',
'postLaunchActions': {'deployment': {'TEST_ONLY'}},
'smallVolumeConf': {'iops': 'long',
'throughput': 'long',
'volumeType': 'io1 | io2 | gp3 | gp2 | st1 | sc1 | '
'standard'},
'smallVolumeMaxSize': 'long',
'targetInstanceTypeRightSizingMethod': 'NONE | BASIC'}
Response {'associatePublicIpAddress': 'boolean',
'bootMode': 'LEGACY_BIOS | UEFI',
'copyPrivateIp': 'boolean',
'copyTags': 'boolean',
'ec2LaunchTemplateID': 'string',
'enableMapAutoTagging': 'boolean',
'largeVolumeConf': {'iops': 'long',
'throughput': 'long',
'volumeType': 'io1 | io2 | gp3 | gp2 | st1 | sc1 | '
'standard'},
'launchDisposition': 'STOPPED | STARTED',
'licensing': {'osByol': 'boolean'},
'mapAutoTaggingMpeID': 'string',
'postLaunchActions': {'deployment': {'TEST_ONLY'}},
'smallVolumeConf': {'iops': 'long',
'throughput': 'long',
'volumeType': 'io1 | io2 | gp3 | gp2 | st1 | sc1 | '
'standard'},
'smallVolumeMaxSize': 'long',
'targetInstanceTypeRightSizingMethod': 'NONE | BASIC'}
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',
'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.
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',
'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.
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': {'associatePublicIpAddress': 'boolean',
'bootMode': 'LEGACY_BIOS | UEFI',
'copyPrivateIp': 'boolean',
'copyTags': 'boolean',
'ec2LaunchTemplateID': 'string',
'enableMapAutoTagging': 'boolean',
'largeVolumeConf': {'iops': 'long',
'throughput': 'long',
'volumeType': 'io1 | io2 | gp3 | gp2 | st1 | '
'sc1 | standard'},
'launchDisposition': 'STOPPED | STARTED',
'licensing': {'osByol': 'boolean'},
'mapAutoTaggingMpeID': 'string',
'postLaunchActions': {'deployment': {'TEST_ONLY'}},
'smallVolumeConf': {'iops': 'long',
'throughput': 'long',
'volumeType': 'io1 | io2 | gp3 | gp2 | st1 | '
'sc1 | standard'},
'smallVolumeMaxSize': 'long',
'targetInstanceTypeRightSizingMethod': 'NONE | BASIC'}}
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',
'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.
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': {'applicationIDs': ['string']}}
Response {'items': {'applicationID': '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',
],
'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
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to filter Source Servers list by item.
(dict) --
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.
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) --
vcenterClientID (string) --
Source server vCenter client id.
nextToken (string) --
Request to filter Source Servers next token.
{'applicationID': '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
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
}
Response Structure
(dict) --
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.
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) --
vcenterClientID (string) --
Source server vCenter client id.
{'applicationID': '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
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
}
Response Structure
(dict) --
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.
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) --
vcenterClientID (string) --
Source server vCenter client id.
{'enableMapAutoTagging': 'boolean',
'mapAutoTaggingMpeID': 'string',
'postLaunchActions': {'deployment': {'TEST_ONLY'}}}
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',
'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.
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.
{'applicationID': '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
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
}
Response Structure
(dict) --
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.
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) --
vcenterClientID (string) --
Source server vCenter client id.
{'applicationID': '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
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
}
Response Structure
(dict) --
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.
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) --
vcenterClientID (string) --
Source server vCenter client id.
{'applicationID': '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
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
}
Response Structure
(dict) --
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.
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) --
vcenterClientID (string) --
Source server vCenter client id.
{'enableMapAutoTagging': 'boolean',
'mapAutoTaggingMpeID': 'string',
'postLaunchActions': {'deployment': {'TEST_ONLY'}}}
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',
'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.
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',
'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.
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.
{'associatePublicIpAddress': 'boolean',
'bootMode': 'LEGACY_BIOS | UEFI',
'copyPrivateIp': 'boolean',
'copyTags': 'boolean',
'enableMapAutoTagging': 'boolean',
'largeVolumeConf': {'iops': 'long',
'throughput': 'long',
'volumeType': 'io1 | io2 | gp3 | gp2 | st1 | sc1 | '
'standard'},
'launchDisposition': 'STOPPED | STARTED',
'licensing': {'osByol': 'boolean'},
'mapAutoTaggingMpeID': 'string',
'postLaunchActions': {'deployment': {'TEST_ONLY'}},
'smallVolumeConf': {'iops': 'long',
'throughput': 'long',
'volumeType': 'io1 | io2 | gp3 | gp2 | st1 | sc1 | '
'standard'},
'smallVolumeMaxSize': 'long',
'targetInstanceTypeRightSizingMethod': 'NONE | BASIC'}
Response {'associatePublicIpAddress': 'boolean',
'bootMode': 'LEGACY_BIOS | UEFI',
'copyPrivateIp': 'boolean',
'copyTags': 'boolean',
'ec2LaunchTemplateID': 'string',
'enableMapAutoTagging': 'boolean',
'largeVolumeConf': {'iops': 'long',
'throughput': 'long',
'volumeType': 'io1 | io2 | gp3 | gp2 | st1 | sc1 | '
'standard'},
'launchDisposition': 'STOPPED | STARTED',
'licensing': {'osByol': 'boolean'},
'mapAutoTaggingMpeID': 'string',
'postLaunchActions': {'deployment': {'TEST_ONLY'}},
'smallVolumeConf': {'iops': 'long',
'throughput': 'long',
'volumeType': 'io1 | io2 | gp3 | gp2 | st1 | sc1 | '
'standard'},
'smallVolumeMaxSize': 'long',
'targetInstanceTypeRightSizingMethod': 'NONE | BASIC'}
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',
'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.
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',
'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.
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.
{'applicationID': '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
},
]
},
'isArchived': True|False,
'launchedInstance': {
'ec2InstanceID': 'string',
'firstBoot': 'WAITING'|'SUCCEEDED'|'UNKNOWN'|'STOPPED',
'jobID': 'string'
},
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastCutover': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'lastSeenByServiceDateTime': 'string',
'lastTest': {
'finalized': {
'apiCallDateTime': 'string'
},
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string'
},
'reverted': {
'apiCallDateTime': 'string'
}
},
'state': 'STOPPED'|'NOT_READY'|'READY_FOR_TEST'|'TESTING'|'READY_FOR_CUTOVER'|'CUTTING_OVER'|'CUTOVER'|'DISCONNECTED'|'DISCOVERED'
},
'replicationType': 'AGENT_BASED'|'SNAPSHOT_SHIPPING',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmPath': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123,
'recommendedInstanceType': 'string'
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
},
'vcenterClientID': 'string'
}
Response Structure
(dict) --
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.
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) --
vcenterClientID (string) --
Source server vCenter client id.