CREATECRAWLER()`¶

About CreateCrawler¶

Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets field, the jdbcTargets field, or the DynamoDBTargets field.

Method Signature¶

METHODS /AWS1/IF_GLU~CREATECRAWLER
  IMPORTING
    !IV_NAME TYPE /AWS1/GLUNAMESTRING OPTIONAL
    !IV_ROLE TYPE /AWS1/GLUROLE OPTIONAL
    !IV_DATABASENAME TYPE /AWS1/GLUDATABASENAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/GLUDESCRIPTIONSTRING OPTIONAL
    !IO_TARGETS TYPE REF TO /AWS1/CL_GLUCRAWLERTARGETS OPTIONAL
    !IV_SCHEDULE TYPE /AWS1/GLUCRONEXPRESSION OPTIONAL
    !IT_CLASSIFIERS TYPE /AWS1/CL_GLUCLIFIERNAMELIST_W=>TT_CLASSIFIERNAMELIST OPTIONAL
    !IV_TABLEPREFIX TYPE /AWS1/GLUTABLEPREFIX OPTIONAL
    !IO_SCHEMACHANGEPOLICY TYPE REF TO /AWS1/CL_GLUSCHEMACHANGEPOLICY OPTIONAL
    !IO_RECRAWLPOLICY TYPE REF TO /AWS1/CL_GLURECRAWLPOLICY OPTIONAL
    !IO_LINEAGECONFIGURATION TYPE REF TO /AWS1/CL_GLULINEAGECONF OPTIONAL
    !IO_LAKEFORMATIONCONF TYPE REF TO /AWS1/CL_GLULAKEFORMATIONCONF OPTIONAL
    !IV_CONFIGURATION TYPE /AWS1/GLUCRAWLERCONFIGURATION OPTIONAL
    !IV_CRAWLERSECURITYCONF TYPE /AWS1/GLUCRAWLERSECURITYCONF OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_GLUTAGSMAP_W=>TT_TAGSMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_glucreatecrawlerrsp
  RAISING
    /AWS1/CX_GLUALREADYEXISTSEX
    /AWS1/CX_GLUINVALIDINPUTEX
    /AWS1/CX_GLUOPERATIONTIMEOUTEX
    /AWS1/CX_GLURESRCNUMLMTEXCDEX
    /AWS1/CX_GLUCLIENTEXC
    /AWS1/CX_GLUSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/GLUNAMESTRING` `/AWS1/GLUNAMESTRING`¶

Name of the new crawler.

`iv_role` `TYPE /AWS1/GLUROLE` `/AWS1/GLUROLE`¶

The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.

`io_targets` `TYPE REF TO /AWS1/CL_GLUCRAWLERTARGETS` `/AWS1/CL_GLUCRAWLERTARGETS`¶

A list of collection of targets to crawl.

Optional arguments:¶

`iv_databasename` `TYPE /AWS1/GLUDATABASENAME` `/AWS1/GLUDATABASENAME`¶

The Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

`iv_description` `TYPE /AWS1/GLUDESCRIPTIONSTRING` `/AWS1/GLUDESCRIPTIONSTRING`¶

A description of the new crawler.

`iv_schedule` `TYPE /AWS1/GLUCRONEXPRESSION` `/AWS1/GLUCRONEXPRESSION`¶

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

`it_classifiers` `TYPE /AWS1/CL_GLUCLIFIERNAMELIST_W=>TT_CLASSIFIERNAMELIST` `TT_CLASSIFIERNAMELIST`¶

A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.

`iv_tableprefix` `TYPE /AWS1/GLUTABLEPREFIX` `/AWS1/GLUTABLEPREFIX`¶

The table prefix used for catalog tables that are created.

`io_schemachangepolicy` `TYPE REF TO /AWS1/CL_GLUSCHEMACHANGEPOLICY` `/AWS1/CL_GLUSCHEMACHANGEPOLICY`¶

The policy for the crawler's update and deletion behavior.

`io_recrawlpolicy` `TYPE REF TO /AWS1/CL_GLURECRAWLPOLICY` `/AWS1/CL_GLURECRAWLPOLICY`¶

A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run.

`io_lineageconfiguration` `TYPE REF TO /AWS1/CL_GLULINEAGECONF` `/AWS1/CL_GLULINEAGECONF`¶

Specifies data lineage configuration settings for the crawler.

`io_lakeformationconf` `TYPE REF TO /AWS1/CL_GLULAKEFORMATIONCONF` `/AWS1/CL_GLULAKEFORMATIONCONF`¶

Specifies Lake Formation configuration settings for the crawler.

`iv_configuration` `TYPE /AWS1/GLUCRAWLERCONFIGURATION` `/AWS1/GLUCRAWLERCONFIGURATION`¶

Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Setting crawler configuration options.

`iv_crawlersecurityconf` `TYPE /AWS1/GLUCRAWLERSECURITYCONF` `/AWS1/GLUCRAWLERSECURITYCONF`¶

The name of the SecurityConfiguration structure to be used by this crawler.

`it_tags` `TYPE /AWS1/CL_GLUTAGSMAP_W=>TT_TAGSMAP` `TT_TAGSMAP`¶

The tags to use with this crawler request. You may use tags to limit access to the crawler. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_glucreatecrawlerrsp` `/AWS1/CL_GLUCREATECRAWLERRSP`¶

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->createcrawler(
  io_lakeformationconf = new /aws1/cl_glulakeformationconf(
    iv_accountid = |string|
    iv_uselakeformationcreds = ABAP_TRUE
  )
  io_lineageconfiguration = new /aws1/cl_glulineageconf( |string| )
  io_recrawlpolicy = new /aws1/cl_glurecrawlpolicy( |string| )
  io_schemachangepolicy = new /aws1/cl_gluschemachangepolicy(
    iv_deletebehavior = |string|
    iv_updatebehavior = |string|
  )
  io_targets = new /aws1/cl_glucrawlertargets(
    it_catalogtargets = VALUE /aws1/cl_glucatalogtarget=>tt_catalogtargetlist(
      (
        new /aws1/cl_glucatalogtarget(
          it_tables = VALUE /aws1/cl_glucatalogtblslist_w=>tt_catalogtableslist(
            ( new /aws1/cl_glucatalogtblslist_w( |string| ) )
          )
          iv_connectionname = |string|
          iv_databasename = |string|
          iv_dlqeventqueuearn = |string|
          iv_eventqueuearn = |string|
        )
      )
    )
    it_deltatargets = VALUE /aws1/cl_gludeltatarget=>tt_deltatargetlist(
      (
        new /aws1/cl_gludeltatarget(
          it_deltatables = VALUE /aws1/cl_glupathlist_w=>tt_pathlist(
            ( new /aws1/cl_glupathlist_w( |string| ) )
          )
          iv_connectionname = |string|
          iv_createnativedeltatable = ABAP_TRUE
          iv_writemanifest = ABAP_TRUE
        )
      )
    )
    it_dynamodbtargets = VALUE /aws1/cl_gludynamodbtarget=>tt_dynamodbtargetlist(
      (
        new /aws1/cl_gludynamodbtarget(
          iv_path = |string|
          iv_scanall = ABAP_TRUE
          iv_scanrate = '0.1'
        )
      )
    )
    it_huditargets = VALUE /aws1/cl_gluhuditarget=>tt_huditargetlist(
      (
        new /aws1/cl_gluhuditarget(
          it_exclusions = VALUE /aws1/cl_glupathlist_w=>tt_pathlist(
            ( new /aws1/cl_glupathlist_w( |string| ) )
          )
          it_paths = VALUE /aws1/cl_glupathlist_w=>tt_pathlist(
            ( new /aws1/cl_glupathlist_w( |string| ) )
          )
          iv_connectionname = |string|
          iv_maximumtraversaldepth = 123
        )
      )
    )
    it_icebergtargets = VALUE /aws1/cl_gluicebergtarget=>tt_icebergtargetlist(
      (
        new /aws1/cl_gluicebergtarget(
          it_exclusions = VALUE /aws1/cl_glupathlist_w=>tt_pathlist(
            ( new /aws1/cl_glupathlist_w( |string| ) )
          )
          it_paths = VALUE /aws1/cl_glupathlist_w=>tt_pathlist(
            ( new /aws1/cl_glupathlist_w( |string| ) )
          )
          iv_connectionname = |string|
          iv_maximumtraversaldepth = 123
        )
      )
    )
    it_jdbctargets = VALUE /aws1/cl_glujdbctarget=>tt_jdbctargetlist(
      (
        new /aws1/cl_glujdbctarget(
          it_enableadditionalmetadata = VALUE /aws1/cl_gluenableaddlmet_w=>tt_enableadditionalmetadata(
            ( new /aws1/cl_gluenableaddlmet_w( |string| ) )
          )
          it_exclusions = VALUE /aws1/cl_glupathlist_w=>tt_pathlist(
            ( new /aws1/cl_glupathlist_w( |string| ) )
          )
          iv_connectionname = |string|
          iv_path = |string|
        )
      )
    )
    it_mongodbtargets = VALUE /aws1/cl_glumongodbtarget=>tt_mongodbtargetlist(
      (
        new /aws1/cl_glumongodbtarget(
          iv_connectionname = |string|
          iv_path = |string|
          iv_scanall = ABAP_TRUE
        )
      )
    )
    it_s3targets = VALUE /aws1/cl_glus3target=>tt_s3targetlist(
      (
        new /aws1/cl_glus3target(
          it_exclusions = VALUE /aws1/cl_glupathlist_w=>tt_pathlist(
            ( new /aws1/cl_glupathlist_w( |string| ) )
          )
          iv_connectionname = |string|
          iv_dlqeventqueuearn = |string|
          iv_eventqueuearn = |string|
          iv_path = |string|
          iv_samplesize = 123
        )
      )
    )
  )
  it_classifiers = VALUE /aws1/cl_gluclifiernamelist_w=>tt_classifiernamelist(
    ( new /aws1/cl_gluclifiernamelist_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_glutagsmap_w=>tt_tagsmap(
    (
      VALUE /aws1/cl_glutagsmap_w=>ts_tagsmap_maprow(
        key = |string|
        value = new /aws1/cl_glutagsmap_w( |string| )
      )
    )
  )
  iv_configuration = |string|
  iv_crawlersecurityconf = |string|
  iv_databasename = |string|
  iv_description = |string|
  iv_name = |string|
  iv_role = |string|
  iv_schedule = |string|
  iv_tableprefix = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

/AWS1/IF_GLU=>CREATECRAWLER()¶

About CreateCrawler¶

Method Signature¶

IMPORTING¶

Required arguments:¶

iv_name TYPE /AWS1/GLUNAMESTRING /AWS1/GLUNAMESTRING¶

iv_role TYPE /AWS1/GLUROLE /AWS1/GLUROLE¶

io_targets TYPE REF TO /AWS1/CL_GLUCRAWLERTARGETS /AWS1/CL_GLUCRAWLERTARGETS¶

Optional arguments:¶

iv_databasename TYPE /AWS1/GLUDATABASENAME /AWS1/GLUDATABASENAME¶

iv_description TYPE /AWS1/GLUDESCRIPTIONSTRING /AWS1/GLUDESCRIPTIONSTRING¶

iv_schedule TYPE /AWS1/GLUCRONEXPRESSION /AWS1/GLUCRONEXPRESSION¶

it_classifiers TYPE /AWS1/CL_GLUCLIFIERNAMELIST_W=>TT_CLASSIFIERNAMELIST TT_CLASSIFIERNAMELIST¶

iv_tableprefix TYPE /AWS1/GLUTABLEPREFIX /AWS1/GLUTABLEPREFIX¶

io_schemachangepolicy TYPE REF TO /AWS1/CL_GLUSCHEMACHANGEPOLICY /AWS1/CL_GLUSCHEMACHANGEPOLICY¶

io_recrawlpolicy TYPE REF TO /AWS1/CL_GLURECRAWLPOLICY /AWS1/CL_GLURECRAWLPOLICY¶

io_lineageconfiguration TYPE REF TO /AWS1/CL_GLULINEAGECONF /AWS1/CL_GLULINEAGECONF¶

io_lakeformationconf TYPE REF TO /AWS1/CL_GLULAKEFORMATIONCONF /AWS1/CL_GLULAKEFORMATIONCONF¶

iv_configuration TYPE /AWS1/GLUCRAWLERCONFIGURATION /AWS1/GLUCRAWLERCONFIGURATION¶

iv_crawlersecurityconf TYPE /AWS1/GLUCRAWLERSECURITYCONF /AWS1/GLUCRAWLERSECURITYCONF¶

it_tags TYPE /AWS1/CL_GLUTAGSMAP_W=>TT_TAGSMAP TT_TAGSMAP¶