| 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
Description
Derived from API version 2021-06-15 of the AWS service descriptions, licensed under Apache 2.0.
This is the Recycle Bin API Reference. This documentation provides descriptions and syntax for each of the actions and data types in Recycle Bin.
Recycle Bin is a resource recovery feature that enables you to restore accidentally deleted snapshots and EBS-backed AMIs. When using Recycle Bin, if your resources are deleted, they are retained in the Recycle Bin for a time period that you specify.
You can restore a resource from the Recycle Bin at any time before its retention period expires. After you restore a resource from the Recycle Bin, the resource is removed from the Recycle Bin, and you can then use it in the same way you use any other resource of that type in your account. If the retention period expires and the resource is not restored, the resource is permanently deleted from the Recycle Bin and is no longer available for recovery. For more information about Recycle Bin, see Recycle Bin in the Amazon Elastic Compute Cloud User Guide.
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
- data CreateRule = CreateRule' (Maybe Text) (Maybe LockConfiguration) (Maybe [ResourceTag]) (Maybe [Tag]) RetentionPeriod ResourceType
- newCreateRule :: RetentionPeriod -> ResourceType -> CreateRule
- data CreateRuleResponse = CreateRuleResponse' (Maybe Text) (Maybe Text) (Maybe LockConfiguration) (Maybe LockState) (Maybe [ResourceTag]) (Maybe ResourceType) (Maybe RetentionPeriod) (Maybe RuleStatus) (Maybe [Tag]) Int
- newCreateRuleResponse :: Int -> CreateRuleResponse
- data DeleteRule = DeleteRule' Text
- newDeleteRule :: Text -> DeleteRule
- data DeleteRuleResponse = DeleteRuleResponse' Int
- newDeleteRuleResponse :: Int -> DeleteRuleResponse
- data GetRule = GetRule' Text
- newGetRule :: Text -> GetRule
- data GetRuleResponse = GetRuleResponse' (Maybe Text) (Maybe Text) (Maybe LockConfiguration) (Maybe POSIX) (Maybe LockState) (Maybe [ResourceTag]) (Maybe ResourceType) (Maybe RetentionPeriod) (Maybe RuleStatus) Int
- newGetRuleResponse :: Int -> GetRuleResponse
- data ListRules = ListRules' (Maybe LockState) (Maybe Natural) (Maybe Text) (Maybe [ResourceTag]) ResourceType
- newListRules :: ResourceType -> ListRules
- data ListRulesResponse = ListRulesResponse' (Maybe Text) (Maybe [RuleSummary]) Int
- newListRulesResponse :: Int -> ListRulesResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data LockRule = LockRule' Text LockConfiguration
- newLockRule :: Text -> LockConfiguration -> LockRule
- data LockRuleResponse = LockRuleResponse' (Maybe Text) (Maybe Text) (Maybe LockConfiguration) (Maybe LockState) (Maybe [ResourceTag]) (Maybe ResourceType) (Maybe RetentionPeriod) (Maybe RuleStatus) Int
- newLockRuleResponse :: Int -> LockRuleResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UnlockRule = UnlockRule' Text
- newUnlockRule :: Text -> UnlockRule
- data UnlockRuleResponse = UnlockRuleResponse' (Maybe Text) (Maybe Text) (Maybe LockConfiguration) (Maybe POSIX) (Maybe LockState) (Maybe [ResourceTag]) (Maybe ResourceType) (Maybe RetentionPeriod) (Maybe RuleStatus) Int
- newUnlockRuleResponse :: Int -> UnlockRuleResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateRule = UpdateRule' (Maybe Text) (Maybe [ResourceTag]) (Maybe ResourceType) (Maybe RetentionPeriod) Text
- newUpdateRule :: Text -> UpdateRule
- data UpdateRuleResponse = UpdateRuleResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe LockState) (Maybe [ResourceTag]) (Maybe ResourceType) (Maybe RetentionPeriod) (Maybe RuleStatus) Int
- newUpdateRuleResponse :: Int -> UpdateRuleResponse
- 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' UnlockDelay
- newLockConfiguration :: UnlockDelay -> LockConfiguration
- data ResourceTag = ResourceTag' (Maybe Text) Text
- newResourceTag :: Text -> ResourceTag
- data RetentionPeriod = RetentionPeriod' Natural RetentionPeriodUnit
- newRetentionPeriod :: Natural -> RetentionPeriodUnit -> RetentionPeriod
- data RuleSummary = RuleSummary' (Maybe Text) (Maybe Text) (Maybe LockState) (Maybe RetentionPeriod)
- newRuleSummary :: RuleSummary
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data UnlockDelay = UnlockDelay' Natural UnlockDelayUnit
- newUnlockDelay :: Natural -> UnlockDelayUnit -> UnlockDelay
Service Configuration
defaultService :: Service Source #
API version 2021-06-15 of the Amazon Recycle Bin SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by RBin.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
The specified retention rule lock request can't be completed.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
The service could not respond to the request due to an internal problem.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource was not found.
ServiceQuotaExceededException
_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
_ValidationException :: AsError a => Fold a ServiceError Source #
One or more of the parameters in the request is not valid.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateRule
data CreateRule Source #
See: newCreateRule smart constructor.
Constructors
| CreateRule' (Maybe Text) (Maybe LockConfiguration) (Maybe [ResourceTag]) (Maybe [Tag]) RetentionPeriod ResourceType |
Instances
Arguments
| :: RetentionPeriod | |
| -> ResourceType | |
| -> CreateRule |
Create a value of CreateRule 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:
CreateRule, createRule_description - The retention rule description.
CreateRule, createRule_lockConfiguration - Information about the retention rule lock configuration.
CreateRule, createRule_resourceTags - 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, createRule_tags - Information about the tags to assign to the retention rule.
CreateRule, createRule_retentionPeriod - Information about the retention period for which the retention rule is
to retain resources.
CreateRule, createRule_resourceType - 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.
data CreateRuleResponse Source #
See: newCreateRuleResponse smart constructor.
Constructors
| CreateRuleResponse' (Maybe Text) (Maybe Text) (Maybe LockConfiguration) (Maybe LockState) (Maybe [ResourceTag]) (Maybe ResourceType) (Maybe RetentionPeriod) (Maybe RuleStatus) (Maybe [Tag]) Int |
Instances
newCreateRuleResponse Source #
Arguments
| :: Int | |
| -> CreateRuleResponse |
Create a value of CreateRuleResponse 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:
CreateRule, createRuleResponse_description - The retention rule description.
CreateRuleResponse, createRuleResponse_identifier - The unique ID of the retention rule.
CreateRule, createRuleResponse_lockConfiguration - Information about the retention rule lock configuration.
CreateRuleResponse, createRuleResponse_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 thelockedandunlockedstates only; it can never transition back tonull.
CreateRule, createRuleResponse_resourceTags - Information about the resource tags used to identify resources that are
retained by the retention rule.
CreateRule, createRuleResponse_resourceType - The resource type retained by the retention rule.
CreateRule, createRuleResponse_retentionPeriod - Undocumented member.
$sel:status:CreateRuleResponse', createRuleResponse_status - The state of the retention rule. Only retention rules that are in the
available state retain resources.
CreateRule, createRuleResponse_tags - Information about the tags assigned to the retention rule.
$sel:httpStatus:CreateRuleResponse', createRuleResponse_httpStatus - The response's http status code.
DeleteRule
data DeleteRule Source #
See: newDeleteRule smart constructor.
Constructors
| DeleteRule' Text |
Instances
Arguments
| :: Text | |
| -> DeleteRule |
Create a value of DeleteRule 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:
DeleteRule, deleteRule_identifier - The unique ID of the retention rule.
data DeleteRuleResponse Source #
See: newDeleteRuleResponse smart constructor.
Constructors
| DeleteRuleResponse' Int |
Instances
newDeleteRuleResponse Source #
Arguments
| :: Int | |
| -> DeleteRuleResponse |
Create a value of DeleteRuleResponse 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:httpStatus:DeleteRuleResponse', deleteRuleResponse_httpStatus - The response's http status code.
GetRule
See: newGetRule smart constructor.
Instances
| ToHeaders GetRule Source # | |
Defined in Amazonka.RBin.GetRule | |
| ToPath GetRule Source # | |
Defined in Amazonka.RBin.GetRule Methods toPath :: GetRule -> ByteString # | |
| ToQuery GetRule Source # | |
Defined in Amazonka.RBin.GetRule Methods toQuery :: GetRule -> QueryString # | |
| AWSRequest GetRule Source # | |
Defined in Amazonka.RBin.GetRule Associated Types type AWSResponse GetRule # Methods request :: (Service -> Service) -> GetRule -> Request GetRule # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRule))) # | |
| Generic GetRule Source # | |
| Read GetRule Source # | |
| Show GetRule Source # | |
| NFData GetRule Source # | |
Defined in Amazonka.RBin.GetRule | |
| Eq GetRule Source # | |
| Hashable GetRule Source # | |
Defined in Amazonka.RBin.GetRule | |
| type AWSResponse GetRule Source # | |
Defined in Amazonka.RBin.GetRule | |
| type Rep GetRule Source # | |
Defined in Amazonka.RBin.GetRule | |
Create a value of GetRule 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:
GetRule, getRule_identifier - The unique ID of the retention rule.
data GetRuleResponse Source #
See: newGetRuleResponse smart constructor.
Constructors
| GetRuleResponse' (Maybe Text) (Maybe Text) (Maybe LockConfiguration) (Maybe POSIX) (Maybe LockState) (Maybe [ResourceTag]) (Maybe ResourceType) (Maybe RetentionPeriod) (Maybe RuleStatus) Int |
Instances
Arguments
| :: Int | |
| -> GetRuleResponse |
Create a value of GetRuleResponse 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:
GetRuleResponse, getRuleResponse_description - The retention rule description.
GetRule, getRuleResponse_identifier - The unique ID of the retention rule.
$sel:lockConfiguration:GetRuleResponse', getRuleResponse_lockConfiguration - Information about the retention rule lock configuration.
$sel:lockEndTime:GetRuleResponse', getRuleResponse_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.
GetRuleResponse, getRuleResponse_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 thelockedandunlockedstates only; it can never transition back tonull.
$sel:resourceTags:GetRuleResponse', getRuleResponse_resourceTags - Information about the resource tags used to identify resources that are
retained by the retention rule.
$sel:resourceType:GetRuleResponse', getRuleResponse_resourceType - The resource type retained by the retention rule.
GetRuleResponse, getRuleResponse_retentionPeriod - Information about the retention period for which the retention rule is
to retain resources.
$sel:status:GetRuleResponse', getRuleResponse_status - The state of the retention rule. Only retention rules that are in the
available state retain resources.
$sel:httpStatus:GetRuleResponse', getRuleResponse_httpStatus - The response's http status code.
ListRules (Paginated)
See: newListRules smart constructor.
Constructors
| ListRules' (Maybe LockState) (Maybe Natural) (Maybe Text) (Maybe [ResourceTag]) ResourceType |
Instances
Arguments
| :: ResourceType | |
| -> ListRules |
Create a value of ListRules 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:
ListRules, listRules_lockState - The lock state of the retention rules to list. Only retention rules with
the specified lock state are returned.
$sel:maxResults:ListRules', listRules_maxResults - 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, listRules_nextToken - The token for the next page of results.
$sel:resourceTags:ListRules', listRules_resourceTags - Information about the resource tags used to identify resources that are
retained by the retention rule.
$sel:resourceType:ListRules', listRules_resourceType - 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.
data ListRulesResponse Source #
See: newListRulesResponse smart constructor.
Constructors
| ListRulesResponse' (Maybe Text) (Maybe [RuleSummary]) Int |
Instances
Arguments
| :: Int | |
| -> ListRulesResponse |
Create a value of ListRulesResponse 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:
ListRules, listRulesResponse_nextToken - The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
$sel:rules:ListRulesResponse', listRulesResponse_rules - Information about the retention rules.
$sel:httpStatus:ListRulesResponse', listRulesResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the retention rule.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - Information about the tags assigned to the retention rule.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
LockRule
See: newLockRule smart constructor.
Constructors
| LockRule' Text LockConfiguration |
Instances
Arguments
| :: Text | |
| -> LockConfiguration | |
| -> 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.
data LockRuleResponse Source #
See: newLockRuleResponse smart constructor.
Constructors
| LockRuleResponse' (Maybe Text) (Maybe Text) (Maybe LockConfiguration) (Maybe LockState) (Maybe [ResourceTag]) (Maybe ResourceType) (Maybe RetentionPeriod) (Maybe RuleStatus) Int |
Instances
Arguments
| :: Int | |
| -> 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 thelockedandunlockedstates only; it can never transition back tonull.
$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.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the retention rule.
$sel:tags:TagResource', tagResource_tags - Information about the tags to assign to the retention rule.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UnlockRule
data UnlockRule Source #
See: newUnlockRule smart constructor.
Constructors
| UnlockRule' Text |
Instances
Arguments
| :: 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.
data UnlockRuleResponse Source #
See: newUnlockRuleResponse smart constructor.
Constructors
| UnlockRuleResponse' (Maybe Text) (Maybe Text) (Maybe LockConfiguration) (Maybe POSIX) (Maybe LockState) (Maybe [ResourceTag]) (Maybe ResourceType) (Maybe RetentionPeriod) (Maybe RuleStatus) Int |
Instances
newUnlockRuleResponse Source #
Arguments
| :: Int | |
| -> 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 thelockedandunlockedstates 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.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the retention rule.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The tag keys of the tags to unassign. All tags that have the specified
tag key are unassigned.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateRule
data UpdateRule Source #
See: newUpdateRule smart constructor.
Constructors
| UpdateRule' (Maybe Text) (Maybe [ResourceTag]) (Maybe ResourceType) (Maybe RetentionPeriod) Text |
Instances
Arguments
| :: Text | |
| -> UpdateRule |
Create a value of UpdateRule 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:
UpdateRule, updateRule_description - The retention rule description.
UpdateRule, updateRule_resourceTags - 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, updateRule_resourceType - This parameter is currently not supported. You can't update a retention
rule's resource type after creation.
UpdateRule, updateRule_retentionPeriod - Information about the retention period for which the retention rule is
to retain resources.
UpdateRule, updateRule_identifier - The unique ID of the retention rule.
data UpdateRuleResponse Source #
See: newUpdateRuleResponse smart constructor.
Constructors
| UpdateRuleResponse' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe LockState) (Maybe [ResourceTag]) (Maybe ResourceType) (Maybe RetentionPeriod) (Maybe RuleStatus) Int |
Instances
newUpdateRuleResponse Source #
Arguments
| :: Int | |
| -> UpdateRuleResponse |
Create a value of UpdateRuleResponse 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:
UpdateRule, updateRuleResponse_description - The retention rule description.
UpdateRule, updateRuleResponse_identifier - The unique ID of the retention rule.
$sel:lockEndTime:UpdateRuleResponse', updateRuleResponse_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.
UpdateRuleResponse, updateRuleResponse_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 thelockedandunlockedstates only; it can never transition back tonull.
UpdateRule, updateRuleResponse_resourceTags - Information about the resource tags used to identify resources that are
retained by the retention rule.
UpdateRule, updateRuleResponse_resourceType - The resource type retained by the retention rule.
UpdateRule, updateRuleResponse_retentionPeriod - Undocumented member.
$sel:status:UpdateRuleResponse', updateRuleResponse_status - The state of the retention rule. Only retention rules that are in the
available state retain resources.
$sel:httpStatus:UpdateRuleResponse', updateRuleResponse_httpStatus - The response's http status code.
Types
LockState
Constructors
| LockState' | |
Fields | |
Bundled Patterns
| pattern LockState_Locked :: LockState | |
| pattern LockState_Pending_unlock :: LockState | |
| pattern LockState_Unlocked :: LockState |
Instances
ResourceType
newtype ResourceType Source #
Constructors
| ResourceType' | |
Fields | |
Bundled Patterns
| pattern ResourceType_EBS_SNAPSHOT :: ResourceType | |
| pattern ResourceType_EC2_IMAGE :: ResourceType |
Instances
RetentionPeriodUnit
newtype RetentionPeriodUnit Source #
Constructors
| RetentionPeriodUnit' | |
Fields | |
Bundled Patterns
| pattern RetentionPeriodUnit_DAYS :: RetentionPeriodUnit |
Instances
RuleStatus
newtype RuleStatus Source #
Constructors
| RuleStatus' | |
Fields | |
Bundled Patterns
| pattern RuleStatus_Available :: RuleStatus | |
| pattern RuleStatus_Pending :: RuleStatus |
Instances
UnlockDelayUnit
newtype UnlockDelayUnit Source #
Constructors
| UnlockDelayUnit' | |
Fields | |
Bundled Patterns
| pattern UnlockDelayUnit_DAYS :: UnlockDelayUnit |
Instances
LockConfiguration
data LockConfiguration Source #
Information about a retention rule lock configuration.
See: newLockConfiguration smart constructor.
Constructors
| LockConfiguration' UnlockDelay |
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.
ResourceTag
data ResourceTag Source #
Information about the resource tags used to identify resources that are retained by the retention rule.
See: newResourceTag smart constructor.
Constructors
| ResourceTag' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> ResourceTag |
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.
RetentionPeriod
data RetentionPeriod Source #
Information about the retention period for which the retention rule is to retain resources.
See: newRetentionPeriod smart constructor.
Constructors
| RetentionPeriod' Natural RetentionPeriodUnit |
Instances
Arguments
| :: Natural | |
| -> RetentionPeriodUnit | |
| -> RetentionPeriod |
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.
RuleSummary
data RuleSummary Source #
Information about a Recycle Bin retention rule.
See: newRuleSummary smart constructor.
Constructors
| RuleSummary' (Maybe Text) (Maybe Text) (Maybe LockState) (Maybe RetentionPeriod) |
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 thelockedandunlockedstates 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.
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.
Constructors
| UnlockDelay' Natural UnlockDelayUnit |
Instances
Arguments
| :: 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.