Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoT.DescribeSecurityProfile

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about a Device Defender security profile.

Requires permission to access the DescribeSecurityProfile action.

Synopsis

Creating a Request

data DescribeSecurityProfile Source #

See: newDescribeSecurityProfile smart constructor.

Constructors

DescribeSecurityProfile'
Fields securityProfileName :: Text The name of the security profile whose information you want to get.

Instances

Instances details

Eq DescribeSecurityProfile Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile Methods (==) :: DescribeSecurityProfile -> DescribeSecurityProfile -> Bool # (/=) :: DescribeSecurityProfile -> DescribeSecurityProfile -> Bool #
Read DescribeSecurityProfile Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile Methods readsPrec :: Int -> ReadS DescribeSecurityProfile # readList :: ReadS [DescribeSecurityProfile] # readPrec :: ReadPrec DescribeSecurityProfile # readListPrec :: ReadPrec [DescribeSecurityProfile] #
Show DescribeSecurityProfile Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile Methods showsPrec :: Int -> DescribeSecurityProfile -> ShowS # show :: DescribeSecurityProfile -> String # showList :: [DescribeSecurityProfile] -> ShowS #
Generic DescribeSecurityProfile Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile Associated Types type Rep DescribeSecurityProfile :: Type -> Type # Methods from :: DescribeSecurityProfile -> Rep DescribeSecurityProfile x # to :: Rep DescribeSecurityProfile x -> DescribeSecurityProfile #
NFData DescribeSecurityProfile Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile Methods rnf :: DescribeSecurityProfile -> () #
Hashable DescribeSecurityProfile Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile Methods hashWithSalt :: Int -> DescribeSecurityProfile -> Int # hash :: DescribeSecurityProfile -> Int #
AWSRequest DescribeSecurityProfile Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile Associated Types type AWSResponse DescribeSecurityProfile # Methods request :: DescribeSecurityProfile -> Request DescribeSecurityProfile # response :: MonadResource m => Logger -> Service -> Proxy DescribeSecurityProfile -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSecurityProfile))) #
ToHeaders DescribeSecurityProfile Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile Methods toHeaders :: DescribeSecurityProfile -> [Header] #
ToPath DescribeSecurityProfile Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile Methods toPath :: DescribeSecurityProfile -> ByteString #
ToQuery DescribeSecurityProfile Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile Methods toQuery :: DescribeSecurityProfile -> QueryString #
type Rep DescribeSecurityProfile Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile type Rep DescribeSecurityProfile = D1 ('MetaData "DescribeSecurityProfile" "Amazonka.IoT.DescribeSecurityProfile" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "DescribeSecurityProfile'" 'PrefixI 'True) (S1 ('MetaSel ('Just "securityProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeSecurityProfile Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile type AWSResponse DescribeSecurityProfile = DescribeSecurityProfileResponse

newDescribeSecurityProfile Source #

Arguments

:: Text	`$sel:securityProfileName:DescribeSecurityProfile'`
-> DescribeSecurityProfile

Create a value of DescribeSecurityProfile 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:securityProfileName:DescribeSecurityProfile', describeSecurityProfile_securityProfileName - The name of the security profile whose information you want to get.

Request Lenses

describeSecurityProfile_securityProfileName :: Lens' DescribeSecurityProfile Text Source #

The name of the security profile whose information you want to get.

Destructuring the Response

data DescribeSecurityProfileResponse Source #

See: newDescribeSecurityProfileResponse smart constructor.

Constructors

DescribeSecurityProfileResponse'

Fields

alertTargets :: Maybe (HashMap AlertTargetType AlertTarget)
Where the alerts are sent. (Alerts are always sent to the console.)
additionalMetricsToRetainV2 :: Maybe [MetricToRetain]
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
behaviors :: Maybe [Behavior]
Specifies the behaviors that, when violated by a device (thing), cause an alert.
lastModifiedDate :: Maybe POSIX
The time the security profile was last modified.
version :: Maybe Integer
The version of the security profile. A new version is generated whenever the security profile is updated.
securityProfileName :: Maybe Text
The name of the security profile.
creationDate :: Maybe POSIX
The time the security profile was created.
additionalMetricsToRetain :: Maybe [Text]
/Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead./
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
securityProfileArn :: Maybe Text
The ARN of the security profile.
securityProfileDescription :: Maybe Text
A description of the security profile (associated with the security profile when it was created or updated).
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile Methods (==) :: DescribeSecurityProfileResponse -> DescribeSecurityProfileResponse -> Bool # (/=) :: DescribeSecurityProfileResponse -> DescribeSecurityProfileResponse -> Bool #
Read DescribeSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile Methods readsPrec :: Int -> ReadS DescribeSecurityProfileResponse # readList :: ReadS [DescribeSecurityProfileResponse] # readPrec :: ReadPrec DescribeSecurityProfileResponse # readListPrec :: ReadPrec [DescribeSecurityProfileResponse] #
Show DescribeSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile Methods showsPrec :: Int -> DescribeSecurityProfileResponse -> ShowS # show :: DescribeSecurityProfileResponse -> String # showList :: [DescribeSecurityProfileResponse] -> ShowS #
Generic DescribeSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile Associated Types type Rep DescribeSecurityProfileResponse :: Type -> Type # Methods from :: DescribeSecurityProfileResponse -> Rep DescribeSecurityProfileResponse x # to :: Rep DescribeSecurityProfileResponse x -> DescribeSecurityProfileResponse #
NFData DescribeSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile Methods rnf :: DescribeSecurityProfileResponse -> () #
type Rep DescribeSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.DescribeSecurityProfile type Rep DescribeSecurityProfileResponse = D1 ('MetaData "DescribeSecurityProfileResponse" "Amazonka.IoT.DescribeSecurityProfile" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "DescribeSecurityProfileResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "alertTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap AlertTargetType AlertTarget))) :: S1 ('MetaSel ('Just "additionalMetricsToRetainV2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricToRetain]))) :: (S1 ('MetaSel ('Just "behaviors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Behavior])) :: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :: ((S1 ('MetaSel ('Just "securityProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "additionalMetricsToRetain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "securityProfileArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "securityProfileDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeSecurityProfileResponse Source #

Arguments

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

Create a value of DescribeSecurityProfileResponse 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:alertTargets:DescribeSecurityProfileResponse', describeSecurityProfileResponse_alertTargets - Where the alerts are sent. (Alerts are always sent to the console.)

$sel:additionalMetricsToRetainV2:DescribeSecurityProfileResponse', describeSecurityProfileResponse_additionalMetricsToRetainV2 - A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

$sel:behaviors:DescribeSecurityProfileResponse', describeSecurityProfileResponse_behaviors - Specifies the behaviors that, when violated by a device (thing), cause an alert.

$sel:lastModifiedDate:DescribeSecurityProfileResponse', describeSecurityProfileResponse_lastModifiedDate - The time the security profile was last modified.

$sel:version:DescribeSecurityProfileResponse', describeSecurityProfileResponse_version - The version of the security profile. A new version is generated whenever the security profile is updated.

$sel:securityProfileName:DescribeSecurityProfile', describeSecurityProfileResponse_securityProfileName - The name of the security profile.

$sel:creationDate:DescribeSecurityProfileResponse', describeSecurityProfileResponse_creationDate - The time the security profile was created.

$sel:additionalMetricsToRetain:DescribeSecurityProfileResponse', describeSecurityProfileResponse_additionalMetricsToRetain - /Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead./

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

$sel:securityProfileArn:DescribeSecurityProfileResponse', describeSecurityProfileResponse_securityProfileArn - The ARN of the security profile.

$sel:securityProfileDescription:DescribeSecurityProfileResponse', describeSecurityProfileResponse_securityProfileDescription - A description of the security profile (associated with the security profile when it was created or updated).

$sel:httpStatus:DescribeSecurityProfileResponse', describeSecurityProfileResponse_httpStatus - The response's http status code.

Response Lenses

describeSecurityProfileResponse_alertTargets :: Lens' DescribeSecurityProfileResponse (Maybe (HashMap AlertTargetType AlertTarget)) Source #

Where the alerts are sent. (Alerts are always sent to the console.)

describeSecurityProfileResponse_additionalMetricsToRetainV2 :: Lens' DescribeSecurityProfileResponse (Maybe [MetricToRetain]) Source #

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

describeSecurityProfileResponse_behaviors :: Lens' DescribeSecurityProfileResponse (Maybe [Behavior]) Source #

Specifies the behaviors that, when violated by a device (thing), cause an alert.

describeSecurityProfileResponse_lastModifiedDate :: Lens' DescribeSecurityProfileResponse (Maybe UTCTime) Source #

The time the security profile was last modified.

describeSecurityProfileResponse_version :: Lens' DescribeSecurityProfileResponse (Maybe Integer) Source #

The version of the security profile. A new version is generated whenever the security profile is updated.

describeSecurityProfileResponse_securityProfileName :: Lens' DescribeSecurityProfileResponse (Maybe Text) Source #

The name of the security profile.

describeSecurityProfileResponse_creationDate :: Lens' DescribeSecurityProfileResponse (Maybe UTCTime) Source #

The time the security profile was created.

describeSecurityProfileResponse_additionalMetricsToRetain :: Lens' DescribeSecurityProfileResponse (Maybe [Text]) Source #

/Please use DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead./

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

describeSecurityProfileResponse_securityProfileArn :: Lens' DescribeSecurityProfileResponse (Maybe Text) Source #

The ARN of the security profile.

describeSecurityProfileResponse_securityProfileDescription :: Lens' DescribeSecurityProfileResponse (Maybe Text) Source #

A description of the security profile (associated with the security profile when it was created or updated).

describeSecurityProfileResponse_httpStatus :: Lens' DescribeSecurityProfileResponse Int Source #

The response's http status code.