AWS.Tools.NimbleStudio.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.NimbleStudio</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.NS.AddNSResourceTagCmdlet"> <summary> Creates tags for a resource, given its ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.AddNSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource you want to add tags to. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.AddNSResourceTagCmdlet.Tag"> <summary> <para> <para>A collection of labels, in the form of key-value pairs, that apply to this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.AddNSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.AddNSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.AddNSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.ApproveNSEulaCmdlet"> <summary> Accept EULAs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.ApproveNSEulaCmdlet.EulaId"> <summary> <para> <para>The EULA ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.ApproveNSEulaCmdlet.StudioId"> <summary> <para> <para>The studio ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.ApproveNSEulaCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.ApproveNSEulaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EulaAcceptances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.AcceptEulasResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.AcceptEulasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.ApproveNSEulaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.ApproveNSEulaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSEulaCmdlet"> <summary> Get EULA. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSEulaCmdlet.EulaId"> <summary> <para> <para>The EULA ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSEulaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Eula'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.GetEulaResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.GetEulaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSEulaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EulaId parameter. The -PassThru parameter is deprecated, use -Select '^EulaId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSEulaAcceptanceListCmdlet"> <summary> List EULA acceptances. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSEulaAcceptanceListCmdlet.EulaId"> <summary> <para> <para>The list of EULA IDs that have been previously accepted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSEulaAcceptanceListCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSEulaAcceptanceListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSEulaAcceptanceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EulaAcceptances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.ListEulaAcceptancesResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.ListEulaAcceptancesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSEulaAcceptanceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSEulaListCmdlet"> <summary> List EULAs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSEulaListCmdlet.EulaId"> <summary> <para> <para>The list of EULA IDs that should be returned</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSEulaListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSEulaListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Eulas'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.ListEulasResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.ListEulasResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileCmdlet"> <summary> Get a launch profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileCmdlet.LaunchProfileId"> <summary> <para> <para>The ID of the launch profile used to control access from the streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileCmdlet.Select"> <summary> 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.GetLaunchProfileResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.GetLaunchProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileDetailCmdlet"> <summary> Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileDetailCmdlet.LaunchProfileId"> <summary> <para> <para>The ID of the launch profile used to control access from the streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileDetailCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileDetailCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.GetLaunchProfileDetailsResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.GetLaunchProfileDetailsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileDetailCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileInitializationCmdlet"> <summary> Get a launch profile initialization. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileInitializationCmdlet.LaunchProfileId"> <summary> <para> <para>The ID of the launch profile used to control access from the streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileInitializationCmdlet.LaunchProfileProtocolVersion"> <summary> <para> <para>The launch profile protocol versions supported by the client.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileInitializationCmdlet.LaunchPurpose"> <summary> <para> <para>The launch purpose.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileInitializationCmdlet.Platform"> <summary> <para> <para>The platform where this Launch Profile will be used, either Windows or Linux.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileInitializationCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileInitializationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LaunchProfileInitialization'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.GetLaunchProfileInitializationResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.GetLaunchProfileInitializationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileInitializationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileListCmdlet"> <summary> List all the launch profiles a studio. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileListCmdlet.PrincipalId"> <summary> <para> <para>The principal ID. This currently supports a IAM Identity Center UserId. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileListCmdlet.State"> <summary> <para> <para>Filter this request to launch profiles in any of the given states.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileListCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileListCmdlet.MaxResult"> <summary> <para> <para>The max number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LaunchProfiles'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.ListLaunchProfilesResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.ListLaunchProfilesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileMemberCmdlet"> <summary> Get a user persona in launch profile membership. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileMemberCmdlet.LaunchProfileId"> <summary> <para> <para>The ID of the launch profile used to control access from the streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileMemberCmdlet.PrincipalId"> <summary> <para> <para>The principal ID. This currently supports a IAM Identity Center UserId. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileMemberCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileMemberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Member'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.GetLaunchProfileMemberResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.GetLaunchProfileMemberResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileMemberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PrincipalId parameter. The -PassThru parameter is deprecated, use -Select '^PrincipalId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileMemberListCmdlet"> <summary> Get all users in a given launch profile membership. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileMemberListCmdlet.LaunchProfileId"> <summary> <para> <para>The ID of the launch profile used to control access from the streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileMemberListCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileMemberListCmdlet.MaxResult"> <summary> <para> <para>The max number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileMemberListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileMemberListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Members'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.ListLaunchProfileMembersResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.ListLaunchProfileMembersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSLaunchProfileMemberListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSResourceTagCmdlet"> <summary> Gets the tags for a resource, given its Amazon Resource Names (ARN). <para> This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource for which you want to list tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingImageCmdlet"> <summary> Get streaming image. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingImageCmdlet.StreamingImageId"> <summary> <para> <para>The streaming image ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingImageCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingImageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamingImage'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.GetStreamingImageResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.GetStreamingImageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingImageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StreamingImageId parameter. The -PassThru parameter is deprecated, use -Select '^StreamingImageId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingImageListCmdlet"> <summary> List the streaming image resources available to this studio. <para> This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingImageListCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingImageListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingImageListCmdlet.Owner"> <summary> <para> <para>Filter this request to streaming images with the given owner</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingImageListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamingImages'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.ListStreamingImagesResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.ListStreamingImagesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingImageListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionCmdlet"> <summary> Gets StreamingSession resource. <para> Invoke this operation to poll for a streaming session state while creating or deleting a session. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionCmdlet.SessionId"> <summary> <para> <para>The streaming session ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Session'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.GetStreamingSessionResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.GetStreamingSessionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionBackupCmdlet"> <summary> Gets <c>StreamingSessionBackup</c> resource. <para> Invoke this operation to poll for a streaming session backup while stopping a streaming session. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionBackupCmdlet.BackupId"> <summary> <para> <para>The ID of the backup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionBackupCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionBackupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamingSessionBackup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.GetStreamingSessionBackupResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.GetStreamingSessionBackupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionBackupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BackupId parameter. The -PassThru parameter is deprecated, use -Select '^BackupId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionBackupListCmdlet"> <summary> Lists the backups of a streaming session in a studio. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionBackupListCmdlet.OwnedBy"> <summary> <para> <para>The user ID of the user that owns the streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionBackupListCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionBackupListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionBackupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamingSessionBackups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.ListStreamingSessionBackupsResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.ListStreamingSessionBackupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionBackupListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionListCmdlet"> <summary> Lists the streaming sessions in a studio. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionListCmdlet.CreatedBy"> <summary> <para> <para>Filters the request to streaming sessions created by the given user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionListCmdlet.OwnedBy"> <summary> <para> <para>Filters the request to streaming session owned by the given user</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionListCmdlet.SessionId"> <summary> <para> <para>Filters the request to only the provided session IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionListCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Sessions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.ListStreamingSessionsResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.ListStreamingSessionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionStreamCmdlet"> <summary> Gets a StreamingSessionStream for a streaming session. <para> Invoke this operation to poll the resource after invoking <c>CreateStreamingSessionStream</c>. </para><para> After the <c>StreamingSessionStream</c> changes to the <c>READY</c> state, the url property will contain a stream to be used with the DCV streaming client. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionStreamCmdlet.SessionId"> <summary> <para> <para>The streaming session ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionStreamCmdlet.StreamId"> <summary> <para> <para>The streaming session stream ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionStreamCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionStreamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Stream'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.GetStreamingSessionStreamResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.GetStreamingSessionStreamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStreamingSessionStreamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StreamId parameter. The -PassThru parameter is deprecated, use -Select '^StreamId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSStudioCmdlet"> <summary> Get a studio resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Studio'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.GetStudioResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.GetStudioResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSStudioComponentCmdlet"> <summary> Gets a studio component resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioComponentCmdlet.StudioComponentId"> <summary> <para> <para>The studio component ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioComponentCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StudioComponent'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.GetStudioComponentResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.GetStudioComponentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioComponentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioComponentId parameter. The -PassThru parameter is deprecated, use -Select '^StudioComponentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSStudioComponentListCmdlet"> <summary> Lists the <c>StudioComponents</c> in a studio. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioComponentListCmdlet.State"> <summary> <para> <para>Filters the request to studio components that are in one of the given states. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioComponentListCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioComponentListCmdlet.Type"> <summary> <para> <para>Filters the request to studio components that are of one of the given types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioComponentListCmdlet.MaxResult"> <summary> <para> <para>The max number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioComponentListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioComponentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StudioComponents'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.ListStudioComponentsResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.ListStudioComponentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioComponentListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSStudioListCmdlet"> <summary> List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Studios'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.ListStudiosResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.ListStudiosResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSStudioMemberCmdlet"> <summary> Get a user's membership in a studio. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioMemberCmdlet.PrincipalId"> <summary> <para> <para>The principal ID. This currently supports a IAM Identity Center UserId. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioMemberCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioMemberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Member'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.GetStudioMemberResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.GetStudioMemberResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioMemberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PrincipalId parameter. The -PassThru parameter is deprecated, use -Select '^PrincipalId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.GetNSStudioMemberListCmdlet"> <summary> Get all users in a given studio membership. <note><para><c>ListStudioMembers</c> only returns admin members. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioMemberListCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioMemberListCmdlet.MaxResult"> <summary> <para> <para>The max number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioMemberListCmdlet.NextToken"> <summary> <para> <para>The token for the next set of results, or null if there are no more results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioMemberListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Members'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.ListStudioMembersResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.ListStudioMembersResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.GetNSStudioMemberListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet"> <summary> Create a launch profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.StreamConfiguration_AutomaticTerminationMode"> <summary> <para> <para>Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a <c>STOPPED</c> state.</para><ul><li><para>When <c>ACTIVATED</c>, the streaming session is scheduled for termination after being in the <c>STOPPED</c> state for the time specified in <c>maxStoppedSessionLengthInMinutes</c>.</para></li><li><para>When <c>DEACTIVATED</c>, the streaming session can remain in the <c>STOPPED</c> state indefinitely.</para></li></ul><para>This parameter is only allowed when <c>sessionPersistenceMode</c> is <c>ACTIVATED</c>. When allowed, the default value for this parameter is <c>DEACTIVATED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.StreamConfiguration_ClipboardMode"> <summary> <para> <para>Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.Description"> <summary> <para> <para>The description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.StreamConfiguration_Ec2InstanceType"> <summary> <para> <para>The EC2 instance types that users can select from when launching a streaming session with this launch profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.Ec2SubnetId"> <summary> <para> <para>Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.VolumeConfiguration_Iops"> <summary> <para> <para>The number of I/O operations per second for the root volume that is attached to streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.LaunchProfileProtocolVersion"> <summary> <para> <para>The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.Root_Linux"> <summary> <para> <para>The folder path in Linux workstations where files are uploaded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.SessionBackup_MaxBackupsToRetain"> <summary> <para> <para>The maximum number of backups that each streaming session created from this launch profile can have.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.StreamConfiguration_MaxSessionLengthInMinute"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.StreamConfiguration_MaxStoppedSessionLengthInMinute"> <summary> <para> <para>Integer that determines if you can start and stop your sessions and how long a session can stay in the <c>STOPPED</c> state. The default value is 0. The maximum value is 5760.</para><para>This field is allowed only when <c>sessionPersistenceMode</c> is <c>ACTIVATED</c> and <c>automaticTerminationMode</c> is <c>ACTIVATED</c>.</para><para>If the value is set to 0, your sessions can’t be <c>STOPPED</c>. If you then call <c>StopStreamingSession</c>, the session fails. If the time that a session stays in the <c>READY</c> state exceeds the <c>maxSessionLengthInMinutes</c> value, the session will automatically be terminated (instead of <c>STOPPED</c>).</para><para>If the value is set to a positive number, the session can be stopped. You can call <c>StopStreamingSession</c> to stop sessions in the <c>READY</c> state. If the time that a session stays in the <c>READY</c> state exceeds the <c>maxSessionLengthInMinutes</c> value, the session will automatically be stopped (instead of terminated).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.SessionBackup_Mode"> <summary> <para> <para>Specifies how artists sessions are backed up.</para><para>Configures backups for streaming sessions launched with this launch profile. The default value is <c>DEACTIVATED</c>, which means that backups are deactivated. To allow backups, set this value to <c>AUTOMATIC</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.SessionStorage_Mode"> <summary> <para> <para>Allows artists to upload files to their workstations. The only valid option is <c>UPLOAD</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.Name"> <summary> <para> <para>The name for the launch profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.StreamConfiguration_SessionPersistenceMode"> <summary> <para> <para>Determine if a streaming session created from this launch profile can configure persistent storage. This means that <c>volumeConfiguration</c> and <c>automaticTerminationMode</c> are configured.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.VolumeConfiguration_Size"> <summary> <para> <para>The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.StreamConfiguration_StreamingImageId"> <summary> <para> <para>The streaming images that users can select from when launching a streaming session with this launch profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.StudioComponentId"> <summary> <para> <para>Unique identifiers for a collection of studio components that can be used with this launch profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.Tag"> <summary> <para> <para>A collection of labels, in the form of key-value pairs, that apply to this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.VolumeConfiguration_Throughput"> <summary> <para> <para>The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.Root_Window"> <summary> <para> <para>The folder path in Windows workstations where files are uploaded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.Select"> <summary> 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.CreateLaunchProfileResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.CreateLaunchProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSLaunchProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingImageCmdlet"> <summary> Creates a streaming image resource in a studio. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingImageCmdlet.Description"> <summary> <para> <para>A human-readable description of the streaming image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingImageCmdlet.Ec2ImageId"> <summary> <para> <para>The ID of an EC2 machine image with which to create this streaming image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingImageCmdlet.Name"> <summary> <para> <para>A friendly name for a streaming image resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingImageCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingImageCmdlet.Tag"> <summary> <para> <para>A collection of labels, in the form of key-value pairs, that apply to this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingImageCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingImageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamingImage'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.CreateStreamingImageResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.CreateStreamingImageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingImageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingImageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionCmdlet"> <summary> Creates a streaming session in a studio. <para> After invoking this operation, you must poll GetStreamingSession until the streaming session is in the <c>READY</c> state. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionCmdlet.Ec2InstanceType"> <summary> <para> <para>The EC2 Instance type used for the streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionCmdlet.LaunchProfileId"> <summary> <para> <para>The ID of the launch profile used to control access from the streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionCmdlet.OwnedBy"> <summary> <para> <para>The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionCmdlet.StreamingImageId"> <summary> <para> <para>The ID of the streaming image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionCmdlet.Tag"> <summary> <para> <para>A collection of labels, in the form of key-value pairs, that apply to this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Session'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.CreateStreamingSessionResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.CreateStreamingSessionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionStreamCmdlet"> <summary> Creates a streaming session stream for a streaming session. <para> After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in the <c>READY</c> state. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionStreamCmdlet.ExpirationInSecond"> <summary> <para> <para>The expiration time in seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionStreamCmdlet.SessionId"> <summary> <para> <para>The streaming session ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionStreamCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionStreamCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionStreamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Stream'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.CreateStreamingSessionStreamResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.CreateStreamingSessionStreamResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionStreamCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStreamingSessionStreamCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.NewNSStudioCmdlet"> <summary> Create a new studio. <para> When creating a studio, two IAM roles must be provided: the admin role and the user role. These roles are assumed by your users when they log in to the Nimble Studio portal. </para><para> The user role must have the <c>AmazonNimbleStudio-StudioUser</c> managed policy attached for the portal to function properly. </para><para> The admin role must have the <c>AmazonNimbleStudio-StudioAdmin</c> managed policy attached for the portal to function properly. </para><para> You may optionally specify a KMS key in the <c>StudioEncryptionConfiguration</c>. </para><para> In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling <c>CreateStudio</c> to encrypt this data using a key you own and manage. </para><para> When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys. </para><para> If you delete this grant, the studio will no longer be accessible to your portal users. </para><para> If you delete the studio KMS key, your studio will no longer be accessible. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioCmdlet.AdminRoleArn"> <summary> <para> <para>The IAM role that studio admins will assume when logging in to the Nimble Studio portal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioCmdlet.DisplayName"> <summary> <para> <para>A friendly name for the studio.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioCmdlet.StudioEncryptionConfiguration_KeyArn"> <summary> <para> <para>The ARN for a KMS key that is used to encrypt studio data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioCmdlet.StudioEncryptionConfiguration_KeyType"> <summary> <para> <para>The type of KMS key that is used to encrypt studio data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioCmdlet.StudioName"> <summary> <para> <para>The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioCmdlet.Tag"> <summary> <para> <para>A collection of labels, in the form of key-value pairs, that apply to this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioCmdlet.UserRoleArn"> <summary> <para> <para>The IAM role that studio users will assume when logging in to the Nimble Studio portal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Studio'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.CreateStudioResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.CreateStudioResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet"> <summary> Creates a studio component resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.ComputeFarmConfiguration_ActiveDirectoryUser"> <summary> <para> <para>The name of an Active Directory user that is used on ComputeFarm worker instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.ActiveDirectoryConfiguration_ComputerAttribute"> <summary> <para> <para>A collection of custom attributes for an Active Directory computer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.Description"> <summary> <para> <para>The description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.ActiveDirectoryConfiguration_DirectoryId"> <summary> <para> <para>The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.Ec2SecurityGroupId"> <summary> <para> <para>The EC2 security groups that control access to the studio component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.ComputeFarmConfiguration_Endpoint"> <summary> <para> <para>The endpoint of the ComputeFarm that is accessed by the studio component resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.LicenseServiceConfiguration_Endpoint"> <summary> <para> <para>The endpoint of the license service that is accessed by the studio component resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.SharedFileSystemConfiguration_Endpoint"> <summary> <para> <para>The endpoint of the shared file system that is accessed by the studio component resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.SharedFileSystemConfiguration_FileSystemId"> <summary> <para> <para>The unique identifier for a file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.InitializationScript"> <summary> <para> <para>Initialization scripts for studio components.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.SharedFileSystemConfiguration_LinuxMountPoint"> <summary> <para> <para>The mount location for a shared file system on a Linux virtual workstation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.Name"> <summary> <para> <para>The name for the studio component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.ActiveDirectoryConfiguration_OrganizationalUnitDistinguishedName"> <summary> <para> <para>The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.RuntimeRoleArn"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.ScriptParameter"> <summary> <para> <para>Parameters for the studio component scripts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.SecureInitializationRoleArn"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.SharedFileSystemConfiguration_ShareName"> <summary> <para> <para>The name of the file share.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.Subtype"> <summary> <para> <para>The specific subtype of a studio component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.Tag"> <summary> <para> <para>A collection of labels, in the form of key-value pairs, that apply to this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.Type"> <summary> <para> <para>The type of the studio component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.SharedFileSystemConfiguration_WindowsMountDrive"> <summary> <para> <para>The mount location for a shared file system on a Windows virtual workstation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StudioComponent'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.CreateStudioComponentResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.CreateStudioComponentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.NewNSStudioComponentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.RemoveNSLaunchProfileCmdlet"> <summary> Permanently delete a launch profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSLaunchProfileCmdlet.LaunchProfileId"> <summary> <para> <para>The ID of the launch profile used to control access from the streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSLaunchProfileCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSLaunchProfileCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSLaunchProfileCmdlet.Select"> <summary> 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.DeleteLaunchProfileResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.DeleteLaunchProfileResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSLaunchProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSLaunchProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.RemoveNSLaunchProfileMemberCmdlet"> <summary> Delete a user from launch profile membership. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSLaunchProfileMemberCmdlet.LaunchProfileId"> <summary> <para> <para>The ID of the launch profile used to control access from the streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSLaunchProfileMemberCmdlet.PrincipalId"> <summary> <para> <para>The principal ID. This currently supports a IAM Identity Center UserId. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSLaunchProfileMemberCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSLaunchProfileMemberCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSLaunchProfileMemberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.DeleteLaunchProfileMemberResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSLaunchProfileMemberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PrincipalId parameter. The -PassThru parameter is deprecated, use -Select '^PrincipalId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSLaunchProfileMemberCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.RemoveNSResourceTagCmdlet"> <summary> Deletes the tags for a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>Identifies the Amazon Resource Name(ARN) key from which you are removing tags. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSResourceTagCmdlet.TagKey"> <summary> <para> <para>One or more tag keys. Specify only the tag keys, not the tag values.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.RemoveNSStreamingImageCmdlet"> <summary> Delete streaming image. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStreamingImageCmdlet.StreamingImageId"> <summary> <para> <para>The streaming image ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStreamingImageCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStreamingImageCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStreamingImageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamingImage'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.DeleteStreamingImageResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.DeleteStreamingImageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStreamingImageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StreamingImageId parameter. The -PassThru parameter is deprecated, use -Select '^StreamingImageId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStreamingImageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.RemoveNSStreamingSessionCmdlet"> <summary> Deletes streaming session resource. <para> After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a <c>DELETED</c> state. </para><para> A streaming session will count against your streaming session quota until it is marked <c>DELETED</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStreamingSessionCmdlet.SessionId"> <summary> <para> <para>The streaming session ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStreamingSessionCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStreamingSessionCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStreamingSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Session'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.DeleteStreamingSessionResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.DeleteStreamingSessionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStreamingSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStreamingSessionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioCmdlet"> <summary> Delete a studio resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Studio'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.DeleteStudioResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.DeleteStudioResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioComponentCmdlet"> <summary> Deletes a studio component resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioComponentCmdlet.StudioComponentId"> <summary> <para> <para>The studio component ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioComponentCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioComponentCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StudioComponent'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.DeleteStudioComponentResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.DeleteStudioComponentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioComponentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioComponentId parameter. The -PassThru parameter is deprecated, use -Select '^StudioComponentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioComponentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioMemberCmdlet"> <summary> Delete a user from studio membership. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioMemberCmdlet.PrincipalId"> <summary> <para> <para>The principal ID. This currently supports a IAM Identity Center UserId. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioMemberCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioMemberCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioMemberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.DeleteStudioMemberResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioMemberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PrincipalId parameter. The -PassThru parameter is deprecated, use -Select '^PrincipalId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.RemoveNSStudioMemberCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.StartNSStreamingSessionCmdlet"> <summary> Transitions sessions from the <c>STOPPED</c> state into the <c>READY</c> state. The <c>START_IN_PROGRESS</c> state is the intermediate state between the <c>STOPPED</c> and <c>READY</c> states. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StartNSStreamingSessionCmdlet.BackupId"> <summary> <para> <para>The ID of the backup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StartNSStreamingSessionCmdlet.SessionId"> <summary> <para> <para>The streaming session ID for the <c>StartStreamingSessionRequest</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StartNSStreamingSessionCmdlet.StudioId"> <summary> <para> <para>The studio ID for the StartStreamingSessionRequest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StartNSStreamingSessionCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StartNSStreamingSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Session'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.StartStreamingSessionResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.StartStreamingSessionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StartNSStreamingSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StartNSStreamingSessionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.StartNSStudioSSOConfigurationRepairCmdlet"> <summary> Repairs the IAM Identity Center configuration for a given studio. <para> If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error. </para><para> If the studio does not have a valid IAM Identity Center configuration currently associated with it, then a new IAM Identity Center application is created for the studio and the studio is changed to the <c>READY</c> state. </para><para> After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StartNSStudioSSOConfigurationRepairCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StartNSStudioSSOConfigurationRepairCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StartNSStudioSSOConfigurationRepairCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Studio'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.StartStudioSSOConfigurationRepairResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.StartStudioSSOConfigurationRepairResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StartNSStudioSSOConfigurationRepairCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StartNSStudioSSOConfigurationRepairCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.StopNSStreamingSessionCmdlet"> <summary> Transitions sessions from the <c>READY</c> state into the <c>STOPPED</c> state. The <c>STOP_IN_PROGRESS</c> state is the intermediate state between the <c>READY</c> and <c>STOPPED</c> states. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StopNSStreamingSessionCmdlet.SessionId"> <summary> <para> <para>The streaming session ID for the <c>StopStreamingSessionRequest</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StopNSStreamingSessionCmdlet.StudioId"> <summary> <para> <para>The studioId for the StopStreamingSessionRequest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StopNSStreamingSessionCmdlet.VolumeRetentionMode"> <summary> <para> <para>Adds additional instructions to a streaming session stop action to either retain the EBS volumes or delete the EBS volumes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StopNSStreamingSessionCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StopNSStreamingSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Session'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.StopStreamingSessionResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.StopStreamingSessionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StopNSStreamingSessionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SessionId parameter. The -PassThru parameter is deprecated, use -Select '^SessionId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.StopNSStreamingSessionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet"> <summary> Update a launch profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.StreamConfiguration_AutomaticTerminationMode"> <summary> <para> <para>Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a <c>STOPPED</c> state.</para><ul><li><para>When <c>ACTIVATED</c>, the streaming session is scheduled for termination after being in the <c>STOPPED</c> state for the time specified in <c>maxStoppedSessionLengthInMinutes</c>.</para></li><li><para>When <c>DEACTIVATED</c>, the streaming session can remain in the <c>STOPPED</c> state indefinitely.</para></li></ul><para>This parameter is only allowed when <c>sessionPersistenceMode</c> is <c>ACTIVATED</c>. When allowed, the default value for this parameter is <c>DEACTIVATED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.StreamConfiguration_ClipboardMode"> <summary> <para> <para>Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.Description"> <summary> <para> <para>The description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.StreamConfiguration_Ec2InstanceType"> <summary> <para> <para>The EC2 instance types that users can select from when launching a streaming session with this launch profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.VolumeConfiguration_Iops"> <summary> <para> <para>The number of I/O operations per second for the root volume that is attached to streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.LaunchProfileId"> <summary> <para> <para>The ID of the launch profile used to control access from the streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.LaunchProfileProtocolVersion"> <summary> <para> <para>The version number of the protocol that is used by the launch profile. The only valid version is "2021-03-31".</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.Root_Linux"> <summary> <para> <para>The folder path in Linux workstations where files are uploaded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.SessionBackup_MaxBackupsToRetain"> <summary> <para> <para>The maximum number of backups that each streaming session created from this launch profile can have.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.StreamConfiguration_MaxSessionLengthInMinute"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.StreamConfiguration_MaxStoppedSessionLengthInMinute"> <summary> <para> <para>Integer that determines if you can start and stop your sessions and how long a session can stay in the <c>STOPPED</c> state. The default value is 0. The maximum value is 5760.</para><para>This field is allowed only when <c>sessionPersistenceMode</c> is <c>ACTIVATED</c> and <c>automaticTerminationMode</c> is <c>ACTIVATED</c>.</para><para>If the value is set to 0, your sessions can’t be <c>STOPPED</c>. If you then call <c>StopStreamingSession</c>, the session fails. If the time that a session stays in the <c>READY</c> state exceeds the <c>maxSessionLengthInMinutes</c> value, the session will automatically be terminated (instead of <c>STOPPED</c>).</para><para>If the value is set to a positive number, the session can be stopped. You can call <c>StopStreamingSession</c> to stop sessions in the <c>READY</c> state. If the time that a session stays in the <c>READY</c> state exceeds the <c>maxSessionLengthInMinutes</c> value, the session will automatically be stopped (instead of terminated).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.SessionBackup_Mode"> <summary> <para> <para>Specifies how artists sessions are backed up.</para><para>Configures backups for streaming sessions launched with this launch profile. The default value is <c>DEACTIVATED</c>, which means that backups are deactivated. To allow backups, set this value to <c>AUTOMATIC</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.SessionStorage_Mode"> <summary> <para> <para>Allows artists to upload files to their workstations. The only valid option is <c>UPLOAD</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.Name"> <summary> <para> <para>The name for the launch profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.StreamConfiguration_SessionPersistenceMode"> <summary> <para> <para>Determine if a streaming session created from this launch profile can configure persistent storage. This means that <c>volumeConfiguration</c> and <c>automaticTerminationMode</c> are configured.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.VolumeConfiguration_Size"> <summary> <para> <para>The size of the root volume that is attached to the streaming session. The root volume size is measured in GiBs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.StreamConfiguration_StreamingImageId"> <summary> <para> <para>The streaming images that users can select from when launching a streaming session with this launch profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.StudioComponentId"> <summary> <para> <para>Unique identifiers for a collection of studio components that can be used with this launch profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.VolumeConfiguration_Throughput"> <summary> <para> <para>The throughput to provision for the root volume that is attached to the streaming session. The throughput is measured in MiB/s.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.Root_Window"> <summary> <para> <para>The folder path in Windows workstations where files are uploaded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileMemberCmdlet"> <summary> Update a user persona in launch profile membership. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileMemberCmdlet.LaunchProfileId"> <summary> <para> <para>The ID of the launch profile used to control access from the streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileMemberCmdlet.Persona"> <summary> <para> <para>The persona.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileMemberCmdlet.PrincipalId"> <summary> <para> <para>The principal ID. This currently supports a IAM Identity Center UserId. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileMemberCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileMemberCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileMemberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Member'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.UpdateLaunchProfileMemberResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.UpdateLaunchProfileMemberResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileMemberCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSLaunchProfileMemberCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.UpdateNSStreamingImageCmdlet"> <summary> Update streaming image. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStreamingImageCmdlet.Description"> <summary> <para> <para>The description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStreamingImageCmdlet.Name"> <summary> <para> <para>The name for the streaming image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStreamingImageCmdlet.StreamingImageId"> <summary> <para> <para>The streaming image ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStreamingImageCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStreamingImageCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStreamingImageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamingImage'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.UpdateStreamingImageResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.UpdateStreamingImageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStreamingImageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StreamingImageId parameter. The -PassThru parameter is deprecated, use -Select '^StreamingImageId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStreamingImageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioCmdlet"> <summary> Update a Studio resource. <para> Currently, this operation only supports updating the displayName of your studio. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioCmdlet.AdminRoleArn"> <summary> <para> <para>The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioCmdlet.DisplayName"> <summary> <para> <para>A friendly name for the studio.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioCmdlet.UserRoleArn"> <summary> <para> <para>The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Studio'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.UpdateStudioResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.UpdateStudioResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet"> <summary> Updates a studio component resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.ComputeFarmConfiguration_ActiveDirectoryUser"> <summary> <para> <para>The name of an Active Directory user that is used on ComputeFarm worker instances.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.ActiveDirectoryConfiguration_ComputerAttribute"> <summary> <para> <para>A collection of custom attributes for an Active Directory computer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.Description"> <summary> <para> <para>The description.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.ActiveDirectoryConfiguration_DirectoryId"> <summary> <para> <para>The directory ID of the Directory Service for Microsoft Active Directory to access using this studio component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.Ec2SecurityGroupId"> <summary> <para> <para>The EC2 security groups that control access to the studio component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.ComputeFarmConfiguration_Endpoint"> <summary> <para> <para>The endpoint of the ComputeFarm that is accessed by the studio component resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.LicenseServiceConfiguration_Endpoint"> <summary> <para> <para>The endpoint of the license service that is accessed by the studio component resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.SharedFileSystemConfiguration_Endpoint"> <summary> <para> <para>The endpoint of the shared file system that is accessed by the studio component resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.SharedFileSystemConfiguration_FileSystemId"> <summary> <para> <para>The unique identifier for a file system.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.InitializationScript"> <summary> <para> <para>Initialization scripts for studio components.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.SharedFileSystemConfiguration_LinuxMountPoint"> <summary> <para> <para>The mount location for a shared file system on a Linux virtual workstation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.Name"> <summary> <para> <para>The name for the studio component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.ActiveDirectoryConfiguration_OrganizationalUnitDistinguishedName"> <summary> <para> <para>The distinguished name (DN) and organizational unit (OU) of an Active Directory computer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.RuntimeRoleArn"> <summary> <para> <para>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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.ScriptParameter"> <summary> <para> <para>Parameters for the studio component scripts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.SecureInitializationRoleArn"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.SharedFileSystemConfiguration_ShareName"> <summary> <para> <para>The name of the file share.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.StudioComponentId"> <summary> <para> <para>The studio component ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.Subtype"> <summary> <para> <para>The specific subtype of a studio component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.Type"> <summary> <para> <para>The type of the studio component.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.SharedFileSystemConfiguration_WindowsMountDrive"> <summary> <para> <para>The mount location for a shared file system on a Windows virtual workstation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StudioComponent'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.UpdateStudioComponentResponse). Specifying the name of a property of type Amazon.NimbleStudio.Model.UpdateStudioComponentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioComponentId parameter. The -PassThru parameter is deprecated, use -Select '^StudioComponentId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.UpdateNSStudioComponentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.WriteNSLaunchProfileMemberCmdlet"> <summary> Add/update users with given persona to launch profile membership. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.WriteNSLaunchProfileMemberCmdlet.IdentityStoreId"> <summary> <para> <para>The ID of the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.WriteNSLaunchProfileMemberCmdlet.LaunchProfileId"> <summary> <para> <para>The ID of the launch profile used to control access from the streaming session.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.WriteNSLaunchProfileMemberCmdlet.Member"> <summary> <para> <para>A list of members.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.WriteNSLaunchProfileMemberCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.WriteNSLaunchProfileMemberCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.WriteNSLaunchProfileMemberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.PutLaunchProfileMembersResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.WriteNSLaunchProfileMemberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.WriteNSLaunchProfileMemberCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.NS.WriteNSStudioMemberCmdlet"> <summary> Add/update users with given persona to studio membership. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.WriteNSStudioMemberCmdlet.IdentityStoreId"> <summary> <para> <para>The ID of the identity store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.WriteNSStudioMemberCmdlet.Member"> <summary> <para> <para>A list of members.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.WriteNSStudioMemberCmdlet.StudioId"> <summary> <para> <para>The studio ID. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.WriteNSStudioMemberCmdlet.ClientToken"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.WriteNSStudioMemberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.PutStudioMembersResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.WriteNSStudioMemberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StudioId parameter. The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.NS.WriteNSStudioMemberCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |