KMSClient on Grafana Labs

generateDataKey

Mon, 21 Sep 2026 15:16:28 +0000

generateDataKey

KMSClient.generateDataKey generates a symmetric data key for use outside of the AWS Key Management Service.

Parameters

Name	Type	Description
`id`	string	The identifier of the key. This can be either the key ID or the Amazon Resource Name (ARN) of the key.
`size`	number	The length of the data key. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 256-bit (32-byte) data keys, use the value 32, instead.

Returns

Type	Description
Promise< KMSDataKey>	A Promise that fulfills with a KMSDataKey object.

Example

import exec from 'k6/execution';

import {
  AWSConfig,
  KMSClient,
} from 'https://jslib.k6.io/aws/0.14.0/kms.js';

const awsConfig = new AWSConfig({
  region: __ENV.AWS_REGION,
  accessKeyId: __ENV.AWS_ACCESS_KEY_ID,
  secretAccessKey: __ENV.AWS_SECRET_ACCESS_KEY,
});

const kms = new KMSClient(awsConfig);
const testKeyId = 'e67f95-4c047567-4-a0b7-62f7ce8ec8f48';

export default async function () {
  // List the KMS keys the AWS authentication configuration
  // gives us access to.
  const keys = await kms.listKeys();

  // If our test key does not exist, abort the execution.
  if (keys.filter((b) => b.keyId === testKeyId).length == 0) {
    exec.test.abort();
  }

  // Generate a data key from the KMS key.
  const key = await kms.generateDataKey(testKeyId, 32);
}

A k6 script that generating a data key from an AWS Key Management Service key

listKeys

Mon, 21 Sep 2026 15:16:28 +0000

listKeys

KMSClient.listKeys() lists all the Key Management Service keys in the caller’s AWS account and region.

Returns

Type	Description
Promise< KMSKey[]>	A Promise that fulfills with an array of `KMSKey` objects.

Example

import exec from 'k6/execution';

import {
  AWSConfig,
  KMSClient,
} from 'https://jslib.k6.io/aws/0.14.0/kms.js';

const awsConfig = new AWSConfig({
  region: __ENV.AWS_REGION,
  accessKeyId: __ENV.AWS_ACCESS_KEY_ID,
  secretAccessKey: __ENV.AWS_SECRET_ACCESS_KEY,
});

const kms = new KMSClient(awsConfig);
const testKeyId = 'e67f95-4c047567-4-a0b7-62f7ce8ec8f48';

export default async function () {
  // List the KMS keys the AWS authentication configuration
  // gives us access to.
  const keys = await kms.listKeys();

  // If our test key does not exist, abort the execution.
  if (keys.filter((b) => b.keyId === testKeyId).length == 0) {
    exec.test.abort();
  }
}

A k6 script querying the user’s Key Management Service keys and verifying their test key exists

KMSDataKey

Mon, 21 Sep 2026 15:16:28 +0000

KMSDataKey

KMSClient.*DataKey methods, querying Key Management Service data keys, return some KMSDataKey instances. The KMSDataKey object describes an Amazon Key Management Service data key. For instance, the generateDataKey returns the generated KMSDataKey object.

Name	Type	Description
`KMSDataKey.id`	string	The identifier of the Key Management Service key that encrypted the data key.
`KMSDataKey.ciphertextBlob`	string	The base64-encoded encrypted copy of the data key.
`KMSDataKey.plaintext`	string	The plain text data key. Use this data key to encrypt your data outside of Key Management Service. Then, remove it from memory as soon as possible.

Example

import exec from 'k6/execution';

import {
  AWSConfig,
  KMSClient,
} from 'https://jslib.k6.io/aws/0.14.0/kms.js';

const awsConfig = new AWSConfig({
  region: __ENV.AWS_REGION,
  accessKeyId: __ENV.AWS_ACCESS_KEY_ID,
  secretAccessKey: __ENV.AWS_SECRET_ACCESS_KEY,
});

const kms = new KMSClient(awsConfig);
const testKeyId = 'e67f95-4c047567-4-a0b7-62f7ce8ec8f48';

export default async function () {
  // List the KMS keys the AWS authentication configuration
  // gives us access to.
  const keys = await kms.listKeys();

  // If our test key does not exist, abort the execution.
  if (keys.filter((b) => b.keyId === testKeyId).length == 0) {
    exec.test.abort();
  }

  // Generate a data key from the KMS key.
  const key = await kms.generateDataKey(testKeyId, 32);
}

A k6 script that generating a data key from an AWS Key Management Service key

KMSKey

Mon, 21 Sep 2026 15:16:28 +0000

KMSKey

KMSClient.* methods querying Key Management Service keys return some KMSKey instances. Namely, listKeys() returns an array of KMSKey objects. The KMSKey object describes an Amazon Key Management Service key.

Name	Type	Description
`KMSKey.keyId`	string	Unique identifier of the key
`KMSKey.keyArn`	string	ARN of the key

Example

import exec from 'k6/execution';

import {
  AWSConfig,
  KMSClient,
} from 'https://jslib.k6.io/aws/0.14.0/kms.js';

const awsConfig = new AWSConfig({
  region: __ENV.AWS_REGION,
  accessKeyId: __ENV.AWS_ACCESS_KEY_ID,
  secretAccessKey: __ENV.AWS_SECRET_ACCESS_KEY,
});

const kms = new KMSClient(awsConfig);
const testKeyId = 'e67f95-4c047567-4-a0b7-62f7ce8ec8f48';

export default async function () {
  // List the KMS keys the AWS authentication configuration
  // gives us access to.
  const keys = await kms.listKeys();

  // If our test key does not exist, abort the execution.
  if (keys.filter((b) => b.keyId === testKeyId).length == 0) {
    exec.test.abort();
  }
}

A k6 script querying the user’s Key Management Service keys and verifying their test key exists