putComplianceItems method

Future<void> putComplianceItems({ required String complianceType, required ComplianceExecutionSummary executionSummary, required List<ComplianceItemEntry> items, required String resourceId, required String resourceType, String? itemContentHash, ComplianceUploadType? uploadType, })

Registers a compliance type and other compliance details on a designated resource. This action 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 instance.
• 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: A 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'

May throw InternalServerError. May throw InvalidItemContentException. May throw TotalSizeLimitExceededException. May throw ItemSizeLimitExceededException. May throw ComplianceTypeCountLimitExceededException. May throw InvalidResourceType. May throw InvalidResourceId.

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

Parameter executionSummary : 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'.

Parameter items : 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.

Parameter resourceId : Specify an ID for this resource. For a managed instance, this is the instance ID.

Parameter resourceType : Specify the type of resource. ManagedInstance is currently the only supported resource type.

Parameter itemContentHash : 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.

Parameter uploadType : 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.

Implementation

Future<void> putComplianceItems({
  required String complianceType,
  required ComplianceExecutionSummary executionSummary,
  required List<ComplianceItemEntry> items,
  required String resourceId,
  required String resourceType,
  String? itemContentHash,
  ComplianceUploadType? uploadType,
}) async {
  ArgumentError.checkNotNull(complianceType, 'complianceType');
  _s.validateStringLength(
    'complianceType',
    complianceType,
    1,
    100,
    isRequired: true,
  );
  ArgumentError.checkNotNull(executionSummary, 'executionSummary');
  ArgumentError.checkNotNull(items, 'items');
  ArgumentError.checkNotNull(resourceId, 'resourceId');
  _s.validateStringLength(
    'resourceId',
    resourceId,
    1,
    100,
    isRequired: true,
  );
  ArgumentError.checkNotNull(resourceType, 'resourceType');
  _s.validateStringLength(
    'resourceType',
    resourceType,
    1,
    50,
    isRequired: true,
  );
  _s.validateStringLength(
    'itemContentHash',
    itemContentHash,
    0,
    256,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonSSM.PutComplianceItems'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'ComplianceType': complianceType,
      'ExecutionSummary': executionSummary,
      'Items': items,
      'ResourceId': resourceId,
      'ResourceType': resourceType,
      if (itemContentHash != null) 'ItemContentHash': itemContentHash,
      if (uploadType != null) 'UploadType': uploadType.toValue(),
    },
  );
}