/audit/findings/{findingId}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and the start time when the audit that returned the finding.

Requires permission to access the DescribeAuditFinding action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/audit/findings/'

Response Example

200 - Example 1

{
    "finding": {
        "findingId": "string",
        "taskId": "string",
        "checkName": "string",
        "taskStartTime": "string",
        "findingTime": "string",
        "severity": "CRITICAL",
        "nonCompliantResource": {
            "resourceType": "string",
            "resourceIdentifier": "string",
            "additionalInfo": {
                "property1": "string",
                "property2": "string"
            }
        },
        "relatedResources": [],
        "reasonForNonCompliance": "string",
        "reasonForNonComplianceCode": "string",
        "isSuppressed": true
    }
}

Request

Path Params

findingId

string

required

A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.

Responses

🟢200Success

application/json

Body

finding

object (AuditFinding)

optional

The findings (results) of the audit.

findingId

string

optional

A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9_-]+

taskId

string

optional

The ID of the audit that generated this result (finding).

>= 1 characters<= 40 characters

Match pattern:

[a-zA-Z0-9\-]+

checkName

string

optional

The audit check that generated this result.

taskStartTime

string <date-time>

optional

The time the audit started.

findingTime

string <date-time>

optional

The time the result (finding) was discovered.

severity

enum<string>

optional

The severity of the result (finding).

Allowed values:

CRITICALHIGHMEDIUMLOW

nonCompliantResource

object

optional

The resource that was found to be noncompliant with the audit check.

relatedResources

array[object (RelatedResource) {3}]

optional

The list of related resources.

reasonForNonCompliance

string

optional

The reason the resource was noncompliant.

reasonForNonComplianceCode

string

optional

A code that indicates the reason that the resource was noncompliant.

isSuppressed

boolean

optional

Indicates whether the audit finding was suppressed or not during reporting.

🟠480ResourceNotFoundException

🟠481InvalidRequestException

🟠482ThrottlingException

🟠483InternalFailureException

Modified at 2022-09-10 23:12:16

/thing-types/{thingTypeName}/deprecate

/audit/mitigationactions/tasks/{taskId}