Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeWorkteam

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

Request Syntax


{
   "WorkteamName": "string"
}

Request Parameters

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]){0,62}

Required: Yes

Response Syntax


{
   "Workteam": { 
      "CreateDate": number,
      "Description": "string",
      "LastUpdatedDate": number,
      "MemberDefinitions": [ 
         { 
            "CognitoMemberDefinition": { 
               "ClientId": "string",
               "UserGroup": "string",
               "UserPool": "string"
            },
            "OidcMemberDefinition": { 
               "Groups": [ "string" ]
            }
         }
      ],
      "NotificationConfiguration": { 
         "NotificationTopicArn": "string"
      },
      "ProductListingIds": [ "string" ],
      "SubDomain": "string",
      "WorkerAccessConfiguration": { 
         "S3Presign": { 
            "IamPolicyConstraints": { 
               "SourceIp": "string",
               "VpcSourceIp": "string"
            }
         }
      },
      "WorkforceArn": "string",
      "WorkteamArn": "string",
      "WorkteamName": "string"
   }
}

Response Elements

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

Errors

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