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 |
Unlocks a retention rule. After a retention rule is unlocked, it can be modified or deleted only after the unlock delay period expires.
Synopsis
- data UnlockRule = UnlockRule' {
- identifier :: Text
- newUnlockRule :: Text -> UnlockRule
- unlockRule_identifier :: Lens' UnlockRule Text
- data UnlockRuleResponse = UnlockRuleResponse' {}
- newUnlockRuleResponse :: Int -> UnlockRuleResponse
- unlockRuleResponse_description :: Lens' UnlockRuleResponse (Maybe Text)
- unlockRuleResponse_identifier :: Lens' UnlockRuleResponse (Maybe Text)
- unlockRuleResponse_lockConfiguration :: Lens' UnlockRuleResponse (Maybe LockConfiguration)
- unlockRuleResponse_lockEndTime :: Lens' UnlockRuleResponse (Maybe UTCTime)
- unlockRuleResponse_lockState :: Lens' UnlockRuleResponse (Maybe LockState)
- unlockRuleResponse_resourceTags :: Lens' UnlockRuleResponse (Maybe [ResourceTag])
- unlockRuleResponse_resourceType :: Lens' UnlockRuleResponse (Maybe ResourceType)
- unlockRuleResponse_retentionPeriod :: Lens' UnlockRuleResponse (Maybe RetentionPeriod)
- unlockRuleResponse_status :: Lens' UnlockRuleResponse (Maybe RuleStatus)
- unlockRuleResponse_httpStatus :: Lens' UnlockRuleResponse Int
Creating a Request
data UnlockRule Source #
See: newUnlockRule
smart constructor.
UnlockRule' | |
|
Instances
:: Text | |
-> 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.
UnlockRuleResponse' | |
|
Instances
newUnlockRuleResponse Source #
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 thelocked
andunlocked
states only; it can never transition back tonull
.
$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 thelocked
andunlocked
states only; it can never transition back tonull
.
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.