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)


5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5702

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :missing_count,
  :failed_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)


5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5702

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :missing_count,
  :failed_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)


5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5702

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :missing_count,
  :failed_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)


5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5702

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :missing_count,
  :failed_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)


5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5702

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :missing_count,
  :failed_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)


5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5702

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :missing_count,
  :failed_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 hence aren't installed on the instance.

Returns:

  • (Integer)


5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5702

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :missing_count,
  :failed_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)


5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5702

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :missing_count,
  :failed_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)


5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5702

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :missing_count,
  :failed_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)


5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5702

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :missing_count,
  :failed_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)


5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5702

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :missing_count,
  :failed_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)


5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5702

class InstancePatchState < Struct.new(
  :instance_id,
  :patch_group,
  :baseline_id,
  :snapshot_id,
  :owner_information,
  :installed_count,
  :installed_other_count,
  :missing_count,
  :failed_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)


5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5702

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