get-studio-component¶
Description¶
Gets a studio component resource.
See also: AWS API Documentation
Synopsis¶
get-studio-component
--studio-component-id <value>
--studio-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--studio-component-id (string)
The studio component ID.
--studio-id (string)
The studio ID.
--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.
--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
on
off
auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output¶
studioComponent -> (structure)
Information about the studio component.
arn -> (string)
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
configuration -> (tagged union structure)
The configuration of the studio component, based on component type.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:
activeDirectoryConfiguration,computeFarmConfiguration,licenseServiceConfiguration,sharedFileSystemConfiguration.activeDirectoryConfiguration -> (structure)
The configuration for a Directory Service for Microsoft Active Directory 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 ISO 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.
runtimeRoleArn -> (string)
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.
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.
secureInitializationRoleArn -> (string)
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.
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 ISO timestamp in seconds for when the resource was updated.
updatedBy -> (string)
The user ID of the user that most recently updated the resource.