DESCRENVIRONMENTMEMBERSHIPS()`¶

About DescribeEnvironmentMemberships¶

Gets information about environment members for an Cloud9 development environment.

Cloud9 is no longer available to new customers. Existing customers of Cloud9 can continue to use the service as normal. Learn more"

Method Signature¶

METHODS /AWS1/IF_CL9~DESCRENVIRONMENTMEMBERSHIPS
  IMPORTING
    !IV_USERARN TYPE /AWS1/CL9USERARN OPTIONAL
    !IV_ENVIRONMENTID TYPE /AWS1/CL9ENVIRONMENTID OPTIONAL
    !IT_PERMISSIONS TYPE /AWS1/CL_CL9PERMISSIONSLIST_W=>TT_PERMISSIONSLIST OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CL9STRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/CL9MAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cl9dscenvironmentme01
  RAISING
    /AWS1/CX_CL9BADREQUESTEX
    /AWS1/CX_CL9CONFLICTEXCEPTION
    /AWS1/CX_CL9FORBIDDENEXCEPTION
    /AWS1/CX_CL9INTERNALSERVERER00
    /AWS1/CX_CL9LIMITEXCEEDEDEX
    /AWS1/CX_CL9NOTFOUNDEXCEPTION
    /AWS1/CX_CL9TOOMANYREQUESTSEX
    /AWS1/CX_CL9CLIENTEXC
    /AWS1/CX_CL9SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`iv_userarn` `TYPE /AWS1/CL9USERARN` `/AWS1/CL9USERARN`¶

The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.

`iv_environmentid` `TYPE /AWS1/CL9ENVIRONMENTID` `/AWS1/CL9ENVIRONMENTID`¶

The ID of the environment to get environment member information about.

`it_permissions` `TYPE /AWS1/CL_CL9PERMISSIONSLIST_W=>TT_PERMISSIONSLIST` `TT_PERMISSIONSLIST`¶

The type of environment member permissions to get information about. Available values include:

owner: Owns the environment.

read-only: Has read-only access to the environment.

read-write: Has read-write access to the environment.

If no value is specified, information about all environment members are returned.

`iv_nexttoken` `TYPE /AWS1/CL9STRING` `/AWS1/CL9STRING`¶

During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

`iv_maxresults` `TYPE /AWS1/CL9MAXRESULTS` `/AWS1/CL9MAXRESULTS`¶

The maximum number of environment members to get information about.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cl9dscenvironmentme01` `/AWS1/CL_CL9DSCENVIRONMENTME01`¶

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->descrenvironmentmemberships(
  it_permissions = VALUE /aws1/cl_cl9permissionslist_w=>tt_permissionslist(
    ( new /aws1/cl_cl9permissionslist_w( |string| ) )
  )
  iv_environmentid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_userarn = |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_memberships( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_permissions = lo_row_1->get_permissions( ).
      lv_string = lo_row_1->get_userid( ).
      lv_userarn = lo_row_1->get_userarn( ).
      lv_environmentid = lo_row_1->get_environmentid( ).
      lv_timestamp = lo_row_1->get_lastaccess( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

DescribeEnvironmentMemberships2¶

The following example gets information about the owner of the specified development environment.

DATA(lo_result) = lo_client->descrenvironmentmemberships(
  it_permissions = VALUE /aws1/cl_cl9permissionslist_w=>tt_permissionslist(
    ( new /aws1/cl_cl9permissionslist_w( |owner| ) )
  )
  iv_environmentid = |8d9967e2f0624182b74e7690ad69ebEX|
).

DescribeEnvironmentMemberships3¶

The following example gets development environment membership information for the specified user.

DATA(lo_result) = lo_client->descrenvironmentmemberships( iv_userarn = |arn:aws:iam::123456789012:user/MyDemoUser| ) .

DescribeEnvironmentMemberships1¶

The following example gets information about all of the environment members for the specified development environment.

DATA(lo_result) = lo_client->descrenvironmentmemberships( iv_environmentid = |8d9967e2f0624182b74e7690ad69ebEX| ) .

/AWS1/IF_CL9=>DESCRENVIRONMENTMEMBERSHIPS()¶