Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetPITRMalwareScanResults

Returns the malware scan results for a specified point in time within a continuous (point-in-time recovery) backup.

Request Syntax


GET /scan/pitr-malware-scan-results?BackupVaultName=BackupVaultName&MalwareScanner=MalwareScanner&RecoveryPointArn=RecoveryPointArn&ScanEndTime=ScanEndTime HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

BackupVaultName

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.

Required: Yes

MalwareScanner

The scanning engine used for the corresponding scan job. Currently only GUARDDUTY is supported.

Valid Values: GUARDDUTY

Required: Yes

RecoveryPointArn

An ARN that uniquely identifies the target recovery point for scanning; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Required: Yes

ScanEndTime

The point in time within the continuous backup to examine for malware scan results.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "LastScanJobTime": number,
   "ScanEndTime": number,
   "ScanId": "string",
   "ScanMode": "string",
   "ScanResult": { 
      "ScanResultStatus": "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.

LastScanJobTime

The completion time of the most recent scan job that covered the specified point in time.

Type: Timestamp

ScanEndTime

The point in time that was queried. This echoes back the time specified in the request.

Type: Timestamp

ScanId

The scan ID generated by Amazon GuardDuty for the corresponding Scan Job ID request from AWS Backup.

Type: String

ScanMode

Specifies the scan type used for the scan job.

Type: String

Valid Values: FULL_SCAN | INCREMENTAL_SCAN

ScanResult

Contains the ScanResultStatus for the scan and returns THREATS_FOUND, NO_THREATS_FOUND, or UNKNOWN.

Type: ScanResultInfo object

Errors

For information about the errors that are common to all actions, see Common Error Types.

InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

Context
Type

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

Context
Type

HTTP Status Code: 400

ResourceNotFoundException

A resource that is required for the action doesn't exist.

Context
Type

HTTP Status Code: 400

ServiceUnavailableException

The request failed due to a temporary failure of the server.

Context
Type

HTTP Status Code: 500