class Aws::SageMaker::Types::CreateWorkteamRequest
@note When making an API call, you may pass CreateWorkteamRequest
data as a 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 }, ], }
@!attribute [rw] workteam_name
The name of the work team. Use this name to identify the work team. @return [String]
@!attribute [rw] workforce_name
The name of the workforce. @return [String]
@!attribute [rw] member_definitions
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][1]. 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]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html @return [Array<Types::MemberDefinition>]
@!attribute [rw] description
A description of the work team. @return [String]
@!attribute [rw] notification_configuration
Configures notification of workers regarding available or expiring work items. @return [Types::NotificationConfiguration]
@!attribute [rw] tags
An array of key-value pairs. For more information, see [Resource Tag][1] and [Using Cost Allocation Tags][2] in the <i> Amazon Web Services Billing and Cost Management User Guide</i>. [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html [2]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what @return [Array<Types::Tag>]
@see docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateWorkteamRequest AWS API Documentation
Constants
- SENSITIVE