AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . nimble ]

get-launch-profile-initialization

Description

Get a launch profile initialization.

See also: AWS API Documentation

Synopsis

  get-launch-profile-initialization
--launch-profile-id <value>
--launch-profile-protocol-versions <value>
--launch-purpose <value>
--platform <value>
--studio-id <value>
[--cli-input-json <value>]
[--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>]

Options

--launch-profile-id (string)

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

--launch-profile-protocol-versions (list)

The launch profile protocol versions supported by the client.

(string)

Syntax:

"string" "string" ...

--launch-purpose (string)

The launch purpose.

--platform (string)

The platform where this Launch Profile will be used, either Windows or Linux.

--studio-id (string)

The studio ID.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

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

Output

launchProfileInitialization -> (structure)

The launch profile initialization.

activeDirectory -> (structure)

A LaunchProfileInitializationActiveDirectory resource.

computerAttributes -> (list)

A collection of custom attributes for an Active Directory computer.

(structure)

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

name -> (string)

The name for the LDAP attribute.

value -> (string)

The value for the LDAP attribute.

directoryId -> (string)

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

directoryName -> (string)

The directory name.

dnsIpAddresses -> (list)

The DNS IP address.

(string)

organizationalUnitDistinguishedName -> (string)

The name for the organizational unit distinguished name.

studioComponentId -> (string)

The unique identifier for a studio component resource.

studioComponentName -> (string)

The name for the studio component.

ec2SecurityGroupIds -> (list)

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

(string)

launchProfileId -> (string)

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

launchProfileProtocolVersion -> (string)

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

launchPurpose -> (string)

The launch purpose.

name -> (string)

The name for the launch profile.

platform -> (string)

The platform of the launch platform, either Windows or Linux.

systemInitializationScripts -> (list)

The system initializtion scripts.

(structure)

The launch profile initialization script is used when start streaming session runs.

runtimeRoleArn -> (string)

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

script -> (string)

The initialization script.

secureInitializationRoleArn -> (string)

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

studioComponentId -> (string)

The unique identifier for a studio component resource.

studioComponentName -> (string)

The name for the studio component.

userInitializationScripts -> (list)

The user initializtion scripts.

(structure)

The launch profile initialization script is used when start streaming session runs.

runtimeRoleArn -> (string)

An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running.

script -> (string)

The initialization script.

secureInitializationRoleArn -> (string)

An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.

studioComponentId -> (string)

The unique identifier for a studio component resource.

studioComponentName -> (string)

The name for the studio component.