Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . iot ]

update-security-profile

Description

Updates a Device Defender security profile.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-security-profile
--security-profile-name <value>
[--security-profile-description <value>]
[--behaviors <value>]
[--alert-targets <value>]
[--expected-version <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--security-profile-name (string)

The name of the security profile you want to update.

--security-profile-description (string)

A description of the security profile.

--behaviors (list)

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

JSON Syntax:

[
  {
    "name": "string",
    "metric": "string",
    "criteria": {
      "comparisonOperator": "less-than"|"less-than-equals"|"greater-than"|"greater-than-equals"|"in-cidr-set"|"not-in-cidr-set"|"in-port-set"|"not-in-port-set",
      "value": {
        "count": long,
        "cidrs": ["string", ...],
        "ports": [integer, ...]
      },
      "durationSeconds": integer
    }
  }
  ...
]

--alert-targets (map)

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

Shorthand Syntax:

  KeyName1=alertTargetArn=string,roleArn=string,KeyName2=alertTargetArn=string,roleArn=string

Where valid key names are:
  SNS

JSON Syntax:

{"SNS": {
      "alertTargetArn": "string",
      "roleArn": "string"
    }
  ...}

--expected-version (long)

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different than the actual version, a VersionConflictException is thrown.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

securityProfileName -> (string)

The name of the security profile that was updated.

securityProfileArn -> (string)

The ARN of the security profile that was updated.

securityProfileDescription -> (string)

The description of the security profile.

behaviors -> (list)

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

(structure)

A Device Defender security profile behavior.

name -> (string)

The name you have given to the behavior.

metric -> (string)

What is measured by the behavior.

criteria -> (structure)

The criteria that determine if a device is behaving normally in regard to the metric .

comparisonOperator -> (string)

The operator that relates the thing measured (metric ) to the criteria (value ).

value -> (structure)

The value to be compared with the metric .

count -> (long)

If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric .

cidrs -> (list)

If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric .

(string)

ports -> (list)

If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric .

(integer)

durationSeconds -> (integer)

Use this to specify the period of time over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT ).

alertTargets -> (map)

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

key -> (string)

The type of alert target: one of "SNS".

value -> (structure)

A structure containing the alert target ARN and the role ARN.

alertTargetArn -> (string)

The ARN of the notification target to which alerts are sent.

roleArn -> (string)

The ARN of the role that grants permission to send alerts to the notification target.

version -> (long)

The updated version of the security profile.

creationDate -> (timestamp)

The time the security profile was created.

lastModifiedDate -> (timestamp)

The time the security profile was last modified.