Amazon IoT Device Defender Behavior Model Training API
The Behavior Model Training API from Amazon IoT Device Defender — 1 operation(s) for behavior model training.
The Behavior Model Training API from Amazon IoT Device Defender — 1 operation(s) for behavior model training.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-iot-device-defender-behavior-model-training-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 2015-05-28
x-release: v4
title: AWS IoT Behavior Model Training API
description: 'IoT
IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud.'
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: iot
x-aws-signingName: iot
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iot-2015-05-28.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://iot.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS IoT multi-region endpoint
- url: https://iot.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS IoT multi-region endpoint
- url: http://iot.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS IoT endpoint for China (Beijing) and China (Ningxia)
- url: https://iot.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS IoT endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Behavior Model Training
paths:
/behavior-model-training/summaries:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: GetBehaviorModelTrainingSummaries
description: 'Returns a Device Defender''s ML Detect Security Profile training model''s status.
Requires permission to access the GetBehaviorModelTrainingSummaries action.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetBehaviorModelTrainingSummariesResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'482':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters:
- name: securityProfileName
in: query
required: false
description: ' The name of the security profile. '
schema:
type: string
pattern: '[a-zA-Z0-9:_-]+'
minLength: 1
maxLength: 128
- name: maxResults
in: query
required: false
description: ' The maximum number of results to return at one time. The default is 10. '
schema:
type: integer
minimum: 1
maximum: 10
- name: nextToken
in: query
required: false
description: ' The token for the next set of results. '
schema:
type: string
summary: Amazon IoT Device Defender Get Behavior Model Training Summaries
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Behavior Model Training
components:
schemas:
BehaviorName:
type: string
pattern: '[a-zA-Z0-9:_-]+'
minLength: 1
maxLength: 128
ThrottlingException: {}
BehaviorModelTrainingSummaries:
type: array
items:
$ref: '#/components/schemas/BehaviorModelTrainingSummary'
DataCollectionPercentage:
type: number
format: double
minimum: 0
maximum: 100
BehaviorModelTrainingSummary:
type: object
properties:
securityProfileName:
allOf:
- $ref: '#/components/schemas/SecurityProfileName'
- description: ' The name of the security profile. '
behaviorName:
allOf:
- $ref: '#/components/schemas/BehaviorName'
- description: ' The name of the behavior. '
trainingDataCollectionStartDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: ' The date a training model started collecting data. '
modelStatus:
allOf:
- $ref: '#/components/schemas/ModelStatus'
- description: ' The status of the behavior model. '
datapointsCollectionPercentage:
allOf:
- $ref: '#/components/schemas/DataCollectionPercentage'
- description: ' The percentage of datapoints collected. '
lastModelRefreshDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: ' The date the model was last refreshed. '
description: ' The summary of an ML Detect behavior model. '
ModelStatus:
type: string
enum:
- PENDING_BUILD
- ACTIVE
- EXPIRED
InvalidRequestException: {}
ResourceNotFoundException: {}
GetBehaviorModelTrainingSummariesResponse:
type: object
properties:
summaries:
allOf:
- $ref: '#/components/schemas/BehaviorModelTrainingSummaries'
- description: ' A list of all ML Detect behaviors and their model status for a given Security Profile. '
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: ' A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results. '
SecurityProfileName:
type: string
pattern: '[a-zA-Z0-9:_-]+'
minLength: 1
maxLength: 128
NextToken:
type: string
Timestamp:
type: string
format: date-time
InternalFailureException: {}
parameters:
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/iot/
x-hasEquivalentPaths: true