Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . iot ]

list-audit-findings

Description

Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-audit-findings is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: findings

Synopsis

  list-audit-findings
[--task-id <value>]
[--check-name <value>]
[--resource-identifier <value>]
[--start-time <value>]
[--end-time <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--task-id (string)

A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.

--check-name (string)

A filter to limit results to the findings for the specified audit check.

--resource-identifier (structure)

Information identifying the non-compliant resource.

Shorthand Syntax:

deviceCertificateId=string,caCertificateId=string,cognitoIdentityPoolId=string,clientId=string,policyVersionIdentifier={policyName=string,policyVersionId=string},account=string

JSON Syntax:

{
  "deviceCertificateId": "string",
  "caCertificateId": "string",
  "cognitoIdentityPoolId": "string",
  "clientId": "string",
  "policyVersionIdentifier": {
    "policyName": "string",
    "policyVersionId": "string"
  },
  "account": "string"
}

--start-time (timestamp)

A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.

--end-time (timestamp)

A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

findings -> (list)

The findings (results) of the audit.

(structure)

The findings (results) of the audit.

taskId -> (string)

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

checkName -> (string)

The audit check that generated this result.

taskStartTime -> (timestamp)

The time the audit started.

findingTime -> (timestamp)

The time the result (finding) was discovered.

severity -> (string)

The severity of the result (finding).

nonCompliantResource -> (structure)

The resource that was found to be non-compliant with the audit check.

resourceType -> (string)

The type of the non-compliant resource.

resourceIdentifier -> (structure)

Information identifying the non-compliant resource.

deviceCertificateId -> (string)

The ID of the certificate attached to the resource.

caCertificateId -> (string)

The ID of the CA certificate used to authorize the certificate.

cognitoIdentityPoolId -> (string)

The ID of the Cognito Identity Pool.

clientId -> (string)

The client ID.

policyVersionIdentifier -> (structure)

The version of the policy associated with the resource.

policyName -> (string)

The name of the policy.

policyVersionId -> (string)

The ID of the version of the policy associated with the resource.

account -> (string)

The account with which the resource is associated.

additionalInfo -> (map)

Additional information about the non-compliant resource.

key -> (string)

value -> (string)

relatedResources -> (list)

The list of related resources.

(structure)

Information about a related resource.

resourceType -> (string)

The type of resource.

resourceIdentifier -> (structure)

Information identifying the resource.

deviceCertificateId -> (string)

The ID of the certificate attached to the resource.

caCertificateId -> (string)

The ID of the CA certificate used to authorize the certificate.

cognitoIdentityPoolId -> (string)

The ID of the Cognito Identity Pool.

clientId -> (string)

The client ID.

policyVersionIdentifier -> (structure)

The version of the policy associated with the resource.

policyName -> (string)

The name of the policy.

policyVersionId -> (string)

The ID of the version of the policy associated with the resource.

account -> (string)

The account with which the resource is associated.

additionalInfo -> (map)

Additional information about the resource.

key -> (string)

value -> (string)

reasonForNonCompliance -> (string)

The reason the resource was non-compliant.

reasonForNonComplianceCode -> (string)

A code which indicates the reason that the resource was non-compliant.

nextToken -> (string)

A token that can be used to retrieve the next set of results, or null if there are no additional results.