Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: CC-BY-SA-4.0

DescribeWorkteam

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

{
   "[WorkteamName](#SageMaker-DescribeWorkteam-request-WorkteamName)": "string"
}

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

** WorkteamName ** The name of the work team to return a description of.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
Required: Yes

{
   "[Workteam](#SageMaker-DescribeWorkteam-response-Workteam)": { 
      "[CreateDate](API_Workteam.md#SageMaker-Type-Workteam-CreateDate)": number,
      "[Description](API_Workteam.md#SageMaker-Type-Workteam-Description)": "string",
      "[LastUpdatedDate](API_Workteam.md#SageMaker-Type-Workteam-LastUpdatedDate)": number,
      "[MemberDefinitions](API_Workteam.md#SageMaker-Type-Workteam-MemberDefinitions)": [ 
         { 
            "[CognitoMemberDefinition](API_MemberDefinition.md#SageMaker-Type-MemberDefinition-CognitoMemberDefinition)": { 
               "[ClientId](API_CognitoMemberDefinition.md#SageMaker-Type-CognitoMemberDefinition-ClientId)": "string",
               "[UserGroup](API_CognitoMemberDefinition.md#SageMaker-Type-CognitoMemberDefinition-UserGroup)": "string",
               "[UserPool](API_CognitoMemberDefinition.md#SageMaker-Type-CognitoMemberDefinition-UserPool)": "string"
            }
         }
      ],
      "[NotificationConfiguration](API_Workteam.md#SageMaker-Type-Workteam-NotificationConfiguration)": { 
         "[NotificationTopicArn](API_NotificationConfiguration.md#SageMaker-Type-NotificationConfiguration-NotificationTopicArn)": "string"
      },
      "[ProductListingIds](API_Workteam.md#SageMaker-Type-Workteam-ProductListingIds)": [ "string" ],
      "[SubDomain](API_Workteam.md#SageMaker-Type-Workteam-SubDomain)": "string",
      "[WorkteamArn](API_Workteam.md#SageMaker-Type-Workteam-WorkteamArn)": "string",
      "[WorkteamName](API_Workteam.md#SageMaker-Type-Workteam-WorkteamName)": "string"
   }
}

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

** Workteam ** A Workteam instance that contains information about the work team.
Type: Workteam object

For information about the errors that are common to all actions, see Common Errors.

For more information about using this API in one of the language-specific AWS SDKs, see the following: + AWS Command Line Interface + AWS SDK for .NET + AWS SDK for C++ + AWS SDK for Go + AWS SDK for Go - Pilot + AWS SDK for Java + AWS SDK for JavaScript + AWS SDK for PHP V3 + AWS SDK for Python + AWS SDK for Ruby V2