JavaScript admin.groupGetS3ServerSideEncryptionKmsKey

admin:group-get-s3-server-side-encryption-kms-key

admin:group-get-s3-server-side-encryption-kms-key(
   $config as element(configuration),
   $group-id as xs:unsignedLong
) as xs:string

Summary

This function gets the KMS key that is used by server side encryption for data at rest on the simple storage service. This key will only be used when the server side encryption method is "aws:kms".

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
group-id	The ID of the group. Typically, this is the result of an `admin:group-get-id` call.

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/group

http://marklogic.com/xdmp/privileges/admin/group/{id}

Example


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  let $groupid := admin:group-get-id($config, "Default")
  return admin:group-get-s3-server-side-encryption-kms-key($config, $groupid)
  ==> "f4cefc8d-f64d-4fd1-8e93-064db9c26968"