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

StartScanJob

Starts scanning jobs for specific resources.

Request Syntax


PUT /scan/job HTTP/1.1
Content-type: application/json

{
   "BackupVaultName": "string",
   "IamRoleArn": "string",
   "IdempotencyToken": "string",
   "MalwareScanner": "string",
   "RecoveryPointArn": "string",
   "ScanBaseRecoveryPointArn": "string",
   "ScanMode": "string",
   "ScannerRoleArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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.

Pattern: ^[a-zA-Z0-9\-\_]{2,50}$

Type: String

Required: Yes

IamRoleArn

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Type: String

Required: Yes

IdempotencyToken

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartScanJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Type: String

Required: No

MalwareScanner

Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.

Type: String

Valid Values: GUARDDUTY

Required: Yes

RecoveryPointArn

An Amazon Resource Name (ARN) that uniquely identifies a recovery point. This is your target recovery point for a full scan. If you are running an incremental scan, this will be your a recovery point which has been created after your base recovery point selection.

Type: String

Required: Yes

ScanBaseRecoveryPointArn

An ARN that uniquely identifies the base recovery point to be used for incremental scanning.

Type: String

Required: No

ScanMode

Specifies the scan type use for the scan job.

Includes:

FULL_SCAN will scan the entire data lineage within the backup.
INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.

Type: String

Valid Values: FULL_SCAN | INCREMENTAL_SCAN

Required: Yes

ScannerRoleArn

Specified the IAM scanner role ARN.

Type: String

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "CreationDate": number,
   "ScanJobId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

CreationDate

The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Type: Timestamp

ScanJobId

Uniquely identifies a request to AWS Backup to back up a resource.

Type: String

Errors

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

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

InvalidRequestException

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

Context
Type

HTTP Status Code: 400

LimitExceededException

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

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