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.Shield.DescribeProtection

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the details of a Protection object.

Creating a Request

data DescribeProtection Source #

See: newDescribeProtection smart constructor.

Constructors

DescribeProtection'

Fields

protectionId :: Maybe Text
The unique identifier (ID) for the Protection object to describe. You must provide either the ResourceArn of the protected resource or the ProtectionID of the protection, but not both.
resourceArn :: Maybe Text
The ARN (Amazon Resource Name) of the protected Amazon Web Services resource. You must provide either the ResourceArn of the protected resource or the ProtectionID of the protection, but not both.

Instances

Instances details

ToJSON DescribeProtection Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Methods toJSON :: DescribeProtection -> Value # toEncoding :: DescribeProtection -> Encoding # toJSONList :: [DescribeProtection] -> Value # toEncodingList :: [DescribeProtection] -> Encoding #
ToHeaders DescribeProtection Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Methods toHeaders :: DescribeProtection -> [Header] #
ToPath DescribeProtection Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Methods toPath :: DescribeProtection -> ByteString #
ToQuery DescribeProtection Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Methods toQuery :: DescribeProtection -> QueryString #
AWSRequest DescribeProtection Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Associated Types type AWSResponse DescribeProtection # Methods request :: (Service -> Service) -> DescribeProtection -> Request DescribeProtection # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeProtection -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeProtection))) #
Generic DescribeProtection Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Associated Types type Rep DescribeProtection :: Type -> Type # Methods from :: DescribeProtection -> Rep DescribeProtection x # to :: Rep DescribeProtection x -> DescribeProtection #
Read DescribeProtection Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Methods readsPrec :: Int -> ReadS DescribeProtection # readList :: ReadS [DescribeProtection] # readPrec :: ReadPrec DescribeProtection # readListPrec :: ReadPrec [DescribeProtection] #
Show DescribeProtection Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Methods showsPrec :: Int -> DescribeProtection -> ShowS # show :: DescribeProtection -> String # showList :: [DescribeProtection] -> ShowS #
NFData DescribeProtection Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Methods rnf :: DescribeProtection -> () #
Eq DescribeProtection Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Methods (==) :: DescribeProtection -> DescribeProtection -> Bool # (/=) :: DescribeProtection -> DescribeProtection -> Bool #
Hashable DescribeProtection Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Methods hashWithSalt :: Int -> DescribeProtection -> Int # hash :: DescribeProtection -> Int #
type AWSResponse DescribeProtection Source #
Instance details Defined in Amazonka.Shield.DescribeProtection type AWSResponse DescribeProtection = DescribeProtectionResponse
type Rep DescribeProtection Source #
Instance details Defined in Amazonka.Shield.DescribeProtection type Rep DescribeProtection = D1 ('MetaData "DescribeProtection" "Amazonka.Shield.DescribeProtection" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "DescribeProtection'" 'PrefixI 'True) (S1 ('MetaSel ('Just "protectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDescribeProtection :: DescribeProtection Source #

Create a value of DescribeProtection 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:protectionId:DescribeProtection', describeProtection_protectionId - The unique identifier (ID) for the Protection object to describe. You must provide either the ResourceArn of the protected resource or the ProtectionID of the protection, but not both.

DescribeProtection, describeProtection_resourceArn - The ARN (Amazon Resource Name) of the protected Amazon Web Services resource. You must provide either the ResourceArn of the protected resource or the ProtectionID of the protection, but not both.

Request Lenses

describeProtection_protectionId :: Lens' DescribeProtection (Maybe Text) Source #

The unique identifier (ID) for the Protection object to describe. You must provide either the ResourceArn of the protected resource or the ProtectionID of the protection, but not both.

describeProtection_resourceArn :: Lens' DescribeProtection (Maybe Text) Source #

The ARN (Amazon Resource Name) of the protected Amazon Web Services resource. You must provide either the ResourceArn of the protected resource or the ProtectionID of the protection, but not both.

Destructuring the Response

data DescribeProtectionResponse Source #

See: newDescribeProtectionResponse smart constructor.

Constructors

DescribeProtectionResponse'
Fields protection :: Maybe Protection The Protection that you requested. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeProtectionResponse Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Associated Types type Rep DescribeProtectionResponse :: Type -> Type # Methods from :: DescribeProtectionResponse -> Rep DescribeProtectionResponse x # to :: Rep DescribeProtectionResponse x -> DescribeProtectionResponse #
Read DescribeProtectionResponse Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Methods readsPrec :: Int -> ReadS DescribeProtectionResponse # readList :: ReadS [DescribeProtectionResponse] # readPrec :: ReadPrec DescribeProtectionResponse # readListPrec :: ReadPrec [DescribeProtectionResponse] #
Show DescribeProtectionResponse Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Methods showsPrec :: Int -> DescribeProtectionResponse -> ShowS # show :: DescribeProtectionResponse -> String # showList :: [DescribeProtectionResponse] -> ShowS #
NFData DescribeProtectionResponse Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Methods rnf :: DescribeProtectionResponse -> () #
Eq DescribeProtectionResponse Source #
Instance details Defined in Amazonka.Shield.DescribeProtection Methods (==) :: DescribeProtectionResponse -> DescribeProtectionResponse -> Bool # (/=) :: DescribeProtectionResponse -> DescribeProtectionResponse -> Bool #
type Rep DescribeProtectionResponse Source #
Instance details Defined in Amazonka.Shield.DescribeProtection type Rep DescribeProtectionResponse = D1 ('MetaData "DescribeProtectionResponse" "Amazonka.Shield.DescribeProtection" "amazonka-shield-2.0-Cz9Fa9OSQ93AE4UCXBDcFo" 'False) (C1 ('MetaCons "DescribeProtectionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "protection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Protection)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeProtectionResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeProtectionResponse'`
-> DescribeProtectionResponse

Create a value of DescribeProtectionResponse 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:protection:DescribeProtectionResponse', describeProtectionResponse_protection - The Protection that you requested.

$sel:httpStatus:DescribeProtectionResponse', describeProtectionResponse_httpStatus - The response's http status code.

Response Lenses

describeProtectionResponse_protection :: Lens' DescribeProtectionResponse (Maybe Protection) Source #

The Protection that you requested.

describeProtectionResponse_httpStatus :: Lens' DescribeProtectionResponse Int Source #

The response's http status code.