Table of Contents
drs.Client¶A low-level client representing Elastic Disaster Recovery Service (drs)
AWS Elastic Disaster Recovery Service.
import boto3
client = boto3.client('drs')
These are the available methods:
can_paginate()close()create_extended_source_server()create_replication_configuration_template()delete_job()delete_recovery_instance()delete_replication_configuration_template()delete_source_server()describe_job_log_items()describe_jobs()describe_recovery_instances()describe_recovery_snapshots()describe_replication_configuration_templates()describe_source_servers()disconnect_recovery_instance()disconnect_source_server()get_failback_replication_configuration()get_launch_configuration()get_paginator()get_replication_configuration()get_waiter()initialize_service()list_extensible_source_servers()list_staging_accounts()list_tags_for_resource()retry_data_replication()start_failback_launch()start_recovery()stop_failback()tag_resource()terminate_recovery_instances()untag_resource()update_failback_replication_configuration()update_launch_configuration()update_replication_configuration()update_replication_configuration_template()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_extended_source_server(**kwargs)¶Create an extended source server in the target Account based on the source server in staging account.
See also: AWS API Documentation
Request Syntax
response = client.create_extended_source_server(
sourceServerArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
This defines the ARN of the source server in staging Account based on which you want to create an extended source server.
A list of tags associated with the extended source server.
dict
Response Syntax
{
'sourceServer': {
'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',
'stagingArea': {
'errorMessage': 'string',
'stagingAccountID': 'string',
'stagingSourceServerArn': 'string',
'status': 'EXTENDED'|'EXTENSION_ERROR'|'NOT_EXTENDED'
},
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
sourceServer (dict) --
Created extended source server.
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.
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.
stagingArea (dict) --
The staging area of the source server.
errorMessage (string) --
Shows an error message that occurred when DRS tried to access the staging source server. In this case StagingArea$status will have value EXTENSION_ERROR
stagingAccountID (string) --
Account ID of the account to which source server belongs. If this source server is extended - shows Account ID of staging source server.
stagingSourceServerArn (string) --
Arn of the staging source server if this source server is extended
status (string) --
Status of Source server extension. Possible values: (a) NOT_EXTENDED - This is a source server that is replicating in the current account. (b) EXTENDED - Source server is extended from a staging source server. In this case, the value of stagingSourceServerArn is pointing to the Arn of the source server in the staging account. (c) EXTENSION_ERROR - Some issue occurred when accessing staging source server. In this case, errorMessage field will contain an error message that explains what happened.
tags (dict) --
The tags associated with the Source Server.
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ServiceQuotaExceededExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.ValidationExceptiondrs.Client.exceptions.UninitializedAccountExceptioncreate_replication_configuration_template(**kwargs)¶Creates a new ReplicationConfigurationTemplate.
See also: AWS API Documentation
Request Syntax
response = client.create_replication_configuration_template(
associateDefaultSecurityGroup=True|False,
bandwidthThrottling=123,
createPublicIP=True|False,
dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP',
defaultLargeStagingDiskType='GP2'|'GP3'|'ST1'|'AUTO',
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
)
[REQUIRED]
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
[REQUIRED]
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
[REQUIRED]
Whether to create a Public IP for the Recovery Instance by default.
[REQUIRED]
The data plane routing mechanism that will be used for replication.
[REQUIRED]
The Staging Disk EBS volume type to be used during replication.
[REQUIRED]
The type of EBS encryption to be used during replication.
[REQUIRED]
The Point in time (PIT) policy to manage snapshots taken during replication.
A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.
Whether this rule is enabled or not.
How often, in the chosen units, a snapshot should be taken.
The duration to retain a snapshot for, in the chosen units.
The ID of the rule.
The units used to measure the interval and retentionDuration.
[REQUIRED]
The instance type to be used for the replication server.
[REQUIRED]
The security group IDs that will be used by the replication server.
[REQUIRED]
The subnet to be used by the replication staging area.
[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.
A set of tags to be associated with the Replication Configuration Template resource.
[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'|'AUTO',
'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.
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.
tags (dict) --
A set of tags to be associated with the Replication Configuration Template resource.
useDedicatedReplicationServer (boolean) --
Whether to use a dedicated Replication Server in the replication staging area.
Exceptions
drs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ServiceQuotaExceededExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.ValidationExceptiondrs.Client.exceptions.UninitializedAccountExceptiondelete_job(**kwargs)¶Deletes a single Job by ID.
See also: AWS API Documentation
Request Syntax
response = client.delete_job(
jobID='string'
)
[REQUIRED]
The ID of the Job to be deleted.
{}
Response Structure
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ConflictExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.UninitializedAccountExceptiondelete_recovery_instance(**kwargs)¶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
response = client.delete_recovery_instance(
recoveryInstanceID='string'
)
[REQUIRED]
The ID of the Recovery Instance to be deleted.
Exceptions
drs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ConflictExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.UninitializedAccountExceptiondelete_replication_configuration_template(**kwargs)¶Deletes a single Replication Configuration Template by ID
See also: AWS API Documentation
Request Syntax
response = client.delete_replication_configuration_template(
replicationConfigurationTemplateID='string'
)
[REQUIRED]
The ID of the Replication Configuration Template to be deleted.
{}
Response Structure
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ConflictExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.UninitializedAccountExceptiondelete_source_server(**kwargs)¶Deletes a single Source Server by ID. The Source Server must be disconnected first.
See also: AWS API Documentation
Request Syntax
response = client.delete_source_server(
sourceServerID='string'
)
[REQUIRED]
The ID of the Source Server to be deleted.
{}
Response Structure
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ConflictExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.UninitializedAccountExceptiondescribe_job_log_items(**kwargs)¶Retrieves a detailed Job log with pagination.
See also: AWS API Documentation
Request Syntax
response = client.describe_job_log_items(
jobID='string',
maxResults=123,
nextToken='string'
)
[REQUIRED]
The ID of the Job for which Job log items will be retrieved.
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': {
'conversionProperties': {
'dataTimestamp': 'string',
'forceUefi': True|False,
'rootVolumeName': 'string',
'volumeToConversionMap': {
'string': {
'string': 'string'
}
},
'volumeToVolumeSize': {
'string': 123
}
},
'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.
conversionProperties (dict) --
Properties of a conversion job
dataTimestamp (string) --
The timestamp of when the snapshot being converted was taken
forceUefi (boolean) --
Whether the volume being converted uses UEFI or not
rootVolumeName (string) --
The root volume name of a conversion job
volumeToConversionMap (dict) --
A mapping between the volumes being converted and the converted snapshot ids
volumeToVolumeSize (dict) --
A mapping between the volumes and their sizes
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.
Exceptions
drs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.ValidationExceptiondrs.Client.exceptions.UninitializedAccountExceptiondescribe_jobs(**kwargs)¶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
response = client.describe_jobs(
filters={
'fromDate': 'string',
'jobIDs': [
'string',
],
'toDate': 'string'
},
maxResults=123,
nextToken='string'
)
A set of filters by which to return Jobs.
The start date in a date range query.
An array of Job IDs that should be returned. An empty array means all jobs.
The end date in a date range query.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_RECOVERY'|'START_DRILL'|'FAILBACK'|'DIAGNOSTIC'|'TERMINATE_RECOVERY_INSTANCES'|'TARGET_ACCOUNT',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'recoveryInstanceID': 'string',
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'|'CREATE_CONVERTED_SNAPSHOT'
},
],
'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.
type (string) --
The type of the Job.
nextToken (string) --
The token of the next Job to retrieve.
Exceptions
drs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.ValidationExceptiondrs.Client.exceptions.UninitializedAccountExceptiondescribe_recovery_instances(**kwargs)¶Lists all Recovery Instances or multiple Recovery Instances by ID.
See also: AWS API Documentation
Request Syntax
response = client.describe_recovery_instances(
filters={
'recoveryInstanceIDs': [
'string',
],
'sourceServerIDs': [
'string',
]
},
maxResults=123,
nextToken='string'
)
A set of filters by which to return Recovery Instances.
An array of Recovery Instance IDs that should be returned. An empty array means all Recovery Instances.
An array of Source Server IDs for which associated Recovery Instances should be returned.
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.
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.
nextToken (string) --
The token of the next Recovery Instance to retrieve.
Exceptions
drs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.UninitializedAccountExceptiondescribe_recovery_snapshots(**kwargs)¶Lists all Recovery Snapshots for a single Source Server.
See also: AWS API Documentation
Request Syntax
response = client.describe_recovery_snapshots(
filters={
'fromDateTime': 'string',
'toDateTime': 'string'
},
maxResults=123,
nextToken='string',
order='ASC'|'DESC',
sourceServerID='string'
)
A set of filters by which to return Recovery Snapshots.
The start date in a date range query.
The end date in a date range query.
[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.
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.
Exceptions
drs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.ValidationExceptiondrs.Client.exceptions.UninitializedAccountExceptiondescribe_replication_configuration_templates(**kwargs)¶Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
See also: AWS API Documentation
Request Syntax
response = client.describe_replication_configuration_templates(
maxResults=123,
nextToken='string',
replicationConfigurationTemplateIDs=[
'string',
]
)
The IDs of the Replication Configuration Templates to retrieve. An empty list means all Replication Configuration Templates.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'GP3'|'ST1'|'AUTO',
'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.
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.
tags (dict) --
A set of tags to be associated with the Replication Configuration Template resource.
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.
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.ValidationExceptiondrs.Client.exceptions.UninitializedAccountExceptiondescribe_source_servers(**kwargs)¶Lists all Source Servers or multiple Source Servers filtered by ID.
See also: AWS API Documentation
Request Syntax
response = client.describe_source_servers(
filters={
'hardwareId': 'string',
'sourceServerIDs': [
'string',
],
'stagingAccountIDs': [
'string',
]
},
maxResults=123,
nextToken='string'
)
A set of filters by which to return Source Servers.
An ID that describes the hardware of the Source Server. This is either an EC2 instance id, a VMware uuid or a mac address.
An array of Source Servers IDs that should be returned. An empty array means all Source Servers.
An array of staging account IDs that extended source servers belong to. An empty array means all source servers will be shown.
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',
'stagingArea': {
'errorMessage': 'string',
'stagingAccountID': 'string',
'stagingSourceServerArn': 'string',
'status': 'EXTENDED'|'EXTENSION_ERROR'|'NOT_EXTENDED'
},
'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.
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.
stagingArea (dict) --
The staging area of the source server.
errorMessage (string) --
Shows an error message that occurred when DRS tried to access the staging source server. In this case StagingArea$status will have value EXTENSION_ERROR
stagingAccountID (string) --
Account ID of the account to which source server belongs. If this source server is extended - shows Account ID of staging source server.
stagingSourceServerArn (string) --
Arn of the staging source server if this source server is extended
status (string) --
Status of Source server extension. Possible values: (a) NOT_EXTENDED - This is a source server that is replicating in the current account. (b) EXTENDED - Source server is extended from a staging source server. In this case, the value of stagingSourceServerArn is pointing to the Arn of the source server in the staging account. (c) EXTENSION_ERROR - Some issue occurred when accessing staging source server. In this case, errorMessage field will contain an error message that explains what happened.
tags (dict) --
The tags associated with the Source Server.
nextToken (string) --
The token of the next Source Server to retrieve.
Exceptions
drs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.ValidationExceptiondrs.Client.exceptions.UninitializedAccountExceptiondisconnect_recovery_instance(**kwargs)¶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
response = client.disconnect_recovery_instance(
recoveryInstanceID='string'
)
[REQUIRED]
The ID of the Recovery Instance to disconnect.
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ConflictExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.UninitializedAccountExceptiondisconnect_source_server(**kwargs)¶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
response = client.disconnect_source_server(
sourceServerID='string'
)
[REQUIRED]
The ID of the Source Server to disconnect.
{
'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',
'stagingArea': {
'errorMessage': 'string',
'stagingAccountID': 'string',
'stagingSourceServerArn': 'string',
'status': 'EXTENDED'|'EXTENSION_ERROR'|'NOT_EXTENDED'
},
'tags': {
'string': 'string'
}
}
Response Structure
The ARN of the Source Server.
The Data Replication Info of the Source Server.
Error in data replication.
Error in data replication.
Error in data replication.
Information about whether the data replication has been initiated.
The date and time of the next attempt to initiate data replication.
The date and time of the current attempt to initiate data replication.
The steps of the current attempt to initiate data replication.
Data replication initiation step.
The name of the step.
The status of the step.
The state of the data replication.
An estimate of when the data replication will be completed.
Data replication lag duration.
The disks that should be replicated.
A disk that should be replicated.
The size of the replication backlog in bytes.
The name of the device.
The amount of data replicated so far in bytes.
The amount of data to be rescanned in bytes.
The total amount of data to be replicated in bytes.
The status of the last recovery launch of this Source Server.
The lifecycle information of this Source Server.
The date and time of when the Source Server was added to the service.
The amount of time that the Source Server has been replicating for.
The date and time of the first byte that was replicated from the Source Server.
An object containing information regarding the last launch of the Source Server.
An object containing information regarding the initiation of the last launch of a Source Server.
The date and time the last Source Server launch was initiated.
The ID of the Job that was used to last launch the Source Server.
The Job type that was used to last launch the Source Server.
The date and time this Source Server was last seen by the service.
The ID of the Recovery Instance associated with this Source Server.
The source properties of the Source Server.
An array of CPUs.
Information about a server's CPU.
The number of CPU cores.
The model name of the CPU.
An array of disks.
An object representing a data storage device on a server.
The amount of storage on the disk in bytes.
The disk or device name.
Hints used to uniquely identify a machine.
AWS Instance ID identification hint.
Fully Qualified Domain Name identification hint.
Hostname identification hint.
vCenter VM path identification hint.
The date and time the Source Properties were last updated on.
An array of network interfaces.
Network interface.
Network interface IPs.
Whether this is the primary network interface.
The MAC address of the network interface.
Operating system.
The long name of the Operating System.
The amount of RAM in bytes.
The recommended EC2 instance type that will be used when recovering the Source Server.
The ID of the Source Server.
The staging area of the source server.
Shows an error message that occurred when DRS tried to access the staging source server. In this case StagingArea$status will have value EXTENSION_ERROR
Account ID of the account to which source server belongs. If this source server is extended - shows Account ID of staging source server.
Arn of the staging source server if this source server is extended
Status of Source server extension. Possible values: (a) NOT_EXTENDED - This is a source server that is replicating in the current account. (b) EXTENDED - Source server is extended from a staging source server. In this case, the value of stagingSourceServerArn is pointing to the Arn of the source server in the staging account. (c) EXTENSION_ERROR - Some issue occurred when accessing staging source server. In this case, errorMessage field will contain an error message that explains what happened.
The tags associated with the Source Server.
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ConflictExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.UninitializedAccountExceptionget_failback_replication_configuration(**kwargs)¶Lists all Failback ReplicationConfigurations, filtered by Recovery Instance ID.
See also: AWS API Documentation
Request Syntax
response = client.get_failback_replication_configuration(
recoveryInstanceID='string'
)
[REQUIRED]
The ID of the Recovery Instance whose failback replication configuration should be returned.
{
'bandwidthThrottling': 123,
'name': 'string',
'recoveryInstanceID': 'string',
'usePrivateIP': True|False
}
Response Structure
Configure bandwidth throttling for the outbound data transfer rate of the Recovery Instance in Mbps.
The name of the Failback Replication Configuration.
The ID of the Recovery Instance.
Whether to use Private IP for the failback replication of the Recovery Instance.
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.UninitializedAccountExceptionget_launch_configuration(**kwargs)¶Gets a LaunchConfiguration, filtered by Source Server IDs.
See also: AWS API Documentation
Request Syntax
response = client.get_launch_configuration(
sourceServerID='string'
)
[REQUIRED]
The ID of the Source Server that we want to retrieve a Launch Configuration for.
{
'copyPrivateIp': True|False,
'copyTags': True|False,
'ec2LaunchTemplateID': 'string',
'launchDisposition': 'STOPPED'|'STARTED',
'licensing': {
'osByol': True|False
},
'name': 'string',
'sourceServerID': 'string',
'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'
}
Response Structure
Whether we should copy the Private IP of the Source Server to the Recovery Instance.
Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.
The EC2 launch template ID of this launch configuration.
The state of the Recovery Instance in EC2 after the recovery operation.
The licensing configuration to be used for this launch configuration.
Whether to enable "Bring your own license" or not.
The name of the launch configuration.
The ID of the Source Server for this launch configuration.
Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.UninitializedAccountExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_replication_configuration(**kwargs)¶Gets a ReplicationConfiguration, filtered by Source Server ID.
See also: AWS API Documentation
Request Syntax
response = client.get_replication_configuration(
sourceServerID='string'
)
[REQUIRED]
The ID of the Source Serve for this Replication Configuration.r
{
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'GP3'|'ST1'|'AUTO',
'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,
'optimizedStagingDiskType': 'AUTO'|'GP2'|'GP3'|'IO1'|'SC1'|'ST1'|'STANDARD',
'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
Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
Whether to create a Public IP for the Recovery Instance by default.
The data plane routing mechanism that will be used for replication.
The Staging Disk EBS volume type to be used during replication.
The type of EBS encryption to be used during replication.
The ARN of the EBS encryption key to be used during replication.
The name of the Replication Configuration.
The Point in time (PIT) policy to manage snapshots taken during replication.
A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.
Whether this rule is enabled or not.
How often, in the chosen units, a snapshot should be taken.
The duration to retain a snapshot for, in the chosen units.
The ID of the rule.
The units used to measure the interval and retentionDuration.
The configuration of the disks of the Source Server to be replicated.
The configuration of a disk of the Source Server to be replicated.
The name of the device.
The requested number of I/O operations per second (IOPS).
Whether to boot from this disk or not.
The Staging Disk EBS volume type to be used during replication when stagingDiskType is set to Auto. This is a read-only field.
The Staging Disk EBS volume type to be used during replication.
The throughput to use for the EBS volume in MiB/s. This parameter is valid only for gp3 volumes.
The instance type to be used for the replication server.
The security group IDs that will be used by the replication server.
The ID of the Source Server for this Replication Configuration.
The subnet to be used by the replication staging area.
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
Whether to use a dedicated Replication Server in the replication staging area.
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.UninitializedAccountExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
initialize_service()¶Initialize Elastic Disaster Recovery.
See also: AWS API Documentation
Request Syntax
response = client.initialize_service()
{}
Response Structure
Exceptions
drs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.ValidationExceptionlist_extensible_source_servers(**kwargs)¶Returns a list of source servers on a staging account that are extensible, which means that: a. The source server is not already extended into this Account. b. The source server on the Account we’re reading from is not an extension of another source server.
See also: AWS API Documentation
Request Syntax
response = client.list_extensible_source_servers(
maxResults=123,
nextToken='string',
stagingAccountID='string'
)
[REQUIRED]
The Id of the staging Account to retrieve extensible source servers from.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'hostname': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
A list of source servers on a staging Account that are extensible.
(dict) --
Source server in staging account that extended source server connected to.
arn (string) --
The ARN of the source server.
hostname (string) --
Hostname of staging source server.
tags (dict) --
A list of tags associated with the staging source server.
nextToken (string) --
The token of the next extensible source server to retrieve.
Exceptions
drs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.ValidationExceptiondrs.Client.exceptions.UninitializedAccountExceptionlist_staging_accounts(**kwargs)¶Returns an array of staging accounts for existing extended source servers.
See also: AWS API Documentation
Request Syntax
response = client.list_staging_accounts(
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'accounts': [
{
'accountID': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
accounts (list) --
An array of staging AWS Accounts.
(dict) --
AWS account.
accountID (string) --
Account ID of AWS account.
nextToken (string) --
The token of the next staging Account to retrieve.
Exceptions
drs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.ValidationExceptiondrs.Client.exceptions.UninitializedAccountExceptionList all tags for your Elastic Disaster Recovery resources.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The ARN of the resource whose tags should be returned.
{
'tags': {
'string': 'string'
}
}
Response Structure
The tags of the requested resource.
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.ValidationExceptionretry_data_replication(**kwargs)¶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
response = client.retry_data_replication(
sourceServerID='string'
)
[REQUIRED]
The ID of the Source Server whose data replication should be retried.
{
'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',
'stagingArea': {
'errorMessage': 'string',
'stagingAccountID': 'string',
'stagingSourceServerArn': 'string',
'status': 'EXTENDED'|'EXTENSION_ERROR'|'NOT_EXTENDED'
},
'tags': {
'string': 'string'
}
}
Response Structure
The ARN of the Source Server.
The Data Replication Info of the Source Server.
Error in data replication.
Error in data replication.
Error in data replication.
Information about whether the data replication has been initiated.
The date and time of the next attempt to initiate data replication.
The date and time of the current attempt to initiate data replication.
The steps of the current attempt to initiate data replication.
Data replication initiation step.
The name of the step.
The status of the step.
The state of the data replication.
An estimate of when the data replication will be completed.
Data replication lag duration.
The disks that should be replicated.
A disk that should be replicated.
The size of the replication backlog in bytes.
The name of the device.
The amount of data replicated so far in bytes.
The amount of data to be rescanned in bytes.
The total amount of data to be replicated in bytes.
The status of the last recovery launch of this Source Server.
The lifecycle information of this Source Server.
The date and time of when the Source Server was added to the service.
The amount of time that the Source Server has been replicating for.
The date and time of the first byte that was replicated from the Source Server.
An object containing information regarding the last launch of the Source Server.
An object containing information regarding the initiation of the last launch of a Source Server.
The date and time the last Source Server launch was initiated.
The ID of the Job that was used to last launch the Source Server.
The Job type that was used to last launch the Source Server.
The date and time this Source Server was last seen by the service.
The ID of the Recovery Instance associated with this Source Server.
The source properties of the Source Server.
An array of CPUs.
Information about a server's CPU.
The number of CPU cores.
The model name of the CPU.
An array of disks.
An object representing a data storage device on a server.
The amount of storage on the disk in bytes.
The disk or device name.
Hints used to uniquely identify a machine.
AWS Instance ID identification hint.
Fully Qualified Domain Name identification hint.
Hostname identification hint.
vCenter VM path identification hint.
The date and time the Source Properties were last updated on.
An array of network interfaces.
Network interface.
Network interface IPs.
Whether this is the primary network interface.
The MAC address of the network interface.
Operating system.
The long name of the Operating System.
The amount of RAM in bytes.
The recommended EC2 instance type that will be used when recovering the Source Server.
The ID of the Source Server.
The staging area of the source server.
Shows an error message that occurred when DRS tried to access the staging source server. In this case StagingArea$status will have value EXTENSION_ERROR
Account ID of the account to which source server belongs. If this source server is extended - shows Account ID of staging source server.
Arn of the staging source server if this source server is extended
Status of Source server extension. Possible values: (a) NOT_EXTENDED - This is a source server that is replicating in the current account. (b) EXTENDED - Source server is extended from a staging source server. In this case, the value of stagingSourceServerArn is pointing to the Arn of the source server in the staging account. (c) EXTENSION_ERROR - Some issue occurred when accessing staging source server. In this case, errorMessage field will contain an error message that explains what happened.
The tags associated with the Source Server.
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.ValidationExceptiondrs.Client.exceptions.UninitializedAccountExceptionstart_failback_launch(**kwargs)¶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
response = client.start_failback_launch(
recoveryInstanceIDs=[
'string',
],
tags={
'string': 'string'
}
)
[REQUIRED]
The IDs of the Recovery Instance whose failback launch we want to request.
The tags to be associated with the failback launch Job.
dict
Response Syntax
{
'job': {
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_RECOVERY'|'START_DRILL'|'FAILBACK'|'DIAGNOSTIC'|'TERMINATE_RECOVERY_INSTANCES'|'TARGET_ACCOUNT',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'recoveryInstanceID': 'string',
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'|'CREATE_CONVERTED_SNAPSHOT'
}
}
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.
type (string) --
The type of the Job.
Exceptions
drs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ConflictExceptiondrs.Client.exceptions.ServiceQuotaExceededExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.ValidationExceptiondrs.Client.exceptions.UninitializedAccountExceptionstart_recovery(**kwargs)¶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
response = client.start_recovery(
isDrill=True|False,
sourceServers=[
{
'recoverySnapshotID': 'string',
'sourceServerID': 'string'
},
],
tags={
'string': 'string'
}
)
[REQUIRED]
The Source Servers that we want to start a Recovery Job for.
An object representing the Source Server to recover.
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.
The ID of the Source Server you want to recover.
The tags to be associated with the Recovery Job.
dict
Response Syntax
{
'job': {
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_RECOVERY'|'START_DRILL'|'FAILBACK'|'DIAGNOSTIC'|'TERMINATE_RECOVERY_INSTANCES'|'TARGET_ACCOUNT',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'recoveryInstanceID': 'string',
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'|'CREATE_CONVERTED_SNAPSHOT'
}
}
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.
type (string) --
The type of the Job.
Exceptions
drs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ConflictExceptiondrs.Client.exceptions.ServiceQuotaExceededExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.UninitializedAccountExceptionstop_failback(**kwargs)¶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
response = client.stop_failback(
recoveryInstanceID='string'
)
[REQUIRED]
The ID of the Recovery Instance we want to stop failback for.
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.UninitializedAccountExceptiontag_resource(**kwargs)¶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
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
ARN of the resource for which tags are to be added or updated.
[REQUIRED]
Array of tags to be added or updated.
None
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.ValidationExceptionterminate_recovery_instances(**kwargs)¶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
response = client.terminate_recovery_instances(
recoveryInstanceIDs=[
'string',
]
)
[REQUIRED]
The IDs of the Recovery Instances that should be terminated.
{
'job': {
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_RECOVERY'|'START_DRILL'|'FAILBACK'|'DIAGNOSTIC'|'TERMINATE_RECOVERY_INSTANCES'|'TARGET_ACCOUNT',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'recoveryInstanceID': 'string',
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'|'CREATE_CONVERTED_SNAPSHOT'
}
}
Response Structure
The Job for terminating the Recovery Instances.
The ARN of a Job.
The date and time of when the Job was created.
The date and time of when the Job ended.
A string representing who initiated the Job.
The ID of the Job.
A list of servers that the Job is acting upon.
Represents a server participating in an asynchronous Job.
The launch status of a participating server.
The Recovery Instance ID of a participating server.
The Source Server ID of a participating server.
The status of the Job.
A list of tags associated with the Job.
The type of the Job.
Exceptions
drs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ConflictExceptiondrs.Client.exceptions.ServiceQuotaExceededExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.UninitializedAccountExceptionuntag_resource(**kwargs)¶Deletes the specified set of tags from the specified set of Elastic Disaster Recovery resources.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
ARN of the resource for which tags are to be removed.
[REQUIRED]
Array of tags to be removed.
None
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.ValidationExceptionupdate_failback_replication_configuration(**kwargs)¶Allows you to update the failback replication configuration of a Recovery Instance by ID.
See also: AWS API Documentation
Request Syntax
response = client.update_failback_replication_configuration(
bandwidthThrottling=123,
name='string',
recoveryInstanceID='string',
usePrivateIP=True|False
)
[REQUIRED]
The ID of the Recovery Instance.
None
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.UninitializedAccountExceptionupdate_launch_configuration(**kwargs)¶Updates a LaunchConfiguration by Source Server ID.
See also: AWS API Documentation
Request Syntax
response = client.update_launch_configuration(
copyPrivateIp=True|False,
copyTags=True|False,
launchDisposition='STOPPED'|'STARTED',
licensing={
'osByol': True|False
},
name='string',
sourceServerID='string',
targetInstanceTypeRightSizingMethod='NONE'|'BASIC'
)
The licensing configuration to be used for this launch configuration.
Whether to enable "Bring your own license" or not.
[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.
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ConflictExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.ValidationExceptiondrs.Client.exceptions.UninitializedAccountExceptionupdate_replication_configuration(**kwargs)¶Allows you to update a ReplicationConfiguration by Source Server ID.
See also: AWS API Documentation
Request Syntax
response = client.update_replication_configuration(
associateDefaultSecurityGroup=True|False,
bandwidthThrottling=123,
createPublicIP=True|False,
dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP',
defaultLargeStagingDiskType='GP2'|'GP3'|'ST1'|'AUTO',
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,
'optimizedStagingDiskType': 'AUTO'|'GP2'|'GP3'|'IO1'|'SC1'|'ST1'|'STANDARD',
'stagingDiskType': 'AUTO'|'GP2'|'GP3'|'IO1'|'SC1'|'ST1'|'STANDARD',
'throughput': 123
},
],
replicationServerInstanceType='string',
replicationServersSecurityGroupsIDs=[
'string',
],
sourceServerID='string',
stagingAreaSubnetId='string',
stagingAreaTags={
'string': 'string'
},
useDedicatedReplicationServer=True|False
)
The Point in time (PIT) policy to manage snapshots taken during replication.
A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.
Whether this rule is enabled or not.
How often, in the chosen units, a snapshot should be taken.
The duration to retain a snapshot for, in the chosen units.
The ID of the rule.
The units used to measure the interval and retentionDuration.
The configuration of the disks of the Source Server to be replicated.
The configuration of a disk of the Source Server to be replicated.
The name of the device.
The requested number of I/O operations per second (IOPS).
Whether to boot from this disk or not.
The Staging Disk EBS volume type to be used during replication when stagingDiskType is set to Auto. This is a read-only field.
The Staging Disk EBS volume type to be used during replication.
The throughput to use for the EBS volume in MiB/s. This parameter is valid only for gp3 volumes.
The security group IDs that will be used by the replication server.
[REQUIRED]
The ID of the Source Server for this Replication Configuration.
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
dict
Response Syntax
{
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'GP3'|'ST1'|'AUTO',
'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,
'optimizedStagingDiskType': 'AUTO'|'GP2'|'GP3'|'IO1'|'SC1'|'ST1'|'STANDARD',
'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.
optimizedStagingDiskType (string) --
The Staging Disk EBS volume type to be used during replication when stagingDiskType is set to Auto. This is a read-only field.
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.
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.
useDedicatedReplicationServer (boolean) --
Whether to use a dedicated Replication Server in the replication staging area.
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ConflictExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.ValidationExceptiondrs.Client.exceptions.UninitializedAccountExceptionupdate_replication_configuration_template(**kwargs)¶Updates a ReplicationConfigurationTemplate by ID.
See also: AWS API Documentation
Request Syntax
response = client.update_replication_configuration_template(
arn='string',
associateDefaultSecurityGroup=True|False,
bandwidthThrottling=123,
createPublicIP=True|False,
dataPlaneRouting='PRIVATE_IP'|'PUBLIC_IP',
defaultLargeStagingDiskType='GP2'|'GP3'|'ST1'|'AUTO',
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
)
The Point in time (PIT) policy to manage snapshots taken during replication.
A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.
Whether this rule is enabled or not.
How often, in the chosen units, a snapshot should be taken.
The duration to retain a snapshot for, in the chosen units.
The ID of the rule.
The units used to measure the interval and retentionDuration.
[REQUIRED]
The Replication Configuration Template ID.
The security group IDs that will be used by the replication server.
A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
dict
Response Syntax
{
'arn': 'string',
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'GP3'|'ST1'|'AUTO',
'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.
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.
tags (dict) --
A set of tags to be associated with the Replication Configuration Template resource.
useDedicatedReplicationServer (boolean) --
Whether to use a dedicated Replication Server in the replication staging area.
Exceptions
drs.Client.exceptions.ResourceNotFoundExceptiondrs.Client.exceptions.InternalServerExceptiondrs.Client.exceptions.ThrottlingExceptiondrs.Client.exceptions.AccessDeniedExceptiondrs.Client.exceptions.ValidationExceptiondrs.Client.exceptions.UninitializedAccountExceptionThe available paginators are:
drs.Paginator.DescribeJobLogItemsdrs.Paginator.DescribeJobsdrs.Paginator.DescribeRecoveryInstancesdrs.Paginator.DescribeRecoverySnapshotsdrs.Paginator.DescribeReplicationConfigurationTemplatesdrs.Paginator.DescribeSourceServersdrs.Paginator.ListExtensibleSourceServersdrs.Paginator.ListStagingAccountsdrs.Paginator.DescribeJobLogItems¶paginator = client.get_paginator('describe_job_log_items')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from drs.Client.describe_job_log_items().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
jobID='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The ID of the Job for which Job log items will be retrieved.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
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': {
'conversionProperties': {
'dataTimestamp': 'string',
'forceUefi': True|False,
'rootVolumeName': 'string',
'volumeToConversionMap': {
'string': {
'string': 'string'
}
},
'volumeToVolumeSize': {
'string': 123
}
},
'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.
conversionProperties (dict) --
Properties of a conversion job
dataTimestamp (string) --
The timestamp of when the snapshot being converted was taken
forceUefi (boolean) --
Whether the volume being converted uses UEFI or not
rootVolumeName (string) --
The root volume name of a conversion job
volumeToConversionMap (dict) --
A mapping between the volumes being converted and the converted snapshot ids
volumeToVolumeSize (dict) --
A mapping between the volumes and their sizes
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) --
A token to resume pagination.
drs.Paginator.DescribeJobs¶paginator = client.get_paginator('describe_jobs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from drs.Client.describe_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters={
'fromDate': 'string',
'jobIDs': [
'string',
],
'toDate': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A set of filters by which to return Jobs.
The start date in a date range query.
An array of Job IDs that should be returned. An empty array means all jobs.
The end date in a date range query.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'creationDateTime': 'string',
'endDateTime': 'string',
'initiatedBy': 'START_RECOVERY'|'START_DRILL'|'FAILBACK'|'DIAGNOSTIC'|'TERMINATE_RECOVERY_INSTANCES'|'TARGET_ACCOUNT',
'jobID': 'string',
'participatingServers': [
{
'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
'recoveryInstanceID': 'string',
'sourceServerID': 'string'
},
],
'status': 'PENDING'|'STARTED'|'COMPLETED',
'tags': {
'string': 'string'
},
'type': 'LAUNCH'|'TERMINATE'|'CREATE_CONVERTED_SNAPSHOT'
},
],
'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.
type (string) --
The type of the Job.
NextToken (string) --
A token to resume pagination.
drs.Paginator.DescribeRecoveryInstances¶paginator = client.get_paginator('describe_recovery_instances')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from drs.Client.describe_recovery_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters={
'recoveryInstanceIDs': [
'string',
],
'sourceServerIDs': [
'string',
]
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A set of filters by which to return Recovery Instances.
An array of Recovery Instance IDs that should be returned. An empty array means all Recovery Instances.
An array of Source Server IDs for which associated Recovery Instances should be returned.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
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.
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.
NextToken (string) --
A token to resume pagination.
drs.Paginator.DescribeRecoverySnapshots¶paginator = client.get_paginator('describe_recovery_snapshots')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from drs.Client.describe_recovery_snapshots().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters={
'fromDateTime': 'string',
'toDateTime': 'string'
},
order='ASC'|'DESC',
sourceServerID='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A set of filters by which to return Recovery Snapshots.
The start date in a date range query.
The end date in a date range query.
[REQUIRED]
Filter Recovery Snapshots by Source Server ID.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
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.
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) --
A token to resume pagination.
drs.Paginator.DescribeReplicationConfigurationTemplates¶paginator = client.get_paginator('describe_replication_configuration_templates')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from drs.Client.describe_replication_configuration_templates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
replicationConfigurationTemplateIDs=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The IDs of the Replication Configuration Templates to retrieve. An empty list means all Replication Configuration Templates.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'associateDefaultSecurityGroup': True|False,
'bandwidthThrottling': 123,
'createPublicIP': True|False,
'dataPlaneRouting': 'PRIVATE_IP'|'PUBLIC_IP',
'defaultLargeStagingDiskType': 'GP2'|'GP3'|'ST1'|'AUTO',
'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.
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.
tags (dict) --
A set of tags to be associated with the Replication Configuration Template resource.
useDedicatedReplicationServer (boolean) --
Whether to use a dedicated Replication Server in the replication staging area.
NextToken (string) --
A token to resume pagination.
drs.Paginator.DescribeSourceServers¶paginator = client.get_paginator('describe_source_servers')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from drs.Client.describe_source_servers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters={
'hardwareId': 'string',
'sourceServerIDs': [
'string',
],
'stagingAccountIDs': [
'string',
]
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A set of filters by which to return Source Servers.
An ID that describes the hardware of the Source Server. This is either an EC2 instance id, a VMware uuid or a mac address.
An array of Source Servers IDs that should be returned. An empty array means all Source Servers.
An array of staging account IDs that extended source servers belong to. An empty array means all source servers will be shown.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
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',
'stagingArea': {
'errorMessage': 'string',
'stagingAccountID': 'string',
'stagingSourceServerArn': 'string',
'status': 'EXTENDED'|'EXTENSION_ERROR'|'NOT_EXTENDED'
},
'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.
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.
stagingArea (dict) --
The staging area of the source server.
errorMessage (string) --
Shows an error message that occurred when DRS tried to access the staging source server. In this case StagingArea$status will have value EXTENSION_ERROR
stagingAccountID (string) --
Account ID of the account to which source server belongs. If this source server is extended - shows Account ID of staging source server.
stagingSourceServerArn (string) --
Arn of the staging source server if this source server is extended
status (string) --
Status of Source server extension. Possible values: (a) NOT_EXTENDED - This is a source server that is replicating in the current account. (b) EXTENDED - Source server is extended from a staging source server. In this case, the value of stagingSourceServerArn is pointing to the Arn of the source server in the staging account. (c) EXTENSION_ERROR - Some issue occurred when accessing staging source server. In this case, errorMessage field will contain an error message that explains what happened.
tags (dict) --
The tags associated with the Source Server.
NextToken (string) --
A token to resume pagination.
drs.Paginator.ListExtensibleSourceServers¶paginator = client.get_paginator('list_extensible_source_servers')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from drs.Client.list_extensible_source_servers().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
stagingAccountID='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Id of the staging Account to retrieve extensible source servers from.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'items': [
{
'arn': 'string',
'hostname': 'string',
'tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
items (list) --
A list of source servers on a staging Account that are extensible.
(dict) --
Source server in staging account that extended source server connected to.
arn (string) --
The ARN of the source server.
hostname (string) --
Hostname of staging source server.
tags (dict) --
A list of tags associated with the staging source server.
NextToken (string) --
A token to resume pagination.
drs.Paginator.ListStagingAccounts¶paginator = client.get_paginator('list_staging_accounts')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from drs.Client.list_staging_accounts().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'accounts': [
{
'accountID': 'string'
},
],
'NextToken': 'string'
}
Response Structure
An array of staging AWS Accounts.
AWS account.
Account ID of AWS account.
A token to resume pagination.