Restores a specified AWS CloudHSM backup that is in the
PENDING_DELETION state. For more information on deleting a backup, see
DeleteBackup.
Cross-account use: No. You cannot perform this operation on an AWS CloudHSM backup in a different AWS account.
Request Syntax
{
"BackupId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- BackupId
-
The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.
Type: String
Pattern:
backup-[2-7a-zA-Z]{11,16}Required: Yes
Response Syntax
{
"Backup": {
"BackupArn": "string",
"BackupId": "string",
"BackupState": "string",
"ClusterId": "string",
"CopyTimestamp": number,
"CreateTimestamp": number,
"DeleteTimestamp": number,
"HsmType": "string",
"Mode": "string",
"NeverExpires": boolean,
"SourceBackup": "string",
"SourceCluster": "string",
"SourceRegion": "string",
"TagList": [
{
"Key": "string",
"Value": "string"
}
]
}
}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
For information about the errors that are common to all actions, see Common Errors.
- CloudHsmAccessDeniedException
-
The request was rejected because the requester does not have permission to perform the requested operation.
HTTP Status Code: 400
- CloudHsmInternalFailureException
-
The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
HTTP Status Code: 500
- CloudHsmInvalidRequestException
-
The request was rejected because it is not a valid request.
HTTP Status Code: 400
- CloudHsmResourceNotFoundException
-
The request was rejected because it refers to a resource that cannot be found.
HTTP Status Code: 400
- CloudHsmServiceException
-
The request was rejected because an error occurred.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
