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 |
Gets information about a Device Defender security profile.
Requires permission to access the DescribeSecurityProfile action.
Synopsis
- data DescribeSecurityProfile = DescribeSecurityProfile' {}
- newDescribeSecurityProfile :: Text -> DescribeSecurityProfile
- describeSecurityProfile_securityProfileName :: Lens' DescribeSecurityProfile Text
- data DescribeSecurityProfileResponse = DescribeSecurityProfileResponse' {
- additionalMetricsToRetain :: Maybe [Text]
- additionalMetricsToRetainV2 :: Maybe [MetricToRetain]
- alertTargets :: Maybe (HashMap AlertTargetType AlertTarget)
- behaviors :: Maybe [Behavior]
- creationDate :: Maybe POSIX
- lastModifiedDate :: Maybe POSIX
- securityProfileArn :: Maybe Text
- securityProfileDescription :: Maybe Text
- securityProfileName :: Maybe Text
- version :: Maybe Integer
- httpStatus :: Int
- newDescribeSecurityProfileResponse :: Int -> DescribeSecurityProfileResponse
- describeSecurityProfileResponse_additionalMetricsToRetain :: Lens' DescribeSecurityProfileResponse (Maybe [Text])
- describeSecurityProfileResponse_additionalMetricsToRetainV2 :: Lens' DescribeSecurityProfileResponse (Maybe [MetricToRetain])
- describeSecurityProfileResponse_alertTargets :: Lens' DescribeSecurityProfileResponse (Maybe (HashMap AlertTargetType AlertTarget))
- describeSecurityProfileResponse_behaviors :: Lens' DescribeSecurityProfileResponse (Maybe [Behavior])
- describeSecurityProfileResponse_creationDate :: Lens' DescribeSecurityProfileResponse (Maybe UTCTime)
- describeSecurityProfileResponse_lastModifiedDate :: Lens' DescribeSecurityProfileResponse (Maybe UTCTime)
- describeSecurityProfileResponse_securityProfileArn :: Lens' DescribeSecurityProfileResponse (Maybe Text)
- describeSecurityProfileResponse_securityProfileDescription :: Lens' DescribeSecurityProfileResponse (Maybe Text)
- describeSecurityProfileResponse_securityProfileName :: Lens' DescribeSecurityProfileResponse (Maybe Text)
- describeSecurityProfileResponse_version :: Lens' DescribeSecurityProfileResponse (Maybe Integer)
- describeSecurityProfileResponse_httpStatus :: Lens' DescribeSecurityProfileResponse Int
Creating a Request
data DescribeSecurityProfile Source #
See: newDescribeSecurityProfile
smart constructor.
DescribeSecurityProfile' | |
|
Instances
newDescribeSecurityProfile Source #
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:
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.
DescribeSecurityProfileResponse' | |
|
Instances
newDescribeSecurityProfileResponse Source #
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: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: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:alertTargets:DescribeSecurityProfileResponse'
, describeSecurityProfileResponse_alertTargets
- Where the alerts are sent. (Alerts are always sent to the console.)
$sel:behaviors:DescribeSecurityProfileResponse'
, describeSecurityProfileResponse_behaviors
- Specifies the behaviors that, when violated by a device (thing), cause
an alert.
DescribeSecurityProfileResponse
, describeSecurityProfileResponse_creationDate
- The time the security profile was created.
DescribeSecurityProfileResponse
, describeSecurityProfileResponse_lastModifiedDate
- The time the security profile was last modified.
$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).
DescribeSecurityProfile
, describeSecurityProfileResponse_securityProfileName
- The name of the security profile.
DescribeSecurityProfileResponse
, describeSecurityProfileResponse_version
- The version of the security profile. A new version is generated whenever
the security profile is updated.
$sel:httpStatus:DescribeSecurityProfileResponse'
, describeSecurityProfileResponse_httpStatus
- The response's http status code.
Response Lenses
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_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_alertTargets :: Lens' DescribeSecurityProfileResponse (Maybe (HashMap AlertTargetType AlertTarget)) Source #
Where the alerts are sent. (Alerts are always sent to the console.)
describeSecurityProfileResponse_behaviors :: Lens' DescribeSecurityProfileResponse (Maybe [Behavior]) Source #
Specifies the behaviors that, when violated by a device (thing), cause an alert.
describeSecurityProfileResponse_creationDate :: Lens' DescribeSecurityProfileResponse (Maybe UTCTime) Source #
The time the security profile was created.
describeSecurityProfileResponse_lastModifiedDate :: Lens' DescribeSecurityProfileResponse (Maybe UTCTime) Source #
The time the security profile was last modified.
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_securityProfileName :: Lens' DescribeSecurityProfileResponse (Maybe Text) Source #
The name of the security profile.
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_httpStatus :: Lens' DescribeSecurityProfileResponse Int Source #
The response's http status code.