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