Gets the key material for an AWS Payment Cryptography key, including the immutable and mutable data specified when the key was created.
Cross-account use: This operation can't be used across different AWS accounts.
Related operations:
Request Syntax
{
"KeyIdentifier": "string"
}Request Parameters
The request accepts the following data in JSON format.
- KeyIdentifier
-
The
KeyARNof the AWS Payment Cryptography key.Type: String
Length Constraints: Minimum length of 7. Maximum length of 322.
Pattern:
arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+Required: Yes
Response Syntax
{
"Key": {
"CreateTimestamp": number,
"DeletePendingTimestamp": number,
"DeleteTimestamp": number,
"DeriveKeyUsage": "string",
"Enabled": boolean,
"Exportable": boolean,
"KeyArn": "string",
"KeyAttributes": {
"KeyAlgorithm": "string",
"KeyClass": "string",
"KeyModesOfUse": {
"Decrypt": boolean,
"DeriveKey": boolean,
"Encrypt": boolean,
"Generate": boolean,
"NoRestrictions": boolean,
"Sign": boolean,
"Unwrap": boolean,
"Verify": boolean,
"Wrap": boolean
},
"KeyUsage": "string"
},
"KeyCheckValue": "string",
"KeyCheckValueAlgorithm": "string",
"KeyOrigin": "string",
"KeyState": "string",
"UsageStartTimestamp": number,
"UsageStopTimestamp": number
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 400
- InternalServerException
-
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request was denied due to an invalid resource error.
HTTP Status Code: 400
- ServiceUnavailableException
-
The service cannot complete the request.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
- ValidationException
-
The request was denied due to an invalid request error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
