amazonka-iot-2.0: Amazon IoT SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoT.UpdateSecurityProfile

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

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

  • 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)

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

  • behaviors :: Maybe [Behavior]

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

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

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

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

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

  • securityProfileDescription :: Maybe Text

    A description of the security profile.

  • securityProfileName :: Text

    The name of the security profile you want to update.

Instances

Instances details
ToJSON UpdateSecurityProfile Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

ToHeaders UpdateSecurityProfile Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

ToPath UpdateSecurityProfile Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

ToQuery UpdateSecurityProfile Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

AWSRequest UpdateSecurityProfile Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

Associated Types

type AWSResponse UpdateSecurityProfile #

Generic UpdateSecurityProfile Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

Associated Types

type Rep UpdateSecurityProfile :: Type -> Type #

Read UpdateSecurityProfile Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

Show UpdateSecurityProfile Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

NFData UpdateSecurityProfile Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

Methods

rnf :: UpdateSecurityProfile -> () #

Eq UpdateSecurityProfile Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

Hashable UpdateSecurityProfile Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

type AWSResponse UpdateSecurityProfile Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

type Rep UpdateSecurityProfile Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

type Rep UpdateSecurityProfile = D1 ('MetaData "UpdateSecurityProfile" "Amazonka.IoT.UpdateSecurityProfile" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "UpdateSecurityProfile'" '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 "deleteAdditionalMetricsToRetain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "deleteAlertTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "deleteBehaviors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "expectedVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "securityProfileDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "securityProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateSecurityProfile Source #

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:

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.

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.

UpdateSecurityProfile, updateSecurityProfile_alertTargets - Where the alerts are sent. (Alerts are always sent to the console.)

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

$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: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: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: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.

UpdateSecurityProfile, updateSecurityProfile_securityProfileDescription - A description of the security profile.

UpdateSecurityProfile, updateSecurityProfile_securityProfileName - The name of the security profile you want to update.

Request Lenses

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_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_alertTargets :: Lens' UpdateSecurityProfile (Maybe (HashMap AlertTargetType AlertTarget)) Source #

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

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

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

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_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_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_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_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

Instances

Instances details
Generic UpdateSecurityProfileResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

Associated Types

type Rep UpdateSecurityProfileResponse :: Type -> Type #

Read UpdateSecurityProfileResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

Show UpdateSecurityProfileResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

NFData UpdateSecurityProfileResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

Eq UpdateSecurityProfileResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

type Rep UpdateSecurityProfileResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateSecurityProfile

type Rep UpdateSecurityProfileResponse = D1 ('MetaData "UpdateSecurityProfileResponse" "Amazonka.IoT.UpdateSecurityProfile" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "UpdateSecurityProfileResponse'" '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 "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "securityProfileArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "securityProfileDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "securityProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newUpdateSecurityProfileResponse Source #

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:

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.

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.

UpdateSecurityProfile, updateSecurityProfileResponse_alertTargets - Where the alerts are sent. (Alerts are always sent to the console.)

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

UpdateSecurityProfileResponse, updateSecurityProfileResponse_creationDate - The time the security profile was created.

UpdateSecurityProfileResponse, updateSecurityProfileResponse_lastModifiedDate - The time the security profile was last modified.

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

UpdateSecurityProfile, updateSecurityProfileResponse_securityProfileDescription - The description of the security profile.

UpdateSecurityProfile, updateSecurityProfileResponse_securityProfileName - The name of the security profile that was updated.

UpdateSecurityProfileResponse, updateSecurityProfileResponse_version - The updated version of the security profile.

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

Response Lenses

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_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_alertTargets :: Lens' UpdateSecurityProfileResponse (Maybe (HashMap AlertTargetType AlertTarget)) Source #

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

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

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