ssm_put_compliance_items: Registers a compliance type and other compliance details on a...

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

Description

Registers a compliance type and other compliance details on a designated resource. This action 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:

Usage

1
2
ssm_put_compliance_items(ResourceId, ResourceType, ComplianceType,
  ExecutionSummary, Items, ItemContentHash, UploadType)

Arguments

ResourceId

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

ResourceType

[required] Specify the type of resource. ManagedInstance is currently the only supported resource type.

ComplianceType

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

ExecutionSummary

[required] 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'.

Items

[required] 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.

ItemContentHash

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.

UploadType

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.

Value

An empty list.

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
svc$put_compliance_items(
  ResourceId = "string",
  ResourceType = "string",
  ComplianceType = "string",
  ExecutionSummary = list(
    ExecutionTime = as.POSIXct(
      "2015-01-01"
    ),
    ExecutionId = "string",
    ExecutionType = "string"
  ),
  Items = list(
    list(
      Id = "string",
      Title = "string",
      Severity = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"INFORMATIONAL"|"UNSPECIFIED",
      Status = "COMPLIANT"|"NON_COMPLIANT",
      Details = list(
        "string"
      )
    )
  ),
  ItemContentHash = "string",
  UploadType = "COMPLETE"|"PARTIAL"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.