Skip to content
AWS for Query.Farm

aws.ssm.list_compliance_items

Example SQL Queries

SELECT * FROM
aws.ssm.list_compliance_items;

Description

For a specified resource ID, this API operation returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

Table Definition

Column NameColumn Data Type
filters Input Column

One or more compliance filters. Use a filter to return a more specific list of results.

STRUCT(
    "key" VARCHAR,
    "values" VARCHAR[],
    "type" VARCHAR
)[]
Show child fields
filters[]
Show child fields
filters[].key

The name of the filter.

filters[].type

The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith, LessThan, or GreaterThan.

filters[].values[]
resource_ids Input Column

The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.

VARCHAR[]
Show child fields
resource_ids[]
resource_types Input Column

The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance.

VARCHAR[]
Show child fields
resource_types[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
compliance_type

The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.

VARCHAR
details

A "Key": "Value" tag combination for the compliance item.

MAP(VARCHAR, VARCHAR)
execution_summary

A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.

STRUCT(
    "execution_time" TIMESTAMP_S,
    "execution_id" VARCHAR,
    "execution_type" VARCHAR
)
Show child fields
execution_summary.execution_id

An ID created by the system when PutComplianceItems was called. For example, CommandID is a valid execution ID. You can use this ID in subsequent calls.

execution_summary.execution_time

The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

execution_summary.execution_type

The type of execution. For example, Command is a valid execution type.

id

An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320.

VARCHAR
resource_id

An ID for the resource. For a managed node, this is the node ID.

VARCHAR
resource_type

The type of resource. ManagedInstance is currently the only supported resource type.

VARCHAR
severity

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

VARCHAR
status

The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable).

VARCHAR
title

A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.

VARCHAR