Amazon IoT Core Audit 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 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.
ScheduledAuditMetadataList
array
DeleteScheduledAuditResponse
object
WaitingForDataCollectionChecksCount
integer
FailedFindingsCount
integer
CancelAuditMitigationActionsTaskResponse
object
AuditTaskMetadata
object
The audits that were performed.
3 properties
ResourceNotFoundException
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
AuditMitigationActionsTaskMetadata
object
Information about an audit mitigation actions task that is returned by ListAuditMitigationActionsTasks .
3 properties
AuditMitigationActionsTaskMetadataList
array
ReasonForNonComplianceCodes
array
AuditMitigationActionsTaskTarget
object
Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears.
3 properties
IssuerCertificateSubject
string
NonCompliantResourcesCount
integer
AuditCheckConfigurations
object
DescribeAuditSuppressionResponse
object
5 properties
SuppressedNonCompliantResourcesCount
integer
ReplaceDefaultPolicyVersionParams
object
Parameters to define a mitigation action that adds a blank policy to restrict permissions.
1 property
1 required
AuditCheckRunStatus
string
AuditSuppressionList
array
AuditCheckToActionsMapping
object
AuditSuppression
object
Filters out specific findings of a Device Defender audit.
5 properties
2 required
CACertificateUpdateAction
string
TotalFindingsCount
integer
AuditFinding
object
The findings (results) of the audit.
11 properties
DeleteAuditSuppressionResponse
object
CancelAuditTaskResponse
object
UpdateCACertificateParams
object
Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
1 property
1 required
ResourceIdentifier
object
Information that identifies the noncompliant resource.
10 properties
TotalResourcesCount
integer
ListAuditSuppressionsResponse
object
2 properties
ReasonForNonComplianceCode
string
ListAuditFindingsResponse
object
2 properties
AuditCheckDetails
object
Information about the audit check.
7 properties
ListAuditMitigationActionsTasksResponse
object
2 properties
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…
UpdateDeviceCertificateParams
object
Parameters to define a mitigation action that changes the state of the device certificate to inactive.
1 property
1 required
ListAuditTasksResponse
object
2 properties
ResourceAlreadyExistsException
CognitoIdentityPoolId
string
DescribeScheduledAuditResponse
object
6 properties
ListRelatedResourcesForAuditFindingResponse
object
2 properties
DescribeAuditMitigationActionsTaskResponse
object
7 properties
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
CompliantChecksCount
integer
AuditCheckToReasonCodeFilter
object
Tag
object
A set of key/value pairs that are used to manage the resource.
2 properties
1 required
MitigationActionNameList
array
MitigationActionList
array
ReasonForNonCompliance
string
AuditTaskMetadataList
array
InProgressChecksCount
integer
DeleteAccountAuditConfigurationResponse
object
IssuerCertificateIdentifier
object
The certificate issuer indentifier.
3 properties
AuditMitigationActionsTaskStatus
string
CreateScheduledAuditResponse
object
1 property
AuditMitigationActionsTaskStatistics
object
AuditNotificationTarget
object
Information about the targets to which audit notifications are sent.
3 properties
ListScheduledAuditsResponse
object
2 properties
NonCompliantChecksCount
integer
SuppressIndefinitely
boolean
NonCompliantResource
object
Information about the resource that was noncompliant with the audit check.
3 properties
DescribeAuditFindingResponse
object
1 property
UpdateScheduledAuditResponse
object
1 property
AuditMitigationActionExecutionMetadataList
array
FailedChecksCount
integer
UpdateAuditSuppressionResponse
object
AuditMitigationActionExecutionMetadata
object
Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.
9 properties
ScheduledAuditMetadata
object
Information about the scheduled audit.
5 properties
UpdateAccountAuditConfigurationResponse
object
ListAuditMitigationActionsExecutionsResponse
object
2 properties
EnableIoTLoggingParams
object
Parameters used when defining a mitigation action that enable Amazon Web Services IoT Core logging.
2 properties
2 required
AddThingsToThingGroupParams
object
Parameters used when defining a mitigation action that move a set of things to a thing group.
2 properties
1 required
TaskAlreadyExistsException
AuditMitigationActionsExecutionStatus
string
CanceledFindingsCount
integer
AuditNotificationTargetConfigurations
object
MitigationActionName
string
DeviceCertificateUpdateAction
string
ScheduledAuditName
string
TaskStatistics
object
Statistics for the checks performed during the audit.
7 properties
CreateAuditSuppressionResponse
object
MitigationActionsTaskId
string
StartAuditMitigationActionsTaskResponse
object
1 property
AuditCheckConfiguration
object
Which audit checks are enabled and disabled for this account.
1 property
PolicyVersionIdentifier
object
Information about the version of the policy associated with the resource.
2 properties
IssuerCertificateSerialNumber
string
RelatedResource
object
Information about a related resource.
3 properties
SkippedFindingsCount
integer
MitigationActionId
string
StartOnDemandAuditTaskResponse
object
1 property
DescribeAuditTaskResponse
object
6 properties
AuditFindingSeverity
string
CanceledChecksCount
integer
SucceededFindingsCount
integer
DescribeAccountAuditConfigurationResponse
object
3 properties
TargetAuditCheckNames
array
MitigationAction
object
Describes which changes should be applied as part of a mitigation action.
4 properties
PolicyTemplateName
string
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Amazon IoT Core publishes across the network.
