Type definitions#
Index > PaymentCryptographyControlPlane > Type definitions
Auto-generated documentation for PaymentCryptographyControlPlane type annotations stubs module mypy-boto3-payment-cryptography.
AddKeyReplicationRegionsInputTypeDef#
# AddKeyReplicationRegionsInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import AddKeyReplicationRegionsInputTypeDef
def get_value() -> AddKeyReplicationRegionsInputTypeDef:
return {
"KeyIdentifier": ...,
}
# AddKeyReplicationRegionsInputTypeDef definition
class AddKeyReplicationRegionsInputTypeDef(TypedDict):
KeyIdentifier: str,
ReplicationRegions: Sequence[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.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],
AliasTypeDef#
# AliasTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import AliasTypeDef
def get_value() -> AliasTypeDef:
return {
"AliasName": ...,
}
# AliasTypeDef definition
class AliasTypeDef(TypedDict):
AliasName: str,
KeyArn: NotRequired[str],
CertificateSubjectTypeTypeDef#
# CertificateSubjectTypeTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import CertificateSubjectTypeTypeDef
def get_value() -> CertificateSubjectTypeTypeDef:
return {
"CommonName": ...,
}
# CertificateSubjectTypeTypeDef definition
class CertificateSubjectTypeTypeDef(TypedDict):
CommonName: str,
OrganizationUnit: NotRequired[str],
Organization: NotRequired[str],
City: NotRequired[str],
Country: NotRequired[str],
StateOrProvince: NotRequired[str],
EmailAddress: NotRequired[str],
CreateAliasInputTypeDef#
# CreateAliasInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import CreateAliasInputTypeDef
def get_value() -> CreateAliasInputTypeDef:
return {
"AliasName": ...,
}
# CreateAliasInputTypeDef definition
class CreateAliasInputTypeDef(TypedDict):
AliasName: str,
KeyArn: NotRequired[str],
TagTypeDef#
# TagTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
DeleteAliasInputTypeDef#
# DeleteAliasInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import DeleteAliasInputTypeDef
def get_value() -> DeleteAliasInputTypeDef:
return {
"AliasName": ...,
}
# DeleteAliasInputTypeDef definition
class DeleteAliasInputTypeDef(TypedDict):
AliasName: str,
DeleteKeyInputTypeDef#
# DeleteKeyInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import DeleteKeyInputTypeDef
def get_value() -> DeleteKeyInputTypeDef:
return {
"KeyIdentifier": ...,
}
# DeleteKeyInputTypeDef definition
class DeleteKeyInputTypeDef(TypedDict):
KeyIdentifier: str,
DeleteKeyInDays: NotRequired[int],
DiffieHellmanDerivationDataTypeDef#
# DiffieHellmanDerivationDataTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import DiffieHellmanDerivationDataTypeDef
def get_value() -> DiffieHellmanDerivationDataTypeDef:
return {
"SharedInformation": ...,
}
# DiffieHellmanDerivationDataTypeDef definition
class DiffieHellmanDerivationDataTypeDef(TypedDict):
SharedInformation: NotRequired[str],
DisableDefaultKeyReplicationRegionsInputTypeDef#
# DisableDefaultKeyReplicationRegionsInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import DisableDefaultKeyReplicationRegionsInputTypeDef
def get_value() -> DisableDefaultKeyReplicationRegionsInputTypeDef:
return {
"ReplicationRegions": ...,
}
# DisableDefaultKeyReplicationRegionsInputTypeDef definition
class DisableDefaultKeyReplicationRegionsInputTypeDef(TypedDict):
ReplicationRegions: Sequence[str],
EnableDefaultKeyReplicationRegionsInputTypeDef#
# EnableDefaultKeyReplicationRegionsInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import EnableDefaultKeyReplicationRegionsInputTypeDef
def get_value() -> EnableDefaultKeyReplicationRegionsInputTypeDef:
return {
"ReplicationRegions": ...,
}
# EnableDefaultKeyReplicationRegionsInputTypeDef definition
class EnableDefaultKeyReplicationRegionsInputTypeDef(TypedDict):
ReplicationRegions: Sequence[str],
ExportDukptInitialKeyTypeDef#
# ExportDukptInitialKeyTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ExportDukptInitialKeyTypeDef
def get_value() -> ExportDukptInitialKeyTypeDef:
return {
"KeySerialNumber": ...,
}
# ExportDukptInitialKeyTypeDef definition
class ExportDukptInitialKeyTypeDef(TypedDict):
KeySerialNumber: str,
ExportKeyCryptogramTypeDef#
# ExportKeyCryptogramTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ExportKeyCryptogramTypeDef
def get_value() -> ExportKeyCryptogramTypeDef:
return {
"CertificateAuthorityPublicKeyIdentifier": ...,
}
# ExportKeyCryptogramTypeDef definition
class ExportKeyCryptogramTypeDef(TypedDict):
CertificateAuthorityPublicKeyIdentifier: str,
WrappingKeyCertificate: str,
WrappingSpec: NotRequired[WrappingKeySpecType], # (1)
WrappedKeyTypeDef#
# WrappedKeyTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import WrappedKeyTypeDef
def get_value() -> WrappedKeyTypeDef:
return {
"WrappingKeyArn": ...,
}
# WrappedKeyTypeDef definition
class WrappedKeyTypeDef(TypedDict):
WrappingKeyArn: str,
WrappedKeyMaterialFormat: WrappedKeyMaterialFormatType, # (1)
KeyMaterial: str,
KeyCheckValue: NotRequired[str],
KeyCheckValueAlgorithm: NotRequired[KeyCheckValueAlgorithmType], # (2)
GetAliasInputTypeDef#
# GetAliasInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import GetAliasInputTypeDef
def get_value() -> GetAliasInputTypeDef:
return {
"AliasName": ...,
}
# GetAliasInputTypeDef definition
class GetAliasInputTypeDef(TypedDict):
AliasName: str,
GetKeyInputTypeDef#
# GetKeyInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import GetKeyInputTypeDef
def get_value() -> GetKeyInputTypeDef:
return {
"KeyIdentifier": ...,
}
# GetKeyInputTypeDef definition
class GetKeyInputTypeDef(TypedDict):
KeyIdentifier: str,
GetParametersForExportInputTypeDef#
# GetParametersForExportInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import GetParametersForExportInputTypeDef
def get_value() -> GetParametersForExportInputTypeDef:
return {
"KeyMaterialType": ...,
}
# GetParametersForExportInputTypeDef definition
class GetParametersForExportInputTypeDef(TypedDict):
KeyMaterialType: KeyMaterialTypeType, # (1)
SigningKeyAlgorithm: KeyAlgorithmType, # (2)
- See KeyMaterialTypeType
- See KeyAlgorithmType
GetParametersForImportInputTypeDef#
# GetParametersForImportInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import GetParametersForImportInputTypeDef
def get_value() -> GetParametersForImportInputTypeDef:
return {
"KeyMaterialType": ...,
}
# GetParametersForImportInputTypeDef definition
class GetParametersForImportInputTypeDef(TypedDict):
KeyMaterialType: KeyMaterialTypeType, # (1)
WrappingKeyAlgorithm: KeyAlgorithmType, # (2)
- See KeyMaterialTypeType
- See KeyAlgorithmType
GetPublicKeyCertificateInputTypeDef#
# GetPublicKeyCertificateInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import GetPublicKeyCertificateInputTypeDef
def get_value() -> GetPublicKeyCertificateInputTypeDef:
return {
"KeyIdentifier": ...,
}
# GetPublicKeyCertificateInputTypeDef definition
class GetPublicKeyCertificateInputTypeDef(TypedDict):
KeyIdentifier: str,
ImportTr31KeyBlockTypeDef#
# ImportTr31KeyBlockTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ImportTr31KeyBlockTypeDef
def get_value() -> ImportTr31KeyBlockTypeDef:
return {
"WrappingKeyIdentifier": ...,
}
# ImportTr31KeyBlockTypeDef definition
class ImportTr31KeyBlockTypeDef(TypedDict):
WrappingKeyIdentifier: str,
WrappedKeyBlock: str,
ImportTr34KeyBlockTypeDef#
# ImportTr34KeyBlockTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ImportTr34KeyBlockTypeDef
def get_value() -> ImportTr34KeyBlockTypeDef:
return {
"CertificateAuthorityPublicKeyIdentifier": ...,
}
# ImportTr34KeyBlockTypeDef definition
class ImportTr34KeyBlockTypeDef(TypedDict):
CertificateAuthorityPublicKeyIdentifier: str,
SigningKeyCertificate: str,
WrappedKeyBlock: str,
KeyBlockFormat: Tr34KeyBlockFormatType, # (1)
ImportToken: NotRequired[str],
WrappingKeyIdentifier: NotRequired[str],
WrappingKeyCertificate: NotRequired[str],
RandomNonce: NotRequired[str],
KeyModesOfUseTypeDef#
# KeyModesOfUseTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import KeyModesOfUseTypeDef
def get_value() -> KeyModesOfUseTypeDef:
return {
"Encrypt": ...,
}
# KeyModesOfUseTypeDef definition
class KeyModesOfUseTypeDef(TypedDict):
Encrypt: NotRequired[bool],
Decrypt: NotRequired[bool],
Wrap: NotRequired[bool],
Unwrap: NotRequired[bool],
Generate: NotRequired[bool],
Sign: NotRequired[bool],
Verify: NotRequired[bool],
DeriveKey: NotRequired[bool],
NoRestrictions: NotRequired[bool],
ReplicationStatusTypeTypeDef#
# ReplicationStatusTypeTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ReplicationStatusTypeTypeDef
def get_value() -> ReplicationStatusTypeTypeDef:
return {
"Status": ...,
}
# ReplicationStatusTypeTypeDef definition
class ReplicationStatusTypeTypeDef(TypedDict):
Status: KeyReplicationStateType, # (1)
StatusMessage: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListAliasesInputTypeDef#
# ListAliasesInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ListAliasesInputTypeDef
def get_value() -> ListAliasesInputTypeDef:
return {
"KeyArn": ...,
}
# ListAliasesInputTypeDef definition
class ListAliasesInputTypeDef(TypedDict):
KeyArn: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListKeysInputTypeDef#
# ListKeysInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ListKeysInputTypeDef
def get_value() -> ListKeysInputTypeDef:
return {
"KeyState": ...,
}
# ListKeysInputTypeDef definition
class ListKeysInputTypeDef(TypedDict):
KeyState: NotRequired[KeyStateType], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See KeyStateType
ListTagsForResourceInputTypeDef#
# ListTagsForResourceInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ListTagsForResourceInputTypeDef
def get_value() -> ListTagsForResourceInputTypeDef:
return {
"ResourceArn": ...,
}
# ListTagsForResourceInputTypeDef definition
class ListTagsForResourceInputTypeDef(TypedDict):
ResourceArn: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
RemoveKeyReplicationRegionsInputTypeDef#
# RemoveKeyReplicationRegionsInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import RemoveKeyReplicationRegionsInputTypeDef
def get_value() -> RemoveKeyReplicationRegionsInputTypeDef:
return {
"KeyIdentifier": ...,
}
# RemoveKeyReplicationRegionsInputTypeDef definition
class RemoveKeyReplicationRegionsInputTypeDef(TypedDict):
KeyIdentifier: str,
ReplicationRegions: Sequence[str],
RestoreKeyInputTypeDef#
# RestoreKeyInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import RestoreKeyInputTypeDef
def get_value() -> RestoreKeyInputTypeDef:
return {
"KeyIdentifier": ...,
}
# RestoreKeyInputTypeDef definition
class RestoreKeyInputTypeDef(TypedDict):
KeyIdentifier: str,
StartKeyUsageInputTypeDef#
# StartKeyUsageInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import StartKeyUsageInputTypeDef
def get_value() -> StartKeyUsageInputTypeDef:
return {
"KeyIdentifier": ...,
}
# StartKeyUsageInputTypeDef definition
class StartKeyUsageInputTypeDef(TypedDict):
KeyIdentifier: str,
StopKeyUsageInputTypeDef#
# StopKeyUsageInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import StopKeyUsageInputTypeDef
def get_value() -> StopKeyUsageInputTypeDef:
return {
"KeyIdentifier": ...,
}
# StopKeyUsageInputTypeDef definition
class StopKeyUsageInputTypeDef(TypedDict):
KeyIdentifier: str,
UntagResourceInputTypeDef#
# UntagResourceInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import UntagResourceInputTypeDef
def get_value() -> UntagResourceInputTypeDef:
return {
"ResourceArn": ...,
}
# UntagResourceInputTypeDef definition
class UntagResourceInputTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
UpdateAliasInputTypeDef#
# UpdateAliasInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import UpdateAliasInputTypeDef
def get_value() -> UpdateAliasInputTypeDef:
return {
"AliasName": ...,
}
# UpdateAliasInputTypeDef definition
class UpdateAliasInputTypeDef(TypedDict):
AliasName: str,
KeyArn: NotRequired[str],
DisableDefaultKeyReplicationRegionsOutputTypeDef#
# DisableDefaultKeyReplicationRegionsOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import DisableDefaultKeyReplicationRegionsOutputTypeDef
def get_value() -> DisableDefaultKeyReplicationRegionsOutputTypeDef:
return {
"EnabledReplicationRegions": ...,
}
# DisableDefaultKeyReplicationRegionsOutputTypeDef definition
class DisableDefaultKeyReplicationRegionsOutputTypeDef(TypedDict):
EnabledReplicationRegions: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EnableDefaultKeyReplicationRegionsOutputTypeDef#
# EnableDefaultKeyReplicationRegionsOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import EnableDefaultKeyReplicationRegionsOutputTypeDef
def get_value() -> EnableDefaultKeyReplicationRegionsOutputTypeDef:
return {
"EnabledReplicationRegions": ...,
}
# EnableDefaultKeyReplicationRegionsOutputTypeDef definition
class EnableDefaultKeyReplicationRegionsOutputTypeDef(TypedDict):
EnabledReplicationRegions: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetCertificateSigningRequestOutputTypeDef#
# GetCertificateSigningRequestOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import GetCertificateSigningRequestOutputTypeDef
def get_value() -> GetCertificateSigningRequestOutputTypeDef:
return {
"CertificateSigningRequest": ...,
}
# GetCertificateSigningRequestOutputTypeDef definition
class GetCertificateSigningRequestOutputTypeDef(TypedDict):
CertificateSigningRequest: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetDefaultKeyReplicationRegionsOutputTypeDef#
# GetDefaultKeyReplicationRegionsOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import GetDefaultKeyReplicationRegionsOutputTypeDef
def get_value() -> GetDefaultKeyReplicationRegionsOutputTypeDef:
return {
"EnabledReplicationRegions": ...,
}
# GetDefaultKeyReplicationRegionsOutputTypeDef definition
class GetDefaultKeyReplicationRegionsOutputTypeDef(TypedDict):
EnabledReplicationRegions: list[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetParametersForExportOutputTypeDef#
# GetParametersForExportOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import GetParametersForExportOutputTypeDef
def get_value() -> GetParametersForExportOutputTypeDef:
return {
"SigningKeyCertificate": ...,
}
# GetParametersForExportOutputTypeDef definition
class GetParametersForExportOutputTypeDef(TypedDict):
SigningKeyCertificate: str,
SigningKeyCertificateChain: str,
SigningKeyAlgorithm: KeyAlgorithmType, # (1)
ExportToken: str,
ParametersValidUntilTimestamp: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetParametersForImportOutputTypeDef#
# GetParametersForImportOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import GetParametersForImportOutputTypeDef
def get_value() -> GetParametersForImportOutputTypeDef:
return {
"WrappingKeyCertificate": ...,
}
# GetParametersForImportOutputTypeDef definition
class GetParametersForImportOutputTypeDef(TypedDict):
WrappingKeyCertificate: str,
WrappingKeyCertificateChain: str,
WrappingKeyAlgorithm: KeyAlgorithmType, # (1)
ImportToken: str,
ParametersValidUntilTimestamp: datetime.datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetPublicKeyCertificateOutputTypeDef#
# GetPublicKeyCertificateOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import GetPublicKeyCertificateOutputTypeDef
def get_value() -> GetPublicKeyCertificateOutputTypeDef:
return {
"KeyCertificate": ...,
}
# GetPublicKeyCertificateOutputTypeDef definition
class GetPublicKeyCertificateOutputTypeDef(TypedDict):
KeyCertificate: str,
KeyCertificateChain: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateAliasOutputTypeDef#
# CreateAliasOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import CreateAliasOutputTypeDef
def get_value() -> CreateAliasOutputTypeDef:
return {
"Alias": ...,
}
# CreateAliasOutputTypeDef definition
class CreateAliasOutputTypeDef(TypedDict):
Alias: AliasTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AliasTypeDef
- See ResponseMetadataTypeDef
GetAliasOutputTypeDef#
# GetAliasOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import GetAliasOutputTypeDef
def get_value() -> GetAliasOutputTypeDef:
return {
"Alias": ...,
}
# GetAliasOutputTypeDef definition
class GetAliasOutputTypeDef(TypedDict):
Alias: AliasTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AliasTypeDef
- See ResponseMetadataTypeDef
ListAliasesOutputTypeDef#
# ListAliasesOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ListAliasesOutputTypeDef
def get_value() -> ListAliasesOutputTypeDef:
return {
"Aliases": ...,
}
# ListAliasesOutputTypeDef definition
class ListAliasesOutputTypeDef(TypedDict):
Aliases: list[AliasTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See
list[AliasTypeDef] - See ResponseMetadataTypeDef
UpdateAliasOutputTypeDef#
# UpdateAliasOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import UpdateAliasOutputTypeDef
def get_value() -> UpdateAliasOutputTypeDef:
return {
"Alias": ...,
}
# UpdateAliasOutputTypeDef definition
class UpdateAliasOutputTypeDef(TypedDict):
Alias: AliasTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AliasTypeDef
- See ResponseMetadataTypeDef
GetCertificateSigningRequestInputTypeDef#
# GetCertificateSigningRequestInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import GetCertificateSigningRequestInputTypeDef
def get_value() -> GetCertificateSigningRequestInputTypeDef:
return {
"KeyIdentifier": ...,
}
# GetCertificateSigningRequestInputTypeDef definition
class GetCertificateSigningRequestInputTypeDef(TypedDict):
KeyIdentifier: str,
SigningAlgorithm: SigningAlgorithmTypeType, # (1)
CertificateSubject: CertificateSubjectTypeTypeDef, # (2)
ListTagsForResourceOutputTypeDef#
# ListTagsForResourceOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ListTagsForResourceOutputTypeDef
def get_value() -> ListTagsForResourceOutputTypeDef:
return {
"Tags": ...,
}
# ListTagsForResourceOutputTypeDef definition
class ListTagsForResourceOutputTypeDef(TypedDict):
Tags: list[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See
list[TagTypeDef] - See ResponseMetadataTypeDef
TagResourceInputTypeDef#
# TagResourceInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import TagResourceInputTypeDef
def get_value() -> TagResourceInputTypeDef:
return {
"ResourceArn": ...,
}
# TagResourceInputTypeDef definition
class TagResourceInputTypeDef(TypedDict):
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
- See
Sequence[TagTypeDef]
ImportDiffieHellmanTr31KeyBlockTypeDef#
# ImportDiffieHellmanTr31KeyBlockTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ImportDiffieHellmanTr31KeyBlockTypeDef
def get_value() -> ImportDiffieHellmanTr31KeyBlockTypeDef:
return {
"PrivateKeyIdentifier": ...,
}
# ImportDiffieHellmanTr31KeyBlockTypeDef definition
class ImportDiffieHellmanTr31KeyBlockTypeDef(TypedDict):
PrivateKeyIdentifier: str,
CertificateAuthorityPublicKeyIdentifier: str,
PublicKeyCertificate: str,
DeriveKeyAlgorithm: SymmetricKeyAlgorithmType, # (1)
KeyDerivationFunction: KeyDerivationFunctionType, # (2)
KeyDerivationHashAlgorithm: KeyDerivationHashAlgorithmType, # (3)
DerivationData: DiffieHellmanDerivationDataTypeDef, # (4)
WrappedKeyBlock: str,
- See SymmetricKeyAlgorithmType
- See KeyDerivationFunctionType
- See KeyDerivationHashAlgorithmType
- See DiffieHellmanDerivationDataTypeDef
ExportAttributesTypeDef#
# ExportAttributesTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ExportAttributesTypeDef
def get_value() -> ExportAttributesTypeDef:
return {
"ExportDukptInitialKey": ...,
}
# ExportAttributesTypeDef definition
class ExportAttributesTypeDef(TypedDict):
ExportDukptInitialKey: NotRequired[ExportDukptInitialKeyTypeDef], # (1)
KeyCheckValueAlgorithm: NotRequired[KeyCheckValueAlgorithmType], # (2)
ExportKeyOutputTypeDef#
# ExportKeyOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ExportKeyOutputTypeDef
def get_value() -> ExportKeyOutputTypeDef:
return {
"WrappedKey": ...,
}
# ExportKeyOutputTypeDef definition
class ExportKeyOutputTypeDef(TypedDict):
WrappedKey: WrappedKeyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
KeyAttributesTypeDef#
# KeyAttributesTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import KeyAttributesTypeDef
def get_value() -> KeyAttributesTypeDef:
return {
"KeyUsage": ...,
}
# KeyAttributesTypeDef definition
class KeyAttributesTypeDef(TypedDict):
KeyUsage: KeyUsageType, # (1)
KeyClass: KeyClassType, # (2)
KeyAlgorithm: KeyAlgorithmType, # (3)
KeyModesOfUse: KeyModesOfUseTypeDef, # (4)
- See KeyUsageType
- See KeyClassType
- See KeyAlgorithmType
- See KeyModesOfUseTypeDef
KeyBlockHeadersTypeDef#
# KeyBlockHeadersTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import KeyBlockHeadersTypeDef
def get_value() -> KeyBlockHeadersTypeDef:
return {
"KeyModesOfUse": ...,
}
# KeyBlockHeadersTypeDef definition
class KeyBlockHeadersTypeDef(TypedDict):
KeyModesOfUse: NotRequired[KeyModesOfUseTypeDef], # (1)
KeyExportability: NotRequired[KeyExportabilityType], # (2)
KeyVersion: NotRequired[str],
OptionalBlocks: NotRequired[Mapping[str, str]],
ListAliasesInputPaginateTypeDef#
# ListAliasesInputPaginateTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ListAliasesInputPaginateTypeDef
def get_value() -> ListAliasesInputPaginateTypeDef:
return {
"KeyArn": ...,
}
# ListAliasesInputPaginateTypeDef definition
class ListAliasesInputPaginateTypeDef(TypedDict):
KeyArn: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListKeysInputPaginateTypeDef#
# ListKeysInputPaginateTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ListKeysInputPaginateTypeDef
def get_value() -> ListKeysInputPaginateTypeDef:
return {
"KeyState": ...,
}
# ListKeysInputPaginateTypeDef definition
class ListKeysInputPaginateTypeDef(TypedDict):
KeyState: NotRequired[KeyStateType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See KeyStateType
- See PaginatorConfigTypeDef
ListTagsForResourceInputPaginateTypeDef#
# ListTagsForResourceInputPaginateTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ListTagsForResourceInputPaginateTypeDef
def get_value() -> ListTagsForResourceInputPaginateTypeDef:
return {
"ResourceArn": ...,
}
# ListTagsForResourceInputPaginateTypeDef definition
class ListTagsForResourceInputPaginateTypeDef(TypedDict):
ResourceArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
CreateKeyInputTypeDef#
# CreateKeyInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import CreateKeyInputTypeDef
def get_value() -> CreateKeyInputTypeDef:
return {
"KeyAttributes": ...,
}
# CreateKeyInputTypeDef definition
class CreateKeyInputTypeDef(TypedDict):
KeyAttributes: KeyAttributesTypeDef, # (1)
Exportable: bool,
KeyCheckValueAlgorithm: NotRequired[KeyCheckValueAlgorithmType], # (2)
Enabled: NotRequired[bool],
Tags: NotRequired[Sequence[TagTypeDef]], # (3)
DeriveKeyUsage: NotRequired[DeriveKeyUsageType], # (4)
ReplicationRegions: NotRequired[Sequence[str]],
- See KeyAttributesTypeDef
- See KeyCheckValueAlgorithmType
- See
Sequence[TagTypeDef] - See DeriveKeyUsageType
ImportKeyCryptogramTypeDef#
# ImportKeyCryptogramTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ImportKeyCryptogramTypeDef
def get_value() -> ImportKeyCryptogramTypeDef:
return {
"KeyAttributes": ...,
}
# ImportKeyCryptogramTypeDef definition
class ImportKeyCryptogramTypeDef(TypedDict):
KeyAttributes: KeyAttributesTypeDef, # (1)
Exportable: bool,
WrappedKeyCryptogram: str,
ImportToken: str,
WrappingSpec: NotRequired[WrappingKeySpecType], # (2)
KeySummaryTypeDef#
# KeySummaryTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import KeySummaryTypeDef
def get_value() -> KeySummaryTypeDef:
return {
"KeyArn": ...,
}
# KeySummaryTypeDef definition
class KeySummaryTypeDef(TypedDict):
KeyArn: str,
KeyState: KeyStateType, # (1)
KeyAttributes: KeyAttributesTypeDef, # (2)
KeyCheckValue: str,
Exportable: bool,
Enabled: bool,
MultiRegionKeyType: NotRequired[MultiRegionKeyTypeType], # (3)
PrimaryRegion: NotRequired[str],
- See KeyStateType
- See KeyAttributesTypeDef
- See MultiRegionKeyTypeType
KeyTypeDef#
# KeyTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import KeyTypeDef
def get_value() -> KeyTypeDef:
return {
"KeyArn": ...,
}
# KeyTypeDef definition
class KeyTypeDef(TypedDict):
KeyArn: str,
KeyAttributes: KeyAttributesTypeDef, # (1)
KeyCheckValue: str,
KeyCheckValueAlgorithm: KeyCheckValueAlgorithmType, # (2)
Enabled: bool,
Exportable: bool,
KeyState: KeyStateType, # (3)
KeyOrigin: KeyOriginType, # (4)
CreateTimestamp: datetime.datetime,
UsageStartTimestamp: NotRequired[datetime.datetime],
UsageStopTimestamp: NotRequired[datetime.datetime],
DeletePendingTimestamp: NotRequired[datetime.datetime],
DeleteTimestamp: NotRequired[datetime.datetime],
DeriveKeyUsage: NotRequired[DeriveKeyUsageType], # (5)
MultiRegionKeyType: NotRequired[MultiRegionKeyTypeType], # (6)
PrimaryRegion: NotRequired[str],
ReplicationStatus: NotRequired[dict[str, ReplicationStatusTypeTypeDef]], # (7)
UsingDefaultReplicationRegions: NotRequired[bool],
- See KeyAttributesTypeDef
- See KeyCheckValueAlgorithmType
- See KeyStateType
- See KeyOriginType
- See DeriveKeyUsageType
- See MultiRegionKeyTypeType
- See
dict[str, ReplicationStatusTypeTypeDef]
RootCertificatePublicKeyTypeDef#
# RootCertificatePublicKeyTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import RootCertificatePublicKeyTypeDef
def get_value() -> RootCertificatePublicKeyTypeDef:
return {
"KeyAttributes": ...,
}
# RootCertificatePublicKeyTypeDef definition
class RootCertificatePublicKeyTypeDef(TypedDict):
KeyAttributes: KeyAttributesTypeDef, # (1)
PublicKeyCertificate: str,
TrustedCertificatePublicKeyTypeDef#
# TrustedCertificatePublicKeyTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import TrustedCertificatePublicKeyTypeDef
def get_value() -> TrustedCertificatePublicKeyTypeDef:
return {
"KeyAttributes": ...,
}
# TrustedCertificatePublicKeyTypeDef definition
class TrustedCertificatePublicKeyTypeDef(TypedDict):
KeyAttributes: KeyAttributesTypeDef, # (1)
PublicKeyCertificate: str,
CertificateAuthorityPublicKeyIdentifier: str,
ExportDiffieHellmanTr31KeyBlockTypeDef#
# ExportDiffieHellmanTr31KeyBlockTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ExportDiffieHellmanTr31KeyBlockTypeDef
def get_value() -> ExportDiffieHellmanTr31KeyBlockTypeDef:
return {
"PrivateKeyIdentifier": ...,
}
# ExportDiffieHellmanTr31KeyBlockTypeDef definition
class ExportDiffieHellmanTr31KeyBlockTypeDef(TypedDict):
PrivateKeyIdentifier: str,
CertificateAuthorityPublicKeyIdentifier: str,
PublicKeyCertificate: str,
DeriveKeyAlgorithm: SymmetricKeyAlgorithmType, # (1)
KeyDerivationFunction: KeyDerivationFunctionType, # (2)
KeyDerivationHashAlgorithm: KeyDerivationHashAlgorithmType, # (3)
DerivationData: DiffieHellmanDerivationDataTypeDef, # (4)
KeyBlockHeaders: NotRequired[KeyBlockHeadersTypeDef], # (5)
- See SymmetricKeyAlgorithmType
- See KeyDerivationFunctionType
- See KeyDerivationHashAlgorithmType
- See DiffieHellmanDerivationDataTypeDef
- See KeyBlockHeadersTypeDef
ExportTr31KeyBlockTypeDef#
# ExportTr31KeyBlockTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ExportTr31KeyBlockTypeDef
def get_value() -> ExportTr31KeyBlockTypeDef:
return {
"WrappingKeyIdentifier": ...,
}
# ExportTr31KeyBlockTypeDef definition
class ExportTr31KeyBlockTypeDef(TypedDict):
WrappingKeyIdentifier: str,
KeyBlockHeaders: NotRequired[KeyBlockHeadersTypeDef], # (1)
ExportTr34KeyBlockTypeDef#
# ExportTr34KeyBlockTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ExportTr34KeyBlockTypeDef
def get_value() -> ExportTr34KeyBlockTypeDef:
return {
"CertificateAuthorityPublicKeyIdentifier": ...,
}
# ExportTr34KeyBlockTypeDef definition
class ExportTr34KeyBlockTypeDef(TypedDict):
CertificateAuthorityPublicKeyIdentifier: str,
WrappingKeyCertificate: str,
KeyBlockFormat: Tr34KeyBlockFormatType, # (1)
ExportToken: NotRequired[str],
SigningKeyIdentifier: NotRequired[str],
SigningKeyCertificate: NotRequired[str],
RandomNonce: NotRequired[str],
KeyBlockHeaders: NotRequired[KeyBlockHeadersTypeDef], # (2)
ListKeysOutputTypeDef#
# ListKeysOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ListKeysOutputTypeDef
def get_value() -> ListKeysOutputTypeDef:
return {
"Keys": ...,
}
# ListKeysOutputTypeDef definition
class ListKeysOutputTypeDef(TypedDict):
Keys: list[KeySummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
- See
list[KeySummaryTypeDef] - See ResponseMetadataTypeDef
AddKeyReplicationRegionsOutputTypeDef#
# AddKeyReplicationRegionsOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import AddKeyReplicationRegionsOutputTypeDef
def get_value() -> AddKeyReplicationRegionsOutputTypeDef:
return {
"Key": ...,
}
# AddKeyReplicationRegionsOutputTypeDef definition
class AddKeyReplicationRegionsOutputTypeDef(TypedDict):
Key: KeyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See KeyTypeDef
- See ResponseMetadataTypeDef
CreateKeyOutputTypeDef#
# CreateKeyOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import CreateKeyOutputTypeDef
def get_value() -> CreateKeyOutputTypeDef:
return {
"Key": ...,
}
# CreateKeyOutputTypeDef definition
class CreateKeyOutputTypeDef(TypedDict):
Key: KeyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See KeyTypeDef
- See ResponseMetadataTypeDef
DeleteKeyOutputTypeDef#
# DeleteKeyOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import DeleteKeyOutputTypeDef
def get_value() -> DeleteKeyOutputTypeDef:
return {
"Key": ...,
}
# DeleteKeyOutputTypeDef definition
class DeleteKeyOutputTypeDef(TypedDict):
Key: KeyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See KeyTypeDef
- See ResponseMetadataTypeDef
GetKeyOutputTypeDef#
# GetKeyOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import GetKeyOutputTypeDef
def get_value() -> GetKeyOutputTypeDef:
return {
"Key": ...,
}
# GetKeyOutputTypeDef definition
class GetKeyOutputTypeDef(TypedDict):
Key: KeyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See KeyTypeDef
- See ResponseMetadataTypeDef
ImportKeyOutputTypeDef#
# ImportKeyOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ImportKeyOutputTypeDef
def get_value() -> ImportKeyOutputTypeDef:
return {
"Key": ...,
}
# ImportKeyOutputTypeDef definition
class ImportKeyOutputTypeDef(TypedDict):
Key: KeyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See KeyTypeDef
- See ResponseMetadataTypeDef
RemoveKeyReplicationRegionsOutputTypeDef#
# RemoveKeyReplicationRegionsOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import RemoveKeyReplicationRegionsOutputTypeDef
def get_value() -> RemoveKeyReplicationRegionsOutputTypeDef:
return {
"Key": ...,
}
# RemoveKeyReplicationRegionsOutputTypeDef definition
class RemoveKeyReplicationRegionsOutputTypeDef(TypedDict):
Key: KeyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See KeyTypeDef
- See ResponseMetadataTypeDef
RestoreKeyOutputTypeDef#
# RestoreKeyOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import RestoreKeyOutputTypeDef
def get_value() -> RestoreKeyOutputTypeDef:
return {
"Key": ...,
}
# RestoreKeyOutputTypeDef definition
class RestoreKeyOutputTypeDef(TypedDict):
Key: KeyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See KeyTypeDef
- See ResponseMetadataTypeDef
StartKeyUsageOutputTypeDef#
# StartKeyUsageOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import StartKeyUsageOutputTypeDef
def get_value() -> StartKeyUsageOutputTypeDef:
return {
"Key": ...,
}
# StartKeyUsageOutputTypeDef definition
class StartKeyUsageOutputTypeDef(TypedDict):
Key: KeyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See KeyTypeDef
- See ResponseMetadataTypeDef
StopKeyUsageOutputTypeDef#
# StopKeyUsageOutputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import StopKeyUsageOutputTypeDef
def get_value() -> StopKeyUsageOutputTypeDef:
return {
"Key": ...,
}
# StopKeyUsageOutputTypeDef definition
class StopKeyUsageOutputTypeDef(TypedDict):
Key: KeyTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See KeyTypeDef
- See ResponseMetadataTypeDef
ImportKeyMaterialTypeDef#
# ImportKeyMaterialTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ImportKeyMaterialTypeDef
def get_value() -> ImportKeyMaterialTypeDef:
return {
"RootCertificatePublicKey": ...,
}
# ImportKeyMaterialTypeDef definition
class ImportKeyMaterialTypeDef(TypedDict):
RootCertificatePublicKey: NotRequired[RootCertificatePublicKeyTypeDef], # (1)
TrustedCertificatePublicKey: NotRequired[TrustedCertificatePublicKeyTypeDef], # (2)
Tr31KeyBlock: NotRequired[ImportTr31KeyBlockTypeDef], # (3)
Tr34KeyBlock: NotRequired[ImportTr34KeyBlockTypeDef], # (4)
KeyCryptogram: NotRequired[ImportKeyCryptogramTypeDef], # (5)
DiffieHellmanTr31KeyBlock: NotRequired[ImportDiffieHellmanTr31KeyBlockTypeDef], # (6)
- See RootCertificatePublicKeyTypeDef
- See TrustedCertificatePublicKeyTypeDef
- See ImportTr31KeyBlockTypeDef
- See ImportTr34KeyBlockTypeDef
- See ImportKeyCryptogramTypeDef
- See ImportDiffieHellmanTr31KeyBlockTypeDef
ExportKeyMaterialTypeDef#
# ExportKeyMaterialTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ExportKeyMaterialTypeDef
def get_value() -> ExportKeyMaterialTypeDef:
return {
"Tr31KeyBlock": ...,
}
# ExportKeyMaterialTypeDef definition
class ExportKeyMaterialTypeDef(TypedDict):
Tr31KeyBlock: NotRequired[ExportTr31KeyBlockTypeDef], # (1)
Tr34KeyBlock: NotRequired[ExportTr34KeyBlockTypeDef], # (2)
KeyCryptogram: NotRequired[ExportKeyCryptogramTypeDef], # (3)
DiffieHellmanTr31KeyBlock: NotRequired[ExportDiffieHellmanTr31KeyBlockTypeDef], # (4)
- See ExportTr31KeyBlockTypeDef
- See ExportTr34KeyBlockTypeDef
- See ExportKeyCryptogramTypeDef
- See ExportDiffieHellmanTr31KeyBlockTypeDef
ImportKeyInputTypeDef#
# ImportKeyInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ImportKeyInputTypeDef
def get_value() -> ImportKeyInputTypeDef:
return {
"KeyMaterial": ...,
}
# ImportKeyInputTypeDef definition
class ImportKeyInputTypeDef(TypedDict):
KeyMaterial: ImportKeyMaterialTypeDef, # (1)
KeyCheckValueAlgorithm: NotRequired[KeyCheckValueAlgorithmType], # (2)
Enabled: NotRequired[bool],
Tags: NotRequired[Sequence[TagTypeDef]], # (3)
ReplicationRegions: NotRequired[Sequence[str]],
- See ImportKeyMaterialTypeDef
- See KeyCheckValueAlgorithmType
- See
Sequence[TagTypeDef]
ExportKeyInputTypeDef#
# ExportKeyInputTypeDef TypedDict usage example
from mypy_boto3_payment_cryptography.type_defs import ExportKeyInputTypeDef
def get_value() -> ExportKeyInputTypeDef:
return {
"KeyMaterial": ...,
}
# ExportKeyInputTypeDef definition
class ExportKeyInputTypeDef(TypedDict):
KeyMaterial: ExportKeyMaterialTypeDef, # (1)
ExportKeyIdentifier: str,
ExportAttributes: NotRequired[ExportAttributesTypeDef], # (2)