LaunchProfiles - Amazon Nimble Studio

LaunchProfiles

Represents a collection of launch profiles.

URI

/2020-08-01/studios/studioId/launch-profiles

HTTP methods

GET

Operation ID: ListLaunchProfiles

List all the launch profiles a studio.

Path parameters
Name Type Required Description
studioId String True

The studio ID.

Query parameters
Name Type Required Description
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.

principalId String False

The principal ID.

Responses
Status code Response model Description
200 ListLaunchProfilesOutput

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

Create a launch profile.

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 CreateLaunchProfileOutput

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", "launchProfileProtocolVersions": [ "string" ], "studioComponentIds": [ "string" ], "ec2SubnetIds": [ "string" ], "streamConfiguration": { "ec2InstanceTypes": [ enum ], "streamingImageIds": [ "string" ], "maxSessionLengthInMinutes": integer, "clipboardMode": enum }, "tags": { } }
{ "name": "string", "description": "string", "launchProfileProtocolVersions": [ "string" ], "studioComponentIds": [ "string" ], "ec2SubnetIds": [ "string" ], "streamConfiguration": { "ec2InstanceTypes": [ enum ], "streamingImageIds": [ "string" ], "maxSessionLengthInMinutes": integer, "clipboardMode": enum }, "tags": { } }

Response bodies

{ "launchProfiles": [ { "name": "string", "description": "string", "launchProfileProtocolVersions": [ "string" ], "studioComponentIds": [ "string" ], "ec2SubnetIds": [ "string" ], "launchProfileId": "string", "streamConfiguration": { "ec2InstanceTypes": [ enum ], "streamingImageIds": [ "string" ], "maxSessionLengthInMinutes": integer, "clipboardMode": enum }, "state": enum, "statusCode": enum, "statusMessage": "string", "createdAt": "string", "updatedAt": "string", "createdBy": "string", "updatedBy": "string", "arn": "string", "tags": { } } ], "nextToken": "string" }
{ "launchProfile": { "name": "string", "description": "string", "launchProfileProtocolVersions": [ "string" ], "studioComponentIds": [ "string" ], "ec2SubnetIds": [ "string" ], "launchProfileId": "string", "streamConfiguration": { "ec2InstanceTypes": [ enum ], "streamingImageIds": [ "string" ], "maxSessionLengthInMinutes": integer, "clipboardMode": enum }, "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.

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.

CreateLaunchProfileInput

Property Type Required Description
name

string

True

The name for the launch profile.

description

string

False

The description.

launchProfileProtocolVersions

Array of type string

True

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

studioComponentIds

Array of type string

True

Unique identifiers for a collection of studio components that can be used with this launch profile.

ec2SubnetIds

Array of type string

True
streamConfiguration

StreamConfigurationCreate

True

A configuration for a streaming session.

tags

Tags

False

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

CreateLaunchProfileOutput

Property Type Required Description
launchProfile

LaunchProfile

False

The launch profile.

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.

LaunchProfile

Property Type Required Description
name

string

False

A friendly name for the launch profile.

description

string

False

A human-readable description of the launch profile.

launchProfileProtocolVersions

Array of type string

False

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

studioComponentIds

Array of type string

False

Unique identifiers for a collection of studio components that can be used with this launch profile.

ec2SubnetIds

Array of type string

False

Unique identifiers for a collection of EC2 subnets.

launchProfileId

string

False

The launch profile ID.

streamConfiguration

StreamConfiguration

False

A configuration for a streaming session.

state

LaunchProfileState

False

The current state.

statusCode

LaunchProfileStatusCode

False

The status code.

statusMessage

string

False

The status message for the launch profile.

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 launch profile.

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.

LaunchProfileState

  • CREATE_IN_PROGRESS

  • READY

  • UPDATE_IN_PROGRESS

  • DELETE_IN_PROGRESS

  • DELETED

  • DELETE_FAILED

  • CREATE_FAILED

  • UPDATE_FAILED

LaunchProfileStatusCode

  • LAUNCH_PROFILE_CREATED

  • LAUNCH_PROFILE_UPDATED

  • LAUNCH_PROFILE_DELETED

  • LAUNCH_PROFILE_CREATE_IN_PROGRESS

  • LAUNCH_PROFILE_UPDATE_IN_PROGRESS

  • LAUNCH_PROFILE_DELETE_IN_PROGRESS

  • INTERNAL_ERROR

  • STREAMING_IMAGE_NOT_FOUND

  • STREAMING_IMAGE_NOT_READY

  • LAUNCH_PROFILE_WITH_STREAM_SESSIONS_NOT_DELETED

  • ENCRYPTION_KEY_ACCESS_DENIED

  • ENCRYPTION_KEY_NOT_FOUND

  • INVALID_SUBNETS_PROVIDED

ListLaunchProfilesOutput

Property Type Required Description
launchProfiles

Array of type LaunchProfile

False

A collection of launch profiles.

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.

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.

StreamConfiguration

A configuration for a streaming session.

Property Type Required Description
ec2InstanceTypes

Array of type StreamingInstanceType

False

The EC2 instance types that users can select from when launching a streaming session with this launch profile.

streamingImageIds

Array of type string

False

The streaming images that users can select from when launching a streaming session with this launch profile.

maxSessionLengthInMinutes

integer

False

The length of time, in minutes, that a streaming session can run. After this point, Nimble Studio automatically terminates the session.

clipboardMode

StreamingClipboardMode

False

Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

StreamConfigurationCreate

Property Type Required Description
ec2InstanceTypes

Array of type StreamingInstanceType

True

The EC2 instance types that users can select from when launching a streaming session with this launch profile.

streamingImageIds

Array of type string

True

The streaming images that users can select from when launching a streaming session with this launch profile.

maxSessionLengthInMinutes

integer

False

The length of time, in minutes, that a streaming session can run. After this point, Nimble Studio automatically terminates the session.

clipboardMode

StreamingClipboardMode

True

Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

StreamingClipboardMode

  • ENABLED

  • DISABLED

StreamingInstanceType

  • g4dn.xlarge

  • g4dn.2xlarge

  • g4dn.4xlarge

  • g4dn.8xlarge

  • g4dn.12xlarge

  • g4dn.16xlarge

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:

ListLaunchProfiles

CreateLaunchProfile