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.IoT.CreateSecurityProfile

Contents

Description

Creates a Device Defender security profile.

Requires permission to access the CreateSecurityProfile action.

Synopsis

Creating a Request

data CreateSecurityProfile Source #

See: newCreateSecurityProfile smart constructor.

Constructors

CreateSecurityProfile'

Fields

additionalMetricsToRetain :: Maybe [Text]
/Please use CreateSecurityProfileRequest$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. Can be used with custom metrics; cannot be used with dimensions.
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. Can be used with custom metrics; cannot be used with dimensions.
alertTargets :: Maybe (HashMap AlertTargetType AlertTarget)
Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.
behaviors :: Maybe [Behavior]
Specifies the behaviors that, when violated by a device (thing), cause an alert.
securityProfileDescription :: Maybe Text
A description of the security profile.
tags :: Maybe [Tag]
Metadata that can be used to manage the security profile.
securityProfileName :: Text
The name you are giving to the security profile.

Instances

Instances details

ToJSON CreateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Methods toJSON :: CreateSecurityProfile -> Value # toEncoding :: CreateSecurityProfile -> Encoding # toJSONList :: [CreateSecurityProfile] -> Value # toEncodingList :: [CreateSecurityProfile] -> Encoding #
ToHeaders CreateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Methods toHeaders :: CreateSecurityProfile -> [Header] #
ToPath CreateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Methods toPath :: CreateSecurityProfile -> ByteString #
ToQuery CreateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Methods toQuery :: CreateSecurityProfile -> QueryString #
AWSRequest CreateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Associated Types type AWSResponse CreateSecurityProfile # Methods request :: (Service -> Service) -> CreateSecurityProfile -> Request CreateSecurityProfile # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateSecurityProfile -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSecurityProfile))) #
Generic CreateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Associated Types type Rep CreateSecurityProfile :: Type -> Type # Methods from :: CreateSecurityProfile -> Rep CreateSecurityProfile x # to :: Rep CreateSecurityProfile x -> CreateSecurityProfile #
Read CreateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Methods readsPrec :: Int -> ReadS CreateSecurityProfile # readList :: ReadS [CreateSecurityProfile] # readPrec :: ReadPrec CreateSecurityProfile # readListPrec :: ReadPrec [CreateSecurityProfile] #
Show CreateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Methods showsPrec :: Int -> CreateSecurityProfile -> ShowS # show :: CreateSecurityProfile -> String # showList :: [CreateSecurityProfile] -> ShowS #
NFData CreateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Methods rnf :: CreateSecurityProfile -> () #
Eq CreateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Methods (==) :: CreateSecurityProfile -> CreateSecurityProfile -> Bool # (/=) :: CreateSecurityProfile -> CreateSecurityProfile -> Bool #
Hashable CreateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Methods hashWithSalt :: Int -> CreateSecurityProfile -> Int # hash :: CreateSecurityProfile -> Int #
type AWSResponse CreateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile type AWSResponse CreateSecurityProfile = CreateSecurityProfileResponse
type Rep CreateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile type Rep CreateSecurityProfile = D1 ('MetaData "CreateSecurityProfile" "Amazonka.IoT.CreateSecurityProfile" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateSecurityProfile'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "additionalMetricsToRetain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "additionalMetricsToRetainV2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricToRetain])) :: S1 ('MetaSel ('Just "alertTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap AlertTargetType AlertTarget))))) :: ((S1 ('MetaSel ('Just "behaviors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Behavior])) :: S1 ('MetaSel ('Just "securityProfileDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "securityProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateSecurityProfile Source #

Arguments

:: Text	`CreateSecurityProfile`
-> CreateSecurityProfile

Create a value of CreateSecurityProfile 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:CreateSecurityProfile', createSecurityProfile_additionalMetricsToRetain - /Please use CreateSecurityProfileRequest$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. Can be used with custom metrics; cannot be used with dimensions.

$sel:additionalMetricsToRetainV2:CreateSecurityProfile', createSecurityProfile_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. Can be used with custom metrics; cannot be used with dimensions.

$sel:alertTargets:CreateSecurityProfile', createSecurityProfile_alertTargets - Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

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

$sel:securityProfileDescription:CreateSecurityProfile', createSecurityProfile_securityProfileDescription - A description of the security profile.

$sel:tags:CreateSecurityProfile', createSecurityProfile_tags - Metadata that can be used to manage the security profile.

CreateSecurityProfile, createSecurityProfile_securityProfileName - The name you are giving to the security profile.

Request Lenses

createSecurityProfile_additionalMetricsToRetain :: Lens' CreateSecurityProfile (Maybe [Text]) Source #

/Please use CreateSecurityProfileRequest$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. Can be used with custom metrics; cannot be used with dimensions.

createSecurityProfile_additionalMetricsToRetainV2 :: Lens' CreateSecurityProfile (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. Can be used with custom metrics; cannot be used with dimensions.

createSecurityProfile_alertTargets :: Lens' CreateSecurityProfile (Maybe (HashMap AlertTargetType AlertTarget)) Source #

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

createSecurityProfile_behaviors :: Lens' CreateSecurityProfile (Maybe [Behavior]) Source #

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

createSecurityProfile_securityProfileDescription :: Lens' CreateSecurityProfile (Maybe Text) Source #

A description of the security profile.

createSecurityProfile_tags :: Lens' CreateSecurityProfile (Maybe [Tag]) Source #

Metadata that can be used to manage the security profile.

createSecurityProfile_securityProfileName :: Lens' CreateSecurityProfile Text Source #

The name you are giving to the security profile.

Destructuring the Response

data CreateSecurityProfileResponse Source #

See: newCreateSecurityProfileResponse smart constructor.

Constructors

CreateSecurityProfileResponse'
Fields securityProfileArn :: Maybe Text The ARN of the security profile. securityProfileName :: Maybe Text The name you gave to the security profile. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Associated Types type Rep CreateSecurityProfileResponse :: Type -> Type # Methods from :: CreateSecurityProfileResponse -> Rep CreateSecurityProfileResponse x # to :: Rep CreateSecurityProfileResponse x -> CreateSecurityProfileResponse #
Read CreateSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Methods readsPrec :: Int -> ReadS CreateSecurityProfileResponse # readList :: ReadS [CreateSecurityProfileResponse] # readPrec :: ReadPrec CreateSecurityProfileResponse # readListPrec :: ReadPrec [CreateSecurityProfileResponse] #
Show CreateSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Methods showsPrec :: Int -> CreateSecurityProfileResponse -> ShowS # show :: CreateSecurityProfileResponse -> String # showList :: [CreateSecurityProfileResponse] -> ShowS #
NFData CreateSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Methods rnf :: CreateSecurityProfileResponse -> () #
Eq CreateSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile Methods (==) :: CreateSecurityProfileResponse -> CreateSecurityProfileResponse -> Bool # (/=) :: CreateSecurityProfileResponse -> CreateSecurityProfileResponse -> Bool #
type Rep CreateSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.CreateSecurityProfile type Rep CreateSecurityProfileResponse = D1 ('MetaData "CreateSecurityProfileResponse" "Amazonka.IoT.CreateSecurityProfile" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateSecurityProfileResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "securityProfileArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "securityProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateSecurityProfileResponse Source #

Arguments

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

Create a value of CreateSecurityProfileResponse 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:securityProfileArn:CreateSecurityProfileResponse', createSecurityProfileResponse_securityProfileArn - The ARN of the security profile.

CreateSecurityProfile, createSecurityProfileResponse_securityProfileName - The name you gave to the security profile.

$sel:httpStatus:CreateSecurityProfileResponse', createSecurityProfileResponse_httpStatus - The response's http status code.

Response Lenses

createSecurityProfileResponse_securityProfileArn :: Lens' CreateSecurityProfileResponse (Maybe Text) Source #

The ARN of the security profile.

createSecurityProfileResponse_securityProfileName :: Lens' CreateSecurityProfileResponse (Maybe Text) Source #

The name you gave to the security profile.

createSecurityProfileResponse_httpStatus :: Lens' CreateSecurityProfileResponse Int Source #

The response's http status code.