AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateWorkforce operation. Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the DeleteWorkforce API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SageMaker.AmazonSageMakerRequest
      Amazon.SageMaker.Model.CreateWorkforceRequest

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C#
public class CreateWorkforceRequest : AmazonSageMakerRequest
         IAmazonWebServiceRequest

The CreateWorkforceRequest type exposes the following members

Constructors

NameDescription
Public Method CreateWorkforceRequest()

Properties

NameTypeDescription
Public Property CognitoConfig Amazon.SageMaker.Model.CognitoConfig

Gets and sets the property CognitoConfig.

Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Do not use OidcConfig if you specify values for CognitoConfig.

Public Property OidcConfig Amazon.SageMaker.Model.OidcConfig

Gets and sets the property OidcConfig.

Use this parameter to configure a private workforce using your own OIDC Identity Provider.

Do not use CognitoConfig if you specify values for OidcConfig.

Public Property SourceIpConfig Amazon.SageMaker.Model.SourceIpConfig

Gets and sets the property SourceIpConfig.

Public Property Tags System.Collections.Generic.List<Amazon.SageMaker.Model.Tag>

Gets and sets the property Tags.

An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.

Public Property WorkforceName System.String

Gets and sets the property WorkforceName.

The name of the private workforce.

Public Property WorkforceVpcConfig Amazon.SageMaker.Model.WorkforceVpcConfigRequest

Gets and sets the property WorkforceVpcConfig.

Use this parameter to configure a workforce using VPC.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5