Skip to content
AWS for Query.Farm

aws.sagemaker.describe_workforce

Example SQL Queries

SELECT * FROM
aws.sagemaker.describe_workforce
WHERE
"workforce_name" = 'VALUE';

Description

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.

This operation applies only to private workforces.

Table Definition

Column NameColumn Data Type
workforce_name Required Input Column

The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified. 

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

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 Amazon Web Services 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.

STRUCT(
    "workforce_name" VARCHAR,
    "workforce_arn" VARCHAR,
    "last_updated_date" TIMESTAMP_S,
    "source_ip_config" STRUCT(
        "cidrs" VARCHAR[]
    ),
    "sub_domain" VARCHAR,
    "cognito_config" STRUCT(
        "user_pool" VARCHAR,
        "client_id" VARCHAR
    ),
    "oidc_config" STRUCT(
        "client_id" VARCHAR,
        "issuer" VARCHAR,
        "authorization_endpoint" VARCHAR,
        "token_endpoint" VARCHAR,
        "user_info_endpoint" VARCHAR,
        "logout_endpoint" VARCHAR,
        "jwks_uri" VARCHAR,
        "scope" VARCHAR,
        "authentication_request_extra_params" MAP(VARCHAR, VARCHAR)
    ),
    "create_date" TIMESTAMP_S,
    "workforce_vpc_config" STRUCT(
        "vpc_id" VARCHAR,
        "security_group_ids" VARCHAR[],
        "subnets" VARCHAR[],
        "vpc_endpoint_id" VARCHAR
    ),
    "status" VARCHAR,
    "failure_reason" VARCHAR
)
Show child fields
workforce.cognito_config

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

Show child fields
workforce.cognito_config.client_id

The client ID for your Amazon Cognito user pool.

workforce.cognito_config.user_pool

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.

workforce.create_date

The date that the workforce is created.

workforce.failure_reason

The reason your workforce failed.

workforce.last_updated_date

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.

workforce.oidc_config

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

Show child fields
workforce.oidc_config.authentication_request_extra_params

A string to string map of identifiers specific to the custom identity provider (IdP) being used.

workforce.oidc_config.authorization_endpoint

The OIDC IdP authorization endpoint used to configure your private workforce.

workforce.oidc_config.client_id

The OIDC IdP client ID used to configure your private workforce.

workforce.oidc_config.issuer

The OIDC IdP issuer used to configure your private workforce.

workforce.oidc_config.jwks_uri

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

workforce.oidc_config.logout_endpoint

The OIDC IdP logout endpoint used to configure your private workforce.

workforce.oidc_config.scope

An array of string identifiers used to refer to the specific pieces of user data or claims that the client application wants to access.

workforce.oidc_config.token_endpoint

The OIDC IdP token endpoint used to configure your private workforce.

workforce.oidc_config.user_info_endpoint

The OIDC IdP user information endpoint used to configure your private workforce.

workforce.source_ip_config

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.

Show child fields
workforce.source_ip_config.cidrs[]
workforce.status

The status of your workforce.

workforce.sub_domain

The subdomain for your OIDC Identity Provider.

workforce.workforce_arn

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

workforce.workforce_name

The name of the private workforce.

workforce.workforce_vpc_config

The configuration of a VPC workforce.

Show child fields
workforce.workforce_vpc_config.security_group_ids[]
workforce.workforce_vpc_config.subnets[]
workforce.workforce_vpc_config.vpc_endpoint_id

The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.

workforce.workforce_vpc_config.vpc_id

The ID of the VPC that the workforce uses for communication.