2021/11/17 - Elastic Disaster Recovery Service - 29 new api methods
Changes Introducing AWS Elastic Disaster Recovery (AWS DRS), a new service that minimizes downtime and data loss with fast, reliable recovery of on-premises and cloud-based applications using affordable storage, minimal compute, and point-in-time recovery.
Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state.
See also: AWS API Documentation
Request Syntax
client.retry_data_replication(
sourceServerID='string'
)
string
[REQUIRED]
The ID of the Source Server whose data replication should be retried.
dict
Response Syntax
{
'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',
'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',
'etaDateTime': 'string',
'lagDuration': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'lastLaunchResult': 'NOT_STARTED'|'PENDING'|'SUCCEEDED'|'FAILED',
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastLaunch': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string',
'type': 'RECOVERY'|'DRILL'
}
},
'lastSeenByServiceDateTime': 'string'
},
'recoveryInstanceId': 'string',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': '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'
}
}
Response Structure
(dict) --
arn (string) --
The ARN of the Source Server.
dataReplicationInfo (dict) --
The Data Replication Info of the Source Server.
dataReplicationError (dict) --
Error in data replication.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Information about whether the data replication has been initiated.
nextAttemptDateTime (string) --
The date and time of the next attempt to initiate data replication.
startDateTime (string) --
The date and time of the current attempt to initiate data replication.
steps (list) --
The steps of the current attempt to initiate data replication.
(dict) --
Data replication initiation step.
name (string) --
The name of the step.
status (string) --
The status of the step.
dataReplicationState (string) --
The state of the data replication.
etaDateTime (string) --
An estimate of when the data replication will be completed.
lagDuration (string) --
Data replication lag duration.
replicatedDisks (list) --
The disks that should be replicated.
(dict) --
A disk that should be replicated.
backloggedStorageBytes (integer) --
The size of the replication backlog in bytes.
deviceName (string) --
The name of the device.
replicatedStorageBytes (integer) --
The amount of data replicated so far in bytes.
rescannedStorageBytes (integer) --
The amount of data to be rescanned in bytes.
totalStorageBytes (integer) --
The total amount of data to be replicated in bytes.
lastLaunchResult (string) --
The status of the last recovery launch of this Source Server.
lifeCycle (dict) --
The lifecycle information of this Source Server.
addedToServiceDateTime (string) --
The date and time of when the Source Server was added to the service.
elapsedReplicationDuration (string) --
The amount of time that the Source Server has been replicating for.
firstByteDateTime (string) --
The date and time of the first byte that was replicated from the Source Server.
lastLaunch (dict) --
An object containing information regarding the last launch of the Source Server.
initiated (dict) --
An object containing information regarding the initiation of the last launch of a Source Server.
apiCallDateTime (string) --
The date and time the last Source Server launch was initiated.
jobID (string) --
The ID of the Job that was used to last launch the Source Server.
type (string) --
The Job type that was used to last launch the Source Server.
lastSeenByServiceDateTime (string) --
The date and time this Source Server was last seen by the service.
recoveryInstanceId (string) --
The ID of the Recovery Instance associated with this Source Server.
sourceProperties (dict) --
The source properties of the Source Server.
cpus (list) --
An array of CPUs.
(dict) --
Information about a server's CPU.
cores (integer) --
The number of CPU cores.
modelName (string) --
The model name of the CPU.
disks (list) --
An array of disks.
(dict) --
An object representing a data storage device on a server.
bytes (integer) --
The amount of storage on the disk in bytes.
deviceName (string) --
The disk or device name.
identificationHints (dict) --
Hints used to uniquely identify a machine.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
Fully Qualified Domain Name identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vCenter VM path identification hint.
lastUpdatedDateTime (string) --
The date and time the Source Properties were last updated on.
networkInterfaces (list) --
An array of network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Whether this is the primary network interface.
macAddress (string) --
The MAC address of the network interface.
os (dict) --
Operating system.
fullString (string) --
The long name of the Operating System.
ramBytes (integer) --
The amount of RAM in bytes.
recommendedInstanceType (string) --
The recommended EC2 instance type that will be used when recovering the Source Server.
sourceServerID (string) --
The ID of the Source Server.
tags (dict) --
The tags associated with the Source Server.
(string) --
(string) --
Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
See also: AWS API Documentation
Request Syntax
client.describe_replication_configuration_templates(
maxResults=123,
nextToken='string',
replicationConfigurationTemplateIDs=[
'string',
]
)
integer
Maximum number of Replication Configuration Templates to retrieve.
string
The token of the next Replication Configuration Template to retrieve.
list
[REQUIRED]
The IDs of the Replication Configuration Templates to retrieve. An empty list means all Replication Configuration Templates.
(string) --
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'GP3'|'ST1',
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'pitPolicy': [
{
'enabled': True|False,
'interval': 123,
'retentionDuration': 123,
'ruleID': 123,
'units': 'MINUTE'|'HOUR'|'DAY'
},
],
'replicationConfigurationTemplateID': 'string',
'replicationServerInstanceType': 'string',
'replicationServersSecurityGroupsIDs': [
'string',
],
'stagingAreaSubnetId': 'string',
'stagingAreaTags': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'useDedicatedReplicationServer': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
An array of Replication Configuration Templates.
(dict) --
arn (string) --
The Replication Configuration Template ARN.
associateDefaultSecurityGroup (boolean) --
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
bandwidthThrottling (integer) --
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
createPublicIP (boolean) --
Whether to create a Public IP for the Recovery Instance by default.
dataPlaneRouting (string) --
The data plane routing mechanism that will be used for replication.
defaultLargeStagingDiskType (string) --
The Staging Disk EBS volume type to be used during replication.
ebsEncryption (string) --
The type of EBS encryption to be used during replication.
ebsEncryptionKeyArn (string) --
The ARN of the EBS encryption key to be used during replication.
pitPolicy (list) --
The Point in time (PIT) policy to manage snapshots taken during replication.
(dict) --
A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.
enabled (boolean) --
Whether this rule is enabled or not.
interval (integer) --
How often, in the chosen units, a snapshot should be taken.
retentionDuration (integer) --
The duration to retain a snapshot for, in the chosen units.
ruleID (integer) --
The ID of the rule.
units (string) --
The units used to measure the interval and retentionDuration.
replicationConfigurationTemplateID (string) --
The Replication Configuration Template ID.
replicationServerInstanceType (string) --
The instance type to be used for the replication server.
replicationServersSecurityGroupsIDs (list) --
The security group IDs that will be used by the replication server.
(string) --
stagingAreaSubnetId (string) --
The subnet to be used by the replication staging area.
stagingAreaTags (dict) --
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
(string) --
(string) --
tags (dict) --
A set of tags to be associated with the Replication Configuration Template resource.
(string) --
(string) --
useDedicatedReplicationServer (boolean) --
Whether to use a dedicated Replication Server in the replication staging area.
nextToken (string) --
The token of the next Replication Configuration Template to retrieve.
Gets a LaunchConfiguration, filtered by Source Server IDs.
See also: AWS API Documentation
Request Syntax
client.get_launch_configuration(
sourceServerID='string'
)
string
[REQUIRED]
The ID of the Source Server that we want to retrieve a Launch Configuration for.
dict
Response Syntax
{
'copyPrivateIp': True|False,
'copyTags': True|False,
'ec2LaunchTemplateID': 'string',
'launchDisposition': 'STOPPED'|'STARTED',
'licensing': {
'osByol': True|False
},
'name': 'string',
'sourceServerID': 'string',
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'
}
Response Structure
(dict) --
copyPrivateIp (boolean) --
Whether we should copy the Private IP of the Source Server to the Recovery Instance.
copyTags (boolean) --
Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.
ec2LaunchTemplateID (string) --
The EC2 launch template ID of this launch configuration.
launchDisposition (string) --
The state of the Recovery Instance in EC2 after the recovery operation.
licensing (dict) --
The licensing configuration to be used for this launch configuration.
osByol (boolean) --
Whether to enable "Bring your own license" or not.
name (string) --
The name of the launch configuration.
sourceServerID (string) --
The ID of the Source Server for this launch configuration.
targetInstanceTypeRightSizingMethod (string) --
Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.
Lists all Recovery Instances or multiple Recovery Instances by ID.
See also: AWS API Documentation
Request Syntax
client.describe_recovery_instances(
filters={
'recoveryInstanceIDs': [
'string',
],
'sourceServerIDs': [
'string',
]
},
maxResults=123,
nextToken='string'
)
dict
[REQUIRED]
A set of filters by which to return Recovery Instances.
recoveryInstanceIDs (list) --
An array of Recovery Instance IDs that should be returned. An empty array means all Recovery Instances.
(string) --
sourceServerIDs (list) --
An array of Source Server IDs for which associated Recovery Instances should be returned.
(string) --
integer
Maximum number of Recovery Instances to retrieve.
string
The token of the next Recovery Instance to retrieve.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'dataReplicationInfo': {
'dataReplicationError': {
'error': 'AGENT_NOT_SEEN'|'FAILBACK_CLIENT_NOT_SEEN'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT'|'FAILED_TO_CONFIGURE_REPLICATION_SOFTWARE'|'FAILED_TO_PAIR_AGENT_WITH_REPLICATION_SOFTWARE'|'FAILED_TO_ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION',
'rawError': 'string'
},
'dataReplicationInitiation': {
'startDateTime': 'string',
'steps': [
{
'name': 'LINK_FAILBACK_CLIENT_WITH_RECOVERY_INSTANCE'|'COMPLETE_VOLUME_MAPPING'|'ESTABLISH_RECOVERY_INSTANCE_COMMUNICATION'|'DOWNLOAD_REPLICATION_SOFTWARE_TO_FAILBACK_CLIENT'|'CONFIGURE_REPLICATION_SOFTWARE'|'PAIR_AGENT_WITH_REPLICATION_SOFTWARE'|'ESTABLISH_AGENT_REPLICATOR_SOFTWARE_COMMUNICATION',
'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
},
]
},
'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED',
'etaDateTime': 'string',
'lagDuration': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'ec2InstanceID': 'string',
'ec2InstanceState': 'PENDING'|'RUNNING'|'STOPPING'|'STOPPED'|'SHUTTING-DOWN'|'TERMINATED'|'NOT_FOUND',
'failback': {
'agentLastSeenByServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'failbackClientID': 'string',
'failbackClientLastSeenByServiceDateTime': 'string',
'failbackInitiationTime': 'string',
'failbackJobID': 'string',
'failbackToOriginalServer': True|False,
'firstByteDateTime': 'string',
'state': 'FAILBACK_NOT_STARTED'|'FAILBACK_IN_PROGRESS'|'FAILBACK_READY_FOR_LAUNCH'|'FAILBACK_COMPLETED'|'FAILBACK_ERROR'
},
'isDrill': True|False,
'jobID': 'string',
'pointInTimeSnapshotDateTime': 'string',
'recoveryInstanceID': 'string',
'recoveryInstanceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'ebsVolumeID': 'string',
'internalDeviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': 'string',
'vmWareUuid': 'string'
},
'lastUpdatedDateTime': 'string',
'networkInterfaces': [
{
'ips': [
'string',
],
'isPrimary': True|False,
'macAddress': 'string'
},
],
'os': {
'fullString': 'string'
},
'ramBytes': 123
},
'sourceServerID': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
An array of Recovery Instances.
(dict) --
A Recovery Instance is a replica of a Source Server running on EC2.
arn (string) --
The ARN of the Recovery Instance.
dataReplicationInfo (dict) --
The Data Replication Info of the Recovery Instance.
dataReplicationError (dict) --
Information about Data Replication
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Information about whether the data replication has been initiated.
startDateTime (string) --
The date and time of the current attempt to initiate data replication.
steps (list) --
The steps of the current attempt to initiate data replication.
(dict) --
Data replication initiation step.
name (string) --
The name of the step.
status (string) --
The status of the step.
dataReplicationState (string) --
The state of the data replication.
etaDateTime (string) --
An estimate of when the data replication will be completed.
lagDuration (string) --
Data replication lag duration.
replicatedDisks (list) --
The disks that should be replicated.
(dict) --
A disk that should be replicated.
backloggedStorageBytes (integer) --
The size of the replication backlog in bytes.
deviceName (string) --
The name of the device.
replicatedStorageBytes (integer) --
The amount of data replicated so far in bytes.
rescannedStorageBytes (integer) --
The amount of data to be rescanned in bytes.
totalStorageBytes (integer) --
The total amount of data to be replicated in bytes.
ec2InstanceID (string) --
The EC2 instance ID of the Recovery Instance.
ec2InstanceState (string) --
The state of the EC2 instance for this Recovery Instance.
failback (dict) --
An object representing failback related information of the Recovery Instance.
agentLastSeenByServiceDateTime (string) --
The date and time the agent on the Recovery Instance was last seen by the service.
elapsedReplicationDuration (string) --
The amount of time that the Recovery Instance has been replicating for.
failbackClientID (string) --
The ID of the failback client that this Recovery Instance is associated with.
failbackClientLastSeenByServiceDateTime (string) --
The date and time that the failback client was last seen by the service.
failbackInitiationTime (string) --
The date and time that the failback initiation started.
failbackJobID (string) --
The Job ID of the last failback log for this Recovery Instance.
failbackToOriginalServer (boolean) --
Whether we are failing back to the original Source Server for this Recovery Instance.
firstByteDateTime (string) --
The date and time of the first byte that was replicated from the Recovery Instance.
state (string) --
The state of the failback process that this Recovery Instance is in.
isDrill (boolean) --
Whether this Recovery Instance was created for a drill or for an actual Recovery event.
jobID (string) --
The ID of the Job that created the Recovery Instance.
pointInTimeSnapshotDateTime (string) --
The date and time of the Point in Time (PIT) snapshot that this Recovery Instance was launched from.
recoveryInstanceID (string) --
The ID of the Recovery Instance.
recoveryInstanceProperties (dict) --
Properties of the Recovery Instance machine.
cpus (list) --
An array of CPUs.
(dict) --
Information about a server's CPU.
cores (integer) --
The number of CPU cores.
modelName (string) --
The model name of the CPU.
disks (list) --
An array of disks.
(dict) --
An object representing a block storage device on the Recovery Instance.
bytes (integer) --
The amount of storage on the disk in bytes.
ebsVolumeID (string) --
The EBS Volume ID of this disk.
internalDeviceName (string) --
The internal device name of this disk. This is the name that is visible on the machine itself and not from the EC2 console.
identificationHints (dict) --
Hints used to uniquely identify a machine.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
Fully Qualified Domain Name identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vCenter VM path identification hint.
lastUpdatedDateTime (string) --
The date and time the Recovery Instance properties were last updated on.
networkInterfaces (list) --
An array of network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Whether this is the primary network interface.
macAddress (string) --
The MAC address of the network interface.
os (dict) --
Operating system.
fullString (string) --
The long name of the Operating System.
ramBytes (integer) --
The amount of RAM in bytes.
sourceServerID (string) --
The Source Server ID that this Recovery Instance is associated with.
tags (dict) --
An array of tags that are associated with the Recovery Instance.
(string) --
(string) --
nextToken (string) --
The token of the next Recovery Instance to retrieve.
Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.
See also: AWS API Documentation
Request Syntax
client.get_failback_replication_configuration(
recoveryInstanceID='string'
)
string
[REQUIRED]
The ID of the Recovery Instance whose failback replication configuration should be returned.
dict
Response Syntax
{
'bandwidthThrottling': 123,
'name': 'string',
'recoveryInstanceID': 'string',
'usePrivateIP': True|False
}
Response Structure
(dict) --
bandwidthThrottling (integer) --
Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.
name (string) --
The name of the Failback Replication Configuration.
recoveryInstanceID (string) --
The ID of the Recovery Instance.
usePrivateIP (boolean) --
Whether to use Private IP for the failback replication of the Recovery Instance.
Initiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery service.
See also: AWS API Documentation
Request Syntax
client.terminate_recovery_instances(
recoveryInstanceIDs=[
'string',
]
)
list
[REQUIRED]
The IDs of the Recovery Instances that should be terminated.
(string) --
dict
Response Syntax
{
'job': {
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_RECOVERY'|'START_DRILL'|'FAILBACK'|'DIAGNOSTIC'|'TERMINATE_RECOVERY_INSTANCES',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'recoveryInstanceID': 'string',
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
}
}
Response Structure
(dict) --
job (dict) --
The Job for terminating the Recovery Instances.
arn (string) --
The ARN of a Job.
creationDateTime (string) --
The date and time of when the Job was created.
endDateTime (string) --
The date and time of when the Job ended.
initiatedBy (string) --
A string representing who initiated the Job.
jobID (string) --
The ID of the Job.
participatingServers (list) --
A list of servers that the Job is acting upon.
(dict) --
Represents a server participating in an asynchronous Job.
launchStatus (string) --
The launch status of a participating server.
recoveryInstanceID (string) --
The Recovery Instance ID of a participating server.
sourceServerID (string) --
The Source Server ID of a participating server.
status (string) --
The status of the Job.
tags (dict) --
A list of tags associated with the Job.
(string) --
(string) --
type (string) --
The type of the Job.
Deletes a single Source Server by ID. The Source Server must be disconnected first.
See also: AWS API Documentation
Request Syntax
client.delete_source_server(
sourceServerID='string'
)
string
[REQUIRED]
The ID of the Source Server to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the Recovery Instance 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_recovery_instance(
recoveryInstanceID='string'
)
string
[REQUIRED]
The ID of the Recovery Instance to disconnect.
None
Creates a new ReplicationConfigurationTemplate.
See also: AWS API Documentation
Request Syntax
client.create_replication_configuration_template(
associateDefaultSecurityGroup=True|False,
bandwidthThrottling=123,
createPublicIP=True|False,
dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP',
defaultLargeStagingDiskType='GP2'|'GP3'|'ST1',
ebsEncryption='DEFAULT'|'CUSTOM',
ebsEncryptionKeyArn='string',
pitPolicy=[
{
'enabled': True|False,
'interval': 123,
'retentionDuration': 123,
'ruleID': 123,
'units': 'MINUTE'|'HOUR'|'DAY'
},
],
replicationServerInstanceType='string',
replicationServersSecurityGroupsIDs=[
'string',
],
stagingAreaSubnetId='string',
stagingAreaTags={
'string': 'string'
},
tags={
'string': 'string'
},
useDedicatedReplicationServer=True|False
)
boolean
[REQUIRED]
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
integer
[REQUIRED]
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
boolean
[REQUIRED]
Whether to create a Public IP for the Recovery Instance by default.
string
[REQUIRED]
The data plane routing mechanism that will be used for replication.
string
[REQUIRED]
The Staging Disk EBS volume type to be used during replication.
string
[REQUIRED]
The type of EBS encryption to be used during replication.
string
The ARN of the EBS encryption key to be used during replication.
list
[REQUIRED]
The Point in time (PIT) policy to manage snapshots taken during replication.
(dict) --
A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.
enabled (boolean) --
Whether this rule is enabled or not.
interval (integer) -- [REQUIRED]
How often, in the chosen units, a snapshot should be taken.
retentionDuration (integer) -- [REQUIRED]
The duration to retain a snapshot for, in the chosen units.
ruleID (integer) --
The ID of the rule.
units (string) -- [REQUIRED]
The units used to measure the interval and retentionDuration.
string
[REQUIRED]
The instance type to be used for the replication server.
list
[REQUIRED]
The security group IDs that will be used by the replication server.
(string) --
string
[REQUIRED]
The subnet to be used by the replication staging area.
dict
[REQUIRED]
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
(string) --
(string) --
dict
A set of tags to be associated with the Replication Configuration Template resource.
(string) --
(string) --
boolean
[REQUIRED]
Whether to use a dedicated Replication Server in the replication staging area.
dict
Response Syntax
{
'arn': 'string',
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'GP3'|'ST1',
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'pitPolicy': [
{
'enabled': True|False,
'interval': 123,
'retentionDuration': 123,
'ruleID': 123,
'units': 'MINUTE'|'HOUR'|'DAY'
},
],
'replicationConfigurationTemplateID': 'string',
'replicationServerInstanceType': 'string',
'replicationServersSecurityGroupsIDs': [
'string',
],
'stagingAreaSubnetId': 'string',
'stagingAreaTags': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'useDedicatedReplicationServer': True|False
}
Response Structure
(dict) --
arn (string) --
The Replication Configuration Template ARN.
associateDefaultSecurityGroup (boolean) --
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
bandwidthThrottling (integer) --
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
createPublicIP (boolean) --
Whether to create a Public IP for the Recovery Instance by default.
dataPlaneRouting (string) --
The data plane routing mechanism that will be used for replication.
defaultLargeStagingDiskType (string) --
The Staging Disk EBS volume type to be used during replication.
ebsEncryption (string) --
The type of EBS encryption to be used during replication.
ebsEncryptionKeyArn (string) --
The ARN of the EBS encryption key to be used during replication.
pitPolicy (list) --
The Point in time (PIT) policy to manage snapshots taken during replication.
(dict) --
A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.
enabled (boolean) --
Whether this rule is enabled or not.
interval (integer) --
How often, in the chosen units, a snapshot should be taken.
retentionDuration (integer) --
The duration to retain a snapshot for, in the chosen units.
ruleID (integer) --
The ID of the rule.
units (string) --
The units used to measure the interval and retentionDuration.
replicationConfigurationTemplateID (string) --
The Replication Configuration Template ID.
replicationServerInstanceType (string) --
The instance type to be used for the replication server.
replicationServersSecurityGroupsIDs (list) --
The security group IDs that will be used by the replication server.
(string) --
stagingAreaSubnetId (string) --
The subnet to be used by the replication staging area.
stagingAreaTags (dict) --
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
(string) --
(string) --
tags (dict) --
A set of tags to be associated with the Replication Configuration Template resource.
(string) --
(string) --
useDedicatedReplicationServer (boolean) --
Whether to use a dedicated Replication Server in the replication staging area.
Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot.
See also: AWS API Documentation
Request Syntax
client.start_recovery(
isDrill=True|False,
sourceServers=[
{
'recoverySnapshotID': 'string',
'sourceServerID': 'string'
},
],
tags={
'string': 'string'
}
)
boolean
Whether this Source Server Recovery operation is a drill or not.
list
[REQUIRED]
The Source Servers that we want to start a Recovery Job for.
(dict) --
An object representing the Source Server to recover.
recoverySnapshotID (string) --
The ID of a Recovery Snapshot we want to recover from. Omit this field to launch from the latest data by taking an on-demand snapshot.
sourceServerID (string) -- [REQUIRED]
The ID of the Source Server you want to recover.
dict
The tags to be associated with the Recovery Job.
(string) --
(string) --
dict
Response Syntax
{
'job': {
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_RECOVERY'|'START_DRILL'|'FAILBACK'|'DIAGNOSTIC'|'TERMINATE_RECOVERY_INSTANCES',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'recoveryInstanceID': 'string',
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
}
}
Response Structure
(dict) --
job (dict) --
The Recovery Job.
arn (string) --
The ARN of a Job.
creationDateTime (string) --
The date and time of when the Job was created.
endDateTime (string) --
The date and time of when the Job ended.
initiatedBy (string) --
A string representing who initiated the Job.
jobID (string) --
The ID of the Job.
participatingServers (list) --
A list of servers that the Job is acting upon.
(dict) --
Represents a server participating in an asynchronous Job.
launchStatus (string) --
The launch status of a participating server.
recoveryInstanceID (string) --
The Recovery Instance ID of a participating server.
sourceServerID (string) --
The Source Server ID of a participating server.
status (string) --
The status of the Job.
tags (dict) --
A list of tags associated with the Job.
(string) --
(string) --
type (string) --
The type of the Job.
Stops the failback process for a specified Recovery Instance. This changes the Failback State of the Recovery Instance back to FAILBACK_NOT_STARTED.
See also: AWS API Documentation
Request Syntax
client.stop_failback(
recoveryInstanceID='string'
)
string
[REQUIRED]
The ID of the Recovery Instance we want to stop failback for.
None
Updates a ReplicationConfigurationTemplate by ID.
See also: AWS API Documentation
Request Syntax
client.update_replication_configuration_template(
arn='string',
associateDefaultSecurityGroup=True|False,
bandwidthThrottling=123,
createPublicIP=True|False,
dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP',
defaultLargeStagingDiskType='GP2'|'GP3'|'ST1',
ebsEncryption='DEFAULT'|'CUSTOM',
ebsEncryptionKeyArn='string',
pitPolicy=[
{
'enabled': True|False,
'interval': 123,
'retentionDuration': 123,
'ruleID': 123,
'units': 'MINUTE'|'HOUR'|'DAY'
},
],
replicationConfigurationTemplateID='string',
replicationServerInstanceType='string',
replicationServersSecurityGroupsIDs=[
'string',
],
stagingAreaSubnetId='string',
stagingAreaTags={
'string': 'string'
},
useDedicatedReplicationServer=True|False
)
string
The Replication Configuration Template ARN.
boolean
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
integer
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
boolean
Whether to create a Public IP for the Recovery Instance by default.
string
The data plane routing mechanism that will be used for replication.
string
The Staging Disk EBS volume type to be used during replication.
string
The type of EBS encryption to be used during replication.
string
The ARN of the EBS encryption key to be used during replication.
list
The Point in time (PIT) policy to manage snapshots taken during replication.
(dict) --
A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.
enabled (boolean) --
Whether this rule is enabled or not.
interval (integer) -- [REQUIRED]
How often, in the chosen units, a snapshot should be taken.
retentionDuration (integer) -- [REQUIRED]
The duration to retain a snapshot for, in the chosen units.
ruleID (integer) --
The ID of the rule.
units (string) -- [REQUIRED]
The units used to measure the interval and retentionDuration.
string
[REQUIRED]
The Replication Configuration Template ID.
string
The instance type to be used for the replication server.
list
The security group IDs that will be used by the replication server.
(string) --
string
The subnet to be used by the replication staging area.
dict
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
(string) --
(string) --
boolean
Whether to use a dedicated Replication Server in the replication staging area.
dict
Response Syntax
{
'arn': 'string',
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'GP3'|'ST1',
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'pitPolicy': [
{
'enabled': True|False,
'interval': 123,
'retentionDuration': 123,
'ruleID': 123,
'units': 'MINUTE'|'HOUR'|'DAY'
},
],
'replicationConfigurationTemplateID': 'string',
'replicationServerInstanceType': 'string',
'replicationServersSecurityGroupsIDs': [
'string',
],
'stagingAreaSubnetId': 'string',
'stagingAreaTags': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'useDedicatedReplicationServer': True|False
}
Response Structure
(dict) --
arn (string) --
The Replication Configuration Template ARN.
associateDefaultSecurityGroup (boolean) --
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
bandwidthThrottling (integer) --
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
createPublicIP (boolean) --
Whether to create a Public IP for the Recovery Instance by default.
dataPlaneRouting (string) --
The data plane routing mechanism that will be used for replication.
defaultLargeStagingDiskType (string) --
The Staging Disk EBS volume type to be used during replication.
ebsEncryption (string) --
The type of EBS encryption to be used during replication.
ebsEncryptionKeyArn (string) --
The ARN of the EBS encryption key to be used during replication.
pitPolicy (list) --
The Point in time (PIT) policy to manage snapshots taken during replication.
(dict) --
A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.
enabled (boolean) --
Whether this rule is enabled or not.
interval (integer) --
How often, in the chosen units, a snapshot should be taken.
retentionDuration (integer) --
The duration to retain a snapshot for, in the chosen units.
ruleID (integer) --
The ID of the rule.
units (string) --
The units used to measure the interval and retentionDuration.
replicationConfigurationTemplateID (string) --
The Replication Configuration Template ID.
replicationServerInstanceType (string) --
The instance type to be used for the replication server.
replicationServersSecurityGroupsIDs (list) --
The security group IDs that will be used by the replication server.
(string) --
stagingAreaSubnetId (string) --
The subnet to be used by the replication staging area.
stagingAreaTags (dict) --
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
(string) --
(string) --
tags (dict) --
A set of tags to be associated with the Replication Configuration Template resource.
(string) --
(string) --
useDedicatedReplicationServer (boolean) --
Whether to use a dedicated Replication Server in the replication staging area.
Retrieves a detailed Job log with pagination.
See also: AWS API Documentation
Request Syntax
client.describe_job_log_items(
jobID='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The ID of the Job for which Job log items will be retrieved.
integer
Maximum number of Job log items to retrieve.
string
The token of the next Job log items to retrieve.
dict
Response Syntax
{
'items': [
{
'event': 'JOB_START'|'SERVER_SKIPPED'|'CLEANUP_START'|'CLEANUP_END'|'CLEANUP_FAIL'|'SNAPSHOT_START'|'SNAPSHOT_END'|'SNAPSHOT_FAIL'|'USING_PREVIOUS_SNAPSHOT'|'USING_PREVIOUS_SNAPSHOT_FAILED'|'CONVERSION_START'|'CONVERSION_END'|'CONVERSION_FAIL'|'LAUNCH_START'|'LAUNCH_FAILED'|'JOB_CANCEL'|'JOB_END',
'eventData': {
'conversionServerID': 'string',
'rawError': 'string',
'sourceServerID': 'string',
'targetInstanceID': 'string'
},
'logDateTime': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
An array of Job log items.
(dict) --
A log outputted by a Job.
event (string) --
The event represents the type of a log.
eventData (dict) --
Metadata associated with a Job log.
conversionServerID (string) --
The ID of a conversion server.
rawError (string) --
A string representing a job error.
sourceServerID (string) --
The ID of a Source Server.
targetInstanceID (string) --
The ID of a Recovery Instance.
logDateTime (string) --
The date and time the log was taken.
nextToken (string) --
The token of the next Job log items to retrieve.
Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
ARN of the resource for which tags are to be removed.
list
[REQUIRED]
Array of tags to be removed.
(string) --
None
Deletes a single Replication Configuration Template by ID
See also: AWS API Documentation
Request Syntax
client.delete_replication_configuration_template(
replicationConfigurationTemplateID='string'
)
string
[REQUIRED]
The ID of the Replication Configuration Template to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch 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
[REQUIRED]
A set of filters by which to return Jobs.
fromDate (string) --
The start date in a date range query.
jobIDs (list) --
An array of Job IDs that should be returned. An empty array means all jobs.
(string) --
toDate (string) --
The end date in a date range query.
integer
Maximum number of Jobs to retrieve.
string
The token of the next Job to retrieve.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_RECOVERY'|'START_DRILL'|'FAILBACK'|'DIAGNOSTIC'|'TERMINATE_RECOVERY_INSTANCES',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'recoveryInstanceID': 'string',
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
An array of Jobs.
(dict) --
A job is an asynchronous workflow.
arn (string) --
The ARN of a Job.
creationDateTime (string) --
The date and time of when the Job was created.
endDateTime (string) --
The date and time of when the Job ended.
initiatedBy (string) --
A string representing who initiated the Job.
jobID (string) --
The ID of the Job.
participatingServers (list) --
A list of servers that the Job is acting upon.
(dict) --
Represents a server participating in an asynchronous Job.
launchStatus (string) --
The launch status of a participating server.
recoveryInstanceID (string) --
The Recovery Instance ID of a participating server.
sourceServerID (string) --
The Source Server ID of a participating server.
status (string) --
The status of the Job.
tags (dict) --
A list of tags associated with the Job.
(string) --
(string) --
type (string) --
The type of the Job.
nextToken (string) --
The token of the next Job to retrieve.
Updates a LaunchConfiguration by Source Server ID.
See also: AWS API Documentation
Request Syntax
client.update_launch_configuration(
copyPrivateIp=True|False,
copyTags=True|False,
launchDisposition='STOPPED'|'STARTED',
licensing={
'osByol': True|False
},
name='string',
sourceServerID='string',
targetInstanceTypeRightSizingMethod='NONE'|'BASIC'
)
boolean
Whether we should copy the Private IP of the Source Server to the Recovery Instance.
boolean
Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.
string
The state of the Recovery Instance in EC2 after the recovery operation.
dict
The licensing configuration to be used for this launch configuration.
osByol (boolean) --
Whether to enable "Bring your own license" or not.
string
The name of the launch configuration.
string
[REQUIRED]
The ID of the Source Server that we want to retrieve a Launch Configuration for.
string
Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.
dict
Response Syntax
{
'copyPrivateIp': True|False,
'copyTags': True|False,
'ec2LaunchTemplateID': 'string',
'launchDisposition': 'STOPPED'|'STARTED',
'licensing': {
'osByol': True|False
},
'name': 'string',
'sourceServerID': 'string',
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'
}
Response Structure
(dict) --
copyPrivateIp (boolean) --
Whether we should copy the Private IP of the Source Server to the Recovery Instance.
copyTags (boolean) --
Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.
ec2LaunchTemplateID (string) --
The EC2 launch template ID of this launch configuration.
launchDisposition (string) --
The state of the Recovery Instance in EC2 after the recovery operation.
licensing (dict) --
The licensing configuration to be used for this launch configuration.
osByol (boolean) --
Whether to enable "Bring your own license" or not.
name (string) --
The name of the launch configuration.
sourceServerID (string) --
The ID of the Source Server for this launch configuration.
targetInstanceTypeRightSizingMethod (string) --
Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.
Allows you to update the failback replication configuration of a Recovery Instance by ID.
See also: AWS API Documentation
Request Syntax
client.update_failback_replication_configuration(
bandwidthThrottling=123,
name='string',
recoveryInstanceID='string',
usePrivateIP=True|False
)
integer
Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.
string
The name of the Failback Replication Configuration.
string
[REQUIRED]
The ID of the Recovery Instance.
boolean
Whether to use Private IP for the failback replication of the Recovery Instance.
None
Deletes a single Job by ID.
See also: AWS API Documentation
Request Syntax
client.delete_job(
jobID='string'
)
string
[REQUIRED]
The ID of the Job to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --
Allows you to update a ReplicationConfiguration by Source Server ID.
See also: AWS API Documentation
Request Syntax
client.update_replication_configuration(
associateDefaultSecurityGroup=True|False,
bandwidthThrottling=123,
createPublicIP=True|False,
dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP',
defaultLargeStagingDiskType='GP2'|'GP3'|'ST1',
ebsEncryption='DEFAULT'|'CUSTOM',
ebsEncryptionKeyArn='string',
name='string',
pitPolicy=[
{
'enabled': True|False,
'interval': 123,
'retentionDuration': 123,
'ruleID': 123,
'units': 'MINUTE'|'HOUR'|'DAY'
},
],
replicatedDisks=[
{
'deviceName': 'string',
'iops': 123,
'isBootDisk': True|False,
'stagingDiskType': 'AUTO'|'GP2'|'GP3'|'IO1'|'SC1'|'ST1'|'STANDARD',
'throughput': 123
},
],
replicationServerInstanceType='string',
replicationServersSecurityGroupsIDs=[
'string',
],
sourceServerID='string',
stagingAreaSubnetId='string',
stagingAreaTags={
'string': 'string'
},
useDedicatedReplicationServer=True|False
)
boolean
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
integer
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
boolean
Whether to create a Public IP for the Recovery Instance by default.
string
The data plane routing mechanism that will be used for replication.
string
The Staging Disk EBS volume type to be used during replication.
string
The type of EBS encryption to be used during replication.
string
The ARN of the EBS encryption key to be used during replication.
string
The name of the Replication Configuration.
list
The Point in time (PIT) policy to manage snapshots taken during replication.
(dict) --
A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.
enabled (boolean) --
Whether this rule is enabled or not.
interval (integer) -- [REQUIRED]
How often, in the chosen units, a snapshot should be taken.
retentionDuration (integer) -- [REQUIRED]
The duration to retain a snapshot for, in the chosen units.
ruleID (integer) --
The ID of the rule.
units (string) -- [REQUIRED]
The units used to measure the interval and retentionDuration.
list
The configuration of the disks of the Source Server to be replicated.
(dict) --
The configuration of a disk of the Source Server to be replicated.
deviceName (string) --
The name of the device.
iops (integer) --
The requested number of I/O operations per second (IOPS).
isBootDisk (boolean) --
Whether to boot from this disk or not.
stagingDiskType (string) --
The Staging Disk EBS volume type to be used during replication.
throughput (integer) --
The throughput to use for the EBS volume in MiB/s. This parameter is valid only for gp3 volumes.
string
The instance type to be used for the replication server.
list
The security group IDs that will be used by the replication server.
(string) --
string
[REQUIRED]
The ID of the Source Server for this Replication Configuration.
string
The subnet to be used by the replication staging area.
dict
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
(string) --
(string) --
boolean
Whether to use a dedicated Replication Server in the replication staging area.
dict
Response Syntax
{
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'GP3'|'ST1',
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'name': 'string',
'pitPolicy': [
{
'enabled': True|False,
'interval': 123,
'retentionDuration': 123,
'ruleID': 123,
'units': 'MINUTE'|'HOUR'|'DAY'
},
],
'replicatedDisks': [
{
'deviceName': 'string',
'iops': 123,
'isBootDisk': True|False,
'stagingDiskType': 'AUTO'|'GP2'|'GP3'|'IO1'|'SC1'|'ST1'|'STANDARD',
'throughput': 123
},
],
'replicationServerInstanceType': 'string',
'replicationServersSecurityGroupsIDs': [
'string',
],
'sourceServerID': 'string',
'stagingAreaSubnetId': 'string',
'stagingAreaTags': {
'string': 'string'
},
'useDedicatedReplicationServer': True|False
}
Response Structure
(dict) --
associateDefaultSecurityGroup (boolean) --
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
bandwidthThrottling (integer) --
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
createPublicIP (boolean) --
Whether to create a Public IP for the Recovery Instance by default.
dataPlaneRouting (string) --
The data plane routing mechanism that will be used for replication.
defaultLargeStagingDiskType (string) --
The Staging Disk EBS volume type to be used during replication.
ebsEncryption (string) --
The type of EBS encryption to be used during replication.
ebsEncryptionKeyArn (string) --
The ARN of the EBS encryption key to be used during replication.
name (string) --
The name of the Replication Configuration.
pitPolicy (list) --
The Point in time (PIT) policy to manage snapshots taken during replication.
(dict) --
A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.
enabled (boolean) --
Whether this rule is enabled or not.
interval (integer) --
How often, in the chosen units, a snapshot should be taken.
retentionDuration (integer) --
The duration to retain a snapshot for, in the chosen units.
ruleID (integer) --
The ID of the rule.
units (string) --
The units used to measure the interval and retentionDuration.
replicatedDisks (list) --
The configuration of the disks of the Source Server to be replicated.
(dict) --
The configuration of a disk of the Source Server to be replicated.
deviceName (string) --
The name of the device.
iops (integer) --
The requested number of I/O operations per second (IOPS).
isBootDisk (boolean) --
Whether to boot from this disk or not.
stagingDiskType (string) --
The Staging Disk EBS volume type to be used during replication.
throughput (integer) --
The throughput to use for the EBS volume in MiB/s. This parameter is valid only for gp3 volumes.
replicationServerInstanceType (string) --
The instance type to be used for the replication server.
replicationServersSecurityGroupsIDs (list) --
The security group IDs that will be used by the replication server.
(string) --
sourceServerID (string) --
The ID of the Source Server for this Replication Configuration.
stagingAreaSubnetId (string) --
The subnet to be used by the replication staging area.
stagingAreaTags (dict) --
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
(string) --
(string) --
useDedicatedReplicationServer (boolean) --
Whether to use a dedicated Replication Server in the replication staging area.
Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client and will reboot your machine, thus completing the failback process.
See also: AWS API Documentation
Request Syntax
client.start_failback_launch(
recoveryInstanceIDs=[
'string',
],
tags={
'string': 'string'
}
)
list
[REQUIRED]
The IDs of the Recovery Instance whose failback launch we want to request.
(string) --
dict
The tags to be associated with the failback launch Job.
(string) --
(string) --
dict
Response Syntax
{
'job': {
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_RECOVERY'|'START_DRILL'|'FAILBACK'|'DIAGNOSTIC'|'TERMINATE_RECOVERY_INSTANCES',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'recoveryInstanceID': 'string',
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'
}
}
Response Structure
(dict) --
job (dict) --
The failback launch Job.
arn (string) --
The ARN of a Job.
creationDateTime (string) --
The date and time of when the Job was created.
endDateTime (string) --
The date and time of when the Job ended.
initiatedBy (string) --
A string representing who initiated the Job.
jobID (string) --
The ID of the Job.
participatingServers (list) --
A list of servers that the Job is acting upon.
(dict) --
Represents a server participating in an asynchronous Job.
launchStatus (string) --
The launch status of a participating server.
recoveryInstanceID (string) --
The Recovery Instance ID of a participating server.
sourceServerID (string) --
The Source Server ID of a participating server.
status (string) --
The status of the Job.
tags (dict) --
A list of tags associated with the Job.
(string) --
(string) --
type (string) --
The type of the Job.
Lists all Recovery Snapshots for a single Source Server.
See also: AWS API Documentation
Request Syntax
client.describe_recovery_snapshots(
filters={
'fromDateTime': 'string',
'toDateTime': 'string'
},
maxResults=123,
nextToken='string',
order='ASC'|'DESC',
sourceServerID='string'
)
dict
A set of filters by which to return Recovery Snapshots.
fromDateTime (string) --
The start date in a date range query.
toDateTime (string) --
The end date in a date range query.
integer
Maximum number of Recovery Snapshots to retrieve.
string
The token of the next Recovery Snapshot to retrieve.
string
The sorted ordering by which to return Recovery Snapshots.
string
[REQUIRED]
Filter Recovery Snapshots by Source Server ID.
dict
Response Syntax
{
'items': [
{
'ebsSnapshots': [
'string',
],
'expectedTimestamp': 'string',
'snapshotID': 'string',
'sourceServerID': 'string',
'timestamp': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
An array of Recovery Snapshots.
(dict) --
A snapshot of a Source Server used during recovery.
ebsSnapshots (list) --
A list of EBS snapshots.
(string) --
expectedTimestamp (string) --
The timestamp of when we expect the snapshot to be taken.
snapshotID (string) --
The ID of the Recovery Snapshot.
sourceServerID (string) --
The ID of the Source Server that the snapshot was taken for.
timestamp (string) --
The actual timestamp that the snapshot was taken.
nextToken (string) --
The token of the next Recovery Snapshot to retrieve.
Gets a ReplicationConfiguration, filtered by Source Server ID.
See also: AWS API Documentation
Request Syntax
client.get_replication_configuration(
sourceServerID='string'
)
string
[REQUIRED]
The ID of the Source Serve for this Replication Configuration.r
dict
Response Syntax
{
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'GP3'|'ST1',
'ebsEncryption': 'DEFAULT'|'CUSTOM',
'ebsEncryptionKeyArn': 'string',
'name': 'string',
'pitPolicy': [
{
'enabled': True|False,
'interval': 123,
'retentionDuration': 123,
'ruleID': 123,
'units': 'MINUTE'|'HOUR'|'DAY'
},
],
'replicatedDisks': [
{
'deviceName': 'string',
'iops': 123,
'isBootDisk': True|False,
'stagingDiskType': 'AUTO'|'GP2'|'GP3'|'IO1'|'SC1'|'ST1'|'STANDARD',
'throughput': 123
},
],
'replicationServerInstanceType': 'string',
'replicationServersSecurityGroupsIDs': [
'string',
],
'sourceServerID': 'string',
'stagingAreaSubnetId': 'string',
'stagingAreaTags': {
'string': 'string'
},
'useDedicatedReplicationServer': True|False
}
Response Structure
(dict) --
associateDefaultSecurityGroup (boolean) --
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
bandwidthThrottling (integer) --
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
createPublicIP (boolean) --
Whether to create a Public IP for the Recovery Instance by default.
dataPlaneRouting (string) --
The data plane routing mechanism that will be used for replication.
defaultLargeStagingDiskType (string) --
The Staging Disk EBS volume type to be used during replication.
ebsEncryption (string) --
The type of EBS encryption to be used during replication.
ebsEncryptionKeyArn (string) --
The ARN of the EBS encryption key to be used during replication.
name (string) --
The name of the Replication Configuration.
pitPolicy (list) --
The Point in time (PIT) policy to manage snapshots taken during replication.
(dict) --
A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.
enabled (boolean) --
Whether this rule is enabled or not.
interval (integer) --
How often, in the chosen units, a snapshot should be taken.
retentionDuration (integer) --
The duration to retain a snapshot for, in the chosen units.
ruleID (integer) --
The ID of the rule.
units (string) --
The units used to measure the interval and retentionDuration.
replicatedDisks (list) --
The configuration of the disks of the Source Server to be replicated.
(dict) --
The configuration of a disk of the Source Server to be replicated.
deviceName (string) --
The name of the device.
iops (integer) --
The requested number of I/O operations per second (IOPS).
isBootDisk (boolean) --
Whether to boot from this disk or not.
stagingDiskType (string) --
The Staging Disk EBS volume type to be used during replication.
throughput (integer) --
The throughput to use for the EBS volume in MiB/s. This parameter is valid only for gp3 volumes.
replicationServerInstanceType (string) --
The instance type to be used for the replication server.
replicationServersSecurityGroupsIDs (list) --
The security group IDs that will be used by the replication server.
(string) --
sourceServerID (string) --
The ID of the Source Server for this Replication Configuration.
stagingAreaSubnetId (string) --
The subnet to be used by the replication staging area.
stagingAreaTags (dict) --
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
(string) --
(string) --
useDedicatedReplicationServer (boolean) --
Whether to use a dedicated Replication Server in the replication staging area.
Lists all Source Servers or multiple Source Servers filtered by ID.
See also: AWS API Documentation
Request Syntax
client.describe_source_servers(
filters={
'hardwareId': 'string',
'sourceServerIDs': [
'string',
]
},
maxResults=123,
nextToken='string'
)
dict
[REQUIRED]
A set of filters by which to return Source Servers.
hardwareId (string) --
An ID that describes the hardware of the Source Server. This is either an EC2 instance id, a VMware uuid or a mac address.
sourceServerIDs (list) --
An array of Source Servers IDs that should be returned. An empty array means all Source Servers.
(string) --
integer
Maximum number of Source Servers to retrieve.
string
The token of the next Source Server to retrieve.
dict
Response Syntax
{
'items': [
{
'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',
'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',
'etaDateTime': 'string',
'lagDuration': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'lastLaunchResult': 'NOT_STARTED'|'PENDING'|'SUCCEEDED'|'FAILED',
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastLaunch': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string',
'type': 'RECOVERY'|'DRILL'
}
},
'lastSeenByServiceDateTime': 'string'
},
'recoveryInstanceId': 'string',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': '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'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
An array of Source Servers.
(dict) --
arn (string) --
The ARN of the Source Server.
dataReplicationInfo (dict) --
The Data Replication Info of the Source Server.
dataReplicationError (dict) --
Error in data replication.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Information about whether the data replication has been initiated.
nextAttemptDateTime (string) --
The date and time of the next attempt to initiate data replication.
startDateTime (string) --
The date and time of the current attempt to initiate data replication.
steps (list) --
The steps of the current attempt to initiate data replication.
(dict) --
Data replication initiation step.
name (string) --
The name of the step.
status (string) --
The status of the step.
dataReplicationState (string) --
The state of the data replication.
etaDateTime (string) --
An estimate of when the data replication will be completed.
lagDuration (string) --
Data replication lag duration.
replicatedDisks (list) --
The disks that should be replicated.
(dict) --
A disk that should be replicated.
backloggedStorageBytes (integer) --
The size of the replication backlog in bytes.
deviceName (string) --
The name of the device.
replicatedStorageBytes (integer) --
The amount of data replicated so far in bytes.
rescannedStorageBytes (integer) --
The amount of data to be rescanned in bytes.
totalStorageBytes (integer) --
The total amount of data to be replicated in bytes.
lastLaunchResult (string) --
The status of the last recovery launch of this Source Server.
lifeCycle (dict) --
The lifecycle information of this Source Server.
addedToServiceDateTime (string) --
The date and time of when the Source Server was added to the service.
elapsedReplicationDuration (string) --
The amount of time that the Source Server has been replicating for.
firstByteDateTime (string) --
The date and time of the first byte that was replicated from the Source Server.
lastLaunch (dict) --
An object containing information regarding the last launch of the Source Server.
initiated (dict) --
An object containing information regarding the initiation of the last launch of a Source Server.
apiCallDateTime (string) --
The date and time the last Source Server launch was initiated.
jobID (string) --
The ID of the Job that was used to last launch the Source Server.
type (string) --
The Job type that was used to last launch the Source Server.
lastSeenByServiceDateTime (string) --
The date and time this Source Server was last seen by the service.
recoveryInstanceId (string) --
The ID of the Recovery Instance associated with this Source Server.
sourceProperties (dict) --
The source properties of the Source Server.
cpus (list) --
An array of CPUs.
(dict) --
Information about a server's CPU.
cores (integer) --
The number of CPU cores.
modelName (string) --
The model name of the CPU.
disks (list) --
An array of disks.
(dict) --
An object representing a data storage device on a server.
bytes (integer) --
The amount of storage on the disk in bytes.
deviceName (string) --
The disk or device name.
identificationHints (dict) --
Hints used to uniquely identify a machine.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
Fully Qualified Domain Name identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vCenter VM path identification hint.
lastUpdatedDateTime (string) --
The date and time the Source Properties were last updated on.
networkInterfaces (list) --
An array of network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Whether this is the primary network interface.
macAddress (string) --
The MAC address of the network interface.
os (dict) --
Operating system.
fullString (string) --
The long name of the Operating System.
ramBytes (integer) --
The amount of RAM in bytes.
recommendedInstanceType (string) --
The recommended EC2 instance type that will be used when recovering the Source Server.
sourceServerID (string) --
The ID of the Source Server.
tags (dict) --
The tags associated with the Source Server.
(string) --
(string) --
nextToken (string) --
The token of the next Source Server to retrieve.
Adds or overwrites only the specified tags for the specified Elastic Disaster Recovery resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
ARN of the resource for which tags are to be added or updated.
dict
[REQUIRED]
Array of tags to be added or updated.
(string) --
(string) --
None
Initialize Elastic Disaster Recovery.
See also: AWS API Documentation
Request Syntax
client.initialize_service()
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes a single Recovery Instance by ID. This deletes the Recovery Instance resource from Elastic Disaster Recovery. The Recovery Instance must be disconnected first in order to delete it.
See also: AWS API Documentation
Request Syntax
client.delete_recovery_instance(
recoveryInstanceID='string'
)
string
[REQUIRED]
RThe ID of the Recovery Instance to be deleted.
None
List all tags for your Elastic Disaster Recovery resources.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The ARN of the resource whose tags should be returned.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
The tags of the requested resource.
(string) --
(string) --
Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source Server has not been prevented from communicating with the Elastic Disaster Recovery 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_source_server(
sourceServerID='string'
)
string
[REQUIRED]
The ID of the Source Server to disconnect.
dict
Response Syntax
{
'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',
'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',
'etaDateTime': 'string',
'lagDuration': 'string',
'replicatedDisks': [
{
'backloggedStorageBytes': 123,
'deviceName': 'string',
'replicatedStorageBytes': 123,
'rescannedStorageBytes': 123,
'totalStorageBytes': 123
},
]
},
'lastLaunchResult': 'NOT_STARTED'|'PENDING'|'SUCCEEDED'|'FAILED',
'lifeCycle': {
'addedToServiceDateTime': 'string',
'elapsedReplicationDuration': 'string',
'firstByteDateTime': 'string',
'lastLaunch': {
'initiated': {
'apiCallDateTime': 'string',
'jobID': 'string',
'type': 'RECOVERY'|'DRILL'
}
},
'lastSeenByServiceDateTime': 'string'
},
'recoveryInstanceId': 'string',
'sourceProperties': {
'cpus': [
{
'cores': 123,
'modelName': 'string'
},
],
'disks': [
{
'bytes': 123,
'deviceName': 'string'
},
],
'identificationHints': {
'awsInstanceID': 'string',
'fqdn': 'string',
'hostname': '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'
}
}
Response Structure
(dict) --
arn (string) --
The ARN of the Source Server.
dataReplicationInfo (dict) --
The Data Replication Info of the Source Server.
dataReplicationError (dict) --
Error in data replication.
error (string) --
Error in data replication.
rawError (string) --
Error in data replication.
dataReplicationInitiation (dict) --
Information about whether the data replication has been initiated.
nextAttemptDateTime (string) --
The date and time of the next attempt to initiate data replication.
startDateTime (string) --
The date and time of the current attempt to initiate data replication.
steps (list) --
The steps of the current attempt to initiate data replication.
(dict) --
Data replication initiation step.
name (string) --
The name of the step.
status (string) --
The status of the step.
dataReplicationState (string) --
The state of the data replication.
etaDateTime (string) --
An estimate of when the data replication will be completed.
lagDuration (string) --
Data replication lag duration.
replicatedDisks (list) --
The disks that should be replicated.
(dict) --
A disk that should be replicated.
backloggedStorageBytes (integer) --
The size of the replication backlog in bytes.
deviceName (string) --
The name of the device.
replicatedStorageBytes (integer) --
The amount of data replicated so far in bytes.
rescannedStorageBytes (integer) --
The amount of data to be rescanned in bytes.
totalStorageBytes (integer) --
The total amount of data to be replicated in bytes.
lastLaunchResult (string) --
The status of the last recovery launch of this Source Server.
lifeCycle (dict) --
The lifecycle information of this Source Server.
addedToServiceDateTime (string) --
The date and time of when the Source Server was added to the service.
elapsedReplicationDuration (string) --
The amount of time that the Source Server has been replicating for.
firstByteDateTime (string) --
The date and time of the first byte that was replicated from the Source Server.
lastLaunch (dict) --
An object containing information regarding the last launch of the Source Server.
initiated (dict) --
An object containing information regarding the initiation of the last launch of a Source Server.
apiCallDateTime (string) --
The date and time the last Source Server launch was initiated.
jobID (string) --
The ID of the Job that was used to last launch the Source Server.
type (string) --
The Job type that was used to last launch the Source Server.
lastSeenByServiceDateTime (string) --
The date and time this Source Server was last seen by the service.
recoveryInstanceId (string) --
The ID of the Recovery Instance associated with this Source Server.
sourceProperties (dict) --
The source properties of the Source Server.
cpus (list) --
An array of CPUs.
(dict) --
Information about a server's CPU.
cores (integer) --
The number of CPU cores.
modelName (string) --
The model name of the CPU.
disks (list) --
An array of disks.
(dict) --
An object representing a data storage device on a server.
bytes (integer) --
The amount of storage on the disk in bytes.
deviceName (string) --
The disk or device name.
identificationHints (dict) --
Hints used to uniquely identify a machine.
awsInstanceID (string) --
AWS Instance ID identification hint.
fqdn (string) --
Fully Qualified Domain Name identification hint.
hostname (string) --
Hostname identification hint.
vmWareUuid (string) --
vCenter VM path identification hint.
lastUpdatedDateTime (string) --
The date and time the Source Properties were last updated on.
networkInterfaces (list) --
An array of network interfaces.
(dict) --
Network interface.
ips (list) --
Network interface IPs.
(string) --
isPrimary (boolean) --
Whether this is the primary network interface.
macAddress (string) --
The MAC address of the network interface.
os (dict) --
Operating system.
fullString (string) --
The long name of the Operating System.
ramBytes (integer) --
The amount of RAM in bytes.
recommendedInstanceType (string) --
The recommended EC2 instance type that will be used when recovering the Source Server.
sourceServerID (string) --
The ID of the Source Server.
tags (dict) --
The tags associated with the Source Server.
(string) --
(string) --