amazonka-rbin-2.0: Amazon Recycle Bin 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.RBin.UnlockRule

Description

Unlocks a retention rule. After a retention rule is unlocked, it can be modified or deleted only after the unlock delay period expires.

Synopsis

Creating a Request

data UnlockRule Source #

See: newUnlockRule smart constructor.

Constructors

UnlockRule' 

Fields

Instances

Instances details
ToJSON UnlockRule Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Methods

toJSON :: UnlockRule -> Value #

toEncoding :: UnlockRule -> Encoding #

toJSONList :: [UnlockRule] -> Value #

toEncodingList :: [UnlockRule] -> Encoding #

ToHeaders UnlockRule Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Methods

toHeaders :: UnlockRule -> [Header] #

ToPath UnlockRule Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Methods

toPath :: UnlockRule -> ByteString #

ToQuery UnlockRule Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Methods

toQuery :: UnlockRule -> QueryString #

AWSRequest UnlockRule Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Associated Types

type AWSResponse UnlockRule #

Methods

request :: (Service -> Service) -> UnlockRule -> Request UnlockRule #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UnlockRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UnlockRule))) #

Generic UnlockRule Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Associated Types

type Rep UnlockRule :: Type -> Type #

Methods

from :: UnlockRule -> Rep UnlockRule x #

to :: Rep UnlockRule x -> UnlockRule #

Read UnlockRule Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Methods

readsPrec :: Int -> ReadS UnlockRule #

readList :: ReadS [UnlockRule] #

readPrec :: ReadPrec UnlockRule #

readListPrec :: ReadPrec [UnlockRule] #

Show UnlockRule Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Methods

showsPrec :: Int -> UnlockRule -> ShowS #

show :: UnlockRule -> String #

showList :: [UnlockRule] -> ShowS #

NFData UnlockRule Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Methods

rnf :: UnlockRule -> () #

Eq UnlockRule Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Methods

(==) :: UnlockRule -> UnlockRule -> Bool #

(/=) :: UnlockRule -> UnlockRule -> Bool #

Hashable UnlockRule Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Methods

hashWithSalt :: Int -> UnlockRule -> Int #

hash :: UnlockRule -> Int #

type AWSResponse UnlockRule Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

type AWSResponse UnlockRule = UnlockRuleResponse
type Rep UnlockRule Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

type Rep UnlockRule = D1 ('MetaData "UnlockRule" "Amazonka.RBin.UnlockRule" "amazonka-rbin-2.0-683M7qr6PFTBsVsY3OL2az" 'False) (C1 ('MetaCons "UnlockRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUnlockRule Source #

Arguments

:: Text

UnlockRule

-> UnlockRule 

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

UnlockRule, unlockRule_identifier - The unique ID of the retention rule.

Request Lenses

unlockRule_identifier :: Lens' UnlockRule Text Source #

The unique ID of the retention rule.

Destructuring the Response

data UnlockRuleResponse Source #

See: newUnlockRuleResponse smart constructor.

Constructors

UnlockRuleResponse' 

Fields

  • description :: Maybe Text

    The retention rule description.

  • identifier :: Maybe Text

    The unique ID of the retention rule.

  • lockConfiguration :: Maybe LockConfiguration

    Information about the retention rule lock configuration.

  • lockEndTime :: Maybe POSIX

    The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

  • lockState :: Maybe LockState

    The lock state for the retention rule.

    • locked - The retention rule is locked and can't be modified or deleted.
    • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.
    • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.
    • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.
  • resourceTags :: Maybe [ResourceTag]

    Information about the resource tags used to identify resources that are retained by the retention rule.

  • resourceType :: Maybe ResourceType

    The resource type retained by the retention rule.

  • retentionPeriod :: Maybe RetentionPeriod
     
  • status :: Maybe RuleStatus

    The state of the retention rule. Only retention rules that are in the available state retain resources.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic UnlockRuleResponse Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Associated Types

type Rep UnlockRuleResponse :: Type -> Type #

Methods

from :: UnlockRuleResponse -> Rep UnlockRuleResponse x #

to :: Rep UnlockRuleResponse x -> UnlockRuleResponse #

Read UnlockRuleResponse Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Methods

readsPrec :: Int -> ReadS UnlockRuleResponse #

readList :: ReadS [UnlockRuleResponse] #

readPrec :: ReadPrec UnlockRuleResponse #

readListPrec :: ReadPrec [UnlockRuleResponse] #

Show UnlockRuleResponse Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Methods

showsPrec :: Int -> UnlockRuleResponse -> ShowS #

show :: UnlockRuleResponse -> String #

showList :: [UnlockRuleResponse] -> ShowS #

NFData UnlockRuleResponse Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Methods

rnf :: UnlockRuleResponse -> () #

Eq UnlockRuleResponse Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

Methods

(==) :: UnlockRuleResponse -> UnlockRuleResponse -> Bool #

(/=) :: UnlockRuleResponse -> UnlockRuleResponse -> Bool #

type Rep UnlockRuleResponse Source # 
Instance details

Defined in Amazonka.RBin.UnlockRule

type Rep UnlockRuleResponse = D1 ('MetaData "UnlockRuleResponse" "Amazonka.RBin.UnlockRule" "amazonka-rbin-2.0-683M7qr6PFTBsVsY3OL2az" 'False) (C1 ('MetaCons "UnlockRuleResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lockConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LockConfiguration)) :*: (S1 ('MetaSel ('Just "lockEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "lockState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LockState))))) :*: ((S1 ('MetaSel ('Just "resourceTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceTag])) :*: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType))) :*: (S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionPeriod)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newUnlockRuleResponse Source #

Arguments

:: Int

$sel:httpStatus:UnlockRuleResponse'

-> UnlockRuleResponse 

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

UnlockRuleResponse, unlockRuleResponse_description - The retention rule description.

UnlockRule, unlockRuleResponse_identifier - The unique ID of the retention rule.

$sel:lockConfiguration:UnlockRuleResponse', unlockRuleResponse_lockConfiguration - Information about the retention rule lock configuration.

$sel:lockEndTime:UnlockRuleResponse', unlockRuleResponse_lockEndTime - The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

UnlockRuleResponse, unlockRuleResponse_lockState - The lock state for the retention rule.

  • locked - The retention rule is locked and can't be modified or deleted.
  • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.
  • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.
  • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

$sel:resourceTags:UnlockRuleResponse', unlockRuleResponse_resourceTags - Information about the resource tags used to identify resources that are retained by the retention rule.

$sel:resourceType:UnlockRuleResponse', unlockRuleResponse_resourceType - The resource type retained by the retention rule.

UnlockRuleResponse, unlockRuleResponse_retentionPeriod - Undocumented member.

$sel:status:UnlockRuleResponse', unlockRuleResponse_status - The state of the retention rule. Only retention rules that are in the available state retain resources.

$sel:httpStatus:UnlockRuleResponse', unlockRuleResponse_httpStatus - The response's http status code.

Response Lenses

unlockRuleResponse_description :: Lens' UnlockRuleResponse (Maybe Text) Source #

The retention rule description.

unlockRuleResponse_identifier :: Lens' UnlockRuleResponse (Maybe Text) Source #

The unique ID of the retention rule.

unlockRuleResponse_lockConfiguration :: Lens' UnlockRuleResponse (Maybe LockConfiguration) Source #

Information about the retention rule lock configuration.

unlockRuleResponse_lockEndTime :: Lens' UnlockRuleResponse (Maybe UTCTime) Source #

The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

unlockRuleResponse_lockState :: Lens' UnlockRuleResponse (Maybe LockState) Source #

The lock state for the retention rule.

  • locked - The retention rule is locked and can't be modified or deleted.
  • pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.
  • unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.
  • null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

unlockRuleResponse_resourceTags :: Lens' UnlockRuleResponse (Maybe [ResourceTag]) Source #

Information about the resource tags used to identify resources that are retained by the retention rule.

unlockRuleResponse_resourceType :: Lens' UnlockRuleResponse (Maybe ResourceType) Source #

The resource type retained by the retention rule.

unlockRuleResponse_retentionPeriod :: Lens' UnlockRuleResponse (Maybe RetentionPeriod) Source #

Undocumented member.

unlockRuleResponse_status :: Lens' UnlockRuleResponse (Maybe RuleStatus) Source #

The state of the retention rule. Only retention rules that are in the available state retain resources.

unlockRuleResponse_httpStatus :: Lens' UnlockRuleResponse Int Source #

The response's http status code.