/behavior-model-training/summaries

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

Returns a Device Defender's ML Detect Security Profile training model's status.

Requires permission to access the GetBehaviorModelTrainingSummaries action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/behavior-model-training/summaries'

Response Example

200 - Example 1

{
    "summaries": [],
    "nextToken": "string"
}

Request

Query Params

securityProfileName

string

optional

The name of the security profile.

maxResults

integer

optional

The maximum number of results to return at one time. The default is 25.

nextToken

string

optional

The token for the next set of results.

Responses

🟢200Success

application/json

Body

summaries

array[object (BehaviorModelTrainingSummary) {6}]

optional

A list of all ML Detect behaviors and their model status for a given Security Profile.

securityProfileName

string

optional

The name of the security profile.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9:_-]+

behaviorName

string

optional

The name of the behavior.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9:_-]+

trainingDataCollectionStartDate

string <date-time>

optional

The date a training model started collecting data.

modelStatus

enum<string>

optional

The status of the behavior model.

Allowed values:

PENDING_BUILDACTIVEEXPIRED

datapointsCollectionPercentage

number <double>

optional

The percentage of datapoints collected.

>= 0<= 100

lastModelRefreshDate

string <date-time>

optional

The date the model was last refreshed.

nextToken

string

optional

A token that can be used to retrieve the next set of results, or null if there are no additional results.

<= 4096 characters

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482InternalFailureException

🟠483ResourceNotFoundException

Modified at 2022-09-10 23:12:17

/rules/{ruleName}/enable

/indices/buckets