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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a Device Defender security profile.

Requires permission to access the UpdateSecurityProfile action.

Synopsis

Creating a Request

data UpdateSecurityProfile Source #

See: newUpdateSecurityProfile smart constructor.

Constructors

UpdateSecurityProfile'

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. Can be used with custom metrics; cannot be used with dimensions.
behaviors :: Maybe [Behavior]
Specifies the behaviors that, when violated by a device (thing), cause an alert.
expectedVersion :: Maybe Integer
The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.
deleteAlertTargets :: Maybe Bool
If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
additionalMetricsToRetain :: Maybe [Text]
/Please use UpdateSecurityProfileRequest$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.
securityProfileDescription :: Maybe Text
A description of the security profile.
deleteBehaviors :: Maybe Bool
If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
deleteAdditionalMetricsToRetain :: Maybe Bool
If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
securityProfileName :: Text
The name of the security profile you want to update.

Instances

Instances details

Eq UpdateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Methods (==) :: UpdateSecurityProfile -> UpdateSecurityProfile -> Bool # (/=) :: UpdateSecurityProfile -> UpdateSecurityProfile -> Bool #
Read UpdateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Methods readsPrec :: Int -> ReadS UpdateSecurityProfile # readList :: ReadS [UpdateSecurityProfile] # readPrec :: ReadPrec UpdateSecurityProfile # readListPrec :: ReadPrec [UpdateSecurityProfile] #
Show UpdateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Methods showsPrec :: Int -> UpdateSecurityProfile -> ShowS # show :: UpdateSecurityProfile -> String # showList :: [UpdateSecurityProfile] -> ShowS #
Generic UpdateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Associated Types type Rep UpdateSecurityProfile :: Type -> Type # Methods from :: UpdateSecurityProfile -> Rep UpdateSecurityProfile x # to :: Rep UpdateSecurityProfile x -> UpdateSecurityProfile #
NFData UpdateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Methods rnf :: UpdateSecurityProfile -> () #
Hashable UpdateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Methods hashWithSalt :: Int -> UpdateSecurityProfile -> Int # hash :: UpdateSecurityProfile -> Int #
ToJSON UpdateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Methods toJSON :: UpdateSecurityProfile -> Value # toEncoding :: UpdateSecurityProfile -> Encoding # toJSONList :: [UpdateSecurityProfile] -> Value # toEncodingList :: [UpdateSecurityProfile] -> Encoding #
AWSRequest UpdateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Associated Types type AWSResponse UpdateSecurityProfile # Methods request :: UpdateSecurityProfile -> Request UpdateSecurityProfile # response :: MonadResource m => Logger -> Service -> Proxy UpdateSecurityProfile -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateSecurityProfile))) #
ToHeaders UpdateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Methods toHeaders :: UpdateSecurityProfile -> [Header] #
ToPath UpdateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Methods toPath :: UpdateSecurityProfile -> ByteString #
ToQuery UpdateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Methods toQuery :: UpdateSecurityProfile -> QueryString #
type Rep UpdateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile type Rep UpdateSecurityProfile = D1 ('MetaData "UpdateSecurityProfile" "Amazonka.IoT.UpdateSecurityProfile" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "UpdateSecurityProfile'" '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 "expectedVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "deleteAlertTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "additionalMetricsToRetain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "securityProfileDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "deleteBehaviors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "deleteAdditionalMetricsToRetain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "securityProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse UpdateSecurityProfile Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile type AWSResponse UpdateSecurityProfile = UpdateSecurityProfileResponse

newUpdateSecurityProfile Source #

Arguments

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

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

$sel:additionalMetricsToRetainV2:UpdateSecurityProfile', updateSecurityProfile_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:behaviors:UpdateSecurityProfile', updateSecurityProfile_behaviors - Specifies the behaviors that, when violated by a device (thing), cause an alert.

$sel:expectedVersion:UpdateSecurityProfile', updateSecurityProfile_expectedVersion - The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

$sel:deleteAlertTargets:UpdateSecurityProfile', updateSecurityProfile_deleteAlertTargets - If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

$sel:additionalMetricsToRetain:UpdateSecurityProfile', updateSecurityProfile_additionalMetricsToRetain - /Please use UpdateSecurityProfileRequest$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:securityProfileDescription:UpdateSecurityProfile', updateSecurityProfile_securityProfileDescription - A description of the security profile.

$sel:deleteBehaviors:UpdateSecurityProfile', updateSecurityProfile_deleteBehaviors - If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

$sel:deleteAdditionalMetricsToRetain:UpdateSecurityProfile', updateSecurityProfile_deleteAdditionalMetricsToRetain - If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

$sel:securityProfileName:UpdateSecurityProfile', updateSecurityProfile_securityProfileName - The name of the security profile you want to update.

Request Lenses

updateSecurityProfile_alertTargets :: Lens' UpdateSecurityProfile (Maybe (HashMap AlertTargetType AlertTarget)) Source #

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

updateSecurityProfile_additionalMetricsToRetainV2 :: Lens' UpdateSecurityProfile (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.

updateSecurityProfile_behaviors :: Lens' UpdateSecurityProfile (Maybe [Behavior]) Source #

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

updateSecurityProfile_expectedVersion :: Lens' UpdateSecurityProfile (Maybe Integer) Source #

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

updateSecurityProfile_deleteAlertTargets :: Lens' UpdateSecurityProfile (Maybe Bool) Source #

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

updateSecurityProfile_additionalMetricsToRetain :: Lens' UpdateSecurityProfile (Maybe [Text]) Source #

/Please use UpdateSecurityProfileRequest$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.

updateSecurityProfile_securityProfileDescription :: Lens' UpdateSecurityProfile (Maybe Text) Source #

A description of the security profile.

updateSecurityProfile_deleteBehaviors :: Lens' UpdateSecurityProfile (Maybe Bool) Source #

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

updateSecurityProfile_deleteAdditionalMetricsToRetain :: Lens' UpdateSecurityProfile (Maybe Bool) Source #

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

updateSecurityProfile_securityProfileName :: Lens' UpdateSecurityProfile Text Source #

The name of the security profile you want to update.

Destructuring the Response

data UpdateSecurityProfileResponse Source #

See: newUpdateSecurityProfileResponse smart constructor.

Constructors

UpdateSecurityProfileResponse'

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. Can be used with custom metrics; cannot be used with dimensions.
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 updated version of the security profile.
securityProfileName :: Maybe Text
The name of the security profile that was updated.
creationDate :: Maybe POSIX
The time the security profile was created.
additionalMetricsToRetain :: Maybe [Text]
/Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead./
A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors, but it is also retained for any metric specified here.
securityProfileArn :: Maybe Text
The ARN of the security profile that was updated.
securityProfileDescription :: Maybe Text
The description of the security profile.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq UpdateSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Methods (==) :: UpdateSecurityProfileResponse -> UpdateSecurityProfileResponse -> Bool # (/=) :: UpdateSecurityProfileResponse -> UpdateSecurityProfileResponse -> Bool #
Read UpdateSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Methods readsPrec :: Int -> ReadS UpdateSecurityProfileResponse # readList :: ReadS [UpdateSecurityProfileResponse] # readPrec :: ReadPrec UpdateSecurityProfileResponse # readListPrec :: ReadPrec [UpdateSecurityProfileResponse] #
Show UpdateSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Methods showsPrec :: Int -> UpdateSecurityProfileResponse -> ShowS # show :: UpdateSecurityProfileResponse -> String # showList :: [UpdateSecurityProfileResponse] -> ShowS #
Generic UpdateSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Associated Types type Rep UpdateSecurityProfileResponse :: Type -> Type # Methods from :: UpdateSecurityProfileResponse -> Rep UpdateSecurityProfileResponse x # to :: Rep UpdateSecurityProfileResponse x -> UpdateSecurityProfileResponse #
NFData UpdateSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile Methods rnf :: UpdateSecurityProfileResponse -> () #
type Rep UpdateSecurityProfileResponse Source #
Instance details Defined in Amazonka.IoT.UpdateSecurityProfile type Rep UpdateSecurityProfileResponse = D1 ('MetaData "UpdateSecurityProfileResponse" "Amazonka.IoT.UpdateSecurityProfile" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "UpdateSecurityProfileResponse'" '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))))))

newUpdateSecurityProfileResponse Source #

Arguments

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

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

$sel:additionalMetricsToRetainV2:UpdateSecurityProfile', updateSecurityProfileResponse_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:behaviors:UpdateSecurityProfile', updateSecurityProfileResponse_behaviors - Specifies the behaviors that, when violated by a device (thing), cause an alert.

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

$sel:version:UpdateSecurityProfileResponse', updateSecurityProfileResponse_version - The updated version of the security profile.

$sel:securityProfileName:UpdateSecurityProfile', updateSecurityProfileResponse_securityProfileName - The name of the security profile that was updated.

$sel:creationDate:UpdateSecurityProfileResponse', updateSecurityProfileResponse_creationDate - The time the security profile was created.

$sel:additionalMetricsToRetain:UpdateSecurityProfile', updateSecurityProfileResponse_additionalMetricsToRetain - /Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead./

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

$sel:securityProfileArn:UpdateSecurityProfileResponse', updateSecurityProfileResponse_securityProfileArn - The ARN of the security profile that was updated.

$sel:securityProfileDescription:UpdateSecurityProfile', updateSecurityProfileResponse_securityProfileDescription - The description of the security profile.

$sel:httpStatus:UpdateSecurityProfileResponse', updateSecurityProfileResponse_httpStatus - The response's http status code.

Response Lenses

updateSecurityProfileResponse_alertTargets :: Lens' UpdateSecurityProfileResponse (Maybe (HashMap AlertTargetType AlertTarget)) Source #

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

updateSecurityProfileResponse_additionalMetricsToRetainV2 :: Lens' UpdateSecurityProfileResponse (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.

updateSecurityProfileResponse_behaviors :: Lens' UpdateSecurityProfileResponse (Maybe [Behavior]) Source #

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

updateSecurityProfileResponse_lastModifiedDate :: Lens' UpdateSecurityProfileResponse (Maybe UTCTime) Source #

The time the security profile was last modified.

updateSecurityProfileResponse_version :: Lens' UpdateSecurityProfileResponse (Maybe Integer) Source #

The updated version of the security profile.

updateSecurityProfileResponse_securityProfileName :: Lens' UpdateSecurityProfileResponse (Maybe Text) Source #

The name of the security profile that was updated.

updateSecurityProfileResponse_creationDate :: Lens' UpdateSecurityProfileResponse (Maybe UTCTime) Source #

The time the security profile was created.

updateSecurityProfileResponse_additionalMetricsToRetain :: Lens' UpdateSecurityProfileResponse (Maybe [Text]) Source #

/Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead./

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

updateSecurityProfileResponse_securityProfileArn :: Lens' UpdateSecurityProfileResponse (Maybe Text) Source #

The ARN of the security profile that was updated.

updateSecurityProfileResponse_securityProfileDescription :: Lens' UpdateSecurityProfileResponse (Maybe Text) Source #

The description of the security profile.

updateSecurityProfileResponse_httpStatus :: Lens' UpdateSecurityProfileResponse Int Source #

The response's http status code.