Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

ComplianceItem

Information about the compliance as defined by the resource type. For example, for a patch resource type, Items includes information about the PatchSeverity, Classification, etc.

Contents

ComplianceType

The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

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

Required: No

Details

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

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Value Length Constraints: Minimum length of 0. Maximum length of 4096.

Required: No

ExecutionSummary

A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.

Type: ComplianceExecutionSummary object

Required: No

Id

An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article. Here's an example: KB4010320.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

ResourceId

An ID for the resource. For a managed instance, this is the instance ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

ResourceType

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Required: No

Severity

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

Type: String

Valid Values: CRITICAL | HIGH | MEDIUM | LOW | INFORMATIONAL | UNSPECIFIED

Required: No

Status

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

Type: String

Valid Values: COMPLIANT | NON_COMPLIANT

Required: No

Title

A title for 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. Here's an example: Security Update for Active Directory Federation Services.

Type: String

Length Constraints: Maximum length of 500.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: