Skip to content
AWS for Query.Farm

aws.ssm.describe_instance_patch_states_for_patch_group

Example SQL Queries

SELECT * FROM
aws.ssm.describe_instance_patch_states_for_patch_group
WHERE
"patch_group" = 'VALUE';

Description

Retrieves the high-level patch state for the managed nodes in the specified patch group.

Table Definition

Column NameColumn Data Type
patch_group Required Input Column

The name of the patch group the managed node belongs to.

VARCHAR
filters Input Column

Each entry in the array is a structure containing:

  • Key (string between 1 and 200 characters)

  • Values (array containing a single string)

  • Type (string "Equal", "NotEqual", "LessThan", "GreaterThan")

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

The key for the filter. Supported values include the following:

  • InstalledCount

  • InstalledOtherCount

  • InstalledPendingRebootCount

  • InstalledRejectedCount

  • MissingCount

  • FailedCount

  • UnreportedNotApplicableCount

  • NotApplicableCount

filters[].type

The type of comparison that should be performed for the value.

filters[].values[]
_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
baseline_id

The ID of the patch baseline used to patch the managed node.

VARCHAR
critical_non_compliant_count

The number of patches per node that are specified as Critical for compliance reporting in the patch baseline aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.

BIGINT
failed_count

The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.

BIGINT
install_override_list

An https URL or an Amazon Simple Storage Service (Amazon S3) path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline.

For more information about the InstallOverrideList parameter, see About the AWS-RunPatchBaseline SSM document in the Amazon Web Services Systems Manager User Guide.

VARCHAR
installed_count

The number of patches from the patch baseline that are installed on the managed node.

BIGINT
installed_other_count

The number of patches not specified in the patch baseline that are installed on the managed node.

BIGINT
installed_pending_reboot_count

The number of patches installed by Patch Manager since the last time the managed node was rebooted.

BIGINT
installed_rejected_count

The number of patches installed on a managed node that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list.

If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).

BIGINT
instance_id

The ID of the managed node the high-level patch compliance information was collected for.

VARCHAR
last_no_reboot_install_operation_time

The time of the last attempt to patch the managed node with NoReboot specified as the reboot option.

TIMESTAMP_S
missing_count

The number of patches from the patch baseline that are applicable for the managed node but aren't currently installed.

BIGINT
not_applicable_count

The number of patches from the patch baseline that aren't applicable for the managed node and therefore aren't installed on the node. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount.

BIGINT
operation

The type of patching operation that was performed: or

  • SCAN assesses the patch compliance state.

  • INSTALL installs missing patches.

VARCHAR
operation_end_time

The time the most recent patching operation completed on the managed node.

TIMESTAMP_S
operation_start_time

The time the most recent patching operation was started on the managed node.

TIMESTAMP_S
other_non_compliant_count

The number of patches per node that are specified as other than Critical or Security but aren't compliant with the patch baseline. The status of these managed nodes is NON_COMPLIANT.

BIGINT
owner_information

Placeholder information. This field will always be empty in the current release of the service.

VARCHAR
reboot_option

Indicates the reboot option specified in the patch baseline.

Reboot options apply to Install operations only. Reboots aren't attempted for Patch Manager Scan operations.

  • RebootIfNeeded: Patch Manager tries to reboot the managed node if it installed any patches, or if any patches are detected with a status of InstalledPendingReboot.

  • NoReboot: Patch Manager attempts to install missing packages without trying to reboot the system. Patches installed with this option are assigned a status of InstalledPendingReboot. These patches might not be in effect until a reboot is performed.

VARCHAR
security_non_compliant_count

The number of patches per node that are specified as Security in a patch advisory aren't installed. These patches might be missing, have failed installation, were rejected, or were installed but awaiting a required managed node reboot. The status of these managed nodes is NON_COMPLIANT.

BIGINT
snapshot_id

The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.

VARCHAR
unreported_not_applicable_count

The number of patches beyond the supported limit of NotApplicableCount that aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.

BIGINT