Skip to content

/AWS1/IF_IOT=>CREATESCHEDULEDAUDIT()

About CreateScheduledAudit

Creates a scheduled audit that is run at a specified time interval.

Requires permission to access the CreateScheduledAudit action.

Method Signature

METHODS /AWS1/IF_IOT~CREATESCHEDULEDAUDIT
  IMPORTING
    !IV_FREQUENCY TYPE /AWS1/IOTAUDITFREQUENCY OPTIONAL
    !IV_DAYOFMONTH TYPE /AWS1/IOTDAYOFMONTH OPTIONAL
    !IV_DAYOFWEEK TYPE /AWS1/IOTDAYOFWEEK OPTIONAL
    !IT_TARGETCHECKNAMES TYPE /AWS1/CL_IOTTGTAUDCHECKNAMES_W=>TT_TARGETAUDITCHECKNAMES OPTIONAL
    !IV_SCHEDULEDAUDITNAME TYPE /AWS1/IOTSCHEDULEDAUDITNAME OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_IOTTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotcreschddauditrsp
  RAISING
    /AWS1/CX_IOTINTERNALFAILUREEX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTLIMITEXCEEDEDEX
    /AWS1/CX_IOTRESRCALRDYEXISTSEX
    /AWS1/CX_IOTTHROTTLINGEX
    /AWS1/CX_IOTCLIENTEXC
    /AWS1/CX_IOTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_frequency TYPE /AWS1/IOTAUDITFREQUENCY /AWS1/IOTAUDITFREQUENCY

How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY or MONTHLY. The start time of each audit is determined by the system.

it_targetchecknames TYPE /AWS1/CL_IOTTGTAUDCHECKNAMES_W=>TT_TARGETAUDITCHECKNAMES TT_TARGETAUDITCHECKNAMES

Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

iv_scheduledauditname TYPE /AWS1/IOTSCHEDULEDAUDITNAME /AWS1/IOTSCHEDULEDAUDITNAME

The name you want to give to the scheduled audit. (Max. 128 chars)

Optional arguments:

iv_dayofmonth TYPE /AWS1/IOTDAYOFMONTH /AWS1/IOTDAYOFMONTH

The day of the month on which the scheduled audit takes place. This can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to MONTHLY. If days 29 to 31 are specified, and the month doesn't have that many days, the audit takes place on the LAST day of the month.

iv_dayofweek TYPE /AWS1/IOTDAYOFWEEK /AWS1/IOTDAYOFWEEK

The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.

it_tags TYPE /AWS1/CL_IOTTAG=>TT_TAGLIST TT_TAGLIST

Metadata that can be used to manage the scheduled audit.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotcreschddauditrsp /AWS1/CL_IOTCRESCHDDAUDITRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

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->createscheduledaudit(
  it_tags = VALUE /aws1/cl_iottag=>tt_taglist(
    (
      new /aws1/cl_iottag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  it_targetchecknames = VALUE /aws1/cl_iottgtaudchecknames_w=>tt_targetauditchecknames(
    ( new /aws1/cl_iottgtaudchecknames_w( |string| ) )
  )
  iv_dayofmonth = |string|
  iv_dayofweek = |string|
  iv_frequency = |string|
  iv_scheduledauditname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_scheduledauditarn = lo_result->get_scheduledauditarn( ).
ENDIF.