Skip to content

Type definitions#

Index > PaymentCryptographyControlPlane > Type definitions

Auto-generated documentation for PaymentCryptographyControlPlane type annotations stubs module mypy-boto3-payment-cryptography.

AliasTypeDef#

# AliasTypeDef definition

class AliasTypeDef(TypedDict):
    AliasName: str,
    KeyArn: NotRequired[str],

CreateAliasInputRequestTypeDef#

# CreateAliasInputRequestTypeDef definition

class CreateAliasInputRequestTypeDef(TypedDict):
    AliasName: str,
    KeyArn: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: NotRequired[str],

DeleteAliasInputRequestTypeDef#

# DeleteAliasInputRequestTypeDef definition

class DeleteAliasInputRequestTypeDef(TypedDict):
    AliasName: str,

DeleteKeyInputRequestTypeDef#

# DeleteKeyInputRequestTypeDef definition

class DeleteKeyInputRequestTypeDef(TypedDict):
    KeyIdentifier: str,
    DeleteKeyInDays: NotRequired[int],

ExportTr31KeyBlockTypeDef#

# ExportTr31KeyBlockTypeDef definition

class ExportTr31KeyBlockTypeDef(TypedDict):
    WrappingKeyIdentifier: str,

ExportTr34KeyBlockTypeDef#

# ExportTr34KeyBlockTypeDef definition

class ExportTr34KeyBlockTypeDef(TypedDict):
    CertificateAuthorityPublicKeyIdentifier: str,
    ExportToken: str,
    KeyBlockFormat: Tr34KeyBlockFormatType,  # (1)
    WrappingKeyCertificate: str,
    RandomNonce: NotRequired[str],
  1. See Tr34KeyBlockFormatType

WrappedKeyTypeDef#

# WrappedKeyTypeDef definition

class WrappedKeyTypeDef(TypedDict):
    KeyMaterial: str,
    WrappedKeyMaterialFormat: WrappedKeyMaterialFormatType,  # (1)
    WrappingKeyArn: str,
  1. See WrappedKeyMaterialFormatType

GetAliasInputRequestTypeDef#

# GetAliasInputRequestTypeDef definition

class GetAliasInputRequestTypeDef(TypedDict):
    AliasName: str,

GetKeyInputRequestTypeDef#

# GetKeyInputRequestTypeDef definition

class GetKeyInputRequestTypeDef(TypedDict):
    KeyIdentifier: str,

GetParametersForExportInputRequestTypeDef#

# GetParametersForExportInputRequestTypeDef definition

class GetParametersForExportInputRequestTypeDef(TypedDict):
    KeyMaterialType: KeyMaterialTypeType,  # (1)
    SigningKeyAlgorithm: KeyAlgorithmType,  # (2)
  1. See KeyMaterialTypeType
  2. See KeyAlgorithmType

GetParametersForImportInputRequestTypeDef#

# GetParametersForImportInputRequestTypeDef definition

class GetParametersForImportInputRequestTypeDef(TypedDict):
    KeyMaterialType: KeyMaterialTypeType,  # (1)
    WrappingKeyAlgorithm: KeyAlgorithmType,  # (2)
  1. See KeyMaterialTypeType
  2. See KeyAlgorithmType

GetPublicKeyCertificateInputRequestTypeDef#

# GetPublicKeyCertificateInputRequestTypeDef definition

class GetPublicKeyCertificateInputRequestTypeDef(TypedDict):
    KeyIdentifier: str,

ImportTr31KeyBlockTypeDef#

# ImportTr31KeyBlockTypeDef definition

class ImportTr31KeyBlockTypeDef(TypedDict):
    WrappedKeyBlock: str,
    WrappingKeyIdentifier: str,

ImportTr34KeyBlockTypeDef#

# ImportTr34KeyBlockTypeDef definition

class ImportTr34KeyBlockTypeDef(TypedDict):
    CertificateAuthorityPublicKeyIdentifier: str,
    ImportToken: str,
    KeyBlockFormat: Tr34KeyBlockFormatType,  # (1)
    SigningKeyCertificate: str,
    WrappedKeyBlock: str,
    RandomNonce: NotRequired[str],
  1. See Tr34KeyBlockFormatType

KeyModesOfUseTypeDef#

# KeyModesOfUseTypeDef definition

class KeyModesOfUseTypeDef(TypedDict):
    Decrypt: NotRequired[bool],
    DeriveKey: NotRequired[bool],
    Encrypt: NotRequired[bool],
    Generate: NotRequired[bool],
    NoRestrictions: NotRequired[bool],
    Sign: NotRequired[bool],
    Unwrap: NotRequired[bool],
    Verify: NotRequired[bool],
    Wrap: NotRequired[bool],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListAliasesInputRequestTypeDef#

# ListAliasesInputRequestTypeDef definition

class ListAliasesInputRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListKeysInputRequestTypeDef#

# ListKeysInputRequestTypeDef definition

class ListKeysInputRequestTypeDef(TypedDict):
    KeyState: NotRequired[KeyStateType],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See KeyStateType

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

RestoreKeyInputRequestTypeDef#

# RestoreKeyInputRequestTypeDef definition

class RestoreKeyInputRequestTypeDef(TypedDict):
    KeyIdentifier: str,

StartKeyUsageInputRequestTypeDef#

# StartKeyUsageInputRequestTypeDef definition

class StartKeyUsageInputRequestTypeDef(TypedDict):
    KeyIdentifier: str,

StopKeyUsageInputRequestTypeDef#

# StopKeyUsageInputRequestTypeDef definition

class StopKeyUsageInputRequestTypeDef(TypedDict):
    KeyIdentifier: str,

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

class UntagResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateAliasInputRequestTypeDef#

# UpdateAliasInputRequestTypeDef definition

class UpdateAliasInputRequestTypeDef(TypedDict):
    AliasName: str,
    KeyArn: NotRequired[str],

CreateAliasOutputTypeDef#

# CreateAliasOutputTypeDef definition

class CreateAliasOutputTypeDef(TypedDict):
    Alias: AliasTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AliasTypeDef
  2. See ResponseMetadataTypeDef

GetAliasOutputTypeDef#

# GetAliasOutputTypeDef definition

class GetAliasOutputTypeDef(TypedDict):
    Alias: AliasTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AliasTypeDef
  2. See ResponseMetadataTypeDef

GetParametersForExportOutputTypeDef#

# GetParametersForExportOutputTypeDef definition

class GetParametersForExportOutputTypeDef(TypedDict):
    ExportToken: str,
    ParametersValidUntilTimestamp: datetime,
    SigningKeyAlgorithm: KeyAlgorithmType,  # (1)
    SigningKeyCertificate: str,
    SigningKeyCertificateChain: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KeyAlgorithmType
  2. See ResponseMetadataTypeDef

GetParametersForImportOutputTypeDef#

# GetParametersForImportOutputTypeDef definition

class GetParametersForImportOutputTypeDef(TypedDict):
    ImportToken: str,
    ParametersValidUntilTimestamp: datetime,
    WrappingKeyAlgorithm: KeyAlgorithmType,  # (1)
    WrappingKeyCertificate: str,
    WrappingKeyCertificateChain: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KeyAlgorithmType
  2. See ResponseMetadataTypeDef

GetPublicKeyCertificateOutputTypeDef#

# GetPublicKeyCertificateOutputTypeDef definition

class GetPublicKeyCertificateOutputTypeDef(TypedDict):
    KeyCertificate: str,
    KeyCertificateChain: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListAliasesOutputTypeDef#

# ListAliasesOutputTypeDef definition

class ListAliasesOutputTypeDef(TypedDict):
    Aliases: List[AliasTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AliasTypeDef
  2. See ResponseMetadataTypeDef

UpdateAliasOutputTypeDef#

# UpdateAliasOutputTypeDef definition

class UpdateAliasOutputTypeDef(TypedDict):
    Alias: AliasTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AliasTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    NextToken: str,
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

class TagResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

ExportKeyMaterialTypeDef#

# ExportKeyMaterialTypeDef definition

class ExportKeyMaterialTypeDef(TypedDict):
    Tr31KeyBlock: NotRequired[ExportTr31KeyBlockTypeDef],  # (1)
    Tr34KeyBlock: NotRequired[ExportTr34KeyBlockTypeDef],  # (2)
  1. See ExportTr31KeyBlockTypeDef
  2. See ExportTr34KeyBlockTypeDef

ExportKeyOutputTypeDef#

# ExportKeyOutputTypeDef definition

class ExportKeyOutputTypeDef(TypedDict):
    WrappedKey: WrappedKeyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WrappedKeyTypeDef
  2. See ResponseMetadataTypeDef

KeyAttributesTypeDef#

# KeyAttributesTypeDef definition

class KeyAttributesTypeDef(TypedDict):
    KeyAlgorithm: KeyAlgorithmType,  # (1)
    KeyClass: KeyClassType,  # (2)
    KeyModesOfUse: KeyModesOfUseTypeDef,  # (3)
    KeyUsage: KeyUsageType,  # (4)
  1. See KeyAlgorithmType
  2. See KeyClassType
  3. See KeyModesOfUseTypeDef
  4. See KeyUsageType

ListAliasesInputListAliasesPaginateTypeDef#

# ListAliasesInputListAliasesPaginateTypeDef definition

class ListAliasesInputListAliasesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListKeysInputListKeysPaginateTypeDef#

# ListKeysInputListKeysPaginateTypeDef definition

class ListKeysInputListKeysPaginateTypeDef(TypedDict):
    KeyState: NotRequired[KeyStateType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See KeyStateType
  2. See PaginatorConfigTypeDef

ListTagsForResourceInputListTagsForResourcePaginateTypeDef#

# ListTagsForResourceInputListTagsForResourcePaginateTypeDef definition

class ListTagsForResourceInputListTagsForResourcePaginateTypeDef(TypedDict):
    ResourceArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ExportKeyInputRequestTypeDef#

# ExportKeyInputRequestTypeDef definition

class ExportKeyInputRequestTypeDef(TypedDict):
    ExportKeyIdentifier: str,
    KeyMaterial: ExportKeyMaterialTypeDef,  # (1)
  1. See ExportKeyMaterialTypeDef

CreateKeyInputRequestTypeDef#

# CreateKeyInputRequestTypeDef definition

class CreateKeyInputRequestTypeDef(TypedDict):
    Exportable: bool,
    KeyAttributes: KeyAttributesTypeDef,  # (1)
    Enabled: NotRequired[bool],
    KeyCheckValueAlgorithm: NotRequired[KeyCheckValueAlgorithmType],  # (2)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See KeyAttributesTypeDef
  2. See KeyCheckValueAlgorithmType
  3. See TagTypeDef

KeySummaryTypeDef#

# KeySummaryTypeDef definition

class KeySummaryTypeDef(TypedDict):
    Enabled: bool,
    Exportable: bool,
    KeyArn: str,
    KeyAttributes: KeyAttributesTypeDef,  # (1)
    KeyCheckValue: str,
    KeyState: KeyStateType,  # (2)
  1. See KeyAttributesTypeDef
  2. See KeyStateType

KeyTypeDef#

# KeyTypeDef definition

class KeyTypeDef(TypedDict):
    CreateTimestamp: datetime,
    Enabled: bool,
    Exportable: bool,
    KeyArn: str,
    KeyAttributes: KeyAttributesTypeDef,  # (1)
    KeyCheckValue: str,
    KeyCheckValueAlgorithm: KeyCheckValueAlgorithmType,  # (2)
    KeyOrigin: KeyOriginType,  # (3)
    KeyState: KeyStateType,  # (4)
    DeletePendingTimestamp: NotRequired[datetime],
    DeleteTimestamp: NotRequired[datetime],
    UsageStartTimestamp: NotRequired[datetime],
    UsageStopTimestamp: NotRequired[datetime],
  1. See KeyAttributesTypeDef
  2. See KeyCheckValueAlgorithmType
  3. See KeyOriginType
  4. See KeyStateType

RootCertificatePublicKeyTypeDef#

# RootCertificatePublicKeyTypeDef definition

class RootCertificatePublicKeyTypeDef(TypedDict):
    KeyAttributes: KeyAttributesTypeDef,  # (1)
    PublicKeyCertificate: str,
  1. See KeyAttributesTypeDef

TrustedCertificatePublicKeyTypeDef#

# TrustedCertificatePublicKeyTypeDef definition

class TrustedCertificatePublicKeyTypeDef(TypedDict):
    CertificateAuthorityPublicKeyIdentifier: str,
    KeyAttributes: KeyAttributesTypeDef,  # (1)
    PublicKeyCertificate: str,
  1. See KeyAttributesTypeDef

ListKeysOutputTypeDef#

# ListKeysOutputTypeDef definition

class ListKeysOutputTypeDef(TypedDict):
    Keys: List[KeySummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KeySummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateKeyOutputTypeDef#

# CreateKeyOutputTypeDef definition

class CreateKeyOutputTypeDef(TypedDict):
    Key: KeyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KeyTypeDef
  2. See ResponseMetadataTypeDef

DeleteKeyOutputTypeDef#

# DeleteKeyOutputTypeDef definition

class DeleteKeyOutputTypeDef(TypedDict):
    Key: KeyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KeyTypeDef
  2. See ResponseMetadataTypeDef

GetKeyOutputTypeDef#

# GetKeyOutputTypeDef definition

class GetKeyOutputTypeDef(TypedDict):
    Key: KeyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KeyTypeDef
  2. See ResponseMetadataTypeDef

ImportKeyOutputTypeDef#

# ImportKeyOutputTypeDef definition

class ImportKeyOutputTypeDef(TypedDict):
    Key: KeyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KeyTypeDef
  2. See ResponseMetadataTypeDef

RestoreKeyOutputTypeDef#

# RestoreKeyOutputTypeDef definition

class RestoreKeyOutputTypeDef(TypedDict):
    Key: KeyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KeyTypeDef
  2. See ResponseMetadataTypeDef

StartKeyUsageOutputTypeDef#

# StartKeyUsageOutputTypeDef definition

class StartKeyUsageOutputTypeDef(TypedDict):
    Key: KeyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KeyTypeDef
  2. See ResponseMetadataTypeDef

StopKeyUsageOutputTypeDef#

# StopKeyUsageOutputTypeDef definition

class StopKeyUsageOutputTypeDef(TypedDict):
    Key: KeyTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See KeyTypeDef
  2. See ResponseMetadataTypeDef

ImportKeyMaterialTypeDef#

# ImportKeyMaterialTypeDef definition

class ImportKeyMaterialTypeDef(TypedDict):
    RootCertificatePublicKey: NotRequired[RootCertificatePublicKeyTypeDef],  # (1)
    Tr31KeyBlock: NotRequired[ImportTr31KeyBlockTypeDef],  # (2)
    Tr34KeyBlock: NotRequired[ImportTr34KeyBlockTypeDef],  # (3)
    TrustedCertificatePublicKey: NotRequired[TrustedCertificatePublicKeyTypeDef],  # (4)
  1. See RootCertificatePublicKeyTypeDef
  2. See ImportTr31KeyBlockTypeDef
  3. See ImportTr34KeyBlockTypeDef
  4. See TrustedCertificatePublicKeyTypeDef

ImportKeyInputRequestTypeDef#

# ImportKeyInputRequestTypeDef definition

class ImportKeyInputRequestTypeDef(TypedDict):
    KeyMaterial: ImportKeyMaterialTypeDef,  # (1)
    Enabled: NotRequired[bool],
    KeyCheckValueAlgorithm: NotRequired[KeyCheckValueAlgorithmType],  # (2)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See ImportKeyMaterialTypeDef
  2. See KeyCheckValueAlgorithmType
  3. See TagTypeDef