Skip to content

/AWS1/IF_IOS=>CREATEACCESSPOLICY()

About CreateAccessPolicy

Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.

Support for access policies that use an SSO Group as the identity is not supported at this time.

Method Signature

METHODS /AWS1/IF_IOS~CREATEACCESSPOLICY
  IMPORTING
    !IO_ACCESSPOLICYIDENTITY TYPE REF TO /AWS1/CL_IOSIDENTITY OPTIONAL
    !IO_ACCESSPOLICYRESOURCE TYPE REF TO /AWS1/CL_IOSRESOURCE OPTIONAL
    !IV_ACCESSPOLICYPERMISSION TYPE /AWS1/IOSPERMISSION OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/IOSCLIENTTOKEN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_IOSTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioscreateaccpolicyrsp
  RAISING
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /AWS1/CX_IOSLIMITEXCEEDEDEX
    /AWS1/CX_IOSRESOURCENOTFOUNDEX
    /AWS1/CX_IOSTHROTTLINGEX
    /AWS1/CX_IOSCLIENTEXC
    /AWS1/CX_IOSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

io_accesspolicyidentity TYPE REF TO /AWS1/CL_IOSIDENTITY /AWS1/CL_IOSIDENTITY

The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.

io_accesspolicyresource TYPE REF TO /AWS1/CL_IOSRESOURCE /AWS1/CL_IOSRESOURCE

The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

iv_accesspolicypermission TYPE /AWS1/IOSPERMISSION /AWS1/IOSPERMISSION

The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

Optional arguments:

iv_clienttoken TYPE /AWS1/IOSCLIENTTOKEN /AWS1/IOSCLIENTTOKEN

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

it_tags TYPE /AWS1/CL_IOSTAGMAP_W=>TT_TAGMAP TT_TAGMAP

A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_ioscreateaccpolicyrsp /AWS1/CL_IOSCREATEACCPOLICYRSP

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->createaccesspolicy(
  io_accesspolicyidentity = new /aws1/cl_iosidentity(
    io_group = new /aws1/cl_iosgroupidentity( |string| )
    io_iamrole = new /aws1/cl_iosiamroleidentity( |string| )
    io_iamuser = new /aws1/cl_iosiamuseridentity( |string| )
    io_user = new /aws1/cl_iosuseridentity( |string| )
  )
  io_accesspolicyresource = new /aws1/cl_iosresource(
    io_portal = new /aws1/cl_iosportalresource( |string| )
    io_project = new /aws1/cl_iosprojectresource( |string| )
  )
  it_tags = VALUE /aws1/cl_iostagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_iostagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_iostagmap_w( |string| )
      )
    )
  )
  iv_accesspolicypermission = |string|
  iv_clienttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_id = lo_result->get_accesspolicyid( ).
  lv_arn = lo_result->get_accesspolicyarn( ).
ENDIF.