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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the Recycle Bin retention rules in the Region.

This operation returns paginated results.

Synopsis

data ListRules = ListRules' {
- lockState :: Maybe LockState
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- resourceTags :: Maybe [ResourceTag]
- resourceType :: ResourceType
}
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

data ListRules Source #

See: newListRules smart constructor.

Constructors

ListRules'

Fields

lockState :: Maybe LockState
The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.
maxResults :: Maybe Natural
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.
nextToken :: Maybe Text
The token for the next page of results.
resourceTags :: Maybe [ResourceTag]
Information about the resource tags used to identify resources that are retained by the retention rule.
resourceType :: 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.

Instances

Instances details

ToJSON ListRules Source #
Instance details Defined in Amazonka.RBin.ListRules Methods toJSON :: ListRules -> Value # toEncoding :: ListRules -> Encoding # toJSONList :: [ListRules] -> Value # toEncodingList :: [ListRules] -> Encoding #
ToHeaders ListRules Source #
Instance details Defined in Amazonka.RBin.ListRules Methods toHeaders :: ListRules -> [Header] #
ToPath ListRules Source #
Instance details Defined in Amazonka.RBin.ListRules Methods toPath :: ListRules -> ByteString #
ToQuery ListRules Source #
Instance details Defined in Amazonka.RBin.ListRules Methods toQuery :: ListRules -> QueryString #
AWSPager ListRules Source #
Instance details Defined in Amazonka.RBin.ListRules Methods page :: ListRules -> AWSResponse ListRules -> Maybe ListRules #
AWSRequest ListRules Source #
Instance details Defined in Amazonka.RBin.ListRules Associated Types type AWSResponse ListRules # Methods request :: (Service -> Service) -> ListRules -> Request ListRules # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListRules -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListRules))) #
Generic ListRules Source #
Instance details Defined in Amazonka.RBin.ListRules Associated Types type Rep ListRules :: Type -> Type # Methods from :: ListRules -> Rep ListRules x # to :: Rep ListRules x -> ListRules #
Read ListRules Source #
Instance details Defined in Amazonka.RBin.ListRules Methods readsPrec :: Int -> ReadS ListRules # readList :: ReadS [ListRules] # readPrec :: ReadPrec ListRules # readListPrec :: ReadPrec [ListRules] #
Show ListRules Source #
Instance details Defined in Amazonka.RBin.ListRules Methods showsPrec :: Int -> ListRules -> ShowS # show :: ListRules -> String # showList :: [ListRules] -> ShowS #
NFData ListRules Source #
Instance details Defined in Amazonka.RBin.ListRules Methods rnf :: ListRules -> () #
Eq ListRules Source #
Instance details Defined in Amazonka.RBin.ListRules Methods (==) :: ListRules -> ListRules -> Bool # (/=) :: ListRules -> ListRules -> Bool #
Hashable ListRules Source #
Instance details Defined in Amazonka.RBin.ListRules Methods hashWithSalt :: Int -> ListRules -> Int # hash :: ListRules -> Int #
type AWSResponse ListRules Source #
Instance details Defined in Amazonka.RBin.ListRules type AWSResponse ListRules = ListRulesResponse
type Rep ListRules Source #
Instance details Defined in Amazonka.RBin.ListRules type Rep ListRules = D1 ('MetaData "ListRules" "Amazonka.RBin.ListRules" "amazonka-rbin-2.0-683M7qr6PFTBsVsY3OL2az" 'False) (C1 ('MetaCons "ListRules'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lockState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LockState)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "resourceTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceTag])) :: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceType)))))

newListRules Source #

Arguments

:: ResourceType	`$sel:resourceType:ListRules'`
-> 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.

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

Destructuring the Response

data ListRulesResponse Source #

See: newListRulesResponse smart constructor.

Constructors

ListRulesResponse'
Fields nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. rules :: Maybe [RuleSummary] Information about the retention rules. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListRulesResponse Source #
Instance details Defined in Amazonka.RBin.ListRules Associated Types type Rep ListRulesResponse :: Type -> Type # Methods from :: ListRulesResponse -> Rep ListRulesResponse x # to :: Rep ListRulesResponse x -> ListRulesResponse #
Read ListRulesResponse Source #
Instance details Defined in Amazonka.RBin.ListRules Methods readsPrec :: Int -> ReadS ListRulesResponse # readList :: ReadS [ListRulesResponse] # readPrec :: ReadPrec ListRulesResponse # readListPrec :: ReadPrec [ListRulesResponse] #
Show ListRulesResponse Source #
Instance details Defined in Amazonka.RBin.ListRules Methods showsPrec :: Int -> ListRulesResponse -> ShowS # show :: ListRulesResponse -> String # showList :: [ListRulesResponse] -> ShowS #
NFData ListRulesResponse Source #
Instance details Defined in Amazonka.RBin.ListRules Methods rnf :: ListRulesResponse -> () #
Eq ListRulesResponse Source #
Instance details Defined in Amazonka.RBin.ListRules Methods (==) :: ListRulesResponse -> ListRulesResponse -> Bool # (/=) :: ListRulesResponse -> ListRulesResponse -> Bool #
type Rep ListRulesResponse Source #
Instance details Defined in Amazonka.RBin.ListRules type Rep ListRulesResponse = D1 ('MetaData "ListRulesResponse" "Amazonka.RBin.ListRules" "amazonka-rbin-2.0-683M7qr6PFTBsVsY3OL2az" 'False) (C1 ('MetaCons "ListRulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RuleSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListRulesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListRulesResponse'`
-> 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.

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.