aws_sdk_iot/client/
describe_security_profile.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeSecurityProfile`](crate::operation::describe_security_profile::builders::DescribeSecurityProfileFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`security_profile_name(impl Into<String>)`](crate::operation::describe_security_profile::builders::DescribeSecurityProfileFluentBuilder::security_profile_name) / [`set_security_profile_name(Option<String>)`](crate::operation::describe_security_profile::builders::DescribeSecurityProfileFluentBuilder::set_security_profile_name):<br>required: **true**<br><p>The name of the security profile whose information you want to get.</p><br>
7    /// - On success, responds with [`DescribeSecurityProfileOutput`](crate::operation::describe_security_profile::DescribeSecurityProfileOutput) with field(s):
8    ///   - [`security_profile_name(Option<String>)`](crate::operation::describe_security_profile::DescribeSecurityProfileOutput::security_profile_name): <p>The name of the security profile.</p>
9    ///   - [`security_profile_arn(Option<String>)`](crate::operation::describe_security_profile::DescribeSecurityProfileOutput::security_profile_arn): <p>The ARN of the security profile.</p>
10    ///   - [`security_profile_description(Option<String>)`](crate::operation::describe_security_profile::DescribeSecurityProfileOutput::security_profile_description): <p>A description of the security profile (associated with the security profile when it was created or updated).</p>
11    ///   - [`behaviors(Option<Vec::<Behavior>>)`](crate::operation::describe_security_profile::DescribeSecurityProfileOutput::behaviors): <p>Specifies the behaviors that, when violated by a device (thing), cause an alert.</p>
12    ///   - [`alert_targets(Option<HashMap::<AlertTargetType, AlertTarget>>)`](crate::operation::describe_security_profile::DescribeSecurityProfileOutput::alert_targets): <p>Where the alerts are sent. (Alerts are always sent to the console.)</p>
13    ///   - [`additional_metrics_to_retain(Option<Vec::<String>>)`](crate::operation::describe_security_profile::DescribeSecurityProfileOutput::additional_metrics_to_retain): <p><i>Please use <code>DescribeSecurityProfileResponse$additionalMetricsToRetainV2</code> instead.</i></p> <p>A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's <code>behaviors</code>, but it is also retained for any metric specified here.</p>
14    ///   - [`additional_metrics_to_retain_v2(Option<Vec::<MetricToRetain>>)`](crate::operation::describe_security_profile::DescribeSecurityProfileOutput::additional_metrics_to_retain_v2): <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.</p>
15    ///   - [`version(i64)`](crate::operation::describe_security_profile::DescribeSecurityProfileOutput::version): <p>The version of the security profile. A new version is generated whenever the security profile is updated.</p>
16    ///   - [`creation_date(Option<DateTime>)`](crate::operation::describe_security_profile::DescribeSecurityProfileOutput::creation_date): <p>The time the security profile was created.</p>
17    ///   - [`last_modified_date(Option<DateTime>)`](crate::operation::describe_security_profile::DescribeSecurityProfileOutput::last_modified_date): <p>The time the security profile was last modified.</p>
18    ///   - [`metrics_export_config(Option<MetricsExportConfig>)`](crate::operation::describe_security_profile::DescribeSecurityProfileOutput::metrics_export_config): <p>Specifies the MQTT topic and role ARN required for metric export.</p>
19    /// - On failure, responds with [`SdkError<DescribeSecurityProfileError>`](crate::operation::describe_security_profile::DescribeSecurityProfileError)
20    pub fn describe_security_profile(&self) -> crate::operation::describe_security_profile::builders::DescribeSecurityProfileFluentBuilder {
21        crate::operation::describe_security_profile::builders::DescribeSecurityProfileFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_iot/client/describe_security_profile.rs

aws_sdk_iot/client/
describe_security_profile.rs
