UpdateLaunchProfile
Update a launch profile.
Important
This API is only available to customers who created a Nimble Studio cloud studio before June 19th, 2023. This API won't be accessible after June 19th, 2024.
Request Syntax
PATCH /2020-08-01/studios/studioId
/launch-profiles/launchProfileId
HTTP/1.1
X-Amz-Client-Token: clientToken
Content-type: application/json
{
"description": "string
",
"launchProfileProtocolVersions": [ "string
" ],
"name": "string
",
"streamConfiguration": {
"automaticTerminationMode": "string
",
"clipboardMode": "string
",
"ec2InstanceTypes": [ "string
" ],
"maxSessionLengthInMinutes": number
,
"maxStoppedSessionLengthInMinutes": number
,
"sessionBackup": {
"maxBackupsToRetain": number
,
"mode": "string
"
},
"sessionPersistenceMode": "string
",
"sessionStorage": {
"mode": [ "string
" ],
"root": {
"linux": "string
",
"windows": "string
"
}
},
"streamingImageIds": [ "string
" ],
"volumeConfiguration": {
"iops": number
,
"size": number
,
"throughput": number
}
},
"studioComponentIds": [ "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.
- launchProfileId
-
The ID of the launch profile used to control access from the streaming session.
Required: Yes
- studioId
-
The studio ID.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- description
-
The description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- launchProfileProtocolVersions
-
The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern:
^2021\-03\-31$
Required: No
- name
-
The name for the launch profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
- streamConfiguration
-
A configuration for a streaming session.
Type: StreamConfigurationCreate object
Required: No
- studioComponentIds
-
Unique identifiers for a collection of studio components that can be used with this launch profile.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"launchProfile": {
"arn": "string",
"createdAt": "string",
"createdBy": "string",
"description": "string",
"ec2SubnetIds": [ "string" ],
"launchProfileId": "string",
"launchProfileProtocolVersions": [ "string" ],
"name": "string",
"state": "string",
"statusCode": "string",
"statusMessage": "string",
"streamConfiguration": {
"automaticTerminationMode": "string",
"clipboardMode": "string",
"ec2InstanceTypes": [ "string" ],
"maxSessionLengthInMinutes": number,
"maxStoppedSessionLengthInMinutes": number,
"sessionBackup": {
"maxBackupsToRetain": number,
"mode": "string"
},
"sessionPersistenceMode": "string",
"sessionStorage": {
"mode": [ "string" ],
"root": {
"linux": "string",
"windows": "string"
}
},
"streamingImageIds": [ "string" ],
"volumeConfiguration": {
"iops": number,
"size": number,
"throughput": number
}
},
"studioComponentIds": [ "string" ],
"tags": {
"string" : "string"
},
"updatedAt": "string",
"updatedBy": "string",
"validationResults": [
{
"state": "string",
"statusCode": "string",
"statusMessage": "string",
"type": "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.
- launchProfile
-
The launch profile.
Type: LaunchProfile 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: