Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. sagemaker
  6. getWorkforce

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.75.0
published on Monday, Aug 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.sagemaker.getWorkforce

aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.75.0
published on Monday, Aug 17, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SageMaker::Workforce. Use to create a private workforce that you can use to label your training data using Amazon SageMaker Ground Truth.

    Using getWorkforce

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWorkforce(args: GetWorkforceArgs, opts?: InvokeOptions): Promise<GetWorkforceResult>
function getWorkforceOutput(args: GetWorkforceOutputArgs, opts?: InvokeOutputOptions): Output<GetWorkforceResult>
    def get_workforce(workforce_arn: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetWorkforceResult
def get_workforce_output(workforce_arn: pulumi.Input[Optional[str]] = None,
                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetWorkforceResult]
    func LookupWorkforce(ctx *Context, args *LookupWorkforceArgs, opts ...InvokeOption) (*LookupWorkforceResult, error)
func LookupWorkforceOutput(ctx *Context, args *LookupWorkforceOutputArgs, opts ...InvokeOption) LookupWorkforceResultOutput

    > Note: This function is named LookupWorkforce in the Go SDK.

    public static class GetWorkforce 
{
    public static Task<GetWorkforceResult> InvokeAsync(GetWorkforceArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkforceResult> Invoke(GetWorkforceInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkforceResult> Invoke(GetWorkforceInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetWorkforceResult> getWorkforce(GetWorkforceArgs args, InvokeOptions options)
public static Output<GetWorkforceResult> getWorkforce(GetWorkforceArgs args, InvokeOptions options)
public static Output<GetWorkforceResult> getWorkforce(GetWorkforceArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:sagemaker:getWorkforce
  arguments:
    # arguments dictionary
    data "aws-native_sagemaker_get_workforce" "name" {
    # arguments
}

    The following arguments are supported:

    WorkforceArn string
    The Amazon Resource Name (ARN) of the private workforce.
    WorkforceArn string
    The Amazon Resource Name (ARN) of the private workforce.
    workforce_arn string
    The Amazon Resource Name (ARN) of the private workforce.
    workforceArn String
    The Amazon Resource Name (ARN) of the private workforce.
    workforceArn string
    The Amazon Resource Name (ARN) of the private workforce.
    workforce_arn str
    The Amazon Resource Name (ARN) of the private workforce.
    workforceArn String
    The Amazon Resource Name (ARN) of the private workforce.

    getWorkforce Result

    The following output properties are available:

    IpAddressType Pulumi.AwsNative.SageMaker.WorkforceIpAddressType
    The IP address type for the workforce. IPv4 only or dualstack (IPv4 and IPv6).
    OidcConfig Pulumi.AwsNative.SageMaker.Outputs.WorkforceOidcConfig
    SourceIpConfig Pulumi.AwsNative.SageMaker.Outputs.WorkforceSourceIpConfig
    SubDomain string
    The subdomain for your OIDC Identity Provider.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs.
    WorkforceArn string
    The Amazon Resource Name (ARN) of the private workforce.
    WorkforceVpcConfig Pulumi.AwsNative.SageMaker.Outputs.WorkforceVpcConfigRequest
    IpAddressType WorkforceIpAddressType
    The IP address type for the workforce. IPv4 only or dualstack (IPv4 and IPv6).
    OidcConfig WorkforceOidcConfig
    SourceIpConfig WorkforceSourceIpConfig
    SubDomain string
    The subdomain for your OIDC Identity Provider.
    Tags Tag
    An array of key-value pairs.
    WorkforceArn string
    The Amazon Resource Name (ARN) of the private workforce.
    WorkforceVpcConfig WorkforceVpcConfigRequest
    ip_address_type "ipv4" | "dualstack"
    The IP address type for the workforce. IPv4 only or dualstack (IPv4 and IPv6).
    oidc_config object
    source_ip_config object
    sub_domain string
    The subdomain for your OIDC Identity Provider.
    tags list(object)
    An array of key-value pairs.
    workforce_arn string
    The Amazon Resource Name (ARN) of the private workforce.
    workforce_vpc_config object
    ipAddressType WorkforceIpAddressType
    The IP address type for the workforce. IPv4 only or dualstack (IPv4 and IPv6).
    oidcConfig WorkforceOidcConfig
    sourceIpConfig WorkforceSourceIpConfig
    subDomain String
    The subdomain for your OIDC Identity Provider.
    tags List<Tag>
    An array of key-value pairs.
    workforceArn String
    The Amazon Resource Name (ARN) of the private workforce.
    workforceVpcConfig WorkforceVpcConfigRequest
    ipAddressType WorkforceIpAddressType
    The IP address type for the workforce. IPv4 only or dualstack (IPv4 and IPv6).
    oidcConfig WorkforceOidcConfig
    sourceIpConfig WorkforceSourceIpConfig
    subDomain string
    The subdomain for your OIDC Identity Provider.
    tags Tag[]
    An array of key-value pairs.
    workforceArn string
    The Amazon Resource Name (ARN) of the private workforce.
    workforceVpcConfig WorkforceVpcConfigRequest
    ip_address_type WorkforceIpAddressType
    The IP address type for the workforce. IPv4 only or dualstack (IPv4 and IPv6).
    oidc_config WorkforceOidcConfig
    source_ip_config WorkforceSourceIpConfig
    sub_domain str
    The subdomain for your OIDC Identity Provider.
    tags Sequence[root_Tag]
    An array of key-value pairs.
    workforce_arn str
    The Amazon Resource Name (ARN) of the private workforce.
    workforce_vpc_config WorkforceVpcConfigRequest
    ipAddressType "ipv4" | "dualstack"
    The IP address type for the workforce. IPv4 only or dualstack (IPv4 and IPv6).
    oidcConfig Property Map
    sourceIpConfig Property Map
    subDomain String
    The subdomain for your OIDC Identity Provider.
    tags List<Property Map>
    An array of key-value pairs.
    workforceArn String
    The Amazon Resource Name (ARN) of the private workforce.
    workforceVpcConfig Property Map

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    WorkforceIpAddressType

    WorkforceOidcConfig

    AuthorizationEndpoint string
    The OIDC IdP authorization endpoint used to configure your private workforce.
    ClientId string
    The OIDC IdP client ID used to configure your private workforce.
    Issuer string
    The OIDC IdP issuer used to configure your private workforce.
    JwksUri string
    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
    LogoutEndpoint string
    The OIDC IdP logout endpoint used to configure your private workforce.
    TokenEndpoint string
    The OIDC IdP token endpoint used to configure your private workforce.
    UserInfoEndpoint string
    The OIDC IdP user info endpoint used to configure your private workforce.
    AuthenticationRequestExtraParams Dictionary<string, string>
    A string to string map of identifiers specific to the custom identity provider (IdP) being used.
    ClientSecret string
    The OIDC IdP client secret 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.
    AuthorizationEndpoint string
    The OIDC IdP authorization endpoint used to configure your private workforce.
    ClientId string
    The OIDC IdP client ID used to configure your private workforce.
    Issuer string
    The OIDC IdP issuer used to configure your private workforce.
    JwksUri string
    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
    LogoutEndpoint string
    The OIDC IdP logout endpoint used to configure your private workforce.
    TokenEndpoint string
    The OIDC IdP token endpoint used to configure your private workforce.
    UserInfoEndpoint string
    The OIDC IdP user info endpoint used to configure your private workforce.
    AuthenticationRequestExtraParams map[string]string
    A string to string map of identifiers specific to the custom identity provider (IdP) being used.
    ClientSecret string
    The OIDC IdP client secret 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.
    authorization_endpoint string
    The OIDC IdP authorization endpoint used to configure your private workforce.
    client_id string
    The OIDC IdP client ID used to configure your private workforce.
    issuer string
    The OIDC IdP issuer used to configure your private workforce.
    jwks_uri string
    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
    logout_endpoint string
    The OIDC IdP logout endpoint used to configure your private workforce.
    token_endpoint string
    The OIDC IdP token endpoint used to configure your private workforce.
    user_info_endpoint string
    The OIDC IdP user info endpoint used to configure your private workforce.
    authentication_request_extra_params map(string)
    A string to string map of identifiers specific to the custom identity provider (IdP) being used.
    client_secret string
    The OIDC IdP client secret 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.
    authorizationEndpoint String
    The OIDC IdP authorization endpoint used to configure your private workforce.
    clientId String
    The OIDC IdP client ID used to configure your private workforce.
    issuer String
    The OIDC IdP issuer used to configure your private workforce.
    jwksUri String
    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
    logoutEndpoint String
    The OIDC IdP logout endpoint used to configure your private workforce.
    tokenEndpoint String
    The OIDC IdP token endpoint used to configure your private workforce.
    userInfoEndpoint String
    The OIDC IdP user info endpoint used to configure your private workforce.
    authenticationRequestExtraParams Map<String,String>
    A string to string map of identifiers specific to the custom identity provider (IdP) being used.
    clientSecret String
    The OIDC IdP client secret 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.
    authorizationEndpoint string
    The OIDC IdP authorization endpoint used to configure your private workforce.
    clientId string
    The OIDC IdP client ID used to configure your private workforce.
    issuer string
    The OIDC IdP issuer used to configure your private workforce.
    jwksUri string
    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
    logoutEndpoint string
    The OIDC IdP logout endpoint used to configure your private workforce.
    tokenEndpoint string
    The OIDC IdP token endpoint used to configure your private workforce.
    userInfoEndpoint string
    The OIDC IdP user info endpoint used to configure your private workforce.
    authenticationRequestExtraParams {[key: string]: string}
    A string to string map of identifiers specific to the custom identity provider (IdP) being used.
    clientSecret string
    The OIDC IdP client secret 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.
    authorization_endpoint str
    The OIDC IdP authorization endpoint used to configure your private workforce.
    client_id str
    The OIDC IdP client ID used to configure your private workforce.
    issuer str
    The OIDC IdP issuer used to configure your private workforce.
    jwks_uri str
    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
    logout_endpoint str
    The OIDC IdP logout endpoint used to configure your private workforce.
    token_endpoint str
    The OIDC IdP token endpoint used to configure your private workforce.
    user_info_endpoint str
    The OIDC IdP user info endpoint used to configure your private workforce.
    authentication_request_extra_params Mapping[str, str]
    A string to string map of identifiers specific to the custom identity provider (IdP) being used.
    client_secret str
    The OIDC IdP client secret used to configure your private workforce.
    scope str
    An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.
    authorizationEndpoint String
    The OIDC IdP authorization endpoint used to configure your private workforce.
    clientId String
    The OIDC IdP client ID used to configure your private workforce.
    issuer String
    The OIDC IdP issuer used to configure your private workforce.
    jwksUri String
    The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.
    logoutEndpoint String
    The OIDC IdP logout endpoint used to configure your private workforce.
    tokenEndpoint String
    The OIDC IdP token endpoint used to configure your private workforce.
    userInfoEndpoint String
    The OIDC IdP user info endpoint used to configure your private workforce.
    authenticationRequestExtraParams Map<String>
    A string to string map of identifiers specific to the custom identity provider (IdP) being used.
    clientSecret String
    The OIDC IdP client secret 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.

    WorkforceSourceIpConfig

    Cidrs List<string>
    A list of one to ten Classless Inter-Domain Routing (CIDR) values.
    Cidrs []string
    A list of one to ten Classless Inter-Domain Routing (CIDR) values.
    cidrs list(string)
    A list of one to ten Classless Inter-Domain Routing (CIDR) values.
    cidrs List<String>
    A list of one to ten Classless Inter-Domain Routing (CIDR) values.
    cidrs string[]
    A list of one to ten Classless Inter-Domain Routing (CIDR) values.
    cidrs Sequence[str]
    A list of one to ten Classless Inter-Domain Routing (CIDR) values.
    cidrs List<String>
    A list of one to ten Classless Inter-Domain Routing (CIDR) values.

    WorkforceVpcConfigRequest

    SecurityGroupIds List<string>
    The VPC security group IDs.
    Subnets List<string>
    The VPC subnets.
    VpcId string
    The ID of the VPC.
    SecurityGroupIds []string
    The VPC security group IDs.
    Subnets []string
    The VPC subnets.
    VpcId string
    The ID of the VPC.
    security_group_ids list(string)
    The VPC security group IDs.
    subnets list(string)
    The VPC subnets.
    vpc_id string
    The ID of the VPC.
    securityGroupIds List<String>
    The VPC security group IDs.
    subnets List<String>
    The VPC subnets.
    vpcId String
    The ID of the VPC.
    securityGroupIds string[]
    The VPC security group IDs.
    subnets string[]
    The VPC subnets.
    vpcId string
    The ID of the VPC.
    security_group_ids Sequence[str]
    The VPC security group IDs.
    subnets Sequence[str]
    The VPC subnets.
    vpc_id str
    The ID of the VPC.
    securityGroupIds List<String>
    The VPC security group IDs.
    subnets List<String>
    The VPC subnets.
    vpcId String
    The ID of the VPC.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.75.0
    published on Monday, Aug 17, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial