Amazon IoT Device Defender Audit API is one of 69 APIs that Amazon IoT Device Defender publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Audit. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.
This API exposes
25 operations
across 19 paths,
and defines 145 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.
The identity and technical contract details declared by the specification.
AuditFinding
object
The findings (results) of the audit.
11 properties
AuditCheckConfigurations
object
CreateAuditSuppressionResponse
object
AuditMitigationActionsTaskStatus
string
AuditCheckConfiguration
object
Which audit checks are enabled and disabled for this account.
1 property
TaskAlreadyExistsException
AuditFindingSeverity
string
ScheduledAuditMetadata
object
Information about the scheduled audit.
5 properties
ReasonForNonCompliance
string
TargetAuditCheckNames
array
PublishFindingToSnsParams
object
Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS message…
1 property
1 required
ListAuditFindingsResponse
object
2 properties
AuditNotificationTarget
object
Information about the targets to which audit notifications are sent.
3 properties
SkippedFindingsCount
integer
TotalFindingsCount
integer
UpdateDeviceCertificateParams
object
Parameters to define a mitigation action that changes the state of the device certificate to inactive.
1 property
1 required
ScheduledAuditName
string
DeleteScheduledAuditResponse
object
CancelAuditTaskResponse
object
MitigationActionList
array
ScheduledAuditMetadataList
array
PolicyTemplateName
string
ResourceAlreadyExistsException
AuditMitigationActionsTaskMetadataList
array
NonCompliantChecksCount
integer
NonCompliantResource
object
Information about the resource that was noncompliant with the audit check.
3 properties
AuditTaskMetadataList
array
AuditSuppressionList
array
ReplaceDefaultPolicyVersionParams
object
Parameters to define a mitigation action that adds a blank policy to restrict permissions.
1 property
1 required
DescribeAuditTaskResponse
object
6 properties
CognitoIdentityPoolId
string
IssuerCertificateSerialNumber
string
ListAuditTasksResponse
object
2 properties
DescribeAuditFindingResponse
object
1 property
IssuerCertificateSubject
string
UpdateScheduledAuditResponse
object
1 property
AuditCheckToActionsMapping
object
UpdateCACertificateParams
object
Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
1 property
1 required
NonCompliantResourcesCount
integer
CanceledChecksCount
integer
MitigationActionsTaskId
string
FailedFindingsCount
integer
AuditNotificationTargetConfigurations
object
ListScheduledAuditsResponse
object
2 properties
DescribeAccountAuditConfigurationResponse
object
3 properties
MitigationAction
object
Describes which changes should be applied as part of a mitigation action.
4 properties
AddThingsToThingGroupParams
object
Parameters used when defining a mitigation action that move a set of things to a thing group.
2 properties
1 required
AuditTaskMetadata
object
The audits that were performed.
3 properties
InProgressChecksCount
integer
ListAuditMitigationActionsTasksResponse
object
2 properties
AuditMitigationActionsTaskMetadata
object
Information about an audit mitigation actions task that is returned by ListAuditMitigationActionsTasks .
3 properties
AuditMitigationActionsTaskStatistics
object
AuditMitigationActionExecutionMetadata
object
Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.
9 properties
MitigationActionName
string
PolicyVersionIdentifier
object
Information about the version of the policy associated with the resource.
2 properties
CACertificateUpdateAction
string
MitigationActionNameList
array
SucceededFindingsCount
integer
AuditSuppression
object
Filters out specific findings of a Device Defender audit.
5 properties
2 required
AuditCheckDetails
object
Information about the audit check.
7 properties
ListAuditSuppressionsResponse
object
2 properties
EnableIoTLoggingParams
object
Parameters used when defining a mitigation action that enable Amazon Web Services IoT Core logging.
2 properties
2 required
IssuerCertificateIdentifier
object
The certificate issuer indentifier.
3 properties
AuditMitigationActionExecutionMetadataList
array
StartOnDemandAuditTaskResponse
object
1 property
AuditCheckName
string
An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are en…
MitigationActionParams
object
The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mi…
6 properties
WaitingForDataCollectionChecksCount
integer
DescribeAuditMitigationActionsTaskResponse
object
7 properties
TotalResourcesCount
integer
FailedChecksCount
integer
DescribeScheduledAuditResponse
object
6 properties
UpdateAccountAuditConfigurationResponse
object
SuppressIndefinitely
boolean
TaskStatisticsForAuditCheck
object
Provides summary counts of how many tasks for findings are in a particular state. This information is included in the response from DescribeAuditMitigationActi…
5 properties
RelatedResource
object
Information about a related resource.
3 properties
ResourceIdentifier
object
Information that identifies the noncompliant resource.
10 properties
MitigationActionId
string
SuppressedNonCompliantResourcesCount
integer
CreateScheduledAuditResponse
object
1 property
AuditMitigationActionsTaskTarget
object
Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears.
3 properties
ReasonForNonComplianceCode
string
DeleteAccountAuditConfigurationResponse
object
TaskStatistics
object
Statistics for the checks performed during the audit.
7 properties
DeleteAuditSuppressionResponse
object
CancelAuditMitigationActionsTaskResponse
object
CanceledFindingsCount
integer
AuditCheckRunStatus
string
ReasonForNonComplianceCodes
array
AuditCheckToReasonCodeFilter
object
UpdateAuditSuppressionResponse
object
ResourceNotFoundException
StartAuditMitigationActionsTaskResponse
object
1 property
DescribeAuditSuppressionResponse
object
5 properties
AuditMitigationActionsExecutionStatus
string
Tag
object
A set of key/value pairs that are used to manage the resource.
2 properties
1 required
ListRelatedResourcesForAuditFindingResponse
object
2 properties
DeviceCertificateUpdateAction
string
ListAuditMitigationActionsExecutionsResponse
object
2 properties
CompliantChecksCount
integer
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Amazon IoT Device Defender publishes across the network.
