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.S3.Types.RestoreRequest

Description

Documentation

data RestoreRequest Source #

Container for restore job parameters.

See: newRestoreRequest smart constructor.

Constructors

RestoreRequest'

Fields

days :: Maybe Int
Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.
The Days element is required for regular restores, and must not be provided for select requests.
description :: Maybe Text
The optional description for the job.
glacierJobParameters :: Maybe GlacierJobParameters
S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.
outputLocation :: Maybe OutputLocation
Describes the location where the restore job's output is stored.
selectParameters :: Maybe SelectParameters
Describes the parameters for Select job types.
tier :: Maybe Tier
Retrieval tier at which the restore will be processed.
type' :: Maybe RestoreRequestType
Type of restore request.

Instances

Instances details

ToXML RestoreRequest Source #
Instance details Defined in Amazonka.S3.Types.RestoreRequest Methods toXML :: RestoreRequest -> XML #
Generic RestoreRequest Source #
Instance details Defined in Amazonka.S3.Types.RestoreRequest Associated Types type Rep RestoreRequest :: Type -> Type # Methods from :: RestoreRequest -> Rep RestoreRequest x # to :: Rep RestoreRequest x -> RestoreRequest #
Show RestoreRequest Source #
Instance details Defined in Amazonka.S3.Types.RestoreRequest Methods showsPrec :: Int -> RestoreRequest -> ShowS # show :: RestoreRequest -> String # showList :: [RestoreRequest] -> ShowS #
NFData RestoreRequest Source #
Instance details Defined in Amazonka.S3.Types.RestoreRequest Methods rnf :: RestoreRequest -> () #
Eq RestoreRequest Source #
Instance details Defined in Amazonka.S3.Types.RestoreRequest Methods (==) :: RestoreRequest -> RestoreRequest -> Bool # (/=) :: RestoreRequest -> RestoreRequest -> Bool #
Hashable RestoreRequest Source #
Instance details Defined in Amazonka.S3.Types.RestoreRequest Methods hashWithSalt :: Int -> RestoreRequest -> Int # hash :: RestoreRequest -> Int #
type Rep RestoreRequest Source #
Instance details Defined in Amazonka.S3.Types.RestoreRequest type Rep RestoreRequest = D1 ('MetaData "RestoreRequest" "Amazonka.S3.Types.RestoreRequest" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "RestoreRequest'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "days") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "glacierJobParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GlacierJobParameters)))) :: ((S1 ('MetaSel ('Just "outputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OutputLocation)) :: S1 ('MetaSel ('Just "selectParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SelectParameters))) :: (S1 ('MetaSel ('Just "tier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Tier)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RestoreRequestType))))))

newRestoreRequest :: RestoreRequest Source #

Create a value of RestoreRequest 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:days:RestoreRequest', restoreRequest_days - Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

$sel:description:RestoreRequest', restoreRequest_description - The optional description for the job.

$sel:glacierJobParameters:RestoreRequest', restoreRequest_glacierJobParameters - S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

$sel:outputLocation:RestoreRequest', restoreRequest_outputLocation - Describes the location where the restore job's output is stored.

$sel:selectParameters:RestoreRequest', restoreRequest_selectParameters - Describes the parameters for Select job types.

RestoreRequest, restoreRequest_tier - Retrieval tier at which the restore will be processed.

$sel:type':RestoreRequest', restoreRequest_type - Type of restore request.

restoreRequest_days :: Lens' RestoreRequest (Maybe Int) Source #

Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

restoreRequest_description :: Lens' RestoreRequest (Maybe Text) Source #

The optional description for the job.

restoreRequest_glacierJobParameters :: Lens' RestoreRequest (Maybe GlacierJobParameters) Source #

S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

restoreRequest_outputLocation :: Lens' RestoreRequest (Maybe OutputLocation) Source #

Describes the location where the restore job's output is stored.

restoreRequest_selectParameters :: Lens' RestoreRequest (Maybe SelectParameters) Source #

Describes the parameters for Select job types.

restoreRequest_tier :: Lens' RestoreRequest (Maybe Tier) Source #

Retrieval tier at which the restore will be processed.

restoreRequest_type :: Lens' RestoreRequest (Maybe RestoreRequestType) Source #

Type of restore request.