Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . sagemaker ]

update-workteam

Description

Updates an existing work team with new member definitions or description.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-workteam
--workteam-name <value>
[--member-definitions <value>]
[--description <value>]
[--notification-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--workteam-name (string)

The name of the work team to update.

--member-definitions (list)

A list of MemberDefinition objects that contain the updated work team members.

Shorthand Syntax:

CognitoMemberDefinition={UserPool=string,UserGroup=string,ClientId=string} ...

JSON Syntax:

[
  {
    "CognitoMemberDefinition": {
      "UserPool": "string",
      "UserGroup": "string",
      "ClientId": "string"
    }
  }
  ...
]

--description (string)

An updated description for the work team.

--notification-configuration (structure)

Configures SNS topic notifications for available or expiring work items

Shorthand Syntax:

NotificationTopicArn=string

JSON Syntax:

{
  "NotificationTopicArn": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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 object that describes the updated work team.

WorkteamName -> (string)

The name of the work team.

MemberDefinitions -> (list)

The Amazon Cognito user groups that make up the work team.

(structure)

Defines the Amazon Cognito 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.

WorkteamArn -> (string)

The Amazon Resource Name (ARN) that identifies the work team.

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 SNS topic to which notifications should be published.