/

The Amazon SSM multi-region endpoint

http://ssm.{region}.amazonaws.com

POST

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, 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'

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://ssm.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ResourceId": "string",
    "ResourceType": "string",
    "ComplianceType": "string",
    "ExecutionSummary": {
        "ExecutionTime": "string",
        "ExecutionId": "string",
        "ExecutionType": "string"
    },
    "Items": [],
    "ItemContentHash": "string",
    "UploadType": "COMPLETE"
}'

Response Example

200 - Example 1

{}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

ResourceId

string

required

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

>= 1 characters<= 100 characters

ResourceType

string

required

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

>= 1 characters<= 50 characters

ComplianceType

string

required

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

>= 1 characters<= 100 characters

Match pattern:

[A-Za-z0-9_\-]\w+|Custom:[a-zA-Z0-9_\-]\w+

ExecutionSummary

object

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

ExecutionTime

string <date-time>

required

The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

ExecutionId

string

optional

An ID created by the system when PutComplianceItems was called. For example, CommandID is a valid execution ID. You can use this ID in subsequent calls.

<= 100 characters

ExecutionType

string

optional

The type of execution. For example, Command is a valid execution type.

<= 50 characters

Items

array[object (ComplianceItemEntry) {5}]

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.

>= 0 items<= 10000 items

string

optional

The compliance item ID. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article.

Title

string

optional

The title of the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.

<= 500 characters

Severity

enum<string>

required

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

Allowed values:

CRITICALHIGHMEDIUMLOWINFORMATIONALUNSPECIFIED

Status

enum<string>

required

The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.

Allowed values:

COMPLIANTNON_COMPLIANT

Details

object

optional

A "Key": "Value" tag combination for the compliance item.

ItemContentHash

string

optional

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.

<= 256 characters

UploadType

enum<string>

optional

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.

Allowed values:

COMPLETEPARTIAL

Examples

Responses

🟢200Success

application/json

Body

object {0}

🟠480InternalServerError

🟠481InvalidItemContentException

🟠482TotalSizeLimitExceededException

🟠483ItemSizeLimitExceededException

🟠484ComplianceTypeCountLimitExceededException

🟠485InvalidResourceType

🟠486InvalidResourceId