2022/06/23 - Application Migration Service - 4 new6 updated api methods
Changes New and modified APIs for the Post-Migration Framework
Creates a new ReplicationConfigurationTemplate.
See also: AWS API Documentation
Request Syntax
client.update_launch_configuration_template(
launchConfigurationTemplateID='string',
postLaunchActions={
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
}
)
string
[REQUIRED]
Update Launch configuration Target instance right sizing request.
dict
Update Launch configuration Target instance right sizing request.
cloudWatchLogGroupName (string) --
Server participating in Job.
deployment (string) --
Server participating in Job.
s3LogBucket (string) --
Server participating in Job.
s3OutputKeyPrefix (string) --
Server participating in Job.
ssmDocuments (list) --
Server participating in Job.
(dict) --
Source server replication type.
actionName (string) -- [REQUIRED]
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) -- [REQUIRED]
Source server replication type.
parameterType (string) -- [REQUIRED]
Source server replication type.
ssmDocumentName (string) -- [REQUIRED]
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
dict
Response Syntax
{
'arn': 'string',
'launchConfigurationTemplateID': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
Copy Private IP during Launch Configuration.
launchConfigurationTemplateID (string) --
Copy Private IP during Launch Configuration.
postLaunchActions (dict) --
Copy Private IP during Launch Configuration.
cloudWatchLogGroupName (string) --
Server participating in Job.
deployment (string) --
Server participating in Job.
s3LogBucket (string) --
Server participating in Job.
s3OutputKeyPrefix (string) --
Server participating in Job.
ssmDocuments (list) --
Server participating in Job.
(dict) --
Source server replication type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
tags (dict) --
Copy Private IP during Launch Configuration.
(string) --
(string) --
Creates a new ReplicationConfigurationTemplate.
See also: AWS API Documentation
Request Syntax
client.describe_launch_configuration_templates(
launchConfigurationTemplateIDs=[
'string',
],
maxResults=123,
nextToken='string'
)
list
Request to disconnect Source Server from service by Server ID.
(string) --
integer
Request to disconnect Source Server from service by Server ID.
string
Request to disconnect Source Server from service by Server ID.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'launchConfigurationTemplateID': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to disconnect Source Server from service by Server ID.
(dict) --
arn (string) --
Copy Private IP during Launch Configuration.
launchConfigurationTemplateID (string) --
Copy Private IP during Launch Configuration.
postLaunchActions (dict) --
Copy Private IP during Launch Configuration.
cloudWatchLogGroupName (string) --
Server participating in Job.
deployment (string) --
Server participating in Job.
s3LogBucket (string) --
Server participating in Job.
s3OutputKeyPrefix (string) --
Server participating in Job.
ssmDocuments (list) --
Server participating in Job.
(dict) --
Source server replication type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
tags (dict) --
Copy Private IP during Launch Configuration.
(string) --
(string) --
nextToken (string) --
Request to disconnect Source Server from service by Server ID.
Creates a new ReplicationConfigurationTemplate.
See also: AWS API Documentation
Request Syntax
client.delete_launch_configuration_template(
launchConfigurationTemplateID='string'
)
string
[REQUIRED]
ID of resource to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates a new ReplicationConfigurationTemplate.
See also: AWS API Documentation
Request Syntax
client.create_launch_configuration_template(
postLaunchActions={
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
tags={
'string': 'string'
}
)
dict
Request to associate the default Application Migration Service Security group with the Replication Settings template.
cloudWatchLogGroupName (string) --
Server participating in Job.
deployment (string) --
Server participating in Job.
s3LogBucket (string) --
Server participating in Job.
s3OutputKeyPrefix (string) --
Server participating in Job.
ssmDocuments (list) --
Server participating in Job.
(dict) --
Source server replication type.
actionName (string) -- [REQUIRED]
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) -- [REQUIRED]
Source server replication type.
parameterType (string) -- [REQUIRED]
Source server replication type.
ssmDocumentName (string) -- [REQUIRED]
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
dict
Request to associate the default Application Migration Service Security group with the Replication Settings template.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'launchConfigurationTemplateID': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
Copy Private IP during Launch Configuration.
launchConfigurationTemplateID (string) --
Copy Private IP during Launch Configuration.
postLaunchActions (dict) --
Copy Private IP during Launch Configuration.
cloudWatchLogGroupName (string) --
Server participating in Job.
deployment (string) --
Server participating in Job.
s3LogBucket (string) --
Server participating in Job.
s3OutputKeyPrefix (string) --
Server participating in Job.
ssmDocuments (list) --
Server participating in Job.
(dict) --
Source server replication type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
tags (dict) --
Copy Private IP during Launch Configuration.
(string) --
(string) --
{'items': {'participatingServers': {'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {'postLaunchActionsLaunchStatusList': [{'executionID': 'string',
'executionStatus': 'IN_PROGRESS '
'| '
'SUCCESS '
'| '
'FAILED',
'failureReason': 'string',
'ssmDocument': {'actionName': 'string',
'mustSucceedForCutover': 'boolean',
'parameters': {'string': [{'parameterName': 'string',
'parameterType': 'STRING'}]},
'ssmDocumentName': 'string',
'timeoutSeconds': 'integer'},
'ssmDocumentType': 'AUTOMATION '
'| '
'COMMAND'}],
'ssmAgentDiscoveryDatetime': 'string'}}}}
Returns a list of Jobs. Use the JobsID and fromDate and toData filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are normally created by the StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to Support and only used in response to relevant support tickets.
See also: AWS API Documentation
Request Syntax
client.describe_jobs(
filters={
'fromDate': 'string',
'jobIDs': [
'string',
],
'toDate': 'string'
},
maxResults=123,
nextToken='string'
)
dict
Request to describe Job log filters.
fromDate (string) --
Request to describe Job log filters by date.
jobIDs (list) --
Request to describe Job log filters by job ID.
(string) --
toDate (string) --
Request to describe job log items by last date.
integer
Request to describe job log items by max results.
string
Request to describe job log items by next token.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'postLaunchActionsLaunchStatusList': [
{
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string',
'ssmDocument': {
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND'
},
],
'ssmAgentDiscoveryDatetime': 'string'
},
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
Request to describe Job log items.
(dict) --
Job.
arn (string) --
the ARN of the specific Job.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
initiatedBy (string) --
Job initiated by field.
jobID (string) --
Job ID.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server Source Server ID.
postLaunchActionsStatus (dict) --
Participating server Source Server ID.
postLaunchActionsLaunchStatusList (list) --
Server participating in Job.
(dict) --
Job type.
executionID (string) --
Job type.
executionStatus (string) --
Job type.
failureReason (string) --
Job type.
ssmDocument (dict) --
Job type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
ssmDocumentType (string) --
Job type.
ssmAgentDiscoveryDatetime (string) --
Server participating in Job.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
type (string) --
Job type.
nextToken (string) --
Request to describe Job response by next token.
{'postLaunchActions': {'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER | CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [{'actionName': 'string',
'mustSucceedForCutover': 'boolean',
'parameters': {'string': [{'parameterName': 'string',
'parameterType': 'STRING'}]},
'ssmDocumentName': 'string',
'timeoutSeconds': 'integer'}]}}
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',
'launchDisposition': 'STOPPED'|'STARTED',
'licensing': {
'osByol': True|False
},
'name': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'sourceServerID': 'string',
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'
}
Response Structure
(dict) --
bootMode (string) --
Launch configuration boot mode.
copyPrivateIp (boolean) --
Copy Private IP during Launch Configuration.
copyTags (boolean) --
Copy Tags during Launch Configuration.
ec2LaunchTemplateID (string) --
Launch configuration EC2 Launch template ID.
launchDisposition (string) --
Launch disposition for launch configuration.
licensing (dict) --
Launch configuration OS licensing.
osByol (boolean) --
Configure BYOL OS licensing.
name (string) --
Launch configuration name.
postLaunchActions (dict) --
Server participating in Job.
cloudWatchLogGroupName (string) --
Server participating in Job.
deployment (string) --
Server participating in Job.
s3LogBucket (string) --
Server participating in Job.
s3OutputKeyPrefix (string) --
Server participating in Job.
ssmDocuments (list) --
Server participating in Job.
(dict) --
Source server replication type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
sourceServerID (string) --
Launch configuration Source Server ID.
targetInstanceTypeRightSizingMethod (string) --
Launch configuration Target instance type right sizing method.
{'job': {'participatingServers': {'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {'postLaunchActionsLaunchStatusList': [{'executionID': 'string',
'executionStatus': 'IN_PROGRESS '
'| '
'SUCCESS '
'| '
'FAILED',
'failureReason': 'string',
'ssmDocument': {'actionName': 'string',
'mustSucceedForCutover': 'boolean',
'parameters': {'string': [{'parameterName': 'string',
'parameterType': 'STRING'}]},
'ssmDocumentName': 'string',
'timeoutSeconds': 'integer'},
'ssmDocumentType': 'AUTOMATION '
'| '
'COMMAND'}],
'ssmAgentDiscoveryDatetime': 'string'}}}}
Launches a Cutover Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartCutover and changes the SourceServer.lifeCycle.state property to CUTTING_OVER.
See also: AWS API Documentation
Request Syntax
client.start_cutover(
sourceServerIDs=[
'string',
],
tags={
'string': 'string'
}
)
list
[REQUIRED]
Start Cutover by Source Server IDs.
(string) --
dict
Start Cutover by Tags.
(string) --
(string) --
dict
Response Syntax
{
'job': {
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'postLaunchActionsLaunchStatusList': [
{
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string',
'ssmDocument': {
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND'
},
],
'ssmAgentDiscoveryDatetime': 'string'
},
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
}
}
Response Structure
(dict) --
job (dict) --
Start Cutover Job response.
arn (string) --
the ARN of the specific Job.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
initiatedBy (string) --
Job initiated by field.
jobID (string) --
Job ID.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server Source Server ID.
postLaunchActionsStatus (dict) --
Participating server Source Server ID.
postLaunchActionsLaunchStatusList (list) --
Server participating in Job.
(dict) --
Job type.
executionID (string) --
Job type.
executionStatus (string) --
Job type.
failureReason (string) --
Job type.
ssmDocument (dict) --
Job type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
ssmDocumentType (string) --
Job type.
ssmAgentDiscoveryDatetime (string) --
Server participating in Job.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
type (string) --
Job type.
{'job': {'participatingServers': {'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {'postLaunchActionsLaunchStatusList': [{'executionID': 'string',
'executionStatus': 'IN_PROGRESS '
'| '
'SUCCESS '
'| '
'FAILED',
'failureReason': 'string',
'ssmDocument': {'actionName': 'string',
'mustSucceedForCutover': 'boolean',
'parameters': {'string': [{'parameterName': 'string',
'parameterType': 'STRING'}]},
'ssmDocumentName': 'string',
'timeoutSeconds': 'integer'},
'ssmDocumentType': 'AUTOMATION '
'| '
'COMMAND'}],
'ssmAgentDiscoveryDatetime': 'string'}}}}
Launches a Test Instance for specific Source Servers. This command starts a LAUNCH job whose initiatedBy property is StartTest and changes the SourceServer.lifeCycle.state property to TESTING.
See also: AWS API Documentation
Request Syntax
client.start_test(
sourceServerIDs=[
'string',
],
tags={
'string': 'string'
}
)
list
[REQUIRED]
Start Test for Source Server IDs.
(string) --
dict
Start Test by Tags.
(string) --
(string) --
dict
Response Syntax
{
'job': {
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'postLaunchActionsLaunchStatusList': [
{
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string',
'ssmDocument': {
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND'
},
],
'ssmAgentDiscoveryDatetime': 'string'
},
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
}
}
Response Structure
(dict) --
job (dict) --
Start Test Job response.
arn (string) --
the ARN of the specific Job.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
initiatedBy (string) --
Job initiated by field.
jobID (string) --
Job ID.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server Source Server ID.
postLaunchActionsStatus (dict) --
Participating server Source Server ID.
postLaunchActionsLaunchStatusList (list) --
Server participating in Job.
(dict) --
Job type.
executionID (string) --
Job type.
executionStatus (string) --
Job type.
failureReason (string) --
Job type.
ssmDocument (dict) --
Job type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
ssmDocumentType (string) --
Job type.
ssmAgentDiscoveryDatetime (string) --
Server participating in Job.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
type (string) --
Job type.
{'job': {'participatingServers': {'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {'postLaunchActionsLaunchStatusList': [{'executionID': 'string',
'executionStatus': 'IN_PROGRESS '
'| '
'SUCCESS '
'| '
'FAILED',
'failureReason': 'string',
'ssmDocument': {'actionName': 'string',
'mustSucceedForCutover': 'boolean',
'parameters': {'string': [{'parameterName': 'string',
'parameterType': 'STRING'}]},
'ssmDocumentName': 'string',
'timeoutSeconds': 'integer'},
'ssmDocumentType': 'AUTOMATION '
'| '
'COMMAND'}],
'ssmAgentDiscoveryDatetime': 'string'}}}}
Starts a job that terminates specific launched EC2 Test and Cutover instances. This command will not work for any Source Server with a lifecycle.state of TESTING, CUTTING_OVER, or CUTOVER.
See also: AWS API Documentation
Request Syntax
client.terminate_target_instances(
sourceServerIDs=[
'string',
],
tags={
'string': 'string'
}
)
list
[REQUIRED]
Terminate Target instance by Source Server IDs.
(string) --
dict
Terminate Target instance by Tags.
(string) --
(string) --
dict
Response Syntax
{
'job': {
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_TEST'|'START_CUTOVER'|'DIAGNOSTIC'|'TERMINATE',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'launchedEc2InstanceID': 'string',
'postLaunchActionsStatus': {
'postLaunchActionsLaunchStatusList': [
{
'executionID': 'string',
'executionStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED',
'failureReason': 'string',
'ssmDocument': {
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
'ssmDocumentType': 'AUTOMATION'|'COMMAND'
},
],
'ssmAgentDiscoveryDatetime': 'string'
},
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
}
}
Response Structure
(dict) --
job (dict) --
Terminate Target instance Job response.
arn (string) --
the ARN of the specific Job.
creationDateTime (string) --
Job creation time.
endDateTime (string) --
Job end time.
initiatedBy (string) --
Job initiated by field.
jobID (string) --
Job ID.
participatingServers (list) --
Servers participating in a specific Job.
(dict) --
Server participating in Job.
launchStatus (string) --
Participating server launch status.
launchedEc2InstanceID (string) --
Participating server Source Server ID.
postLaunchActionsStatus (dict) --
Participating server Source Server ID.
postLaunchActionsLaunchStatusList (list) --
Server participating in Job.
(dict) --
Job type.
executionID (string) --
Job type.
executionStatus (string) --
Job type.
failureReason (string) --
Job type.
ssmDocument (dict) --
Job type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
ssmDocumentType (string) --
Job type.
ssmAgentDiscoveryDatetime (string) --
Server participating in Job.
sourceServerID (string) --
Participating server Source Server ID.
status (string) --
Job status.
tags (dict) --
Tags associated with specific Job.
(string) --
(string) --
type (string) --
Job type.
{'postLaunchActions': {'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER | CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [{'actionName': 'string',
'mustSucceedForCutover': 'boolean',
'parameters': {'string': [{'parameterName': 'string',
'parameterType': 'STRING'}]},
'ssmDocumentName': 'string',
'timeoutSeconds': 'integer'}]}}
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,
launchDisposition='STOPPED'|'STARTED',
licensing={
'osByol': True|False
},
name='string',
postLaunchActions={
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
sourceServerID='string',
targetInstanceTypeRightSizingMethod='NONE'|'BASIC'
)
string
Update Launch configuration boot mode request.
boolean
Update Launch configuration copy Private IP request.
boolean
Update Launch configuration copy Tags request.
string
Update Launch configuration launch disposition request.
dict
Update Launch configuration licensing request.
osByol (boolean) --
Configure BYOL OS licensing.
string
Update Launch configuration name request.
dict
Server participating in Job.
cloudWatchLogGroupName (string) --
Server participating in Job.
deployment (string) --
Server participating in Job.
s3LogBucket (string) --
Server participating in Job.
s3OutputKeyPrefix (string) --
Server participating in Job.
ssmDocuments (list) --
Server participating in Job.
(dict) --
Source server replication type.
actionName (string) -- [REQUIRED]
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) -- [REQUIRED]
Source server replication type.
parameterType (string) -- [REQUIRED]
Source server replication type.
ssmDocumentName (string) -- [REQUIRED]
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
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',
'launchDisposition': 'STOPPED'|'STARTED',
'licensing': {
'osByol': True|False
},
'name': 'string',
'postLaunchActions': {
'cloudWatchLogGroupName': 'string',
'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY',
's3LogBucket': 'string',
's3OutputKeyPrefix': 'string',
'ssmDocuments': [
{
'actionName': 'string',
'mustSucceedForCutover': True|False,
'parameters': {
'string': [
{
'parameterName': 'string',
'parameterType': 'STRING'
},
]
},
'ssmDocumentName': 'string',
'timeoutSeconds': 123
},
]
},
'sourceServerID': 'string',
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'
}
Response Structure
(dict) --
bootMode (string) --
Launch configuration boot mode.
copyPrivateIp (boolean) --
Copy Private IP during Launch Configuration.
copyTags (boolean) --
Copy Tags during Launch Configuration.
ec2LaunchTemplateID (string) --
Launch configuration EC2 Launch template ID.
launchDisposition (string) --
Launch disposition for launch configuration.
licensing (dict) --
Launch configuration OS licensing.
osByol (boolean) --
Configure BYOL OS licensing.
name (string) --
Launch configuration name.
postLaunchActions (dict) --
Server participating in Job.
cloudWatchLogGroupName (string) --
Server participating in Job.
deployment (string) --
Server participating in Job.
s3LogBucket (string) --
Server participating in Job.
s3OutputKeyPrefix (string) --
Server participating in Job.
ssmDocuments (list) --
Server participating in Job.
(dict) --
Source server replication type.
actionName (string) --
Source server replication type.
mustSucceedForCutover (boolean) --
Source server replication type.
parameters (dict) --
Source server replication type.
(string) --
(list) --
(dict) --
Source server replication type.
parameterName (string) --
Source server replication type.
parameterType (string) --
Source server replication type.
ssmDocumentName (string) --
Source server replication type.
timeoutSeconds (integer) --
Source server replication type.
sourceServerID (string) --
Launch configuration Source Server ID.
targetInstanceTypeRightSizingMethod (string) --
Launch configuration Target instance type right sizing method.