put_compliance_items ¶

def put_compliance_items(
    self,
    resource_id: "capo_ssm.types.compliance_resource_id.ComplianceResourceId",
    resource_type: "capo_ssm.types.compliance_resource_type.ComplianceResourceType",
    compliance_type: "capo_ssm.types.compliance_type_name.ComplianceTypeName",
    execution_summary: "capo_ssm.types.compliance_execution_summary.ComplianceExecutionSummary",
    items: "capo_ssm.types.compliance_item_entry_list.ComplianceItemEntryList",
    *,
    config_overrides: Optional[SSMClientConfig] = None,
    item_content_hash: Optional[
        "capo_ssm.types.compliance_item_content_hash.ComplianceItemContentHash"
    ] = None,
    upload_type: Optional[
        "capo_ssm.types.compliance_upload_type.ComplianceUploadType"
    ] = None,
) -> "capo_ssm.types.put_compliance_items_result.PutComplianceItemsResult":
    """<p>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.</p> <p>ComplianceType can be one of the following:</p> <ul> <li> <p>ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.</p> </li> <li> <p>ExecutionType: Specify patch, association, or Custom:<code>string</code>.</p> </li> <li> <p>ExecutionTime. The time the patch, association, or custom compliance item was applied to the managed node.</p> <important> <p>For State Manager associations, this represents the time when compliance status was captured by the Systems Manager service during its internal compliance aggregation workflow, not necessarily when the association was executed on the managed node. State Manager updates compliance information for all associations on an instance whenever any association executes, which may result in multiple associations showing the same execution time.</p> </important> </li> <li> <p>Id: The patch, association, or custom compliance ID.</p> </li> <li> <p>Title: A title.</p> </li> <li> <p>Status: The status of the compliance item. For example, <code>approved</code> for patches, or <code>Failed</code> for associations.</p> </li> <li> <p>Severity: A patch severity. For example, <code>Critical</code>.</p> </li> <li> <p>DocumentName: An SSM document name. For example, <code>AWS-RunPatchBaseline</code>.</p> </li> <li> <p>DocumentVersion: An SSM document version number. For example, 4.</p> </li> <li> <p>Classification: A patch classification. For example, <code>security updates</code>.</p> </li> <li> <p>PatchBaselineId: A patch baseline ID.</p> </li> <li> <p>PatchSeverity: A patch severity. For example, <code>Critical</code>.</p> </li> <li> <p>PatchState: A patch state. For example, <code>InstancesWithFailedPatches</code>.</p> </li> <li> <p>PatchGroup: The name of a patch group.</p> </li> <li> <p>InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: <code>yyyy-MM-dd'T'HH:mm:ss'Z'</code> </p> </li> </ul>

    Args:
        resource_id: <p>Specify an ID for this resource. For a managed node, this is the node ID.</p>
        resource_type: <p>Specify the type of resource. <code>ManagedInstance</code> is currently the only supported resource type.</p>
        compliance_type: <p>Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:<code>string</code>.</p>
        execution_summary: <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: <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: <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: <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>

    Raises:
        capo_ssm.errors.compliance_type_count_limit_exceeded_exception.ComplianceTypeCountLimitExceededException: <p>You specified too many custom compliance types. You can specify a maximum of 10 different types. </p>
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.invalid_item_content_exception.InvalidItemContentException: <p>One or more content items isn't valid.</p>
        capo_ssm.errors.invalid_resource_id.InvalidResourceId: <p>The resource ID isn't valid. Verify that you entered the correct ID and try again.</p>
        capo_ssm.errors.invalid_resource_type.InvalidResourceType: <p>The resource type isn't valid. For example, if you are attempting to tag an EC2 instance, the instance must be a registered managed node.</p>
        capo_ssm.errors.item_size_limit_exceeded_exception.ItemSizeLimitExceededException: <p>The inventory item size has exceeded the size limit.</p>
        capo_ssm.errors.total_size_limit_exceeded_exception.TotalSizeLimitExceededException: <p>The size of inventory data has exceeded the total size limit for the resource.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.put_compliance_items_request.PutComplianceItemsRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.put_compliance_items_result.PutComplianceItemsResult"
    ]:
        import capo_ssm._operations.amazon_ssm.put_compliance_items

        output, http_response = (
            capo_ssm._operations.amazon_ssm.put_compliance_items.put_compliance_items(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutComplianceItems")
    )
    input_: capo_ssm.types.put_compliance_items_request.PutComplianceItemsRequest = {
        "resource_id": resource_id,
        "resource_type": resource_type,
        "compliance_type": compliance_type,
        "execution_summary": execution_summary,
        "items": items,
    }
    if item_content_hash is not None:
        input_["item_content_hash"] = item_content_hash
    if upload_type is not None:
        input_["upload_type"] = upload_type

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output