drs / Client / start_failback_launch

start_failback_launch

drs.Client.start_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'
    }
)

Parameters:

• recoveryInstanceIDs (list) –

  [REQUIRED]

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

  • (string) –

• tags (dict) –

  The tags to be associated with the failback launch Job.

  • (string) –

    • (string) –

Return type:

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.

Exceptions

• drs.Client.exceptions.InternalServerException

• drs.Client.exceptions.ConflictException

• drs.Client.exceptions.ServiceQuotaExceededException

• drs.Client.exceptions.ThrottlingException

• drs.Client.exceptions.ValidationException

• drs.Client.exceptions.UninitializedAccountException