UpdateSecurityProfileRequest

import type { UpdateSecurityProfileRequest } from "https://aws-api.deno.dev/v0.3/services/iot.ts?docs=full";

interface UpdateSecurityProfileRequest {

additionalMetricsToRetain?: string[] | null;

additionalMetricsToRetainV2?: MetricToRetain[] | null;

alertTargets?: [key in AlertTargetType]: AlertTarget | null | undefined | null;

behaviors?: Behavior[] | null;

deleteAdditionalMetricsToRetain?: boolean | null;

deleteAlertTargets?: boolean | null;

deleteBehaviors?: boolean | null;

expectedVersion?: number | null;

securityProfileDescription?: string | null;

securityProfileName: string;

}

§Properties

additionalMetricsToRetain?: string[] | null

[src]

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?: MetricToRetain[] | null

[src]

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?: [key in AlertTargetType]: AlertTarget | null | undefined | null

[src]

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

behaviors?: Behavior[] | null

[src]

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

deleteAdditionalMetricsToRetain?: boolean | null

[src]

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

deleteAlertTargets?: boolean | null

[src]

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

deleteBehaviors?: boolean | null

[src]

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

expectedVersion?: number | null

[src]

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?: string | null

[src]

A description of the security profile.

securityProfileName: string

[src]

The name of the security profile you want to update.