list-launch-profiles¶
Description¶
List all the launch profiles a studio.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
list-launch-profiles is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.
When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: launchProfiles
Synopsis¶
list-launch-profiles
[--principal-id <value>]
[--states <value>]
--studio-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
Options¶
--principal-id (string)
The principal ID. This currently supports a Amazon Web Services SSO UserId.
--states (list)
Filter this request to launch profiles in any of the given states.
(string)
Syntax:
"string" "string" ...
Where valid values are:
CREATE_IN_PROGRESS
READY
UPDATE_IN_PROGRESS
DELETE_IN_PROGRESS
DELETED
DELETE_FAILED
CREATE_FAILED
UPDATE_FAILED
--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.
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size (integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items (integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextTokenis provided in the command’s output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To list the available widgets
The following list-launch-profiles example lists the launch profiles in your AWS account.
aws nimble list-launch-profiles \
--studio-id "StudioID"
Output:
{
"launchProfiles": [
{
"arn": "arn:aws:nimble:us-west-2:123456789012:launch-profile/yeG7lDwNQEiwNTRT7DrV7Q",
"createdAt": "2022-01-27T21:18:59+00:00",
"createdBy": "AROA3OO2NEHCCYRNDDIFT:i-EXAMPLE11111",
"description": "The Launch Profile for the Render workers created by StudioBuilder.",
"ec2SubnetIds": [
"subnet-EXAMPLE11111"
],
"launchProfileId": "yeG7lDwNQEiwNTRT7DrV7Q",
"launchProfileProtocolVersions": [
"2021-03-31"
],
"name": "RenderWorker-Default",
"state": "READY",
"statusCode": "LAUNCH_PROFILE_CREATED",
"statusMessage": "Launch Profile has been created",
"streamConfiguration": {
"clipboardMode": "ENABLED",
"ec2InstanceTypes": [
"g4dn.4xlarge",
"g4dn.8xlarge"
],
"maxSessionLengthInMinutes": 690,
"maxStoppedSessionLengthInMinutes": 0,
"streamingImageIds": [
"Cw_jXnp1QcSSXhE2hkNRoQ",
"YGXAqgoWTnCNSV8VP20sHQ"
]
},
"studioComponentIds": [
"_hR_-RaAReSOjAnLakbX7Q",
"vQ5w_TbIRayPkAZgcbyYRA",
"ZQuMxN99Qfa_Js6ma9TwdA",
"45KjOSPPRzK2OyvpCuQ6qw"
],
"tags": {},
"updatedAt": "2022-01-27T21:19:13+00:00",
"updatedBy": "AROA3OO2NEHCCYRNDDIFT:i-EXAMPLE11111",
"validationResults": [
{
"state": "VALIDATION_SUCCESS",
"statusCode": "VALIDATION_SUCCESS",
"statusMessage": "The validation succeeded.",
"type": "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT"
},
{
"state": "VALIDATION_SUCCESS",
"statusCode": "VALIDATION_SUCCESS",
"statusMessage": "The validation succeeded.",
"type": "VALIDATE_SUBNET_ASSOCIATION"
},
{
"state": "VALIDATION_SUCCESS",
"statusCode": "VALIDATION_SUCCESS",
"statusMessage": "The validation succeeded.",
"type": "VALIDATE_NETWORK_ACL_ASSOCIATION"
},
{
"state": "VALIDATION_SUCCESS",
"statusCode": "VALIDATION_SUCCESS",
"statusMessage": "The validation succeeded.",
"type": "VALIDATE_SECURITY_GROUP_ASSOCIATION"
}
]
},
{
"arn": "arn:aws:nimble:us-west-2:123456789012:launch-profile/jDCIm1jRSaa9e44PZ3w7gg",
"createdAt": "2022-01-27T21:19:26+00:00",
"createdBy": "AROA3OO2NEHCCYRNDDIFT:i-EXAMPLE11111",
"description": "This Workstation Launch Profile was created by StudioBuilder",
"ec2SubnetIds": [
"subnet-046f4205ae535b2cc"
],
"launchProfileId": "jDCIm1jRSaa9e44PZ3w7gg",
"launchProfileProtocolVersions": [
"2021-03-31"
],
"name": "Workstation-Default",
"state": "READY",
"statusCode": "LAUNCH_PROFILE_CREATED",
"statusMessage": "Launch Profile has been created",
"streamConfiguration": {
"clipboardMode": "ENABLED",
"ec2InstanceTypes": [
"g4dn.4xlarge",
"g4dn.8xlarge"
],
"maxSessionLengthInMinutes": 690,
"maxStoppedSessionLengthInMinutes": 0,
"streamingImageIds": [
"Cw_jXnp1QcSSXhE2hkNRoQ",
"YGXAqgoWTnCNSV8VP20sHQ"
]
},
"studioComponentIds": [
"_hR_-RaAReSOjAnLakbX7Q",
"vQ5w_TbIRayPkAZgcbyYRA",
"ZQuMxN99Qfa_Js6ma9TwdA",
"yJSbsHXAQYWk9FXLNusXlQ",
"45KjOSPPRzK2OyvpCuQ6qw"
],
"tags": {},
"updatedAt": "2022-01-27T21:19:40+00:00",
"updatedBy": "AROA3OO2NEHCCYRNDDIFT:i-EXAMPLE11111",
"validationResults": [
{
"state": "VALIDATION_SUCCESS",
"statusCode": "VALIDATION_SUCCESS",
"statusMessage": "The validation succeeded.",
"type": "VALIDATE_ACTIVE_DIRECTORY_STUDIO_COMPONENT"
},
{
"state": "VALIDATION_SUCCESS",
"statusCode": "VALIDATION_SUCCESS",
"statusMessage": "The validation succeeded.",
"type": "VALIDATE_SUBNET_ASSOCIATION"
},
{
"state": "VALIDATION_SUCCESS",
"statusCode": "VALIDATION_SUCCESS",
"statusMessage": "The validation succeeded.",
"type": "VALIDATE_NETWORK_ACL_ASSOCIATION"
},
{
"state": "VALIDATION_SUCCESS",
"statusCode": "VALIDATION_SUCCESS",
"statusMessage": "The validation succeeded.",
"type": "VALIDATE_SECURITY_GROUP_ASSOCIATION"
}
]
}
]
}
For more information, see Creating launch profiles in the Amazon Nimble Studio User Guide.
Output¶
launchProfiles -> (list)
A collection of launch profiles.
(structure)
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).
<p>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.</p>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 be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
maxStoppedSessionLengthInMinutes -> (integer)
Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
If the value is missing or set to 0, your sessions can’t be stopped. If you then call
StopStreamingSession, the session fails. If the time that a session stays in the READY state exceeds themaxSessionLengthInMinutesvalue, the session will automatically be terminated (instead of stopped).If the value is set to a positive number, the session can be stopped. You can call
StopStreamingSessionto stop sessions in the READY state. If the time that a session stays in the READY state exceeds themaxSessionLengthInMinutesvalue, the session will automatically be stopped (instead of terminated).sessionStorage -> (structure)
(Optional) The upload storage for a streaming session.
mode -> (list)
Allows artists to upload files to their workstations. The only valid option is
UPLOAD.(string)
root -> (structure)
The configuration for the upload storage root of the streaming session.
linux -> (string)
The folder path in Linux workstations where files are uploaded.
windows -> (string)
The folder path in Windows workstations where files are uploaded.
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.
validationResults -> (list)
The list of the latest validation results.
(structure)
The launch profile validation result.
state -> (string)
The current state.
statusCode -> (string)
The status code. This will contain the failure reason if the state is
VALIDATION_FAILED.statusMessage -> (string)
The status message for the validation result.
type -> (string)
The type of the validation result.
nextToken -> (string)
The token for the next set of results, or null if there are no more results.