You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass CreateWorkteamRequest data as a hash:

{
  workteam_name: "WorkteamName", # required
  member_definitions: [ # required
    {
      cognito_member_definition: {
        user_pool: "CognitoUserPool", # required
        user_group: "CognitoUserGroup", # required
        client_id: "CognitoClientId", # required
      },
    },
  ],
  description: "String200", # required
  notification_configuration: {
    notification_topic_arn: "NotificationTopicArn",
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the work team.

Returns:

  • (String)


3170
3171
3172
3173
3174
3175
3176
3177
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3170

class CreateWorkteamRequest < Struct.new(
  :workteam_name,
  :member_definitions,
  :description,
  :notification_configuration,
  :tags)
  include Aws::Structure
end

#member_definitionsArray<Types::MemberDefinition>

A list of MemberDefinition objects that contains objects that identify the Amazon Cognito user pool that makes up the work team. For more information, see Amazon Cognito User Pools.

All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values.

Returns:



3170
3171
3172
3173
3174
3175
3176
3177
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3170

class CreateWorkteamRequest < Struct.new(
  :workteam_name,
  :member_definitions,
  :description,
  :notification_configuration,
  :tags)
  include Aws::Structure
end

#notification_configurationTypes::NotificationConfiguration

Configures notification of workers regarding available or expiring work items.



3170
3171
3172
3173
3174
3175
3176
3177
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3170

class CreateWorkteamRequest < Struct.new(
  :workteam_name,
  :member_definitions,
  :description,
  :notification_configuration,
  :tags)
  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 AWS Billing and Cost Management User Guide.

Returns:



3170
3171
3172
3173
3174
3175
3176
3177
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3170

class CreateWorkteamRequest < Struct.new(
  :workteam_name,
  :member_definitions,
  :description,
  :notification_configuration,
  :tags)
  include Aws::Structure
end

#workteam_nameString

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

Returns:

  • (String)


3170
3171
3172
3173
3174
3175
3176
3177
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/types.rb', line 3170

class CreateWorkteamRequest < Struct.new(
  :workteam_name,
  :member_definitions,
  :description,
  :notification_configuration,
  :tags)
  include Aws::Structure
end