Skip to content

/AWS1/IF_GLU=>STRTDATAQUALITYRLRECOMMEND00()

About StartDataQualityRuleRecommendationRun

Starts a recommendation run that is used to generate rules when you don't know what rules to write. Glue Data Quality analyzes the data and comes up with recommendations for a potential ruleset. You can then triage the ruleset and modify the generated ruleset to your liking.

Recommendation runs are automatically deleted after 90 days.

Method Signature

METHODS /AWS1/IF_GLU~STRTDATAQUALITYRLRECOMMEND00
  IMPORTING
    !IO_DATASOURCE TYPE REF TO /AWS1/CL_GLUDATASOURCE OPTIONAL
    !IV_ROLE TYPE /AWS1/GLUROLESTRING OPTIONAL
    !IV_NUMBEROFWORKERS TYPE /AWS1/GLUNULLABLEINTEGER OPTIONAL
    !IV_TIMEOUT TYPE /AWS1/GLUTIMEOUT OPTIONAL
    !IV_CREATEDRULESETNAME TYPE /AWS1/GLUNAMESTRING OPTIONAL
    !IV_DATAQUALITYSECURITYCONF TYPE /AWS1/GLUNAMESTRING OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/GLUHASHSTRING OPTIONAL
    !IO_ADDITIONALRUNOPTIONS TYPE REF TO /AWS1/CL_GLUDATQLTYRLRECRUNA00 OPTIONAL
    !IV_RECOMMENDATIONMODE TYPE /AWS1/GLURECOMMENDATIONMODE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_glustrtdataqualityr01
  RAISING
    /AWS1/CX_GLUCONFLICTEXCEPTION
    /AWS1/CX_GLUINTERNALSERVICEEX
    /AWS1/CX_GLUINVALIDINPUTEX
    /AWS1/CX_GLUOPERATIONTIMEOUTEX
    /AWS1/CX_GLUCLIENTEXC
    /AWS1/CX_GLUSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

io_datasource TYPE REF TO /AWS1/CL_GLUDATASOURCE /AWS1/CL_GLUDATASOURCE

The data source (Glue table) associated with this run.

iv_role TYPE /AWS1/GLUROLESTRING /AWS1/GLUROLESTRING

The IAM role that Glue assumes to access resources for the run.

For more information, see Configure IAM permissions for Glue Data Quality.

Optional arguments:

iv_numberofworkers TYPE /AWS1/GLUNULLABLEINTEGER /AWS1/GLUNULLABLEINTEGER

The number of G.1X workers to be used in the run. The default is 5.

iv_timeout TYPE /AWS1/GLUTIMEOUT /AWS1/GLUTIMEOUT

The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

iv_createdrulesetname TYPE /AWS1/GLUNAMESTRING /AWS1/GLUNAMESTRING

A name for the ruleset.

iv_dataqualitysecurityconf TYPE /AWS1/GLUNAMESTRING /AWS1/GLUNAMESTRING

The name of the security configuration created with the data quality encryption option.

iv_clienttoken TYPE /AWS1/GLUHASHSTRING /AWS1/GLUHASHSTRING

Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.

io_additionalrunoptions TYPE REF TO /AWS1/CL_GLUDATQLTYRLRECRUNA00 /AWS1/CL_GLUDATQLTYRLRECRUNA00

Additional run options you can specify for a recommendation run.

iv_recommendationmode TYPE /AWS1/GLURECOMMENDATIONMODE /AWS1/GLURECOMMENDATIONMODE

The mode that Glue Data Quality uses to recommend rules.

The default is BASIC.

RETURNING

oo_output TYPE REF TO /aws1/cl_glustrtdataqualityr01 /AWS1/CL_GLUSTRTDATAQUALITYR01

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->strtdataqualityrlrecommend00(
  io_additionalrunoptions = new /aws1/cl_gludatqltyrlrecruna00( |string| )
  io_datasource = new /aws1/cl_gludatasource(
    io_dataqualitygluetable = new /aws1/cl_gludataqualitygluetbl(
      it_additionaloptions = VALUE /aws1/cl_glugluetbladdlopts_w=>tt_gluetableadditionaloptions(
        (
          VALUE /aws1/cl_glugluetbladdlopts_w=>ts_gluetableaddloptions_maprow(
            key = |string|
            value = new /aws1/cl_glugluetbladdlopts_w( |string| )
          )
        )
      )
      iv_catalogid = |string|
      iv_connectionname = |string|
      iv_databasename = |string|
      iv_preprocessingquery = |string|
      iv_tablename = |string|
    )
    io_gluetable = new /aws1/cl_glugluetable(
      it_additionaloptions = VALUE /aws1/cl_glugluetbladdlopts_w=>tt_gluetableadditionaloptions(
        (
          VALUE /aws1/cl_glugluetbladdlopts_w=>ts_gluetableaddloptions_maprow(
            key = |string|
            value = new /aws1/cl_glugluetbladdlopts_w( |string| )
          )
        )
      )
      iv_catalogid = |string|
      iv_connectionname = |string|
      iv_databasename = |string|
      iv_tablename = |string|
    )
  )
  iv_clienttoken = |string|
  iv_createdrulesetname = |string|
  iv_dataqualitysecurityconf = |string|
  iv_numberofworkers = 123
  iv_recommendationmode = |string|
  iv_role = |string|
  iv_timeout = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_hashstring = lo_result->get_runid( ).
ENDIF.