EC2 / Client / restore_snapshot_tier

restore_snapshot_tier#

EC2.Client.restore_snapshot_tier(**kwargs)#

Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.

For more information see Restore an archived snapshot and modify the restore period or restore type for a temporarily restored snapshot in the Amazon Elastic Compute Cloud User Guide.

See also: AWS API Documentation

Request Syntax

response = client.restore_snapshot_tier(
    SnapshotId='string',
    TemporaryRestoreDays=123,
    PermanentRestore=True|False,
    DryRun=True|False
)
Parameters:

  • SnapshotId (string) –

    [REQUIRED]

    The ID of the snapshot to restore.

  • TemporaryRestoreDays (integer) –

    Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.

    To temporarily restore an archived snapshot, specify the number of days and omit the PermanentRestore parameter or set it to false.

  • PermanentRestore (boolean) – Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot, specify true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.

  • DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'SnapshotId': 'string',
    'RestoreStartTime': datetime(2015, 1, 1),
    'RestoreDuration': 123,
    'IsPermanentRestore': True|False
}

Response Structure

  • (dict) –

    • SnapshotId (string) –

      The ID of the snapshot.

    • RestoreStartTime (datetime) –

      The date and time when the snapshot restore process started.

    • RestoreDuration (integer) –

      For temporary restores only. The number of days for which the archived snapshot is temporarily restored.

    • IsPermanentRestore (boolean) –

      Indicates whether the snapshot is permanently restored. true indicates a permanent restore. false indicates a temporary restore.