Skip to content

/AWS1/IF_LOC=>CREATEGEOFENCECOLLECTION()

About CreateGeofenceCollection

Creates a geofence collection, which manages and stores geofences.

Method Signature

METHODS /AWS1/IF_LOC~CREATEGEOFENCECOLLECTION
  IMPORTING
    !IV_COLLECTIONNAME TYPE /AWS1/LOCRESOURCENAME OPTIONAL
    !IV_PRICINGPLAN TYPE /AWS1/LOCPRICINGPLAN OPTIONAL
    !IV_PRICINGPLANDATASOURCE TYPE /AWS1/LOCSTRING OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/LOCRESOURCEDESCRIPTION OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_LOCTAGMAP_W=>TT_TAGMAP OPTIONAL
    !IV_KMSKEYID TYPE /AWS1/LOCKMSKEYID OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_loccregeofencecollrsp
  RAISING
    /AWS1/CX_LOCACCESSDENIEDEX
    /AWS1/CX_LOCCONFLICTEXCEPTION
    /AWS1/CX_LOCINTERNALSERVEREX
    /AWS1/CX_LOCSERVICEQUOTAEXCDEX
    /AWS1/CX_LOCTHROTTLINGEX
    /AWS1/CX_LOCVALIDATIONEX
    /AWS1/CX_LOCCLIENTEXC
    /AWS1/CX_LOCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_collectionname TYPE /AWS1/LOCRESOURCENAME /AWS1/LOCRESOURCENAME

A custom name for the geofence collection.

Requirements:

  • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

  • Must be a unique geofence collection name.

  • No spaces allowed. For example, ExampleGeofenceCollection.

Optional arguments:

iv_pricingplan TYPE /AWS1/LOCPRICINGPLAN /AWS1/LOCPRICINGPLAN

No longer used. If included, the only allowed value is RequestBasedUsage.

iv_pricingplandatasource TYPE /AWS1/LOCSTRING /AWS1/LOCSTRING

This parameter is no longer used.

iv_description TYPE /AWS1/LOCRESOURCEDESCRIPTION /AWS1/LOCRESOURCEDESCRIPTION

An optional description for the geofence collection.

it_tags TYPE /AWS1/CL_LOCTAGMAP_W=>TT_TAGMAP TT_TAGMAP

Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

  • Cannot use "aws:" as a prefix for a key.

iv_kmskeyid TYPE /AWS1/LOCKMSKEYID /AWS1/LOCKMSKEYID

A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

RETURNING

oo_output TYPE REF TO /aws1/cl_loccregeofencecollrsp /AWS1/CL_LOCCREGEOFENCECOLLRSP

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->creategeofencecollection(
  it_tags = VALUE /aws1/cl_loctagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_loctagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_loctagmap_w( |string| )
      )
    )
  )
  iv_collectionname = |string|
  iv_description = |string|
  iv_kmskeyid = |string|
  iv_pricingplan = |string|
  iv_pricingplandatasource = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_resourcename = lo_result->get_collectionname( ).
  lv_arn = lo_result->get_collectionarn( ).
  lv_timestamp = lo_result->get_createtime( ).
ENDIF.