Skip to content

Workforce

Source code in docs_src/capo_sagemaker/types/workforce.py
class Workforce(TypedDict, closed=True):
    workforce_name: NotRequired["capo_sagemaker.types.workforce_name.WorkforceName"]
    """<p>The name of the private workforce.</p>"""
    workforce_arn: NotRequired["capo_sagemaker.types.workforce_arn.WorkforceArn"]
    """<p>The Amazon Resource Name (ARN) of the private workforce.</p>"""
    last_updated_date: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The most recent date that <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateWorkforce.html">UpdateWorkforce</a> was used to successfully add one or more IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>) to a private workforce's allow list.</p>"""
    source_ip_config: NotRequired[
        "capo_sagemaker.types.source_ip_config.SourceIpConfig"
    ]
    """<p>A list of one to ten IP address ranges (<a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html">CIDRs</a>) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.</p>"""
    sub_domain: NotRequired["capo_sagemaker.types.string.String"]
    """<p>The subdomain for your OIDC Identity Provider.</p>"""
    cognito_config: NotRequired["capo_sagemaker.types.cognito_config.CognitoConfig"]
    """<p>The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html"> Amazon Cognito user pool</a>.</p>"""
    oidc_config: NotRequired[
        "capo_sagemaker.types.oidc_config_for_response.OidcConfigForResponse"
    ]
    """<p>The configuration of an OIDC Identity Provider (IdP) private workforce.</p>"""
    create_date: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The date that the workforce is created.</p>"""
    workforce_vpc_config: NotRequired[
        "capo_sagemaker.types.workforce_vpc_config_response.WorkforceVpcConfigResponse"
    ]
    """<p>The configuration of a VPC workforce.</p>"""
    status: NotRequired["capo_sagemaker.types.workforce_status.WorkforceStatus"]
    """<p>The status of your workforce.</p>"""
    failure_reason: NotRequired[
        "capo_sagemaker.types.workforce_failure_reason.WorkforceFailureReason"
    ]
    """<p>The reason your workforce failed.</p>"""
    ip_address_type: NotRequired[
        "capo_sagemaker.types.workforce_ip_address_type.WorkforceIpAddressType"
    ]
    """<p>The IP address type you specify - either <code>IPv4</code> only or <code>dualstack</code> (<code>IPv4</code> and <code>IPv6</code>) - to support your labeling workforce.</p>"""

cognito_config instance-attribute

cognito_config: NotRequired[CognitoConfig]

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

create_date instance-attribute

create_date: NotRequired[Timestamp]

The date that the workforce is created.

failure_reason instance-attribute

failure_reason: NotRequired[WorkforceFailureReason]

The reason your workforce failed.

ip_address_type instance-attribute

ip_address_type: NotRequired[WorkforceIpAddressType]

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

last_updated_date instance-attribute

last_updated_date: NotRequired[Timestamp]

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.

oidc_config instance-attribute

oidc_config: NotRequired[OidcConfigForResponse]

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

source_ip_config instance-attribute

source_ip_config: NotRequired[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.

status instance-attribute

status: NotRequired[WorkforceStatus]

The status of your workforce.

sub_domain instance-attribute

sub_domain: NotRequired[String]

The subdomain for your OIDC Identity Provider.

workforce_arn instance-attribute

workforce_arn: NotRequired[WorkforceArn]

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

workforce_name instance-attribute

workforce_name: NotRequired[WorkforceName]

The name of the private workforce.

workforce_vpc_config instance-attribute

workforce_vpc_config: NotRequired[WorkforceVpcConfigResponse]

The configuration of a VPC workforce.