AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Nimble Studio UpdateLaunchProfile API operation.

Syntax

Update-NSLaunchProfile
-LaunchProfileId <String>
-StreamConfiguration_AutomaticTerminationMode <AutomaticTerminationMode>
-StreamConfiguration_ClipboardMode <StreamingClipboardMode>
-Description <String>
-StreamConfiguration_Ec2InstanceType <String[]>
-VolumeConfiguration_Iops <Int32>
-LaunchProfileProtocolVersion <String[]>
-Root_Linux <String>
-SessionBackup_MaxBackupsToRetain <Int32>
-StreamConfiguration_MaxSessionLengthInMinute <Int32>
-StreamConfiguration_MaxStoppedSessionLengthInMinute <Int32>
-SessionBackup_Mode <SessionBackupMode>
-SessionStorage_Mode <String[]>
-Name <String>
-StreamConfiguration_SessionPersistenceMode <SessionPersistenceMode>
-VolumeConfiguration_Size <Int32>
-StreamConfiguration_StreamingImageId <String[]>
-StudioComponentId <String[]>
-StudioId <String>
-VolumeConfiguration_Throughput <Int32>
-Root_Window <String>
-ClientToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonNimbleStudioConfig>

Description

Update a launch profile.

Parameters

-ClientConfig <AmazonNimbleStudioConfig>
Amazon.PowerShell.Cmdlets.NS.AmazonNimbleStudioClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The description.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LaunchProfileId <String>
The ID of the launch profile used to control access from the streaming session.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-LaunchProfileProtocolVersion <String[]>
The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLaunchProfileProtocolVersions
-Name <String>
The name for the launch profile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the LaunchProfileId parameter. The -PassThru parameter is deprecated, use -Select '^LaunchProfileId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Root_Linux <String>
The folder path in Linux workstations where files are uploaded.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamConfiguration_SessionStorage_Root_Linux
-Root_Window <String>
The folder path in Windows workstations where files are uploaded.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamConfiguration_SessionStorage_Root_Windows
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'LaunchProfile'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.UpdateLaunchProfileResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.UpdateLaunchProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SessionBackup_MaxBackupsToRetain <Int32>
The maximum number of backups that each streaming session created from this launch profile can have.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamConfiguration_SessionBackup_MaxBackupsToRetain
-SessionBackup_Mode <SessionBackupMode>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamConfiguration_SessionBackup_Mode
-SessionStorage_Mode <String[]>
Allows artists to upload files to their workstations. The only valid option is UPLOAD.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamConfiguration_SessionStorage_Mode
-StreamConfiguration_AutomaticTerminationMode <AutomaticTerminationMode>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StreamConfiguration_ClipboardMode <StreamingClipboardMode>
Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StreamConfiguration_Ec2InstanceType <String[]>
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamConfiguration_Ec2InstanceTypes
-StreamConfiguration_MaxSessionLengthInMinute <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamConfiguration_MaxSessionLengthInMinutes
-StreamConfiguration_MaxStoppedSessionLengthInMinute <Int32>
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).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamConfiguration_MaxStoppedSessionLengthInMinutes
-StreamConfiguration_SessionPersistenceMode <SessionPersistenceMode>
Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StreamConfiguration_StreamingImageId <String[]>
The streaming images that users can select from when launching a streaming session with this launch profile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamConfiguration_StreamingImageIds
-StudioComponentId <String[]>
Unique identifiers for a collection of studio components that can be used with this launch profile.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStudioComponentIds
-StudioId <String>
The studio ID.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VolumeConfiguration_Iops <Int32>
The number of I/O operations per second for the root volume that is attached to streaming session.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamConfiguration_VolumeConfiguration_Iops
-VolumeConfiguration_Size <Int32>
The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamConfiguration_VolumeConfiguration_Size
-VolumeConfiguration_Throughput <Int32>
The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStreamConfiguration_VolumeConfiguration_Throughput

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.NimbleStudio.Model.LaunchProfile or Amazon.NimbleStudio.Model.UpdateLaunchProfileResponse
This cmdlet returns an Amazon.NimbleStudio.Model.LaunchProfile object. The service call response (type Amazon.NimbleStudio.Model.UpdateLaunchProfileResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z