CreateStudioComponent - Amazon Nimble Studio

CreateStudioComponent

Creates a studio component resource.

Request Syntax

POST /2020-08-01/studios/studioId/studio-components HTTP/1.1 X-Amz-Client-Token: clientToken Content-type: application/json { "configuration": { "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", "ec2SecurityGroupIds": [ "string" ], "initializationScripts": [ { "launchProfileProtocolVersion": "string", "platform": "string", "runContext": "string", "script": "string" } ], "name": "string", "scriptParameters": [ { "key": "string", "value": "string" } ], "subtype": "string", "tags": { "string" : "string" }, "type": "string" }

URI Request Parameters

The request uses the following URI parameters.

clientToken

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.

Length Constraints: Minimum length of 1. Maximum length of 64.

studioId

The studio ID.

Required: Yes

Request Body

The request accepts the following data in JSON format.

configuration

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

Type: StudioComponentConfiguration object

Required: No

description

The description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

ec2SecurityGroupIds

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 30 items.

Required: No

initializationScripts

Initialization scripts for studio components.

Type: Array of StudioComponentInitializationScript objects

Required: No

name

The name for the studio component.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: Yes

scriptParameters

Parameters for the studio component scripts.

Type: Array of ScriptParameterKeyValue objects

Array Members: Minimum number of 0 items. Maximum number of 30 items.

Required: No

subtype

The specific subtype of a studio component.

Type: String

Valid Values: AWS_MANAGED_MICROSOFT_AD | AMAZON_FSX_FOR_WINDOWS | AMAZON_FSX_FOR_LUSTRE | CUSTOM

Required: No

tags

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

Type: String to string map

Required: No

type

The type of the studio component.

Type: String

Valid Values: ACTIVE_DIRECTORY | SHARED_FILE_SYSTEM | COMPUTE_FARM | LICENSE_SERVICE | CUSTOM

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "studioComponent": { "arn": "string", "configuration": { "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" } }, "createdAt": number, "createdBy": "string", "description": "string", "ec2SecurityGroupIds": [ "string" ], "initializationScripts": [ { "launchProfileProtocolVersion": "string", "platform": "string", "runContext": "string", "script": "string" } ], "name": "string", "scriptParameters": [ { "key": "string", "value": "string" } ], "state": "string", "statusCode": "string", "statusMessage": "string", "studioComponentId": "string", "subtype": "string", "tags": { "string" : "string" }, "type": "string", "updatedAt": number, "updatedBy": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

studioComponent

Information about the studio component.

Type: StudioComponent object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

HTTP Status Code: 403

ConflictException

Another operation is in progress.

HTTP Status Code: 409

InternalServerErrorException

An internal error has occurred. Please retry your request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

ServiceQuotaExceededException

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use AWS Service Quotas to request an increase.

HTTP Status Code: 402

ThrottlingException

The request throughput limit was exceeded.

HTTP Status Code: 429

ValidationException

One of the parameters in the request is invalid.

HTTP Status Code: 400

See Also

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