Skip to content

UpdateSecurityProfileResponse

Source code in docs_src/capo_iot/types/update_security_profile_response.py
class UpdateSecurityProfileResponse(TypedDict, closed=True):
    security_profile_name: NotRequired[
        "capo_iot.types.security_profile_name.SecurityProfileName"
    ]
    """<p>The name of the security profile that was updated.</p>"""
    security_profile_arn: NotRequired[
        "capo_iot.types.security_profile_arn.SecurityProfileArn"
    ]
    """<p>The ARN of the security profile that was updated.</p>"""
    security_profile_description: NotRequired[
        "capo_iot.types.security_profile_description.SecurityProfileDescription"
    ]
    """<p>The description of the security profile.</p>"""
    behaviors: NotRequired["capo_iot.types.behaviors.Behaviors"]
    """<p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>"""
    alert_targets: NotRequired["capo_iot.types.alert_targets.AlertTargets"]
    """<p>Where the alerts are sent. (Alerts are always sent to the console.)</p>"""
    additional_metrics_to_retain: NotRequired[
        "capo_iot.types.additional_metrics_to_retain_list.AdditionalMetricsToRetainList"
    ]
    """<p> <i>Please use <a>UpdateSecurityProfileResponse$additionalMetricsToRetainV2</a> instead.</i> </p> <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p>"""
    additional_metrics_to_retain_v2: NotRequired[
        "capo_iot.types.additional_metrics_to_retain_v2_list.AdditionalMetricsToRetainV2List"
    ]
    """<p>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.</p>"""
    version: "capo_iot.types.version.Version"
    """<p>The updated version of the security profile.</p>"""
    creation_date: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p>The time the security profile was created.</p>"""
    last_modified_date: NotRequired["capo_iot.types.timestamp.Timestamp"]
    """<p>The time the security profile was last modified.</p>"""
    metrics_export_config: NotRequired[
        "capo_iot.types.metrics_export_config.MetricsExportConfig"
    ]
    """<p>Specifies the MQTT topic and role ARN required for metric export.</p>"""

additional_metrics_to_retain instance-attribute

additional_metrics_to_retain: NotRequired[AdditionalMetricsToRetainList]

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.

additional_metrics_to_retain_v2 instance-attribute

additional_metrics_to_retain_v2: NotRequired[AdditionalMetricsToRetainV2List]

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.

alert_targets instance-attribute

alert_targets: NotRequired[AlertTargets]

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

behaviors instance-attribute

behaviors: NotRequired[Behaviors]

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

creation_date instance-attribute

creation_date: NotRequired[Timestamp]

The time the security profile was created.

last_modified_date instance-attribute

last_modified_date: NotRequired[Timestamp]

The time the security profile was last modified.

metrics_export_config instance-attribute

metrics_export_config: NotRequired[MetricsExportConfig]

Specifies the MQTT topic and role ARN required for metric export.

security_profile_arn instance-attribute

security_profile_arn: NotRequired[SecurityProfileArn]

The ARN of the security profile that was updated.

security_profile_description instance-attribute

security_profile_description: NotRequired[SecurityProfileDescription]

The description of the security profile.

security_profile_name instance-attribute

security_profile_name: NotRequired[SecurityProfileName]

The name of the security profile that was updated.

version instance-attribute

version: Version

The updated version of the security profile.