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 |
Lists the Recycle Bin retention rules in the Region.
This operation returns paginated results.
Synopsis
- data ListRules = ListRules' {}
- newListRules :: ResourceType -> ListRules
- listRules_lockState :: Lens' ListRules (Maybe LockState)
- listRules_maxResults :: Lens' ListRules (Maybe Natural)
- listRules_nextToken :: Lens' ListRules (Maybe Text)
- listRules_resourceTags :: Lens' ListRules (Maybe [ResourceTag])
- listRules_resourceType :: Lens' ListRules ResourceType
- data ListRulesResponse = ListRulesResponse' {
- nextToken :: Maybe Text
- rules :: Maybe [RuleSummary]
- httpStatus :: Int
- newListRulesResponse :: Int -> ListRulesResponse
- listRulesResponse_nextToken :: Lens' ListRulesResponse (Maybe Text)
- listRulesResponse_rules :: Lens' ListRulesResponse (Maybe [RuleSummary])
- listRulesResponse_httpStatus :: Lens' ListRulesResponse Int
Creating a Request
See: newListRules
smart constructor.
ListRules' | |
|
Instances
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
.
Request Lenses
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_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
.
Destructuring the Response
data ListRulesResponse Source #
See: newListRulesResponse
smart constructor.
ListRulesResponse' | |
|
Instances
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.
Response Lenses
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.