AWS Amazon SageMaker Workteam

This page shows how to write Terraform and CloudFormation for Amazon SageMaker Workteam and write them securely.

aws_sagemaker_workteam (Terraform)

The Workteam in Amazon SageMaker can be configured in Terraform with the resource name aws_sagemaker_workteam. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Review your Terraform file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).


The following arguments are supported:

  • description - (Required) A description of the work team.
  • workforce_name - (Required) The name of the Workteam (must be unique).
  • workteam_name - (Required) The name of the workforce.
  • member_definition - (Required) A list of Member Definitions 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 cognito_member_definition. For workforces created using your own OIDC identity provider (IdP) use oidc_member_definition. Do not provide input for both of these parameters in a single request. see Member Definition details below.
  • notification_configuration - (Optional) Configures notification of workers regarding available or expiring work items. see Notification Configuration details below.
  • tags - (Optional) A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Member Definition

  • cognito_member_definition - (Optional) The Amazon Cognito user group that is part of the work team. See Cognito Member Definition details below.
  • oidc_member_definition - (Optional) A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. See Cognito Member Definition details below.

Cognito Member Definition

  • client_id - (Required) An identifier for an application client. You must create the app client ID using Amazon Cognito.
  • user_pool - (Required) An identifier for a user pool. The user pool must be in the same region as the service that you are calling.
  • user_group - (Required) An identifier for a user group.

Oidc Member Definition

  • groups - (Required) A list of comma separated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.

Notification Configuration

  • notification_topic_arn - (Required) The ARN for the SNS topic to which notifications should be published.

In addition to all arguments above, the following attributes are exported:

  • arn - The Amazon Resource Name (ARN) assigned by AWS to this Workteam.
  • id - The name of the Workteam.
  • subdomain - The subdomain for your OIDC Identity Provider.
  • tags_all - A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Explanation in Terraform Registry

Provides a Sagemaker Workteam resource.

AWS::SageMaker::Workteam (CloudFormation)

The Workteam in SageMaker can be configured in CloudFormation with the resource name AWS::SageMaker::Workteam. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.


Explanation in CloudFormation Registry

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.

Frequently asked questions

What is AWS Amazon SageMaker Workteam?

AWS Amazon SageMaker Workteam is a resource for Amazon SageMaker of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.