Typed dictionaries
Auto-generated documentation for KMS type annotations stubs module mypy-boto3-kms.
AliasListEntryTypeDef
Usage Example
from mypy_boto3_kms.type_defs import AliasListEntryTypeDef
def get_value() -> AliasListEntryTypeDef:
return {
"AliasName": ...,
}
Definition
class AliasListEntryTypeDef(TypedDict):
AliasName: NotRequired[str],
AliasArn: NotRequired[str],
TargetKeyId: NotRequired[str],
CreationDate: NotRequired[datetime],
LastUpdatedDate: NotRequired[datetime],
CancelKeyDeletionRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import CancelKeyDeletionRequestRequestTypeDef
def get_value() -> CancelKeyDeletionRequestRequestTypeDef:
return {
"KeyId": ...,
}
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
ConnectCustomKeyStoreRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ConnectCustomKeyStoreRequestRequestTypeDef
def get_value() -> ConnectCustomKeyStoreRequestRequestTypeDef:
return {
"CustomKeyStoreId": ...,
}
CreateAliasRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import CreateAliasRequestRequestTypeDef
def get_value() -> CreateAliasRequestRequestTypeDef:
return {
"AliasName": ...,
"TargetKeyId": ...,
}
XksProxyAuthenticationCredentialTypeTypeDef
Usage Example
from mypy_boto3_kms.type_defs import XksProxyAuthenticationCredentialTypeTypeDef
def get_value() -> XksProxyAuthenticationCredentialTypeTypeDef:
return {
"AccessKeyId": ...,
"RawSecretAccessKey": ...,
}
Definition
class XksProxyAuthenticationCredentialTypeTypeDef(TypedDict):
AccessKeyId: str,
RawSecretAccessKey: str,
GrantConstraintsTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GrantConstraintsTypeDef
def get_value() -> GrantConstraintsTypeDef:
return {
"EncryptionContextSubset": ...,
}
Definition
class GrantConstraintsTypeDef(TypedDict):
EncryptionContextSubset: NotRequired[Mapping[str, str]],
EncryptionContextEquals: NotRequired[Mapping[str, str]],
TagTypeDef
Usage Example
from mypy_boto3_kms.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"TagKey": ...,
"TagValue": ...,
}
XksProxyConfigurationTypeTypeDef
Usage Example
from mypy_boto3_kms.type_defs import XksProxyConfigurationTypeTypeDef
def get_value() -> XksProxyConfigurationTypeTypeDef:
return {
"Connectivity": ...,
}
Definition
class XksProxyConfigurationTypeTypeDef(TypedDict):
Connectivity: NotRequired[XksProxyConnectivityTypeType], # (1)
AccessKeyId: NotRequired[str],
UriEndpoint: NotRequired[str],
UriPath: NotRequired[str],
VpcEndpointServiceName: NotRequired[str],
DecryptRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import DecryptRequestRequestTypeDef
def get_value() -> DecryptRequestRequestTypeDef:
return {
"CiphertextBlob": ...,
}
Definition
class DecryptRequestRequestTypeDef(TypedDict):
CiphertextBlob: Union[str, bytes, IO[Any], StreamingBody],
EncryptionContext: NotRequired[Mapping[str, str]],
GrantTokens: NotRequired[Sequence[str]],
KeyId: NotRequired[str],
EncryptionAlgorithm: NotRequired[EncryptionAlgorithmSpecType], # (1)
DeleteAliasRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import DeleteAliasRequestRequestTypeDef
def get_value() -> DeleteAliasRequestRequestTypeDef:
return {
"AliasName": ...,
}
DeleteCustomKeyStoreRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import DeleteCustomKeyStoreRequestRequestTypeDef
def get_value() -> DeleteCustomKeyStoreRequestRequestTypeDef:
return {
"CustomKeyStoreId": ...,
}
DeleteImportedKeyMaterialRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import DeleteImportedKeyMaterialRequestRequestTypeDef
def get_value() -> DeleteImportedKeyMaterialRequestRequestTypeDef:
return {
"KeyId": ...,
}
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_kms.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeCustomKeyStoresRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import DescribeCustomKeyStoresRequestRequestTypeDef
def get_value() -> DescribeCustomKeyStoresRequestRequestTypeDef:
return {
"CustomKeyStoreId": ...,
}
Definition
class DescribeCustomKeyStoresRequestRequestTypeDef(TypedDict):
CustomKeyStoreId: NotRequired[str],
CustomKeyStoreName: NotRequired[str],
Limit: NotRequired[int],
Marker: NotRequired[str],
DescribeKeyRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import DescribeKeyRequestRequestTypeDef
def get_value() -> DescribeKeyRequestRequestTypeDef:
return {
"KeyId": ...,
}
Definition
class DescribeKeyRequestRequestTypeDef(TypedDict):
KeyId: str,
GrantTokens: NotRequired[Sequence[str]],
DisableKeyRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import DisableKeyRequestRequestTypeDef
def get_value() -> DisableKeyRequestRequestTypeDef:
return {
"KeyId": ...,
}
DisableKeyRotationRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import DisableKeyRotationRequestRequestTypeDef
def get_value() -> DisableKeyRotationRequestRequestTypeDef:
return {
"KeyId": ...,
}
DisconnectCustomKeyStoreRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import DisconnectCustomKeyStoreRequestRequestTypeDef
def get_value() -> DisconnectCustomKeyStoreRequestRequestTypeDef:
return {
"CustomKeyStoreId": ...,
}
EnableKeyRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import EnableKeyRequestRequestTypeDef
def get_value() -> EnableKeyRequestRequestTypeDef:
return {
"KeyId": ...,
}
EnableKeyRotationRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import EnableKeyRotationRequestRequestTypeDef
def get_value() -> EnableKeyRotationRequestRequestTypeDef:
return {
"KeyId": ...,
}
EncryptRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import EncryptRequestRequestTypeDef
def get_value() -> EncryptRequestRequestTypeDef:
return {
"KeyId": ...,
"Plaintext": ...,
}
Definition
class EncryptRequestRequestTypeDef(TypedDict):
KeyId: str,
Plaintext: Union[str, bytes, IO[Any], StreamingBody],
EncryptionContext: NotRequired[Mapping[str, str]],
GrantTokens: NotRequired[Sequence[str]],
EncryptionAlgorithm: NotRequired[EncryptionAlgorithmSpecType], # (1)
GenerateDataKeyPairRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GenerateDataKeyPairRequestRequestTypeDef
def get_value() -> GenerateDataKeyPairRequestRequestTypeDef:
return {
"KeyId": ...,
"KeyPairSpec": ...,
}
Definition
class GenerateDataKeyPairRequestRequestTypeDef(TypedDict):
KeyId: str,
KeyPairSpec: DataKeyPairSpecType, # (1)
EncryptionContext: NotRequired[Mapping[str, str]],
GrantTokens: NotRequired[Sequence[str]],
GenerateDataKeyPairWithoutPlaintextRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GenerateDataKeyPairWithoutPlaintextRequestRequestTypeDef
def get_value() -> GenerateDataKeyPairWithoutPlaintextRequestRequestTypeDef:
return {
"KeyId": ...,
"KeyPairSpec": ...,
}
Definition
class GenerateDataKeyPairWithoutPlaintextRequestRequestTypeDef(TypedDict):
KeyId: str,
KeyPairSpec: DataKeyPairSpecType, # (1)
EncryptionContext: NotRequired[Mapping[str, str]],
GrantTokens: NotRequired[Sequence[str]],
GenerateDataKeyRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GenerateDataKeyRequestRequestTypeDef
def get_value() -> GenerateDataKeyRequestRequestTypeDef:
return {
"KeyId": ...,
}
Definition
class GenerateDataKeyRequestRequestTypeDef(TypedDict):
KeyId: str,
EncryptionContext: NotRequired[Mapping[str, str]],
NumberOfBytes: NotRequired[int],
KeySpec: NotRequired[DataKeySpecType], # (1)
GrantTokens: NotRequired[Sequence[str]],
- See DataKeySpecType
GenerateDataKeyWithoutPlaintextRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GenerateDataKeyWithoutPlaintextRequestRequestTypeDef
def get_value() -> GenerateDataKeyWithoutPlaintextRequestRequestTypeDef:
return {
"KeyId": ...,
}
Definition
class GenerateDataKeyWithoutPlaintextRequestRequestTypeDef(TypedDict):
KeyId: str,
EncryptionContext: NotRequired[Mapping[str, str]],
KeySpec: NotRequired[DataKeySpecType], # (1)
NumberOfBytes: NotRequired[int],
GrantTokens: NotRequired[Sequence[str]],
- See DataKeySpecType
GenerateMacRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GenerateMacRequestRequestTypeDef
def get_value() -> GenerateMacRequestRequestTypeDef:
return {
"Message": ...,
"KeyId": ...,
"MacAlgorithm": ...,
}
Definition
class GenerateMacRequestRequestTypeDef(TypedDict):
Message: Union[str, bytes, IO[Any], StreamingBody],
KeyId: str,
MacAlgorithm: MacAlgorithmSpecType, # (1)
GrantTokens: NotRequired[Sequence[str]],
GenerateRandomRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GenerateRandomRequestRequestTypeDef
def get_value() -> GenerateRandomRequestRequestTypeDef:
return {
"NumberOfBytes": ...,
}
Definition
class GenerateRandomRequestRequestTypeDef(TypedDict):
NumberOfBytes: NotRequired[int],
CustomKeyStoreId: NotRequired[str],
GetKeyPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GetKeyPolicyRequestRequestTypeDef
def get_value() -> GetKeyPolicyRequestRequestTypeDef:
return {
"KeyId": ...,
"PolicyName": ...,
}
GetKeyRotationStatusRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GetKeyRotationStatusRequestRequestTypeDef
def get_value() -> GetKeyRotationStatusRequestRequestTypeDef:
return {
"KeyId": ...,
}
GetParametersForImportRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GetParametersForImportRequestRequestTypeDef
def get_value() -> GetParametersForImportRequestRequestTypeDef:
return {
"KeyId": ...,
"WrappingAlgorithm": ...,
"WrappingKeySpec": ...,
}
Definition
class GetParametersForImportRequestRequestTypeDef(TypedDict):
KeyId: str,
WrappingAlgorithm: AlgorithmSpecType, # (1)
WrappingKeySpec: WrappingKeySpecType, # (2)
- See AlgorithmSpecType
- See WrappingKeySpecType
GetPublicKeyRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GetPublicKeyRequestRequestTypeDef
def get_value() -> GetPublicKeyRequestRequestTypeDef:
return {
"KeyId": ...,
}
Definition
class GetPublicKeyRequestRequestTypeDef(TypedDict):
KeyId: str,
GrantTokens: NotRequired[Sequence[str]],
ImportKeyMaterialRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ImportKeyMaterialRequestRequestTypeDef
def get_value() -> ImportKeyMaterialRequestRequestTypeDef:
return {
"KeyId": ...,
"ImportToken": ...,
"EncryptedKeyMaterial": ...,
}
Definition
class ImportKeyMaterialRequestRequestTypeDef(TypedDict):
KeyId: str,
ImportToken: Union[str, bytes, IO[Any], StreamingBody],
EncryptedKeyMaterial: Union[str, bytes, IO[Any], StreamingBody],
ValidTo: NotRequired[Union[datetime, str]],
ExpirationModel: NotRequired[ExpirationModelTypeType], # (1)
KeyListEntryTypeDef
Usage Example
from mypy_boto3_kms.type_defs import KeyListEntryTypeDef
def get_value() -> KeyListEntryTypeDef:
return {
"KeyId": ...,
}
XksKeyConfigurationTypeTypeDef
Usage Example
from mypy_boto3_kms.type_defs import XksKeyConfigurationTypeTypeDef
def get_value() -> XksKeyConfigurationTypeTypeDef:
return {
"Id": ...,
}
ListAliasesRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListAliasesRequestRequestTypeDef
def get_value() -> ListAliasesRequestRequestTypeDef:
return {
"KeyId": ...,
}
Definition
class ListAliasesRequestRequestTypeDef(TypedDict):
KeyId: NotRequired[str],
Limit: NotRequired[int],
Marker: NotRequired[str],
ListGrantsRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListGrantsRequestRequestTypeDef
def get_value() -> ListGrantsRequestRequestTypeDef:
return {
"KeyId": ...,
}
Definition
class ListGrantsRequestRequestTypeDef(TypedDict):
KeyId: str,
Limit: NotRequired[int],
Marker: NotRequired[str],
GrantId: NotRequired[str],
GranteePrincipal: NotRequired[str],
ListKeyPoliciesRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListKeyPoliciesRequestRequestTypeDef
def get_value() -> ListKeyPoliciesRequestRequestTypeDef:
return {
"KeyId": ...,
}
Definition
class ListKeyPoliciesRequestRequestTypeDef(TypedDict):
KeyId: str,
Limit: NotRequired[int],
Marker: NotRequired[str],
ListKeysRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListKeysRequestRequestTypeDef
def get_value() -> ListKeysRequestRequestTypeDef:
return {
"Limit": ...,
}
Definition
class ListKeysRequestRequestTypeDef(TypedDict):
Limit: NotRequired[int],
Marker: NotRequired[str],
ListResourceTagsRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListResourceTagsRequestRequestTypeDef
def get_value() -> ListResourceTagsRequestRequestTypeDef:
return {
"KeyId": ...,
}
Definition
class ListResourceTagsRequestRequestTypeDef(TypedDict):
KeyId: str,
Limit: NotRequired[int],
Marker: NotRequired[str],
ListRetirableGrantsRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListRetirableGrantsRequestRequestTypeDef
def get_value() -> ListRetirableGrantsRequestRequestTypeDef:
return {
"RetiringPrincipal": ...,
}
Definition
class ListRetirableGrantsRequestRequestTypeDef(TypedDict):
RetiringPrincipal: str,
Limit: NotRequired[int],
Marker: NotRequired[str],
MultiRegionKeyTypeDef
Usage Example
from mypy_boto3_kms.type_defs import MultiRegionKeyTypeDef
def get_value() -> MultiRegionKeyTypeDef:
return {
"Arn": ...,
}
PutKeyPolicyRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import PutKeyPolicyRequestRequestTypeDef
def get_value() -> PutKeyPolicyRequestRequestTypeDef:
return {
"KeyId": ...,
"PolicyName": ...,
"Policy": ...,
}
Definition
class PutKeyPolicyRequestRequestTypeDef(TypedDict):
KeyId: str,
PolicyName: str,
Policy: str,
BypassPolicyLockoutSafetyCheck: NotRequired[bool],
ReEncryptRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ReEncryptRequestRequestTypeDef
def get_value() -> ReEncryptRequestRequestTypeDef:
return {
"CiphertextBlob": ...,
"DestinationKeyId": ...,
}
Definition
class ReEncryptRequestRequestTypeDef(TypedDict):
CiphertextBlob: Union[str, bytes, IO[Any], StreamingBody],
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]],
RetireGrantRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import RetireGrantRequestRequestTypeDef
def get_value() -> RetireGrantRequestRequestTypeDef:
return {
"GrantToken": ...,
}
Definition
class RetireGrantRequestRequestTypeDef(TypedDict):
GrantToken: NotRequired[str],
KeyId: NotRequired[str],
GrantId: NotRequired[str],
RevokeGrantRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import RevokeGrantRequestRequestTypeDef
def get_value() -> RevokeGrantRequestRequestTypeDef:
return {
"KeyId": ...,
"GrantId": ...,
}
ScheduleKeyDeletionRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ScheduleKeyDeletionRequestRequestTypeDef
def get_value() -> ScheduleKeyDeletionRequestRequestTypeDef:
return {
"KeyId": ...,
}
Definition
class ScheduleKeyDeletionRequestRequestTypeDef(TypedDict):
KeyId: str,
PendingWindowInDays: NotRequired[int],
SignRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import SignRequestRequestTypeDef
def get_value() -> SignRequestRequestTypeDef:
return {
"KeyId": ...,
"Message": ...,
"SigningAlgorithm": ...,
}
Definition
class SignRequestRequestTypeDef(TypedDict):
KeyId: str,
Message: Union[str, bytes, IO[Any], StreamingBody],
SigningAlgorithm: SigningAlgorithmSpecType, # (1)
MessageType: NotRequired[MessageTypeType], # (2)
GrantTokens: NotRequired[Sequence[str]],
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"KeyId": ...,
"TagKeys": ...,
}
UpdateAliasRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import UpdateAliasRequestRequestTypeDef
def get_value() -> UpdateAliasRequestRequestTypeDef:
return {
"AliasName": ...,
"TargetKeyId": ...,
}
UpdateKeyDescriptionRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import UpdateKeyDescriptionRequestRequestTypeDef
def get_value() -> UpdateKeyDescriptionRequestRequestTypeDef:
return {
"KeyId": ...,
"Description": ...,
}
UpdatePrimaryRegionRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import UpdatePrimaryRegionRequestRequestTypeDef
def get_value() -> UpdatePrimaryRegionRequestRequestTypeDef:
return {
"KeyId": ...,
"PrimaryRegion": ...,
}
Definition
class UpdatePrimaryRegionRequestRequestTypeDef(TypedDict):
KeyId: str,
PrimaryRegion: str,
VerifyMacRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import VerifyMacRequestRequestTypeDef
def get_value() -> VerifyMacRequestRequestTypeDef:
return {
"Message": ...,
"KeyId": ...,
"MacAlgorithm": ...,
"Mac": ...,
}
Definition
class VerifyMacRequestRequestTypeDef(TypedDict):
Message: Union[str, bytes, IO[Any], StreamingBody],
KeyId: str,
MacAlgorithm: MacAlgorithmSpecType, # (1)
Mac: Union[str, bytes, IO[Any], StreamingBody],
GrantTokens: NotRequired[Sequence[str]],
VerifyRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import VerifyRequestRequestTypeDef
def get_value() -> VerifyRequestRequestTypeDef:
return {
"KeyId": ...,
"Message": ...,
"Signature": ...,
"SigningAlgorithm": ...,
}
Definition
class VerifyRequestRequestTypeDef(TypedDict):
KeyId: str,
Message: Union[str, bytes, IO[Any], StreamingBody],
Signature: Union[str, bytes, IO[Any], StreamingBody],
SigningAlgorithm: SigningAlgorithmSpecType, # (1)
MessageType: NotRequired[MessageTypeType], # (2)
GrantTokens: NotRequired[Sequence[str]],
CancelKeyDeletionResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import CancelKeyDeletionResponseTypeDef
def get_value() -> CancelKeyDeletionResponseTypeDef:
return {
"KeyId": ...,
"ResponseMetadata": ...,
}
Definition
class CancelKeyDeletionResponseTypeDef(TypedDict):
KeyId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateCustomKeyStoreResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import CreateCustomKeyStoreResponseTypeDef
def get_value() -> CreateCustomKeyStoreResponseTypeDef:
return {
"CustomKeyStoreId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateCustomKeyStoreResponseTypeDef(TypedDict):
CustomKeyStoreId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateGrantResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import CreateGrantResponseTypeDef
def get_value() -> CreateGrantResponseTypeDef:
return {
"GrantToken": ...,
"GrantId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateGrantResponseTypeDef(TypedDict):
GrantToken: str,
GrantId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DecryptResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import DecryptResponseTypeDef
def get_value() -> DecryptResponseTypeDef:
return {
"KeyId": ...,
"Plaintext": ...,
"EncryptionAlgorithm": ...,
"ResponseMetadata": ...,
}
Definition
class DecryptResponseTypeDef(TypedDict):
KeyId: str,
Plaintext: bytes,
EncryptionAlgorithm: EncryptionAlgorithmSpecType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EmptyResponseMetadataTypeDef
Usage Example
from mypy_boto3_kms.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EncryptResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import EncryptResponseTypeDef
def get_value() -> EncryptResponseTypeDef:
return {
"CiphertextBlob": ...,
"KeyId": ...,
"EncryptionAlgorithm": ...,
"ResponseMetadata": ...,
}
Definition
class EncryptResponseTypeDef(TypedDict):
CiphertextBlob: bytes,
KeyId: str,
EncryptionAlgorithm: EncryptionAlgorithmSpecType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GenerateDataKeyPairResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GenerateDataKeyPairResponseTypeDef
def get_value() -> GenerateDataKeyPairResponseTypeDef:
return {
"PrivateKeyCiphertextBlob": ...,
"PrivateKeyPlaintext": ...,
"PublicKey": ...,
"KeyId": ...,
"KeyPairSpec": ...,
"ResponseMetadata": ...,
}
Definition
class GenerateDataKeyPairResponseTypeDef(TypedDict):
PrivateKeyCiphertextBlob: bytes,
PrivateKeyPlaintext: bytes,
PublicKey: bytes,
KeyId: str,
KeyPairSpec: DataKeyPairSpecType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GenerateDataKeyPairWithoutPlaintextResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GenerateDataKeyPairWithoutPlaintextResponseTypeDef
def get_value() -> GenerateDataKeyPairWithoutPlaintextResponseTypeDef:
return {
"PrivateKeyCiphertextBlob": ...,
"PublicKey": ...,
"KeyId": ...,
"KeyPairSpec": ...,
"ResponseMetadata": ...,
}
Definition
class GenerateDataKeyPairWithoutPlaintextResponseTypeDef(TypedDict):
PrivateKeyCiphertextBlob: bytes,
PublicKey: bytes,
KeyId: str,
KeyPairSpec: DataKeyPairSpecType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GenerateDataKeyResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GenerateDataKeyResponseTypeDef
def get_value() -> GenerateDataKeyResponseTypeDef:
return {
"CiphertextBlob": ...,
"Plaintext": ...,
"KeyId": ...,
"ResponseMetadata": ...,
}
Definition
class GenerateDataKeyResponseTypeDef(TypedDict):
CiphertextBlob: bytes,
Plaintext: bytes,
KeyId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GenerateDataKeyWithoutPlaintextResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GenerateDataKeyWithoutPlaintextResponseTypeDef
def get_value() -> GenerateDataKeyWithoutPlaintextResponseTypeDef:
return {
"CiphertextBlob": ...,
"KeyId": ...,
"ResponseMetadata": ...,
}
Definition
class GenerateDataKeyWithoutPlaintextResponseTypeDef(TypedDict):
CiphertextBlob: bytes,
KeyId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GenerateMacResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GenerateMacResponseTypeDef
def get_value() -> GenerateMacResponseTypeDef:
return {
"Mac": ...,
"MacAlgorithm": ...,
"KeyId": ...,
"ResponseMetadata": ...,
}
Definition
class GenerateMacResponseTypeDef(TypedDict):
Mac: bytes,
MacAlgorithm: MacAlgorithmSpecType, # (1)
KeyId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GenerateRandomResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GenerateRandomResponseTypeDef
def get_value() -> GenerateRandomResponseTypeDef:
return {
"Plaintext": ...,
"ResponseMetadata": ...,
}
Definition
class GenerateRandomResponseTypeDef(TypedDict):
Plaintext: bytes,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetKeyPolicyResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GetKeyPolicyResponseTypeDef
def get_value() -> GetKeyPolicyResponseTypeDef:
return {
"Policy": ...,
"ResponseMetadata": ...,
}
Definition
class GetKeyPolicyResponseTypeDef(TypedDict):
Policy: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetKeyRotationStatusResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GetKeyRotationStatusResponseTypeDef
def get_value() -> GetKeyRotationStatusResponseTypeDef:
return {
"KeyRotationEnabled": ...,
"ResponseMetadata": ...,
}
Definition
class GetKeyRotationStatusResponseTypeDef(TypedDict):
KeyRotationEnabled: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetParametersForImportResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GetParametersForImportResponseTypeDef
def get_value() -> GetParametersForImportResponseTypeDef:
return {
"KeyId": ...,
"ImportToken": ...,
"PublicKey": ...,
"ParametersValidTo": ...,
"ResponseMetadata": ...,
}
Definition
class GetParametersForImportResponseTypeDef(TypedDict):
KeyId: str,
ImportToken: bytes,
PublicKey: bytes,
ParametersValidTo: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetPublicKeyResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GetPublicKeyResponseTypeDef
def get_value() -> GetPublicKeyResponseTypeDef:
return {
"KeyId": ...,
"PublicKey": ...,
"CustomerMasterKeySpec": ...,
"KeySpec": ...,
"KeyUsage": ...,
"EncryptionAlgorithms": ...,
"SigningAlgorithms": ...,
"ResponseMetadata": ...,
}
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)
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See CustomerMasterKeySpecType
- See KeySpecType
- See KeyUsageTypeType
- See EncryptionAlgorithmSpecType
- See SigningAlgorithmSpecType
- See ResponseMetadataTypeDef
ListAliasesResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListAliasesResponseTypeDef
def get_value() -> ListAliasesResponseTypeDef:
return {
"Aliases": ...,
"NextMarker": ...,
"Truncated": ...,
"ResponseMetadata": ...,
}
Definition
class ListAliasesResponseTypeDef(TypedDict):
Aliases: List[AliasListEntryTypeDef], # (1)
NextMarker: str,
Truncated: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListKeyPoliciesResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListKeyPoliciesResponseTypeDef
def get_value() -> ListKeyPoliciesResponseTypeDef:
return {
"PolicyNames": ...,
"NextMarker": ...,
"Truncated": ...,
"ResponseMetadata": ...,
}
Definition
class ListKeyPoliciesResponseTypeDef(TypedDict):
PolicyNames: List[str],
NextMarker: str,
Truncated: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ReEncryptResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ReEncryptResponseTypeDef
def get_value() -> ReEncryptResponseTypeDef:
return {
"CiphertextBlob": ...,
"SourceKeyId": ...,
"KeyId": ...,
"SourceEncryptionAlgorithm": ...,
"DestinationEncryptionAlgorithm": ...,
"ResponseMetadata": ...,
}
Definition
class ReEncryptResponseTypeDef(TypedDict):
CiphertextBlob: bytes,
SourceKeyId: str,
KeyId: str,
SourceEncryptionAlgorithm: EncryptionAlgorithmSpecType, # (1)
DestinationEncryptionAlgorithm: EncryptionAlgorithmSpecType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ScheduleKeyDeletionResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ScheduleKeyDeletionResponseTypeDef
def get_value() -> ScheduleKeyDeletionResponseTypeDef:
return {
"KeyId": ...,
"DeletionDate": ...,
"KeyState": ...,
"PendingWindowInDays": ...,
"ResponseMetadata": ...,
}
Definition
class ScheduleKeyDeletionResponseTypeDef(TypedDict):
KeyId: str,
DeletionDate: datetime,
KeyState: KeyStateType, # (1)
PendingWindowInDays: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See KeyStateType
- See ResponseMetadataTypeDef
SignResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import SignResponseTypeDef
def get_value() -> SignResponseTypeDef:
return {
"KeyId": ...,
"Signature": ...,
"SigningAlgorithm": ...,
"ResponseMetadata": ...,
}
Definition
class SignResponseTypeDef(TypedDict):
KeyId: str,
Signature: bytes,
SigningAlgorithm: SigningAlgorithmSpecType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
VerifyMacResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import VerifyMacResponseTypeDef
def get_value() -> VerifyMacResponseTypeDef:
return {
"KeyId": ...,
"MacValid": ...,
"MacAlgorithm": ...,
"ResponseMetadata": ...,
}
Definition
class VerifyMacResponseTypeDef(TypedDict):
KeyId: str,
MacValid: bool,
MacAlgorithm: MacAlgorithmSpecType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
VerifyResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import VerifyResponseTypeDef
def get_value() -> VerifyResponseTypeDef:
return {
"KeyId": ...,
"SignatureValid": ...,
"SigningAlgorithm": ...,
"ResponseMetadata": ...,
}
Definition
class VerifyResponseTypeDef(TypedDict):
KeyId: str,
SignatureValid: bool,
SigningAlgorithm: SigningAlgorithmSpecType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateCustomKeyStoreRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import CreateCustomKeyStoreRequestRequestTypeDef
def get_value() -> CreateCustomKeyStoreRequestRequestTypeDef:
return {
"CustomKeyStoreName": ...,
}
Definition
class CreateCustomKeyStoreRequestRequestTypeDef(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)
- See CustomKeyStoreTypeType
- See XksProxyAuthenticationCredentialTypeTypeDef
- See XksProxyConnectivityTypeType
UpdateCustomKeyStoreRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import UpdateCustomKeyStoreRequestRequestTypeDef
def get_value() -> UpdateCustomKeyStoreRequestRequestTypeDef:
return {
"CustomKeyStoreId": ...,
}
Definition
class UpdateCustomKeyStoreRequestRequestTypeDef(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)
CreateGrantRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import CreateGrantRequestRequestTypeDef
def get_value() -> CreateGrantRequestRequestTypeDef:
return {
"KeyId": ...,
"GranteePrincipal": ...,
"Operations": ...,
}
Definition
class CreateGrantRequestRequestTypeDef(TypedDict):
KeyId: str,
GranteePrincipal: str,
Operations: Sequence[GrantOperationType], # (1)
RetiringPrincipal: NotRequired[str],
Constraints: NotRequired[GrantConstraintsTypeDef], # (2)
GrantTokens: NotRequired[Sequence[str]],
Name: NotRequired[str],
GrantListEntryTypeDef
Usage Example
from mypy_boto3_kms.type_defs import GrantListEntryTypeDef
def get_value() -> GrantListEntryTypeDef:
return {
"KeyId": ...,
}
Definition
class GrantListEntryTypeDef(TypedDict):
KeyId: NotRequired[str],
GrantId: NotRequired[str],
Name: NotRequired[str],
CreationDate: NotRequired[datetime],
GranteePrincipal: NotRequired[str],
RetiringPrincipal: NotRequired[str],
IssuingAccount: NotRequired[str],
Operations: NotRequired[List[GrantOperationType]], # (1)
Constraints: NotRequired[GrantConstraintsTypeDef], # (2)
CreateKeyRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import CreateKeyRequestRequestTypeDef
def get_value() -> CreateKeyRequestRequestTypeDef:
return {
"Policy": ...,
}
Definition
class CreateKeyRequestRequestTypeDef(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],
- See KeyUsageTypeType
- See CustomerMasterKeySpecType
- See KeySpecType
- See OriginTypeType
- See TagTypeDef
ListResourceTagsResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListResourceTagsResponseTypeDef
def get_value() -> ListResourceTagsResponseTypeDef:
return {
"Tags": ...,
"NextMarker": ...,
"Truncated": ...,
"ResponseMetadata": ...,
}
Definition
class ListResourceTagsResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
NextMarker: str,
Truncated: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
ReplicateKeyRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ReplicateKeyRequestRequestTypeDef
def get_value() -> ReplicateKeyRequestRequestTypeDef:
return {
"KeyId": ...,
"ReplicaRegion": ...,
}
Definition
class ReplicateKeyRequestRequestTypeDef(TypedDict):
KeyId: str,
ReplicaRegion: str,
Policy: NotRequired[str],
BypassPolicyLockoutSafetyCheck: NotRequired[bool],
Description: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_kms.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"KeyId": ...,
"Tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
KeyId: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CustomKeyStoresListEntryTypeDef
Usage Example
from mypy_boto3_kms.type_defs import CustomKeyStoresListEntryTypeDef
def get_value() -> CustomKeyStoresListEntryTypeDef:
return {
"CustomKeyStoreId": ...,
}
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],
CustomKeyStoreType: NotRequired[CustomKeyStoreTypeType], # (3)
XksProxyConfiguration: NotRequired[XksProxyConfigurationTypeTypeDef], # (4)
- See ConnectionStateTypeType
- See ConnectionErrorCodeTypeType
- See CustomKeyStoreTypeType
- See XksProxyConfigurationTypeTypeDef
DescribeCustomKeyStoresRequestDescribeCustomKeyStoresPaginateTypeDef
Usage Example
from mypy_boto3_kms.type_defs import DescribeCustomKeyStoresRequestDescribeCustomKeyStoresPaginateTypeDef
def get_value() -> DescribeCustomKeyStoresRequestDescribeCustomKeyStoresPaginateTypeDef:
return {
"CustomKeyStoreId": ...,
}
Definition
class DescribeCustomKeyStoresRequestDescribeCustomKeyStoresPaginateTypeDef(TypedDict):
CustomKeyStoreId: NotRequired[str],
CustomKeyStoreName: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAliasesRequestListAliasesPaginateTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListAliasesRequestListAliasesPaginateTypeDef
def get_value() -> ListAliasesRequestListAliasesPaginateTypeDef:
return {
"KeyId": ...,
}
Definition
class ListAliasesRequestListAliasesPaginateTypeDef(TypedDict):
KeyId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListGrantsRequestListGrantsPaginateTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListGrantsRequestListGrantsPaginateTypeDef
def get_value() -> ListGrantsRequestListGrantsPaginateTypeDef:
return {
"KeyId": ...,
}
Definition
class ListGrantsRequestListGrantsPaginateTypeDef(TypedDict):
KeyId: str,
GrantId: NotRequired[str],
GranteePrincipal: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListKeyPoliciesRequestListKeyPoliciesPaginateTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListKeyPoliciesRequestListKeyPoliciesPaginateTypeDef
def get_value() -> ListKeyPoliciesRequestListKeyPoliciesPaginateTypeDef:
return {
"KeyId": ...,
}
Definition
class ListKeyPoliciesRequestListKeyPoliciesPaginateTypeDef(TypedDict):
KeyId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListKeysRequestListKeysPaginateTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListKeysRequestListKeysPaginateTypeDef
def get_value() -> ListKeysRequestListKeysPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListKeysRequestListKeysPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListResourceTagsRequestListResourceTagsPaginateTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListResourceTagsRequestListResourceTagsPaginateTypeDef
def get_value() -> ListResourceTagsRequestListResourceTagsPaginateTypeDef:
return {
"KeyId": ...,
}
Definition
class ListResourceTagsRequestListResourceTagsPaginateTypeDef(TypedDict):
KeyId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRetirableGrantsRequestListRetirableGrantsPaginateTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListRetirableGrantsRequestListRetirableGrantsPaginateTypeDef
def get_value() -> ListRetirableGrantsRequestListRetirableGrantsPaginateTypeDef:
return {
"RetiringPrincipal": ...,
}
Definition
class ListRetirableGrantsRequestListRetirableGrantsPaginateTypeDef(TypedDict):
RetiringPrincipal: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListKeysResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListKeysResponseTypeDef
def get_value() -> ListKeysResponseTypeDef:
return {
"Keys": ...,
"NextMarker": ...,
"Truncated": ...,
"ResponseMetadata": ...,
}
Definition
class ListKeysResponseTypeDef(TypedDict):
Keys: List[KeyListEntryTypeDef], # (1)
NextMarker: str,
Truncated: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
MultiRegionConfigurationTypeDef
Usage Example
from mypy_boto3_kms.type_defs import MultiRegionConfigurationTypeDef
def get_value() -> MultiRegionConfigurationTypeDef:
return {
"MultiRegionKeyType": ...,
}
Definition
class MultiRegionConfigurationTypeDef(TypedDict):
MultiRegionKeyType: NotRequired[MultiRegionKeyTypeType], # (1)
PrimaryKey: NotRequired[MultiRegionKeyTypeDef], # (2)
ReplicaKeys: NotRequired[List[MultiRegionKeyTypeDef]], # (3)
ListGrantsResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ListGrantsResponseTypeDef
def get_value() -> ListGrantsResponseTypeDef:
return {
"Grants": ...,
"NextMarker": ...,
"Truncated": ...,
"ResponseMetadata": ...,
}
Definition
class ListGrantsResponseTypeDef(TypedDict):
Grants: List[GrantListEntryTypeDef], # (1)
NextMarker: str,
Truncated: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeCustomKeyStoresResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import DescribeCustomKeyStoresResponseTypeDef
def get_value() -> DescribeCustomKeyStoresResponseTypeDef:
return {
"CustomKeyStores": ...,
"NextMarker": ...,
"Truncated": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeCustomKeyStoresResponseTypeDef(TypedDict):
CustomKeyStores: List[CustomKeyStoresListEntryTypeDef], # (1)
NextMarker: str,
Truncated: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
KeyMetadataTypeDef
Usage Example
from mypy_boto3_kms.type_defs import KeyMetadataTypeDef
def get_value() -> KeyMetadataTypeDef:
return {
"KeyId": ...,
}
Definition
class KeyMetadataTypeDef(TypedDict):
KeyId: str,
AWSAccountId: NotRequired[str],
Arn: NotRequired[str],
CreationDate: NotRequired[datetime],
Enabled: NotRequired[bool],
Description: NotRequired[str],
KeyUsage: NotRequired[KeyUsageTypeType], # (1)
KeyState: NotRequired[KeyStateType], # (2)
DeletionDate: NotRequired[datetime],
ValidTo: NotRequired[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)
MultiRegion: NotRequired[bool],
MultiRegionConfiguration: NotRequired[MultiRegionConfigurationTypeDef], # (10)
PendingDeletionWindowInDays: NotRequired[int],
MacAlgorithms: NotRequired[List[MacAlgorithmSpecType]], # (11)
XksKeyConfiguration: NotRequired[XksKeyConfigurationTypeTypeDef], # (12)
- See KeyUsageTypeType
- See KeyStateType
- See OriginTypeType
- See ExpirationModelTypeType
- See KeyManagerTypeType
- See CustomerMasterKeySpecType
- See KeySpecType
- See EncryptionAlgorithmSpecType
- See SigningAlgorithmSpecType
- See MultiRegionConfigurationTypeDef
- See MacAlgorithmSpecType
- See XksKeyConfigurationTypeTypeDef
CreateKeyResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import CreateKeyResponseTypeDef
def get_value() -> CreateKeyResponseTypeDef:
return {
"KeyMetadata": ...,
"ResponseMetadata": ...,
}
Definition
class CreateKeyResponseTypeDef(TypedDict):
KeyMetadata: KeyMetadataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeKeyResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import DescribeKeyResponseTypeDef
def get_value() -> DescribeKeyResponseTypeDef:
return {
"KeyMetadata": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeKeyResponseTypeDef(TypedDict):
KeyMetadata: KeyMetadataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ReplicateKeyResponseTypeDef
Usage Example
from mypy_boto3_kms.type_defs import ReplicateKeyResponseTypeDef
def get_value() -> ReplicateKeyResponseTypeDef:
return {
"ReplicaKeyMetadata": ...,
"ReplicaPolicy": ...,
"ReplicaTags": ...,
"ResponseMetadata": ...,
}
Definition
class ReplicateKeyResponseTypeDef(TypedDict):
ReplicaKeyMetadata: KeyMetadataTypeDef, # (1)
ReplicaPolicy: str,
ReplicaTags: List[TagTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See KeyMetadataTypeDef
- See TagTypeDef
- See ResponseMetadataTypeDef