/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the sagemaker-2017-07-24.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.SageMaker.Model
{
///
/// Container for the parameters to the CreateWorkteam operation.
/// Creates a new work team for labeling your data. A work team is defined by one or more
/// Amazon Cognito user pools. You must first create the user pools before you can create
/// a work team.
///
///
///
/// You cannot create more than 25 work teams in an account and region.
///
///
public partial class CreateWorkteamRequest : AmazonSageMakerRequest
{
private string _description;
private List _memberDefinitions = new List();
private NotificationConfiguration _notificationConfiguration;
private List _tags = new List();
private string _workforceName;
private string _workteamName;
///
/// Gets and sets the property Description.
///
/// A description of the work team.
///
///
[AWSProperty(Required=true, Min=1, Max=200)]
public string Description
{
get { return this._description; }
set { this._description = value; }
}
// Check to see if Description property is set
internal bool IsSetDescription()
{
return this._description != null;
}
///
/// Gets and sets the property MemberDefinitions.
///
/// 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
.
///
///
[AWSProperty(Required=true, Min=1, Max=10)]
public List MemberDefinitions
{
get { return this._memberDefinitions; }
set { this._memberDefinitions = value; }
}
// Check to see if MemberDefinitions property is set
internal bool IsSetMemberDefinitions()
{
return this._memberDefinitions != null && this._memberDefinitions.Count > 0;
}
///
/// Gets and sets the property NotificationConfiguration.
///
/// Configures notification of workers regarding available or expiring work items.
///
///
public NotificationConfiguration NotificationConfiguration
{
get { return this._notificationConfiguration; }
set { this._notificationConfiguration = value; }
}
// Check to see if NotificationConfiguration property is set
internal bool IsSetNotificationConfiguration()
{
return this._notificationConfiguration != null;
}
///
/// Gets and sets the property Tags.
///
/// 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.
///
///
[AWSProperty(Min=0, Max=50)]
public List Tags
{
get { return this._tags; }
set { this._tags = value; }
}
// Check to see if Tags property is set
internal bool IsSetTags()
{
return this._tags != null && this._tags.Count > 0;
}
///
/// Gets and sets the property WorkforceName.
///
/// The name of the workforce.
///
///
[AWSProperty(Min=1, Max=63)]
public string WorkforceName
{
get { return this._workforceName; }
set { this._workforceName = value; }
}
// Check to see if WorkforceName property is set
internal bool IsSetWorkforceName()
{
return this._workforceName != null;
}
///
/// Gets and sets the property WorkteamName.
///
/// The name of the work team. Use this name to identify the work team.
///
///
[AWSProperty(Required=true, Min=1, Max=63)]
public string WorkteamName
{
get { return this._workteamName; }
set { this._workteamName = value; }
}
// Check to see if WorkteamName property is set
internal bool IsSetWorkteamName()
{
return this._workteamName != null;
}
}
}