LISTACCOUNTSETTINGS()`¶

About ListAccountSettings¶

Lists the account settings for a specified principal.

Method Signature¶

METHODS /AWS1/IF_ECS~LISTACCOUNTSETTINGS
  IMPORTING
    !IV_NAME TYPE /AWS1/ECSSETTINGNAME OPTIONAL
    !IV_VALUE TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_PRINCIPALARN TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_EFFECTIVESETTINGS TYPE /AWS1/ECSBOOLEAN OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ECSSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ECSINTEGER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ecslistacctstgsrsp
  RAISING
    /AWS1/CX_ECSCLIENTEXCEPTION
    /AWS1/CX_ECSINVALIDPARAMETEREX
    /AWS1/CX_ECSSERVEREXCEPTION
    /AWS1/CX_ECSCLIENTEXC
    /AWS1/CX_ECSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_name` `TYPE /AWS1/ECSSETTINGNAME` `/AWS1/ECSSETTINGNAME`¶

The name of the account setting you want to list the settings for.

`iv_value` `TYPE /AWS1/ECSSTRING` `/AWS1/ECSSTRING`¶

The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.

`iv_principalarn` `TYPE /AWS1/ECSSTRING` `/AWS1/ECSSTRING`¶

The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

In order to use this parameter, you must be the root user, or the principal.

Federated users assume the account setting of the root user and can't have explicit account settings set for them.

`iv_effectivesettings` `TYPE /AWS1/ECSBOOLEAN` `/AWS1/ECSBOOLEAN`¶

Determines whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they're set. Otherwise, no account settings are returned.

`iv_nexttoken` `TYPE /AWS1/ECSSTRING` `/AWS1/ECSSTRING`¶

The nextToken value returned from a ListAccountSettings request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

`iv_maxresults` `TYPE /AWS1/ECSINTEGER` `/AWS1/ECSINTEGER`¶

The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter isn't used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ecslistacctstgsrsp` `/AWS1/CL_ECSLISTACCTSTGSRSP`¶

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->listaccountsettings(
  iv_effectivesettings = ABAP_TRUE
  iv_maxresults = 123
  iv_name = |string|
  iv_nexttoken = |string|
  iv_principalarn = |string|
  iv_value = |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_settings( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_settingname = lo_row_1->get_name( ).
      lv_string = lo_row_1->get_value( ).
      lv_string = lo_row_1->get_principalarn( ).
      lv_settingtype = lo_row_1->get_type( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

To view the effective account settings for a specific IAM user or IAM role¶

This example displays the effective account settings for the specified user or role.

DATA(lo_result) = lo_client->listaccountsettings(
  iv_effectivesettings = ABAP_TRUE
  iv_principalarn = |arn:aws:iam::<aws_account_id>:user/principalName|
).

To view your effective account settings¶

This example displays the effective account settings for your account.

DATA(lo_result) = lo_client->listaccountsettings( iv_effectivesettings = ABAP_TRUE ) .

/AWS1/IF_ECS=>LISTACCOUNTSETTINGS()¶