Type definitions

Index > KMS > Type definitions

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

BlobTypeDef

# BlobTypeDef Union usage example

from mypy_boto3_kms.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    botocore.response.StreamingBody,
]

TimestampTypeDef

# TimestampTypeDef Union usage example

from mypy_boto3_kms.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

GrantConstraintsUnionTypeDef

# GrantConstraintsUnionTypeDef Union usage example

from mypy_boto3_kms.type_defs import GrantConstraintsUnionTypeDef


def get_value() -> GrantConstraintsUnionTypeDef:
    return ...


# GrantConstraintsUnionTypeDef definition

GrantConstraintsUnionTypeDef = Union[
    GrantConstraintsTypeDef,  # (1)
    GrantConstraintsOutputTypeDef,  # (2)
]

1. See GrantConstraintsTypeDef
2. See GrantConstraintsOutputTypeDef

AliasListEntryTypeDef

# AliasListEntryTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import AliasListEntryTypeDef


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


# AliasListEntryTypeDef definition

class AliasListEntryTypeDef(TypedDict):
    AliasName: NotRequired[str],
    AliasArn: NotRequired[str],
    TargetKeyId: NotRequired[str],
    CreationDate: NotRequired[datetime.datetime],
    LastUpdatedDate: NotRequired[datetime.datetime],

CancelKeyDeletionRequestTypeDef

# CancelKeyDeletionRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import CancelKeyDeletionRequestTypeDef


def get_value() -> CancelKeyDeletionRequestTypeDef:
    return {
        "KeyId": ...,
    }


# CancelKeyDeletionRequestTypeDef definition

class CancelKeyDeletionRequestTypeDef(TypedDict):
    KeyId: str,

ResponseMetadataTypeDef

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

ConnectCustomKeyStoreRequestTypeDef

# ConnectCustomKeyStoreRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ConnectCustomKeyStoreRequestTypeDef


def get_value() -> ConnectCustomKeyStoreRequestTypeDef:
    return {
        "CustomKeyStoreId": ...,
    }


# ConnectCustomKeyStoreRequestTypeDef definition

class ConnectCustomKeyStoreRequestTypeDef(TypedDict):
    CustomKeyStoreId: str,

CreateAliasRequestTypeDef

# CreateAliasRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import CreateAliasRequestTypeDef


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


# CreateAliasRequestTypeDef definition

class CreateAliasRequestTypeDef(TypedDict):
    AliasName: str,
    TargetKeyId: str,

XksProxyAuthenticationCredentialTypeTypeDef

# XksProxyAuthenticationCredentialTypeTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import XksProxyAuthenticationCredentialTypeTypeDef


def get_value() -> XksProxyAuthenticationCredentialTypeTypeDef:
    return {
        "AccessKeyId": ...,
    }


# XksProxyAuthenticationCredentialTypeTypeDef definition

class XksProxyAuthenticationCredentialTypeTypeDef(TypedDict):
    AccessKeyId: str,
    RawSecretAccessKey: str,

TagTypeDef

# TagTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import TagTypeDef


def get_value() -> TagTypeDef:
    return {
        "TagKey": ...,
    }


# TagTypeDef definition

class TagTypeDef(TypedDict):
    TagKey: str,
    TagValue: str,

XksProxyConfigurationTypeTypeDef

# XksProxyConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import XksProxyConfigurationTypeTypeDef


def get_value() -> XksProxyConfigurationTypeTypeDef:
    return {
        "Connectivity": ...,
    }


# XksProxyConfigurationTypeTypeDef definition

class XksProxyConfigurationTypeTypeDef(TypedDict):
    Connectivity: NotRequired[XksProxyConnectivityTypeType],  # (1)
    AccessKeyId: NotRequired[str],
    UriEndpoint: NotRequired[str],
    UriPath: NotRequired[str],
    VpcEndpointServiceName: NotRequired[str],

1. See XksProxyConnectivityTypeType

DeleteAliasRequestTypeDef

# DeleteAliasRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import DeleteAliasRequestTypeDef


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


# DeleteAliasRequestTypeDef definition

class DeleteAliasRequestTypeDef(TypedDict):
    AliasName: str,

DeleteCustomKeyStoreRequestTypeDef

# DeleteCustomKeyStoreRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import DeleteCustomKeyStoreRequestTypeDef


def get_value() -> DeleteCustomKeyStoreRequestTypeDef:
    return {
        "CustomKeyStoreId": ...,
    }


# DeleteCustomKeyStoreRequestTypeDef definition

class DeleteCustomKeyStoreRequestTypeDef(TypedDict):
    CustomKeyStoreId: str,

DeleteImportedKeyMaterialRequestTypeDef

# DeleteImportedKeyMaterialRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import DeleteImportedKeyMaterialRequestTypeDef


def get_value() -> DeleteImportedKeyMaterialRequestTypeDef:
    return {
        "KeyId": ...,
    }


# DeleteImportedKeyMaterialRequestTypeDef definition

class DeleteImportedKeyMaterialRequestTypeDef(TypedDict):
    KeyId: str,

PaginatorConfigTypeDef

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeCustomKeyStoresRequestTypeDef

# DescribeCustomKeyStoresRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import DescribeCustomKeyStoresRequestTypeDef


def get_value() -> DescribeCustomKeyStoresRequestTypeDef:
    return {
        "CustomKeyStoreId": ...,
    }


# DescribeCustomKeyStoresRequestTypeDef definition

class DescribeCustomKeyStoresRequestTypeDef(TypedDict):
    CustomKeyStoreId: NotRequired[str],
    CustomKeyStoreName: NotRequired[str],
    Limit: NotRequired[int],
    Marker: NotRequired[str],

DescribeKeyRequestTypeDef

# DescribeKeyRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import DescribeKeyRequestTypeDef


def get_value() -> DescribeKeyRequestTypeDef:
    return {
        "KeyId": ...,
    }


# DescribeKeyRequestTypeDef definition

class DescribeKeyRequestTypeDef(TypedDict):
    KeyId: str,
    GrantTokens: NotRequired[Sequence[str]],

DisableKeyRequestTypeDef

# DisableKeyRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import DisableKeyRequestTypeDef


def get_value() -> DisableKeyRequestTypeDef:
    return {
        "KeyId": ...,
    }


# DisableKeyRequestTypeDef definition

class DisableKeyRequestTypeDef(TypedDict):
    KeyId: str,

DisableKeyRotationRequestTypeDef

# DisableKeyRotationRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import DisableKeyRotationRequestTypeDef


def get_value() -> DisableKeyRotationRequestTypeDef:
    return {
        "KeyId": ...,
    }


# DisableKeyRotationRequestTypeDef definition

class DisableKeyRotationRequestTypeDef(TypedDict):
    KeyId: str,

DisconnectCustomKeyStoreRequestTypeDef

# DisconnectCustomKeyStoreRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import DisconnectCustomKeyStoreRequestTypeDef


def get_value() -> DisconnectCustomKeyStoreRequestTypeDef:
    return {
        "CustomKeyStoreId": ...,
    }


# DisconnectCustomKeyStoreRequestTypeDef definition

class DisconnectCustomKeyStoreRequestTypeDef(TypedDict):
    CustomKeyStoreId: str,

EnableKeyRequestTypeDef

# EnableKeyRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import EnableKeyRequestTypeDef


def get_value() -> EnableKeyRequestTypeDef:
    return {
        "KeyId": ...,
    }


# EnableKeyRequestTypeDef definition

class EnableKeyRequestTypeDef(TypedDict):
    KeyId: str,

EnableKeyRotationRequestTypeDef

# EnableKeyRotationRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import EnableKeyRotationRequestTypeDef


def get_value() -> EnableKeyRotationRequestTypeDef:
    return {
        "KeyId": ...,
    }


# EnableKeyRotationRequestTypeDef definition

class EnableKeyRotationRequestTypeDef(TypedDict):
    KeyId: str,
    RotationPeriodInDays: NotRequired[int],

GenerateDataKeyPairWithoutPlaintextRequestTypeDef

# GenerateDataKeyPairWithoutPlaintextRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GenerateDataKeyPairWithoutPlaintextRequestTypeDef


def get_value() -> GenerateDataKeyPairWithoutPlaintextRequestTypeDef:
    return {
        "KeyId": ...,
    }


# GenerateDataKeyPairWithoutPlaintextRequestTypeDef definition

class GenerateDataKeyPairWithoutPlaintextRequestTypeDef(TypedDict):
    KeyId: str,
    KeyPairSpec: DataKeyPairSpecType,  # (1)
    EncryptionContext: NotRequired[Mapping[str, str]],
    GrantTokens: NotRequired[Sequence[str]],
    DryRun: NotRequired[bool],

1. See DataKeyPairSpecType

GenerateDataKeyWithoutPlaintextRequestTypeDef

# GenerateDataKeyWithoutPlaintextRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GenerateDataKeyWithoutPlaintextRequestTypeDef


def get_value() -> GenerateDataKeyWithoutPlaintextRequestTypeDef:
    return {
        "KeyId": ...,
    }


# GenerateDataKeyWithoutPlaintextRequestTypeDef definition

class GenerateDataKeyWithoutPlaintextRequestTypeDef(TypedDict):
    KeyId: str,
    EncryptionContext: NotRequired[Mapping[str, str]],
    KeySpec: NotRequired[DataKeySpecType],  # (1)
    NumberOfBytes: NotRequired[int],
    GrantTokens: NotRequired[Sequence[str]],
    DryRun: NotRequired[bool],

1. See DataKeySpecType

GetKeyPolicyRequestTypeDef

# GetKeyPolicyRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GetKeyPolicyRequestTypeDef


def get_value() -> GetKeyPolicyRequestTypeDef:
    return {
        "KeyId": ...,
    }


# GetKeyPolicyRequestTypeDef definition

class GetKeyPolicyRequestTypeDef(TypedDict):
    KeyId: str,
    PolicyName: NotRequired[str],

GetKeyRotationStatusRequestTypeDef

# GetKeyRotationStatusRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GetKeyRotationStatusRequestTypeDef


def get_value() -> GetKeyRotationStatusRequestTypeDef:
    return {
        "KeyId": ...,
    }


# GetKeyRotationStatusRequestTypeDef definition

class GetKeyRotationStatusRequestTypeDef(TypedDict):
    KeyId: str,

GetParametersForImportRequestTypeDef

# GetParametersForImportRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GetParametersForImportRequestTypeDef


def get_value() -> GetParametersForImportRequestTypeDef:
    return {
        "KeyId": ...,
    }


# GetParametersForImportRequestTypeDef definition

class GetParametersForImportRequestTypeDef(TypedDict):
    KeyId: str,
    WrappingAlgorithm: AlgorithmSpecType,  # (1)
    WrappingKeySpec: WrappingKeySpecType,  # (2)

1. See AlgorithmSpecType
2. See WrappingKeySpecType

GetPublicKeyRequestTypeDef

# GetPublicKeyRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GetPublicKeyRequestTypeDef


def get_value() -> GetPublicKeyRequestTypeDef:
    return {
        "KeyId": ...,
    }


# GetPublicKeyRequestTypeDef definition

class GetPublicKeyRequestTypeDef(TypedDict):
    KeyId: str,
    GrantTokens: NotRequired[Sequence[str]],

GrantConstraintsOutputTypeDef

# GrantConstraintsOutputTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GrantConstraintsOutputTypeDef


def get_value() -> GrantConstraintsOutputTypeDef:
    return {
        "EncryptionContextSubset": ...,
    }


# GrantConstraintsOutputTypeDef definition

class GrantConstraintsOutputTypeDef(TypedDict):
    EncryptionContextSubset: NotRequired[Dict[str, str]],
    EncryptionContextEquals: NotRequired[Dict[str, str]],

GrantConstraintsTypeDef

# GrantConstraintsTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GrantConstraintsTypeDef


def get_value() -> GrantConstraintsTypeDef:
    return {
        "EncryptionContextSubset": ...,
    }


# GrantConstraintsTypeDef definition

class GrantConstraintsTypeDef(TypedDict):
    EncryptionContextSubset: NotRequired[Mapping[str, str]],
    EncryptionContextEquals: NotRequired[Mapping[str, str]],

KeyListEntryTypeDef

# KeyListEntryTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import KeyListEntryTypeDef


def get_value() -> KeyListEntryTypeDef:
    return {
        "KeyId": ...,
    }


# KeyListEntryTypeDef definition

class KeyListEntryTypeDef(TypedDict):
    KeyId: NotRequired[str],
    KeyArn: NotRequired[str],

XksKeyConfigurationTypeTypeDef

# XksKeyConfigurationTypeTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import XksKeyConfigurationTypeTypeDef


def get_value() -> XksKeyConfigurationTypeTypeDef:
    return {
        "Id": ...,
    }


# XksKeyConfigurationTypeTypeDef definition

class XksKeyConfigurationTypeTypeDef(TypedDict):
    Id: NotRequired[str],

ListAliasesRequestTypeDef

# ListAliasesRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListAliasesRequestTypeDef


def get_value() -> ListAliasesRequestTypeDef:
    return {
        "KeyId": ...,
    }


# ListAliasesRequestTypeDef definition

class ListAliasesRequestTypeDef(TypedDict):
    KeyId: NotRequired[str],
    Limit: NotRequired[int],
    Marker: NotRequired[str],

ListGrantsRequestTypeDef

# ListGrantsRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListGrantsRequestTypeDef


def get_value() -> ListGrantsRequestTypeDef:
    return {
        "KeyId": ...,
    }


# ListGrantsRequestTypeDef definition

class ListGrantsRequestTypeDef(TypedDict):
    KeyId: str,
    Limit: NotRequired[int],
    Marker: NotRequired[str],
    GrantId: NotRequired[str],
    GranteePrincipal: NotRequired[str],

ListKeyPoliciesRequestTypeDef

# ListKeyPoliciesRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListKeyPoliciesRequestTypeDef


def get_value() -> ListKeyPoliciesRequestTypeDef:
    return {
        "KeyId": ...,
    }


# ListKeyPoliciesRequestTypeDef definition

class ListKeyPoliciesRequestTypeDef(TypedDict):
    KeyId: str,
    Limit: NotRequired[int],
    Marker: NotRequired[str],

ListKeyRotationsRequestTypeDef

# ListKeyRotationsRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListKeyRotationsRequestTypeDef


def get_value() -> ListKeyRotationsRequestTypeDef:
    return {
        "KeyId": ...,
    }


# ListKeyRotationsRequestTypeDef definition

class ListKeyRotationsRequestTypeDef(TypedDict):
    KeyId: str,
    Limit: NotRequired[int],
    Marker: NotRequired[str],

RotationsListEntryTypeDef

# RotationsListEntryTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import RotationsListEntryTypeDef


def get_value() -> RotationsListEntryTypeDef:
    return {
        "KeyId": ...,
    }


# RotationsListEntryTypeDef definition

class RotationsListEntryTypeDef(TypedDict):
    KeyId: NotRequired[str],
    RotationDate: NotRequired[datetime.datetime],
    RotationType: NotRequired[RotationTypeType],  # (1)

1. See RotationTypeType

ListKeysRequestTypeDef

# ListKeysRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListKeysRequestTypeDef


def get_value() -> ListKeysRequestTypeDef:
    return {
        "Limit": ...,
    }


# ListKeysRequestTypeDef definition

class ListKeysRequestTypeDef(TypedDict):
    Limit: NotRequired[int],
    Marker: NotRequired[str],

ListResourceTagsRequestTypeDef

# ListResourceTagsRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListResourceTagsRequestTypeDef


def get_value() -> ListResourceTagsRequestTypeDef:
    return {
        "KeyId": ...,
    }


# ListResourceTagsRequestTypeDef definition

class ListResourceTagsRequestTypeDef(TypedDict):
    KeyId: str,
    Limit: NotRequired[int],
    Marker: NotRequired[str],

ListRetirableGrantsRequestTypeDef

# ListRetirableGrantsRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListRetirableGrantsRequestTypeDef


def get_value() -> ListRetirableGrantsRequestTypeDef:
    return {
        "RetiringPrincipal": ...,
    }


# ListRetirableGrantsRequestTypeDef definition

class ListRetirableGrantsRequestTypeDef(TypedDict):
    RetiringPrincipal: str,
    Limit: NotRequired[int],
    Marker: NotRequired[str],

MultiRegionKeyTypeDef

# MultiRegionKeyTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import MultiRegionKeyTypeDef


def get_value() -> MultiRegionKeyTypeDef:
    return {
        "Arn": ...,
    }


# MultiRegionKeyTypeDef definition

class MultiRegionKeyTypeDef(TypedDict):
    Arn: NotRequired[str],
    Region: NotRequired[str],

PutKeyPolicyRequestTypeDef

# PutKeyPolicyRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import PutKeyPolicyRequestTypeDef


def get_value() -> PutKeyPolicyRequestTypeDef:
    return {
        "KeyId": ...,
    }


# PutKeyPolicyRequestTypeDef definition

class PutKeyPolicyRequestTypeDef(TypedDict):
    KeyId: str,
    Policy: str,
    PolicyName: NotRequired[str],
    BypassPolicyLockoutSafetyCheck: NotRequired[bool],

RetireGrantRequestTypeDef

# RetireGrantRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import RetireGrantRequestTypeDef


def get_value() -> RetireGrantRequestTypeDef:
    return {
        "GrantToken": ...,
    }


# RetireGrantRequestTypeDef definition

class RetireGrantRequestTypeDef(TypedDict):
    GrantToken: NotRequired[str],
    KeyId: NotRequired[str],
    GrantId: NotRequired[str],
    DryRun: NotRequired[bool],

RevokeGrantRequestTypeDef

# RevokeGrantRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import RevokeGrantRequestTypeDef


def get_value() -> RevokeGrantRequestTypeDef:
    return {
        "KeyId": ...,
    }


# RevokeGrantRequestTypeDef definition

class RevokeGrantRequestTypeDef(TypedDict):
    KeyId: str,
    GrantId: str,
    DryRun: NotRequired[bool],

RotateKeyOnDemandRequestTypeDef

# RotateKeyOnDemandRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import RotateKeyOnDemandRequestTypeDef


def get_value() -> RotateKeyOnDemandRequestTypeDef:
    return {
        "KeyId": ...,
    }


# RotateKeyOnDemandRequestTypeDef definition

class RotateKeyOnDemandRequestTypeDef(TypedDict):
    KeyId: str,

ScheduleKeyDeletionRequestTypeDef

# ScheduleKeyDeletionRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ScheduleKeyDeletionRequestTypeDef


def get_value() -> ScheduleKeyDeletionRequestTypeDef:
    return {
        "KeyId": ...,
    }


# ScheduleKeyDeletionRequestTypeDef definition

class ScheduleKeyDeletionRequestTypeDef(TypedDict):
    KeyId: str,
    PendingWindowInDays: NotRequired[int],

UntagResourceRequestTypeDef

# UntagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "KeyId": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    KeyId: str,
    TagKeys: Sequence[str],

UpdateAliasRequestTypeDef

# UpdateAliasRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import UpdateAliasRequestTypeDef


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


# UpdateAliasRequestTypeDef definition

class UpdateAliasRequestTypeDef(TypedDict):
    AliasName: str,
    TargetKeyId: str,

UpdateKeyDescriptionRequestTypeDef

# UpdateKeyDescriptionRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import UpdateKeyDescriptionRequestTypeDef


def get_value() -> UpdateKeyDescriptionRequestTypeDef:
    return {
        "KeyId": ...,
    }


# UpdateKeyDescriptionRequestTypeDef definition

class UpdateKeyDescriptionRequestTypeDef(TypedDict):
    KeyId: str,
    Description: str,

UpdatePrimaryRegionRequestTypeDef

# UpdatePrimaryRegionRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import UpdatePrimaryRegionRequestTypeDef


def get_value() -> UpdatePrimaryRegionRequestTypeDef:
    return {
        "KeyId": ...,
    }


# UpdatePrimaryRegionRequestTypeDef definition

class UpdatePrimaryRegionRequestTypeDef(TypedDict):
    KeyId: str,
    PrimaryRegion: str,

EncryptRequestTypeDef

# EncryptRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import EncryptRequestTypeDef


def get_value() -> EncryptRequestTypeDef:
    return {
        "KeyId": ...,
    }


# EncryptRequestTypeDef definition

class EncryptRequestTypeDef(TypedDict):
    KeyId: str,
    Plaintext: BlobTypeDef,
    EncryptionContext: NotRequired[Mapping[str, str]],
    GrantTokens: NotRequired[Sequence[str]],
    EncryptionAlgorithm: NotRequired[EncryptionAlgorithmSpecType],  # (1)
    DryRun: NotRequired[bool],

1. See EncryptionAlgorithmSpecType

GenerateMacRequestTypeDef

# GenerateMacRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GenerateMacRequestTypeDef


def get_value() -> GenerateMacRequestTypeDef:
    return {
        "Message": ...,
    }


# GenerateMacRequestTypeDef definition

class GenerateMacRequestTypeDef(TypedDict):
    Message: BlobTypeDef,
    KeyId: str,
    MacAlgorithm: MacAlgorithmSpecType,  # (1)
    GrantTokens: NotRequired[Sequence[str]],
    DryRun: NotRequired[bool],

1. See MacAlgorithmSpecType

ReEncryptRequestTypeDef

# ReEncryptRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ReEncryptRequestTypeDef


def get_value() -> ReEncryptRequestTypeDef:
    return {
        "CiphertextBlob": ...,
    }


# ReEncryptRequestTypeDef definition

class ReEncryptRequestTypeDef(TypedDict):
    CiphertextBlob: BlobTypeDef,
    DestinationKeyId: str,
    SourceEncryptionContext: NotRequired[Mapping[str, str]],
    SourceKeyId: NotRequired[str],
    DestinationEncryptionContext: NotRequired[Mapping[str, str]],
    SourceEncryptionAlgorithm: NotRequired[EncryptionAlgorithmSpecType],  # (1)
    DestinationEncryptionAlgorithm: NotRequired[EncryptionAlgorithmSpecType],  # (1)
    GrantTokens: NotRequired[Sequence[str]],
    DryRun: NotRequired[bool],

1. See EncryptionAlgorithmSpecType
2. See EncryptionAlgorithmSpecType

RecipientInfoTypeDef

# RecipientInfoTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import RecipientInfoTypeDef


def get_value() -> RecipientInfoTypeDef:
    return {
        "KeyEncryptionAlgorithm": ...,
    }


# RecipientInfoTypeDef definition

class RecipientInfoTypeDef(TypedDict):
    KeyEncryptionAlgorithm: NotRequired[KeyEncryptionMechanismType],  # (1)
    AttestationDocument: NotRequired[BlobTypeDef],

1. See KeyEncryptionMechanismType

SignRequestTypeDef

# SignRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import SignRequestTypeDef


def get_value() -> SignRequestTypeDef:
    return {
        "KeyId": ...,
    }


# SignRequestTypeDef definition

class SignRequestTypeDef(TypedDict):
    KeyId: str,
    Message: BlobTypeDef,
    SigningAlgorithm: SigningAlgorithmSpecType,  # (1)
    MessageType: NotRequired[MessageTypeType],  # (2)
    GrantTokens: NotRequired[Sequence[str]],
    DryRun: NotRequired[bool],

1. See SigningAlgorithmSpecType
2. See MessageTypeType

VerifyMacRequestTypeDef

# VerifyMacRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import VerifyMacRequestTypeDef


def get_value() -> VerifyMacRequestTypeDef:
    return {
        "Message": ...,
    }


# VerifyMacRequestTypeDef definition

class VerifyMacRequestTypeDef(TypedDict):
    Message: BlobTypeDef,
    KeyId: str,
    MacAlgorithm: MacAlgorithmSpecType,  # (1)
    Mac: BlobTypeDef,
    GrantTokens: NotRequired[Sequence[str]],
    DryRun: NotRequired[bool],

1. See MacAlgorithmSpecType

VerifyRequestTypeDef

# VerifyRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import VerifyRequestTypeDef


def get_value() -> VerifyRequestTypeDef:
    return {
        "KeyId": ...,
    }


# VerifyRequestTypeDef definition

class VerifyRequestTypeDef(TypedDict):
    KeyId: str,
    Message: BlobTypeDef,
    Signature: BlobTypeDef,
    SigningAlgorithm: SigningAlgorithmSpecType,  # (1)
    MessageType: NotRequired[MessageTypeType],  # (2)
    GrantTokens: NotRequired[Sequence[str]],
    DryRun: NotRequired[bool],

1. See SigningAlgorithmSpecType
2. See MessageTypeType

CancelKeyDeletionResponseTypeDef

# CancelKeyDeletionResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import CancelKeyDeletionResponseTypeDef


def get_value() -> CancelKeyDeletionResponseTypeDef:
    return {
        "KeyId": ...,
    }


# CancelKeyDeletionResponseTypeDef definition

class CancelKeyDeletionResponseTypeDef(TypedDict):
    KeyId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

CreateCustomKeyStoreResponseTypeDef

# CreateCustomKeyStoreResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import CreateCustomKeyStoreResponseTypeDef


def get_value() -> CreateCustomKeyStoreResponseTypeDef:
    return {
        "CustomKeyStoreId": ...,
    }


# CreateCustomKeyStoreResponseTypeDef definition

class CreateCustomKeyStoreResponseTypeDef(TypedDict):
    CustomKeyStoreId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

CreateGrantResponseTypeDef

# CreateGrantResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import CreateGrantResponseTypeDef


def get_value() -> CreateGrantResponseTypeDef:
    return {
        "GrantToken": ...,
    }


# CreateGrantResponseTypeDef definition

class CreateGrantResponseTypeDef(TypedDict):
    GrantToken: str,
    GrantId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

DecryptResponseTypeDef

# DecryptResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import DecryptResponseTypeDef


def get_value() -> DecryptResponseTypeDef:
    return {
        "KeyId": ...,
    }


# DecryptResponseTypeDef definition

class DecryptResponseTypeDef(TypedDict):
    KeyId: str,
    Plaintext: bytes,
    EncryptionAlgorithm: EncryptionAlgorithmSpecType,  # (1)
    CiphertextForRecipient: bytes,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EncryptionAlgorithmSpecType
2. See ResponseMetadataTypeDef

DeriveSharedSecretResponseTypeDef

# DeriveSharedSecretResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import DeriveSharedSecretResponseTypeDef


def get_value() -> DeriveSharedSecretResponseTypeDef:
    return {
        "KeyId": ...,
    }


# DeriveSharedSecretResponseTypeDef definition

class DeriveSharedSecretResponseTypeDef(TypedDict):
    KeyId: str,
    SharedSecret: bytes,
    CiphertextForRecipient: bytes,
    KeyAgreementAlgorithm: KeyAgreementAlgorithmSpecType,  # (1)
    KeyOrigin: OriginTypeType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See KeyAgreementAlgorithmSpecType
2. See OriginTypeType
3. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

# EmptyResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import EmptyResponseMetadataTypeDef


def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }


# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

EncryptResponseTypeDef

# EncryptResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import EncryptResponseTypeDef


def get_value() -> EncryptResponseTypeDef:
    return {
        "CiphertextBlob": ...,
    }


# EncryptResponseTypeDef definition

class EncryptResponseTypeDef(TypedDict):
    CiphertextBlob: bytes,
    KeyId: str,
    EncryptionAlgorithm: EncryptionAlgorithmSpecType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EncryptionAlgorithmSpecType
2. See ResponseMetadataTypeDef

GenerateDataKeyPairResponseTypeDef

# GenerateDataKeyPairResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GenerateDataKeyPairResponseTypeDef


def get_value() -> GenerateDataKeyPairResponseTypeDef:
    return {
        "PrivateKeyCiphertextBlob": ...,
    }


# GenerateDataKeyPairResponseTypeDef definition

class GenerateDataKeyPairResponseTypeDef(TypedDict):
    PrivateKeyCiphertextBlob: bytes,
    PrivateKeyPlaintext: bytes,
    PublicKey: bytes,
    KeyId: str,
    KeyPairSpec: DataKeyPairSpecType,  # (1)
    CiphertextForRecipient: bytes,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DataKeyPairSpecType
2. See ResponseMetadataTypeDef

GenerateDataKeyPairWithoutPlaintextResponseTypeDef

# GenerateDataKeyPairWithoutPlaintextResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GenerateDataKeyPairWithoutPlaintextResponseTypeDef


def get_value() -> GenerateDataKeyPairWithoutPlaintextResponseTypeDef:
    return {
        "PrivateKeyCiphertextBlob": ...,
    }


# GenerateDataKeyPairWithoutPlaintextResponseTypeDef definition

class GenerateDataKeyPairWithoutPlaintextResponseTypeDef(TypedDict):
    PrivateKeyCiphertextBlob: bytes,
    PublicKey: bytes,
    KeyId: str,
    KeyPairSpec: DataKeyPairSpecType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DataKeyPairSpecType
2. See ResponseMetadataTypeDef

GenerateDataKeyResponseTypeDef

# GenerateDataKeyResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GenerateDataKeyResponseTypeDef


def get_value() -> GenerateDataKeyResponseTypeDef:
    return {
        "CiphertextBlob": ...,
    }


# GenerateDataKeyResponseTypeDef definition

class GenerateDataKeyResponseTypeDef(TypedDict):
    CiphertextBlob: bytes,
    Plaintext: bytes,
    KeyId: str,
    CiphertextForRecipient: bytes,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GenerateDataKeyWithoutPlaintextResponseTypeDef

# GenerateDataKeyWithoutPlaintextResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GenerateDataKeyWithoutPlaintextResponseTypeDef


def get_value() -> GenerateDataKeyWithoutPlaintextResponseTypeDef:
    return {
        "CiphertextBlob": ...,
    }


# GenerateDataKeyWithoutPlaintextResponseTypeDef definition

class GenerateDataKeyWithoutPlaintextResponseTypeDef(TypedDict):
    CiphertextBlob: bytes,
    KeyId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GenerateMacResponseTypeDef

# GenerateMacResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GenerateMacResponseTypeDef


def get_value() -> GenerateMacResponseTypeDef:
    return {
        "Mac": ...,
    }


# GenerateMacResponseTypeDef definition

class GenerateMacResponseTypeDef(TypedDict):
    Mac: bytes,
    MacAlgorithm: MacAlgorithmSpecType,  # (1)
    KeyId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MacAlgorithmSpecType
2. See ResponseMetadataTypeDef

GenerateRandomResponseTypeDef

# GenerateRandomResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GenerateRandomResponseTypeDef


def get_value() -> GenerateRandomResponseTypeDef:
    return {
        "Plaintext": ...,
    }


# GenerateRandomResponseTypeDef definition

class GenerateRandomResponseTypeDef(TypedDict):
    Plaintext: bytes,
    CiphertextForRecipient: bytes,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetKeyPolicyResponseTypeDef

# GetKeyPolicyResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GetKeyPolicyResponseTypeDef


def get_value() -> GetKeyPolicyResponseTypeDef:
    return {
        "Policy": ...,
    }


# GetKeyPolicyResponseTypeDef definition

class GetKeyPolicyResponseTypeDef(TypedDict):
    Policy: str,
    PolicyName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetKeyRotationStatusResponseTypeDef

# GetKeyRotationStatusResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GetKeyRotationStatusResponseTypeDef


def get_value() -> GetKeyRotationStatusResponseTypeDef:
    return {
        "KeyRotationEnabled": ...,
    }


# GetKeyRotationStatusResponseTypeDef definition

class GetKeyRotationStatusResponseTypeDef(TypedDict):
    KeyRotationEnabled: bool,
    KeyId: str,
    RotationPeriodInDays: int,
    NextRotationDate: datetime.datetime,
    OnDemandRotationStartDate: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetParametersForImportResponseTypeDef

# GetParametersForImportResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GetParametersForImportResponseTypeDef


def get_value() -> GetParametersForImportResponseTypeDef:
    return {
        "KeyId": ...,
    }


# GetParametersForImportResponseTypeDef definition

class GetParametersForImportResponseTypeDef(TypedDict):
    KeyId: str,
    ImportToken: bytes,
    PublicKey: bytes,
    ParametersValidTo: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetPublicKeyResponseTypeDef

# GetPublicKeyResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GetPublicKeyResponseTypeDef


def get_value() -> GetPublicKeyResponseTypeDef:
    return {
        "KeyId": ...,
    }


# GetPublicKeyResponseTypeDef definition

class GetPublicKeyResponseTypeDef(TypedDict):
    KeyId: str,
    PublicKey: bytes,
    CustomerMasterKeySpec: CustomerMasterKeySpecType,  # (1)
    KeySpec: KeySpecType,  # (2)
    KeyUsage: KeyUsageTypeType,  # (3)
    EncryptionAlgorithms: List[EncryptionAlgorithmSpecType],  # (4)
    SigningAlgorithms: List[SigningAlgorithmSpecType],  # (5)
    KeyAgreementAlgorithms: List[KeyAgreementAlgorithmSpecType],  # (6)
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)

1. See CustomerMasterKeySpecType
2. See KeySpecType
3. See KeyUsageTypeType
4. See List[EncryptionAlgorithmSpecType]
5. See List[SigningAlgorithmSpecType]
6. See List[Literal['ECDH']]
7. See ResponseMetadataTypeDef

ListAliasesResponseTypeDef

# ListAliasesResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListAliasesResponseTypeDef


def get_value() -> ListAliasesResponseTypeDef:
    return {
        "Aliases": ...,
    }


# ListAliasesResponseTypeDef definition

class ListAliasesResponseTypeDef(TypedDict):
    Aliases: List[AliasListEntryTypeDef],  # (1)
    NextMarker: str,
    Truncated: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[AliasListEntryTypeDef]
2. See ResponseMetadataTypeDef

ListKeyPoliciesResponseTypeDef

# ListKeyPoliciesResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListKeyPoliciesResponseTypeDef


def get_value() -> ListKeyPoliciesResponseTypeDef:
    return {
        "PolicyNames": ...,
    }


# ListKeyPoliciesResponseTypeDef definition

class ListKeyPoliciesResponseTypeDef(TypedDict):
    PolicyNames: List[str],
    NextMarker: str,
    Truncated: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ReEncryptResponseTypeDef

# ReEncryptResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ReEncryptResponseTypeDef


def get_value() -> ReEncryptResponseTypeDef:
    return {
        "CiphertextBlob": ...,
    }


# ReEncryptResponseTypeDef definition

class ReEncryptResponseTypeDef(TypedDict):
    CiphertextBlob: bytes,
    SourceKeyId: str,
    KeyId: str,
    SourceEncryptionAlgorithm: EncryptionAlgorithmSpecType,  # (1)
    DestinationEncryptionAlgorithm: EncryptionAlgorithmSpecType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See EncryptionAlgorithmSpecType
2. See EncryptionAlgorithmSpecType
3. See ResponseMetadataTypeDef

RotateKeyOnDemandResponseTypeDef

# RotateKeyOnDemandResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import RotateKeyOnDemandResponseTypeDef


def get_value() -> RotateKeyOnDemandResponseTypeDef:
    return {
        "KeyId": ...,
    }


# RotateKeyOnDemandResponseTypeDef definition

class RotateKeyOnDemandResponseTypeDef(TypedDict):
    KeyId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ScheduleKeyDeletionResponseTypeDef

# ScheduleKeyDeletionResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ScheduleKeyDeletionResponseTypeDef


def get_value() -> ScheduleKeyDeletionResponseTypeDef:
    return {
        "KeyId": ...,
    }


# ScheduleKeyDeletionResponseTypeDef definition

class ScheduleKeyDeletionResponseTypeDef(TypedDict):
    KeyId: str,
    DeletionDate: datetime.datetime,
    KeyState: KeyStateType,  # (1)
    PendingWindowInDays: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See KeyStateType
2. See ResponseMetadataTypeDef

SignResponseTypeDef

# SignResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import SignResponseTypeDef


def get_value() -> SignResponseTypeDef:
    return {
        "KeyId": ...,
    }


# SignResponseTypeDef definition

class SignResponseTypeDef(TypedDict):
    KeyId: str,
    Signature: bytes,
    SigningAlgorithm: SigningAlgorithmSpecType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SigningAlgorithmSpecType
2. See ResponseMetadataTypeDef

VerifyMacResponseTypeDef

# VerifyMacResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import VerifyMacResponseTypeDef


def get_value() -> VerifyMacResponseTypeDef:
    return {
        "KeyId": ...,
    }


# VerifyMacResponseTypeDef definition

class VerifyMacResponseTypeDef(TypedDict):
    KeyId: str,
    MacValid: bool,
    MacAlgorithm: MacAlgorithmSpecType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See MacAlgorithmSpecType
2. See ResponseMetadataTypeDef

VerifyResponseTypeDef

# VerifyResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import VerifyResponseTypeDef


def get_value() -> VerifyResponseTypeDef:
    return {
        "KeyId": ...,
    }


# VerifyResponseTypeDef definition

class VerifyResponseTypeDef(TypedDict):
    KeyId: str,
    SignatureValid: bool,
    SigningAlgorithm: SigningAlgorithmSpecType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SigningAlgorithmSpecType
2. See ResponseMetadataTypeDef

CreateCustomKeyStoreRequestTypeDef

# CreateCustomKeyStoreRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import CreateCustomKeyStoreRequestTypeDef


def get_value() -> CreateCustomKeyStoreRequestTypeDef:
    return {
        "CustomKeyStoreName": ...,
    }


# CreateCustomKeyStoreRequestTypeDef definition

class CreateCustomKeyStoreRequestTypeDef(TypedDict):
    CustomKeyStoreName: str,
    CloudHsmClusterId: NotRequired[str],
    TrustAnchorCertificate: NotRequired[str],
    KeyStorePassword: NotRequired[str],
    CustomKeyStoreType: NotRequired[CustomKeyStoreTypeType],  # (1)
    XksProxyUriEndpoint: NotRequired[str],
    XksProxyUriPath: NotRequired[str],
    XksProxyVpcEndpointServiceName: NotRequired[str],
    XksProxyAuthenticationCredential: NotRequired[XksProxyAuthenticationCredentialTypeTypeDef],  # (2)
    XksProxyConnectivity: NotRequired[XksProxyConnectivityTypeType],  # (3)

1. See CustomKeyStoreTypeType
2. See XksProxyAuthenticationCredentialTypeTypeDef
3. See XksProxyConnectivityTypeType

UpdateCustomKeyStoreRequestTypeDef

# UpdateCustomKeyStoreRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import UpdateCustomKeyStoreRequestTypeDef


def get_value() -> UpdateCustomKeyStoreRequestTypeDef:
    return {
        "CustomKeyStoreId": ...,
    }


# UpdateCustomKeyStoreRequestTypeDef definition

class UpdateCustomKeyStoreRequestTypeDef(TypedDict):
    CustomKeyStoreId: str,
    NewCustomKeyStoreName: NotRequired[str],
    KeyStorePassword: NotRequired[str],
    CloudHsmClusterId: NotRequired[str],
    XksProxyUriEndpoint: NotRequired[str],
    XksProxyUriPath: NotRequired[str],
    XksProxyVpcEndpointServiceName: NotRequired[str],
    XksProxyAuthenticationCredential: NotRequired[XksProxyAuthenticationCredentialTypeTypeDef],  # (1)
    XksProxyConnectivity: NotRequired[XksProxyConnectivityTypeType],  # (2)

1. See XksProxyAuthenticationCredentialTypeTypeDef
2. See XksProxyConnectivityTypeType

CreateKeyRequestTypeDef

# CreateKeyRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import CreateKeyRequestTypeDef


def get_value() -> CreateKeyRequestTypeDef:
    return {
        "Policy": ...,
    }


# CreateKeyRequestTypeDef definition

class CreateKeyRequestTypeDef(TypedDict):
    Policy: NotRequired[str],
    Description: NotRequired[str],
    KeyUsage: NotRequired[KeyUsageTypeType],  # (1)
    CustomerMasterKeySpec: NotRequired[CustomerMasterKeySpecType],  # (2)
    KeySpec: NotRequired[KeySpecType],  # (3)
    Origin: NotRequired[OriginTypeType],  # (4)
    CustomKeyStoreId: NotRequired[str],
    BypassPolicyLockoutSafetyCheck: NotRequired[bool],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (5)
    MultiRegion: NotRequired[bool],
    XksKeyId: NotRequired[str],

1. See KeyUsageTypeType
2. See CustomerMasterKeySpecType
3. See KeySpecType
4. See OriginTypeType
5. See Sequence[TagTypeDef]

ListResourceTagsResponseTypeDef

# ListResourceTagsResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListResourceTagsResponseTypeDef


def get_value() -> ListResourceTagsResponseTypeDef:
    return {
        "Tags": ...,
    }


# ListResourceTagsResponseTypeDef definition

class ListResourceTagsResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    NextMarker: str,
    Truncated: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[TagTypeDef]
2. See ResponseMetadataTypeDef

ReplicateKeyRequestTypeDef

# ReplicateKeyRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ReplicateKeyRequestTypeDef


def get_value() -> ReplicateKeyRequestTypeDef:
    return {
        "KeyId": ...,
    }


# ReplicateKeyRequestTypeDef definition

class ReplicateKeyRequestTypeDef(TypedDict):
    KeyId: str,
    ReplicaRegion: str,
    Policy: NotRequired[str],
    BypassPolicyLockoutSafetyCheck: NotRequired[bool],
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)

1. See Sequence[TagTypeDef]

TagResourceRequestTypeDef

# TagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "KeyId": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    KeyId: str,
    Tags: Sequence[TagTypeDef],  # (1)

1. See Sequence[TagTypeDef]

CustomKeyStoresListEntryTypeDef

# CustomKeyStoresListEntryTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import CustomKeyStoresListEntryTypeDef


def get_value() -> CustomKeyStoresListEntryTypeDef:
    return {
        "CustomKeyStoreId": ...,
    }


# CustomKeyStoresListEntryTypeDef definition

class CustomKeyStoresListEntryTypeDef(TypedDict):
    CustomKeyStoreId: NotRequired[str],
    CustomKeyStoreName: NotRequired[str],
    CloudHsmClusterId: NotRequired[str],
    TrustAnchorCertificate: NotRequired[str],
    ConnectionState: NotRequired[ConnectionStateTypeType],  # (1)
    ConnectionErrorCode: NotRequired[ConnectionErrorCodeTypeType],  # (2)
    CreationDate: NotRequired[datetime.datetime],
    CustomKeyStoreType: NotRequired[CustomKeyStoreTypeType],  # (3)
    XksProxyConfiguration: NotRequired[XksProxyConfigurationTypeTypeDef],  # (4)

1. See ConnectionStateTypeType
2. See ConnectionErrorCodeTypeType
3. See CustomKeyStoreTypeType
4. See XksProxyConfigurationTypeTypeDef

DescribeCustomKeyStoresRequestPaginateTypeDef

# DescribeCustomKeyStoresRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import DescribeCustomKeyStoresRequestPaginateTypeDef


def get_value() -> DescribeCustomKeyStoresRequestPaginateTypeDef:
    return {
        "CustomKeyStoreId": ...,
    }


# DescribeCustomKeyStoresRequestPaginateTypeDef definition

class DescribeCustomKeyStoresRequestPaginateTypeDef(TypedDict):
    CustomKeyStoreId: NotRequired[str],
    CustomKeyStoreName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListAliasesRequestPaginateTypeDef

# ListAliasesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListAliasesRequestPaginateTypeDef


def get_value() -> ListAliasesRequestPaginateTypeDef:
    return {
        "KeyId": ...,
    }


# ListAliasesRequestPaginateTypeDef definition

class ListAliasesRequestPaginateTypeDef(TypedDict):
    KeyId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListGrantsRequestPaginateTypeDef

# ListGrantsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListGrantsRequestPaginateTypeDef


def get_value() -> ListGrantsRequestPaginateTypeDef:
    return {
        "KeyId": ...,
    }


# ListGrantsRequestPaginateTypeDef definition

class ListGrantsRequestPaginateTypeDef(TypedDict):
    KeyId: str,
    GrantId: NotRequired[str],
    GranteePrincipal: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListKeyPoliciesRequestPaginateTypeDef

# ListKeyPoliciesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListKeyPoliciesRequestPaginateTypeDef


def get_value() -> ListKeyPoliciesRequestPaginateTypeDef:
    return {
        "KeyId": ...,
    }


# ListKeyPoliciesRequestPaginateTypeDef definition

class ListKeyPoliciesRequestPaginateTypeDef(TypedDict):
    KeyId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListKeyRotationsRequestPaginateTypeDef

# ListKeyRotationsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListKeyRotationsRequestPaginateTypeDef


def get_value() -> ListKeyRotationsRequestPaginateTypeDef:
    return {
        "KeyId": ...,
    }


# ListKeyRotationsRequestPaginateTypeDef definition

class ListKeyRotationsRequestPaginateTypeDef(TypedDict):
    KeyId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListKeysRequestPaginateTypeDef

# ListKeysRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListKeysRequestPaginateTypeDef


def get_value() -> ListKeysRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListKeysRequestPaginateTypeDef definition

class ListKeysRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListResourceTagsRequestPaginateTypeDef

# ListResourceTagsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListResourceTagsRequestPaginateTypeDef


def get_value() -> ListResourceTagsRequestPaginateTypeDef:
    return {
        "KeyId": ...,
    }


# ListResourceTagsRequestPaginateTypeDef definition

class ListResourceTagsRequestPaginateTypeDef(TypedDict):
    KeyId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListRetirableGrantsRequestPaginateTypeDef

# ListRetirableGrantsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListRetirableGrantsRequestPaginateTypeDef


def get_value() -> ListRetirableGrantsRequestPaginateTypeDef:
    return {
        "RetiringPrincipal": ...,
    }


# ListRetirableGrantsRequestPaginateTypeDef definition

class ListRetirableGrantsRequestPaginateTypeDef(TypedDict):
    RetiringPrincipal: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

GrantListEntryTypeDef

# GrantListEntryTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GrantListEntryTypeDef


def get_value() -> GrantListEntryTypeDef:
    return {
        "KeyId": ...,
    }


# GrantListEntryTypeDef definition

class GrantListEntryTypeDef(TypedDict):
    KeyId: NotRequired[str],
    GrantId: NotRequired[str],
    Name: NotRequired[str],
    CreationDate: NotRequired[datetime.datetime],
    GranteePrincipal: NotRequired[str],
    RetiringPrincipal: NotRequired[str],
    IssuingAccount: NotRequired[str],
    Operations: NotRequired[List[GrantOperationType]],  # (1)
    Constraints: NotRequired[GrantConstraintsOutputTypeDef],  # (2)

1. See List[GrantOperationType]
2. See GrantConstraintsOutputTypeDef

ImportKeyMaterialRequestTypeDef

# ImportKeyMaterialRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ImportKeyMaterialRequestTypeDef


def get_value() -> ImportKeyMaterialRequestTypeDef:
    return {
        "KeyId": ...,
    }


# ImportKeyMaterialRequestTypeDef definition

class ImportKeyMaterialRequestTypeDef(TypedDict):
    KeyId: str,
    ImportToken: BlobTypeDef,
    EncryptedKeyMaterial: BlobTypeDef,
    ValidTo: NotRequired[TimestampTypeDef],
    ExpirationModel: NotRequired[ExpirationModelTypeType],  # (1)

1. See ExpirationModelTypeType

ListKeysResponseTypeDef

# ListKeysResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListKeysResponseTypeDef


def get_value() -> ListKeysResponseTypeDef:
    return {
        "Keys": ...,
    }


# ListKeysResponseTypeDef definition

class ListKeysResponseTypeDef(TypedDict):
    Keys: List[KeyListEntryTypeDef],  # (1)
    NextMarker: str,
    Truncated: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[KeyListEntryTypeDef]
2. See ResponseMetadataTypeDef

ListKeyRotationsResponseTypeDef

# ListKeyRotationsResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListKeyRotationsResponseTypeDef


def get_value() -> ListKeyRotationsResponseTypeDef:
    return {
        "Rotations": ...,
    }


# ListKeyRotationsResponseTypeDef definition

class ListKeyRotationsResponseTypeDef(TypedDict):
    Rotations: List[RotationsListEntryTypeDef],  # (1)
    NextMarker: str,
    Truncated: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[RotationsListEntryTypeDef]
2. See ResponseMetadataTypeDef

MultiRegionConfigurationTypeDef

# MultiRegionConfigurationTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import MultiRegionConfigurationTypeDef


def get_value() -> MultiRegionConfigurationTypeDef:
    return {
        "MultiRegionKeyType": ...,
    }


# MultiRegionConfigurationTypeDef definition

class MultiRegionConfigurationTypeDef(TypedDict):
    MultiRegionKeyType: NotRequired[MultiRegionKeyTypeType],  # (1)
    PrimaryKey: NotRequired[MultiRegionKeyTypeDef],  # (2)
    ReplicaKeys: NotRequired[List[MultiRegionKeyTypeDef]],  # (3)

1. See MultiRegionKeyTypeType
2. See MultiRegionKeyTypeDef
3. See List[MultiRegionKeyTypeDef]

DecryptRequestTypeDef

# DecryptRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import DecryptRequestTypeDef


def get_value() -> DecryptRequestTypeDef:
    return {
        "CiphertextBlob": ...,
    }


# DecryptRequestTypeDef definition

class DecryptRequestTypeDef(TypedDict):
    CiphertextBlob: BlobTypeDef,
    EncryptionContext: NotRequired[Mapping[str, str]],
    GrantTokens: NotRequired[Sequence[str]],
    KeyId: NotRequired[str],
    EncryptionAlgorithm: NotRequired[EncryptionAlgorithmSpecType],  # (1)
    Recipient: NotRequired[RecipientInfoTypeDef],  # (2)
    DryRun: NotRequired[bool],

1. See EncryptionAlgorithmSpecType
2. See RecipientInfoTypeDef

DeriveSharedSecretRequestTypeDef

# DeriveSharedSecretRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import DeriveSharedSecretRequestTypeDef


def get_value() -> DeriveSharedSecretRequestTypeDef:
    return {
        "KeyId": ...,
    }


# DeriveSharedSecretRequestTypeDef definition

class DeriveSharedSecretRequestTypeDef(TypedDict):
    KeyId: str,
    KeyAgreementAlgorithm: KeyAgreementAlgorithmSpecType,  # (1)
    PublicKey: BlobTypeDef,
    GrantTokens: NotRequired[Sequence[str]],
    DryRun: NotRequired[bool],
    Recipient: NotRequired[RecipientInfoTypeDef],  # (2)

1. See KeyAgreementAlgorithmSpecType
2. See RecipientInfoTypeDef

GenerateDataKeyPairRequestTypeDef

# GenerateDataKeyPairRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GenerateDataKeyPairRequestTypeDef


def get_value() -> GenerateDataKeyPairRequestTypeDef:
    return {
        "KeyId": ...,
    }


# GenerateDataKeyPairRequestTypeDef definition

class GenerateDataKeyPairRequestTypeDef(TypedDict):
    KeyId: str,
    KeyPairSpec: DataKeyPairSpecType,  # (1)
    EncryptionContext: NotRequired[Mapping[str, str]],
    GrantTokens: NotRequired[Sequence[str]],
    Recipient: NotRequired[RecipientInfoTypeDef],  # (2)
    DryRun: NotRequired[bool],

1. See DataKeyPairSpecType
2. See RecipientInfoTypeDef

GenerateDataKeyRequestTypeDef

# GenerateDataKeyRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GenerateDataKeyRequestTypeDef


def get_value() -> GenerateDataKeyRequestTypeDef:
    return {
        "KeyId": ...,
    }


# GenerateDataKeyRequestTypeDef definition

class GenerateDataKeyRequestTypeDef(TypedDict):
    KeyId: str,
    EncryptionContext: NotRequired[Mapping[str, str]],
    NumberOfBytes: NotRequired[int],
    KeySpec: NotRequired[DataKeySpecType],  # (1)
    GrantTokens: NotRequired[Sequence[str]],
    Recipient: NotRequired[RecipientInfoTypeDef],  # (2)
    DryRun: NotRequired[bool],

1. See DataKeySpecType
2. See RecipientInfoTypeDef

GenerateRandomRequestTypeDef

# GenerateRandomRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import GenerateRandomRequestTypeDef


def get_value() -> GenerateRandomRequestTypeDef:
    return {
        "NumberOfBytes": ...,
    }


# GenerateRandomRequestTypeDef definition

class GenerateRandomRequestTypeDef(TypedDict):
    NumberOfBytes: NotRequired[int],
    CustomKeyStoreId: NotRequired[str],
    Recipient: NotRequired[RecipientInfoTypeDef],  # (1)

1. See RecipientInfoTypeDef

DescribeCustomKeyStoresResponseTypeDef

# DescribeCustomKeyStoresResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import DescribeCustomKeyStoresResponseTypeDef


def get_value() -> DescribeCustomKeyStoresResponseTypeDef:
    return {
        "CustomKeyStores": ...,
    }


# DescribeCustomKeyStoresResponseTypeDef definition

class DescribeCustomKeyStoresResponseTypeDef(TypedDict):
    CustomKeyStores: List[CustomKeyStoresListEntryTypeDef],  # (1)
    NextMarker: str,
    Truncated: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[CustomKeyStoresListEntryTypeDef]
2. See ResponseMetadataTypeDef

ListGrantsResponseTypeDef

# ListGrantsResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ListGrantsResponseTypeDef


def get_value() -> ListGrantsResponseTypeDef:
    return {
        "Grants": ...,
    }


# ListGrantsResponseTypeDef definition

class ListGrantsResponseTypeDef(TypedDict):
    Grants: List[GrantListEntryTypeDef],  # (1)
    NextMarker: str,
    Truncated: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[GrantListEntryTypeDef]
2. See ResponseMetadataTypeDef

CreateGrantRequestTypeDef

# CreateGrantRequestTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import CreateGrantRequestTypeDef


def get_value() -> CreateGrantRequestTypeDef:
    return {
        "KeyId": ...,
    }


# CreateGrantRequestTypeDef definition

class CreateGrantRequestTypeDef(TypedDict):
    KeyId: str,
    GranteePrincipal: str,
    Operations: Sequence[GrantOperationType],  # (1)
    RetiringPrincipal: NotRequired[str],
    Constraints: NotRequired[GrantConstraintsUnionTypeDef],  # (2)
    GrantTokens: NotRequired[Sequence[str]],
    Name: NotRequired[str],
    DryRun: NotRequired[bool],

1. See Sequence[GrantOperationType]
2. See GrantConstraintsUnionTypeDef

KeyMetadataTypeDef

# KeyMetadataTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import KeyMetadataTypeDef


def get_value() -> KeyMetadataTypeDef:
    return {
        "AWSAccountId": ...,
    }


# KeyMetadataTypeDef definition

class KeyMetadataTypeDef(TypedDict):
    KeyId: str,
    AWSAccountId: NotRequired[str],
    Arn: NotRequired[str],
    CreationDate: NotRequired[datetime.datetime],
    Enabled: NotRequired[bool],
    Description: NotRequired[str],
    KeyUsage: NotRequired[KeyUsageTypeType],  # (1)
    KeyState: NotRequired[KeyStateType],  # (2)
    DeletionDate: NotRequired[datetime.datetime],
    ValidTo: NotRequired[datetime.datetime],
    Origin: NotRequired[OriginTypeType],  # (3)
    CustomKeyStoreId: NotRequired[str],
    CloudHsmClusterId: NotRequired[str],
    ExpirationModel: NotRequired[ExpirationModelTypeType],  # (4)
    KeyManager: NotRequired[KeyManagerTypeType],  # (5)
    CustomerMasterKeySpec: NotRequired[CustomerMasterKeySpecType],  # (6)
    KeySpec: NotRequired[KeySpecType],  # (7)
    EncryptionAlgorithms: NotRequired[List[EncryptionAlgorithmSpecType]],  # (8)
    SigningAlgorithms: NotRequired[List[SigningAlgorithmSpecType]],  # (9)
    KeyAgreementAlgorithms: NotRequired[List[KeyAgreementAlgorithmSpecType]],  # (10)
    MultiRegion: NotRequired[bool],
    MultiRegionConfiguration: NotRequired[MultiRegionConfigurationTypeDef],  # (11)
    PendingDeletionWindowInDays: NotRequired[int],
    MacAlgorithms: NotRequired[List[MacAlgorithmSpecType]],  # (12)
    XksKeyConfiguration: NotRequired[XksKeyConfigurationTypeTypeDef],  # (13)

1. See KeyUsageTypeType
2. See KeyStateType
3. See OriginTypeType
4. See ExpirationModelTypeType
5. See KeyManagerTypeType
6. See CustomerMasterKeySpecType
7. See KeySpecType
8. See List[EncryptionAlgorithmSpecType]
9. See List[SigningAlgorithmSpecType]
10. See List[Literal['ECDH']]
11. See MultiRegionConfigurationTypeDef
12. See List[MacAlgorithmSpecType]
13. See XksKeyConfigurationTypeTypeDef

CreateKeyResponseTypeDef

# CreateKeyResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import CreateKeyResponseTypeDef


def get_value() -> CreateKeyResponseTypeDef:
    return {
        "KeyMetadata": ...,
    }


# CreateKeyResponseTypeDef definition

class CreateKeyResponseTypeDef(TypedDict):
    KeyMetadata: KeyMetadataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See KeyMetadataTypeDef
2. See ResponseMetadataTypeDef

DescribeKeyResponseTypeDef

# DescribeKeyResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import DescribeKeyResponseTypeDef


def get_value() -> DescribeKeyResponseTypeDef:
    return {
        "KeyMetadata": ...,
    }


# DescribeKeyResponseTypeDef definition

class DescribeKeyResponseTypeDef(TypedDict):
    KeyMetadata: KeyMetadataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See KeyMetadataTypeDef
2. See ResponseMetadataTypeDef

ReplicateKeyResponseTypeDef

# ReplicateKeyResponseTypeDef TypedDict usage example

from mypy_boto3_kms.type_defs import ReplicateKeyResponseTypeDef


def get_value() -> ReplicateKeyResponseTypeDef:
    return {
        "ReplicaKeyMetadata": ...,
    }


# ReplicateKeyResponseTypeDef definition

class ReplicateKeyResponseTypeDef(TypedDict):
    ReplicaKeyMetadata: KeyMetadataTypeDef,  # (1)
    ReplicaPolicy: str,
    ReplicaTags: List[TagTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See KeyMetadataTypeDef
2. See List[TagTypeDef]
3. See ResponseMetadataTypeDef