Gets a list of private work teams that you have defined in a region¶

Description¶

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.

Usage¶

sagemaker_list_workteams(SortBy, SortOrder, NameContains, NextToken,
  MaxResults)

Arguments¶

SortBy

The field to sort results by. The default is CreationTime.
SortOrder

The sort order for results. The default is Ascending.
NameContains

A string in the work team's name. This filter returns only work teams whose name contains the specified string.
NextToken

If the result of the previous list_workteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.
MaxResults

The maximum number of work teams to return in each page of the response.

Value¶

A list with the following syntax:

list(
  Workteams = list(
    list(
      WorkteamName = "string",
      MemberDefinitions = list(
        list(
          CognitoMemberDefinition = list(
            UserPool = "string",
            UserGroup = "string",
            ClientId = "string"
          ),
          OidcMemberDefinition = list(
            Groups = list(
              "string"
            )
          )
        )
      ),
      WorkteamArn = "string",
      WorkforceArn = "string",
      ProductListingIds = list(
        "string"
      ),
      Description = "string",
      SubDomain = "string",
      CreateDate = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedDate = as.POSIXct(
        "2015-01-01"
      ),
      NotificationConfiguration = list(
        NotificationTopicArn = "string"
      ),
      WorkerAccessConfiguration = list(
        S3Presign = list(
          IamPolicyConstraints = list(
            SourceIp = "Enabled"|"Disabled",
            VpcSourceIp = "Enabled"|"Disabled"
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_workteams(
  SortBy = "Name"|"CreateDate",
  SortOrder = "Ascending"|"Descending",
  NameContains = "string",
  NextToken = "string",
  MaxResults = 123
)