ImportKeyInput

ImportKeyInput schema from Amazon Payment Cryptography

CryptographyFinancial ServicesPayment ProcessingPCI

Properties

Name Type Description
Enabled object
KeyCheckValueAlgorithm object
KeyMaterial object
Tags object
View JSON Schema on GitHub

JSON Schema

openapi-import-key-input-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-payment-cryptography/refs/heads/main/json-schema/openapi-import-key-input-schema.json",
  "title": "ImportKeyInput",
  "description": "ImportKeyInput schema from Amazon Payment Cryptography",
  "type": "object",
  "properties": {
    "Enabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "Specifies whether import key is enabled."
        }
      ]
    },
    "KeyCheckValueAlgorithm": {
      "allOf": [
        {
          "$ref": "#/components/schemas/KeyCheckValueAlgorithm"
        },
        {
          "description": "<p>The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.</p> <p>For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.</p>"
        }
      ]
    },
    "KeyMaterial": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImportKeyMaterial"
        },
        {
          "description": "The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey."
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Tags"
        },
        {
          "description": "<p>The tags to attach to the key. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. </p> <p>You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.</p> <p>To use this parameter, you must have <code>TagResource</code> permission.</p> <important> <p>Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.</p> </important> <note> <p>Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.</p> </note>"
        }
      ]
    }
  },
  "required": [
    "KeyMaterial"
  ]
}