CloudHSMV2 / Client / restore_backup

restore_backup#

CloudHSMV2.Client.restore_backup(**kwargs)#

Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information on deleting a backup, see DeleteBackup.

Request Syntax

response = client.restore_backup(
    BackupId='string'
)

Parameters:

BackupId (string) –

[REQUIRED]

The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.

Return type:

dict

Returns:

Response Syntax

{
    'Backup': {
        'BackupId': 'string',
        'BackupState': 'CREATE_IN_PROGRESS'|'READY'|'DELETED'|'PENDING_DELETION',
        'ClusterId': 'string',
        'CreateTimestamp': datetime(2015, 1, 1),
        'CopyTimestamp': datetime(2015, 1, 1),
        'NeverExpires': True|False,
        'SourceRegion': 'string',
        'SourceBackup': 'string',
        'SourceCluster': 'string',
        'DeleteTimestamp': datetime(2015, 1, 1),
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- Backup (dict) –
  
  Information on the Backup object created.
  - BackupId (string) –
    
    The identifier (ID) of the backup.
  - BackupState (string) –
    
    The state of the backup.
  - ClusterId (string) –
    
    The identifier (ID) of the cluster that was backed up.
  - CreateTimestamp (datetime) –
    
    The date and time when the backup was created.
  - CopyTimestamp (datetime) –
    
    The date and time when the backup was copied from a source backup.
  - NeverExpires (boolean) –
    
    Specifies whether the service should exempt a backup from the retention policy for the cluster. True exempts a backup from the retention policy. False means the service applies the backup retention policy defined at the cluster.
  - SourceRegion (string) –
    
    The AWS Region that contains the source backup from which the new backup was copied.
  - SourceBackup (string) –
    
    The identifier (ID) of the source backup from which the new backup was copied.
  - SourceCluster (string) –
    
    The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
  - DeleteTimestamp (datetime) –
    
    The date and time when the backup will be permanently deleted.
  - TagList (list) –
    
    The list of tags for the backup.
    - (dict) –
      
      Contains a tag. A tag is a key-value pair.
      - Key (string) –
        
        The key of the tag.
      - Value (string) –
        
        The value of the tag.

Exceptions

CloudHSMV2.Client.exceptions.CloudHsmAccessDeniedException
CloudHSMV2.Client.exceptions.CloudHsmInternalFailureException
CloudHSMV2.Client.exceptions.CloudHsmInvalidRequestException
CloudHSMV2.Client.exceptions.CloudHsmResourceNotFoundException
CloudHSMV2.Client.exceptions.CloudHsmServiceException