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.

For State Manager associations, this represents the time when compliance status was captured by the Systems Manager service during its internal compliance aggregation workflow, not necessarily when the association was executed on the managed node. State Manager updates compliance information for all associations on an instance whenever any association executes, which may result in multiple associations showing the same execution time.
Id: The patch, association, or custom compliance ID.
Title: A title.
Status: The status of the compliance item. For example, approved for patches, or Failed 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¶

METHODS /AWS1/IF_SSM~PUTCOMPLIANCEITEMS
  IMPORTING
    !IV_RESOURCEID TYPE /AWS1/SSMCOMPLIANCERESOURCEID OPTIONAL
    !IV_RESOURCETYPE TYPE /AWS1/SSMCPLNCRESOURCETYPE OPTIONAL
    !IV_COMPLIANCETYPE TYPE /AWS1/SSMCOMPLIANCETYPENAME OPTIONAL
    !IO_EXECUTIONSUMMARY TYPE REF TO /AWS1/CL_SSMCPLNCEXECSUMMARY OPTIONAL
    !IT_ITEMS TYPE /AWS1/CL_SSMCPLNCITEMENTRY=>TT_COMPLIANCEITEMENTRYLIST OPTIONAL
    !IV_ITEMCONTENTHASH TYPE /AWS1/SSMCPLNCITEMCONTENTHASH OPTIONAL
    !IV_UPLOADTYPE TYPE /AWS1/SSMCOMPLIANCEUPLOADTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ssmputcplncitemsrslt
  RAISING
    /AWS1/CX_SSMCPLNCTYPECTLMTEX00
    /AWS1/CX_SSMINTERNALSERVERERR
    /AWS1/CX_SSMINVALIDITEMCONTEX
    /AWS1/CX_SSMINVALIDRESOURCEID
    /AWS1/CX_SSMINVRESOURCETYPE
    /AWS1/CX_SSMITEMSIZELMTEXCDEX
    /AWS1/CX_SSMTOTALSIZELMTEXCDEX
    /AWS1/CX_SSMCLIENTEXC
    /AWS1/CX_SSMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

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 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.

This attribute is only valid for association compliance.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ssmputcplncitemsrslt` `/AWS1/CL_SSMPUTCPLNCITEMSRSLT`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->putcomplianceitems(
  io_executionsummary = new /aws1/cl_ssmcplncexecsummary(
    iv_executionid = |string|
    iv_executiontime = '20150101000000.0000000'
    iv_executiontype = |string|
  )
  it_items = VALUE /aws1/cl_ssmcplncitementry=>tt_complianceitementrylist(
    (
      new /aws1/cl_ssmcplncitementry(
        it_details = VALUE /aws1/cl_ssmcplncitemdetails_w=>tt_complianceitemdetails(
          (
            VALUE /aws1/cl_ssmcplncitemdetails_w=>ts_cplncitemdetails_maprow(
              key = |string|
              value = new /aws1/cl_ssmcplncitemdetails_w( |string| )
            )
          )
        )
        iv_id = |string|
        iv_severity = |string|
        iv_status = |string|
        iv_title = |string|
      )
    )
  )
  iv_compliancetype = |string|
  iv_itemcontenthash = |string|
  iv_resourceid = |string|
  iv_resourcetype = |string|
  iv_uploadtype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

/AWS1/IF_SSM=>PUTCOMPLIANCEITEMS()¶

About PutComplianceItems¶

Method Signature¶

IMPORTING¶

Required arguments:¶

iv_resourceid TYPE /AWS1/SSMCOMPLIANCERESOURCEID /AWS1/SSMCOMPLIANCERESOURCEID¶

iv_resourcetype TYPE /AWS1/SSMCPLNCRESOURCETYPE /AWS1/SSMCPLNCRESOURCETYPE¶

iv_compliancetype TYPE /AWS1/SSMCOMPLIANCETYPENAME /AWS1/SSMCOMPLIANCETYPENAME¶

io_executionsummary TYPE REF TO /AWS1/CL_SSMCPLNCEXECSUMMARY /AWS1/CL_SSMCPLNCEXECSUMMARY¶

it_items TYPE /AWS1/CL_SSMCPLNCITEMENTRY=>TT_COMPLIANCEITEMENTRYLIST TT_COMPLIANCEITEMENTRYLIST¶