UPDATEWORKTEAM()`¶

About UpdateWorkteam¶

Updates an existing work team with new member definitions or description.

Method Signature¶

METHODS /AWS1/IF_SGM~UPDATEWORKTEAM
  IMPORTING
    !IV_WORKTEAMNAME TYPE /AWS1/SGMWORKTEAMNAME OPTIONAL
    !IT_MEMBERDEFINITIONS TYPE /AWS1/CL_SGMMEMBERDEFINITION=>TT_MEMBERDEFINITIONS OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/SGMSTRING200 OPTIONAL
    !IO_NOTIFICATIONCONFIGURATION TYPE REF TO /AWS1/CL_SGMNOTIFICATIONCONF OPTIONAL
    !IO_WORKERACCESSCONFIGURATION TYPE REF TO /AWS1/CL_SGMWORKERACCESSCONF OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmupdateworkteamrsp
  RAISING
    /AWS1/CX_SGMRESOURCELIMITEXCD
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_workteamname` `TYPE /AWS1/SGMWORKTEAMNAME` `/AWS1/SGMWORKTEAMNAME`¶

The name of the work team to update.

Optional arguments:¶

`it_memberdefinitions` `TYPE /AWS1/CL_SGMMEMBERDEFINITION=>TT_MEMBERDEFINITIONS` `TT_MEMBERDEFINITIONS`¶

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. You should not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see Adding groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups. Be aware that user groups that are already in the work team must also be listed in Groups when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.

`iv_description` `TYPE /AWS1/SGMSTRING200` `/AWS1/SGMSTRING200`¶

An updated description for the work team.

`io_notificationconfiguration` `TYPE REF TO /AWS1/CL_SGMNOTIFICATIONCONF` `/AWS1/CL_SGMNOTIFICATIONCONF`¶

Configures SNS topic notifications for available or expiring work items

`io_workeraccessconfiguration` `TYPE REF TO /AWS1/CL_SGMWORKERACCESSCONF` `/AWS1/CL_SGMWORKERACCESSCONF`¶

Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_sgmupdateworkteamrsp` `/AWS1/CL_SGMUPDATEWORKTEAMRSP`¶

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->updateworkteam(
  io_notificationconfiguration = new /aws1/cl_sgmnotificationconf( |string| )
  io_workeraccessconfiguration = new /aws1/cl_sgmworkeraccessconf(
    io_s3presign = new /aws1/cl_sgms3presign(
      io_iampolicyconstraints = new /aws1/cl_sgmiampolicycnstrnts(
        iv_sourceip = |string|
        iv_vpcsourceip = |string|
      )
    )
  )
  it_memberdefinitions = VALUE /aws1/cl_sgmmemberdefinition=>tt_memberdefinitions(
    (
      new /aws1/cl_sgmmemberdefinition(
        io_cognitomemberdefinition = new /aws1/cl_sgmcognitomemberdefn(
          iv_clientid = |string|
          iv_usergroup = |string|
          iv_userpool = |string|
        )
        io_oidcmemberdefinition = new /aws1/cl_sgmoidcmemberdefn(
          it_groups = VALUE /aws1/cl_sgmgroups_w=>tt_groups(
            ( new /aws1/cl_sgmgroups_w( |string| ) )
          )
        )
      )
    )
  )
  iv_description = |string|
  iv_workteamname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_workteam = lo_result->get_workteam( ).
  IF lo_workteam IS NOT INITIAL.
    lv_workteamname = lo_workteam->get_workteamname( ).
    LOOP AT lo_workteam->get_memberdefinitions( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lo_cognitomemberdefinition = lo_row_1->get_cognitomemberdefinition( ).
        IF lo_cognitomemberdefinition IS NOT INITIAL.
          lv_cognitouserpool = lo_cognitomemberdefinition->get_userpool( ).
          lv_cognitousergroup = lo_cognitomemberdefinition->get_usergroup( ).
          lv_clientid = lo_cognitomemberdefinition->get_clientid( ).
        ENDIF.
        lo_oidcmemberdefinition = lo_row_1->get_oidcmemberdefinition( ).
        IF lo_oidcmemberdefinition IS NOT INITIAL.
          LOOP AT lo_oidcmemberdefinition->get_groups( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_group = lo_row_3->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDIF.
    ENDLOOP.
    lv_workteamarn = lo_workteam->get_workteamarn( ).
    lv_workforcearn = lo_workteam->get_workforcearn( ).
    LOOP AT lo_workteam->get_productlistingids( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_string = lo_row_5->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_string200 = lo_workteam->get_description( ).
    lv_string = lo_workteam->get_subdomain( ).
    lv_timestamp = lo_workteam->get_createdate( ).
    lv_timestamp = lo_workteam->get_lastupdateddate( ).
    lo_notificationconfigurati = lo_workteam->get_notificationconf( ).
    IF lo_notificationconfigurati IS NOT INITIAL.
      lv_notificationtopicarn = lo_notificationconfigurati->get_notificationtopicarn( ).
    ENDIF.
    lo_workeraccessconfigurati = lo_workteam->get_workeraccessconf( ).
    IF lo_workeraccessconfigurati IS NOT INITIAL.
      lo_s3presign = lo_workeraccessconfigurati->get_s3presign( ).
      IF lo_s3presign IS NOT INITIAL.
        lo_iampolicyconstraints = lo_s3presign->get_iampolicyconstraints( ).
        IF lo_iampolicyconstraints IS NOT INITIAL.
          lv_enabledordisabled = lo_iampolicyconstraints->get_sourceip( ).
          lv_enabledordisabled = lo_iampolicyconstraints->get_vpcsourceip( ).
        ENDIF.
      ENDIF.
    ENDIF.
  ENDIF.
ENDIF.

/AWS1/IF_SGM=>UPDATEWORKTEAM()¶