CREATEWORKGROUP()`¶

About CreateWorkGroup¶

Creates a workgroup with the specified name. A workgroup can be an Apache Spark enabled workgroup or an Athena SQL workgroup.

Method Signature¶

METHODS /AWS1/IF_ATH~CREATEWORKGROUP
  IMPORTING
    !IV_NAME TYPE /AWS1/ATHWORKGROUPNAME OPTIONAL
    !IO_CONFIGURATION TYPE REF TO /AWS1/CL_ATHWORKGROUPCONF OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/ATHWORKGROUPDESCSTRING OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_ATHTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_athcreateworkgroupout
  RAISING
    /AWS1/CX_ATHINTERNALSERVEREX
    /AWS1/CX_ATHINVALIDREQUESTEX
    /AWS1/CX_ATHCLIENTEXC
    /AWS1/CX_ATHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_name` `TYPE /AWS1/ATHWORKGROUPNAME` `/AWS1/ATHWORKGROUPNAME`¶

The workgroup name.

Optional arguments:¶

`io_configuration` `TYPE REF TO /AWS1/CL_ATHWORKGROUPCONF` `/AWS1/CL_ATHWORKGROUPCONF`¶

Contains configuration information for creating an Athena SQL workgroup or Spark enabled Athena workgroup. Athena SQL workgroup configuration includes the location in Amazon S3 where query and calculation results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

`iv_description` `TYPE /AWS1/ATHWORKGROUPDESCSTRING` `/AWS1/ATHWORKGROUPDESCSTRING`¶

The workgroup description.

`it_tags` `TYPE /AWS1/CL_ATHTAG=>TT_TAGLIST` `TT_TAGLIST`¶

A list of comma separated tags to add to the workgroup that is created.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_athcreateworkgroupout` `/AWS1/CL_ATHCREATEWORKGROUPOUT`¶

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->createworkgroup(
  io_configuration = new /aws1/cl_athworkgroupconf(
    io_customercontentencconf = new /aws1/cl_athcuscontentencconf( |string| )
    io_engineversion = new /aws1/cl_athengineversion(
      iv_effectiveengineversion = |string|
      iv_selectedengineversion = |string|
    )
    io_identitycenterconf = new /aws1/cl_athidentitycenterconf(
      iv_enableidentitycenter = ABAP_TRUE
      iv_identitycenterinstancearn = |string|
    )
    io_managedqueryresultsconf = new /aws1/cl_athmanagedqueryrssc00(
      io_encryptionconfiguration = new /aws1/cl_athmanagedqueryrsse00( |string| )
      iv_enabled = ABAP_TRUE
    )
    io_queryrsltss3accgrantsconf = new /aws1/cl_athqueryrsss3accgra00(
      iv_authenticationtype = |string|
      iv_createuserlevelprefix = ABAP_TRUE
      iv_enables3accessgrants = ABAP_TRUE
    )
    io_resultconfiguration = new /aws1/cl_athresultconf(
      io_aclconfiguration = new /aws1/cl_athaclconfiguration( |string| )
      io_encryptionconfiguration = new /aws1/cl_athencryptionconf(
        iv_encryptionoption = |string|
        iv_kmskey = |string|
      )
      iv_expectedbucketowner = |string|
      iv_outputlocation = |string|
    )
    iv_additionalconfiguration = |string|
    iv_bytesscndcutoffperquery = 123
    iv_enableminimumencconf = ABAP_TRUE
    iv_enforceworkgroupconf = ABAP_TRUE
    iv_executionrole = |string|
    iv_pubcloudwatchmetenabled = ABAP_TRUE
    iv_requesterpaysenabled = ABAP_TRUE
  )
  it_tags = VALUE /aws1/cl_athtag=>tt_taglist(
    (
      new /aws1/cl_athtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_description = |string|
  iv_name = |string|
).

This is an example of reading all possible response values

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

/AWS1/IF_ATH=>CREATEWORKGROUP()¶