LaunchProfile - Amazon Nimble Studio

LaunchProfile

A launch profile controls your artist workforce’s access to studio components, like compute farms, shared file systems, managed file systems, and license server configurations, as well as instance types and Amazon Machine Images (AMIs).

Studio administrators create launch profiles in the Nimble Studio console. Artists can use their launch profiles to launch an instance from the Nimble Studio portal. Each user’s launch profile defines how they can launch a streaming session. By default, studio admins can use all launch profiles.

Contents

arn

The ARN of the resource.

Type: String

Required: No

createdAt

The Unix epoch timestamp in seconds for when the resource was created.

Type: Timestamp

Required: No

createdBy

The user ID of the user that created the launch profile.

Type: String

Required: No

description

A human-readable description of the launch profile.

Type: String

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

Required: No

ec2SubnetIds

Unique identifiers for a collection of EC2 subnets.

Type: Array of strings

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

Required: No

launchProfileId

The launch profile ID.

Type: String

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

Pattern: ^[a-zA-Z0-9-_]*$

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

A friendly name for the launch profile.

Type: String

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

Required: No

state

The current state.

Type: String

Valid Values: CREATE_IN_PROGRESS | READY | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | DELETED | DELETE_FAILED | CREATE_FAILED | UPDATE_FAILED

Required: No

statusCode

The status code.

Type: String

Valid Values: 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

Required: No

statusMessage

The status message for the launch profile.

Type: String

Required: No

streamConfiguration

A configuration for a streaming session.

Type: StreamConfiguration 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

tags

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

Type: String to string map

Required: No

updatedAt

The Unix epoch timestamp in seconds for when the resource was updated.

Type: Timestamp

Required: No

updatedBy

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: