[ aws . nimble ]

list-studio-components

Description

Lists the StudioComponents in a studio.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-studio-components is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: studioComponents

Synopsis

  list-studio-components
[--states <value>]
--studio-id <value>
[--types <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--states (list)

A list of states.

(string)

Syntax:

"string" "string" ...

--studio-id (string)

The studio ID.

--types (list)

The types.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

nextToken -> (string)

The token for the next set of results, or null if there are no more results.

studioComponents -> (list)

A collection of studio components.

(structure)

A network that is used by a studio’s users and workflows, including render farm, Active Directory, licensing, and file system.

arn -> (string)

The ARN of the resource.

configuration -> (structure)

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

activeDirectoryConfiguration -> (structure)

The configuration for a Microsoft Active Directory (Microsoft AD) studio resource.

computerAttributes -> (list)

A collection of custom attributes for an Active Directory computer.

(structure)

An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.

name -> (string)

The name for the LDAP attribute.

value -> (string)

The value for the LDAP attribute.

directoryId -> (string)

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

organizationalUnitDistinguishedName -> (string)

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

computeFarmConfiguration -> (structure)

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

activeDirectoryUser -> (string)

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

endpoint -> (string)

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

licenseServiceConfiguration -> (structure)

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

endpoint -> (string)

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

sharedFileSystemConfiguration -> (structure)

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

endpoint -> (string)

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

fileSystemId -> (string)

The unique identifier for a file system.

linuxMountPoint -> (string)

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

shareName -> (string)

The name of the file share.

windowsMountDrive -> (string)

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

createdAt -> (timestamp)

The Unix epoch timestamp in seconds for when the resource was created.

createdBy -> (string)

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

description -> (string)

A human-readable description for the studio component resource.

ec2SecurityGroupIds -> (list)

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

(string)

initializationScripts -> (list)

Initialization scripts for studio components.

(structure)

Initialization scripts for studio components.

launchProfileProtocolVersion -> (string)

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

platform -> (string)

The platform of the initialization script, either WINDOWS or LINUX.

runContext -> (string)

The method to use when running the initialization script.

script -> (string)

The initialization script.

name -> (string)

A friendly name for the studio component resource.

scriptParameters -> (list)

Parameters for the studio component scripts.

(structure)

A parameter for a studio component script, in the form of a key:value pair.

key -> (string)

A script parameter key.

value -> (string)

A script parameter value.

state -> (string)

The current state.

statusCode -> (string)

The status code.

statusMessage -> (string)

The status message for the studio component.

studioComponentId -> (string)

The unique identifier for a studio component resource.

subtype -> (string)

The specific subtype of a studio component.

tags -> (map)

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

key -> (string)

value -> (string)

type -> (string)

The type of the studio component.

updatedAt -> (timestamp)

The Unix epoch timestamp in seconds for when the resource was updated.

updatedBy -> (string)

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