AWS Tools for Windows PowerShell
Command 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.

Synopsis

Calls the Amazon SageMaker Service CreateWorkforce API operation.

Syntax

New-SMWorkforce
-WorkforceName <String>
-OidcConfig_AuthorizationEndpoint <String>
-SourceIpConfig_Cidr <String[]>
-CognitoConfig_ClientId <String>
-OidcConfig_ClientId <String>
-OidcConfig_ClientSecret <String>
-OidcConfig_Issuer <String>
-OidcConfig_JwksUri <String>
-OidcConfig_LogoutEndpoint <String>
-WorkforceVpcConfig_SecurityGroupId <String[]>
-WorkforceVpcConfig_Subnet <String[]>
-Tag <Tag[]>
-OidcConfig_TokenEndpoint <String>
-OidcConfig_UserInfoEndpoint <String>
-CognitoConfig_UserPool <String>
-WorkforceVpcConfig_VpcId <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

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

Parameters

-CognitoConfig_ClientId <String>
The client ID for your Amazon Cognito user pool.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CognitoConfig_UserPool <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OidcConfig_AuthorizationEndpoint <String>
The OIDC IdP authorization endpoint used to configure your private workforce.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OidcConfig_ClientId <String>
The OIDC IdP client ID used to configure your private workforce.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OidcConfig_ClientSecret <String>
The OIDC IdP client secret used to configure your private workforce.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OidcConfig_Issuer <String>
The OIDC IdP issuer used to configure your private workforce.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OidcConfig_JwksUri <String>
The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OidcConfig_LogoutEndpoint <String>
The OIDC IdP logout endpoint used to configure your private workforce.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OidcConfig_TokenEndpoint <String>
The OIDC IdP token endpoint used to configure your private workforce.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OidcConfig_UserInfoEndpoint <String>
The OIDC IdP user information endpoint used to configure your private workforce.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the WorkforceName parameter. The -PassThru parameter is deprecated, use -Select '^WorkforceName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'WorkforceArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateWorkforceResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateWorkforceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceIpConfig_Cidr <String[]>
A list of one to ten Classless Inter-Domain Routing (CIDR) values.Maximum: Ten CIDR valuesThe following Length Constraints apply to individual CIDR values in the CIDR value list.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceIpConfig_Cidrs
-Tag <Tag[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-WorkforceName <String>
The name of the private workforce.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-WorkforceVpcConfig_SecurityGroupId <String[]>
The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWorkforceVpcConfig_SecurityGroupIds
-WorkforceVpcConfig_Subnet <String[]>
The ID of the subnets in the VPC that you want to connect.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesWorkforceVpcConfig_Subnets
-WorkforceVpcConfig_VpcId <String>
The ID of the VPC that the workforce uses for communication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.SageMaker.Model.CreateWorkforceResponse
This cmdlet returns a System.String object. The service call response (type Amazon.SageMaker.Model.CreateWorkforceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z