How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon IoT Core Security Profiles API

The Security Profiles API from Amazon IoT Core — 4 operation(s) for security profiles.

Amazon IoT Core Security Profiles API is one of 70 APIs that Amazon IoT Core publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Security Profiles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 8 operations across 4 paths, and defines 63 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://iot.{region}.amazonaws.com, https://iot.{region}.amazonaws.com, http://iot.{region}.amazonaws.com.cn, https://iot.{region}.amazonaws.com.cn.

8 operations 4 paths 63 schemas 2 DELETE3 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://iot.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon IoT Core Security Profiles API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Security Profiles 8
PUT
/security-profiles/{securityProfileName}/targets#securityProfileTargetArn
Amazon IoT Core Attach Security Profile
AttachSecurityProfile 9 params → 200480481482483484485
DELETE
/security-profiles/{securityProfileName}/targets#securityProfileTargetArn
Amazon IoT Core Detach Security Profile
DetachSecurityProfile 9 params → 200480481482483
POST
/security-profiles/{securityProfileName}
Amazon IoT Core Create Security Profile
CreateSecurityProfile 8 params body → 200480481482483
DELETE
/security-profiles/{securityProfileName}
Amazon IoT Core Delete Security Profile
DeleteSecurityProfile 9 params → 200480481482483
GET
/security-profiles/{securityProfileName}
Amazon IoT Core Describe Security Profile
DescribeSecurityProfile 8 params → 200480481482483
PATCH
/security-profiles/{securityProfileName}
Amazon IoT Core Update Security Profile
UpdateSecurityProfile 9 params body → 200480481482483484
GET
/security-profiles
Amazon IoT Core List Security Profiles
ListSecurityProfiles 11 params → 200480481482483
GET
/security-profiles/{securityProfileName}/targets
Amazon IoT Core List Targets for Security Profile
ListTargetsForSecurityProfile 10 params → 200480481482483

Schemas 63

The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are UpdateSecurityProfileResponse (10 properties), DescribeSecurityProfileResponse (10 properties), BehaviorCriteria (7 properties), MetricValue (6 properties). Each schema is shown below with its type and property counts.

SecurityProfileTarget
object
A target to which an alert is sent when a security profile behavior is violated.
1 property 1 required
SecurityProfileDescription
string
Behaviors
array
NumberList
array
StatisticalThreshold
object
A statistical ranking (percentile) that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
1 property
MetricValue
object
The value to be compared with the metric .
6 properties
Cidr
string
DurationSeconds
integer
ThrottlingException
CreateSecurityProfileResponse
object
2 properties
Tag
object
A set of key/value pairs that are used to manage the resource.
2 properties 1 required
AdditionalMetricsToRetainV2List
array
TagKey
string
ConfidenceLevel
string
ConsecutiveDatapointsToClear
integer
BehaviorName
string
stringValue
string
SecurityProfileArn
string
EvaluationStatistic
string
MetricToRetain
object
The metric you want to retain. Dimensions are optional.
2 properties 1 required
AlertTargets
object
ListTargetsForSecurityProfileResponse
object
2 properties
AttachSecurityProfileResponse
object
InvalidRequestException
DetachSecurityProfileResponse
object
BehaviorMetric
string
NextToken
string
ComparisonOperator
string
SecurityProfileName
string
ResourceNotFoundException
DeleteSecurityProfileResponse
object
StringList
array
ConsecutiveDatapointsToAlarm
integer
UpdateSecurityProfileResponse
object
10 properties
RoleArn
string
SecurityProfileTargetArn
string
DimensionValueOperator
string
VersionConflictException
BehaviorCriteria
object
The criteria by which the behavior is determined to be normal.
7 properties
AdditionalMetricsToRetainList
array
Number
number
ResourceAlreadyExistsException
ListSecurityProfilesResponse
object
2 properties
DescribeSecurityProfileResponse
object
10 properties
MachineLearningDetectionConfig
object
The configuration of an ML Detect Security Profile.
1 property 1 required
SecurityProfileIdentifiers
array
SuppressAlerts
boolean
Port
integer
Timestamp
string
DimensionName
string
InternalFailureException
AlertTargetArn
string
AlertTarget
object
A structure containing the alert target ARN and the role ARN.
2 properties 2 required
Behavior
object
A Device Defender security profile behavior.
5 properties 1 required
MetricDimension
object
The dimension of a metric.
2 properties 1 required
UnsignedLong
integer
SecurityProfileIdentifier
object
Identifying information for a Device Defender security profile.
2 properties 2 required
SecurityProfileTargets
array
Version
integer
Cidrs
array
TagValue
string
Ports
array
LimitExceededException

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-iot-core-security-profiles-api-openapi.yml Raw ↑

Other APIs Amazon IoT Core publishes across the network.

Amazon IoT Core Accept Certificate Transfer API
Amazon IoT Core Active Violations API
Amazon IoT Core Attached Policies API
Amazon IoT Core Audit API
Amazon IoT Core Authorizer API
Amazon IoT Core Authorizers API
Amazon IoT Core Behavior Model Training API
Amazon IoT Core Billing Groups API
Amazon IoT Core Cacertificate API
Amazon IoT Core Cacertificates API
Amazon IoT Core Cancel Certificate Transfer API
Amazon IoT Core Certificate API
Where this information came from

This is an independent, third-party profile of Amazon IoT Core Security Profiles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.