Serialized Form (AWS Java SDK for Payment Cryptography Control Plane 1.12.672 API)

Package com.amazonaws.services.paymentcryptography.model
- Class com.amazonaws.services.paymentcryptography.model.AccessDeniedException extends AWSPaymentCryptographyException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.paymentcryptography.model.Alias extends Object implements Serializable
  - Serialized Fields
    - aliasName
```
String aliasName
```
      A friendly name that you can use to refer to a key. The value must begin with alias/.
      
      Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    - keyArn
```
String keyArn
```
      The KeyARN of the key associated with the alias.
- Class com.amazonaws.services.paymentcryptography.model.AWSPaymentCryptographyException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.paymentcryptography.model.ConflictException extends AWSPaymentCryptographyException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.paymentcryptography.model.CreateAliasRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - aliasName
```
String aliasName
```
      A friendly name that you can use to refer to a key. An alias must begin with alias/ followed by a name, for example alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-).
      
      Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
    - keyArn
```
String keyArn
```
      The KeyARN of the key to associate with the alias.
- Class com.amazonaws.services.paymentcryptography.model.CreateAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - alias
```
Alias alias
```
      The alias for the key.
- Class com.amazonaws.services.paymentcryptography.model.CreateKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key is not enabled, then it is created but not activated. The default value is enabled.
    - exportable
```
Boolean exportable
```
      Specifies whether the key is exportable from the service.
    - keyAttributes
```
KeyAttributes keyAttributes
```
      The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
    - keyCheckValueAlgorithm
```
String keyCheckValueAlgorithm
```
      The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
      
      For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
    - tags
```
List<E> tags
```
      Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.
      
      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.
      
      Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
      
      Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
- Class com.amazonaws.services.paymentcryptography.model.CreateKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - key
```
Key key
```
      The key material that contains all the key attributes.
- Class com.amazonaws.services.paymentcryptography.model.DeleteAliasRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - aliasName
```
String aliasName
```
      A friendly name that you can use to refer Amazon Web Services Payment Cryptography key. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.
- Class com.amazonaws.services.paymentcryptography.model.DeleteAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.paymentcryptography.model.DeleteKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deleteKeyInDays
```
Integer deleteKeyInDays
```
      The waiting period for key deletion. The default value is seven days.
    - keyIdentifier
```
String keyIdentifier
```
      The KeyARN of the key that is scheduled for deletion.
- Class com.amazonaws.services.paymentcryptography.model.DeleteKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - key
```
Key key
```
      The KeyARN of the key that is scheduled for deletion.
- Class com.amazonaws.services.paymentcryptography.model.ExportAttributes extends Object implements Serializable
  - Serialized Fields
    - exportDukptInitialKey
```
ExportDukptInitialKey exportDukptInitialKey
```
      Parameter information for IPEK export.
    - keyCheckValueAlgorithm
```
String keyCheckValueAlgorithm
```
      The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. Specify KCV for IPEK export only.
      
      For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
- Class com.amazonaws.services.paymentcryptography.model.ExportDukptInitialKey extends Object implements Serializable
  - Serialized Fields
    - keySerialNumber
```
String keySerialNumber
```
      The KSN for IPEK generation using DUKPT.
      
      KSN must be padded before sending to Amazon Web Services Payment Cryptography. KSN hex length should be 20 for a TDES_2KEY key or 24 for an AES key.
- Class com.amazonaws.services.paymentcryptography.model.ExportKeyCryptogram extends Object implements Serializable
  - Serialized Fields
    - certificateAuthorityPublicKeyIdentifier
```
String certificateAuthorityPublicKeyIdentifier
```
      The KeyARN of the certificate chain that signs the wrapping key certificate during RSA wrap and unwrap key export.
    - wrappingKeyCertificate
```
String wrappingKeyCertificate
```
      The wrapping key certificate in PEM format (base64 encoded). Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.
    - wrappingSpec
```
String wrappingSpec
```
      The wrapping spec for the key under export.
- Class com.amazonaws.services.paymentcryptography.model.ExportKeyMaterial extends Object implements Serializable
  - Serialized Fields
    - keyCryptogram
```
ExportKeyCryptogram keyCryptogram
```
      Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method
    - tr31KeyBlock
```
ExportTr31KeyBlock tr31KeyBlock
```
      Parameter information for key material export using symmetric TR-31 key exchange method.
    - tr34KeyBlock
```
ExportTr34KeyBlock tr34KeyBlock
```
      Parameter information for key material export using the asymmetric TR-34 key exchange method.
- Class com.amazonaws.services.paymentcryptography.model.ExportKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - exportAttributes
```
ExportAttributes exportAttributes
```
      The attributes for IPEK generation during export.
    - exportKeyIdentifier
```
String exportKeyIdentifier
```
      The KeyARN of the key under export from Amazon Web Services Payment Cryptography.
    - keyMaterial
```
ExportKeyMaterial keyMaterial
```
      The key block format type, for example, TR-34 or TR-31, to use during key material export.
- Class com.amazonaws.services.paymentcryptography.model.ExportKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - wrappedKey
```
WrappedKey wrappedKey
```
      The key material under export as a TR-34 WrappedKeyBlock or a TR-31 WrappedKeyBlock. or a RSA WrappedKeyCryptogram.
- Class com.amazonaws.services.paymentcryptography.model.ExportTr31KeyBlock extends Object implements Serializable
  - Serialized Fields
    - wrappingKeyIdentifier
```
String wrappingKeyIdentifier
```
      The KeyARN of the the wrapping key. This key encrypts or wraps the key under export for TR-31 key block generation.
- Class com.amazonaws.services.paymentcryptography.model.ExportTr34KeyBlock extends Object implements Serializable
  - Serialized Fields
    - certificateAuthorityPublicKeyIdentifier
```
String certificateAuthorityPublicKeyIdentifier
```
      The KeyARN of the certificate chain that signs the wrapping key certificate during TR-34 key export.
    - exportToken
```
String exportToken
```
      The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 7 days. You can use the same export token to export multiple keys from the same service account.
    - keyBlockFormat
```
String keyBlockFormat
```
      The format of key block that Amazon Web Services Payment Cryptography will use during key export.
    - randomNonce
```
String randomNonce
```
      A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.
    - wrappingKeyCertificate
```
String wrappingKeyCertificate
```
      The KeyARN of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.
- Class com.amazonaws.services.paymentcryptography.model.GetAliasRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - aliasName
```
String aliasName
```
      The alias of the Amazon Web Services Payment Cryptography key.
- Class com.amazonaws.services.paymentcryptography.model.GetAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - alias
```
Alias alias
```
      The alias of the Amazon Web Services Payment Cryptography key.
- Class com.amazonaws.services.paymentcryptography.model.GetKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - keyIdentifier
```
String keyIdentifier
```
      The KeyARN of the Amazon Web Services Payment Cryptography key.
- Class com.amazonaws.services.paymentcryptography.model.GetKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - key
```
Key key
```
      The key material, including the immutable and mutable data for the key.
- Class com.amazonaws.services.paymentcryptography.model.GetParametersForExportRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - keyMaterialType
```
String keyMaterialType
```
      The key block format type (for example, TR-34 or TR-31) to use during key material export. Export token is only required for a TR-34 key export, TR34_KEY_BLOCK. Export token is not required for TR-31 key export.
    - signingKeyAlgorithm
```
String signingKeyAlgorithm
```
      The signing key algorithm to generate a signing key certificate. This certificate signs the wrapped key under export within the TR-34 key block. RSA_2048 is the only signing key algorithm allowed.
- Class com.amazonaws.services.paymentcryptography.model.GetParametersForExportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - exportToken
```
String exportToken
```
      The export token to initiate key export from Amazon Web Services Payment Cryptography. The export token expires after 7 days. You can use the same export token to export multiple keys from the same service account.
    - parametersValidUntilTimestamp
```
Date parametersValidUntilTimestamp
```
      The validity period of the export token.
    - signingKeyAlgorithm
```
String signingKeyAlgorithm
```
      The algorithm of the signing key certificate for use in TR-34 key block generation. RSA_2048 is the only signing key algorithm allowed.
    - signingKeyCertificate
```
String signingKeyCertificate
```
      The signing key certificate in PEM format (base64 encoded) of the public key for signature within the TR-34 key block. The certificate expires after 7 days.
    - signingKeyCertificateChain
```
String signingKeyCertificateChain
```
      The root certificate authority (CA) that signed the signing key certificate in PEM format (base64 encoded).
- Class com.amazonaws.services.paymentcryptography.model.GetParametersForImportRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - keyMaterialType
```
String keyMaterialType
```
      The method to use for key material import. Import token is only required for TR-34 WrappedKeyBlock ( TR34_KEY_BLOCK) and RSA WrappedKeyCryptogram (KEY_CRYPTOGRAM).
      
      Import token is not required for TR-31, root public key cerificate or trusted public key certificate.
    - wrappingKeyAlgorithm
```
String wrappingKeyAlgorithm
```
      The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import.
      
      At this time, RSA_2048 is the allowed algorithm for TR-34 WrappedKeyBlock import. Additionally, RSA_2048, RSA_3072, RSA_4096 are the allowed algorithms for RSA WrappedKeyCryptogram import.
- Class com.amazonaws.services.paymentcryptography.model.GetParametersForImportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - importToken
```
String importToken
```
      The import token to initiate key import into Amazon Web Services Payment Cryptography. The import token expires after 7 days. You can use the same import token to import multiple keys to the same service account.
    - parametersValidUntilTimestamp
```
Date parametersValidUntilTimestamp
```
      The validity period of the import token.
    - wrappingKeyAlgorithm
```
String wrappingKeyAlgorithm
```
      The algorithm of the wrapping key for use within TR-34 WrappedKeyBlock or RSA WrappedKeyCryptogram.
    - wrappingKeyCertificate
```
String wrappingKeyCertificate
```
      The wrapping key certificate in PEM format (base64 encoded) of the wrapping key for use within the TR-34 key block. The certificate expires in 7 days.
    - wrappingKeyCertificateChain
```
String wrappingKeyCertificateChain
```
      The Amazon Web Services Payment Cryptography root certificate authority (CA) that signed the wrapping key certificate in PEM format (base64 encoded).
- Class com.amazonaws.services.paymentcryptography.model.GetPublicKeyCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - keyIdentifier
```
String keyIdentifier
```
      The KeyARN of the asymmetric key pair.
- Class com.amazonaws.services.paymentcryptography.model.GetPublicKeyCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - keyCertificate
```
String keyCertificate
```
      The public key component of the asymmetric key pair in a certificate PEM format (base64 encoded). It is signed by the root certificate authority (CA). The certificate expires in 90 days.
    - keyCertificateChain
```
String keyCertificateChain
```
      The root certificate authority (CA) that signed the public key certificate in PEM format (base64 encoded) of the asymmetric key pair.
- Class com.amazonaws.services.paymentcryptography.model.ImportKeyCryptogram extends Object implements Serializable
  - Serialized Fields
    - exportable
```
Boolean exportable
```
      Specifies whether the key is exportable from the service.
    - importToken
```
String importToken
```
      The import token that initiates key import using the asymmetric RSA wrap and unwrap key exchange method into AWS Payment Cryptography. It expires after 7 days. You can use the same import token to import multiple keys to the same service account.
    - keyAttributes
```
KeyAttributes keyAttributes
```
    - wrappedKeyCryptogram
```
String wrappedKeyCryptogram
```
      The RSA wrapped key cryptogram under import.
    - wrappingSpec
```
String wrappingSpec
```
      The wrapping spec for the wrapped key cryptogram.
- Class com.amazonaws.services.paymentcryptography.model.ImportKeyMaterial extends Object implements Serializable
  - Serialized Fields
    - keyCryptogram
```
ImportKeyCryptogram keyCryptogram
```
      Parameter information for key material import using asymmetric RSA wrap and unwrap key exchange method.
    - rootCertificatePublicKey
```
RootCertificatePublicKey rootCertificatePublicKey
```
      Parameter information for root public key certificate import.
    - tr31KeyBlock
```
ImportTr31KeyBlock tr31KeyBlock
```
      Parameter information for key material import using symmetric TR-31 key exchange method.
    - tr34KeyBlock
```
ImportTr34KeyBlock tr34KeyBlock
```
      Parameter information for key material import using the asymmetric TR-34 key exchange method.
    - trustedCertificatePublicKey
```
TrustedCertificatePublicKey trustedCertificatePublicKey
```
      Parameter information for trusted public key certificate import.
- Class com.amazonaws.services.paymentcryptography.model.ImportKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      Specifies whether import key is enabled.
    - keyCheckValueAlgorithm
```
String keyCheckValueAlgorithm
```
      The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
      
      For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
    - keyMaterial
```
ImportKeyMaterial keyMaterial
```
      The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.
    - tags
```
List<E> tags
```
      Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is imported. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.
      
      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. 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.
      
      Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
      
      Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
- Class com.amazonaws.services.paymentcryptography.model.ImportKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - key
```
Key key
```
      The KeyARN of the key material imported within Amazon Web Services Payment Cryptography.
- Class com.amazonaws.services.paymentcryptography.model.ImportTr31KeyBlock extends Object implements Serializable
  - Serialized Fields
    - wrappedKeyBlock
```
String wrappedKeyBlock
```
      The TR-31 wrapped key block to import.
    - wrappingKeyIdentifier
```
String wrappingKeyIdentifier
```
      The KeyARN of the key that will decrypt or unwrap a TR-31 key block during import.
- Class com.amazonaws.services.paymentcryptography.model.ImportTr34KeyBlock extends Object implements Serializable
  - Serialized Fields
    - certificateAuthorityPublicKeyIdentifier
```
String certificateAuthorityPublicKeyIdentifier
```
      The KeyARN of the certificate chain that signs the signing key certificate during TR-34 key import.
    - importToken
```
String importToken
```
      The import token that initiates key import using the asymmetric TR-34 key exchange method into Amazon Web Services Payment Cryptography. It expires after 7 days. You can use the same import token to import multiple keys to the same service account.
    - keyBlockFormat
```
String keyBlockFormat
```
      The key block format to use during key import. The only value allowed is X9_TR34_2012.
    - randomNonce
```
String randomNonce
```
      A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.
    - signingKeyCertificate
```
String signingKeyCertificate
```
      The public key component in PEM certificate format of the private key that signs the KDH TR-34 WrappedKeyBlock.
    - wrappedKeyBlock
```
String wrappedKeyBlock
```
      The TR-34 wrapped key block to import.
- Class com.amazonaws.services.paymentcryptography.model.InternalServerException extends AWSPaymentCryptographyException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.paymentcryptography.model.Key extends Object implements Serializable
  - Serialized Fields
    - createTimestamp
```
Date createTimestamp
```
      The date and time when the key was created.
    - deletePendingTimestamp
```
Date deletePendingTimestamp
```
      The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.
    - deleteTimestamp
```
Date deleteTimestamp
```
      The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.
    - enabled
```
Boolean enabled
```
      Specifies whether the key is enabled.
    - exportable
```
Boolean exportable
```
      Specifies whether the key is exportable. This data is immutable after the key is created.
    - keyArn
```
String keyArn
```
      The Amazon Resource Name (ARN) of the key.
    - keyAttributes
```
KeyAttributes keyAttributes
```
      The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
    - keyCheckValue
```
String keyCheckValue
```
      The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.
    - keyCheckValueAlgorithm
```
String keyCheckValueAlgorithm
```
      The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
      
      For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
    - keyOrigin
```
String keyOrigin
```
      The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.
    - keyState
```
String keyState
```
      The state of key that is being created or deleted.
    - usageStartTimestamp
```
Date usageStartTimestamp
```
      The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.
    - usageStopTimestamp
```
Date usageStopTimestamp
```
      The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.
- Class com.amazonaws.services.paymentcryptography.model.KeyAttributes extends Object implements Serializable
  - Serialized Fields
    - keyAlgorithm
```
String keyAlgorithm
```
      The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
      
      For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
    - keyClass
```
String keyClass
```
      The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    - keyModesOfUse
```
KeyModesOfUse keyModesOfUse
```
      The list of cryptographic operations that you can perform using the key.
    - keyUsage
```
String keyUsage
```
      The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
- Class com.amazonaws.services.paymentcryptography.model.KeyModesOfUse extends Object implements Serializable
  - Serialized Fields
    - decrypt
```
Boolean decrypt
```
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
    - deriveKey
```
Boolean deriveKey
```
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
    - encrypt
```
Boolean encrypt
```
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
    - generate
```
Boolean generate
```
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
    - noRestrictions
```
Boolean noRestrictions
```
      Speciﬁes whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.
    - sign
```
Boolean sign
```
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used for signing.
    - unwrap
```
Boolean unwrap
```
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
    - verify
```
Boolean verify
```
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
    - wrap
```
Boolean wrap
```
      Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
- Class com.amazonaws.services.paymentcryptography.model.KeySummary extends Object implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      Specifies whether the key is enabled.
    - exportable
```
Boolean exportable
```
      Specifies whether the key is exportable. This data is immutable after the key is created.
    - keyArn
```
String keyArn
```
      The Amazon Resource Name (ARN) of the key.
    - keyAttributes
```
KeyAttributes keyAttributes
```
      The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
    - keyCheckValue
```
String keyCheckValue
```
      The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.
    - keyState
```
String keyState
```
      The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
- Class com.amazonaws.services.paymentcryptography.model.ListAliasesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
      
      This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
    - nextToken
```
String nextToken
```
      Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.
- Class com.amazonaws.services.paymentcryptography.model.ListAliasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - aliases
```
List<E> aliases
```
      The list of aliases. Each alias describes the KeyArn contained within.
    - nextToken
```
String nextToken
```
      The token for the next set of results, or an empty or null value if there are no more results.
- Class com.amazonaws.services.paymentcryptography.model.ListKeysRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - keyState
```
String keyState
```
      The key state of the keys you want to list.
    - maxResults
```
Integer maxResults
```
      Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
      
      This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
    - nextToken
```
String nextToken
```
      Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.
- Class com.amazonaws.services.paymentcryptography.model.ListKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - keys
```
List<E> keys
```
      The list of keys created within the caller's Amazon Web Services account and Amazon Web Services Region.
    - nextToken
```
String nextToken
```
      The token for the next set of results, or an empty or null value if there are no more results.
- Class com.amazonaws.services.paymentcryptography.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
      
      This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
    - nextToken
```
String nextToken
```
      Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.
    - resourceArn
```
String resourceArn
```
      The KeyARN of the key whose tags you are getting.
- Class com.amazonaws.services.paymentcryptography.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The token for the next set of results, or an empty or null value if there are no more results.
    - tags
```
List<E> tags
```
      The list of tags associated with a ResourceArn. Each tag will list the key-value pair contained within that tag.
- Class com.amazonaws.services.paymentcryptography.model.ResourceNotFoundException extends AWSPaymentCryptographyException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The string for the exception.
- Class com.amazonaws.services.paymentcryptography.model.RestoreKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - keyIdentifier
```
String keyIdentifier
```
      The KeyARN of the key to be restored within Amazon Web Services Payment Cryptography.
- Class com.amazonaws.services.paymentcryptography.model.RestoreKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - key
```
Key key
```
      The key material of the restored key. The KeyState will change to CREATE_COMPLETE and value for DeletePendingTimestamp gets removed.
- Class com.amazonaws.services.paymentcryptography.model.RootCertificatePublicKey extends Object implements Serializable
  - Serialized Fields
    - keyAttributes
```
KeyAttributes keyAttributes
```
      The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the root public key is imported.
    - publicKeyCertificate
```
String publicKeyCertificate
```
      Parameter information for root public key certificate import.
- Class com.amazonaws.services.paymentcryptography.model.ServiceQuotaExceededException extends AWSPaymentCryptographyException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.paymentcryptography.model.ServiceUnavailableException extends AWSPaymentCryptographyException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.paymentcryptography.model.StartKeyUsageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - keyIdentifier
```
String keyIdentifier
```
      The KeyArn of the key.
- Class com.amazonaws.services.paymentcryptography.model.StartKeyUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - key
```
Key key
```
      The KeyARN of the Amazon Web Services Payment Cryptography key activated for use.
- Class com.amazonaws.services.paymentcryptography.model.StopKeyUsageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - keyIdentifier
```
String keyIdentifier
```
      The KeyArn of the key.
- Class com.amazonaws.services.paymentcryptography.model.StopKeyUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - key
```
Key key
```
      The KeyARN of the key.
- Class com.amazonaws.services.paymentcryptography.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The key of the tag.
    - value
```
String value
```
      The value of the tag.
- Class com.amazonaws.services.paymentcryptography.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The KeyARN of the key whose tags are being updated.
    - tags
```
List<E> tags
```
      One or more tags. Each tag consists of a tag key and a tag value. 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. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the new one.
      
      Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
      
      To use this parameter, you must have TagResource permission in an IAM policy.
      
      Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
- Class com.amazonaws.services.paymentcryptography.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.paymentcryptography.model.ThrottlingException extends AWSPaymentCryptographyException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.paymentcryptography.model.TrustedCertificatePublicKey extends Object implements Serializable
  - Serialized Fields
    - certificateAuthorityPublicKeyIdentifier
```
String certificateAuthorityPublicKeyIdentifier
```
      The KeyARN of the root public key certificate or certificate chain that signs the trusted public key certificate import.
    - keyAttributes
```
KeyAttributes keyAttributes
```
      The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after a trusted public key is imported.
    - publicKeyCertificate
```
String publicKeyCertificate
```
      Parameter information for trusted public key certificate import.
- Class com.amazonaws.services.paymentcryptography.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The KeyARN of the key whose tags are being removed.
    - tagKeys
```
List<E> tagKeys
```
      One or more tag keys. Don't include the tag values.
      
      If the Amazon Web Services Payment Cryptography key doesn't have the specified tag key, Amazon Web Services Payment Cryptography doesn't throw an exception or return a response. To confirm that the operation succeeded, use the ListTagsForResource operation.
- Class com.amazonaws.services.paymentcryptography.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.paymentcryptography.model.UpdateAliasRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - aliasName
```
String aliasName
```
      The alias whose associated key is changing.
    - keyArn
```
String keyArn
```
      The KeyARN for the key that you are updating or removing from the alias.
- Class com.amazonaws.services.paymentcryptography.model.UpdateAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - alias
```
Alias alias
```
      The alias name.
- Class com.amazonaws.services.paymentcryptography.model.ValidationException extends AWSPaymentCryptographyException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.paymentcryptography.model.WrappedKey extends Object implements Serializable
  - Serialized Fields
    - keyCheckValue
```
String keyCheckValue
```
      The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.
    - keyCheckValueAlgorithm
```
String keyCheckValueAlgorithm
```
      The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
      
      For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
    - keyMaterial
```
String keyMaterial
```
      Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.
    - wrappedKeyMaterialFormat
```
String wrappedKeyMaterialFormat
```
      The key block format of a wrapped key.
    - wrappingKeyArn
```
String wrappingKeyArn
```
      The KeyARN of the wrapped key.

Serialized Form

Package com.amazonaws.services.paymentcryptography.model

Class com.amazonaws.services.paymentcryptography.model.AccessDeniedException extends AWSPaymentCryptographyException implements Serializable

Class com.amazonaws.services.paymentcryptography.model.Alias extends Object implements Serializable

Serialized Fields

aliasName

keyArn

Class com.amazonaws.services.paymentcryptography.model.AWSPaymentCryptographyException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.paymentcryptography.model.ConflictException extends AWSPaymentCryptographyException implements Serializable

Class com.amazonaws.services.paymentcryptography.model.CreateAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aliasName

keyArn

Class com.amazonaws.services.paymentcryptography.model.CreateAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

alias

Class com.amazonaws.services.paymentcryptography.model.CreateKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

enabled

exportable

keyAttributes

keyCheckValueAlgorithm

tags

Class com.amazonaws.services.paymentcryptography.model.CreateKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

key

Class com.amazonaws.services.paymentcryptography.model.DeleteAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aliasName

Class com.amazonaws.services.paymentcryptography.model.DeleteAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.paymentcryptography.model.DeleteKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deleteKeyInDays

keyIdentifier

Class com.amazonaws.services.paymentcryptography.model.DeleteKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

key

Class com.amazonaws.services.paymentcryptography.model.ExportAttributes extends Object implements Serializable

Serialized Fields

exportDukptInitialKey

keyCheckValueAlgorithm

Class com.amazonaws.services.paymentcryptography.model.ExportDukptInitialKey extends Object implements Serializable

Serialized Fields

keySerialNumber

Class com.amazonaws.services.paymentcryptography.model.ExportKeyCryptogram extends Object implements Serializable

Serialized Fields

certificateAuthorityPublicKeyIdentifier

wrappingKeyCertificate

wrappingSpec

Class com.amazonaws.services.paymentcryptography.model.ExportKeyMaterial extends Object implements Serializable

Serialized Fields

keyCryptogram

tr31KeyBlock

tr34KeyBlock

Class com.amazonaws.services.paymentcryptography.model.ExportKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exportAttributes

exportKeyIdentifier

keyMaterial

Class com.amazonaws.services.paymentcryptography.model.ExportKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

wrappedKey

Class com.amazonaws.services.paymentcryptography.model.ExportTr31KeyBlock extends Object implements Serializable

Serialized Fields

wrappingKeyIdentifier

Class com.amazonaws.services.paymentcryptography.model.ExportTr34KeyBlock extends Object implements Serializable

Serialized Fields

certificateAuthorityPublicKeyIdentifier

exportToken

keyBlockFormat

randomNonce

wrappingKeyCertificate

Class com.amazonaws.services.paymentcryptography.model.GetAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aliasName

Class com.amazonaws.services.paymentcryptography.model.GetAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

alias

Class com.amazonaws.services.paymentcryptography.model.GetKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields