Skip to content

PutComplianceItemsRequest

Source code in docs_src/capo_ssm/types/put_compliance_items_request.py
class PutComplianceItemsRequest(TypedDict, closed=True):
    resource_id: "capo_ssm.types.compliance_resource_id.ComplianceResourceId"
    """<p>Specify an ID for this resource. For a managed node, this is the node ID.</p>"""
    resource_type: "capo_ssm.types.compliance_resource_type.ComplianceResourceType"
    """<p>Specify the type of resource. <code>ManagedInstance</code> is currently the only supported resource type.</p>"""
    compliance_type: "capo_ssm.types.compliance_type_name.ComplianceTypeName"
    """<p>Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:<code>string</code>.</p>"""
    execution_summary: (
        "capo_ssm.types.compliance_execution_summary.ComplianceExecutionSummary"
    )
    """<p>A summary of the call execution that includes an execution ID, the type of execution (for example, <code>Command</code>), and the date/time of the execution using a datetime object that is saved in the following format: <code>yyyy-MM-dd'T'HH:mm:ss'Z'</code> </p>"""
    items: "capo_ssm.types.compliance_item_entry_list.ComplianceItemEntryList"
    """<p>Information about the compliance as defined by the resource type. For example, for a patch compliance type, <code>Items</code> includes information about the PatchSeverity, Classification, and so on.</p>"""
    item_content_hash: NotRequired[
        "capo_ssm.types.compliance_item_content_hash.ComplianceItemContentHash"
    ]
    """<p>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.</p>"""
    upload_type: NotRequired[
        "capo_ssm.types.compliance_upload_type.ComplianceUploadType"
    ]
    """<p>The mode for uploading compliance items. You can specify <code>COMPLETE</code> or <code>PARTIAL</code>. In <code>COMPLETE</code> 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.</p> <p>In <code>PARTIAL</code> mode, the system overwrites compliance information for a specific association. The association must be configured with <code>SyncCompliance</code> set to <code>MANUAL</code>. By default, all requests use <code>COMPLETE</code> mode.</p> <note> <p>This attribute is only valid for association compliance.</p> </note>"""

compliance_type instance-attribute

compliance_type: ComplianceTypeName

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

execution_summary instance-attribute

execution_summary: ComplianceExecutionSummary

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'

item_content_hash instance-attribute

item_content_hash: NotRequired[ComplianceItemContentHash]

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.

items instance-attribute

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.

resource_id instance-attribute

resource_id: ComplianceResourceId

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

resource_type instance-attribute

resource_type: ComplianceResourceType

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

upload_type instance-attribute

upload_type: NotRequired[ComplianceUploadType]

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.