Skip to content

Examples#

Index > KMS > Examples

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

Client#

Implicit type annotations#

Can be used with boto3-stubs[kms] package installed.

Write your KMS code as usual, type checking and code completion should work out of the box.

# KMSClient usage example

from boto3.session import Session


session = Session()

client = session.client("kms")  # (1)
result = client.cancel_key_deletion()  # (2)
  1. client: KMSClient
  2. result: CancelKeyDeletionResponseTypeDef
# DescribeCustomKeyStoresPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("kms")  # (1)

paginator = client.get_paginator("describe_custom_key_stores")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KMSClient
  2. paginator: DescribeCustomKeyStoresPaginator
  3. item: DescribeCustomKeyStoresResponseTypeDef

Explicit type annotations#

With boto3-stubs-lite[kms] or a standalone mypy_boto3_kms package, you have to explicitly specify client: KMSClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# KMSClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_kms.client import KMSClient
from mypy_boto3_kms.type_defs import CancelKeyDeletionResponseTypeDef
from mypy_boto3_kms.type_defs import CancelKeyDeletionRequestRequestTypeDef


session = Session()

client: KMSClient = session.client("kms")

kwargs: CancelKeyDeletionRequestRequestTypeDef = {...}
result: CancelKeyDeletionResponseTypeDef = client.cancel_key_deletion(**kwargs)
# DescribeCustomKeyStoresPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_kms.client import KMSClient
from mypy_boto3_kms.paginator import DescribeCustomKeyStoresPaginator
from mypy_boto3_kms.type_defs import DescribeCustomKeyStoresResponseTypeDef


session = Session()
client: KMSClient = session.client("kms")

paginator: DescribeCustomKeyStoresPaginator = client.get_paginator("describe_custom_key_stores")
for item in paginator.paginate(...):
    item: DescribeCustomKeyStoresResponseTypeDef
    print(item)