GETEFFECTIVEPOLICIES()`¶

About GetEffectivePolicies¶

Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the IoT device gateway.

Requires permission to access the GetEffectivePolicies action.

Method Signature¶

METHODS /AWS1/IF_IOT~GETEFFECTIVEPOLICIES
  IMPORTING
    !IV_PRINCIPAL TYPE /AWS1/IOTPRINCIPAL OPTIONAL
    !IV_COGNITOIDENTITYPOOLID TYPE /AWS1/IOTCOGNITOIDENTITYPOOLID OPTIONAL
    !IV_THINGNAME TYPE /AWS1/IOTTHINGNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotgeteffectivepolrsp
  RAISING
    /AWS1/CX_IOTINTERNALFAILUREEX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTLIMITEXCEEDEDEX
    /AWS1/CX_IOTRESOURCENOTFOUNDEX
    /AWS1/CX_IOTSERVICEUNAVAILEX
    /AWS1/CX_IOTTHROTTLINGEX
    /AWS1/CX_IOTUNAUTHORIZEDEX
    /AWS1/CX_IOTCLIENTEXC
    /AWS1/CX_IOTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_principal` `TYPE /AWS1/IOTPRINCIPAL` `/AWS1/IOTPRINCIPAL`¶

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

`iv_cognitoidentitypoolid` `TYPE /AWS1/IOTCOGNITOIDENTITYPOOLID` `/AWS1/IOTCOGNITOIDENTITYPOOLID`¶

The Cognito identity pool ID.

`iv_thingname` `TYPE /AWS1/IOTTHINGNAME` `/AWS1/IOTTHINGNAME`¶

The thing name.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iotgeteffectivepolrsp` `/AWS1/CL_IOTGETEFFECTIVEPOLRSP`¶

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->geteffectivepolicies(
  iv_cognitoidentitypoolid = |string|
  iv_principal = |string|
  iv_thingname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_effectivepolicies( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_policyname = lo_row_1->get_policyname( ).
      lv_policyarn = lo_row_1->get_policyarn( ).
      lv_policydocument = lo_row_1->get_policydocument( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_IOT=>GETEFFECTIVEPOLICIES()¶