You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SSM::Types::PutComplianceItemsRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::PutComplianceItemsRequest
- Defined in:
- (unknown)
Overview
When passing PutComplianceItemsRequest as input to an Aws::Client method, you can use a vanilla 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",
upload_type: "COMPLETE", # accepts COMPLETE, PARTIAL
}
Instance Attribute Summary collapse
-
#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.
-
#upload_type ⇒ String
The mode for uploading compliance items.
Instance Attribute Details
#compliance_type ⇒ String
Specify the compliance type. For example, specify Association (for a
State Manager association), Patch, or Custom:string
.
#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. 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.
#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, and so on.
#resource_id ⇒ String
Specify an ID for this resource. For a managed instance, this is the instance ID.
#resource_type ⇒ String
Specify the type of resource. ManagedInstance
is currently the only
supported resource type.
#upload_type ⇒ String
The mode for uploading compliance items. You can specify COMPLETE
or
PARTIAL
. In COMPLETE
mode, the system overwrites all existing
compliance information for the resource. You must provide a full list of
compliance items each time you send the request.
In PARTIAL
mode, the system overwrites compliance information for a
specific association. The association must be configured with
SyncCompliance
set to MANUAL
. By default, all requests use
COMPLETE
mode.
Possible values:
- COMPLETE
- PARTIAL