Skip to content

CreateWorkforceRequest

Source code in docs_src/capo_sagemaker/types/create_workforce_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class CreateWorkforceRequest(TypedDict, closed=True):
    cognito_config: NotRequired["capo_sagemaker.types.cognito_config.CognitoConfig"]
    """<p>Use this parameter to configure an Amazon Cognito private 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> <p>Do not use <code>OidcConfig</code> if you specify values for <code>CognitoConfig</code>.</p>"""
    oidc_config: NotRequired["capo_sagemaker.types.oidc_config.OidcConfig"]
    """<p>Use this parameter to configure a private workforce using your own OIDC Identity Provider.</p> <p>Do not use <code>CognitoConfig</code> if you specify values for <code>OidcConfig</code>.</p>"""
    source_ip_config: NotRequired[
        "capo_sagemaker.types.source_ip_config.SourceIpConfig"
    ]
    workforce_name: NotRequired["capo_sagemaker.types.workforce_name.WorkforceName"]
    """<p>The name of the private workforce.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>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.</p>"""
    workforce_vpc_config: NotRequired[
        "capo_sagemaker.types.workforce_vpc_config_request.WorkforceVpcConfigRequest"
    ]
    """<p>Use this parameter to configure a workforce using VPC.</p>"""
    ip_address_type: NotRequired[
        "capo_sagemaker.types.workforce_ip_address_type.WorkforceIpAddressType"
    ]
    """<p>Use this parameter to specify whether you want <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]

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.

ip_address_type instance-attribute 

ip_address_type: NotRequired[WorkforceIpAddressType]

Use this parameter to specify whether you want IPv4 only or dualstack (IPv4 and IPv6) to support your labeling workforce.

oidc_config instance-attribute 

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

source_ip_config instance-attribute 

source_ip_config: NotRequired[SourceIpConfig]

tags instance-attribute 

tags: NotRequired[TagList]

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.

workforce_name instance-attribute 

workforce_name: NotRequired[WorkforceName]

The name of the private workforce.

workforce_vpc_config instance-attribute 

workforce_vpc_config: NotRequired[WorkforceVpcConfigRequest]

Use this parameter to configure a workforce using VPC.