AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . payment-cryptography ]
Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
See also: AWS API Documentation
start-key-usage
--key-identifier <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--key-identifier
(string)
TheKeyArn
of the key.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To enable a key
The following start-key-usage
example enables a key to be used.
aws payment-cryptography start-key-usage \
--key-identifier arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h
Output:
{
"Key": {
"CreateTimestamp": "1686800690",
"Enabled": true,
"Exportable": true,
"KeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/alsuwfxug3pgy6xh",
"KeyAttributes": {
"KeyAlgorithm": "TDES_3KEY",
"KeyClass": "SYMMETRIC_KEY",
"KeyModesOfUse": {
"Decrypt": true,
"DeriveKey": false,
"Encrypt": true,
"Generate": false,
"NoRestrictions": false,
"Sign": false,
"Unwrap": true,
"Verify": false,
"Wrap": true
},
"KeyUsage": "TR31_P1_PIN_GENERATION_KEY"
},
"KeyCheckValue": "369D",
"KeyCheckValueAlgorithm": "ANSI_X9_24",
"KeyOrigin": "AWS_PAYMENT_CRYPTOGRAPHY",
"KeyState": "CREATE_COMPLETE",
"UsageStartTimestamp": "1686800690"
}
}
For more information, see Enabling and disabling keys in the AWS Payment Cryptography User Guide.
Key -> (structure)
The
KeyARN
of the Amazon Web Services Payment Cryptography key activated for use.KeyArn -> (string)
The Amazon Resource Name (ARN) of the key.KeyAttributes -> (structure)
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.
KeyUsage -> (string)
The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.KeyClass -> (string)
The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.KeyAlgorithm -> (string)
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
andTDES
algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supportsRSA
andECC_NIST
algorithms.KeyModesOfUse -> (structure)
The list of cryptographic operations that you can perform using the key.
Encrypt -> (boolean)
Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.Decrypt -> (boolean)
Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.Wrap -> (boolean)
Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.Unwrap -> (boolean)
Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.Generate -> (boolean)
Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.Sign -> (boolean)
Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.Verify -> (boolean)
Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.DeriveKey -> (boolean)
Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.NoRestrictions -> (boolean)
Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied byKeyUsage
.KeyCheckValue -> (string)
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)
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.
Enabled -> (boolean)
Specifies whether the key is enabled.Exportable -> (boolean)
Specifies whether the key is exportable. This data is immutable after the key is created.KeyState -> (string)
The state of key that is being created or deleted.KeyOrigin -> (string)
The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value isAWS_PAYMENT_CRYPTOGRAPHY
. For keys imported into Amazon Web Services Payment Cryptography, the value isEXTERNAL
.CreateTimestamp -> (timestamp)
The date and time when the key was created.UsageStartTimestamp -> (timestamp)
The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.UsageStopTimestamp -> (timestamp)
The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.DeletePendingTimestamp -> (timestamp)
The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only whenKeyState
isDELETE_PENDING
and the key is scheduled for deletion.DeleteTimestamp -> (timestamp)
The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when theKeyState
isDELETE_COMPLETE
and the Amazon Web Services Payment Cryptography key is deleted.