amazonka-glacier-2.0: Amazon Glacier SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Glacier.SetDataRetrievalPolicy

Description

This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation.

The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.

Synopsis

Creating a Request

data SetDataRetrievalPolicy Source #

SetDataRetrievalPolicy input.

See: newSetDataRetrievalPolicy smart constructor.

Constructors

SetDataRetrievalPolicy' 

Fields

  • policy :: Maybe DataRetrievalPolicy

    The data retrieval policy in JSON format.

  • accountId :: Text

    The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

Instances

Instances details
ToJSON SetDataRetrievalPolicy Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

ToHeaders SetDataRetrievalPolicy Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

ToPath SetDataRetrievalPolicy Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

ToQuery SetDataRetrievalPolicy Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

AWSRequest SetDataRetrievalPolicy Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

Associated Types

type AWSResponse SetDataRetrievalPolicy #

Generic SetDataRetrievalPolicy Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

Associated Types

type Rep SetDataRetrievalPolicy :: Type -> Type #

Read SetDataRetrievalPolicy Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

Show SetDataRetrievalPolicy Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

NFData SetDataRetrievalPolicy Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

Methods

rnf :: SetDataRetrievalPolicy -> () #

Eq SetDataRetrievalPolicy Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

Hashable SetDataRetrievalPolicy Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

type AWSResponse SetDataRetrievalPolicy Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

type Rep SetDataRetrievalPolicy Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

type Rep SetDataRetrievalPolicy = D1 ('MetaData "SetDataRetrievalPolicy" "Amazonka.Glacier.SetDataRetrievalPolicy" "amazonka-glacier-2.0-17Kmjv8nUJeKOtbrjLyy76" 'False) (C1 ('MetaCons "SetDataRetrievalPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataRetrievalPolicy)) :*: S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newSetDataRetrievalPolicy Source #

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

SetDataRetrievalPolicy, setDataRetrievalPolicy_policy - The data retrieval policy in JSON format.

$sel:accountId:SetDataRetrievalPolicy', setDataRetrievalPolicy_accountId - The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

Request Lenses

setDataRetrievalPolicy_accountId :: Lens' SetDataRetrievalPolicy Text Source #

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

Destructuring the Response

data SetDataRetrievalPolicyResponse Source #

See: newSetDataRetrievalPolicyResponse smart constructor.

Instances

Instances details
Generic SetDataRetrievalPolicyResponse Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

Associated Types

type Rep SetDataRetrievalPolicyResponse :: Type -> Type #

Read SetDataRetrievalPolicyResponse Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

Show SetDataRetrievalPolicyResponse Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

NFData SetDataRetrievalPolicyResponse Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

Eq SetDataRetrievalPolicyResponse Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

type Rep SetDataRetrievalPolicyResponse Source # 
Instance details

Defined in Amazonka.Glacier.SetDataRetrievalPolicy

type Rep SetDataRetrievalPolicyResponse = D1 ('MetaData "SetDataRetrievalPolicyResponse" "Amazonka.Glacier.SetDataRetrievalPolicy" "amazonka-glacier-2.0-17Kmjv8nUJeKOtbrjLyy76" 'False) (C1 ('MetaCons "SetDataRetrievalPolicyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSetDataRetrievalPolicyResponse :: SetDataRetrievalPolicyResponse Source #

Create a value of SetDataRetrievalPolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.