Skip to content

EncryptDataInput

Source code in docs_src/capo_payment_cryptography_data/types/encrypt_data_input.py
class EncryptDataInput(TypedDict, closed=True):
    key_identifier: "capo_payment_cryptography_data.types.key_arn_or_key_alias_type.KeyArnOrKeyAliasType"
    """<p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.</p> <p>When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.</p>"""
    plain_text: "capo_payment_cryptography_data.types.plain_text_type.PlainTextType"
    """<p>The plaintext to be encrypted.</p> <note> <p>For encryption using asymmetric keys, plaintext data length is constrained by encryption key strength that you define in <code>KeyAlgorithm</code> and padding type that you define in <code>AsymmetricEncryptionAttributes</code>. For more information, see <a href="https://docs.aws.amazon.com/payment-cryptography/latest/userguide/encrypt-data.html">Encrypt data</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> </note>"""
    encryption_attributes: "capo_payment_cryptography_data.types.encryption_decryption_attributes.EncryptionDecryptionAttributes"
    """<p>The encryption key type and attributes for plaintext encryption.</p>"""
    wrapped_key: NotRequired[
        "capo_payment_cryptography_data.types.wrapped_key.WrappedKey"
    ]
    """<p>The WrappedKeyBlock containing the encryption key for plaintext encryption.</p>"""

encryption_attributes instance-attribute

encryption_attributes: EncryptionDecryptionAttributes

The encryption key type and attributes for plaintext encryption.

key_identifier instance-attribute

key_identifier: KeyArnOrKeyAliasType

The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.

When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.

plain_text instance-attribute

plain_text: PlainTextType

The plaintext to be encrypted.

For encryption using asymmetric keys, plaintext data length is constrained by encryption key strength that you define in KeyAlgorithm and padding type that you define in AsymmetricEncryptionAttributes. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.

wrapped_key instance-attribute

wrapped_key: NotRequired[WrappedKey]

The WrappedKeyBlock containing the encryption key for plaintext encryption.