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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about a Recycle Bin retention rule.

Synopsis

data GetRule = GetRule' {
- identifier :: Text
}
newGetRule :: Text -> GetRule
getRule_identifier :: Lens' GetRule Text
data GetRuleResponse = GetRuleResponse' {
- description :: Maybe Text
- identifier :: Maybe Text
- lockConfiguration :: Maybe LockConfiguration
- lockEndTime :: Maybe POSIX
- lockState :: Maybe LockState
- resourceTags :: Maybe [ResourceTag]
- resourceType :: Maybe ResourceType
- retentionPeriod :: Maybe RetentionPeriod
- status :: Maybe RuleStatus
- httpStatus :: Int
}
newGetRuleResponse :: Int -> GetRuleResponse
getRuleResponse_description :: Lens' GetRuleResponse (Maybe Text)
getRuleResponse_identifier :: Lens' GetRuleResponse (Maybe Text)
getRuleResponse_lockConfiguration :: Lens' GetRuleResponse (Maybe LockConfiguration)
getRuleResponse_lockEndTime :: Lens' GetRuleResponse (Maybe UTCTime)
getRuleResponse_lockState :: Lens' GetRuleResponse (Maybe LockState)
getRuleResponse_resourceTags :: Lens' GetRuleResponse (Maybe [ResourceTag])
getRuleResponse_resourceType :: Lens' GetRuleResponse (Maybe ResourceType)
getRuleResponse_retentionPeriod :: Lens' GetRuleResponse (Maybe RetentionPeriod)
getRuleResponse_status :: Lens' GetRuleResponse (Maybe RuleStatus)
getRuleResponse_httpStatus :: Lens' GetRuleResponse Int

Creating a Request

data GetRule Source #

See: newGetRule smart constructor.

Constructors

GetRule'
Fields identifier :: Text The unique ID of the retention rule.

Instances

Instances details

ToHeaders GetRule Source #
Instance details Defined in Amazonka.RBin.GetRule Methods toHeaders :: GetRule -> [Header] #
ToPath GetRule Source #
Instance details Defined in Amazonka.RBin.GetRule Methods toPath :: GetRule -> ByteString #
ToQuery GetRule Source #
Instance details Defined in Amazonka.RBin.GetRule Methods toQuery :: GetRule -> QueryString #
AWSRequest GetRule Source #
Instance details 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 #
Instance details Defined in Amazonka.RBin.GetRule Associated Types type Rep GetRule :: Type -> Type # Methods from :: GetRule -> Rep GetRule x # to :: Rep GetRule x -> GetRule #
Read GetRule Source #
Instance details Defined in Amazonka.RBin.GetRule Methods readsPrec :: Int -> ReadS GetRule # readList :: ReadS [GetRule] # readPrec :: ReadPrec GetRule # readListPrec :: ReadPrec [GetRule] #
Show GetRule Source #
Instance details Defined in Amazonka.RBin.GetRule Methods showsPrec :: Int -> GetRule -> ShowS # show :: GetRule -> String # showList :: [GetRule] -> ShowS #
NFData GetRule Source #
Instance details Defined in Amazonka.RBin.GetRule Methods rnf :: GetRule -> () #
Eq GetRule Source #
Instance details Defined in Amazonka.RBin.GetRule Methods (==) :: GetRule -> GetRule -> Bool # (/=) :: GetRule -> GetRule -> Bool #
Hashable GetRule Source #
Instance details Defined in Amazonka.RBin.GetRule Methods hashWithSalt :: Int -> GetRule -> Int # hash :: GetRule -> Int #
type AWSResponse GetRule Source #
Instance details Defined in Amazonka.RBin.GetRule type AWSResponse GetRule = GetRuleResponse
type Rep GetRule Source #
Instance details Defined in Amazonka.RBin.GetRule type Rep GetRule = D1 ('MetaData "GetRule" "Amazonka.RBin.GetRule" "amazonka-rbin-2.0-683M7qr6PFTBsVsY3OL2az" 'False) (C1 ('MetaCons "GetRule'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetRule Source #

Arguments

:: Text	`GetRule`
-> 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.

Request Lenses

getRule_identifier :: Lens' GetRule Text Source #

The unique ID of the retention rule.

Destructuring the Response

data GetRuleResponse Source #

See: newGetRuleResponse smart constructor.

Constructors

GetRuleResponse'

Fields

description :: Maybe Text
The retention rule description.
identifier :: Maybe Text
The unique ID of the retention rule.
lockConfiguration :: Maybe LockConfiguration
Information about the retention rule lock configuration.
lockEndTime :: Maybe POSIX
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.
lockState :: Maybe 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 the locked and unlocked states only; it can never transition back to null.
resourceTags :: Maybe [ResourceTag]
Information about the resource tags used to identify resources that are retained by the retention rule.
resourceType :: Maybe ResourceType
The resource type retained by the retention rule.
retentionPeriod :: Maybe RetentionPeriod
Information about the retention period for which the retention rule is to retain resources.
status :: Maybe RuleStatus
The state of the retention rule. Only retention rules that are in the available state retain resources.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetRuleResponse Source #
Instance details Defined in Amazonka.RBin.GetRule Associated Types type Rep GetRuleResponse :: Type -> Type # Methods from :: GetRuleResponse -> Rep GetRuleResponse x # to :: Rep GetRuleResponse x -> GetRuleResponse #
Read GetRuleResponse Source #
Instance details Defined in Amazonka.RBin.GetRule Methods readsPrec :: Int -> ReadS GetRuleResponse # readList :: ReadS [GetRuleResponse] # readPrec :: ReadPrec GetRuleResponse # readListPrec :: ReadPrec [GetRuleResponse] #
Show GetRuleResponse Source #
Instance details Defined in Amazonka.RBin.GetRule Methods showsPrec :: Int -> GetRuleResponse -> ShowS # show :: GetRuleResponse -> String # showList :: [GetRuleResponse] -> ShowS #
NFData GetRuleResponse Source #
Instance details Defined in Amazonka.RBin.GetRule Methods rnf :: GetRuleResponse -> () #
Eq GetRuleResponse Source #
Instance details Defined in Amazonka.RBin.GetRule Methods (==) :: GetRuleResponse -> GetRuleResponse -> Bool # (/=) :: GetRuleResponse -> GetRuleResponse -> Bool #
type Rep GetRuleResponse Source #
Instance details Defined in Amazonka.RBin.GetRule type Rep GetRuleResponse = D1 ('MetaData "GetRuleResponse" "Amazonka.RBin.GetRule" "amazonka-rbin-2.0-683M7qr6PFTBsVsY3OL2az" 'False) (C1 ('MetaCons "GetRuleResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "lockConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LockConfiguration)) :: (S1 ('MetaSel ('Just "lockEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "lockState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LockState))))) :: ((S1 ('MetaSel ('Just "resourceTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceTag])) :: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceType))) :: (S1 ('MetaSel ('Just "retentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetentionPeriod)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetRuleResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetRuleResponse'`
-> 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 the locked and unlocked states only; it can never transition back to null.

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

Response Lenses

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.