Workforce

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each AWS Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

WorkforceArn

The Amazon Resource Name (ARN) of the private workforce.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:workforce/.*

Required: Yes

WorkforceName

The name of the private workforce.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [a-zA-Z0-9]([a-zA-Z0-9\-]){0,62}

Required: Yes

CognitoConfig

The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Type: CognitoConfig object

Required: No

CreateDate

The date that the workforce is created.

Type: Timestamp

Required: No

FailureReason

The reason your workforce failed.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .+

Required: No

IpAddressType

The IP address type you specify - either IPv4 only or dualstack (IPv4 and IPv6) - to support your labeling workforce.

Type: String

Valid Values: ipv4 | dualstack

Required: No

LastUpdatedDate

The most recent date that UpdateWorkforce was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.

Type: Timestamp

Required: No

OidcConfig

The configuration of an OIDC Identity Provider (IdP) private workforce.

Type: OidcConfigForResponse object

Required: No

SourceIpConfig

A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.

Type: SourceIpConfig object

Required: No

Status

The status of your workforce.

Type: String

Valid Values: Initializing | Updating | Deleting | Failed | Active

Required: No

SubDomain

The subdomain for your OIDC Identity Provider.

Type: String

Required: No

WorkforceVpcConfig

The configuration of a VPC workforce.

Type: WorkforceVpcConfigResponse object

Required: No

Workforce

Contents

See Also