Skip to content

KMS module#

Index > KMS

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

How to install#

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 boto3-stubs for KMS service.

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

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

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

How to uninstall#

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


Code samples can be found in Examples.


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

# KMSClient usage example

from boto3.session import Session

from mypy_boto3_kms.client import KMSClient

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


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

# DescribeCustomKeyStoresPaginator usage example

from boto3.session import Session

from mypy_boto3_kms.paginator import DescribeCustomKeyStoresPaginator

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


Type annotations for literals used in methods and schemas.

# AlgorithmSpecType usage example

from mypy_boto3_kms.literals import AlgorithmSpecType

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

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AliasListEntryTypeDef usage example

from mypy_boto3_kms.type_defs import AliasListEntryTypeDef

def get_value() -> AliasListEntryTypeDef:
    return {
        "AliasName": ...,