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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the work team.

Returns:

  • (String)


8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8162

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

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

Returns:



8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8162

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

#notification_configurationTypes::NotificationConfiguration

Configures notification of workers regarding available or expiring work items.



8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8162

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

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

Returns:



8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8162

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

#workforce_nameString

The name of the workforce.

Returns:

  • (String)


8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8162

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

#workteam_nameString

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

Returns:

  • (String)


8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 8162

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