/AWS1/IF_LOC=>CREATEKEY()

About CreateKey

Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer.

For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.

Method Signature

METHODS /AWS1/IF_LOC~CREATEKEY
  IMPORTING
    !IV_KEYNAME TYPE /AWS1/LOCRESOURCENAME OPTIONAL
    !IO_RESTRICTIONS TYPE REF TO /AWS1/CL_LOCAPIKEYRESTRICTIONS OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/LOCRESOURCEDESCRIPTION OPTIONAL
    !IV_EXPIRETIME TYPE /AWS1/LOCTIMESTAMP OPTIONAL
    !IV_NOEXPIRY TYPE /AWS1/LOCBOOLEAN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_LOCTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_loccreatekeyresponse
  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_keyname TYPE /AWS1/LOCRESOURCENAME /AWS1/LOCRESOURCENAME

A custom name for the API key resource.

Requirements:

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

• Must be a unique API key name.

• No spaces allowed. For example, ExampleAPIKey.

io_restrictions TYPE REF TO /AWS1/CL_LOCAPIKEYRESTRICTIONS /AWS1/CL_LOCAPIKEYRESTRICTIONS

The API key restrictions for the API key resource.

Optional arguments:

iv_description TYPE /AWS1/LOCRESOURCEDESCRIPTION /AWS1/LOCRESOURCEDESCRIPTION

An optional description for the API key resource.

iv_expiretime TYPE /AWS1/LOCTIMESTAMP /AWS1/LOCTIMESTAMP

The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.

iv_noexpiry TYPE /AWS1/LOCBOOLEAN /AWS1/LOCBOOLEAN

Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

it_tags TYPE /AWS1/CL_LOCTAGMAP_W=>TT_TAGMAP TT_TAGMAP

Applies one or more tags to the map resource. A tag is a key-value pair that 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.

RETURNING

oo_output TYPE REF TO /aws1/cl_loccreatekeyresponse /AWS1/CL_LOCCREATEKEYRESPONSE

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->createkey(
  io_restrictions = new /aws1/cl_locapikeyrestrictions(
    it_allowactions = VALUE /aws1/cl_locapikeyactionlist_w=>tt_apikeyactionlist(
      ( new /aws1/cl_locapikeyactionlist_w( |string| ) )
    )
    it_allowandroidapps = VALUE /aws1/cl_locandroidapp=>tt_androidapplist(
      (
        new /aws1/cl_locandroidapp(
          iv_certificatefingerprint = |string|
          iv_package = |string|
        )
      )
    )
    it_allowappleapps = VALUE /aws1/cl_locappleapp=>tt_appleapplist(
      ( new /aws1/cl_locappleapp( |string| ) )
    )
    it_allowreferers = VALUE /aws1/cl_locrefererpatlist_w=>tt_refererpatternlist(
      ( new /aws1/cl_locrefererpatlist_w( |string| ) )
    )
    it_allowresources = VALUE /aws1/cl_locgeoarnlist_w=>tt_geoarnlist(
      ( new /aws1/cl_locgeoarnlist_w( |string| ) )
    )
  )
  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_description = |string|
  iv_expiretime = '20150101000000.0000000'
  iv_keyname = |string|
  iv_noexpiry = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_apikey = lo_result->get_key( ).
  lv_arn = lo_result->get_keyarn( ).
  lv_resourcename = lo_result->get_keyname( ).
  lv_timestamp = lo_result->get_createtime( ).
ENDIF.