Skip to content

/AWS1/IF_BUP=>STARTSCANJOB()

About StartScanJob

Starts scanning jobs for specific resources.

Method Signature

METHODS /AWS1/IF_BUP~STARTSCANJOB
  IMPORTING
    !IV_BACKUPVAULTNAME TYPE /AWS1/BUPSTRING00 OPTIONAL
    !IV_IAMROLEARN TYPE /AWS1/BUPSTRING00 OPTIONAL
    !IV_IDEMPOTENCYTOKEN TYPE /AWS1/BUPSTRING00 OPTIONAL
    !IV_MALWARESCANNER TYPE /AWS1/BUPMALWARESCANNER OPTIONAL
    !IV_RECOVERYPOINTARN TYPE /AWS1/BUPSTRING00 OPTIONAL
    !IV_SCANBASERECOVERYPOINTARN TYPE /AWS1/BUPSTRING00 OPTIONAL
    !IV_SCANMODE TYPE /AWS1/BUPSCANMODE OPTIONAL
    !IV_SCANNERROLEARN TYPE /AWS1/BUPSTRING00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bupstartscanjoboutput
  RAISING
    /AWS1/CX_BUPINVPARAMVALUEEX
    /AWS1/CX_BUPINVALIDREQUESTEX
    /AWS1/CX_BUPLIMITEXCEEDEDEX
    /AWS1/CX_BUPMISSINGPARAMVALEX
    /AWS1/CX_BUPRESOURCENOTFOUNDEX
    /AWS1/CX_BUPSERVICEUNAVAILEX
    /AWS1/CX_BUPCLIENTEXC
    /AWS1/CX_BUPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_backupvaultname TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

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 Amazon Web Services Region where they are created.

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

iv_iamrolearn TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

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

iv_malwarescanner TYPE /AWS1/BUPMALWARESCANNER /AWS1/BUPMALWARESCANNER

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

iv_recoverypointarn TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

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.

iv_scanmode TYPE /AWS1/BUPSCANMODE /AWS1/BUPSCANMODE

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.

iv_scannerrolearn TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

Specified the IAM scanner role ARN.

Optional arguments:

iv_idempotencytoken TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

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.

iv_scanbaserecoverypointarn TYPE /AWS1/BUPSTRING00 /AWS1/BUPSTRING00

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

RETURNING

oo_output TYPE REF TO /aws1/cl_bupstartscanjoboutput /AWS1/CL_BUPSTARTSCANJOBOUTPUT

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->startscanjob(
  iv_backupvaultname = |string|
  iv_iamrolearn = |string|
  iv_idempotencytoken = |string|
  iv_malwarescanner = |string|
  iv_recoverypointarn = |string|
  iv_scanbaserecoverypointarn = |string|
  iv_scanmode = |string|
  iv_scannerrolearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_timestamp = lo_result->get_creationdate( ).
  lv_string = lo_result->get_scanjobid( ).
ENDIF.