LaunchProfileInitialization - Amazon Nimble Studio

LaunchProfileInitialization

Represents a launch profile initialization.

URI

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

HTTP methods

GET

Operation ID: GetLaunchProfileInitialization

Get a launch profile initialization.

Path parameters
Name Type Required Description
studioId String True

The studio ID.

launchProfileId String True

The launch profile ID.

Query parameters
Name Type Required Description
launchProfileProtocolVersions String True

A collection of launch profile protocol versions.

launchPurpose String True

The launch purpose.

platform String True

The platform.

Responses
Status code Response model Description
200 GetLaunchProfileInitializationOutput

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

{ "launchProfileInitialization": { "launchProfileId": "string", "name": "string", "platform": enum, "launchProfileProtocolVersion": "string", "launchPurpose": "string", "ec2SecurityGroupIds": [ "string" ], "activeDirectory": { "studioComponentId": "string", "studioComponentName": "string", "directoryId": "string", "directoryName": "string", "dnsIpAddresses": [ "string" ], "organizationalUnitDistinguishedName": "string", "computerAttributes": [ { "name": "string", "value": "string" } ] }, "systemInitializationScripts": [ { "studioComponentId": "string", "studioComponentName": "string", "script": "string" } ], "userInitializationScripts": [ { "studioComponentId": "string", "studioComponentName": "string", "script": "string" } ] } }
{ "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.

ActiveDirectoryComputerAttribute

An LDAP attribute of an Active Directory computer account, in the form of a name:value pair.

Property Type Required Description
name

string

False

The name for the LDAP attribute.

value

string

False

The value for the LDAP attribute.

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

GetLaunchProfileInitializationOutput

Property Type Required Description
launchProfileInitialization

LaunchProfileInitialization

False

The launch profile initialization.

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.

LaunchProfileInitialization

Property Type Required Description
launchProfileId

string

False

The launch profile ID.

name

string

False

The name for the launch profile.

platform

LaunchProfilePlatform

False

The platform of the launch platform, either WINDOWS or LINUX.

launchProfileProtocolVersion

string

False

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

launchPurpose

string

False

The launch purpose.

ec2SecurityGroupIds

Array of type string

False

The EC2 security groups that control access to the studio component.

activeDirectory

LaunchProfileInitializationActiveDirectory

False

A LaunchProfileInitializationActiveDirectory resource.

systemInitializationScripts

Array of type LaunchProfileInitializationScript

False

The system initializtion scripts.

userInitializationScripts

Array of type LaunchProfileInitializationScript

False

The user initializtion scripts.

LaunchProfileInitializationActiveDirectory

Property Type Required Description
studioComponentId

string

False

The unique identifier for a studio component resource.

studioComponentName

string

False

The name for the studio component.

directoryId

string

False

The directory ID of the AWS Directory Service for Microsoft Active Directory to access using this launch profile.

directoryName

string

False

The directory name.

dnsIpAddresses

Array of type string

False

The DNS IP address.

organizationalUnitDistinguishedName

string

False

The name for the organizational unit distinguished name.

computerAttributes

Array of type ActiveDirectoryComputerAttribute

False

A collection of custom attributes for an Active Directory computer.

LaunchProfileInitializationScript

Property Type Required Description
studioComponentId

string

False

The unique identifier for a studio component resource.

studioComponentName

string

False

The name for the studio component.

script

string

False

The initialization script.

LaunchProfilePlatform

  • LINUX

  • WINDOWS

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.

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:

GetLaunchProfileInitialization