You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SSM::Types::InstancePatchState

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Defines the high-level patch compliance state for a managed instance, providing information about the number of installed, missing, not applicable, and failed patches along with metadata about the operation when this information was gathered for the instance.

Instance Attribute Summary collapse

Instance Attribute Details

#baseline_idString

The ID of the patch baseline used to patch the instance.

Returns:

  • (String)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end

#failed_countInteger

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

Returns:

  • (Integer)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end

#install_override_listString

An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an Amazon 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 SSM Document AWS-RunPatchBaseline in the AWS Systems Manager User Guide.

Returns:

  • (String)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end

#installed_countInteger

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

Returns:

  • (Integer)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end

#installed_other_countInteger

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

Returns:

  • (Integer)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end

#installed_rejected_countInteger

The number of instances with patches installed 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).

Returns:

  • (Integer)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end

#instance_idString

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

Returns:

  • (String)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end

#missing_countInteger

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

Returns:

  • (Integer)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end

#not_applicable_countInteger

The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't installed on the instance. 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.

Returns:

  • (Integer)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end

#operationString

The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).

Returns:

  • (String)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end

#operation_end_timeTime

The time the most recent patching operation completed on the instance.

Returns:

  • (Time)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end

#operation_start_timeTime

The time the most recent patching operation was started on the instance.

Returns:

  • (Time)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end

#owner_informationString

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

Returns:

  • (String)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end

#patch_groupString

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

Returns:

  • (String)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end

#snapshot_idString

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

Returns:

  • (String)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end

#unreported_not_applicable_countInteger

The number of patches beyond the supported limit of NotApplicableCount that are not reported by name to Systems Manager Inventory.

Returns:

  • (Integer)


8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 8465

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :install_override_list,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :installed_rejected_count,
  :missing_count,
  :failed_count,
  :unreported_not_applicable_count,
  :not_applicable_count,
  :operation_start_time,
  :operation_end_time,
  :operation)
  include Aws::Structure
end