AWS.Tools.IVSRealTime.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.IVSRealTime</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.IVSRT.AddIVSRTResourceTagCmdlet"> <summary> Adds or updates tags for the AWS resource with the specified ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.AddIVSRTResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to be tagged. The ARN must be URL-encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.AddIVSRTResourceTagCmdlet.Tag"> <summary> <para> <para>Array of tags to be added or updated. Array of maps, each of the form <c>string:string (key:value)</c>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints beyond what is documented there.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.AddIVSRTResourceTagCmdlet.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.IVSRealTime.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.AddIVSRTResourceTagCmdlet.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.IVSRT.AddIVSRTResourceTagCmdlet.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.IVSRT.DisconnectIVSRTParticipantCmdlet"> <summary> Disconnects a specified participant and revokes the participant permanently from a specified stage. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.DisconnectIVSRTParticipantCmdlet.ParticipantId"> <summary> <para> <para>Identifier of the participant to be disconnected. This is assigned by IVS and returned by <a>CreateParticipantToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.DisconnectIVSRTParticipantCmdlet.Reason"> <summary> <para> <para>Description of why this participant is being disconnected.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.DisconnectIVSRTParticipantCmdlet.StageArn"> <summary> <para> <para>ARN of the stage to which the participant is attached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.DisconnectIVSRTParticipantCmdlet.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.IVSRealTime.Model.DisconnectParticipantResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.DisconnectIVSRTParticipantCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ParticipantId parameter. The -PassThru parameter is deprecated, use -Select '^ParticipantId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.DisconnectIVSRTParticipantCmdlet.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.IVSRT.GetIVSRTCompositionCmdlet"> <summary> Get information about the specified Composition resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTCompositionCmdlet.Arn"> <summary> <para> <para>ARN of the Composition resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTCompositionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Composition'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.GetCompositionResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.GetCompositionResponse 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.IVSRT.GetIVSRTCompositionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTCompositionListCmdlet"> <summary> Gets summary information about all Compositions in your account, in the AWS region where the API request is processed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTCompositionListCmdlet.FilterByEncoderConfigurationArn"> <summary> <para> <para>Filters the Composition list to match the specified EncoderConfiguration attached to at least one of its output.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTCompositionListCmdlet.FilterByStageArn"> <summary> <para> <para>Filters the Composition list to match the specified Stage ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTCompositionListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return. Default: 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTCompositionListCmdlet.NextToken"> <summary> <para> <para>The first Composition to retrieve. This is used for pagination; see the <c>nextToken</c> response field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTCompositionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Compositions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.ListCompositionsResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.ListCompositionsResponse 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.IVSRT.GetIVSRTEncoderConfigurationCmdlet"> <summary> Gets information about the specified EncoderConfiguration resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTEncoderConfigurationCmdlet.Arn"> <summary> <para> <para>ARN of the EncoderConfiguration resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTEncoderConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EncoderConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.GetEncoderConfigurationResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.GetEncoderConfigurationResponse 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.IVSRT.GetIVSRTEncoderConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTEncoderConfigurationListCmdlet"> <summary> Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTEncoderConfigurationListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return. Default: 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTEncoderConfigurationListCmdlet.NextToken"> <summary> <para> <para>The first encoder configuration to retrieve. This is used for pagination; see the <c>nextToken</c> response field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTEncoderConfigurationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EncoderConfigurations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.ListEncoderConfigurationsResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.ListEncoderConfigurationsResponse 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.IVSRT.GetIVSRTParticipantCmdlet"> <summary> Gets information about the specified participant token. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantCmdlet.ParticipantId"> <summary> <para> <para>Unique identifier for the participant. This is assigned by IVS and returned by <a>CreateParticipantToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantCmdlet.SessionId"> <summary> <para> <para>ID of a session within the stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantCmdlet.StageArn"> <summary> <para> <para>Stage ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Participant'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.GetParticipantResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.GetParticipantResponse 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.IVSRT.GetIVSRTParticipantEventListCmdlet"> <summary> Lists events for a specified participant that occurred during a specified stage session. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantEventListCmdlet.ParticipantId"> <summary> <para> <para>Unique identifier for this participant. This is assigned by IVS and returned by <a>CreateParticipantToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantEventListCmdlet.SessionId"> <summary> <para> <para>ID of a session within the stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantEventListCmdlet.StageArn"> <summary> <para> <para>Stage ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantEventListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return. Default: 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantEventListCmdlet.NextToken"> <summary> <para> <para>The first participant event to retrieve. This is used for pagination; see the <c>nextToken</c> response field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantEventListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Events'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.ListParticipantEventsResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.ListParticipantEventsResponse 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.IVSRT.GetIVSRTParticipantListCmdlet"> <summary> Lists all participants in a specified stage session. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantListCmdlet.FilterByPublished"> <summary> <para> <para>Filters the response list to only show participants who published during the stage session. Only one of <c>filterByUserId</c>, <c>filterByPublished</c>, <c>filterByState</c>, or <c>filterByRecordingState</c> can be provided per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantListCmdlet.FilterByRecordingState"> <summary> <para> <para>Filters the response list to only show participants with the specified recording state. Only one of <c>filterByUserId</c>, <c>filterByPublished</c>, <c>filterByState</c>, or <c>filterByRecordingState</c> can be provided per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantListCmdlet.FilterByState"> <summary> <para> <para>Filters the response list to only show participants in the specified state. Only one of <c>filterByUserId</c>, <c>filterByPublished</c>, <c>filterByState</c>, or <c>filterByRecordingState</c> can be provided per request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantListCmdlet.FilterByUserId"> <summary> <para> <para>Filters the response list to match the specified user ID. Only one of <c>filterByUserId</c>, <c>filterByPublished</c>, <c>filterByState</c>, or <c>filterByRecordingState</c> can be provided per request. A <c>userId</c> is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantListCmdlet.SessionId"> <summary> <para> <para>ID of the session within the stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantListCmdlet.StageArn"> <summary> <para> <para>Stage ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return. Default: 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantListCmdlet.NextToken"> <summary> <para> <para>The first participant to retrieve. This is used for pagination; see the <c>nextToken</c> response field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTParticipantListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Participants'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.ListParticipantsResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.ListParticipantsResponse 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.IVSRT.GetIVSRTPublicKeyCmdlet"> <summary> Gets information for the specified public key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTPublicKeyCmdlet.Arn"> <summary> <para> <para>ARN of the public key for which the information is to be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTPublicKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PublicKey'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.GetPublicKeyResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.GetPublicKeyResponse 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.IVSRT.GetIVSRTPublicKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTPublicKeyListCmdlet"> <summary> Gets summary information about all public keys in your account, in the AWS region where the API request is processed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTPublicKeyListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return. Default: 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTPublicKeyListCmdlet.NextToken"> <summary> <para> <para>The first public key to retrieve. This is used for pagination; see the <c>nextToken</c> response field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTPublicKeyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PublicKeys'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.ListPublicKeysResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.ListPublicKeysResponse 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.IVSRT.GetIVSRTResourceTagCmdlet"> <summary> Gets information about AWS tags for the specified ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to be retrieved. The ARN must be URL-encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTResourceTagCmdlet.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.IVSRealTime.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.IVSRealTime.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.IVSRT.GetIVSRTResourceTagCmdlet.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.IVSRT.GetIVSRTStageCmdlet"> <summary> Gets information for the specified stage. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStageCmdlet.Arn"> <summary> <para> <para>ARN of the stage for which the information is to be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Stage'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.GetStageResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.GetStageResponse 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.IVSRT.GetIVSRTStageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStageListCmdlet"> <summary> Gets summary information about all stages in your account, in the AWS region where the API request is processed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStageListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return. Default: 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStageListCmdlet.NextToken"> <summary> <para> <para>The first stage to retrieve. This is used for pagination; see the <c>nextToken</c> response field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStageListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Stages'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.ListStagesResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.ListStagesResponse 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.IVSRT.GetIVSRTStageSessionCmdlet"> <summary> Gets information for the specified stage session. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStageSessionCmdlet.SessionId"> <summary> <para> <para>ID of a session within the stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStageSessionCmdlet.StageArn"> <summary> <para> <para>ARN of the stage for which the information is to be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStageSessionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StageSession'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.GetStageSessionResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.GetStageSessionResponse 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.IVSRT.GetIVSRTStageSessionListCmdlet"> <summary> Gets all sessions for a specified stage. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStageSessionListCmdlet.StageArn"> <summary> <para> <para>Stage ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStageSessionListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return. Default: 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStageSessionListCmdlet.NextToken"> <summary> <para> <para>The first stage session to retrieve. This is used for pagination; see the <c>nextToken</c> response field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStageSessionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StageSessions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.ListStageSessionsResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.ListStageSessionsResponse 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.IVSRT.GetIVSRTStageSessionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StageArn parameter. The -PassThru parameter is deprecated, use -Select '^StageArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStorageConfigurationCmdlet"> <summary> Gets the storage configuration for the specified ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStorageConfigurationCmdlet.Arn"> <summary> <para> <para>ARN of the storage configuration to be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStorageConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StorageConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.GetStorageConfigurationResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.GetStorageConfigurationResponse 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.IVSRT.GetIVSRTStorageConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStorageConfigurationListCmdlet"> <summary> Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStorageConfigurationListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of storage configurations to return. Default: your service quota or 100, whichever is smaller.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStorageConfigurationListCmdlet.NextToken"> <summary> <para> <para>The first storage configuration to retrieve. This is used for pagination; see the <c>nextToken</c> response field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.GetIVSRTStorageConfigurationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StorageConfigurations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.ListStorageConfigurationsResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.ListStorageConfigurationsResponse 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.IVSRT.ImportIVSRTPublicKeyCmdlet"> <summary> Import a public key to be used for signing stage participant tokens. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.ImportIVSRTPublicKeyCmdlet.Name"> <summary> <para> <para>Name of the public key to be imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.ImportIVSRTPublicKeyCmdlet.PublicKeyMaterial"> <summary> <para> <para>The content of the public key to be imported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.ImportIVSRTPublicKeyCmdlet.Tag"> <summary> <para> <para>Tags attached to the resource. Array of maps, each of the form <c>string:string (key:value)</c>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.ImportIVSRTPublicKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PublicKey'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.ImportPublicKeyResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.ImportPublicKeyResponse 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.IVSRT.ImportIVSRTPublicKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PublicKeyMaterial parameter. The -PassThru parameter is deprecated, use -Select '^PublicKeyMaterial' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.ImportIVSRTPublicKeyCmdlet.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.IVSRT.NewIVSRTEncoderConfigurationCmdlet"> <summary> Creates an EncoderConfiguration object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTEncoderConfigurationCmdlet.Video_Bitrate"> <summary> <para> <para>Bitrate for generated output, in bps. Default: 2500000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTEncoderConfigurationCmdlet.Video_Framerate"> <summary> <para> <para>Video frame rate, in fps. Default: 30.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTEncoderConfigurationCmdlet.Video_Height"> <summary> <para> <para>Video-resolution height. Note that the maximum value is determined by <c>width</c> times <c>height</c>, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTEncoderConfigurationCmdlet.Name"> <summary> <para> <para>Optional name to identify the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTEncoderConfigurationCmdlet.Tag"> <summary> <para> <para>Tags attached to the resource. Array of maps, each of the form <c>string:string (key:value)</c>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTEncoderConfigurationCmdlet.Video_Width"> <summary> <para> <para>Video-resolution width. Note that the maximum value is determined by <c>width</c> times <c>height</c>, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 1280.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTEncoderConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EncoderConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.CreateEncoderConfigurationResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.CreateEncoderConfigurationResponse 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.IVSRT.NewIVSRTEncoderConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTEncoderConfigurationCmdlet.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.IVSRT.NewIVSRTParticipantTokenCmdlet"> <summary> Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created. <para> Encryption keys are owned by Amazon IVS and never used directly by your application. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTParticipantTokenCmdlet.Attribute"> <summary> <para> <para>Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTParticipantTokenCmdlet.Capability"> <summary> <para> <para>Set of capabilities that the user is allowed to perform in the stage. Default: <c>PUBLISH, SUBSCRIBE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTParticipantTokenCmdlet.Duration"> <summary> <para> <para>Duration (in minutes), after which the token expires. Default: 720 (12 hours).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTParticipantTokenCmdlet.StageArn"> <summary> <para> <para>ARN of the stage to which this token is scoped.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTParticipantTokenCmdlet.UserId"> <summary> <para> <para>Name that can be specified to help identify the token. This can be any UTF-8 encoded text. <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTParticipantTokenCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ParticipantToken'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.CreateParticipantTokenResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.CreateParticipantTokenResponse 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.IVSRT.NewIVSRTParticipantTokenCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StageArn parameter. The -PassThru parameter is deprecated, use -Select '^StageArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTParticipantTokenCmdlet.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.IVSRT.NewIVSRTStageCmdlet"> <summary> Creates a new stage (and optionally participant tokens). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTStageCmdlet.AutoParticipantRecordingConfiguration_MediaType"> <summary> <para> <para>Types of media to be recorded. Default: <c>AUDIO_VIDEO</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTStageCmdlet.Name"> <summary> <para> <para>Optional name that can be specified for the stage being created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTStageCmdlet.ParticipantTokenConfiguration"> <summary> <para> <para>Array of participant token configuration objects to attach to the new stage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTStageCmdlet.AutoParticipantRecordingConfiguration_StorageConfigurationArn"> <summary> <para> <para>ARN of the <a>StorageConfiguration</a> resource to use for individual participant recording. Default: <c>""</c> (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a <a>Stage</a> is created or updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTStageCmdlet.Tag"> <summary> <para> <para>Tags attached to the resource. Array of maps, each of the form <c>string:string (key:value)</c>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTStageCmdlet.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.IVSRealTime.Model.CreateStageResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.CreateStageResponse 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.IVSRT.NewIVSRTStageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTStageCmdlet.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.IVSRT.NewIVSRTStorageConfigurationCmdlet"> <summary> Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTStorageConfigurationCmdlet.S3_BucketName"> <summary> <para> <para>Location (S3 bucket name) where recorded videos will be stored. Note that the StorageConfiguration and S3 bucket must be in the same region as the Composition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTStorageConfigurationCmdlet.Name"> <summary> <para> <para>Storage configuration name. The value does not need to be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTStorageConfigurationCmdlet.Tag"> <summary> <para> <para>Tags attached to the resource. Array of maps, each of the form <c>string:string (key:value)</c>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTStorageConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StorageConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.CreateStorageConfigurationResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.CreateStorageConfigurationResponse 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.IVSRT.NewIVSRTStorageConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the S3_BucketName parameter. The -PassThru parameter is deprecated, use -Select '^S3_BucketName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.NewIVSRTStorageConfigurationCmdlet.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.IVSRT.RemoveIVSRTEncoderConfigurationCmdlet"> <summary> Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTEncoderConfigurationCmdlet.Arn"> <summary> <para> <para>ARN of the EncoderConfiguration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTEncoderConfigurationCmdlet.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.IVSRealTime.Model.DeleteEncoderConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTEncoderConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTEncoderConfigurationCmdlet.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.IVSRT.RemoveIVSRTPublicKeyCmdlet"> <summary> Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTPublicKeyCmdlet.Arn"> <summary> <para> <para>ARN of the public key to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTPublicKeyCmdlet.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.IVSRealTime.Model.DeletePublicKeyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTPublicKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTPublicKeyCmdlet.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.IVSRT.RemoveIVSRTResourceTagCmdlet"> <summary> Removes tags from the resource with the specified ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource to be untagged. The ARN must be URL-encoded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTResourceTagCmdlet.TagKey"> <summary> <para> <para>Array of tags to be removed. Array of maps, each of the form <c>string:string (key:value)</c>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints beyond what is documented there.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTResourceTagCmdlet.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.IVSRealTime.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTResourceTagCmdlet.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.IVSRT.RemoveIVSRTResourceTagCmdlet.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.IVSRT.RemoveIVSRTStageCmdlet"> <summary> Shuts down and deletes the specified stage (disconnecting all participants). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTStageCmdlet.Arn"> <summary> <para> <para>ARN of the stage to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTStageCmdlet.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.IVSRealTime.Model.DeleteStageResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTStageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTStageCmdlet.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.IVSRT.RemoveIVSRTStorageConfigurationCmdlet"> <summary> Deletes the storage configuration for the specified ARN. <para> If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use <a>StopComposition</a> and wait for it to complete, then use DeleteStorageConfiguration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTStorageConfigurationCmdlet.Arn"> <summary> <para> <para>ARN of the storage configuration to be deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTStorageConfigurationCmdlet.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.IVSRealTime.Model.DeleteStorageConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTStorageConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.RemoveIVSRTStorageConfigurationCmdlet.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.IVSRT.StartIVSRTCompositionCmdlet"> <summary> Starts a Composition from a stage based on the configuration provided in the request. <para> A Composition is an ephemeral resource that exists after this endpoint returns successfully. Composition stops and the resource is deleted: </para><ul><li><para> When <a>StopComposition</a> is called. </para></li><li><para> After a 1-minute timeout, when all participants are disconnected from the stage. </para></li><li><para> After a 1-minute timeout, if there are no participants in the stage when StartComposition is called. </para></li><li><para> When broadcasting to the IVS channel fails and all retries are exhausted. </para></li><li><para> When broadcasting is disconnected and all attempts to reconnect are exhausted. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Destination"> <summary> <para> <para>Array of destination configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Grid_FeaturedParticipantAttribute"> <summary> <para> <para>This attribute name identifies the featured slot. A participant with this attribute set to <c>"true"</c> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured slot. Default: <c>""</c> (no featured participant).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Pip_FeaturedParticipantAttribute"> <summary> <para> <para>This attribute name identifies the featured slot. A participant with this attribute set to <c>"true"</c> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the featured slot. Default: <c>""</c> (no featured participant).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Grid_GridGap"> <summary> <para> <para>Specifies the spacing between participant tiles in pixels. Default: <c>2</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Pip_GridGap"> <summary> <para> <para>Specifies the spacing between participant tiles in pixels. Default: <c>0</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.IdempotencyToken"> <summary> <para> <para>Idempotency token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Grid_OmitStoppedVideo"> <summary> <para> <para>Determines whether to omit participants with stopped video in the composition. Default: <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Pip_OmitStoppedVideo"> <summary> <para> <para>Determines whether to omit participants with stopped video in the composition. Default: <c>false</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Pip_PipBehavior"> <summary> <para> <para>Defines PiP behavior when all participants have left: <c>STATIC</c> (maintains original position/size) or <c>DYNAMIC</c> (expands to full composition). Default: <c>STATIC</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Pip_PipHeight"> <summary> <para> <para>Specifies the height of the PiP window in pixels. When this is not set explicitly, <c>pipHeight</c>’s value will be based on the size of the composition and the aspect ratio of the participant’s video.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Pip_PipOffset"> <summary> <para> <para>Sets the PiP window’s offset position in pixels from the closest edges determined by <c>PipPosition</c>. Default: <c>0</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Pip_PipParticipantAttribute"> <summary> <para> <para>Specifies the participant for the PiP window. A participant with this attribute set to <c>"true"</c> (as a string value) in <a>ParticipantTokenConfiguration</a> is placed in the PiP slot. Default: <c>""</c> (no PiP participant).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Pip_PipPosition"> <summary> <para> <para>Determines the corner position of the PiP window. Default: <c>BOTTOM_RIGHT</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Pip_PipWidth"> <summary> <para> <para>Specifies the width of the PiP window in pixels. When this is not set explicitly, <c>pipWidth</c>’s value will be based on the size of the composition and the aspect ratio of the participant’s video.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.StageArn"> <summary> <para> <para>ARN of the stage to be used for compositing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Tag"> <summary> <para> <para>Tags attached to the resource. Array of maps, each of the form <c>string:string (key:value)</c>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS Resources</a> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Grid_VideoAspectRatio"> <summary> <para> <para>Sets the non-featured participant display mode, to control the aspect ratio of video tiles. <c>VIDEO</c> is 16:9, <c>SQUARE</c> is 1:1, and <c>PORTRAIT</c> is 3:4. Default: <c>VIDEO</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Grid_VideoFillMode"> <summary> <para> <para>Defines how video content fits within the participant tile: <c>FILL</c> (stretched), <c>COVER</c> (cropped), or <c>CONTAIN</c> (letterboxed). When not set, <c>videoFillMode</c> defaults to <c>COVER</c> fill mode for participants in the grid and to <c>CONTAIN</c> fill mode for featured participants.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Pip_VideoFillMode"> <summary> <para> <para>Defines how video content fits within the participant tile: <c>FILL</c> (stretched), <c>COVER</c> (cropped), or <c>CONTAIN</c> (letterboxed). Default: <c>COVER</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Composition'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.StartCompositionResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.StartCompositionResponse 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.IVSRT.StartIVSRTCompositionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the StageArn parameter. The -PassThru parameter is deprecated, use -Select '^StageArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StartIVSRTCompositionCmdlet.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.IVSRT.StopIVSRTCompositionCmdlet"> <summary> Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StopIVSRTCompositionCmdlet.Arn"> <summary> <para> <para>ARN of the Composition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StopIVSRTCompositionCmdlet.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.IVSRealTime.Model.StopCompositionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StopIVSRTCompositionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.StopIVSRTCompositionCmdlet.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.IVSRT.UpdateIVSRTStageCmdlet"> <summary> Updates a stage’s configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.UpdateIVSRTStageCmdlet.Arn"> <summary> <para> <para>ARN of the stage to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.UpdateIVSRTStageCmdlet.AutoParticipantRecordingConfiguration_MediaType"> <summary> <para> <para>Types of media to be recorded. Default: <c>AUDIO_VIDEO</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.UpdateIVSRTStageCmdlet.Name"> <summary> <para> <para>Name of the stage to be updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.UpdateIVSRTStageCmdlet.AutoParticipantRecordingConfiguration_StorageConfigurationArn"> <summary> <para> <para>ARN of the <a>StorageConfiguration</a> resource to use for individual participant recording. Default: <c>""</c> (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a <a>Stage</a> is created or updated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.UpdateIVSRTStageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Stage'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IVSRealTime.Model.UpdateStageResponse). Specifying the name of a property of type Amazon.IVSRealTime.Model.UpdateStageResponse 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.IVSRT.UpdateIVSRTStageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.IVSRT.UpdateIVSRTStageCmdlet.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> |