StudioComponents - Amazon Nimble Studio

StudioComponents

Represents the collection of studio components in a studio.

URI

/2020-08-01/studios/studioId/studio-components

HTTP methods

GET

Operation ID: ListStudioComponents

Lists the StudioComponents in a studio.

Path parameters
Name Type Required Description
studioId String True

The studio ID.

Query parameters
Name Type Required Description
types String False

The types.

states String False

A list of states.

nextToken String False

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

maxResults String False

The maximum number of results to be returned per request.

Responses
Status code Response model Description
200 ListStudioComponentsOutput

Success

400 ValidationException

One of the parameters in the request is invalid.

402 ServiceQuotaExceededException

This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to request an increase.

403 AccessDeniedException

You do not have permission to perform this action.

404 ResourceNotFoundException

A requested resource was not found.

409 ConflictException

This request conflicts with another concurrent request. Please retry your request.

429 ThrottlingException

The request was denied due to request throttling. Please retry your request.

500 InternalServerException

A service fault has occurred. Please retry your request and contact AWS Support if this error continues.

POST

Operation ID: CreateStudioComponent

Creates a studio component resource.

Path parameters
Name Type Required Description
studioId String True

The studio ID.

Header parameters
Name Type Required Description
X-Amz-Client-Token String False

To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

Responses
Status code Response model Description
200 CreateStudioComponentOutput

Success

400 ValidationException

One of the parameters in the request is invalid.

402 ServiceQuotaExceededException

This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to request an increase.

403 AccessDeniedException

You do not have permission to perform this action.

404 ResourceNotFoundException

A requested resource was not found.

409 ConflictException

This request conflicts with another concurrent request. Please retry your request.

429 ThrottlingException

The request was denied due to request throttling. Please retry your request.

500 InternalServerException

A service fault has occurred. Please retry your request and contact AWS Support if this error continues.

Schemas

Request bodies

{ "name": "string", "description": "string", "type": enum, "subtype": enum, "configuration": { "activeDirectoryConfiguration": { "directoryId": "string", "organizationalUnitDistinguishedName": "string", "computerAttributes": [ { "name": "string", "value": "string" } ] }, "sharedFileSystemConfiguration": { "fileSystemId": "string", "linuxMountPoint": "string", "windowsMountDrive": "string", "endpoint": "string", "shareName": "string" }, "computeFarmConfiguration": { "endpoint": "string", "activeDirectoryUser": "string" }, "licenseServiceConfiguration": { "endpoint": "string" } }, "ec2SecurityGroupIds": [ "string" ], "initializationScripts": [ { "launchProfileProtocolVersion": "string", "platform": enum, "runContext": enum, "script": "string" } ], "scriptParameters": [ { "key": "string", "value": "string" } ], "tags": { } }
{ "name": "string", "description": "string", "type": enum, "subtype": enum, "configuration": { "activeDirectoryConfiguration": { "directoryId": "string", "organizationalUnitDistinguishedName": "string", "computerAttributes": [ { "name": "string", "value": "string" } ] }, "sharedFileSystemConfiguration": { "fileSystemId": "string", "linuxMountPoint": "string", "windowsMountDrive": "string", "endpoint": "string", "shareName": "string" }, "computeFarmConfiguration": { "endpoint": "string", "activeDirectoryUser": "string" }, "licenseServiceConfiguration": { "endpoint": "string" } }, "ec2SecurityGroupIds": [ "string" ], "initializationScripts": [ { "launchProfileProtocolVersion": "string", "platform": enum, "runContext": enum, "script": "string" } ], "scriptParameters": [ { "key": "string", "value": "string" } ], "tags": { } }

Response bodies

{ "studioComponents": [ { "studioComponentId": "string", "name": "string", "description": "string", "type": enum, "subtype": enum, "configuration": { "activeDirectoryConfiguration": { "directoryId": "string", "organizationalUnitDistinguishedName": "string", "computerAttributes": [ { "name": "string", "value": "string" } ] }, "sharedFileSystemConfiguration": { "fileSystemId": "string", "linuxMountPoint": "string", "windowsMountDrive": "string", "endpoint": "string", "shareName": "string" }, "computeFarmConfiguration": { "endpoint": "string", "activeDirectoryUser": "string" }, "licenseServiceConfiguration": { "endpoint": "string" } }, "ec2SecurityGroupIds": [ "string" ], "initializationScripts": [ { "launchProfileProtocolVersion": "string", "platform": enum, "runContext": enum, "script": "string" } ], "scriptParameters": [ { "key": "string", "value": "string" } ], "state": enum, "statusCode": enum, "statusMessage": "string", "createdAt": "string", "updatedAt": "string", "createdBy": "string", "updatedBy": "string", "arn": "string", "tags": { } } ], "nextToken": "string" }
{ "studioComponent": { "studioComponentId": "string", "name": "string", "description": "string", "type": enum, "subtype": enum, "configuration": { "activeDirectoryConfiguration": { "directoryId": "string", "organizationalUnitDistinguishedName": "string", "computerAttributes": [ { "name": "string", "value": "string" } ] }, "sharedFileSystemConfiguration": { "fileSystemId": "string", "linuxMountPoint": "string", "windowsMountDrive": "string", "endpoint": "string", "shareName": "string" }, "computeFarmConfiguration": { "endpoint": "string", "activeDirectoryUser": "string" }, "licenseServiceConfiguration": { "endpoint": "string" } }, "ec2SecurityGroupIds": [ "string" ], "initializationScripts": [ { "launchProfileProtocolVersion": "string", "platform": enum, "runContext": enum, "script": "string" } ], "scriptParameters": [ { "key": "string", "value": "string" } ], "state": enum, "statusCode": enum, "statusMessage": "string", "createdAt": "string", "updatedAt": "string", "createdBy": "string", "updatedBy": "string", "arn": "string", "tags": { } } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }

Properties

AccessDeniedException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ActiveDirectoryComputerAttribute

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

Property Type Required Description
name

string

False

The name for the LDAP attribute.

value

string

False

The value for the LDAP attribute.

ActiveDirectoryConfiguration

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

Property Type Required Description
directoryId

string

False

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

organizationalUnitDistinguishedName

string

False

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

computerAttributes

Array of type ActiveDirectoryComputerAttribute

False

A collection of custom attributes for an Active Directory computer.

ComputeFarmConfiguration

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

Property Type Required Description
endpoint

string

False

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

activeDirectoryUser

string

False

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

ConflictException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

CreateStudioComponentInput

Property Type Required Description
name

string

True

The name for the studio component.

description

string

False

The description.

type

StudioComponentType

True

The type of the studio component.

subtype

StudioComponentSubtype

False

The specific subtype of a studio component.

configuration

StudioComponentConfiguration

False

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

ec2SecurityGroupIds

Array of type string

False

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

initializationScripts

Array of type StudioComponentInitializationScript

False

Initialization scripts for studio components.

scriptParameters

Array of type ScriptParameterKeyValue

False

Parameters for the studio component scripts.

tags

Tags

False

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

CreateStudioComponentOutput

Property Type Required Description
studioComponent

StudioComponent

False

Information about the studio component.

ExceptionContext

ExceptionContext is a set of key-value pairs that provide you with more information about the error that occurred. For example, when the service returns a 404 ResourceNotFound error, ExceptionContext will contain the key `resourceId` with the value of resource that was not found.

ExceptionContext enables scripts and other programmatic clients to provide for better error handling.

Property Type Required Description

*

string

False

InternalServerException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

LaunchProfilePlatform

  • LINUX

  • WINDOWS

LicenseServiceConfiguration

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

Property Type Required Description
endpoint

string

False

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

ListStudioComponentsOutput

Property Type Required Description
studioComponents

Array of type StudioComponent

False

A collection of studio components.

nextToken

string

False

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

ResourceNotFoundException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ScriptParameterKeyValue

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

Property Type Required Description
key

string

False

A script parameter key.

value

string

False

A script parameter value.

ServiceQuotaExceededException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

SharedFileSystemConfiguration

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

Property Type Required Description
fileSystemId

string

False

The unique identifier for a file system.

linuxMountPoint

string

False

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

windowsMountDrive

string

False

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

endpoint

string

False

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

shareName

string

False

The name of the file share.

StudioComponent

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

Property Type Required Description
studioComponentId

string

False

The unique identifier for a studio component resource.

name

string

False

A friendly name for the studio component resource.

description

string

False

A human-readable description for the studio component resource.

type

StudioComponentType

False

The type of the studio component.

subtype

StudioComponentSubtype

False

The specific subtype of a studio component.

configuration

StudioComponentConfiguration

False

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

ec2SecurityGroupIds

Array of type string

False

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

initializationScripts

Array of type StudioComponentInitializationScript

False

Initialization scripts for studio components.

scriptParameters

Array of type ScriptParameterKeyValue

False

Parameters for the studio component scripts.

state

StudioComponentState

False

The current state.

statusCode

StudioComponentStatusCode

False

The status code.

statusMessage

string

False

The status message for the studio component.

createdAt

string

False

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

updatedAt

string

False

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

createdBy

string

False

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

updatedBy

string

False

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

arn

string

False

The ARN of the resource.

tags

Tags

False

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

StudioComponentConfiguration

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

Property Type Required Description
activeDirectoryConfiguration

ActiveDirectoryConfiguration

False

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

sharedFileSystemConfiguration

SharedFileSystemConfiguration

False

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

computeFarmConfiguration

ComputeFarmConfiguration

False

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

licenseServiceConfiguration

LicenseServiceConfiguration

False

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

StudioComponentInitializationScript

Initialization scripts for studio components.

Property Type Required Description
launchProfileProtocolVersion

string

False

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

platform

LaunchProfilePlatform

False

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

runContext

StudioComponentInitializationScriptRunContext

False

The method to use when running the initialization script.

script

string

False

The initialization script.

StudioComponentInitializationScriptRunContext

  • SYSTEM_INITIALIZATION

  • USER_INITIALIZATION

StudioComponentState

The current state of the studio component resource.

While a studio component is being created, modified, or deleted, its state will equal "CREATE_IN_PROGRESS", "UPDATE_IN_PROGRESS", or "DELETE_IN_PROGRESS"

These are called 'transition states'.

No modifications may be made to the studio component while it is in a transition state.

If creation of the resource fails, the state will change to `CREATE_FAILED`. The resource StatusCode and StatusMessage will provide more information of why creation failed. The resource in this state will automatically be deleted from your account after a period of time.

If updating the resource fails, the state will change to `UPDATE_FAILED`. The resource StatusCode and StatusMessage will provide more information of why the update failed. The resource will be returned to the state it was in when the update request was invoked.

If deleting the resource fails, the state will change to `DELETE_FAILED`. The resource StatusCode and StatusMessage will provide more information of why the update failed. The resource will be returned to the state it was in when the update request was invoked. After the resource is deleted successfully, it will change to the "DELETED" state. The resource will no longer count against service quotas and cannot be used or acted upon any futher. It will be removed from your account after a period of time.

  • CREATE_IN_PROGRESS

  • READY

  • UPDATE_IN_PROGRESS

  • DELETE_IN_PROGRESS

  • DELETED

  • DELETE_FAILED

  • CREATE_FAILED

  • UPDATE_FAILED

StudioComponentStatusCode

The current status of the studio component resource.

When the resource is in the 'READY' state, the status code signals what the last mutation made to the resource was.

When the resource is in a CREATE_FAILED/UPDATE_FAILED/DELETE_FAILED state, the status code signals what went wrong and why the mutation failed.

  • ACTIVE_DIRECTORY_ALREADY_EXISTS

  • STUDIO_COMPONENT_CREATED

  • STUDIO_COMPONENT_UPDATED

  • STUDIO_COMPONENT_DELETED

  • ENCRYPTION_KEY_ACCESS_DENIED

  • ENCRYPTION_KEY_NOT_FOUND

  • STUDIO_COMPONENT_CREATE_IN_PROGRESS

  • STUDIO_COMPONENT_UPDATE_IN_PROGRESS

  • STUDIO_COMPONENT_DELETE_IN_PROGRESS

  • INTERNAL_ERROR

StudioComponentSubtype

  • AWS_MANAGED_MICROSOFT_AD

  • AMAZON_FSX_FOR_WINDOWS

  • AMAZON_FSX_FOR_LUSTRE

  • CUSTOM

StudioComponentType

  • ACTIVE_DIRECTORY

  • SHARED_FILE_SYSTEM

  • COMPUTE_FARM

  • LICENSE_SERVICE

  • CUSTOM

Tags

Property Type Required Description

*

string

False

ThrottlingException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ValidationException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListStudioComponents

CreateStudioComponent