restore_snapshot_tier
¶
restore_snapshot_tier(
*,
config_overrides: Optional[EC2ClientConfig] = None,
snapshot_id: Optional[SnapshotId] = None,
temporary_restore_days: Optional[
RestoreSnapshotTierRequestTemporaryRestoreDays
] = None,
permanent_restore: Optional[Boolean] = None,
dry_run: Optional[Boolean] = None,
) -> RestoreSnapshotTierResult
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 EBS User Guide.
Parameters:
-
snapshot_id(Optional[SnapshotId], default:None) –The ID of the snapshot to restore.
-
temporary_restore_days(Optional[RestoreSnapshotTierRequestTemporaryRestoreDays], default:None) –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. -
permanent_restore(Optional[Boolean], default:None) –Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot, specify
trueand omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter. -
dry_run(Optional[Boolean], default:None) –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 isUnauthorizedOperation.
Raises:
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_ec2/_services/ec2.py
58321 58322 58323 58324 58325 58326 58327 58328 58329 58330 58331 58332 58333 58334 58335 58336 58337 58338 58339 58340 58341 58342 58343 58344 58345 58346 58347 58348 58349 58350 58351 58352 58353 58354 58355 58356 58357 58358 58359 58360 58361 58362 58363 58364 58365 58366 58367 58368 58369 58370 58371 58372 58373 58374 58375 58376 58377 | |