Skip to content

/AWS1/CL_SGM=>CREATEWORKFORCE()

About CreateWorkforce

Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the DeleteWorkforce API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).

Method Signature

IMPORTING

Required arguments:

iv_workforcename TYPE /AWS1/SGMWORKFORCENAME /AWS1/SGMWORKFORCENAME

The name of the private workforce.

Optional arguments:

io_cognitoconfig TYPE REF TO /AWS1/CL_SGMCOGNITOCONFIG /AWS1/CL_SGMCOGNITOCONFIG

Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Do not use OidcConfig if you specify values for CognitoConfig.

io_oidcconfig TYPE REF TO /AWS1/CL_SGMOIDCCONFIG /AWS1/CL_SGMOIDCCONFIG

Use this parameter to configure a private workforce using your own OIDC Identity Provider.

Do not use CognitoConfig if you specify values for OidcConfig.

io_sourceipconfig TYPE REF TO /AWS1/CL_SGMSOURCEIPCONFIG /AWS1/CL_SGMSOURCEIPCONFIG

SourceIpConfig

it_tags TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST TT_TAGLIST

An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.

io_workforcevpcconfig TYPE REF TO /AWS1/CL_SGMWORKFORCEVPCCFGREQ /AWS1/CL_SGMWORKFORCEVPCCFGREQ

Use this parameter to configure a workforce using VPC.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmcreateworkforcersp /AWS1/CL_SGMCREATEWORKFORCERSP

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->/aws1/if_sgm~createworkforce(
  io_cognitoconfig = new /aws1/cl_sgmcognitoconfig(
    iv_clientid = |string|
    iv_userpool = |string|
  )
  io_oidcconfig = new /aws1/cl_sgmoidcconfig(
    it_authntctnreqextraparams = VALUE /aws1/cl_sgmauthreqextraprms_w=>tt_authntctnrequestextraparams(
      (
        VALUE /aws1/cl_sgmauthreqextraprms_w=>ts_authnreqextraparams_maprow(
          key = |string|
          value = new /aws1/cl_sgmauthreqextraprms_w( |string| )
        )
      )
    )
    iv_authorizationendpoint = |string|
    iv_clientid = |string|
    iv_clientsecret = |string|
    iv_issuer = |string|
    iv_jwksuri = |string|
    iv_logoutendpoint = |string|
    iv_scope = |string|
    iv_tokenendpoint = |string|
    iv_userinfoendpoint = |string|
  )
  io_sourceipconfig = new /aws1/cl_sgmsourceipconfig(
    it_cidrs = VALUE /aws1/cl_sgmcidrs_w=>tt_cidrs(
      ( new /aws1/cl_sgmcidrs_w( |string| ) )
    )
  )
  io_workforcevpcconfig = new /aws1/cl_sgmworkforcevpccfgreq(
    it_securitygroupids = VALUE /aws1/cl_sgmworkforcesecgrid00=>tt_workforcesecuritygroupids(
      ( new /aws1/cl_sgmworkforcesecgrid00( |string| ) )
    )
    it_subnets = VALUE /aws1/cl_sgmworkforcesubnets_w=>tt_workforcesubnets(
      ( new /aws1/cl_sgmworkforcesubnets_w( |string| ) )
    )
    iv_vpcid = |string|
  )
  it_tags = VALUE /aws1/cl_sgmtag=>tt_taglist(
    (
      new /aws1/cl_sgmtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_workforcename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_workforcearn = lo_result->get_workforcearn( ).
ENDIF.