List Policy compliance states
/unified/cloud-infrastructure/policy_compliance_states
Query Parameters
Refer Specifying query parameters in Truto APIs
Region of the Config aggregator endpoint (not the region of the evaluated resources - an aggregator returns rows for every account and region it aggregates).
1 supported
Name of the AWS Config configuration aggregator. Required: DescribeAggregateComplianceByConfigRules has no unaggregated form. Enumerate aggregators with DescribeConfigurationAggregators first; most mature organizations already have one. An aggregator removes the AssumeRole-per-account fan-out entirely.
1 supported1 required
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
Present only when truto_response_format=debug. Contains raw fetch details: requestUrl, requestOptions, data, responseHeaders, nextCursor, isLooping, isEmptyResult, resultCount. data is the parsed upstream body; when its JSON form exceeds 1 MiB it is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }, where truto_excerpt is the leading bytes of that body. The same applies to a string requestOptions.body. null for static responses or when truto_skip_api_call=true.
The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.
List of Policy compliance states
The account, subscription or project the object belongs to. An object with no account cannot be attributed to an environment, so this is always present for objects that live inside an account.
1 supported
When Truto actually read this object from the provider, in UTC ISO 8601 with the offset present. Not when the request was made and not a provider timestamp. Drives consumer staleness rules.
1 supported
The evaluation outcome. insufficient_data is kept distinct and never folded into compliant. Note one provider returns insufficient_data but will not accept it as a query filter, so it can only be observed in results.
compliantnon_compliantinsufficient_datanot_applicableunknown
1 supported
Truto's stable unified identifier for this object. Opaque; use provider_ref to address the object in the provider's own console or API.
1 supported
The provider's own type string, unmodified -- for example 'AWS::S3::Bucket', 'aws_iam_role', 'Microsoft.Sql/servers'. Used for display and drill-down.
1 supported
The rule or policy this state belongs to.
1 supported
Which cloud this object was read from.
awsazuregcp
1 supported
The provider's own unbroken identifier, passed through verbatim -- a full ARN, resource id or self-link. Never truncated, prefixed or normalised. This is the customer-facing key used to find the object in the console.
1 supported
The account, node or resource scope this state was evaluated for.
1 supported
How many resources satisfy the rule.
1 supported
Whether the counts are a provider-imposed ceiling rather than exact. Mapped through rather than dropped, because the cap bites on exactly the large rules that matter most and publishing a ceiling as a count is a wrong number.
1 supported
When the rule was last evaluated. Read from a real provider evaluation timestamp -- Truto's own fetch time is NEVER substituted here, because that is precisely the staleness lie the brief warns about. The AWS compliance call carries no timestamp at all and is paired with a separate evaluation-status call.
1 supported
The last evaluation that actually succeeded, as distinct from the last invocation.
1 supported
How many resources violate the rule. See count_capped: the provider may return a ceiling rather than a true count.
1 supported
The resources violating the rule. Opt-in, because on AWS the resource list cannot be aggregated and costs one paged call per rule per account per region.
1 supported
The rule name as the provider names it.
1 supported
Where the object is. A compliance answer in its own right, not metadata. The literal string 'global' is emitted for genuinely global resources (for example IAM, or a GCP VPC network) rather than guessing a region. Never invented: where the provider does not return a location and none can be derived, the collector's queried region is used and that substitution is recorded in unreadable_fields.
1 supported
Raw data returned from the remote API call.
Whether non_compliant_resource_refs was actually gathered. False means an empty list reflects a collection choice, not a clean result.
1 supported
Key-value pairs exactly as the customer set them: no case folding, no key or value normalisation, no merging of separate provider concepts. Present on every object because tags are the primary input for environment classification. An empty object means the object carries no tags; tags that could not be read are recorded in unreadable_fields instead.
1 supported
Per-object list of the fields that could not be read, and why -- the brief section 8.4 answer, chosen over per-field sentinel values. Each entry is an object with 'field' (the property name on this resource), 'reason' (a reason code) and an optional human-readable 'detail'. Reason codes: not_supported_by_provider, not_configured, permission_denied, not_collected, collection_error, partially_collected. An empty array means every property on this object was read successfully. A property absent from this array and null in the payload means the provider genuinely returned no value, which is different from 'we could not look'.
1 supported
truto unified cloud-infrastructure policycompliancestates \
-a '<integrated_account_id>' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'cloud-infrastructure',
'policycompliancestates',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
async for item in truto_api.unified_api.list(
"cloud-infrastructure",
"policycompliancestates",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())curl -X GET 'https://api.truto.one/unified/cloud-infrastructure/policy_compliance_states?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/cloud-infrastructure/policy_compliance_states?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/cloud-infrastructure/policy_compliance_states"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())