workteams

Creates, updates, deletes, gets or lists a workteams resource.

Overview

Name	`workteams`
Type	Resource
Id	`aws.sagemaker.workteams`

Fields

The following fields are returned by SELECT queries:

describe_workteam
list_workteams

Name	Datatype	Description
`create_date`	`string (date-time)`	The date and time that the work team was created (timestamp).
`description`	`string`	A description of the work team. (pattern: <code>.+</code>)
`last_updated_date`	`string (date-time)`	The date and time that the work team was last updated (timestamp).
`member_definitions`	`array`	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.
`notification_configuration`	`object`	Configures SNS notifications of available or expiring work items for work teams.
`product_listing_ids`	`array`	The Amazon Marketplace identifier for a vendor's work team.
`sub_domain`	`string`	The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.
`worker_access_configuration`	`object`	Describes any access constraints that have been defined for Amazon S3 resources.
`workforce_arn`	`string`	The Amazon Resource Name (ARN) of the workforce. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:workforce/.*</code>)
`workteam_arn`	`string`	The Amazon Resource Name (ARN) that identifies the work team. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:workteam/.*</code>)
`workteam_name`	`string`	The name of the work team. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)

Name	Datatype	Description
`create_date`	`string (date-time)`	The date and time that the work team was created (timestamp).
`description`	`string`	A description of the work team. (pattern: <code>.+</code>)
`last_updated_date`	`string (date-time)`	The date and time that the work team was last updated (timestamp).
`member_definitions`	`array`	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.
`notification_configuration`	`object`	Configures SNS notifications of available or expiring work items for work teams.
`product_listing_ids`	`array`	The Amazon Marketplace identifier for a vendor's work team.
`sub_domain`	`string`	The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.
`worker_access_configuration`	`object`	Describes any access constraints that have been defined for Amazon S3 resources.
`workforce_arn`	`string`	The Amazon Resource Name (ARN) of the workforce. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:workforce/.*</code>)
`workteam_arn`	`string`	The Amazon Resource Name (ARN) that identifies the work team. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:workteam/.*</code>)
`workteam_name`	`string`	The name of the work team. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`describe_workteam`	`select`	`region`	Gets information about a specific work team. You can see information such as the creation date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).
`list_workteams`	`select`	`region`	Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.
`create_workteam`	`insert`	`region`, `WorkteamName`, `MemberDefinitions`	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.
`update_workteam`	`update`	`region`, `WorkteamName`	Updates an existing work team with new member definitions or description.
`delete_workteam`	`delete`	`region`	Deletes an existing work team. This operation can't be undone.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`region`	`string`	AWS region (default: us-east-1)

`SELECT` examples

describe_workteam
list_workteams

Gets information about a specific work team. You can see information such as the creation date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).

SELECT
create_date,
description,
last_updated_date,
member_definitions,
notification_configuration,
product_listing_ids,
sub_domain,
worker_access_configuration,
workforce_arn,
workteam_arn,
workteam_name
FROM aws.sagemaker.workteams
WHERE region = '{{ region }}' -- required
;

Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

SELECT
create_date,
description,
last_updated_date,
member_definitions,
notification_configuration,
product_listing_ids,
sub_domain,
worker_access_configuration,
workforce_arn,
workteam_arn,
workteam_name
FROM aws.sagemaker.workteams
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_workteam
Manifest

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.

INSERT INTO aws.sagemaker.workteams (
WorkteamName,
WorkforceName,
MemberDefinitions,
Description,
NotificationConfiguration,
WorkerAccessConfiguration,
Tags,
region
)
SELECT 
'{{ WorkteamName }}' /* required */,
'{{ WorkforceName }}',
'{{ MemberDefinitions }}' /* required */,
'{{ Description }}',
'{{ NotificationConfiguration }}',
'{{ WorkerAccessConfiguration }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
workteam_arn
;

# Description fields are for documentation purposes
- name: workteams
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the workteams resource.
  - name: WorkteamName
    value: "{{ WorkteamName }}"
    description: |
      The name of the work team. Use this name to identify the work team.
  - name: WorkforceName
    value: "{{ WorkforceName }}"
    description: |
      The name of the workforce.
  - name: MemberDefinitions
    description: |
      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.
    value:
      - CognitoMemberDefinition:
          UserPool: "{{ UserPool }}"
          UserGroup: "{{ UserGroup }}"
          ClientId: "{{ ClientId }}"
        OidcMemberDefinition:
          Groups:
            - "{{ Groups }}"
  - name: Description
    value: "{{ Description }}"
    description: |
      A description of the work team.
  - name: NotificationConfiguration
    description: |
      Configures notification of workers regarding available or expiring work items.
    value:
      NotificationTopicArn: "{{ NotificationTopicArn }}"
  - name: WorkerAccessConfiguration
    description: |
      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.
    value:
      S3Presign:
        IamPolicyConstraints:
          SourceIp: "{{ SourceIp }}"
          VpcSourceIp: "{{ VpcSourceIp }}"
  - name: Tags
    description: |
      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:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

`UPDATE` examples

update_workteam

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

UPDATE aws.sagemaker.workteams
SET 
WorkteamName = '{{ WorkteamName }}',
MemberDefinitions = '{{ MemberDefinitions }}',
Description = '{{ Description }}',
NotificationConfiguration = '{{ NotificationConfiguration }}',
WorkerAccessConfiguration = '{{ WorkerAccessConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND WorkteamName = '{{ WorkteamName }}' --required
RETURNING
workteam;

`DELETE` examples

delete_workteam

Deletes an existing work team. This operation can't be undone.

DELETE FROM aws.sagemaker.workteams
WHERE region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​