Elastic Disaster Recovery Service

2022/05/31 - Elastic Disaster Recovery Service - 3 new 8 updated api methods

Changes  Changed existing APIs and added new APIs to accommodate using multiple AWS accounts with AWS Elastic Disaster Recovery.

ListStagingAccounts (new) Link ¶

Returns an array of staging accounts for existing extended source servers.

See also: AWS API Documentation

Request Syntax

client.list_staging_accounts(
    maxResults=123,
    nextToken='string'
)
type maxResults

integer

param maxResults

The maximum number of staging Accounts to retrieve.

type nextToken

string

param nextToken

The token of the next staging Account to retrieve.

rtype

dict

returns

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.

ListExtensibleSourceServers (new) Link ¶

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

client.list_extensible_source_servers(
    maxResults=123,
    nextToken='string',
    stagingAccountID='string'
)
type maxResults

integer

param maxResults

The maximum number of extensible source servers to retrieve.

type nextToken

string

param nextToken

The token of the next extensible source server to retrieve.

type stagingAccountID

string

param stagingAccountID

[REQUIRED]

The Id of the staging Account to retrieve extensible source servers from.

rtype

dict

returns

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.

          • (string) --

            • (string) --

    • nextToken (string) --

      The token of the next extensible source server to retrieve.

CreateExtendedSourceServer (new) Link ¶

Create an extended source server in the target Account based on the source server in staging account.

See also: AWS API Documentation

Request Syntax

client.create_extended_source_server(
    sourceServerArn='string',
    tags={
        'string': 'string'
    }
)
type sourceServerArn

string

param sourceServerArn

[REQUIRED]

This defines the ARN of the source server in staging Account based on which you want to create an extended source server.

type tags

dict

param tags

A list of tags associated with the extended source server.

  • (string) --

    • (string) --

rtype

dict

returns

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.

              • (string) --

            • isPrimary (boolean) --

              Whether this is the primary network interface.

            • macAddress (string) --

              The MAC address of the network interface.

        • os (dict) --

          Operating system.

          • fullString (string) --

            The long name of the Operating System.

        • ramBytes (integer) --

          The amount of RAM in bytes.

        • recommendedInstanceType (string) --

          The recommended EC2 instance type that will be used when recovering the Source Server.

      • sourceServerID (string) --

        The ID of the Source Server.

      • 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.

        • (string) --

          • (string) --

DescribeJobLogItems (updated) Link ¶
Changes (response)
{'items': {'eventData': {'conversionProperties': {'dataTimestamp': 'string',
                                                  'forceUefi': 'boolean',
                                                  'rootVolumeName': 'string',
                                                  'volumeToConversionMap': {'string': {'string': 'string'}},
                                                  'volumeToVolumeSize': {'string': 'long'}}}}}

Retrieves a detailed Job log with pagination.

See also: AWS API Documentation

Request Syntax

client.describe_job_log_items(
    jobID='string',
    maxResults=123,
    nextToken='string'
)
type jobID

string

param jobID

[REQUIRED]

The ID of the Job for which Job log items will be retrieved.

type maxResults

integer

param maxResults

Maximum number of Job log items to retrieve.

type nextToken

string

param nextToken

The token of the next Job log items to retrieve.

rtype

dict

returns

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

              • (string) --

                • (dict) --

                  • (string) --

                    • (string) --

            • volumeToVolumeSize (dict) --

              A mapping between the volumes and their sizes

              • (string) --

                • (integer) --

          • 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.

DescribeJobs (updated) Link ¶
Changes (response)
{'items': {'initiatedBy': {'TARGET_ACCOUNT'},
           'type': {'CREATE_CONVERTED_SNAPSHOT'}}}

Returns a list of Jobs. Use the JobsID and fromDate and toDate filters to limit which jobs are returned. The response is sorted by creationDataTime - latest date first. Jobs are created by the StartRecovery, TerminateRecoveryInstances and StartFailbackLaunch APIs. Jobs are also created by DiagnosticLaunch and TerminateDiagnosticInstances, which are APIs available only to Support and only used in response to relevant support tickets.

See also: AWS API Documentation

Request Syntax

client.describe_jobs(
    filters={
        'fromDate': 'string',
        'jobIDs': [
            'string',
        ],
        'toDate': 'string'
    },
    maxResults=123,
    nextToken='string'
)
type filters

dict

param filters

A set of filters by which to return Jobs.

  • fromDate (string) --

    The start date in a date range query.

  • jobIDs (list) --

    An array of Job IDs that should be returned. An empty array means all jobs.

    • (string) --

  • toDate (string) --

    The end date in a date range query.

type maxResults

integer

param maxResults

Maximum number of Jobs to retrieve.

type nextToken

string

param nextToken

The token of the next Job to retrieve.

rtype

dict

returns

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.

          • (string) --

            • (string) --

        • type (string) --

          The type of the Job.

    • nextToken (string) --

      The token of the next Job to retrieve.

DescribeSourceServers (updated) Link ¶
Changes (request, response)
Request
{'filters': {'stagingAccountIDs': ['string']}}
Response
{'items': {'stagingArea': {'errorMessage': 'string',
                           'stagingAccountID': 'string',
                           'stagingSourceServerArn': 'string',
                           'status': 'EXTENDED | EXTENSION_ERROR | '
                                     'NOT_EXTENDED'}}}

Lists all Source Servers or multiple Source Servers filtered by ID.

See also: AWS API Documentation

Request Syntax

client.describe_source_servers(
    filters={
        'hardwareId': 'string',
        'sourceServerIDs': [
            'string',
        ],
        'stagingAccountIDs': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string'
)
type filters

dict

param filters

A set of filters by which to return Source Servers.

  • hardwareId (string) --

    An ID that describes the hardware of the Source Server. This is either an EC2 instance id, a VMware uuid or a mac address.

  • sourceServerIDs (list) --

    An array of Source Servers IDs that should be returned. An empty array means all Source Servers.

    • (string) --

  • stagingAccountIDs (list) --

    An array of staging account IDs that extended source servers belong to. An empty array means all source servers will be shown.

    • (string) --

type maxResults

integer

param maxResults

Maximum number of Source Servers to retrieve.

type nextToken

string

param nextToken

The token of the next Source Server to retrieve.

rtype

dict

returns

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.

                • (string) --

              • isPrimary (boolean) --

                Whether this is the primary network interface.

              • macAddress (string) --

                The MAC address of the network interface.

          • os (dict) --

            Operating system.

            • fullString (string) --

              The long name of the Operating System.

          • ramBytes (integer) --

            The amount of RAM in bytes.

          • recommendedInstanceType (string) --

            The recommended EC2 instance type that will be used when recovering the Source Server.

        • sourceServerID (string) --

          The ID of the Source Server.

        • 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.

          • (string) --

            • (string) --

    • nextToken (string) --

      The token of the next Source Server to retrieve.

DisconnectSourceServer (updated) Link ¶
Changes (response)
{'stagingArea': {'errorMessage': 'string',
                 'stagingAccountID': 'string',
                 'stagingSourceServerArn': 'string',
                 'status': 'EXTENDED | EXTENSION_ERROR | NOT_EXTENDED'}}

Disconnects a specific Source Server from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Source Server will be terminated / deleted within 90 minutes. You cannot disconnect a Source Server if it has a Recovery Instance. If the agent on the Source Server has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the SourceServer will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.

See also: AWS API Documentation

Request Syntax

client.disconnect_source_server(
    sourceServerID='string'
)
type sourceServerID

string

param sourceServerID

[REQUIRED]

The ID of the Source Server to disconnect.

rtype

dict

returns

Response Syntax

{
    'arn': 'string',
    'dataReplicationInfo': {
        'dataReplicationError': {
            'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER',
            'rawError': 'string'
        },
        'dataReplicationInitiation': {
            'nextAttemptDateTime': 'string',
            'startDateTime': 'string',
            'steps': [
                {
                    'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED',
        'etaDateTime': 'string',
        'lagDuration': 'string',
        'replicatedDisks': [
            {
                'backloggedStorageBytes': 123,
                'deviceName': 'string',
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'totalStorageBytes': 123
            },
        ]
    },
    'lastLaunchResult': 'NOT_STARTED'|'PENDING'|'SUCCEEDED'|'FAILED',
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'firstByteDateTime': 'string',
        'lastLaunch': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string',
                'type': 'RECOVERY'|'DRILL'
            }
        },
        'lastSeenByServiceDateTime': 'string'
    },
    'recoveryInstanceId': 'string',
    'sourceProperties': {
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'disks': [
            {
                'bytes': 123,
                'deviceName': 'string'
            },
        ],
        'identificationHints': {
            'awsInstanceID': 'string',
            'fqdn': 'string',
            'hostname': 'string',
            'vmWareUuid': 'string'
        },
        'lastUpdatedDateTime': 'string',
        'networkInterfaces': [
            {
                'ips': [
                    'string',
                ],
                'isPrimary': True|False,
                'macAddress': 'string'
            },
        ],
        'os': {
            'fullString': 'string'
        },
        'ramBytes': 123,
        'recommendedInstanceType': 'string'
    },
    'sourceServerID': 'string',
    'stagingArea': {
        'errorMessage': 'string',
        'stagingAccountID': 'string',
        'stagingSourceServerArn': 'string',
        'status': 'EXTENDED'|'EXTENSION_ERROR'|'NOT_EXTENDED'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • arn (string) --

      The ARN of the Source Server.

    • dataReplicationInfo (dict) --

      The Data Replication Info of the Source Server.

      • dataReplicationError (dict) --

        Error in data replication.

        • error (string) --

          Error in data replication.

        • rawError (string) --

          Error in data replication.

      • dataReplicationInitiation (dict) --

        Information about whether the data replication has been initiated.

        • nextAttemptDateTime (string) --

          The date and time of the next attempt to initiate data replication.

        • startDateTime (string) --

          The date and time of the current attempt to initiate data replication.

        • steps (list) --

          The steps of the current attempt to initiate data replication.

          • (dict) --

            Data replication initiation step.

            • name (string) --

              The name of the step.

            • status (string) --

              The status of the step.

      • dataReplicationState (string) --

        The state of the data replication.

      • etaDateTime (string) --

        An estimate of when the data replication will be completed.

      • lagDuration (string) --

        Data replication lag duration.

      • replicatedDisks (list) --

        The disks that should be replicated.

        • (dict) --

          A disk that should be replicated.

          • backloggedStorageBytes (integer) --

            The size of the replication backlog in bytes.

          • deviceName (string) --

            The name of the device.

          • replicatedStorageBytes (integer) --

            The amount of data replicated so far in bytes.

          • rescannedStorageBytes (integer) --

            The amount of data to be rescanned in bytes.

          • totalStorageBytes (integer) --

            The total amount of data to be replicated in bytes.

    • lastLaunchResult (string) --

      The status of the last recovery launch of this Source Server.

    • lifeCycle (dict) --

      The lifecycle information of this Source Server.

      • addedToServiceDateTime (string) --

        The date and time of when the Source Server was added to the service.

      • elapsedReplicationDuration (string) --

        The amount of time that the Source Server has been replicating for.

      • firstByteDateTime (string) --

        The date and time of the first byte that was replicated from the Source Server.

      • lastLaunch (dict) --

        An object containing information regarding the last launch of the Source Server.

        • initiated (dict) --

          An object containing information regarding the initiation of the last launch of a Source Server.

          • apiCallDateTime (string) --

            The date and time the last Source Server launch was initiated.

          • jobID (string) --

            The ID of the Job that was used to last launch the Source Server.

          • type (string) --

            The Job type that was used to last launch the Source Server.

      • lastSeenByServiceDateTime (string) --

        The date and time this Source Server was last seen by the service.

    • recoveryInstanceId (string) --

      The ID of the Recovery Instance associated with this Source Server.

    • sourceProperties (dict) --

      The source properties of the Source Server.

      • cpus (list) --

        An array of CPUs.

        • (dict) --

          Information about a server's CPU.

          • cores (integer) --

            The number of CPU cores.

          • modelName (string) --

            The model name of the CPU.

      • disks (list) --

        An array of disks.

        • (dict) --

          An object representing a data storage device on a server.

          • bytes (integer) --

            The amount of storage on the disk in bytes.

          • deviceName (string) --

            The disk or device name.

      • identificationHints (dict) --

        Hints used to uniquely identify a machine.

        • awsInstanceID (string) --

          AWS Instance ID identification hint.

        • fqdn (string) --

          Fully Qualified Domain Name identification hint.

        • hostname (string) --

          Hostname identification hint.

        • vmWareUuid (string) --

          vCenter VM path identification hint.

      • lastUpdatedDateTime (string) --

        The date and time the Source Properties were last updated on.

      • networkInterfaces (list) --

        An array of network interfaces.

        • (dict) --

          Network interface.

          • ips (list) --

            Network interface IPs.

            • (string) --

          • isPrimary (boolean) --

            Whether this is the primary network interface.

          • macAddress (string) --

            The MAC address of the network interface.

      • os (dict) --

        Operating system.

        • fullString (string) --

          The long name of the Operating System.

      • ramBytes (integer) --

        The amount of RAM in bytes.

      • recommendedInstanceType (string) --

        The recommended EC2 instance type that will be used when recovering the Source Server.

    • sourceServerID (string) --

      The ID of the Source Server.

    • 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.

      • (string) --

        • (string) --

RetryDataReplication (updated) Link ¶
Changes (response)
{'stagingArea': {'errorMessage': 'string',
                 'stagingAccountID': 'string',
                 'stagingSourceServerArn': 'string',
                 'status': 'EXTENDED | EXTENSION_ERROR | NOT_EXTENDED'}}

Causes the data replication initiation sequence to begin immediately upon next Handshake for the specified Source Server ID, regardless of when the previous initiation started. This command will work only if the Source Server is stalled or is in a DISCONNECTED or STOPPED state.

See also: AWS API Documentation

Request Syntax

client.retry_data_replication(
    sourceServerID='string'
)
type sourceServerID

string

param sourceServerID

[REQUIRED]

The ID of the Source Server whose data replication should be retried.

rtype

dict

returns

Response Syntax

{
    'arn': 'string',
    'dataReplicationInfo': {
        'dataReplicationError': {
            'error': 'AGENT_NOT_SEEN'|'SNAPSHOTS_FAILURE'|'NOT_CONVERGING'|'UNSTABLE_NETWORK'|'FAILED_TO_CREATE_SECURITY_GROUP'|'FAILED_TO_LAUNCH_REPLICATION_SERVER'|'FAILED_TO_BOOT_REPLICATION_SERVER'|'FAILED_TO_AUTHENTICATE_WITH_SERVICE'|'FAILED_TO_DOWNLOAD_REPLICATION_SOFTWARE'|'FAILED_TO_CREATE_STAGING_DISKS'|'FAILED_TO_ATTACH_STAGING_DISKS'|'FAILED_TO_PAIR_REPLICATION_SERVER_WITH_AGENT'|'FAILED_TO_CONNECT_AGENT_TO_REPLICATION_SERVER'|'FAILED_TO_START_DATA_TRANSFER',
            'rawError': 'string'
        },
        'dataReplicationInitiation': {
            'nextAttemptDateTime': 'string',
            'startDateTime': 'string',
            'steps': [
                {
                    'name': 'WAIT'|'CREATE_SECURITY_GROUP'|'LAUNCH_REPLICATION_SERVER'|'BOOT_REPLICATION_SERVER'|'AUTHENTICATE_WITH_SERVICE'|'DOWNLOAD_REPLICATION_SOFTWARE'|'CREATE_STAGING_DISKS'|'ATTACH_STAGING_DISKS'|'PAIR_REPLICATION_SERVER_WITH_AGENT'|'CONNECT_AGENT_TO_REPLICATION_SERVER'|'START_DATA_TRANSFER',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'SKIPPED'
                },
            ]
        },
        'dataReplicationState': 'STOPPED'|'INITIATING'|'INITIAL_SYNC'|'BACKLOG'|'CREATING_SNAPSHOT'|'CONTINUOUS'|'PAUSED'|'RESCAN'|'STALLED'|'DISCONNECTED',
        'etaDateTime': 'string',
        'lagDuration': 'string',
        'replicatedDisks': [
            {
                'backloggedStorageBytes': 123,
                'deviceName': 'string',
                'replicatedStorageBytes': 123,
                'rescannedStorageBytes': 123,
                'totalStorageBytes': 123
            },
        ]
    },
    'lastLaunchResult': 'NOT_STARTED'|'PENDING'|'SUCCEEDED'|'FAILED',
    'lifeCycle': {
        'addedToServiceDateTime': 'string',
        'elapsedReplicationDuration': 'string',
        'firstByteDateTime': 'string',
        'lastLaunch': {
            'initiated': {
                'apiCallDateTime': 'string',
                'jobID': 'string',
                'type': 'RECOVERY'|'DRILL'
            }
        },
        'lastSeenByServiceDateTime': 'string'
    },
    'recoveryInstanceId': 'string',
    'sourceProperties': {
        'cpus': [
            {
                'cores': 123,
                'modelName': 'string'
            },
        ],
        'disks': [
            {
                'bytes': 123,
                'deviceName': 'string'
            },
        ],
        'identificationHints': {
            'awsInstanceID': 'string',
            'fqdn': 'string',
            'hostname': 'string',
            'vmWareUuid': 'string'
        },
        'lastUpdatedDateTime': 'string',
        'networkInterfaces': [
            {
                'ips': [
                    'string',
                ],
                'isPrimary': True|False,
                'macAddress': 'string'
            },
        ],
        'os': {
            'fullString': 'string'
        },
        'ramBytes': 123,
        'recommendedInstanceType': 'string'
    },
    'sourceServerID': 'string',
    'stagingArea': {
        'errorMessage': 'string',
        'stagingAccountID': 'string',
        'stagingSourceServerArn': 'string',
        'status': 'EXTENDED'|'EXTENSION_ERROR'|'NOT_EXTENDED'
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • arn (string) --

      The ARN of the Source Server.

    • dataReplicationInfo (dict) --

      The Data Replication Info of the Source Server.

      • dataReplicationError (dict) --

        Error in data replication.

        • error (string) --

          Error in data replication.

        • rawError (string) --

          Error in data replication.

      • dataReplicationInitiation (dict) --

        Information about whether the data replication has been initiated.

        • nextAttemptDateTime (string) --

          The date and time of the next attempt to initiate data replication.

        • startDateTime (string) --

          The date and time of the current attempt to initiate data replication.

        • steps (list) --

          The steps of the current attempt to initiate data replication.

          • (dict) --

            Data replication initiation step.

            • name (string) --

              The name of the step.

            • status (string) --

              The status of the step.

      • dataReplicationState (string) --

        The state of the data replication.

      • etaDateTime (string) --

        An estimate of when the data replication will be completed.

      • lagDuration (string) --

        Data replication lag duration.

      • replicatedDisks (list) --

        The disks that should be replicated.

        • (dict) --

          A disk that should be replicated.

          • backloggedStorageBytes (integer) --

            The size of the replication backlog in bytes.

          • deviceName (string) --

            The name of the device.

          • replicatedStorageBytes (integer) --

            The amount of data replicated so far in bytes.

          • rescannedStorageBytes (integer) --

            The amount of data to be rescanned in bytes.

          • totalStorageBytes (integer) --

            The total amount of data to be replicated in bytes.

    • lastLaunchResult (string) --

      The status of the last recovery launch of this Source Server.

    • lifeCycle (dict) --

      The lifecycle information of this Source Server.

      • addedToServiceDateTime (string) --

        The date and time of when the Source Server was added to the service.

      • elapsedReplicationDuration (string) --

        The amount of time that the Source Server has been replicating for.

      • firstByteDateTime (string) --

        The date and time of the first byte that was replicated from the Source Server.

      • lastLaunch (dict) --

        An object containing information regarding the last launch of the Source Server.

        • initiated (dict) --

          An object containing information regarding the initiation of the last launch of a Source Server.

          • apiCallDateTime (string) --

            The date and time the last Source Server launch was initiated.

          • jobID (string) --

            The ID of the Job that was used to last launch the Source Server.

          • type (string) --

            The Job type that was used to last launch the Source Server.

      • lastSeenByServiceDateTime (string) --

        The date and time this Source Server was last seen by the service.

    • recoveryInstanceId (string) --

      The ID of the Recovery Instance associated with this Source Server.

    • sourceProperties (dict) --

      The source properties of the Source Server.

      • cpus (list) --

        An array of CPUs.

        • (dict) --

          Information about a server's CPU.

          • cores (integer) --

            The number of CPU cores.

          • modelName (string) --

            The model name of the CPU.

      • disks (list) --

        An array of disks.

        • (dict) --

          An object representing a data storage device on a server.

          • bytes (integer) --

            The amount of storage on the disk in bytes.

          • deviceName (string) --

            The disk or device name.

      • identificationHints (dict) --

        Hints used to uniquely identify a machine.

        • awsInstanceID (string) --

          AWS Instance ID identification hint.

        • fqdn (string) --

          Fully Qualified Domain Name identification hint.

        • hostname (string) --

          Hostname identification hint.

        • vmWareUuid (string) --

          vCenter VM path identification hint.

      • lastUpdatedDateTime (string) --

        The date and time the Source Properties were last updated on.

      • networkInterfaces (list) --

        An array of network interfaces.

        • (dict) --

          Network interface.

          • ips (list) --

            Network interface IPs.

            • (string) --

          • isPrimary (boolean) --

            Whether this is the primary network interface.

          • macAddress (string) --

            The MAC address of the network interface.

      • os (dict) --

        Operating system.

        • fullString (string) --

          The long name of the Operating System.

      • ramBytes (integer) --

        The amount of RAM in bytes.

      • recommendedInstanceType (string) --

        The recommended EC2 instance type that will be used when recovering the Source Server.

    • sourceServerID (string) --

      The ID of the Source Server.

    • 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.

      • (string) --

        • (string) --

StartFailbackLaunch (updated) Link ¶
Changes (response)
{'job': {'initiatedBy': {'TARGET_ACCOUNT'},
         'type': {'CREATE_CONVERTED_SNAPSHOT'}}}

Initiates a Job for launching the machine that is being failed back to from the specified Recovery Instance. This will run conversion on the failback client and will reboot your machine, thus completing the failback process.

See also: AWS API Documentation

Request Syntax

client.start_failback_launch(
    recoveryInstanceIDs=[
        'string',
    ],
    tags={
        'string': 'string'
    }
)
type recoveryInstanceIDs

list

param recoveryInstanceIDs

[REQUIRED]

The IDs of the Recovery Instance whose failback launch we want to request.

  • (string) --

type tags

dict

param tags

The tags to be associated with the failback launch Job.

  • (string) --

    • (string) --

rtype

dict

returns

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.

        • (string) --

          • (string) --

      • type (string) --

        The type of the Job.

StartRecovery (updated) Link ¶
Changes (response)
{'job': {'initiatedBy': {'TARGET_ACCOUNT'},
         'type': {'CREATE_CONVERTED_SNAPSHOT'}}}

Launches Recovery Instances for the specified Source Servers. For each Source Server you may choose a point in time snapshot to launch from, or use an on demand snapshot.

See also: AWS API Documentation

Request Syntax

client.start_recovery(
    isDrill=True|False,
    sourceServers=[
        {
            'recoverySnapshotID': 'string',
            'sourceServerID': 'string'
        },
    ],
    tags={
        'string': 'string'
    }
)
type isDrill

boolean

param isDrill

Whether this Source Server Recovery operation is a drill or not.

type sourceServers

list

param sourceServers

[REQUIRED]

The Source Servers that we want to start a Recovery Job for.

  • (dict) --

    An object representing the Source Server to recover.

    • recoverySnapshotID (string) --

      The ID of a Recovery Snapshot we want to recover from. Omit this field to launch from the latest data by taking an on-demand snapshot.

    • sourceServerID (string) -- [REQUIRED]

      The ID of the Source Server you want to recover.

type tags

dict

param tags

The tags to be associated with the Recovery Job.

  • (string) --

    • (string) --

rtype

dict

returns

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.

        • (string) --

          • (string) --

      • type (string) --

        The type of the Job.

TerminateRecoveryInstances (updated) Link ¶
Changes (response)
{'job': {'initiatedBy': {'TARGET_ACCOUNT'},
         'type': {'CREATE_CONVERTED_SNAPSHOT'}}}

Initiates a Job for terminating the EC2 resources associated with the specified Recovery Instances, and then will delete the Recovery Instances from the Elastic Disaster Recovery service.

See also: AWS API Documentation

Request Syntax

client.terminate_recovery_instances(
    recoveryInstanceIDs=[
        'string',
    ]
)
type recoveryInstanceIDs

list

param recoveryInstanceIDs

[REQUIRED]

The IDs of the Recovery Instances that should be terminated.

  • (string) --

rtype

dict

returns

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 Job for terminating the Recovery Instances.

      • arn (string) --

        The ARN of a Job.

      • creationDateTime (string) --

        The date and time of when the Job was created.

      • endDateTime (string) --

        The date and time of when the Job ended.

      • initiatedBy (string) --

        A string representing who initiated the Job.

      • jobID (string) --

        The ID of the Job.

      • participatingServers (list) --

        A list of servers that the Job is acting upon.

        • (dict) --

          Represents a server participating in an asynchronous Job.

          • launchStatus (string) --

            The launch status of a participating server.

          • recoveryInstanceID (string) --

            The Recovery Instance ID of a participating server.

          • sourceServerID (string) --

            The Source Server ID of a participating server.

      • status (string) --

        The status of the Job.

      • tags (dict) --

        A list of tags associated with the Job.

        • (string) --

          • (string) --

      • type (string) --

        The type of the Job.