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

Class: Aws::SSM::Types::PutComplianceItemsRequest

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

Overview

Note:

When making an API call, you may pass PutComplianceItemsRequest data as a hash:

{
  resource_id: "ComplianceResourceId", # required
  resource_type: "ComplianceResourceType", # required
  compliance_type: "ComplianceTypeName", # required
  execution_summary: { # required
    execution_time: Time.now, # required
    execution_id: "ComplianceExecutionId",
    execution_type: "ComplianceExecutionType",
  },
  items: [ # required
    {
      id: "ComplianceItemId",
      title: "ComplianceItemTitle",
      severity: "CRITICAL", # required, accepts CRITICAL, HIGH, MEDIUM, LOW, INFORMATIONAL, UNSPECIFIED
      status: "COMPLIANT", # required, accepts COMPLIANT, NON_COMPLIANT
      details: {
        "AttributeName" => "AttributeValue",
      },
    },
  ],
  item_content_hash: "ComplianceItemContentHash",
}

Instance Attribute Summary collapse

Instance Attribute Details

#compliance_typeString

Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string.

Returns:

  • (String)


7951
7952
7953
7954
7955
7956
7957
7958
7959
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7951

class PutComplianceItemsRequest < Struct.new(
  :resource_id,
  :resource_type,
  :compliance_type,
  :execution_summary,
  :items,
  :item_content_hash)
  include Aws::Structure
end

#execution_summaryTypes::ComplianceExecutionSummary

A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.



7951
7952
7953
7954
7955
7956
7957
7958
7959
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7951

class PutComplianceItemsRequest < Struct.new(
  :resource_id,
  :resource_type,
  :compliance_type,
  :execution_summary,
  :items,
  :item_content_hash)
  include Aws::Structure
end

#item_content_hashString

MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.

Returns:

  • (String)


7951
7952
7953
7954
7955
7956
7957
7958
7959
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7951

class PutComplianceItemsRequest < Struct.new(
  :resource_id,
  :resource_type,
  :compliance_type,
  :execution_summary,
  :items,
  :item_content_hash)
  include Aws::Structure
end

#itemsArray<Types::ComplianceItemEntry>

Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, etc.

Returns:



7951
7952
7953
7954
7955
7956
7957
7958
7959
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7951

class PutComplianceItemsRequest < Struct.new(
  :resource_id,
  :resource_type,
  :compliance_type,
  :execution_summary,
  :items,
  :item_content_hash)
  include Aws::Structure
end

#resource_idString

Specify an ID for this resource. For a managed instance, this is the instance ID.

Returns:

  • (String)


7951
7952
7953
7954
7955
7956
7957
7958
7959
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7951

class PutComplianceItemsRequest < Struct.new(
  :resource_id,
  :resource_type,
  :compliance_type,
  :execution_summary,
  :items,
  :item_content_hash)
  include Aws::Structure
end

#resource_typeString

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

Returns:

  • (String)


7951
7952
7953
7954
7955
7956
7957
7958
7959
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 7951

class PutComplianceItemsRequest < Struct.new(
  :resource_id,
  :resource_type,
  :compliance_type,
  :execution_summary,
  :items,
  :item_content_hash)
  include Aws::Structure
end