[ aws . sagemaker ]

describe-workteam

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-workteam
--workteam-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--workteam-name (string)

The name of the work team to return a description of.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Workteam -> (structure)

A Workteam instance that contains information about the 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 .

(structure)

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

CognitoMemberDefinition -> (structure)

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 -> (structure)

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 -> (timestamp)

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

LastUpdatedDate -> (timestamp)

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

NotificationConfiguration -> (structure)

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.