Skip to content

/AWS1/IF_MA2=>CREATEALLOWLIST()

About CreateAllowList

Creates and defines the settings for an allow list.

Method Signature

METHODS /AWS1/IF_MA2~CREATEALLOWLIST
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/MA2__STRING OPTIONAL
    !IO_CRITERIA TYPE REF TO /AWS1/CL_MA2ALLOWLISTCRITERIA OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/MA2__STRMIN1MAX512PATSS OPTIONAL
    !IV_NAME TYPE /AWS1/MA2__STRINGMIN1MAX128PAT OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_MA2TAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ma2createallowlistrsp
  RAISING
    /AWS1/CX_MA2ACCESSDENIEDEX
    /AWS1/CX_MA2CONFLICTEXCEPTION
    /AWS1/CX_MA2INTERNALSERVEREX
    /AWS1/CX_MA2RESOURCENOTFOUNDEX
    /AWS1/CX_MA2SERVICEQUOTAEXCDEX
    /AWS1/CX_MA2THROTTLINGEX
    /AWS1/CX_MA2VALIDATIONEX
    /AWS1/CX_MA2CLIENTEXC
    /AWS1/CX_MA2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_clienttoken TYPE /AWS1/MA2__STRING /AWS1/MA2__STRING

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

io_criteria TYPE REF TO /AWS1/CL_MA2ALLOWLISTCRITERIA /AWS1/CL_MA2ALLOWLISTCRITERIA

The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.

iv_name TYPE /AWS1/MA2__STRINGMIN1MAX128PAT /AWS1/MA2__STRINGMIN1MAX128PAT

A custom name for the allow list. The name can contain as many as 128 characters.

Optional arguments:

iv_description TYPE /AWS1/MA2__STRMIN1MAX512PATSS /AWS1/MA2__STRMIN1MAX512PATSS

A custom description of the allow list. The description can contain as many as 512 characters.

it_tags TYPE /AWS1/CL_MA2TAGMAP_W=>TT_TAGMAP TT_TAGMAP

A map of key-value pairs that specifies the tags to associate with the allow list.

An allow list can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

RETURNING

oo_output TYPE REF TO /aws1/cl_ma2createallowlistrsp /AWS1/CL_MA2CREATEALLOWLISTRSP

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->createallowlist(
  io_criteria = new /aws1/cl_ma2allowlistcriteria(
    io_s3wordslist = new /aws1/cl_ma2s3wordslist(
      iv_bucketname = |string|
      iv_objectkey = |string|
    )
    iv_regex = |string|
  )
  it_tags = VALUE /aws1/cl_ma2tagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_ma2tagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_ma2tagmap_w( |string| )
      )
    )
  )
  iv_clienttoken = |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.
  lv___stringmin71max89patte = lo_result->get_arn( ).
  lv___stringmin22max22patte = lo_result->get_id( ).
ENDIF.