SageMaker / Client / create_workforce

create_workforce#

SageMaker.Client.create_workforce(**kwargs)#

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).

Request Syntax

response = client.create_workforce(
    CognitoConfig={
        'UserPool': 'string',
        'ClientId': 'string'
    },
    OidcConfig={
        'ClientId': 'string',
        'ClientSecret': 'string',
        'Issuer': 'string',
        'AuthorizationEndpoint': 'string',
        'TokenEndpoint': 'string',
        'UserInfoEndpoint': 'string',
        'LogoutEndpoint': 'string',
        'JwksUri': 'string',
        'Scope': 'string',
        'AuthenticationRequestExtraParams': {
            'string': 'string'
        }
    },
    SourceIpConfig={
        'Cidrs': [
            'string',
        ]
    },
    WorkforceName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    WorkforceVpcConfig={
        'VpcId': 'string',
        'SecurityGroupIds': [
            'string',
        ],
        'Subnets': [
            'string',
        ]
    }
)

Parameters:

CognitoConfig (dict) –
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.
- UserPool (string) – [REQUIRED]
  
  A user pool is a user directory in Amazon Cognito. With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. Your users can also sign in through social identity providers like Google, Facebook, Amazon, or Apple, and through SAML identity providers.
- ClientId (string) – [REQUIRED]
  
  The client ID for your Amazon Cognito user pool.
OidcConfig (dict) –
Use this parameter to configure a private workforce using your own OIDC Identity Provider.

Do not use CognitoConfig if you specify values for OidcConfig.
- ClientId (string) – [REQUIRED]
  
  The OIDC IdP client ID used to configure your private workforce.
- ClientSecret (string) – [REQUIRED]
  
  The OIDC IdP client secret used to configure your private workforce.
- Issuer (string) – [REQUIRED]
  
  The OIDC IdP issuer used to configure your private workforce.
- AuthorizationEndpoint (string) – [REQUIRED]
  
  The OIDC IdP authorization endpoint used to configure your private workforce.
- TokenEndpoint (string) – [REQUIRED]
  
  The OIDC IdP token endpoint used to configure your private workforce.
- UserInfoEndpoint (string) – [REQUIRED]
  
  The OIDC IdP user information endpoint used to configure your private workforce.
- LogoutEndpoint (string) – [REQUIRED]
  
  The OIDC IdP logout endpoint used to configure your private workforce.
- JwksUri (string) – [REQUIRED]
  
  The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
- Scope (string) –
  
  An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
- AuthenticationRequestExtraParams (dict) –
  
  A string to string map of identifiers specific to the custom identity provider (IdP) being used.
  - (string) –
    - (string) –
SourceIpConfig (dict) –
A list of IP address ranges ( CIDRs). Used to create an allow list of IP addresses for a private workforce. Workers will only be able to log in to their worker portal from an IP address within this range. By default, a workforce isn’t restricted to specific IP addresses.
- Cidrs (list) – [REQUIRED]
  
  A list of one to ten Classless Inter-Domain Routing (CIDR) values.
  
  Maximum: Ten CIDR values
  
  Note
  The following Length Constraints apply to individual CIDR values in the CIDR value list.
  - (string) –
WorkforceName (string) –
[REQUIRED]

The name of the private workforce.
Tags (list) –
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.
- (dict) –
  
  A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.
  
  You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags.
  
  For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources. For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy.
  - Key (string) – [REQUIRED]
    
    The tag key. Tag keys must be unique per resource.
  - Value (string) – [REQUIRED]
    
    The tag value.
WorkforceVpcConfig (dict) –
Use this parameter to configure a workforce using VPC.
- VpcId (string) –
  
  The ID of the VPC that the workforce uses for communication.
- SecurityGroupIds (list) –
  
  The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
  - (string) –
- Subnets (list) –
  
  The ID of the subnets in the VPC that you want to connect.
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'WorkforceArn': 'string'
}

Response Structure

(dict) –
- WorkforceArn (string) –
  
  The Amazon Resource Name (ARN) of the workforce.