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

Amazonka.EC2.RestoreSnapshotTier

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- dryRun :: Maybe Bool
- permanentRestore :: Maybe Bool
- temporaryRestoreDays :: Maybe Int
- snapshotId :: Text
}
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' {
- isPermanentRestore :: Maybe Bool
- restoreDuration :: Maybe Int
- restoreStartTime :: Maybe ISO8601
- snapshotId :: Maybe Text
- httpStatus :: Int
}
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.

Constructors

RestoreSnapshotTier'

Fields

dryRun :: Maybe Bool
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.
permanentRestore :: Maybe Bool
Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot, specify true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.
temporaryRestoreDays :: Maybe Int
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.
snapshotId :: Text
The ID of the snapshot to restore.

Instances

Instances details

ToHeaders RestoreSnapshotTier Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier Methods toHeaders :: RestoreSnapshotTier -> [Header] #
ToPath RestoreSnapshotTier Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier Methods toPath :: RestoreSnapshotTier -> ByteString #
ToQuery RestoreSnapshotTier Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier Methods toQuery :: RestoreSnapshotTier -> QueryString #
AWSRequest RestoreSnapshotTier Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier Associated Types type AWSResponse RestoreSnapshotTier # Methods request :: (Service -> Service) -> RestoreSnapshotTier -> Request RestoreSnapshotTier # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RestoreSnapshotTier -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RestoreSnapshotTier))) #
Generic RestoreSnapshotTier Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier Associated Types type Rep RestoreSnapshotTier :: Type -> Type # Methods from :: RestoreSnapshotTier -> Rep RestoreSnapshotTier x # to :: Rep RestoreSnapshotTier x -> RestoreSnapshotTier #
Read RestoreSnapshotTier Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier Methods readsPrec :: Int -> ReadS RestoreSnapshotTier # readList :: ReadS [RestoreSnapshotTier] # readPrec :: ReadPrec RestoreSnapshotTier # readListPrec :: ReadPrec [RestoreSnapshotTier] #
Show RestoreSnapshotTier Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier Methods showsPrec :: Int -> RestoreSnapshotTier -> ShowS # show :: RestoreSnapshotTier -> String # showList :: [RestoreSnapshotTier] -> ShowS #
NFData RestoreSnapshotTier Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier Methods rnf :: RestoreSnapshotTier -> () #
Eq RestoreSnapshotTier Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier Methods (==) :: RestoreSnapshotTier -> RestoreSnapshotTier -> Bool # (/=) :: RestoreSnapshotTier -> RestoreSnapshotTier -> Bool #
Hashable RestoreSnapshotTier Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier Methods hashWithSalt :: Int -> RestoreSnapshotTier -> Int # hash :: RestoreSnapshotTier -> Int #
type AWSResponse RestoreSnapshotTier Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier type AWSResponse RestoreSnapshotTier = RestoreSnapshotTierResponse
type Rep RestoreSnapshotTier Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier type Rep RestoreSnapshotTier = D1 ('MetaData "RestoreSnapshotTier" "Amazonka.EC2.RestoreSnapshotTier" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "RestoreSnapshotTier'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "permanentRestore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "temporaryRestoreDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "snapshotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newRestoreSnapshotTier Source #

Arguments

:: Text	`RestoreSnapshotTier`
-> RestoreSnapshotTier

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.

Constructors

RestoreSnapshotTierResponse'

Fields

isPermanentRestore :: Maybe Bool
Indicates whether the snapshot is permanently restored. true indicates a permanent restore. false indicates a temporary restore.
restoreDuration :: Maybe Int
For temporary restores only. The number of days for which the archived snapshot is temporarily restored.
restoreStartTime :: Maybe ISO8601
The date and time when the snapshot restore process started.
snapshotId :: Maybe Text
The ID of the snapshot.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic RestoreSnapshotTierResponse Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier Associated Types type Rep RestoreSnapshotTierResponse :: Type -> Type # Methods from :: RestoreSnapshotTierResponse -> Rep RestoreSnapshotTierResponse x # to :: Rep RestoreSnapshotTierResponse x -> RestoreSnapshotTierResponse #
Read RestoreSnapshotTierResponse Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier Methods readsPrec :: Int -> ReadS RestoreSnapshotTierResponse # readList :: ReadS [RestoreSnapshotTierResponse] # readPrec :: ReadPrec RestoreSnapshotTierResponse # readListPrec :: ReadPrec [RestoreSnapshotTierResponse] #
Show RestoreSnapshotTierResponse Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier Methods showsPrec :: Int -> RestoreSnapshotTierResponse -> ShowS # show :: RestoreSnapshotTierResponse -> String # showList :: [RestoreSnapshotTierResponse] -> ShowS #
NFData RestoreSnapshotTierResponse Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier Methods rnf :: RestoreSnapshotTierResponse -> () #
Eq RestoreSnapshotTierResponse Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier Methods (==) :: RestoreSnapshotTierResponse -> RestoreSnapshotTierResponse -> Bool # (/=) :: RestoreSnapshotTierResponse -> RestoreSnapshotTierResponse -> Bool #
type Rep RestoreSnapshotTierResponse Source #
Instance details Defined in Amazonka.EC2.RestoreSnapshotTier type Rep RestoreSnapshotTierResponse = D1 ('MetaData "RestoreSnapshotTierResponse" "Amazonka.EC2.RestoreSnapshotTier" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "RestoreSnapshotTierResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "isPermanentRestore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "restoreDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "restoreStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "snapshotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newRestoreSnapshotTierResponse Source #

Arguments

:: Int	`$sel:httpStatus:RestoreSnapshotTierResponse'`
-> RestoreSnapshotTierResponse

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.