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 <code>string:string (key:value)</code>. 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 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.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 <code>nextToken</code> 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.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: <code>PUBLISH, SUBSCRIBE</code>.</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: 60 (1 hour).</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.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.Tag"> <summary> <para> <para>Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. 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.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 <code>string:string (key:value)</code>. 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.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.Name"> <summary> <para> <para>Name of the stage to be 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> |