AWS.Tools.ChimeSDKMediaPipelines.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ChimeSDKMediaPipelines</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CHMMP.AddCHMMPResourceTagCmdlet"> <summary> The ARN of the media pipeline that you want to tag. Consists of he pipeline's endpoint region, resource ID, and pipeline ID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.AddCHMMPResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's endpoint region, resource ID, and pipeline ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.AddCHMMPResourceTagCmdlet.Tag"> <summary> <para> <para>The tags associated with the specified media pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.AddCHMMPResourceTagCmdlet.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.ChimeSDKMediaPipelines.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.AddCHMMPResourceTagCmdlet.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.CHMMP.AddCHMMPResourceTagCmdlet.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.CHMMP.GetCHMMPMediaCapturePipelineCmdlet"> <summary> Gets an existing media pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaCapturePipelineCmdlet.MediaPipelineId"> <summary> <para> <para>The ID of the pipeline that you want to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaCapturePipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MediaCapturePipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMediaPipelines.Model.GetMediaCapturePipelineResponse). Specifying the name of a property of type Amazon.ChimeSDKMediaPipelines.Model.GetMediaCapturePipelineResponse 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.CHMMP.GetCHMMPMediaCapturePipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MediaPipelineId parameter. The -PassThru parameter is deprecated, use -Select '^MediaPipelineId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaCapturePipelineListCmdlet"> <summary> Returns a list of media pipelines. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaCapturePipelineListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call. Valid Range: 1 - 99.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaCapturePipelineListCmdlet.NextToken"> <summary> <para> <para>The token used to retrieve the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaCapturePipelineListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MediaCapturePipelines'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMediaPipelines.Model.ListMediaCapturePipelinesResponse). Specifying the name of a property of type Amazon.ChimeSDKMediaPipelines.Model.ListMediaCapturePipelinesResponse 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.CHMMP.GetCHMMPMediaPipelineCmdlet"> <summary> Gets an existing media pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaPipelineCmdlet.MediaPipelineId"> <summary> <para> <para>The ID of the pipeline that you want to get.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaPipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MediaPipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMediaPipelines.Model.GetMediaPipelineResponse). Specifying the name of a property of type Amazon.ChimeSDKMediaPipelines.Model.GetMediaPipelineResponse 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.CHMMP.GetCHMMPMediaPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MediaPipelineId parameter. The -PassThru parameter is deprecated, use -Select '^MediaPipelineId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaPipelineListCmdlet"> <summary> Returns a list of media pipelines. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaPipelineListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call. Valid Range: 1 - 99.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaPipelineListCmdlet.NextToken"> <summary> <para> <para>The token used to retrieve the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaPipelineListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MediaPipelines'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMediaPipelines.Model.ListMediaPipelinesResponse). Specifying the name of a property of type Amazon.ChimeSDKMediaPipelines.Model.ListMediaPipelinesResponse 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.CHMMP.GetCHMMPResourceTagCmdlet"> <summary> Lists the tags available for a media pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's region, resource ID, and pipeline ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPResourceTagCmdlet.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.ChimeSDKMediaPipelines.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.ChimeSDKMediaPipelines.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.CHMMP.GetCHMMPResourceTagCmdlet.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.CHMMP.NewCHMMPMediaCapturePipelineCmdlet"> <summary> Creates a media pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.SelectedVideoStreams_AttendeeId"> <summary> <para> <para>The attendee IDs of the streams selected for a media pipeline. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.ClientRequestToken"> <summary> <para> <para>The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.GridViewConfiguration_ContentShareLayout"> <summary> <para> <para>Defines the layout of the video tiles when content sharing is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.SelectedVideoStreams_ExternalUserId"> <summary> <para> <para>The external user IDs of the streams selected for a media pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.CompositedVideo_Layout"> <summary> <para> <para>The layout setting, such as <code>GridView</code> in the configuration object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.Audio_MuxType"> <summary> <para> <para>The MUX type of the audio artifact configuration object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.Content_MuxType"> <summary> <para> <para>The MUX type of the artifact configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.Video_MuxType"> <summary> <para> <para>The MUX type of the video artifact configuration object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.PresenterOnlyConfiguration_PresenterPosition"> <summary> <para> <para>Defines the position of the presenter video tile. Default: <code>TopRight</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.CompositedVideo_Resolution"> <summary> <para> <para>The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.SinkArn"> <summary> <para> <para>The ARN of the sink type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.SinkType"> <summary> <para> <para>Destination type to which the media artifacts are saved. You must use an S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.SourceArn"> <summary> <para> <para>ARN of the source from which the media artifacts are captured.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.SourceType"> <summary> <para> <para>Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.Content_State"> <summary> <para> <para>Indicates whether the content artifact is enabled or disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.Video_State"> <summary> <para> <para>Indicates whether the video artifact is enabled or disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.Tag"> <summary> <para> <para>The tag key-value pairs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MediaCapturePipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMediaPipelines.Model.CreateMediaCapturePipelineResponse). Specifying the name of a property of type Amazon.ChimeSDKMediaPipelines.Model.CreateMediaCapturePipelineResponse 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.CHMMP.NewCHMMPMediaCapturePipelineCmdlet.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.CHMMP.NewCHMMPMediaConcatenationPipelineCmdlet"> <summary> Creates a media concatenation pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaConcatenationPipelineCmdlet.ClientRequestToken"> <summary> <para> <para>The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media concatenation pipeline request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaConcatenationPipelineCmdlet.Sink"> <summary> <para> <para>An object that specifies the data sinks for the media concatenation pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaConcatenationPipelineCmdlet.Source"> <summary> <para> <para>An object that specifies the sources for the media concatenation pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaConcatenationPipelineCmdlet.Tag"> <summary> <para> <para>The tags associated with the media concatenation pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaConcatenationPipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MediaConcatenationPipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMediaPipelines.Model.CreateMediaConcatenationPipelineResponse). Specifying the name of a property of type Amazon.ChimeSDKMediaPipelines.Model.CreateMediaConcatenationPipelineResponse 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.CHMMP.NewCHMMPMediaConcatenationPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClientRequestToken parameter. The -PassThru parameter is deprecated, use -Select '^ClientRequestToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaConcatenationPipelineCmdlet.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.CHMMP.NewCHMMPMediaLiveConnectorPipelineCmdlet"> <summary> Creates a streaming media pipeline in an Amazon Chime SDK meeting. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaLiveConnectorPipelineCmdlet.ClientRequestToken"> <summary> <para> <para>The token assigned to the client making the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaLiveConnectorPipelineCmdlet.Sink"> <summary> <para> <para>The media pipeline's data sinks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaLiveConnectorPipelineCmdlet.Source"> <summary> <para> <para>The media pipeline's data sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaLiveConnectorPipelineCmdlet.Tag"> <summary> <para> <para>The tags associated with the media pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaLiveConnectorPipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MediaLiveConnectorPipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMediaPipelines.Model.CreateMediaLiveConnectorPipelineResponse). Specifying the name of a property of type Amazon.ChimeSDKMediaPipelines.Model.CreateMediaLiveConnectorPipelineResponse 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.CHMMP.NewCHMMPMediaLiveConnectorPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClientRequestToken parameter. The -PassThru parameter is deprecated, use -Select '^ClientRequestToken' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaLiveConnectorPipelineCmdlet.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.CHMMP.RemoveCHMMPMediaCapturePipelineCmdlet"> <summary> Deletes the media pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPMediaCapturePipelineCmdlet.MediaPipelineId"> <summary> <para> <para>The ID of the media pipeline being deleted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPMediaCapturePipelineCmdlet.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.ChimeSDKMediaPipelines.Model.DeleteMediaCapturePipelineResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPMediaCapturePipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MediaPipelineId parameter. The -PassThru parameter is deprecated, use -Select '^MediaPipelineId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPMediaCapturePipelineCmdlet.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.CHMMP.RemoveCHMMPMediaPipelineCmdlet"> <summary> Deletes the media pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPMediaPipelineCmdlet.MediaPipelineId"> <summary> <para> <para>The ID of the media pipeline to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPMediaPipelineCmdlet.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.ChimeSDKMediaPipelines.Model.DeleteMediaPipelineResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPMediaPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MediaPipelineId parameter. The -PassThru parameter is deprecated, use -Select '^MediaPipelineId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPMediaPipelineCmdlet.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.CHMMP.RemoveCHMMPResourceTagCmdlet"> <summary> Removes any tags from a media pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The ARN of the pipeline that you want to untag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPResourceTagCmdlet.TagKey"> <summary> <para> <para>The key/value pairs in the tag that you want to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPResourceTagCmdlet.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.ChimeSDKMediaPipelines.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPResourceTagCmdlet.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.CHMMP.RemoveCHMMPResourceTagCmdlet.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> |