UpdateLaunchProfileMember
Update a user persona in launch profile membership.
Request Syntax
PATCH /2020-08-01/studios/studioId/launch-profiles/launchProfileId/membership/principalId HTTP/1.1
X-Amz-Client-Token: clientToken Content-type: application/json { "persona": "string"
}
URI Request Parameters
The request uses the following URI parameters.
clientToken (p. 137)
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.
launchProfileId (p. 137) The Launch Profile ID.
Required: Yes principalId (p. 137)
The principal ID. This currently supports a AWS SSO UserId.
Required: Yes studioId (p. 137)
The studio ID.
Required: Yes
Request Body
The request accepts the following data in JSON format.
persona (p. 137) The persona.
Type: String Valid Values: USER Required: Yes
Response Syntax
Response Syntax
HTTP/1.1 200
Content-type: application/json { "member": {
"identityStoreId": "string", "persona": "string",
"principalId": "string", "sid": "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.
member (p. 138)
The updated member.
Type: LaunchProfileMembership (p. 167) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 208).
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.
See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateStreamingImage
UpdateStreamingImage
Update streaming image.
Request Syntax
PATCH /2020-08-01/studios/studioId/streaming-images/streamingImageId HTTP/1.1 X-Amz-Client-Token: clientToken
Content-type: application/json { "description": "string", "name": "string"
}
URI Request Parameters
The request uses the following URI parameters.
clientToken (p. 140)
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.
streamingImageId (p. 140)
The streaming image ID.
Required: Yes studioId (p. 140)
The studio ID.
Required: Yes
Request Body
The request accepts the following data in JSON format.
description (p. 140)
The description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No name (p. 140)
The name for the streaming image.
Response Syntax
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Required: No
"description": "string", "ec2ImageId": "string", "encryptionConfiguration": { "keyArn": "string", "statusCode": "string", "statusMessage": "string", "streamingImageId": "string", "tags": {
"string" : "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.
streamingImage (p. 141)
Represents a streaming image resource.
Streaming images are used by studio users to select which operating system and software they want to use in a Nimble Studio streaming session.
Amazon provides a number of streaming images that include popular 3rd-party software.
You can create your own streaming images using an Amazon Elastic Compute Cloud (Amazon EC2) machine image that you create for this purpose. You can also include software that your users require.
Type: StreamingImage (p. 180) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 208).
See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateStudio
UpdateStudio
Update a Studio resource.
Currently, this operation only supports updating the displayName of your studio.
Request Syntax
PATCH /2020-08-01/studios/studioId HTTP/1.1 X-Amz-Client-Token: clientToken
Content-type: application/json { "adminRoleArn": "string", "displayName": "string", "userRoleArn": "string"
}
URI Request Parameters
The request uses the following URI parameters.
clientToken (p. 143)
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 (p. 143) The studio ID.
Required: Yes
Request Body
The request accepts the following data in JSON format.
adminRoleArn (p. 143)
The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.
Type: String Required: No displayName (p. 143)
A friendly name for the studio.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Required: No
Response Syntax
userRoleArn (p. 143)
The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.
Type: String
"adminRoleArn": "string", "arn": "string",
"createdAt": number, "displayName": "string", "homeRegion": "string", "ssoClientId": "string", "state": "string", "statusCode": "string", "statusMessage": "string",
"studioEncryptionConfiguration": { "keyArn": "string",
"keyType": "string"
},
"studioId": "string", "studioName": "string", "studioUrl": "string", "tags": {
"string" : "string"
},
"updatedAt": number, "userRoleArn": "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.
studio (p. 144)
Information about a studio.
Type: Studio (p. 191) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 208).
AccessDeniedException
You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateStudioComponent
UpdateStudioComponent
Updates a studio component resource.
Request Syntax
PATCH /2020-08-01/studios/studioId/studio-components/studioComponentId HTTP/1.1 X-Amz-Client-Token: clientToken
Content-type: application/json { "configuration": {
"activeDirectoryConfiguration": { "computerAttributes": [
"organizationalUnitDistinguishedName": "string"
},
"computeFarmConfiguration": { "activeDirectoryUser": "string", "endpoint": "string"
},
"licenseServiceConfiguration": { "endpoint": "string"
},
"sharedFileSystemConfiguration": { "endpoint": "string",
"description": "string",
"ec2SecurityGroupIds": [ "string" ], "initializationScripts": [
{
"launchProfileProtocolVersion": "string", "platform": "string",
"runContext": "string", "script": "string"
} ],
"name": "string", "scriptParameters": [ {
"key": "string", "value": "string"
} ],
"subtype": "string", "type": "string"
}
URI Request Parameters
The request uses the following URI parameters.
Request Body
clientToken (p. 146)
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.
studioComponentId (p. 146) The studio component ID.
Required: Yes studioId (p. 146)
The studio ID.
Required: Yes
Request Body
The request accepts the following data in JSON format.
configuration (p. 146)
The configuration of the studio component, based on component type.
Type: StudioComponentConfiguration (p. 198) object Required: No
description (p. 146) The description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
ec2SecurityGroupIds (p. 146)
The EC2 security groups that control access to the studio component.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 30 items.
Required: No
initializationScripts (p. 146)
Initialization scripts for studio components.
Type: Array of StudioComponentInitializationScript (p. 199) objects Required: No
name (p. 146)
The name for the studio component.
Type: String
Response Syntax
Length Constraints: Minimum length of 0. Maximum length of 64.
Required: No
scriptParameters (p. 146)
Parameters for the studio component scripts.
Type: Array of ScriptParameterKeyValue (p. 172) objects
Array Members: Minimum number of 0 items. Maximum number of 30 items.
Required: No subtype (p. 146)
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 type (p. 146)
The type of the studio component.
Type: String
Valid Values: ACTIVE_DIRECTORY | SHARED_FILE_SYSTEM | COMPUTE_FARM | LICENSE_SERVICE | CUSTOM
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"studioComponent": { "arn": "string",
"organizationalUnitDistinguishedName": "string"
},
Response Elements "description": "string",
"ec2SecurityGroupIds": [ "string" ], "initializationScripts": [
{
"launchProfileProtocolVersion": "string", "platform": "string", "statusCode": "string", "statusMessage": "string", "studioComponentId": "string", "subtype": "string",
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 (p. 148)
Information about the studio component.
Type: StudioComponent (p. 194) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 208).
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
See Also
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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3