View a markdown version of this page

Use PutComplianceItems with a CLI - AWS SDK Code Examples

There are more AWS SDK examples available in the AWS Doc SDK Examples GitHub repo.

Use PutComplianceItems with a CLI

The following code examples show how to use PutComplianceItems.

CLI
AWS CLI

To register a compliance type and compliance details to a designated instance

The following put-compliance-items example registers the compliance type Custom:AVCheck to the specified managed instance.

aws ssm put-compliance-items \ --resource-id "i-1234567890abcdef0" \ --resource-type "ManagedInstance" \ --compliance-type "Custom:AVCheck" \ --execution-summary "ExecutionTime=2019-02-18T16:00:00Z" \ --items "Id=Version2.0,Title=ScanHost,Severity=CRITICAL,Status=COMPLIANT"

This command produces no output.

For more information, see Assign custom compliance metadata using the AWS CLI in the AWS Systems Manager User Guide.

PowerShell
Tools for PowerShell V4

Example 1: This example writes a custom compliance item for the given managed instance

$item = [Amazon.SimpleSystemsManagement.Model.ComplianceItemEntry]::new() $item.Id = "07Jun2019-3" $item.Severity="LOW" $item.Status="COMPLIANT" $item.Title="Fin-test-1 - custom" Write-SSMComplianceItem -ResourceId mi-012dcb3ecea45b678 -ComplianceType Custom:VSSCompliant2 -ResourceType ManagedInstance -Item $item -ExecutionSummary_ExecutionTime "07-Jun-2019"
  • For API details, see PutComplianceItems in AWS Tools for PowerShell Cmdlet Reference (V4).

Tools for PowerShell V5

Example 1: This example writes a custom compliance item for the given managed instance

$item = [Amazon.SimpleSystemsManagement.Model.ComplianceItemEntry]::new() $item.Id = "07Jun2019-3" $item.Severity="LOW" $item.Status="COMPLIANT" $item.Title="Fin-test-1 - custom" Write-SSMComplianceItem -ResourceId mi-012dcb3ecea45b678 -ComplianceType Custom:VSSCompliant2 -ResourceType ManagedInstance -Item $item -ExecutionSummary_ExecutionTime "07-Jun-2019"
  • For API details, see PutComplianceItems in AWS Tools for PowerShell Cmdlet Reference (V5).