Skip to content

Describe Workteam

sagemaker_describe_workteam R Documentation

Gets information about a specific work team

Description

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).

Usage

sagemaker_describe_workteam(WorkteamName)

Arguments

WorkteamName

[required] The name of the work team to return a description of.

Value

A list with the following syntax:

list(
  Workteam = 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"
        )
      )
    )
  )
)

Request syntax

svc$describe_workteam(
  WorkteamName = "string"
)