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.FSx.RestoreVolumeFromSnapshot

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.

Synopsis

Creating a Request

data RestoreVolumeFromSnapshot Source #

See: newRestoreVolumeFromSnapshot smart constructor.

Constructors

RestoreVolumeFromSnapshot'

Fields

clientRequestToken :: Maybe Text
options :: Maybe [RestoreOpenZFSVolumeOption]
The settings used when restoring the specified volume from snapshot.
- DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, RestoreVolumeFromSnapshot fails.
- DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, RestoreVolumeFromSnapshot fails.
volumeId :: Text
The ID of the volume that you are restoring.
snapshotId :: Text
The ID of the source snapshot. Specifies the snapshot that you are restoring from.

Instances

Instances details

ToJSON RestoreVolumeFromSnapshot Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Methods toJSON :: RestoreVolumeFromSnapshot -> Value # toEncoding :: RestoreVolumeFromSnapshot -> Encoding # toJSONList :: [RestoreVolumeFromSnapshot] -> Value # toEncodingList :: [RestoreVolumeFromSnapshot] -> Encoding #
ToHeaders RestoreVolumeFromSnapshot Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Methods toHeaders :: RestoreVolumeFromSnapshot -> [Header] #
ToPath RestoreVolumeFromSnapshot Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Methods toPath :: RestoreVolumeFromSnapshot -> ByteString #
ToQuery RestoreVolumeFromSnapshot Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Methods toQuery :: RestoreVolumeFromSnapshot -> QueryString #
AWSRequest RestoreVolumeFromSnapshot Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Associated Types type AWSResponse RestoreVolumeFromSnapshot # Methods request :: (Service -> Service) -> RestoreVolumeFromSnapshot -> Request RestoreVolumeFromSnapshot # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RestoreVolumeFromSnapshot -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RestoreVolumeFromSnapshot))) #
Generic RestoreVolumeFromSnapshot Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Associated Types type Rep RestoreVolumeFromSnapshot :: Type -> Type # Methods from :: RestoreVolumeFromSnapshot -> Rep RestoreVolumeFromSnapshot x # to :: Rep RestoreVolumeFromSnapshot x -> RestoreVolumeFromSnapshot #
Read RestoreVolumeFromSnapshot Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Methods readsPrec :: Int -> ReadS RestoreVolumeFromSnapshot # readList :: ReadS [RestoreVolumeFromSnapshot] # readPrec :: ReadPrec RestoreVolumeFromSnapshot # readListPrec :: ReadPrec [RestoreVolumeFromSnapshot] #
Show RestoreVolumeFromSnapshot Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Methods showsPrec :: Int -> RestoreVolumeFromSnapshot -> ShowS # show :: RestoreVolumeFromSnapshot -> String # showList :: [RestoreVolumeFromSnapshot] -> ShowS #
NFData RestoreVolumeFromSnapshot Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Methods rnf :: RestoreVolumeFromSnapshot -> () #
Eq RestoreVolumeFromSnapshot Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Methods (==) :: RestoreVolumeFromSnapshot -> RestoreVolumeFromSnapshot -> Bool # (/=) :: RestoreVolumeFromSnapshot -> RestoreVolumeFromSnapshot -> Bool #
Hashable RestoreVolumeFromSnapshot Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Methods hashWithSalt :: Int -> RestoreVolumeFromSnapshot -> Int # hash :: RestoreVolumeFromSnapshot -> Int #
type AWSResponse RestoreVolumeFromSnapshot Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot type AWSResponse RestoreVolumeFromSnapshot = RestoreVolumeFromSnapshotResponse
type Rep RestoreVolumeFromSnapshot Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot type Rep RestoreVolumeFromSnapshot = D1 ('MetaData "RestoreVolumeFromSnapshot" "Amazonka.FSx.RestoreVolumeFromSnapshot" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "RestoreVolumeFromSnapshot'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "options") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RestoreOpenZFSVolumeOption]))) :: (S1 ('MetaSel ('Just "volumeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "snapshotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newRestoreVolumeFromSnapshot Source #

Arguments

:: Text	`RestoreVolumeFromSnapshot`
-> Text	`RestoreVolumeFromSnapshot`
-> RestoreVolumeFromSnapshot

Create a value of RestoreVolumeFromSnapshot 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:clientRequestToken:RestoreVolumeFromSnapshot', restoreVolumeFromSnapshot_clientRequestToken - Undocumented member.

RestoreVolumeFromSnapshot, restoreVolumeFromSnapshot_options - The settings used when restoring the specified volume from snapshot.

DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, RestoreVolumeFromSnapshot fails.
DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, RestoreVolumeFromSnapshot fails.

RestoreVolumeFromSnapshot, restoreVolumeFromSnapshot_volumeId - The ID of the volume that you are restoring.

RestoreVolumeFromSnapshot, restoreVolumeFromSnapshot_snapshotId - The ID of the source snapshot. Specifies the snapshot that you are restoring from.

Request Lenses

restoreVolumeFromSnapshot_clientRequestToken :: Lens' RestoreVolumeFromSnapshot (Maybe Text) Source #

Undocumented member.

restoreVolumeFromSnapshot_options :: Lens' RestoreVolumeFromSnapshot (Maybe [RestoreOpenZFSVolumeOption]) Source #

The settings used when restoring the specified volume from snapshot.

DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, RestoreVolumeFromSnapshot fails.
DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, RestoreVolumeFromSnapshot fails.

restoreVolumeFromSnapshot_volumeId :: Lens' RestoreVolumeFromSnapshot Text Source #

The ID of the volume that you are restoring.

restoreVolumeFromSnapshot_snapshotId :: Lens' RestoreVolumeFromSnapshot Text Source #

The ID of the source snapshot. Specifies the snapshot that you are restoring from.

Destructuring the Response

data RestoreVolumeFromSnapshotResponse Source #

See: newRestoreVolumeFromSnapshotResponse smart constructor.

Constructors

RestoreVolumeFromSnapshotResponse'

Fields

administrativeActions :: Maybe [AdministrativeAction]
A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.
lifecycle :: Maybe VolumeLifecycle
The lifecycle state of the volume being restored.
volumeId :: Maybe Text
The ID of the volume that you restored.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic RestoreVolumeFromSnapshotResponse Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Associated Types type Rep RestoreVolumeFromSnapshotResponse :: Type -> Type # Methods from :: RestoreVolumeFromSnapshotResponse -> Rep RestoreVolumeFromSnapshotResponse x # to :: Rep RestoreVolumeFromSnapshotResponse x -> RestoreVolumeFromSnapshotResponse #
Read RestoreVolumeFromSnapshotResponse Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Methods readsPrec :: Int -> ReadS RestoreVolumeFromSnapshotResponse # readList :: ReadS [RestoreVolumeFromSnapshotResponse] # readPrec :: ReadPrec RestoreVolumeFromSnapshotResponse # readListPrec :: ReadPrec [RestoreVolumeFromSnapshotResponse] #
Show RestoreVolumeFromSnapshotResponse Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Methods showsPrec :: Int -> RestoreVolumeFromSnapshotResponse -> ShowS # show :: RestoreVolumeFromSnapshotResponse -> String # showList :: [RestoreVolumeFromSnapshotResponse] -> ShowS #
NFData RestoreVolumeFromSnapshotResponse Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Methods rnf :: RestoreVolumeFromSnapshotResponse -> () #
Eq RestoreVolumeFromSnapshotResponse Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot Methods (==) :: RestoreVolumeFromSnapshotResponse -> RestoreVolumeFromSnapshotResponse -> Bool # (/=) :: RestoreVolumeFromSnapshotResponse -> RestoreVolumeFromSnapshotResponse -> Bool #
type Rep RestoreVolumeFromSnapshotResponse Source #
Instance details Defined in Amazonka.FSx.RestoreVolumeFromSnapshot type Rep RestoreVolumeFromSnapshotResponse = D1 ('MetaData "RestoreVolumeFromSnapshotResponse" "Amazonka.FSx.RestoreVolumeFromSnapshot" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "RestoreVolumeFromSnapshotResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "administrativeActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AdministrativeAction])) :: S1 ('MetaSel ('Just "lifecycle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VolumeLifecycle))) :: (S1 ('MetaSel ('Just "volumeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newRestoreVolumeFromSnapshotResponse Source #

Arguments

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

Create a value of RestoreVolumeFromSnapshotResponse 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:

RestoreVolumeFromSnapshotResponse, restoreVolumeFromSnapshotResponse_administrativeActions - A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.

RestoreVolumeFromSnapshotResponse, restoreVolumeFromSnapshotResponse_lifecycle - The lifecycle state of the volume being restored.

RestoreVolumeFromSnapshot, restoreVolumeFromSnapshotResponse_volumeId - The ID of the volume that you restored.

$sel:httpStatus:RestoreVolumeFromSnapshotResponse', restoreVolumeFromSnapshotResponse_httpStatus - The response's http status code.

Response Lenses

restoreVolumeFromSnapshotResponse_administrativeActions :: Lens' RestoreVolumeFromSnapshotResponse (Maybe [AdministrativeAction]) Source #

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.

restoreVolumeFromSnapshotResponse_lifecycle :: Lens' RestoreVolumeFromSnapshotResponse (Maybe VolumeLifecycle) Source #

The lifecycle state of the volume being restored.

restoreVolumeFromSnapshotResponse_volumeId :: Lens' RestoreVolumeFromSnapshotResponse (Maybe Text) Source #

The ID of the volume that you restored.

restoreVolumeFromSnapshotResponse_httpStatus :: Lens' RestoreVolumeFromSnapshotResponse Int Source #

The response's http status code.