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 |
Synopsis
- defaultService :: Service
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype LockState where
- LockState' { }
- pattern LockState_Locked :: LockState
- pattern LockState_Pending_unlock :: LockState
- pattern LockState_Unlocked :: LockState
- newtype ResourceType where
- ResourceType' { }
- pattern ResourceType_EBS_SNAPSHOT :: ResourceType
- pattern ResourceType_EC2_IMAGE :: ResourceType
- newtype RetentionPeriodUnit where
- newtype RuleStatus where
- RuleStatus' { }
- pattern RuleStatus_Available :: RuleStatus
- pattern RuleStatus_Pending :: RuleStatus
- newtype UnlockDelayUnit where
- UnlockDelayUnit' { }
- pattern UnlockDelayUnit_DAYS :: UnlockDelayUnit
- data LockConfiguration = LockConfiguration' {}
- newLockConfiguration :: UnlockDelay -> LockConfiguration
- lockConfiguration_unlockDelay :: Lens' LockConfiguration UnlockDelay
- data ResourceTag = ResourceTag' {}
- newResourceTag :: Text -> ResourceTag
- resourceTag_resourceTagValue :: Lens' ResourceTag (Maybe Text)
- resourceTag_resourceTagKey :: Lens' ResourceTag Text
- data RetentionPeriod = RetentionPeriod' {}
- newRetentionPeriod :: Natural -> RetentionPeriodUnit -> RetentionPeriod
- retentionPeriod_retentionPeriodValue :: Lens' RetentionPeriod Natural
- retentionPeriod_retentionPeriodUnit :: Lens' RetentionPeriod RetentionPeriodUnit
- data RuleSummary = RuleSummary' {}
- newRuleSummary :: RuleSummary
- ruleSummary_description :: Lens' RuleSummary (Maybe Text)
- ruleSummary_identifier :: Lens' RuleSummary (Maybe Text)
- ruleSummary_lockState :: Lens' RuleSummary (Maybe LockState)
- ruleSummary_retentionPeriod :: Lens' RuleSummary (Maybe RetentionPeriod)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data UnlockDelay = UnlockDelay' {}
- newUnlockDelay :: Natural -> UnlockDelayUnit -> UnlockDelay
- unlockDelay_unlockDelayValue :: Lens' UnlockDelay Natural
- unlockDelay_unlockDelayUnit :: Lens' UnlockDelay UnlockDelayUnit
Service Configuration
defaultService :: Service Source #
API version 2021-06-15
of the Amazon Recycle Bin SDK configuration.
Errors
_ConflictException :: AsError a => Fold a ServiceError Source #
The specified retention rule lock request can't be completed.
_InternalServerException :: AsError a => Fold a ServiceError Source #
The service could not respond to the request due to an internal problem.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource was not found.
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request would cause a service quota for the number of tags per resource to be exceeded.
_ValidationException :: AsError a => Fold a ServiceError Source #
One or more of the parameters in the request is not valid.
LockState
pattern LockState_Locked :: LockState | |
pattern LockState_Pending_unlock :: LockState | |
pattern LockState_Unlocked :: LockState |
Instances
ResourceType
newtype ResourceType Source #
pattern ResourceType_EBS_SNAPSHOT :: ResourceType | |
pattern ResourceType_EC2_IMAGE :: ResourceType |
Instances
RetentionPeriodUnit
newtype RetentionPeriodUnit Source #
pattern RetentionPeriodUnit_DAYS :: RetentionPeriodUnit |
Instances
RuleStatus
newtype RuleStatus Source #
pattern RuleStatus_Available :: RuleStatus | |
pattern RuleStatus_Pending :: RuleStatus |
Instances
UnlockDelayUnit
newtype UnlockDelayUnit Source #
pattern UnlockDelayUnit_DAYS :: UnlockDelayUnit |
Instances
LockConfiguration
data LockConfiguration Source #
Information about a retention rule lock configuration.
See: newLockConfiguration
smart constructor.
LockConfiguration' | |
|
Instances
Create a value of LockConfiguration
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:unlockDelay:LockConfiguration'
, lockConfiguration_unlockDelay
- Information about the retention rule unlock delay.
lockConfiguration_unlockDelay :: Lens' LockConfiguration UnlockDelay Source #
Information about the retention rule unlock delay.
ResourceTag
data ResourceTag Source #
Information about the resource tags used to identify resources that are retained by the retention rule.
See: newResourceTag
smart constructor.
ResourceTag' | |
|
Instances
Create a value of ResourceTag
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:resourceTagValue:ResourceTag'
, resourceTag_resourceTagValue
- The tag value.
$sel:resourceTagKey:ResourceTag'
, resourceTag_resourceTagKey
- The tag key.
resourceTag_resourceTagValue :: Lens' ResourceTag (Maybe Text) Source #
The tag value.
resourceTag_resourceTagKey :: Lens' ResourceTag Text Source #
The tag key.
RetentionPeriod
data RetentionPeriod Source #
Information about the retention period for which the retention rule is to retain resources.
See: newRetentionPeriod
smart constructor.
RetentionPeriod' | |
|
Instances
Create a value of RetentionPeriod
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:retentionPeriodValue:RetentionPeriod'
, retentionPeriod_retentionPeriodValue
- The period value for which the retention rule is to retain resources.
The period is measured using the unit specified for
RetentionPeriodUnit.
$sel:retentionPeriodUnit:RetentionPeriod'
, retentionPeriod_retentionPeriodUnit
- The unit of time in which the retention period is measured. Currently,
only DAYS
is supported.
retentionPeriod_retentionPeriodValue :: Lens' RetentionPeriod Natural Source #
The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit.
retentionPeriod_retentionPeriodUnit :: Lens' RetentionPeriod RetentionPeriodUnit Source #
The unit of time in which the retention period is measured. Currently,
only DAYS
is supported.
RuleSummary
data RuleSummary Source #
Information about a Recycle Bin retention rule.
See: newRuleSummary
smart constructor.
RuleSummary' | |
|
Instances
newRuleSummary :: RuleSummary Source #
Create a value of RuleSummary
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:description:RuleSummary'
, ruleSummary_description
- The retention rule description.
$sel:identifier:RuleSummary'
, ruleSummary_identifier
- The unique ID of the retention rule.
$sel:lockState:RuleSummary'
, ruleSummary_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:retentionPeriod:RuleSummary'
, ruleSummary_retentionPeriod
- Information about the retention period for which the retention rule is
to retain resources.
ruleSummary_description :: Lens' RuleSummary (Maybe Text) Source #
The retention rule description.
ruleSummary_identifier :: Lens' RuleSummary (Maybe Text) Source #
The unique ID of the retention rule.
ruleSummary_lockState :: Lens' RuleSummary (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
.
ruleSummary_retentionPeriod :: Lens' RuleSummary (Maybe RetentionPeriod) Source #
Information about the retention period for which the retention rule is to retain resources.
Tag
Information about the tags to assign to the retention rule.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.RBin.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.RBin.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.RBin.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.RBin.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.RBin.Types.Tag" "amazonka-rbin-2.0-683M7qr6PFTBsVsY3OL2az" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
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:key:Tag'
, tag_key
- The tag key.
$sel:value:Tag'
, tag_value
- The tag value.
UnlockDelay
data UnlockDelay Source #
Information about the retention rule unlock delay. The unlock delay is the period after which a retention rule can be modified or edited after it has been unlocked by a user with the required permissions. The retention rule can't be modified or deleted during the unlock delay.
See: newUnlockDelay
smart constructor.
UnlockDelay' | |
|
Instances
:: Natural | |
-> UnlockDelayUnit | |
-> UnlockDelay |
Create a value of UnlockDelay
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:unlockDelayValue:UnlockDelay'
, unlockDelay_unlockDelayValue
- The unlock delay period, measured in the unit specified for
UnlockDelayUnit.
$sel:unlockDelayUnit:UnlockDelay'
, unlockDelay_unlockDelayUnit
- The unit of time in which to measure the unlock delay. Currently, the
unlock delay can be measure only in days.
unlockDelay_unlockDelayValue :: Lens' UnlockDelay Natural Source #
The unlock delay period, measured in the unit specified for UnlockDelayUnit.
unlockDelay_unlockDelayUnit :: Lens' UnlockDelay UnlockDelayUnit Source #
The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days.