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
Usage
Code samples can be found in Examples.
KMSClient
Type annotations and code completion for boto3.client("kms")
as KMSClient
boto3 documentation
Usage example
from boto3.session import Session
from mypy_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("...")
.
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"))
- DescribeCustomKeyStoresPaginator
- ListAliasesPaginator
- ListGrantsPaginator
- ListKeyPoliciesPaginator
- ListKeysPaginator
- ListResourceTagsPaginator
- ListRetirableGrantsPaginator
Literals
Type annotations for literals used in methods and schemas.
Usage example
from mypy_boto3_kms.literals import AlgorithmSpecType
def get_value() -> AlgorithmSpecType:
return "RSAES_OAEP_SHA_1"
- AlgorithmSpecType
- ConnectionErrorCodeTypeType
- ConnectionStateTypeType
- CustomKeyStoreTypeType
- CustomerMasterKeySpecType
- DataKeyPairSpecType
- DataKeySpecType
- DescribeCustomKeyStoresPaginatorName
- EncryptionAlgorithmSpecType
- ExpirationModelTypeType
- GrantOperationType
- KeyManagerTypeType
- KeySpecType
- KeyStateType
- KeyUsageTypeType
- ListAliasesPaginatorName
- ListGrantsPaginatorName
- ListKeyPoliciesPaginatorName
- ListKeysPaginatorName
- ListResourceTagsPaginatorName
- ListRetirableGrantsPaginatorName
- MacAlgorithmSpecType
- MessageTypeType
- MultiRegionKeyTypeType
- OriginTypeType
- SigningAlgorithmSpecType
- WrappingKeySpecType
- XksProxyConnectivityTypeType
- KMSServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_kms.type_defs import AliasListEntryTypeDef
def get_value() -> AliasListEntryTypeDef:
return {
"AliasName": ...,
}
- AliasListEntryTypeDef
- CancelKeyDeletionRequestRequestTypeDef
- ResponseMetadataTypeDef
- ConnectCustomKeyStoreRequestRequestTypeDef
- CreateAliasRequestRequestTypeDef
- XksProxyAuthenticationCredentialTypeTypeDef
- GrantConstraintsTypeDef
- TagTypeDef
- XksProxyConfigurationTypeTypeDef
- DecryptRequestRequestTypeDef
- DeleteAliasRequestRequestTypeDef
- DeleteCustomKeyStoreRequestRequestTypeDef
- DeleteImportedKeyMaterialRequestRequestTypeDef
- PaginatorConfigTypeDef
- DescribeCustomKeyStoresRequestRequestTypeDef
- DescribeKeyRequestRequestTypeDef
- DisableKeyRequestRequestTypeDef
- DisableKeyRotationRequestRequestTypeDef
- DisconnectCustomKeyStoreRequestRequestTypeDef
- EnableKeyRequestRequestTypeDef
- EnableKeyRotationRequestRequestTypeDef
- EncryptRequestRequestTypeDef
- GenerateDataKeyPairRequestRequestTypeDef
- GenerateDataKeyPairWithoutPlaintextRequestRequestTypeDef
- GenerateDataKeyRequestRequestTypeDef
- GenerateDataKeyWithoutPlaintextRequestRequestTypeDef
- GenerateMacRequestRequestTypeDef
- GenerateRandomRequestRequestTypeDef
- GetKeyPolicyRequestRequestTypeDef
- GetKeyRotationStatusRequestRequestTypeDef
- GetParametersForImportRequestRequestTypeDef
- GetPublicKeyRequestRequestTypeDef
- ImportKeyMaterialRequestRequestTypeDef
- KeyListEntryTypeDef
- XksKeyConfigurationTypeTypeDef
- ListAliasesRequestRequestTypeDef
- ListGrantsRequestRequestTypeDef
- ListKeyPoliciesRequestRequestTypeDef
- ListKeysRequestRequestTypeDef
- ListResourceTagsRequestRequestTypeDef
- ListRetirableGrantsRequestRequestTypeDef
- MultiRegionKeyTypeDef
- PutKeyPolicyRequestRequestTypeDef
- ReEncryptRequestRequestTypeDef
- RetireGrantRequestRequestTypeDef
- RevokeGrantRequestRequestTypeDef
- ScheduleKeyDeletionRequestRequestTypeDef
- SignRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateAliasRequestRequestTypeDef
- UpdateKeyDescriptionRequestRequestTypeDef
- UpdatePrimaryRegionRequestRequestTypeDef
- VerifyMacRequestRequestTypeDef
- VerifyRequestRequestTypeDef
- CancelKeyDeletionResponseTypeDef
- CreateCustomKeyStoreResponseTypeDef
- CreateGrantResponseTypeDef
- DecryptResponseTypeDef
- EmptyResponseMetadataTypeDef
- EncryptResponseTypeDef
- GenerateDataKeyPairResponseTypeDef
- GenerateDataKeyPairWithoutPlaintextResponseTypeDef
- GenerateDataKeyResponseTypeDef
- GenerateDataKeyWithoutPlaintextResponseTypeDef
- GenerateMacResponseTypeDef
- GenerateRandomResponseTypeDef
- GetKeyPolicyResponseTypeDef
- GetKeyRotationStatusResponseTypeDef
- GetParametersForImportResponseTypeDef
- GetPublicKeyResponseTypeDef
- ListAliasesResponseTypeDef
- ListKeyPoliciesResponseTypeDef
- ReEncryptResponseTypeDef
- ScheduleKeyDeletionResponseTypeDef
- SignResponseTypeDef
- VerifyMacResponseTypeDef
- VerifyResponseTypeDef
- CreateCustomKeyStoreRequestRequestTypeDef
- UpdateCustomKeyStoreRequestRequestTypeDef
- CreateGrantRequestRequestTypeDef
- GrantListEntryTypeDef
- CreateKeyRequestRequestTypeDef
- ListResourceTagsResponseTypeDef
- ReplicateKeyRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- CustomKeyStoresListEntryTypeDef
- DescribeCustomKeyStoresRequestDescribeCustomKeyStoresPaginateTypeDef
- ListAliasesRequestListAliasesPaginateTypeDef
- ListGrantsRequestListGrantsPaginateTypeDef
- ListKeyPoliciesRequestListKeyPoliciesPaginateTypeDef
- ListKeysRequestListKeysPaginateTypeDef
- ListResourceTagsRequestListResourceTagsPaginateTypeDef
- ListRetirableGrantsRequestListRetirableGrantsPaginateTypeDef
- ListKeysResponseTypeDef
- MultiRegionConfigurationTypeDef
- ListGrantsResponseTypeDef
- DescribeCustomKeyStoresResponseTypeDef
- KeyMetadataTypeDef
- CreateKeyResponseTypeDef
- DescribeKeyResponseTypeDef
- ReplicateKeyResponseTypeDef