Struct aws_sdk_iot::operation::describe_security_profile::DescribeSecurityProfileOutput

#[non_exhaustive]
pub struct DescribeSecurityProfileOutput {
    pub security_profile_name: Option<String>,
    pub security_profile_arn: Option<String>,
    pub security_profile_description: Option<String>,
    pub behaviors: Option<Vec<Behavior>>,
    pub alert_targets: Option<HashMap<AlertTargetType, AlertTarget>>,
    pub additional_metrics_to_retain: Option<Vec<String>>,
    pub additional_metrics_to_retain_v2: Option<Vec<MetricToRetain>>,
    pub version: i64,
    pub creation_date: Option<DateTime>,
    pub last_modified_date: Option<DateTime>,
    pub metrics_export_config: Option<MetricsExportConfig>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

security_profile_name: Option<String>

The name of the security profile.

security_profile_arn: Option<String>

The ARN of the security profile.

security_profile_description: Option<String>

A description of the security profile (associated with the security profile when it was created or updated).

behaviors: Option<Vec<Behavior>>

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

alert_targets: Option<HashMap<AlertTargetType, AlertTarget>>

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

additional_metrics_to_retain: Option<Vec<String>>

👎Deprecated: Use additionalMetricsToRetainV2.

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

additional_metrics_to_retain_v2: Option<Vec<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.

version: i64

The version of the security profile. A new version is generated whenever the security profile is updated.

creation_date: Option<DateTime>

The time the security profile was created.

last_modified_date: Option<DateTime>

The time the security profile was last modified.

metrics_export_config: Option<MetricsExportConfig>

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

Implementations

impl DescribeSecurityProfileOutput

pub fn security_profile_name(&self) -> Option<&str>

The name of the security profile.

pub fn security_profile_arn(&self) -> Option<&str>

The ARN of the security profile.

pub fn security_profile_description(&self) -> Option<&str>

A description of the security profile (associated with the security profile when it was created or updated).

pub fn behaviors(&self) -> &[Behavior]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .behaviors.is_none().

pub fn alert_targets(&self) -> Option<&HashMap<AlertTargetType, AlertTarget>>

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

pub fn additional_metrics_to_retain(&self) -> &[String]

👎Deprecated: Use additionalMetricsToRetainV2.

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_metrics_to_retain.is_none().

pub fn additional_metrics_to_retain_v2(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_metrics_to_retain_v2.is_none().

pub fn version(&self) -> i64

The version of the security profile. A new version is generated whenever the security profile is updated.

pub fn creation_date(&self) -> Option<&DateTime>

The time the security profile was created.

pub fn last_modified_date(&self) -> Option<&DateTime>

The time the security profile was last modified.

pub fn metrics_export_config(&self) -> Option<&MetricsExportConfig>

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

impl DescribeSecurityProfileOutput

pub fn builder() -> DescribeSecurityProfileOutputBuilder

Creates a new builder-style object to manufacture DescribeSecurityProfileOutput.

Trait Implementations

impl Clone for DescribeSecurityProfileOutput

fn clone(&self) -> DescribeSecurityProfileOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeSecurityProfileOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeSecurityProfileOutput

fn eq(&self, other: &DescribeSecurityProfileOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeSecurityProfileOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for DescribeSecurityProfileOutput