LaunchProfileDetails - Amazon Nimble Studio

LaunchProfileDetails

Identifies the launch profile and the streaming images that can be used with the launch profile.

URI

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

HTTP methods

GET

Operation ID: GetLaunchProfileDetails

Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile.

Path parameters
Name Type Required Description
studioId String True

The studio ID.

launchProfileId String True

The launch profile ID.

Responses
Status code Response model Description
200 GetLaunchProfileDetailsOutput

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

Response bodies

{ "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": { } }, "studioComponentSummaries": [ { "studioComponentId": "string", "name": "string", "description": "string", "type": enum, "subtype": enum, "createdAt": "string", "updatedAt": "string", "createdBy": "string", "updatedBy": "string" } ], "streamingImages": [ { "streamingImageId": "string", "ec2ImageId": "string", "description": "string", "name": "string", "owner": "string", "encryptionConfiguration": { "keyArn": "string", "keyType": enum }, "eulaIds": [ "string" ], "state": enum, "statusCode": enum, "statusMessage": "string", "arn": "string", "platform": "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.

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

GetLaunchProfileDetailsOutput

Property Type Required Description
launchProfile

LaunchProfile

False

The launch profile.

studioComponentSummaries

Array of type StudioComponentSummary

False

A collection of studio component summaries.

streamingImages

Array of type StreamingImage

False

A collection of streaming images.

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

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.

StreamingClipboardMode

  • ENABLED

  • DISABLED

StreamingImage

Property Type Required Description
streamingImageId

string

False

The ID of the streaming image.

ec2ImageId

string

False

The ID of an EC2 machine image with which to create the streaming image.

description

string

False

A human-readable description of the streaming image.

name

string

False

A friendly name for a streaming image resource.

owner

string

False

The owner of the streaming image, either the studioId that contains the streaming image, or 'amazon' for images that are provided by Amazon Nimble Studio.

encryptionConfiguration

StreamingImageEncryptionConfiguration

False

The encryption configuration.

eulaIds

Array of type string

False

The list of EULAs that must be accepted before a Streaming Session can be started using this streaming image.

state

StreamingImageState

False

The current state.

statusCode

StreamingImageStatusCode

False

The status code.

statusMessage

string

False

The status message for the streaming image.

arn

string

False

The ARN of the resource.

platform

string

False

The platform of the streaming image, either WINDOWS or LINUX.

tags

Tags

False

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

StreamingImageEncryptionConfiguration

Property Type Required Description
keyArn

string

False

The ARN for a KMS key that is used to encrypt studio data.

keyType

StreamingImageEncryptionConfigurationKeyType

True

The type of KMS key that is used to encrypt studio data.

StreamingImageEncryptionConfigurationKeyType

  • CUSTOMER_MANAGED_KEY

StreamingImageState

  • CREATE_IN_PROGRESS

  • READY

  • DELETE_IN_PROGRESS

  • DELETED

  • UPDATE_IN_PROGRESS

  • UPDATE_FAILED

  • CREATE_FAILED

  • DELETE_FAILED

StreamingImageStatusCode

The status code.

  • STREAMING_IMAGE_CREATE_IN_PROGRESS

  • STREAMING_IMAGE_READY

  • STREAMING_IMAGE_DELETE_IN_PROGRESS

  • STREAMING_IMAGE_DELETED

  • STREAMING_IMAGE_UPDATE_IN_PROGRESS

  • INTERNAL_ERROR

StreamingInstanceType

  • g4dn.xlarge

  • g4dn.2xlarge

  • g4dn.4xlarge

  • g4dn.8xlarge

  • g4dn.12xlarge

  • g4dn.16xlarge

StudioComponentSubtype

  • AWS_MANAGED_MICROSOFT_AD

  • AMAZON_FSX_FOR_WINDOWS

  • AMAZON_FSX_FOR_LUSTRE

  • CUSTOM

StudioComponentSummary

Property Type Required Description
studioComponentId

string

False

The unique identifier for a studio component resource.

name

string

False

The name for the studio component.

description

string

False

The description.

type

StudioComponentType

False

The type of the studio component.

subtype

StudioComponentSubtype

False

The specific subtype of a studio component.

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 studio component.

updatedBy

string

False

The user ID of the user that most recently updated the resource.

StudioComponentType

  • ACTIVE_DIRECTORY

  • SHARED_FILE_SYSTEM

  • COMPUTE_FARM

  • LICENSE_SERVICE

  • CUSTOM

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:

GetLaunchProfileDetails