Skip to content

/AWS1/IF_CRM=>CREATEMEMBERSHIP()

About CreateMembership

Creates a membership for a specific collaboration identifier and joins the collaboration.

Method Signature

METHODS /AWS1/IF_CRM~CREATEMEMBERSHIP
  IMPORTING
    !IV_COLLABORATIONIDENTIFIER TYPE /AWS1/CRMCOLLABORATIONID OPTIONAL
    !IV_QUERYLOGSTATUS TYPE /AWS1/CRMMEMBERSHIPQUERYLOGS00 OPTIONAL
    !IV_JOBLOGSTATUS TYPE /AWS1/CRMMEMBERSHIPJOBLOGSTAT OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_CRMTAGMAP_W=>TT_TAGMAP OPTIONAL
    !IO_DEFAULTRESULTCONF TYPE REF TO /AWS1/CL_CRMMEMBERSHIPPROTEC00 OPTIONAL
    !IO_DEFAULTJOBRESULTCONF TYPE REF TO /AWS1/CL_CRMMEMBERSHIPPROTEC02 OPTIONAL
    !IO_PAYMENTCONFIGURATION TYPE REF TO /AWS1/CL_CRMMEMBERSHIPPMNTCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_crmcremembershipout
  RAISING
    /AWS1/CX_CRMACCESSDENIEDEX
    /AWS1/CX_CRMCONFLICTEXCEPTION
    /AWS1/CX_CRMINTERNALSERVEREX
    /AWS1/CX_CRMRESOURCENOTFOUNDEX
    /AWS1/CX_CRMSERVICEQUOTAEXCDEX
    /AWS1/CX_CRMTHROTTLINGEX
    /AWS1/CX_CRMVALIDATIONEX
    /AWS1/CX_CRMCLIENTEXC
    /AWS1/CX_CRMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_collaborationidentifier TYPE /AWS1/CRMCOLLABORATIONID /AWS1/CRMCOLLABORATIONID

The unique ID for the associated collaboration.

iv_querylogstatus TYPE /AWS1/CRMMEMBERSHIPQUERYLOGS00 /AWS1/CRMMEMBERSHIPQUERYLOGS00

An indicator as to whether query logging has been enabled or disabled for the membership.

When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

Optional arguments:

iv_joblogstatus TYPE /AWS1/CRMMEMBERSHIPJOBLOGSTAT /AWS1/CRMMEMBERSHIPJOBLOGSTAT

An indicator as to whether job logging has been enabled or disabled for the collaboration.

When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

it_tags TYPE /AWS1/CL_CRMTAGMAP_W=>TT_TAGMAP TT_TAGMAP

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

io_defaultresultconf TYPE REF TO /AWS1/CL_CRMMEMBERSHIPPROTEC00 /AWS1/CL_CRMMEMBERSHIPPROTEC00

The default protected query result configuration as specified by the member who can receive results.

io_defaultjobresultconf TYPE REF TO /AWS1/CL_CRMMEMBERSHIPPROTEC02 /AWS1/CL_CRMMEMBERSHIPPROTEC02

The default job result configuration that determines how job results are protected and managed within this membership. This configuration applies to all jobs.

io_paymentconfiguration TYPE REF TO /AWS1/CL_CRMMEMBERSHIPPMNTCONF /AWS1/CL_CRMMEMBERSHIPPMNTCONF

The payment responsibilities accepted by the collaboration member.

Not required if the collaboration member has the member ability to run queries.

Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator.

RETURNING

oo_output TYPE REF TO /aws1/cl_crmcremembershipout /AWS1/CL_CRMCREMEMBERSHIPOUT

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->createmembership(
  io_defaultjobresultconf = new /aws1/cl_crmmembershipprotec02(
    io_outputconfiguration = new /aws1/cl_crmmembershipprotec03(
      io_s3 = new /aws1/cl_crmprotectedjobs3ou01(
        iv_bucket = |string|
        iv_keyprefix = |string|
      )
    )
    iv_rolearn = |string|
  )
  io_defaultresultconf = new /aws1/cl_crmmembershipprotec00(
    io_outputconfiguration = new /aws1/cl_crmmembershipprotec01(
      io_s3 = new /aws1/cl_crmprotectedquerys300(
        iv_bucket = |string|
        iv_keyprefix = |string|
        iv_resultformat = |string|
        iv_singlefileoutput = ABAP_TRUE
      )
    )
    iv_rolearn = |string|
  )
  io_paymentconfiguration = new /aws1/cl_crmmembershippmntconf(
    io_jobcompute = new /aws1/cl_crmmembershipjobcom00( ABAP_TRUE )
    io_machinelearning = new /aws1/cl_crmmembershipmlpmnt00(
      io_modelinference = new /aws1/cl_crmmembershipmdelin00( ABAP_TRUE )
      io_modeltraining = new /aws1/cl_crmmembershipmdeltr00( ABAP_TRUE )
    )
    io_querycompute = new /aws1/cl_crmmembershipqueryc00( ABAP_TRUE )
  )
  it_tags = VALUE /aws1/cl_crmtagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_crmtagmap_w=>ts_tagmap_maprow(
        value = new /aws1/cl_crmtagmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_collaborationidentifier = |string|
  iv_joblogstatus = |string|
  iv_querylogstatus = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_membership = lo_result->get_membership( ).
  IF lo_membership IS NOT INITIAL.
    lv_uuid = lo_membership->get_id( ).
    lv_membershiparn = lo_membership->get_arn( ).
    lv_collaborationarn = lo_membership->get_collaborationarn( ).
    lv_uuid = lo_membership->get_collaborationid( ).
    lv_accountid = lo_membership->get_collaborationcreatorac00( ).
    lv_displayname = lo_membership->get_collaborationcreatords00( ).
    lv_collaborationname = lo_membership->get_collaborationname( ).
    lv_timestamp = lo_membership->get_createtime( ).
    lv_timestamp = lo_membership->get_updatetime( ).
    lv_membershipstatus = lo_membership->get_status( ).
    LOOP AT lo_membership->get_memberabilities( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_memberability = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lo_mlmemberabilities = lo_membership->get_mlmemberabilities( ).
    IF lo_mlmemberabilities IS NOT INITIAL.
      LOOP AT lo_mlmemberabilities->get_custommlmemberabilities( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_custommlmemberability = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
    lv_membershipquerylogstatu = lo_membership->get_querylogstatus( ).
    lv_membershipjoblogstatus = lo_membership->get_joblogstatus( ).
    lo_membershipprotectedquer = lo_membership->get_defaultresultconf( ).
    IF lo_membershipprotectedquer IS NOT INITIAL.
      lo_membershipprotectedquer_1 = lo_membershipprotectedquer->get_outputconfiguration( ).
      IF lo_membershipprotectedquer_1 IS NOT INITIAL.
        lo_protectedquerys3outputc = lo_membershipprotectedquer_1->get_s3( ).
        IF lo_protectedquerys3outputc IS NOT INITIAL.
          lv_resultformat = lo_protectedquerys3outputc->get_resultformat( ).
          lv_string = lo_protectedquerys3outputc->get_bucket( ).
          lv_keyprefix = lo_protectedquerys3outputc->get_keyprefix( ).
          lv_boolean = lo_protectedquerys3outputc->get_singlefileoutput( ).
        ENDIF.
      ENDIF.
      lv_rolearn = lo_membershipprotectedquer->get_rolearn( ).
    ENDIF.
    lo_membershipprotectedjobr = lo_membership->get_defaultjobresultconf( ).
    IF lo_membershipprotectedjobr IS NOT INITIAL.
      lo_membershipprotectedjobo = lo_membershipprotectedjobr->get_outputconfiguration( ).
      IF lo_membershipprotectedjobo IS NOT INITIAL.
        lo_protectedjobs3outputcon = lo_membershipprotectedjobo->get_s3( ).
        IF lo_protectedjobs3outputcon IS NOT INITIAL.
          lv_string = lo_protectedjobs3outputcon->get_bucket( ).
          lv_keyprefix = lo_protectedjobs3outputcon->get_keyprefix( ).
        ENDIF.
      ENDIF.
      lv_rolearn = lo_membershipprotectedjobr->get_rolearn( ).
    ENDIF.
    lo_membershippaymentconfig = lo_membership->get_paymentconfiguration( ).
    IF lo_membershippaymentconfig IS NOT INITIAL.
      lo_membershipquerycomputep = lo_membershippaymentconfig->get_querycompute( ).
      IF lo_membershipquerycomputep IS NOT INITIAL.
        lv_boolean = lo_membershipquerycomputep->get_isresponsible( ).
      ENDIF.
      lo_membershipmlpaymentconf = lo_membershippaymentconfig->get_machinelearning( ).
      IF lo_membershipmlpaymentconf IS NOT INITIAL.
        lo_membershipmodeltraining = lo_membershipmlpaymentconf->get_modeltraining( ).
        IF lo_membershipmodeltraining IS NOT INITIAL.
          lv_boolean = lo_membershipmodeltraining->get_isresponsible( ).
        ENDIF.
        lo_membershipmodelinferenc = lo_membershipmlpaymentconf->get_modelinference( ).
        IF lo_membershipmodelinferenc IS NOT INITIAL.
          lv_boolean = lo_membershipmodelinferenc->get_isresponsible( ).
        ENDIF.
      ENDIF.
      lo_membershipjobcomputepay = lo_membershippaymentconfig->get_jobcompute( ).
      IF lo_membershipjobcomputepay IS NOT INITIAL.
        lv_boolean = lo_membershipjobcomputepay->get_isresponsible( ).
      ENDIF.
    ENDIF.
  ENDIF.
ENDIF.