Skip to content

KMS module#

Index > KMS

Auto-generated documentation for KMS type annotations stubs module types-boto3-kms.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.36.26' mypy-boto3-builder
  2. Select boto3 AWS SDK.
  3. Add KMS service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and KMS.

From PyPI with pip#

Install types-boto3 for KMS service.

# install with boto3 type annotations
python -m pip install 'types-boto3[kms]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[kms]'

# standalone installation
python -m pip install types-boto3-kms

How to uninstall#

python -m pip uninstall -y types-boto3-kms

Usage#

Code samples can be found in Examples.

KMSClient#

Type annotations and code completion for boto3.client("kms") as KMSClient boto3 documentation

# KMSClient usage example

from boto3.session import Session

from types_boto3_kms.client import KMSClient

def get_client() -> KMSClient:
    return Session().client("kms")

Paginators#

Type annotations and code completion for paginators from boto3.client("kms").get_paginator("...").

# DescribeCustomKeyStoresPaginator usage example

from boto3.session import Session

from types_boto3_kms.paginator import DescribeCustomKeyStoresPaginator

def get_describe_custom_key_stores_paginator() -> DescribeCustomKeyStoresPaginator:
    return Session().client("kms").get_paginator("describe_custom_key_stores"))

Literals#

Type annotations for literals used in methods and schema.

# AlgorithmSpecType usage example

from types_boto3_kms.literals import AlgorithmSpecType

def get_value() -> AlgorithmSpecType:
    return "RSAES_OAEP_SHA_1"

Type definitions#

Type annotations for type definitions used in methods and schema.