Skip to content

DescribeKey

Source: src/AWS/KMS/DescribeKey.ts

Runtime binding for kms:DescribeKey.

Bind this operation to a KMS Key (or the alias/... name of a pre-existing key) to get a callable that automatically injects the KeyId. Useful at runtime to discover a key’s state, spec, and supported algorithms before choosing a cryptographic operation.

const describeKey = yield* AWS.KMS.DescribeKey(key);
const { KeyMetadata } = yield* describeKey();
// KeyMetadata.KeyState, KeyMetadata.KeySpec, ...