Class: Aws::SageMaker::Types::CreateWorkteamRequest

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::CreateWorkteamRequest

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

  A description of 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 notification of workers regarding available or expiring work items.

• #tags ⇒ Array<Types::Tag>

  An array of key-value pairs.

• #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.

• #workforce_name ⇒ String

  The name of the workforce.

• #workteam_name ⇒ String

  The name of the work team.

Instance Attribute Details

#description ⇒ String

A description of the work team.

Returns:

• (String)

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

class CreateWorkteamRequest < Struct.new(
  :workteam_name,
  :workforce_name,
  :member_definitions,
  :description,
  :notification_configuration,
  :worker_access_configuration,
  :tags)
  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`. Do 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`.

[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 10905

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

#notification_configuration ⇒ Types::NotificationConfiguration

Configures notification of workers regarding available or expiring work items.

Returns:

• (Types::NotificationConfiguration)

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

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

#tags ⇒ Array<Types::Tag>

An array of key-value pairs.

For more information, see [Resource Tag] and [Using Cost Allocation Tags] in the Amazon Web Services Billing and Cost Management User Guide.

[1]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html [2]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what

Returns:

• (Array<Types::Tag>)

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

class CreateWorkteamRequest < Struct.new(
  :workteam_name,
  :workforce_name,
  :member_definitions,
  :description,
  :notification_configuration,
  :worker_access_configuration,
  :tags)
  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 10905

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

#workforce_name ⇒ String

The name of the workforce.

Returns:

• (String)

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

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

#workteam_name ⇒ String

The name of the work team. Use this name to identify the work team.

Returns:

• (String)

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

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