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.Lens

Description

 
Synopsis

Operations

CreateRule

createRule_description :: Lens' CreateRule (Maybe Text) Source #

The retention rule description.

createRule_lockConfiguration :: Lens' CreateRule (Maybe LockConfiguration) Source #

Information about the retention rule lock configuration.

createRule_resourceTags :: Lens' CreateRule (Maybe [ResourceTag]) Source #

Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

createRule_tags :: Lens' CreateRule (Maybe [Tag]) Source #

Information about the tags to assign to the retention rule.

createRule_retentionPeriod :: Lens' CreateRule RetentionPeriod Source #

Information about the retention period for which the retention rule is to retain resources.

createRule_resourceType :: Lens' CreateRule ResourceType Source #

The resource type to be retained by the retention rule. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To retain snapshots, specify EBS_SNAPSHOT. To retain EBS-backed AMIs, specify EC2_IMAGE.

createRuleResponse_identifier :: Lens' CreateRuleResponse (Maybe Text) Source #

The unique ID of the retention rule.

createRuleResponse_lockConfiguration :: Lens' CreateRuleResponse (Maybe LockConfiguration) Source #

Information about the retention rule lock configuration.

createRuleResponse_lockState :: Lens' CreateRuleResponse (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.

createRuleResponse_resourceTags :: Lens' CreateRuleResponse (Maybe [ResourceTag]) Source #

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

createRuleResponse_resourceType :: Lens' CreateRuleResponse (Maybe ResourceType) Source #

The resource type retained by the retention rule.

createRuleResponse_status :: Lens' CreateRuleResponse (Maybe RuleStatus) Source #

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

createRuleResponse_tags :: Lens' CreateRuleResponse (Maybe [Tag]) Source #

Information about the tags assigned to the retention rule.

DeleteRule

deleteRule_identifier :: Lens' DeleteRule Text Source #

The unique ID of the retention rule.

GetRule

getRule_identifier :: Lens' GetRule Text Source #

The unique ID of the retention rule.

getRuleResponse_description :: Lens' GetRuleResponse (Maybe Text) Source #

The retention rule description.

getRuleResponse_identifier :: Lens' GetRuleResponse (Maybe Text) Source #

The unique ID of the retention rule.

getRuleResponse_lockConfiguration :: Lens' GetRuleResponse (Maybe LockConfiguration) Source #

Information about the retention rule lock configuration.

getRuleResponse_lockEndTime :: Lens' GetRuleResponse (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.

getRuleResponse_lockState :: Lens' GetRuleResponse (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.

getRuleResponse_resourceTags :: Lens' GetRuleResponse (Maybe [ResourceTag]) Source #

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

getRuleResponse_resourceType :: Lens' GetRuleResponse (Maybe ResourceType) Source #

The resource type retained by the retention rule.

getRuleResponse_retentionPeriod :: Lens' GetRuleResponse (Maybe RetentionPeriod) Source #

Information about the retention period for which the retention rule is to retain resources.

getRuleResponse_status :: Lens' GetRuleResponse (Maybe RuleStatus) Source #

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

getRuleResponse_httpStatus :: Lens' GetRuleResponse Int Source #

The response's http status code.

ListRules

listRules_lockState :: Lens' ListRules (Maybe LockState) Source #

The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

listRules_maxResults :: Lens' ListRules (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.

listRules_nextToken :: Lens' ListRules (Maybe Text) Source #

The token for the next page of results.

listRules_resourceTags :: Lens' ListRules (Maybe [ResourceTag]) Source #

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

listRules_resourceType :: Lens' ListRules ResourceType Source #

The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

listRulesResponse_nextToken :: Lens' ListRulesResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

listRulesResponse_rules :: Lens' ListRulesResponse (Maybe [RuleSummary]) Source #

Information about the retention rules.

listRulesResponse_httpStatus :: Lens' ListRulesResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the retention rule.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #

Information about the tags assigned to the retention rule.

LockRule

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.

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_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.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the retention rule.

tagResource_tags :: Lens' TagResource [Tag] Source #

Information about the tags to assign to the retention rule.

UnlockRule

unlockRule_identifier :: Lens' UnlockRule Text Source #

The unique ID of the retention rule.

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_status :: Lens' UnlockRuleResponse (Maybe RuleStatus) Source #

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

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the retention rule.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The tag keys of the tags to unassign. All tags that have the specified tag key are unassigned.

UpdateRule

updateRule_description :: Lens' UpdateRule (Maybe Text) Source #

The retention rule description.

updateRule_resourceTags :: Lens' UpdateRule (Maybe [ResourceTag]) Source #

Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. For tag-level retention rules, only deleted resources, of the specified resource type, that have one or more of the specified tag key and value pairs are retained. If a resource is deleted, but it does not have any of the specified tag key and value pairs, it is immediately deleted without being retained by the retention rule.

You can add the same tag key and value pair to a maximum or five retention rules.

To create a Region-level retention rule, omit this parameter. A Region-level retention rule does not have any resource tags specified. It retains all deleted resources of the specified resource type in the Region in which the rule is created, even if the resources are not tagged.

updateRule_resourceType :: Lens' UpdateRule (Maybe ResourceType) Source #

This parameter is currently not supported. You can't update a retention rule's resource type after creation.

updateRule_retentionPeriod :: Lens' UpdateRule (Maybe RetentionPeriod) Source #

Information about the retention period for which the retention rule is to retain resources.

updateRule_identifier :: Lens' UpdateRule Text Source #

The unique ID of the retention rule.

updateRuleResponse_identifier :: Lens' UpdateRuleResponse (Maybe Text) Source #

The unique ID of the retention rule.

updateRuleResponse_lockEndTime :: Lens' UpdateRuleResponse (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.

updateRuleResponse_lockState :: Lens' UpdateRuleResponse (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.

updateRuleResponse_resourceTags :: Lens' UpdateRuleResponse (Maybe [ResourceTag]) Source #

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

updateRuleResponse_resourceType :: Lens' UpdateRuleResponse (Maybe ResourceType) Source #

The resource type retained by the retention rule.

updateRuleResponse_status :: Lens' UpdateRuleResponse (Maybe RuleStatus) Source #

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

Types

LockConfiguration

lockConfiguration_unlockDelay :: Lens' LockConfiguration UnlockDelay Source #

Information about the retention rule unlock delay.

ResourceTag

RetentionPeriod

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

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 the locked and unlocked states only; it can never transition back to null.

ruleSummary_retentionPeriod :: Lens' RuleSummary (Maybe RetentionPeriod) Source #

Information about the retention period for which the retention rule is to retain resources.

Tag

tag_key :: Lens' Tag Text Source #

The tag key.

tag_value :: Lens' Tag Text Source #

The tag value.

UnlockDelay

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.