drs / Client / terminate_recovery_instances

terminate_recovery_instances#

drs.Client.terminate_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.

Request Syntax

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

Parameters:

recoveryInstanceIDs (list) –

[REQUIRED]

The IDs of the Recovery Instances that should be terminated.

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

Exceptions

drs.Client.exceptions.InternalServerException
drs.Client.exceptions.ConflictException
drs.Client.exceptions.ServiceQuotaExceededException
drs.Client.exceptions.ThrottlingException
drs.Client.exceptions.UninitializedAccountException