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.RBin.LockRule

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Locks a retention rule. A locked retention rule can't be modified or deleted.

Synopsis

data LockRule = LockRule' {
- identifier :: Text
- lockConfiguration :: LockConfiguration
}
newLockRule :: Text -> LockConfiguration -> LockRule
lockRule_identifier :: Lens' LockRule Text
lockRule_lockConfiguration :: Lens' LockRule LockConfiguration
data LockRuleResponse = LockRuleResponse' {
- description :: Maybe Text
- identifier :: Maybe Text
- lockConfiguration :: Maybe LockConfiguration
- lockState :: Maybe LockState
- resourceTags :: Maybe [ResourceTag]
- resourceType :: Maybe ResourceType
- retentionPeriod :: Maybe RetentionPeriod
- status :: Maybe RuleStatus
- httpStatus :: Int
}
newLockRuleResponse :: Int -> LockRuleResponse
lockRuleResponse_description :: Lens' LockRuleResponse (Maybe Text)
lockRuleResponse_identifier :: Lens' LockRuleResponse (Maybe Text)
lockRuleResponse_lockConfiguration :: Lens' LockRuleResponse (Maybe LockConfiguration)
lockRuleResponse_lockState :: Lens' LockRuleResponse (Maybe LockState)
lockRuleResponse_resourceTags :: Lens' LockRuleResponse (Maybe [ResourceTag])
lockRuleResponse_resourceType :: Lens' LockRuleResponse (Maybe ResourceType)
lockRuleResponse_retentionPeriod :: Lens' LockRuleResponse (Maybe RetentionPeriod)
lockRuleResponse_status :: Lens' LockRuleResponse (Maybe RuleStatus)
lockRuleResponse_httpStatus :: Lens' LockRuleResponse Int

Creating a Request

data LockRule Source #

See: newLockRule smart constructor.

Constructors

LockRule'
Fields identifier :: Text The unique ID of the retention rule. lockConfiguration :: LockConfiguration Information about the retention rule lock configuration.

Instances

Instances details

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

newLockRule Source #

Arguments

:: Text	`LockRule`
-> LockConfiguration	`LockRule`
-> LockRule

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

LockRule, lockRule_identifier - The unique ID of the retention rule.

LockRule, lockRule_lockConfiguration - Information about the retention rule lock configuration.

Request Lenses

lockRule_identifier :: Lens' LockRule Text Source #

The unique ID of the retention rule.

lockRule_lockConfiguration :: Lens' LockRule LockConfiguration Source #

Information about the retention rule lock configuration.

Destructuring the Response

data LockRuleResponse Source #

See: newLockRuleResponse smart constructor.

Constructors

LockRuleResponse'

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.
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 LockRuleResponse Source #
Instance details Defined in Amazonka.RBin.LockRule Associated Types type Rep LockRuleResponse :: Type -> Type # Methods from :: LockRuleResponse -> Rep LockRuleResponse x # to :: Rep LockRuleResponse x -> LockRuleResponse #
Read LockRuleResponse Source #
Instance details Defined in Amazonka.RBin.LockRule Methods readsPrec :: Int -> ReadS LockRuleResponse # readList :: ReadS [LockRuleResponse] # readPrec :: ReadPrec LockRuleResponse # readListPrec :: ReadPrec [LockRuleResponse] #
Show LockRuleResponse Source #
Instance details Defined in Amazonka.RBin.LockRule Methods showsPrec :: Int -> LockRuleResponse -> ShowS # show :: LockRuleResponse -> String # showList :: [LockRuleResponse] -> ShowS #
NFData LockRuleResponse Source #
Instance details Defined in Amazonka.RBin.LockRule Methods rnf :: LockRuleResponse -> () #
Eq LockRuleResponse Source #
Instance details Defined in Amazonka.RBin.LockRule Methods (==) :: LockRuleResponse -> LockRuleResponse -> Bool # (/=) :: LockRuleResponse -> LockRuleResponse -> Bool #
type Rep LockRuleResponse Source #
Instance details Defined in Amazonka.RBin.LockRule type Rep LockRuleResponse = D1 ('MetaData "LockRuleResponse" "Amazonka.RBin.LockRule" "amazonka-rbin-2.0-683M7qr6PFTBsVsY3OL2az" 'False) (C1 ('MetaCons "LockRuleResponse'" '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 "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))))))

newLockRuleResponse Source #

Arguments

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

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

LockRuleResponse, lockRuleResponse_description - The retention rule description.

LockRule, lockRuleResponse_identifier - The unique ID of the retention rule.

LockRule, lockRuleResponse_lockConfiguration - Information about the retention rule lock configuration.

LockRuleResponse, lockRuleResponse_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:LockRuleResponse', lockRuleResponse_resourceTags - Information about the resource tags used to identify resources that are retained by the retention rule.

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

LockRuleResponse, lockRuleResponse_retentionPeriod - Undocumented member.

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

$sel:httpStatus:LockRuleResponse', lockRuleResponse_httpStatus - The response's http status code.

Response Lenses

lockRuleResponse_description :: Lens' LockRuleResponse (Maybe Text) Source #

The retention rule description.

lockRuleResponse_identifier :: Lens' LockRuleResponse (Maybe Text) Source #

The unique ID of the retention rule.

lockRuleResponse_lockConfiguration :: Lens' LockRuleResponse (Maybe LockConfiguration) Source #

Information about the retention rule lock configuration.

lockRuleResponse_lockState :: Lens' LockRuleResponse (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.

lockRuleResponse_resourceTags :: Lens' LockRuleResponse (Maybe [ResourceTag]) Source #

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

lockRuleResponse_resourceType :: Lens' LockRuleResponse (Maybe ResourceType) Source #

The resource type retained by the retention rule.

lockRuleResponse_retentionPeriod :: Lens' LockRuleResponse (Maybe RetentionPeriod) Source #

Undocumented member.

lockRuleResponse_status :: Lens' LockRuleResponse (Maybe RuleStatus) Source #

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

lockRuleResponse_httpStatus :: Lens' LockRuleResponse Int Source #

The response's http status code.