AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the DescribeSecurityProfile operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.IoT.Model.DescribeSecurityProfileResponse

Namespace: Amazon.IoT.Model
Assembly: AWSSDK.IoT.dll
Version: 3.x.y.z

Syntax

C# 
public class DescribeSecurityProfileResponse : AmazonWebServiceResponse

The DescribeSecurityProfileResponse type exposes the following members

Constructors

NameDescription
Public Method DescribeSecurityProfileResponse()

Properties

NameTypeDescription
Public Property AdditionalMetricsToRetain System.Collections.Generic.List<System.String>

Gets and sets the property AdditionalMetricsToRetain.

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.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property AdditionalMetricsToRetainV2 System.Collections.Generic.List<Amazon.IoT.Model.MetricToRetain>

Gets and sets the property 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.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property AlertTargets System.Collections.Generic.Dictionary<System.String, Amazon.IoT.Model.AlertTarget>

Gets and sets the property AlertTargets.

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

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property Behaviors System.Collections.Generic.List<Amazon.IoT.Model.Behavior>

Gets and sets the property Behaviors.

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

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CreationDate System.Nullable<System.DateTime>

Gets and sets the property CreationDate.

The time the security profile was created.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property LastModifiedDate System.Nullable<System.DateTime>

Gets and sets the property LastModifiedDate.

The time the security profile was last modified.

Public Property MetricsExportConfig Amazon.IoT.Model.MetricsExportConfig

Gets and sets the property MetricsExportConfig.

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

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property SecurityProfileArn System.String

Gets and sets the property SecurityProfileArn.

The ARN of the security profile.

Public Property SecurityProfileDescription System.String

Gets and sets the property SecurityProfileDescription.

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

Public Property SecurityProfileName System.String

Gets and sets the property SecurityProfileName.

The name of the security profile.

Public Property Version System.Nullable<System.Int64>

Gets and sets the property Version.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer