SageMaker / Client / list_workteams

list_workteams

SageMaker.Client.list_workteams(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_workteams(
    SortBy='Name'|'CreateDate',
    SortOrder='Ascending'|'Descending',
    NameContains='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

• SortBy (string) – The field to sort results by. The default is CreationTime.

• SortOrder (string) – The sort order for results. The default is Ascending.

• NameContains (string) – A string in the work team’s name. This filter returns only work teams whose name contains the specified string.

• NextToken (string) – If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

• MaxResults (integer) – The maximum number of work teams to return in each page of the response.

Return type:

dict

Returns:

Response Syntax

{
    'Workteams': [
        {
            'WorkteamName': 'string',
            'MemberDefinitions': [
                {
                    'CognitoMemberDefinition': {
                        'UserPool': 'string',
                        'UserGroup': 'string',
                        'ClientId': 'string'
                    },
                    'OidcMemberDefinition': {
                        'Groups': [
                            'string',
                        ]
                    }
                },
            ],
            'WorkteamArn': 'string',
            'WorkforceArn': 'string',
            'ProductListingIds': [
                'string',
            ],
            'Description': 'string',
            'SubDomain': 'string',
            'CreateDate': datetime(2015, 1, 1),
            'LastUpdatedDate': datetime(2015, 1, 1),
            'NotificationConfiguration': {
                'NotificationTopicArn': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Workteams (list) –

    An array of Workteam objects, each describing a work team.

    • (dict) –

      Provides details about a labeling work team.

      • WorkteamName (string) –

        The name of the work team.

      • MemberDefinitions (list) –

        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.

        • (dict) –

          Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.

          • CognitoMemberDefinition (dict) –

            The Amazon Cognito user group that is part of the work team.

            • UserPool (string) –

              An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

            • UserGroup (string) –

              An identifier for a user group.

            • ClientId (string) –

              An identifier for an application client. You must create the app client ID using Amazon Cognito.

          • OidcMemberDefinition (dict) –

            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. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

            • Groups (list) –

              A list of comma seperated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.

              • (string) –

      • WorkteamArn (string) –

        The Amazon Resource Name (ARN) that identifies the work team.

      • WorkforceArn (string) –

        The Amazon Resource Name (ARN) of the workforce.

      • ProductListingIds (list) –

        The Amazon Marketplace identifier for a vendor’s work team.

        • (string) –

      • Description (string) –

        A description of the work team.

      • SubDomain (string) –

        The URI of the labeling job’s user interface. Workers open this URI to start labeling your data objects.

      • CreateDate (datetime) –

        The date and time that the work team was created (timestamp).

      • LastUpdatedDate (datetime) –

        The date and time that the work team was last updated (timestamp).

      • NotificationConfiguration (dict) –

        Configures SNS notifications of available or expiring work items for work teams.

        • NotificationTopicArn (string) –

          The ARN for the Amazon SNS topic to which notifications should be published.

  • NextToken (string) –

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.