Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . nimble ]

update-studio-component

Description

Updates a studio component resource.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-studio-component
[--client-token <value>]
[--configuration <value>]
[--description <value>]
[--ec2-security-group-ids <value>]
[--initialization-scripts <value>]
[--name <value>]
[--script-parameters <value>]
--studio-component-id <value>
--studio-id <value>
[--subtype <value>]
[--type <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

--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.

JSON Syntax:

{
  "activeDirectoryConfiguration": {
    "computerAttributes": [
      {
        "name": "string",
        "value": "string"
      }
      ...
    ],
    "directoryId": "string",
    "organizationalUnitDistinguishedName": "string"
  },
  "computeFarmConfiguration": {
    "activeDirectoryUser": "string",
    "endpoint": "string"
  },
  "licenseServiceConfiguration": {
    "endpoint": "string"
  },
  "sharedFileSystemConfiguration": {
    "endpoint": "string",
    "fileSystemId": "string",
    "linuxMountPoint": "string",
    "shareName": "string",
    "windowsMountDrive": "string"
  }
}

--description (string)

The description.

--ec2-security-group-ids (list)

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

(string)

Syntax:

"string" "string" ...

--initialization-scripts (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.

Shorthand Syntax:

launchProfileProtocolVersion=string,platform=string,runContext=string,script=string ...

JSON Syntax:

[
  {
    "launchProfileProtocolVersion": "string",
    "platform": "LINUX"|"WINDOWS",
    "runContext": "SYSTEM_INITIALIZATION"|"USER_INITIALIZATION",
    "script": "string"
  }
  ...
]

--name (string)

The name for the studio component.

--script-parameters (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.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--studio-component-id (string)

The studio component ID.

--studio-id (string)

The studio ID.

--subtype (string)

The specific subtype of a studio component.

Possible values:

  • AWS_MANAGED_MICROSOFT_AD
  • AMAZON_FSX_FOR_WINDOWS
  • AMAZON_FSX_FOR_LUSTRE
  • CUSTOM

--type (string)

The type of the studio component.

Possible values:

  • ACTIVE_DIRECTORY
  • SHARED_FILE_SYSTEM
  • COMPUTE_FARM
  • LICENSE_SERVICE
  • CUSTOM

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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

studioComponent -> (structure)

Information about the studio component.

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.