Skip to content

aws.nimble.list_studio_components

Example SQL Queries

SELECT * FROM
aws.nimble.list_studio_components
WHERE
"studio_id" = 'VALUE';

Description

Lists the StudioComponents in a studio.

Table Definition

Column NameColumn Data Type
studio_id Required Input Column

The studio ID.

VARCHAR
states Input Column

Filters the request to studio components that are in one of the given states.

VARCHAR[]
Show child fields
states[]
types Input Column

Filters the request to studio components that are of one of the given types.

VARCHAR[]
Show child fields
types[]
_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.

_aws_region Input Column

The AWS region to use.

VARCHAR
arn

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

VARCHAR
configuration

The configuration of the studio component, based on component type.

STRUCT(
"active_directory_configuration" STRUCT(
"computer_attributes" STRUCT(
"name" VARCHAR,
"value" VARCHAR
)[],
"directory_id" VARCHAR,
"organizational_unit_distinguished_name" VARCHAR
),
"compute_farm_configuration" STRUCT(
"active_directory_user" VARCHAR,
"endpoint" VARCHAR
),
"license_service_configuration" STRUCT(
"endpoint" VARCHAR
),
"shared_file_system_configuration" STRUCT(
"endpoint" VARCHAR,
"file_system_id" VARCHAR,
"linux_mount_point" VARCHAR,
"share_name" VARCHAR,
"windows_mount_drive" VARCHAR
)
)
Show child fields
configuration.active_directory_configuration

The configuration for a Directory Service for Microsoft Active Directory studio resource.

Show child fields
configuration.active_directory_configuration.computer_attributes[]
Show child fields
configuration.active_directory_configuration.computer_attributes[].name

The name for the LDAP attribute.

configuration.active_directory_configuration.computer_attributes[].value

The value for the LDAP attribute.

configuration.active_directory_configuration.directory_id

The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.

configuration.active_directory_configuration.organizational_unit_distinguished_name

The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.

configuration.compute_farm_configuration

The configuration for a render farm that is associated with a studio resource.

Show child fields
configuration.compute_farm_configuration.active_directory_user

The name of an Active Directory user that is used on ComputeFarm worker instances.

configuration.compute_farm_configuration.endpoint

The endpoint of the ComputeFarm that is accessed by the studio component resource.

configuration.license_service_configuration

The configuration for a license service that is associated with a studio resource.

Show child fields
configuration.license_service_configuration.endpoint

The endpoint of the license service that is accessed by the studio component resource.

configuration.shared_file_system_configuration

The configuration for a shared file storage system that is associated with a studio resource.

Show child fields
configuration.shared_file_system_configuration.endpoint

The endpoint of the shared file system that is accessed by the studio component resource.

configuration.shared_file_system_configuration.file_system_id

The unique identifier for a file system.

configuration.shared_file_system_configuration.linux_mount_point

The mount location for a shared file system on a Linux virtual workstation.

configuration.shared_file_system_configuration.share_name

The name of the file share.

configuration.shared_file_system_configuration.windows_mount_drive

The mount location for a shared file system on a Windows virtual workstation.

created_at

The ISO timestamp in seconds for when the resource was created.

TIMESTAMP_S
created_by

The user ID of the user that created the studio component.

VARCHAR
description

A human-readable description for the studio component resource.

VARCHAR
ec2_security_group_ids

The EC2 security groups that control access to the studio component.

VARCHAR[]
Show child fields
ec2_security_group_ids[]
initialization_scripts

Initialization scripts for studio components.

STRUCT(
"launch_profile_protocol_version" VARCHAR,
"platform" VARCHAR,
"run_context" VARCHAR,
"script" VARCHAR
)[]
Show child fields
initialization_scripts[]
Show child fields
initialization_scripts[].launch_profile_protocol_version

The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".

initialization_scripts[].platform

The platform of the initialization script, either Windows or Linux.

initialization_scripts[].run_context

The method to use when running the initialization script.

initialization_scripts[].script

The initialization script.

name

A friendly name for the studio component resource.

VARCHAR
runtime_role_arn

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

VARCHAR
script_parameters

Parameters for the studio component scripts.

STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
Show child fields
script_parameters[]
Show child fields
script_parameters[].key

A script parameter key.

script_parameters[].value

A script parameter value.

secure_initialization_role_arn

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

VARCHAR
state

The current state.

VARCHAR
status_code

The status code.

VARCHAR
status_message

The status message for the studio component.

VARCHAR
studio_component_id

The unique identifier for a studio component resource.

VARCHAR
subtype

The specific subtype of a studio component.

VARCHAR
tags

A collection of labels, in the form of key-value pairs, that apply to this resource.

MAP(VARCHAR, VARCHAR)
type

The type of the studio component.

VARCHAR
updated_at

The ISO timestamp in seconds for when the resource was updated.

TIMESTAMP_S
updated_by

The user ID of the user that most recently updated the resource.

VARCHAR