get-launch-profile¶
Description¶
Get a launch profile.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-launch-profile
--launch-profile-id <value>
--studio-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--launch-profile-id (string)
The launch profile ID.
--studio-id (string)
The studio ID.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
launchProfile -> (structure)
The launch profile.
arn -> (string)
The ARN of the resource.
createdAt -> (timestamp)
The Unix epoch timestamp in seconds for when the resource was created.
createdBy -> (string)
The user ID of the user that created the launch profile.
description -> (string)
A human-readable description of the launch profile.
ec2SubnetIds -> (list)
Unique identifiers for a collection of EC2 subnets.
(string)
launchProfileId -> (string)
The launch profile ID.
launchProfileProtocolVersions -> (list)
The version number of the protocol that is used by the launch profile. The only valid version is “2021-03-31”.
(string)
The version number of the protocol that is used by the launch profile. The only valid version is “2021-03-31”.
name -> (string)
A friendly name for the launch profile.
state -> (string)
The current state.
statusCode -> (string)
The status code.
statusMessage -> (string)
The status message for the launch profile.
streamConfiguration -> (structure)
A configuration for a streaming session.
clipboardMode -> (string)
Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
ec2InstanceTypes -> (list)
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
(string)
maxSessionLengthInMinutes -> (integer)
The length of time, in minutes, that a streaming session can run. After this point, Nimble Studio automatically terminates the session.
streamingImageIds -> (list)
The streaming images that users can select from when launching a streaming session with this launch profile.
(string)
studioComponentIds -> (list)
Unique identifiers for a collection of studio components that can be used with this launch profile.
(string)
tags -> (map)
A collection of labels, in the form of key:value pairs, that apply to this resource.
key -> (string)
value -> (string)
updatedAt -> (timestamp)
The Unix epoch timestamp in seconds for when the resource was updated.
updatedBy -> (string)
The user ID of the user that most recently updated the resource.