AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Module: Aws::KMS

Defined in:


This module provides a client for making API requests to AWS Key Management Service.


The Client class provides one-to-one mapping for each API operation.

kms = 'us-east-1')
#=> [:cancel_key_deletion, :connect_custom_key_store, :create_alias, :create_custom_key_store, ...]

Each API operation method accepts a hash of request parameters and returns a response object.

resp = kms.cancel_key_deletion(params)

See Client for more information.


Errors returned from AWS Key Management Service are defined in the Errors module and extend Errors::ServiceError.

  # do stuff
rescue Aws::KMS::Errors::ServiceError
  # rescues all errors returned by AWS Key Management Service

See Errors for more information.

Defined Under Namespace

Modules: Errors, Types Classes: Client