CreateLaunchProfile - Amazon Nimble Studio

CreateLaunchProfile

Create a launch profile.

Request Syntax

POST /2020-08-01/studios/studioId/launch-profiles HTTP/1.1 X-Amz-Client-Token: clientToken Content-type: application/json { "description": "string", "ec2SubnetIds": [ "string" ], "launchProfileProtocolVersions": [ "string" ], "name": "string", "streamConfiguration": { "clipboardMode": "string", "ec2InstanceTypes": [ "string" ], "maxSessionLengthInMinutes": number, "maxStoppedSessionLengthInMinutes": number, "streamingImageIds": [ "string" ] }, "studioComponentIds": [ "string" ], "tags": { "string" : "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.

description

The description.

Type: String

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

Required: No

ec2SubnetIds

Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types.

Type: Array of strings

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

Required: Yes

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: Yes

name

The name for the launch profile.

Type: String

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

Required: Yes

streamConfiguration

A configuration for a streaming session.

Type: StreamConfigurationCreate object

Required: Yes

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: Yes

tags

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

Type: String to string map

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "launchProfile": { "arn": "string", "createdAt": number, "createdBy": "string", "description": "string", "ec2SubnetIds": [ "string" ], "launchProfileId": "string", "launchProfileProtocolVersions": [ "string" ], "name": "string", "state": "string", "statusCode": "string", "statusMessage": "string", "streamConfiguration": { "clipboardMode": "string", "ec2InstanceTypes": [ "string" ], "maxSessionLengthInMinutes": number, "maxStoppedSessionLengthInMinutes": number, "streamingImageIds": [ "string" ] }, "studioComponentIds": [ "string" ], "tags": { "string" : "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.

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: