Skip to content
AWS for Query.Farm

aws.sagemaker.describe_workteam

Example SQL Queries

SELECT * FROM
aws.sagemaker.describe_workteam
WHERE
"workteam_name" = 'VALUE';

Description

Gets information about a specific work team. You can see information such as the creation date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).

Table Definition

Column NameColumn Data Type
workteam_name Required Input Column

The name of the work team to return a description of.

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.

workteam

A Workteam instance that contains information about the work team. 

STRUCT(
    "workteam_name" VARCHAR,
    "member_definitions" STRUCT(
        "cognito_member_definition" STRUCT(
            "user_pool" VARCHAR,
            "user_group" VARCHAR,
            "client_id" VARCHAR
        ),
        "oidc_member_definition" STRUCT(
            "groups" VARCHAR[]
        )
    )[],
    "workteam_arn" VARCHAR,
    "workforce_arn" VARCHAR,
    "product_listing_ids" VARCHAR[],
    "description" VARCHAR,
    "sub_domain" VARCHAR,
    "create_date" TIMESTAMP_S,
    "last_updated_date" TIMESTAMP_S,
    "notification_configuration" STRUCT(
        "notification_topic_arn" VARCHAR
    ),
    "worker_access_configuration" STRUCT(
        "s3_presign" STRUCT(
            "iam_policy_constraints" STRUCT(
                "source_ip" VARCHAR,
                "vpc_source_ip" VARCHAR
            )
        )
    )
)
Show child fields
workteam.create_date

The date and time that the work team was created (timestamp).

workteam.description

A description of the work team.

workteam.last_updated_date

The date and time that the work team was last updated (timestamp).

workteam.member_definitions[]
Show child fields
workteam.member_definitions[].cognito_member_definition

The Amazon Cognito user group that is part of the work team.

Show child fields
workteam.member_definitions[].cognito_member_definition.client_id

An identifier for an application client. You must create the app client ID using Amazon Cognito.

workteam.member_definitions[].cognito_member_definition.user_group

An identifier for a user group.

workteam.member_definitions[].cognito_member_definition.user_pool

An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

workteam.member_definitions[].oidc_member_definition

A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

Show child fields
workteam.member_definitions[].oidc_member_definition.groups[]
workteam.notification_configuration

Configures SNS notifications of available or expiring work items for work teams.

Show child fields
workteam.notification_configuration.notification_topic_arn

The ARN for the Amazon SNS topic to which notifications should be published.

workteam.product_listing_ids[]
workteam.sub_domain

The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.

workteam.worker_access_configuration

Describes any access constraints that have been defined for Amazon S3 resources.

Show child fields
workteam.worker_access_configuration.s3_presign

Defines any Amazon S3 resource constraints.

Show child fields
workteam.worker_access_configuration.s3_presign.iam_policy_constraints

Use this parameter to specify the allowed request source. Possible sources are either SourceIp or VpcSourceIp.

Show child fields
workteam.worker_access_configuration.s3_presign.iam_policy_constraints.source_ip

When SourceIp is Enabled the worker's IP address when a task is rendered in the worker portal is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. This IP address is checked by Amazon S3 and must match in order for the Amazon S3 resource to be rendered in the worker portal.

workteam.worker_access_configuration.s3_presign.iam_policy_constraints.vpc_source_ip

When VpcSourceIp is Enabled the worker's IP address when a task is rendered in private worker portal inside the VPC is added to the IAM policy as a Condition used to generate the Amazon S3 presigned URL. To render the task successfully Amazon S3 checks that the presigned URL is being accessed over an Amazon S3 VPC Endpoint, and that the worker's IP address matches the IP address in the IAM policy. To learn more about configuring private worker portal, see Use Amazon VPC mode from a private worker portal.

workteam.workforce_arn

The Amazon Resource Name (ARN) of the workforce.

workteam.workteam_arn

The Amazon Resource Name (ARN) that identifies the work team.

workteam.workteam_name

The name of the work team.