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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateWorkteamRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A description of the work team.

Returns:

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

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:

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

Returns:

#tags ⇒ Array<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:

  • (Array<Types::Tag>) —

    An array of key-value pairs.

#workforce_name ⇒ String

The name of the workforce.

Returns:

  • (String) —

    The name of the workforce.

#workteam_name ⇒ String

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

Returns:

  • (String) —

    The name of the work team.