Class: Aws::SageMaker::Types::UpdateWorkteamRequest

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::UpdateWorkteamRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  An updated description for the work team.

• #member_definitions ⇒ Array<Types::MemberDefinition>

  A list of ‘MemberDefinition` objects that contains objects that identify the workers that make up the work team.

• #notification_configuration ⇒ Types::NotificationConfiguration

  Configures SNS topic notifications for available or expiring work items.

• #worker_access_configuration ⇒ Types::WorkerAccessConfiguration

  Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys.

• #workteam_name ⇒ String

  The name of the work team to update.

Instance Attribute Details

#description ⇒ String

An updated description for the work team.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 46971

class UpdateWorkteamRequest < Struct.new(
  :workteam_name,
  :member_definitions,
  :description,
  :notification_configuration,
  :worker_access_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#member_definitions ⇒ Array<Types::MemberDefinition>

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`. You should not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito *user groups* within the user pool used to create a workforce. All of the ‘CognitoMemberDefinition` objects that make up the member definition must have the same `ClientId` and `UserPool` values. To add a Amazon Cognito user group to an existing worker pool, see [Adding groups to a User Pool](). For more information about user pools, see [Amazon Cognito User Pools].

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in ‘OidcMemberDefinition` by listing those groups in `Groups`. Be aware that user groups that are already in the work team must also be listed in `Groups` when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html

Returns:

• (Array<Types::MemberDefinition>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 46971

class UpdateWorkteamRequest < Struct.new(
  :workteam_name,
  :member_definitions,
  :description,
  :notification_configuration,
  :worker_access_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#notification_configuration ⇒ Types::NotificationConfiguration

Configures SNS topic notifications for available or expiring work items

Returns:

• (Types::NotificationConfiguration)

# File 'lib/aws-sdk-sagemaker/types.rb', line 46971

class UpdateWorkteamRequest < Struct.new(
  :workteam_name,
  :member_definitions,
  :description,
  :notification_configuration,
  :worker_access_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#worker_access_configuration ⇒ Types::WorkerAccessConfiguration

Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.

Returns:

• (Types::WorkerAccessConfiguration)

# File 'lib/aws-sdk-sagemaker/types.rb', line 46971

class UpdateWorkteamRequest < Struct.new(
  :workteam_name,
  :member_definitions,
  :description,
  :notification_configuration,
  :worker_access_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#workteam_name ⇒ String

The name of the work team to update.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 46971

class UpdateWorkteamRequest < Struct.new(
  :workteam_name,
  :member_definitions,
  :description,
  :notification_configuration,
  :worker_access_configuration)
  SENSITIVE = []
  include Aws::Structure
end