Skip to main content

related_resources_for_audit_findings

Creates, updates, deletes, gets or lists a related_resources_for_audit_findings resource.

Overview

Namerelated_resources_for_audit_findings
TypeResource
Idaws.iot.related_resources_for_audit_findings

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
additional_infoobjectOther information about the resource.
resource_identifierobjectInformation that identifies the noncompliant resource.
resource_typestringThe type of resource. (DEVICE_CERTIFICATE, CA_CERTIFICATE, IOT_POLICY, COGNITO_IDENTITY_POOL, CLIENT_ID, ACCOUNT_SETTINGS, ROLE_ALIAS, IAM_ROLE, ISSUER_CERTIFICATE)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_related_resources_for_audit_findingselectfindingId, regionnextToken, maxResultsThe related resources of an Audit finding. The following resources can be returned from calling this API: DEVICE_CERTIFICATE CA_CERTIFICATE IOT_POLICY COGNITO_IDENTITY_POOL CLIENT_ID ACCOUNT_SETTINGS ROLE_ALIAS IAM_ROLE ISSUER_CERTIFICATE This API is similar to DescribeAuditFinding's RelatedResources but provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
findingIdstringThe finding Id.
regionstringAWS region (default: us-east-1)
maxResultsintegerThe maximum number of results to return at one time.
nextTokenstringA token that can be used to retrieve the next set of results, or null if there are no additional results.

SELECT examples

The related resources of an Audit finding. The following resources can be returned from calling this API: DEVICE_CERTIFICATE CA_CERTIFICATE IOT_POLICY COGNITO_IDENTITY_POOL CLIENT_ID ACCOUNT_SETTINGS ROLE_ALIAS IAM_ROLE ISSUER_CERTIFICATE This API is similar to DescribeAuditFinding's RelatedResources but provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.

SELECT
additional_info,
resource_identifier,
resource_type
FROM aws.iot.related_resources_for_audit_findings
WHERE findingId = '{{ findingId }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;