Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data RestoreSnapshotTier = RestoreSnapshotTier' {}
- newRestoreSnapshotTier :: Text -> RestoreSnapshotTier
- restoreSnapshotTier_dryRun :: Lens' RestoreSnapshotTier (Maybe Bool)
- restoreSnapshotTier_permanentRestore :: Lens' RestoreSnapshotTier (Maybe Bool)
- restoreSnapshotTier_temporaryRestoreDays :: Lens' RestoreSnapshotTier (Maybe Int)
- restoreSnapshotTier_snapshotId :: Lens' RestoreSnapshotTier Text
- data RestoreSnapshotTierResponse = RestoreSnapshotTierResponse' {}
- newRestoreSnapshotTierResponse :: Int -> RestoreSnapshotTierResponse
- restoreSnapshotTierResponse_isPermanentRestore :: Lens' RestoreSnapshotTierResponse (Maybe Bool)
- restoreSnapshotTierResponse_restoreDuration :: Lens' RestoreSnapshotTierResponse (Maybe Int)
- restoreSnapshotTierResponse_restoreStartTime :: Lens' RestoreSnapshotTierResponse (Maybe UTCTime)
- restoreSnapshotTierResponse_snapshotId :: Lens' RestoreSnapshotTierResponse (Maybe Text)
- restoreSnapshotTierResponse_httpStatus :: Lens' RestoreSnapshotTierResponse Int
Creating a Request
data RestoreSnapshotTier Source #
See: newRestoreSnapshotTier
smart constructor.
RestoreSnapshotTier' | |
|
Instances
newRestoreSnapshotTier Source #
Create a value of RestoreSnapshotTier
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dryRun:RestoreSnapshotTier'
, restoreSnapshotTier_dryRun
- 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
.
$sel:permanentRestore:RestoreSnapshotTier'
, restoreSnapshotTier_permanentRestore
- Indicates whether to permanently restore an archived snapshot. To
permanently restore an archived snapshot, specify true
and omit the
RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.
$sel:temporaryRestoreDays:RestoreSnapshotTier'
, restoreSnapshotTier_temporaryRestoreDays
- 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
.
RestoreSnapshotTier
, restoreSnapshotTier_snapshotId
- The ID of the snapshot to restore.
Request Lenses
restoreSnapshotTier_dryRun :: Lens' RestoreSnapshotTier (Maybe Bool) Source #
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
.
restoreSnapshotTier_permanentRestore :: Lens' RestoreSnapshotTier (Maybe Bool) Source #
Indicates whether to permanently restore an archived snapshot. To
permanently restore an archived snapshot, specify true
and omit the
RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.
restoreSnapshotTier_temporaryRestoreDays :: Lens' RestoreSnapshotTier (Maybe Int) Source #
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
.
restoreSnapshotTier_snapshotId :: Lens' RestoreSnapshotTier Text Source #
The ID of the snapshot to restore.
Destructuring the Response
data RestoreSnapshotTierResponse Source #
See: newRestoreSnapshotTierResponse
smart constructor.
RestoreSnapshotTierResponse' | |
|
Instances
newRestoreSnapshotTierResponse Source #
Create a value of RestoreSnapshotTierResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:isPermanentRestore:RestoreSnapshotTierResponse'
, restoreSnapshotTierResponse_isPermanentRestore
- Indicates whether the snapshot is permanently restored. true
indicates
a permanent restore. false
indicates a temporary restore.
$sel:restoreDuration:RestoreSnapshotTierResponse'
, restoreSnapshotTierResponse_restoreDuration
- For temporary restores only. The number of days for which the archived
snapshot is temporarily restored.
$sel:restoreStartTime:RestoreSnapshotTierResponse'
, restoreSnapshotTierResponse_restoreStartTime
- The date and time when the snapshot restore process started.
RestoreSnapshotTier
, restoreSnapshotTierResponse_snapshotId
- The ID of the snapshot.
$sel:httpStatus:RestoreSnapshotTierResponse'
, restoreSnapshotTierResponse_httpStatus
- The response's http status code.
Response Lenses
restoreSnapshotTierResponse_isPermanentRestore :: Lens' RestoreSnapshotTierResponse (Maybe Bool) Source #
Indicates whether the snapshot is permanently restored. true
indicates
a permanent restore. false
indicates a temporary restore.
restoreSnapshotTierResponse_restoreDuration :: Lens' RestoreSnapshotTierResponse (Maybe Int) Source #
For temporary restores only. The number of days for which the archived snapshot is temporarily restored.
restoreSnapshotTierResponse_restoreStartTime :: Lens' RestoreSnapshotTierResponse (Maybe UTCTime) Source #
The date and time when the snapshot restore process started.
restoreSnapshotTierResponse_snapshotId :: Lens' RestoreSnapshotTierResponse (Maybe Text) Source #
The ID of the snapshot.
restoreSnapshotTierResponse_httpStatus :: Lens' RestoreSnapshotTierResponse Int Source #
The response's http status code.