KeySummary
Metadata about an AWS Payment Cryptography key.
Contents
- Enabled
-
Specifies whether the key is enabled.
Type: Boolean
Required: Yes
- Exportable
-
Specifies whether the key is exportable. This data is immutable after the key is created.
Type: Boolean
Required: Yes
- KeyArn
-
The Amazon Resource Name (ARN) of the key.
Type: String
Length Constraints: Minimum length of 70. Maximum length of 150.
Pattern:
arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}Required: Yes
- 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.
Type: KeyAttributes object
Required: Yes
- 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.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 16.
Pattern:
[0-9a-fA-F]+Required: Yes
- KeyState
-
The state of an AWS Payment Cryptography that is being created or deleted.
Type: String
Valid Values:
CREATE_IN_PROGRESS | CREATE_COMPLETE | DELETE_PENDING | DELETE_COMPLETERequired: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
