DESCRIBEPRINCIPALIDFORMAT()`¶

About DescribePrincipalIdFormat¶

Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.

By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.

Method Signature¶

METHODS /AWS1/IF_EC2~DESCRIBEPRINCIPALIDFORMAT
  IMPORTING
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IT_RESOURCES TYPE /AWS1/CL_EC2RESOURCELIST_W=>TT_RESOURCELIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2DSCPRPIDFORMATMAXRSS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2dscprpidformatrs
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_dryrun` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

`it_resources` `TYPE /AWS1/CL_EC2RESOURCELIST_W=>TT_RESOURCELIST` `TT_RESOURCELIST`¶

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway

`iv_maxresults` `TYPE /AWS1/EC2DSCPRPIDFORMATMAXRSS` `/AWS1/EC2DSCPRPIDFORMATMAXRSS`¶

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

`iv_nexttoken` `TYPE /AWS1/EC2STRING` `/AWS1/EC2STRING`¶

The token to request the next page of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2dscprpidformatrs` `/AWS1/CL_EC2DSCPRPIDFORMATRS`¶

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->describeprincipalidformat(
  it_resources = VALUE /aws1/cl_ec2resourcelist_w=>tt_resourcelist(
    ( new /aws1/cl_ec2resourcelist_w( |string| ) )
  )
  iv_dryrun = ABAP_TRUE
  iv_maxresults = 123
  iv_nexttoken = |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_principals( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_arn( ).
      LOOP AT lo_row_1->get_statuses( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_datetime = lo_row_3->get_deadline( ).
          lv_string = lo_row_3->get_resource( ).
          lv_boolean = lo_row_3->get_uselongids( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_EC2=>DESCRIBEPRINCIPALIDFORMAT()¶