AWS CLI Command Reference

[ aws . nimble ]

get-launch-profile

Description

Get a launch profile.

See also: AWS API Documentation

Synopsis

  get-launch-profile
--launch-profile-id <value>
--studio-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--launch-profile-id (string)

The ID of the launch profile used to control access from the streaming session.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input 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 get-launch-profile example lists information about a launch profile.

aws nimble get-launch-profile \
    --studio-id "StudioID" \
    --launch-profile-id "LaunchProfileID"

Output:

{
    "launchProfile": {
        "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-00b98256b04d9e989",
        "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

launchProfile -> (structure)

The launch profile.

arn -> (string)

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

createdAt -> (timestamp)

The ISO 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 ID of the launch profile used to control access from the streaming session.

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.

automaticTerminationMode -> (string)

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

  • When ACTIVATED , the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes .
  • When DEACTIVATED , the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When allowed, the default value for this parameter is DEACTIVATED .

clipboardMode -> (string)

Allows or deactivates 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.

This field is allowed only when sessionPersistenceMode is ACTIVATED and automaticTerminationMode is ACTIVATED .

If the value is 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 the maxSessionLengthInMinutes value, 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 StopStreamingSession to stop sessions in the READY state. If the time that a session stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will automatically be stopped (instead of terminated).

sessionBackup -> (structure)

Information about the streaming session backup.

maxBackupsToRetain -> (integer)

The maximum number of backups that each streaming session created from this launch profile can have.

mode -> (string)

Specifies how artists sessions are backed up.

Configures backups for streaming sessions launched with this launch profile. The default value is DEACTIVATED , which means that backups are deactivated. To allow backups, set this value to AUTOMATIC .

sessionPersistenceMode -> (string)

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

sessionStorage -> (structure)

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)

volumeConfiguration -> (structure)

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED .

iops -> (integer)

The number of I/O operations per second for the root volume that is attached to streaming session.

size -> (integer)

The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.

throughput -> (integer)

The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.

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 ISO 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.
© Copyright 2018, Amazon Web Services. Created using Sphinx.