Skip to content

Create Workteam

sagemaker_create_workteam R Documentation

Creates a new work team for labeling your data

Description

Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

Usage

sagemaker_create_workteam(WorkteamName, WorkforceName,
  MemberDefinitions, Description, NotificationConfiguration,
  WorkerAccessConfiguration, Tags)

Arguments

WorkteamName

[required] The name of the work team. Use this name to identify the work team.

WorkforceName

The name of the workforce.

MemberDefinitions

[required] 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. Do 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.

Description

[required] A description of the work team.

NotificationConfiguration

Configures notification of workers regarding available or expiring work items.

WorkerAccessConfiguration

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.

Tags

An array of key-value pairs.

For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

Value

A list with the following syntax: 

list(
  WorkteamArn = "string"
)

Request syntax

svc$create_workteam(
  WorkteamName = "string",
  WorkforceName = "string",
  MemberDefinitions = list(
    list(
      CognitoMemberDefinition = list(
        UserPool = "string",
        UserGroup = "string",
        ClientId = "string"
      ),
      OidcMemberDefinition = list(
        Groups = list(
          "string"
        )
      )
    )
  ),
  Description = "string",
  NotificationConfiguration = list(
    NotificationTopicArn = "string"
  ),
  WorkerAccessConfiguration = list(
    S3Presign = list(
      IamPolicyConstraints = list(
        SourceIp = "Enabled"|"Disabled",
        VpcSourceIp = "Enabled"|"Disabled"
      )
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)