security_profiles_list_only
Lists security_profiles
in a region or regions, for all properties use security_profiles
Overview
Name | security_profiles_list_only |
Type | Resource |
Description | A security profile defines a set of expected behaviors for devices in your account. |
Id | aws.iot.security_profiles_list_only |
Fields
Name | Datatype | Description |
---|---|---|
security_profile_name | string | A unique identifier for the security profile. |
security_profile_description | string | A description of the security profile. |
behaviors | array | Specifies the behaviors that, when violated by a device (thing), cause an alert. |
alert_targets | object | Specifies the destinations to which alerts are sent. |
additional_metrics_to_retain_v2 | array | 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. |
metrics_export_config | object | A structure containing the mqtt topic for metrics export. |
tags | array | Metadata that can be used to manage the security profile. |
target_arns | array | A set of target ARNs that the security profile is attached to. |
security_profile_arn | string | The ARN (Amazon resource name) of the created security profile. |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
SELECT
examples
Lists all security_profiles
in a region.
SELECT
region,
security_profile_name
FROM aws.iot.security_profiles_list_only
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the security_profiles_list_only
resource, see security_profiles