/AWS1/IF_BUP=>CREATEREPORTPLAN()

About CreateReportPlan

Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.

If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.

Method Signature

METHODS /AWS1/IF_BUP~CREATEREPORTPLAN
  IMPORTING
    !IV_REPORTPLANNAME TYPE /AWS1/BUPREPORTPLANNAME OPTIONAL
    !IV_REPORTPLANDESCRIPTION TYPE /AWS1/BUPREPORTPLANDESCRIPTION OPTIONAL
    !IO_REPORTDELIVERYCHANNEL TYPE REF TO /AWS1/CL_BUPRPTDELIVERYCHANNEL OPTIONAL
    !IO_REPORTSETTING TYPE REF TO /AWS1/CL_BUPREPORTSETTING OPTIONAL
    !IT_REPORTPLANTAGS TYPE /AWS1/CL_BUPSTRINGMAP_W=>TT_STRINGMAP OPTIONAL
    !IV_IDEMPOTENCYTOKEN TYPE /AWS1/BUPSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bupcreaterptplanout
  RAISING
    /AWS1/CX_BUPALREADYEXISTSEX
    /AWS1/CX_BUPINVPARAMVALUEEX
    /AWS1/CX_BUPLIMITEXCEEDEDEX
    /AWS1/CX_BUPMISSINGPARAMVALEX
    /AWS1/CX_BUPSERVICEUNAVAILEX
    /AWS1/CX_BUPCLIENTEXC
    /AWS1/CX_BUPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_reportplanname TYPE /AWS1/BUPREPORTPLANNAME /AWS1/BUPREPORTPLANNAME

The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

io_reportdeliverychannel TYPE REF TO /AWS1/CL_BUPRPTDELIVERYCHANNEL /AWS1/CL_BUPRPTDELIVERYCHANNEL

A structure that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

io_reportsetting TYPE REF TO /AWS1/CL_BUPREPORTSETTING /AWS1/CL_BUPREPORTSETTING

Identifies the report template for the report. Reports are built using a report template. The report templates are:

RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT | SCAN_JOB_REPORT

If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web Services Regions and frameworks.

Optional arguments:

iv_reportplandescription TYPE /AWS1/BUPREPORTPLANDESCRIPTION /AWS1/BUPREPORTPLANDESCRIPTION

An optional description of the report plan with a maximum of 1,024 characters.

it_reportplantags TYPE /AWS1/CL_BUPSTRINGMAP_W=>TT_STRINGMAP TT_STRINGMAP

The tags to assign to the report plan.

iv_idempotencytoken TYPE /AWS1/BUPSTRING /AWS1/BUPSTRING

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

RETURNING

oo_output TYPE REF TO /aws1/cl_bupcreaterptplanout /AWS1/CL_BUPCREATERPTPLANOUT

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->createreportplan(
  io_reportdeliverychannel = new /aws1/cl_buprptdeliverychannel(
    it_formats = VALUE /aws1/cl_bupformatlist_w=>tt_formatlist(
      ( new /aws1/cl_bupformatlist_w( |string| ) )
    )
    iv_s3bucketname = |string|
    iv_s3keyprefix = |string|
  )
  io_reportsetting = new /aws1/cl_bupreportsetting(
    it_accounts = VALUE /aws1/cl_bupstringlist_w=>tt_stringlist(
      ( new /aws1/cl_bupstringlist_w( |string| ) )
    )
    it_frameworkarns = VALUE /aws1/cl_bupstringlist_w=>tt_stringlist(
      ( new /aws1/cl_bupstringlist_w( |string| ) )
    )
    it_organizationunits = VALUE /aws1/cl_bupstringlist_w=>tt_stringlist(
      ( new /aws1/cl_bupstringlist_w( |string| ) )
    )
    it_regions = VALUE /aws1/cl_bupstringlist_w=>tt_stringlist(
      ( new /aws1/cl_bupstringlist_w( |string| ) )
    )
    iv_numberofframeworks = 123
    iv_reporttemplate = |string|
  )
  it_reportplantags = VALUE /aws1/cl_bupstringmap_w=>tt_stringmap(
    (
      VALUE /aws1/cl_bupstringmap_w=>ts_stringmap_maprow(
        value = new /aws1/cl_bupstringmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_idempotencytoken = |string|
  iv_reportplandescription = |string|
  iv_reportplanname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_reportplanname = lo_result->get_reportplanname( ).
  lv_arn = lo_result->get_reportplanarn( ).
  lv_timestamp = lo_result->get_creationtime( ).
ENDIF.