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

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::PutComplianceItemsRequest

Includes:

Aws::Structure

Defined in:

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",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #compliance_type ⇒ String

  Specify the compliance type.

• #execution_summary ⇒ Types::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’.

• #item_content_hash ⇒ String

  MD5 or SHA-256 content hash.

• #items ⇒ Array<Types::ComplianceItemEntry>

  Information about the compliance as defined by the resource type.

• #resource_id ⇒ String

  Specify an ID for this resource.

• #resource_type ⇒ String

  Specify the type of resource.

Instance Attribute Details

#compliance_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 10878

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

#execution_summary ⇒ Types::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’.

Returns:

• (Types::ComplianceExecutionSummary)

# File 'lib/aws-sdk-ssm/types.rb', line 10878

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

#item_content_hash ⇒ String

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)

# File 'lib/aws-sdk-ssm/types.rb', line 10878

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

#items ⇒ Array<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:

• (Array<Types::ComplianceItemEntry>)

# File 'lib/aws-sdk-ssm/types.rb', line 10878

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

#resource_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 10878

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

#resource_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 10878

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