/AWS1/CL_SSM=>PUTCOMPLIANCEITEMS()
¶
About PutComplianceItems¶
Registers a compliance type and other compliance details on a designated resource. This operation lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.
ComplianceType can be one of the following:
-
ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.
-
ExecutionType: Specify patch, association, or Custom:
string
. -
ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node.
-
Id: The patch, association, or custom compliance ID.
-
Title: A title.
-
Status: The status of the compliance item. For example,
approved
for patches, orFailed
for associations. -
Severity: A patch severity. For example,
Critical
. -
DocumentName: An SSM document name. For example,
AWS-RunPatchBaseline
. -
DocumentVersion: An SSM document version number. For example, 4.
-
Classification: A patch classification. For example,
security updates
. -
PatchBaselineId: A patch baseline ID.
-
PatchSeverity: A patch severity. For example,
Critical
. -
PatchState: A patch state. For example,
InstancesWithFailedPatches
. -
PatchGroup: The name of a patch group.
-
InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format:
yyyy-MM-dd'T'HH:mm:ss'Z'
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_RESOURCEID
TYPE /AWS1/SSMCOMPLIANCERESOURCEID
/AWS1/SSMCOMPLIANCERESOURCEID
¶
Specify an ID for this resource. For a managed node, this is the node ID.
IV_RESOURCETYPE
TYPE /AWS1/SSMCPLNCRESOURCETYPE
/AWS1/SSMCPLNCRESOURCETYPE
¶
Specify the type of resource.
ManagedInstance
is currently the only supported resource type.
IV_COMPLIANCETYPE
TYPE /AWS1/SSMCOMPLIANCETYPENAME
/AWS1/SSMCOMPLIANCETYPENAME
¶
Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:
string
.
IO_EXECUTIONSUMMARY
TYPE REF TO /AWS1/CL_SSMCPLNCEXECSUMMARY
/AWS1/CL_SSMCPLNCEXECSUMMARY
¶
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'
IT_ITEMS
TYPE /AWS1/CL_SSMCPLNCITEMENTRY=>TT_COMPLIANCEITEMENTRYLIST
TT_COMPLIANCEITEMENTRYLIST
¶
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.
Optional arguments:¶
IV_ITEMCONTENTHASH
TYPE /AWS1/SSMCPLNCITEMCONTENTHASH
/AWS1/SSMCPLNCITEMCONTENTHASH
¶
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.
IV_UPLOADTYPE
TYPE /AWS1/SSMCOMPLIANCEUPLOADTYPE
/AWS1/SSMCOMPLIANCEUPLOADTYPE
¶
The mode for uploading compliance items. You can specify
COMPLETE
orPARTIAL
. InCOMPLETE
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 withSyncCompliance
set toMANUAL
. By default, all requests useCOMPLETE
mode.This attribute is only valid for association compliance.