2020/08/07 - AWS Server Migration Service - 7 new 7 updated api methods
Changes In this release, AWS Server Migration Service (SMS) has added new features: 1. APIs to work with application and instance level validation 2. Import application catalog from AWS Application Discovery Service 3. For an application you can start on-demand replication
Deletes the validation configuration for the specified application.
See also: AWS API Documentation
Request Syntax
client.delete_app_validation_configuration(
appId='string'
)
string
[REQUIRED]
The ID of the application.
dict
Response Syntax
{}
Response Structure
(dict) --
Starts an on-demand replication run for the specified application.
See also: AWS API Documentation
Request Syntax
client.start_on_demand_app_replication(
appId='string',
description='string'
)
string
[REQUIRED]
The ID of the application.
string
The description of the replication run.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves information about a configuration for validating an application.
See also: AWS API Documentation
Request Syntax
client.get_app_validation_configuration(
appId='string'
)
string
[REQUIRED]
The ID of the application.
dict
Response Syntax
{
'appValidationConfigurations': [
{
'validationId': 'string',
'name': 'string',
'appValidationStrategy': 'SSM',
'ssmValidationParameters': {
'source': {
's3Location': {
'bucket': 'string',
'key': 'string'
}
},
'instanceId': 'string',
'scriptType': 'SHELL_SCRIPT'|'POWERSHELL_SCRIPT',
'command': 'string',
'executionTimeoutSeconds': 123,
'outputS3BucketName': 'string'
}
},
],
'serverGroupValidationConfigurations': [
{
'serverGroupId': 'string',
'serverValidationConfigurations': [
{
'server': {
'serverId': 'string',
'serverType': 'VIRTUAL_MACHINE',
'vmServer': {
'vmServerAddress': {
'vmManagerId': 'string',
'vmId': 'string'
},
'vmName': 'string',
'vmManagerName': 'string',
'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
'vmPath': 'string'
},
'replicationJobId': 'string',
'replicationJobTerminated': True|False
},
'validationId': 'string',
'name': 'string',
'serverValidationStrategy': 'USERDATA',
'userDataValidationParameters': {
'source': {
's3Location': {
'bucket': 'string',
'key': 'string'
}
},
'scriptType': 'SHELL_SCRIPT'|'POWERSHELL_SCRIPT'
}
},
]
},
]
}
Response Structure
(dict) --
appValidationConfigurations (list) --
The configuration for application validation.
(dict) --
Configuration for validating an application.
validationId (string) --
The ID of the validation.
name (string) --
The name of the configuration.
appValidationStrategy (string) --
The validation strategy.
ssmValidationParameters (dict) --
The validation parameters.
source (dict) --
The location of the validation script.
s3Location (dict) --
Location of an Amazon S3 object.
bucket (string) --
The Amazon S3 bucket name.
key (string) --
The Amazon S3 bucket key.
instanceId (string) --
The ID of the instance. The instance must have the following tag: UserForSMSApplicationValidation=true.
scriptType (string) --
The type of validation script.
command (string) --
The command to run the validation script
executionTimeoutSeconds (integer) --
The timeout interval, in seconds.
outputS3BucketName (string) --
The name of the S3 bucket for output.
serverGroupValidationConfigurations (list) --
The configuration for instance validation.
(dict) --
Configuration for validating an instance.
serverGroupId (string) --
The ID of the server group.
serverValidationConfigurations (list) --
The validation configuration.
(dict) --
Configuration for validating an instance.
server (dict) --
Represents a server.
serverId (string) --
The ID of the server.
serverType (string) --
The type of server.
vmServer (dict) --
Information about the VM server.
vmServerAddress (dict) --
The VM server location.
vmManagerId (string) --
The ID of the VM manager.
vmId (string) --
The ID of the VM.
vmName (string) --
The name of the VM.
vmManagerName (string) --
The name of the VM manager.
vmManagerType (string) --
The type of VM management product.
vmPath (string) --
The VM folder path in the vCenter Server virtual machine inventory tree.
replicationJobId (string) --
The ID of the replication job.
replicationJobTerminated (boolean) --
Indicates whether the replication job is deleted or failed.
validationId (string) --
The ID of the validation.
name (string) --
The name of the configuration.
serverValidationStrategy (string) --
The validation strategy.
userDataValidationParameters (dict) --
The validation parameters.
source (dict) --
The location of the validation script.
s3Location (dict) --
Location of an Amazon S3 object.
bucket (string) --
The Amazon S3 bucket name.
key (string) --
The Amazon S3 bucket key.
scriptType (string) --
The type of validation script.
Allows application import from AWS Migration Hub.
See also: AWS API Documentation
Request Syntax
client.import_app_catalog(
roleName='string'
)
string
The name of the service role. If you omit this parameter, we create a service-linked role for AWS Migration Hub in your account. Otherwise, the role that you provide must have the policy and trust policy described in the AWS Migration Hub User Guide .
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves output from validating an application.
See also: AWS API Documentation
Request Syntax
client.get_app_validation_output(
appId='string'
)
string
[REQUIRED]
The ID of the application.
dict
Response Syntax
{
'validationOutputList': [
{
'validationId': 'string',
'name': 'string',
'status': 'READY_FOR_VALIDATION'|'PENDING'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'statusMessage': 'string',
'latestValidationTime': datetime(2015, 1, 1),
'appValidationOutput': {
'ssmOutput': {
's3Location': {
'bucket': 'string',
'key': 'string'
}
}
},
'serverValidationOutput': {
'server': {
'serverId': 'string',
'serverType': 'VIRTUAL_MACHINE',
'vmServer': {
'vmServerAddress': {
'vmManagerId': 'string',
'vmId': 'string'
},
'vmName': 'string',
'vmManagerName': 'string',
'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
'vmPath': 'string'
},
'replicationJobId': 'string',
'replicationJobTerminated': True|False
}
}
},
]
}
Response Structure
(dict) --
validationOutputList (list) --
The validation output.
(dict) --
Contains validation output.
validationId (string) --
The ID of the validation.
name (string) --
The name of the validation.
status (string) --
The status of the validation.
statusMessage (string) --
The status message.
latestValidationTime (datetime) --
The latest time that the validation was performed.
appValidationOutput (dict) --
The output from validating an application.
ssmOutput (dict) --
Output from using SSM to validate the application.
s3Location (dict) --
Location of an Amazon S3 object.
bucket (string) --
The Amazon S3 bucket name.
key (string) --
The Amazon S3 bucket key.
serverValidationOutput (dict) --
The output from validation an instance.
server (dict) --
Represents a server.
serverId (string) --
The ID of the server.
serverType (string) --
The type of server.
vmServer (dict) --
Information about the VM server.
vmServerAddress (dict) --
The VM server location.
vmManagerId (string) --
The ID of the VM manager.
vmId (string) --
The ID of the VM.
vmName (string) --
The name of the VM.
vmManagerName (string) --
The name of the VM manager.
vmManagerType (string) --
The type of VM management product.
vmPath (string) --
The VM folder path in the vCenter Server virtual machine inventory tree.
replicationJobId (string) --
The ID of the replication job.
replicationJobTerminated (boolean) --
Indicates whether the replication job is deleted or failed.
Provides information to AWS SMS about whether application validation is successful.
See also: AWS API Documentation
Request Syntax
client.notify_app_validation_output(
appId='string',
notificationContext={
'validationId': 'string',
'status': 'READY_FOR_VALIDATION'|'PENDING'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'statusMessage': 'string'
}
)
string
[REQUIRED]
The ID of the application.
dict
The notification information.
validationId (string) --
The ID of the validation.
status (string) --
The status of the validation.
statusMessage (string) --
The status message.
dict
Response Syntax
{}
Response Structure
(dict) --
Creates or updates a validation configuration for the specified application.
See also: AWS API Documentation
Request Syntax
client.put_app_validation_configuration(
appId='string',
appValidationConfigurations=[
{
'validationId': 'string',
'name': 'string',
'appValidationStrategy': 'SSM',
'ssmValidationParameters': {
'source': {
's3Location': {
'bucket': 'string',
'key': 'string'
}
},
'instanceId': 'string',
'scriptType': 'SHELL_SCRIPT'|'POWERSHELL_SCRIPT',
'command': 'string',
'executionTimeoutSeconds': 123,
'outputS3BucketName': 'string'
}
},
],
serverGroupValidationConfigurations=[
{
'serverGroupId': 'string',
'serverValidationConfigurations': [
{
'server': {
'serverId': 'string',
'serverType': 'VIRTUAL_MACHINE',
'vmServer': {
'vmServerAddress': {
'vmManagerId': 'string',
'vmId': 'string'
},
'vmName': 'string',
'vmManagerName': 'string',
'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
'vmPath': 'string'
},
'replicationJobId': 'string',
'replicationJobTerminated': True|False
},
'validationId': 'string',
'name': 'string',
'serverValidationStrategy': 'USERDATA',
'userDataValidationParameters': {
'source': {
's3Location': {
'bucket': 'string',
'key': 'string'
}
},
'scriptType': 'SHELL_SCRIPT'|'POWERSHELL_SCRIPT'
}
},
]
},
]
)
string
[REQUIRED]
The ID of the application.
list
The configuration for application validation.
(dict) --
Configuration for validating an application.
validationId (string) --
The ID of the validation.
name (string) --
The name of the configuration.
appValidationStrategy (string) --
The validation strategy.
ssmValidationParameters (dict) --
The validation parameters.
source (dict) --
The location of the validation script.
s3Location (dict) --
Location of an Amazon S3 object.
bucket (string) --
The Amazon S3 bucket name.
key (string) --
The Amazon S3 bucket key.
instanceId (string) --
The ID of the instance. The instance must have the following tag: UserForSMSApplicationValidation=true.
scriptType (string) --
The type of validation script.
command (string) --
The command to run the validation script
executionTimeoutSeconds (integer) --
The timeout interval, in seconds.
outputS3BucketName (string) --
The name of the S3 bucket for output.
list
The configuration for instance validation.
(dict) --
Configuration for validating an instance.
serverGroupId (string) --
The ID of the server group.
serverValidationConfigurations (list) --
The validation configuration.
(dict) --
Configuration for validating an instance.
server (dict) --
Represents a server.
serverId (string) --
The ID of the server.
serverType (string) --
The type of server.
vmServer (dict) --
Information about the VM server.
vmServerAddress (dict) --
The VM server location.
vmManagerId (string) --
The ID of the VM manager.
vmId (string) --
The ID of the VM.
vmName (string) --
The name of the VM.
vmManagerName (string) --
The name of the VM manager.
vmManagerType (string) --
The type of VM management product.
vmPath (string) --
The VM folder path in the vCenter Server virtual machine inventory tree.
replicationJobId (string) --
The ID of the replication job.
replicationJobTerminated (boolean) --
Indicates whether the replication job is deleted or failed.
validationId (string) --
The ID of the validation.
name (string) --
The name of the configuration.
serverValidationStrategy (string) --
The validation strategy.
userDataValidationParameters (dict) --
The validation parameters.
source (dict) --
The location of the validation script.
s3Location (dict) --
Location of an Amazon S3 object.
bucket (string) --
The Amazon S3 bucket name.
key (string) --
The Amazon S3 bucket key.
scriptType (string) --
The type of validation script.
dict
Response Syntax
{}
Response Structure
(dict) --
{'appSummary': {'importedAppId': 'string',
'launchConfigurationStatus': 'NOT_CONFIGURED | CONFIGURED',
'launchStatus': {'PARTIALLY_LAUNCHED'},
'replicationConfigurationStatus': 'NOT_CONFIGURED | CONFIGURED',
'replicationStatus': {'PARTIALLY_REPLICATED'}}}
Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.
See also: AWS API Documentation
Request Syntax
client.create_app(
name='string',
description='string',
roleName='string',
clientToken='string',
serverGroups=[
{
'serverGroupId': 'string',
'name': 'string',
'serverList': [
{
'serverId': 'string',
'serverType': 'VIRTUAL_MACHINE',
'vmServer': {
'vmServerAddress': {
'vmManagerId': 'string',
'vmId': 'string'
},
'vmName': 'string',
'vmManagerName': 'string',
'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
'vmPath': 'string'
},
'replicationJobId': 'string',
'replicationJobTerminated': True|False
},
]
},
],
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
The name of the new application.
string
The description of the new application
string
The name of the service role in the customer's account to be used by AWS SMS.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of application creation.
list
The server groups to include in the application.
(dict) --
Logical grouping of servers.
serverGroupId (string) --
The ID of a server group.
name (string) --
The name of a server group.
serverList (list) --
The servers that belong to a server group.
(dict) --
Represents a server.
serverId (string) --
The ID of the server.
serverType (string) --
The type of server.
vmServer (dict) --
Information about the VM server.
vmServerAddress (dict) --
The VM server location.
vmManagerId (string) --
The ID of the VM manager.
vmId (string) --
The ID of the VM.
vmName (string) --
The name of the VM.
vmManagerName (string) --
The name of the VM manager.
vmManagerType (string) --
The type of VM management product.
vmPath (string) --
The VM folder path in the vCenter Server virtual machine inventory tree.
replicationJobId (string) --
The ID of the replication job.
replicationJobTerminated (boolean) --
Indicates whether the replication job is deleted or failed.
list
The tags to be associated with the application.
(dict) --
Key/value pair that can be assigned to an application.
key (string) --
The tag key.
value (string) --
The tag value.
dict
Response Syntax
{
'appSummary': {
'appId': 'string',
'importedAppId': 'string',
'name': 'string',
'description': 'string',
'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'DELETE_FAILED',
'statusMessage': 'string',
'replicationConfigurationStatus': 'NOT_CONFIGURED'|'CONFIGURED',
'replicationStatus': 'READY_FOR_CONFIGURATION'|'CONFIGURATION_IN_PROGRESS'|'CONFIGURATION_INVALID'|'READY_FOR_REPLICATION'|'VALIDATION_IN_PROGRESS'|'REPLICATION_PENDING'|'REPLICATION_IN_PROGRESS'|'REPLICATED'|'PARTIALLY_REPLICATED'|'DELTA_REPLICATION_IN_PROGRESS'|'DELTA_REPLICATED'|'DELTA_REPLICATION_FAILED'|'REPLICATION_FAILED'|'REPLICATION_STOPPING'|'REPLICATION_STOP_FAILED'|'REPLICATION_STOPPED',
'replicationStatusMessage': 'string',
'latestReplicationTime': datetime(2015, 1, 1),
'launchConfigurationStatus': 'NOT_CONFIGURED'|'CONFIGURED',
'launchStatus': 'READY_FOR_CONFIGURATION'|'CONFIGURATION_IN_PROGRESS'|'CONFIGURATION_INVALID'|'READY_FOR_LAUNCH'|'VALIDATION_IN_PROGRESS'|'LAUNCH_PENDING'|'LAUNCH_IN_PROGRESS'|'LAUNCHED'|'PARTIALLY_LAUNCHED'|'DELTA_LAUNCH_IN_PROGRESS'|'DELTA_LAUNCH_FAILED'|'LAUNCH_FAILED'|'TERMINATE_IN_PROGRESS'|'TERMINATE_FAILED'|'TERMINATED',
'launchStatusMessage': 'string',
'launchDetails': {
'latestLaunchTime': datetime(2015, 1, 1),
'stackName': 'string',
'stackId': 'string'
},
'creationTime': datetime(2015, 1, 1),
'lastModified': datetime(2015, 1, 1),
'roleName': 'string',
'totalServerGroups': 123,
'totalServers': 123
},
'serverGroups': [
{
'serverGroupId': 'string',
'name': 'string',
'serverList': [
{
'serverId': 'string',
'serverType': 'VIRTUAL_MACHINE',
'vmServer': {
'vmServerAddress': {
'vmManagerId': 'string',
'vmId': 'string'
},
'vmName': 'string',
'vmManagerName': 'string',
'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
'vmPath': 'string'
},
'replicationJobId': 'string',
'replicationJobTerminated': True|False
},
]
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
(dict) --
appSummary (dict) --
A summary description of the application.
appId (string) --
The unique ID of the application.
importedAppId (string) --
The ID of the application.
name (string) --
The name of the application.
description (string) --
The description of the application.
status (string) --
Status of the application.
statusMessage (string) --
A message related to the status of the application
replicationConfigurationStatus (string) --
Status of the replication configuration.
replicationStatus (string) --
The replication status of the application.
replicationStatusMessage (string) --
A message related to the replication status of the application.
latestReplicationTime (datetime) --
The timestamp of the application's most recent successful replication.
launchConfigurationStatus (string) --
Status of the launch configuration.
launchStatus (string) --
The launch status of the application.
launchStatusMessage (string) --
A message related to the launch status of the application.
launchDetails (dict) --
Details about the latest launch of the application.
latestLaunchTime (datetime) --
The latest time that this application was launched successfully.
stackName (string) --
The name of the latest stack launched for this application.
stackId (string) --
The ID of the latest stack launched for this application.
creationTime (datetime) --
The creation time of the application.
lastModified (datetime) --
The last modified time of the application.
roleName (string) --
The name of the service role in the customer's account used by AWS SMS.
totalServerGroups (integer) --
The number of server groups present in the application.
totalServers (integer) --
The number of servers present in the application.
serverGroups (list) --
The server groups included in the application.
(dict) --
Logical grouping of servers.
serverGroupId (string) --
The ID of a server group.
name (string) --
The name of a server group.
serverList (list) --
The servers that belong to a server group.
(dict) --
Represents a server.
serverId (string) --
The ID of the server.
serverType (string) --
The type of server.
vmServer (dict) --
Information about the VM server.
vmServerAddress (dict) --
The VM server location.
vmManagerId (string) --
The ID of the VM manager.
vmId (string) --
The ID of the VM.
vmName (string) --
The name of the VM.
vmManagerName (string) --
The name of the VM manager.
vmManagerType (string) --
The type of VM management product.
vmPath (string) --
The VM folder path in the vCenter Server virtual machine inventory tree.
replicationJobId (string) --
The ID of the replication job.
replicationJobTerminated (boolean) --
Indicates whether the replication job is deleted or failed.
tags (list) --
The tags associated with the application.
(dict) --
Key/value pair that can be assigned to an application.
key (string) --
The tag key.
value (string) --
The tag value.
{'appSummary': {'importedAppId': 'string',
'launchConfigurationStatus': 'NOT_CONFIGURED | CONFIGURED',
'launchStatus': {'PARTIALLY_LAUNCHED'},
'replicationConfigurationStatus': 'NOT_CONFIGURED | CONFIGURED',
'replicationStatus': {'PARTIALLY_REPLICATED'}}}
Retrieve information about the specified application.
See also: AWS API Documentation
Request Syntax
client.get_app(
appId='string'
)
string
The ID of the application.
dict
Response Syntax
{
'appSummary': {
'appId': 'string',
'importedAppId': 'string',
'name': 'string',
'description': 'string',
'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'DELETE_FAILED',
'statusMessage': 'string',
'replicationConfigurationStatus': 'NOT_CONFIGURED'|'CONFIGURED',
'replicationStatus': 'READY_FOR_CONFIGURATION'|'CONFIGURATION_IN_PROGRESS'|'CONFIGURATION_INVALID'|'READY_FOR_REPLICATION'|'VALIDATION_IN_PROGRESS'|'REPLICATION_PENDING'|'REPLICATION_IN_PROGRESS'|'REPLICATED'|'PARTIALLY_REPLICATED'|'DELTA_REPLICATION_IN_PROGRESS'|'DELTA_REPLICATED'|'DELTA_REPLICATION_FAILED'|'REPLICATION_FAILED'|'REPLICATION_STOPPING'|'REPLICATION_STOP_FAILED'|'REPLICATION_STOPPED',
'replicationStatusMessage': 'string',
'latestReplicationTime': datetime(2015, 1, 1),
'launchConfigurationStatus': 'NOT_CONFIGURED'|'CONFIGURED',
'launchStatus': 'READY_FOR_CONFIGURATION'|'CONFIGURATION_IN_PROGRESS'|'CONFIGURATION_INVALID'|'READY_FOR_LAUNCH'|'VALIDATION_IN_PROGRESS'|'LAUNCH_PENDING'|'LAUNCH_IN_PROGRESS'|'LAUNCHED'|'PARTIALLY_LAUNCHED'|'DELTA_LAUNCH_IN_PROGRESS'|'DELTA_LAUNCH_FAILED'|'LAUNCH_FAILED'|'TERMINATE_IN_PROGRESS'|'TERMINATE_FAILED'|'TERMINATED',
'launchStatusMessage': 'string',
'launchDetails': {
'latestLaunchTime': datetime(2015, 1, 1),
'stackName': 'string',
'stackId': 'string'
},
'creationTime': datetime(2015, 1, 1),
'lastModified': datetime(2015, 1, 1),
'roleName': 'string',
'totalServerGroups': 123,
'totalServers': 123
},
'serverGroups': [
{
'serverGroupId': 'string',
'name': 'string',
'serverList': [
{
'serverId': 'string',
'serverType': 'VIRTUAL_MACHINE',
'vmServer': {
'vmServerAddress': {
'vmManagerId': 'string',
'vmId': 'string'
},
'vmName': 'string',
'vmManagerName': 'string',
'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
'vmPath': 'string'
},
'replicationJobId': 'string',
'replicationJobTerminated': True|False
},
]
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
(dict) --
appSummary (dict) --
Information about the application.
appId (string) --
The unique ID of the application.
importedAppId (string) --
The ID of the application.
name (string) --
The name of the application.
description (string) --
The description of the application.
status (string) --
Status of the application.
statusMessage (string) --
A message related to the status of the application
replicationConfigurationStatus (string) --
Status of the replication configuration.
replicationStatus (string) --
The replication status of the application.
replicationStatusMessage (string) --
A message related to the replication status of the application.
latestReplicationTime (datetime) --
The timestamp of the application's most recent successful replication.
launchConfigurationStatus (string) --
Status of the launch configuration.
launchStatus (string) --
The launch status of the application.
launchStatusMessage (string) --
A message related to the launch status of the application.
launchDetails (dict) --
Details about the latest launch of the application.
latestLaunchTime (datetime) --
The latest time that this application was launched successfully.
stackName (string) --
The name of the latest stack launched for this application.
stackId (string) --
The ID of the latest stack launched for this application.
creationTime (datetime) --
The creation time of the application.
lastModified (datetime) --
The last modified time of the application.
roleName (string) --
The name of the service role in the customer's account used by AWS SMS.
totalServerGroups (integer) --
The number of server groups present in the application.
totalServers (integer) --
The number of servers present in the application.
serverGroups (list) --
The server groups that belong to the application.
(dict) --
Logical grouping of servers.
serverGroupId (string) --
The ID of a server group.
name (string) --
The name of a server group.
serverList (list) --
The servers that belong to a server group.
(dict) --
Represents a server.
serverId (string) --
The ID of the server.
serverType (string) --
The type of server.
vmServer (dict) --
Information about the VM server.
vmServerAddress (dict) --
The VM server location.
vmManagerId (string) --
The ID of the VM manager.
vmId (string) --
The ID of the VM.
vmName (string) --
The name of the VM.
vmManagerName (string) --
The name of the VM manager.
vmManagerType (string) --
The type of VM management product.
vmPath (string) --
The VM folder path in the vCenter Server virtual machine inventory tree.
replicationJobId (string) --
The ID of the replication job.
replicationJobTerminated (boolean) --
Indicates whether the replication job is deleted or failed.
tags (list) --
The tags associated with the application.
(dict) --
Key/value pair that can be assigned to an application.
key (string) --
The tag key.
value (string) --
The tag value.
{'autoLaunch': 'boolean',
'serverGroupLaunchConfigurations': {'serverLaunchConfigurations': {'configureScript': {'bucket': 'string',
'key': 'string'},
'configureScriptType': 'SHELL_SCRIPT '
'| '
'POWERSHELL_SCRIPT',
'iamInstanceProfileName': 'string'}}}
Retrieves the application launch configuration associated with the specified application.
See also: AWS API Documentation
Request Syntax
client.get_app_launch_configuration(
appId='string'
)
string
The ID of the application.
dict
Response Syntax
{
'appId': 'string',
'roleName': 'string',
'autoLaunch': True|False,
'serverGroupLaunchConfigurations': [
{
'serverGroupId': 'string',
'launchOrder': 123,
'serverLaunchConfigurations': [
{
'server': {
'serverId': 'string',
'serverType': 'VIRTUAL_MACHINE',
'vmServer': {
'vmServerAddress': {
'vmManagerId': 'string',
'vmId': 'string'
},
'vmName': 'string',
'vmManagerName': 'string',
'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
'vmPath': 'string'
},
'replicationJobId': 'string',
'replicationJobTerminated': True|False
},
'logicalId': 'string',
'vpc': 'string',
'subnet': 'string',
'securityGroup': 'string',
'ec2KeyName': 'string',
'userData': {
's3Location': {
'bucket': 'string',
'key': 'string'
}
},
'instanceType': 'string',
'associatePublicIpAddress': True|False,
'iamInstanceProfileName': 'string',
'configureScript': {
'bucket': 'string',
'key': 'string'
},
'configureScriptType': 'SHELL_SCRIPT'|'POWERSHELL_SCRIPT'
},
]
},
]
}
Response Structure
(dict) --
appId (string) --
The ID of the application.
roleName (string) --
The name of the service role in the customer's account that AWS CloudFormation uses to launch the application.
autoLaunch (boolean) --
Indicates whether the application is configured to launch automatically after replication is complete.
serverGroupLaunchConfigurations (list) --
The launch configurations for server groups in this application.
(dict) --
Launch configuration for a server group.
serverGroupId (string) --
The ID of the server group with which the launch configuration is associated.
launchOrder (integer) --
The launch order of servers in the server group.
serverLaunchConfigurations (list) --
The launch configuration for servers in the server group.
(dict) --
Launch configuration for a server.
server (dict) --
The ID of the server with which the launch configuration is associated.
serverId (string) --
The ID of the server.
serverType (string) --
The type of server.
vmServer (dict) --
Information about the VM server.
vmServerAddress (dict) --
The VM server location.
vmManagerId (string) --
The ID of the VM manager.
vmId (string) --
The ID of the VM.
vmName (string) --
The name of the VM.
vmManagerName (string) --
The name of the VM manager.
vmManagerType (string) --
The type of VM management product.
vmPath (string) --
The VM folder path in the vCenter Server virtual machine inventory tree.
replicationJobId (string) --
The ID of the replication job.
replicationJobTerminated (boolean) --
Indicates whether the replication job is deleted or failed.
logicalId (string) --
The logical ID of the server in the AWS CloudFormation template.
vpc (string) --
The ID of the VPC into which the server should be launched.
subnet (string) --
The ID of the subnet the server should be launched into.
securityGroup (string) --
The ID of the security group that applies to the launched server.
ec2KeyName (string) --
The name of the Amazon EC2 SSH key to be used for connecting to the launched server.
userData (dict) --
Location of the user-data script to be executed when launching the server.
s3Location (dict) --
Amazon S3 location of the user-data script.
bucket (string) --
The Amazon S3 bucket name.
key (string) --
The Amazon S3 bucket key.
instanceType (string) --
The instance type to use when launching the server.
associatePublicIpAddress (boolean) --
Indicates whether a publicly accessible IP address is created when launching the server.
iamInstanceProfileName (string) --
The name of the IAM instance profile.
configureScript (dict) --
Location of an Amazon S3 object.
bucket (string) --
The Amazon S3 bucket name.
key (string) --
The Amazon S3 bucket key.
configureScriptType (string) --
The type of configuration script.
{'connectorList': {'capabilityList': {'SMS_OPTIMIZED'}}}
Describes the connectors registered with the AWS SMS.
See also: AWS API Documentation
Request Syntax
client.get_connectors(
nextToken='string',
maxResults=123
)
string
The token for the next set of results.
integer
The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.
dict
Response Syntax
{
'connectorList': [
{
'connectorId': 'string',
'version': 'string',
'status': 'HEALTHY'|'UNHEALTHY',
'capabilityList': [
'VSPHERE'|'SCVMM'|'HYPERV-MANAGER'|'SNAPSHOT_BATCHING'|'SMS_OPTIMIZED',
],
'vmManagerName': 'string',
'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
'vmManagerId': 'string',
'ipAddress': 'string',
'macAddress': 'string',
'associatedOn': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
connectorList (list) --
Information about the registered connectors.
(dict) --
Represents a connector.
connectorId (string) --
The ID of the connector.
version (string) --
The connector version.
status (string) --
The status of the connector.
capabilityList (list) --
The capabilities of the connector.
(string) --
vmManagerName (string) --
The name of the VM manager.
vmManagerType (string) --
The VM management product.
vmManagerId (string) --
The ID of the VM manager.
ipAddress (string) --
The IP address of the connector.
macAddress (string) --
The MAC address of the connector.
associatedOn (datetime) --
The time the connector was associated.
nextToken (string) --
The token required to retrieve the next set of results. This value is null when there are no more results to return.
{'apps': {'importedAppId': 'string',
'launchConfigurationStatus': 'NOT_CONFIGURED | CONFIGURED',
'launchStatus': {'PARTIALLY_LAUNCHED'},
'replicationConfigurationStatus': 'NOT_CONFIGURED | CONFIGURED',
'replicationStatus': {'PARTIALLY_REPLICATED'}}}
Retrieves summaries for all applications.
See also: AWS API Documentation
Request Syntax
client.list_apps(
appIds=[
'string',
],
nextToken='string',
maxResults=123
)
list
The unique application IDs.
(string) --
string
The token for the next set of results.
integer
The maximum number of results to return in a single call. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.
dict
Response Syntax
{
'apps': [
{
'appId': 'string',
'importedAppId': 'string',
'name': 'string',
'description': 'string',
'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'DELETE_FAILED',
'statusMessage': 'string',
'replicationConfigurationStatus': 'NOT_CONFIGURED'|'CONFIGURED',
'replicationStatus': 'READY_FOR_CONFIGURATION'|'CONFIGURATION_IN_PROGRESS'|'CONFIGURATION_INVALID'|'READY_FOR_REPLICATION'|'VALIDATION_IN_PROGRESS'|'REPLICATION_PENDING'|'REPLICATION_IN_PROGRESS'|'REPLICATED'|'PARTIALLY_REPLICATED'|'DELTA_REPLICATION_IN_PROGRESS'|'DELTA_REPLICATED'|'DELTA_REPLICATION_FAILED'|'REPLICATION_FAILED'|'REPLICATION_STOPPING'|'REPLICATION_STOP_FAILED'|'REPLICATION_STOPPED',
'replicationStatusMessage': 'string',
'latestReplicationTime': datetime(2015, 1, 1),
'launchConfigurationStatus': 'NOT_CONFIGURED'|'CONFIGURED',
'launchStatus': 'READY_FOR_CONFIGURATION'|'CONFIGURATION_IN_PROGRESS'|'CONFIGURATION_INVALID'|'READY_FOR_LAUNCH'|'VALIDATION_IN_PROGRESS'|'LAUNCH_PENDING'|'LAUNCH_IN_PROGRESS'|'LAUNCHED'|'PARTIALLY_LAUNCHED'|'DELTA_LAUNCH_IN_PROGRESS'|'DELTA_LAUNCH_FAILED'|'LAUNCH_FAILED'|'TERMINATE_IN_PROGRESS'|'TERMINATE_FAILED'|'TERMINATED',
'launchStatusMessage': 'string',
'launchDetails': {
'latestLaunchTime': datetime(2015, 1, 1),
'stackName': 'string',
'stackId': 'string'
},
'creationTime': datetime(2015, 1, 1),
'lastModified': datetime(2015, 1, 1),
'roleName': 'string',
'totalServerGroups': 123,
'totalServers': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
apps (list) --
The application summaries.
(dict) --
Information about the application.
appId (string) --
The unique ID of the application.
importedAppId (string) --
The ID of the application.
name (string) --
The name of the application.
description (string) --
The description of the application.
status (string) --
Status of the application.
statusMessage (string) --
A message related to the status of the application
replicationConfigurationStatus (string) --
Status of the replication configuration.
replicationStatus (string) --
The replication status of the application.
replicationStatusMessage (string) --
A message related to the replication status of the application.
latestReplicationTime (datetime) --
The timestamp of the application's most recent successful replication.
launchConfigurationStatus (string) --
Status of the launch configuration.
launchStatus (string) --
The launch status of the application.
launchStatusMessage (string) --
A message related to the launch status of the application.
launchDetails (dict) --
Details about the latest launch of the application.
latestLaunchTime (datetime) --
The latest time that this application was launched successfully.
stackName (string) --
The name of the latest stack launched for this application.
stackId (string) --
The ID of the latest stack launched for this application.
creationTime (datetime) --
The creation time of the application.
lastModified (datetime) --
The last modified time of the application.
roleName (string) --
The name of the service role in the customer's account used by AWS SMS.
totalServerGroups (integer) --
The number of server groups present in the application.
totalServers (integer) --
The number of servers present in the application.
nextToken (string) --
The token required to retrieve the next set of results. This value is null when there are no more results to return.
{'autoLaunch': 'boolean',
'serverGroupLaunchConfigurations': {'serverLaunchConfigurations': {'configureScript': {'bucket': 'string',
'key': 'string'},
'configureScriptType': 'SHELL_SCRIPT '
'| '
'POWERSHELL_SCRIPT',
'iamInstanceProfileName': 'string'}}}
Creates or updates the launch configuration for the specified application.
See also: AWS API Documentation
Request Syntax
client.put_app_launch_configuration(
appId='string',
roleName='string',
autoLaunch=True|False,
serverGroupLaunchConfigurations=[
{
'serverGroupId': 'string',
'launchOrder': 123,
'serverLaunchConfigurations': [
{
'server': {
'serverId': 'string',
'serverType': 'VIRTUAL_MACHINE',
'vmServer': {
'vmServerAddress': {
'vmManagerId': 'string',
'vmId': 'string'
},
'vmName': 'string',
'vmManagerName': 'string',
'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
'vmPath': 'string'
},
'replicationJobId': 'string',
'replicationJobTerminated': True|False
},
'logicalId': 'string',
'vpc': 'string',
'subnet': 'string',
'securityGroup': 'string',
'ec2KeyName': 'string',
'userData': {
's3Location': {
'bucket': 'string',
'key': 'string'
}
},
'instanceType': 'string',
'associatePublicIpAddress': True|False,
'iamInstanceProfileName': 'string',
'configureScript': {
'bucket': 'string',
'key': 'string'
},
'configureScriptType': 'SHELL_SCRIPT'|'POWERSHELL_SCRIPT'
},
]
},
]
)
string
The ID of the application.
string
The name of service role in the customer's account that AWS CloudFormation uses to launch the application.
boolean
Indicates whether the application is configured to launch automatically after replication is complete.
list
Information about the launch configurations for server groups in the application.
(dict) --
Launch configuration for a server group.
serverGroupId (string) --
The ID of the server group with which the launch configuration is associated.
launchOrder (integer) --
The launch order of servers in the server group.
serverLaunchConfigurations (list) --
The launch configuration for servers in the server group.
(dict) --
Launch configuration for a server.
server (dict) --
The ID of the server with which the launch configuration is associated.
serverId (string) --
The ID of the server.
serverType (string) --
The type of server.
vmServer (dict) --
Information about the VM server.
vmServerAddress (dict) --
The VM server location.
vmManagerId (string) --
The ID of the VM manager.
vmId (string) --
The ID of the VM.
vmName (string) --
The name of the VM.
vmManagerName (string) --
The name of the VM manager.
vmManagerType (string) --
The type of VM management product.
vmPath (string) --
The VM folder path in the vCenter Server virtual machine inventory tree.
replicationJobId (string) --
The ID of the replication job.
replicationJobTerminated (boolean) --
Indicates whether the replication job is deleted or failed.
logicalId (string) --
The logical ID of the server in the AWS CloudFormation template.
vpc (string) --
The ID of the VPC into which the server should be launched.
subnet (string) --
The ID of the subnet the server should be launched into.
securityGroup (string) --
The ID of the security group that applies to the launched server.
ec2KeyName (string) --
The name of the Amazon EC2 SSH key to be used for connecting to the launched server.
userData (dict) --
Location of the user-data script to be executed when launching the server.
s3Location (dict) --
Amazon S3 location of the user-data script.
bucket (string) --
The Amazon S3 bucket name.
key (string) --
The Amazon S3 bucket key.
instanceType (string) --
The instance type to use when launching the server.
associatePublicIpAddress (boolean) --
Indicates whether a publicly accessible IP address is created when launching the server.
iamInstanceProfileName (string) --
The name of the IAM instance profile.
configureScript (dict) --
Location of an Amazon S3 object.
bucket (string) --
The Amazon S3 bucket name.
key (string) --
The Amazon S3 bucket key.
configureScriptType (string) --
The type of configuration script.
dict
Response Syntax
{}
Response Structure
(dict) --
{'appSummary': {'importedAppId': 'string',
'launchConfigurationStatus': 'NOT_CONFIGURED | CONFIGURED',
'launchStatus': {'PARTIALLY_LAUNCHED'},
'replicationConfigurationStatus': 'NOT_CONFIGURED | CONFIGURED',
'replicationStatus': {'PARTIALLY_REPLICATED'}}}
Updates the specified application.
See also: AWS API Documentation
Request Syntax
client.update_app(
appId='string',
name='string',
description='string',
roleName='string',
serverGroups=[
{
'serverGroupId': 'string',
'name': 'string',
'serverList': [
{
'serverId': 'string',
'serverType': 'VIRTUAL_MACHINE',
'vmServer': {
'vmServerAddress': {
'vmManagerId': 'string',
'vmId': 'string'
},
'vmName': 'string',
'vmManagerName': 'string',
'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
'vmPath': 'string'
},
'replicationJobId': 'string',
'replicationJobTerminated': True|False
},
]
},
],
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
The ID of the application.
string
The new name of the application.
string
The new description of the application.
string
The name of the service role in the customer's account used by AWS SMS.
list
The server groups in the application to update.
(dict) --
Logical grouping of servers.
serverGroupId (string) --
The ID of a server group.
name (string) --
The name of a server group.
serverList (list) --
The servers that belong to a server group.
(dict) --
Represents a server.
serverId (string) --
The ID of the server.
serverType (string) --
The type of server.
vmServer (dict) --
Information about the VM server.
vmServerAddress (dict) --
The VM server location.
vmManagerId (string) --
The ID of the VM manager.
vmId (string) --
The ID of the VM.
vmName (string) --
The name of the VM.
vmManagerName (string) --
The name of the VM manager.
vmManagerType (string) --
The type of VM management product.
vmPath (string) --
The VM folder path in the vCenter Server virtual machine inventory tree.
replicationJobId (string) --
The ID of the replication job.
replicationJobTerminated (boolean) --
Indicates whether the replication job is deleted or failed.
list
The tags to associate with the application.
(dict) --
Key/value pair that can be assigned to an application.
key (string) --
The tag key.
value (string) --
The tag value.
dict
Response Syntax
{
'appSummary': {
'appId': 'string',
'importedAppId': 'string',
'name': 'string',
'description': 'string',
'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'DELETED'|'DELETE_FAILED',
'statusMessage': 'string',
'replicationConfigurationStatus': 'NOT_CONFIGURED'|'CONFIGURED',
'replicationStatus': 'READY_FOR_CONFIGURATION'|'CONFIGURATION_IN_PROGRESS'|'CONFIGURATION_INVALID'|'READY_FOR_REPLICATION'|'VALIDATION_IN_PROGRESS'|'REPLICATION_PENDING'|'REPLICATION_IN_PROGRESS'|'REPLICATED'|'PARTIALLY_REPLICATED'|'DELTA_REPLICATION_IN_PROGRESS'|'DELTA_REPLICATED'|'DELTA_REPLICATION_FAILED'|'REPLICATION_FAILED'|'REPLICATION_STOPPING'|'REPLICATION_STOP_FAILED'|'REPLICATION_STOPPED',
'replicationStatusMessage': 'string',
'latestReplicationTime': datetime(2015, 1, 1),
'launchConfigurationStatus': 'NOT_CONFIGURED'|'CONFIGURED',
'launchStatus': 'READY_FOR_CONFIGURATION'|'CONFIGURATION_IN_PROGRESS'|'CONFIGURATION_INVALID'|'READY_FOR_LAUNCH'|'VALIDATION_IN_PROGRESS'|'LAUNCH_PENDING'|'LAUNCH_IN_PROGRESS'|'LAUNCHED'|'PARTIALLY_LAUNCHED'|'DELTA_LAUNCH_IN_PROGRESS'|'DELTA_LAUNCH_FAILED'|'LAUNCH_FAILED'|'TERMINATE_IN_PROGRESS'|'TERMINATE_FAILED'|'TERMINATED',
'launchStatusMessage': 'string',
'launchDetails': {
'latestLaunchTime': datetime(2015, 1, 1),
'stackName': 'string',
'stackId': 'string'
},
'creationTime': datetime(2015, 1, 1),
'lastModified': datetime(2015, 1, 1),
'roleName': 'string',
'totalServerGroups': 123,
'totalServers': 123
},
'serverGroups': [
{
'serverGroupId': 'string',
'name': 'string',
'serverList': [
{
'serverId': 'string',
'serverType': 'VIRTUAL_MACHINE',
'vmServer': {
'vmServerAddress': {
'vmManagerId': 'string',
'vmId': 'string'
},
'vmName': 'string',
'vmManagerName': 'string',
'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
'vmPath': 'string'
},
'replicationJobId': 'string',
'replicationJobTerminated': True|False
},
]
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
(dict) --
appSummary (dict) --
A summary description of the application.
appId (string) --
The unique ID of the application.
importedAppId (string) --
The ID of the application.
name (string) --
The name of the application.
description (string) --
The description of the application.
status (string) --
Status of the application.
statusMessage (string) --
A message related to the status of the application
replicationConfigurationStatus (string) --
Status of the replication configuration.
replicationStatus (string) --
The replication status of the application.
replicationStatusMessage (string) --
A message related to the replication status of the application.
latestReplicationTime (datetime) --
The timestamp of the application's most recent successful replication.
launchConfigurationStatus (string) --
Status of the launch configuration.
launchStatus (string) --
The launch status of the application.
launchStatusMessage (string) --
A message related to the launch status of the application.
launchDetails (dict) --
Details about the latest launch of the application.
latestLaunchTime (datetime) --
The latest time that this application was launched successfully.
stackName (string) --
The name of the latest stack launched for this application.
stackId (string) --
The ID of the latest stack launched for this application.
creationTime (datetime) --
The creation time of the application.
lastModified (datetime) --
The last modified time of the application.
roleName (string) --
The name of the service role in the customer's account used by AWS SMS.
totalServerGroups (integer) --
The number of server groups present in the application.
totalServers (integer) --
The number of servers present in the application.
serverGroups (list) --
The updated server groups in the application.
(dict) --
Logical grouping of servers.
serverGroupId (string) --
The ID of a server group.
name (string) --
The name of a server group.
serverList (list) --
The servers that belong to a server group.
(dict) --
Represents a server.
serverId (string) --
The ID of the server.
serverType (string) --
The type of server.
vmServer (dict) --
Information about the VM server.
vmServerAddress (dict) --
The VM server location.
vmManagerId (string) --
The ID of the VM manager.
vmId (string) --
The ID of the VM.
vmName (string) --
The name of the VM.
vmManagerName (string) --
The name of the VM manager.
vmManagerType (string) --
The type of VM management product.
vmPath (string) --
The VM folder path in the vCenter Server virtual machine inventory tree.
replicationJobId (string) --
The ID of the replication job.
replicationJobTerminated (boolean) --
Indicates whether the replication job is deleted or failed.
tags (list) --
The tags associated with the application.
(dict) --
Key/value pair that can be assigned to an application.
key (string) --
The tag key.
value (string) --
The tag value.