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 the 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.GetCHMMPMediaInsightsPipelineConfigurationCmdlet"> <summary> Gets the configuration settings for a media insights pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaInsightsPipelineConfigurationCmdlet.Identifier"> <summary> <para> <para>The unique identifier of the requested resource. Valid values include the name and ARN of the media insights pipeline configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaInsightsPipelineConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MediaInsightsPipelineConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMediaPipelines.Model.GetMediaInsightsPipelineConfigurationResponse). Specifying the name of a property of type Amazon.ChimeSDKMediaPipelines.Model.GetMediaInsightsPipelineConfigurationResponse 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.GetCHMMPMediaInsightsPipelineConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Identifier parameter. The -PassThru parameter is deprecated, use -Select '^Identifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaInsightsPipelineConfigurationListCmdlet"> <summary> Lists the available media insights pipeline configurations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaInsightsPipelineConfigurationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in a single call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaInsightsPipelineConfigurationListCmdlet.NextToken"> <summary> <para> <para>The token used to return the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.GetCHMMPMediaInsightsPipelineConfigurationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MediaInsightsPipelineConfigurations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMediaPipelines.Model.ListMediaInsightsPipelineConfigurationsResponse). Specifying the name of a property of type Amazon.ChimeSDKMediaPipelines.Model.ListMediaInsightsPipelineConfigurationsResponse 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.NewCHMMPMediaInsightsPipelineCmdlet"> <summary> Creates a media insights pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineCmdlet.ClientRequestToken"> <summary> <para> <para>The unique identifier for the media insights pipeline request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineCmdlet.S3RecordingSinkRuntimeConfiguration_Destination"> <summary> <para> <para>The URI of the S3 bucket used as the sink.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineCmdlet.TimestampRange_EndTimestamp"> <summary> <para> <para>The ending timestamp for the specified range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineCmdlet.FragmentSelector_FragmentSelectorType"> <summary> <para> <para>The origin of the timestamps to use, <code>Server</code> or <code>Producer</code>. For more information, see <a href="kinesisvideostreams/latest/dg/API_dataplane_StartSelector.html#KinesisVideo-Type-dataplane_StartSelector-StartSelectorType">StartSelectorType</a> in the <i>Amazon Kinesis Video Streams Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineCmdlet.KinesisVideoStreamSourceRuntimeConfiguration_MediaEncoding"> <summary> <para> <para>Specifies the encoding of your input audio. Supported format: PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</para><para>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> in the <i>Amazon Transcribe Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineCmdlet.MediaInsightsPipelineConfigurationArn"> <summary> <para> <para>The ARN of the pipeline's configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineCmdlet.MediaInsightsRuntimeMetadata"> <summary> <para> <para>The runtime metadata for the media insights pipeline. Consists of a key-value map of strings.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineCmdlet.KinesisVideoStreamSourceRuntimeConfiguration_MediaSampleRate"> <summary> <para> <para>The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.</para><para>Valid Range: Minimum value of 8000. Maximum value of 48000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineCmdlet.S3RecordingSinkRuntimeConfiguration_RecordingFileFormat"> <summary> <para> <para>The file format for the media files sent to the Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineCmdlet.TimestampRange_StartTimestamp"> <summary> <para> <para>The starting timestamp for the specified range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineCmdlet.KinesisVideoStreamRecordingSourceRuntimeConfiguration_Stream"> <summary> <para> <para>The stream or streams to be recorded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineCmdlet.KinesisVideoStreamSourceRuntimeConfiguration_Stream"> <summary> <para> <para>The streams in the source runtime configuration of a Kinesis video stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineCmdlet.Tag"> <summary> <para> <para>The tags assigned to the media insights pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MediaInsightsPipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMediaPipelines.Model.CreateMediaInsightsPipelineResponse). Specifying the name of a property of type Amazon.ChimeSDKMediaPipelines.Model.CreateMediaInsightsPipelineResponse 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.NewCHMMPMediaInsightsPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MediaInsightsPipelineConfigurationArn parameter. The -PassThru parameter is deprecated, use -Select '^MediaInsightsPipelineConfigurationArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineCmdlet.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.NewCHMMPMediaInsightsPipelineConfigurationCmdlet"> <summary> A structure that contains the static configurations for a media insights pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineConfigurationCmdlet.ClientRequestToken"> <summary> <para> <para>The unique identifier for the media insights pipeline configuration request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineConfigurationCmdlet.RealTimeAlertConfiguration_Disabled"> <summary> <para> <para>Turns off real-time alerts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineConfigurationCmdlet.Element"> <summary> <para> <para>The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineConfigurationCmdlet.MediaInsightsPipelineConfigurationName"> <summary> <para> <para>The name of the media insights pipeline configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineConfigurationCmdlet.ResourceAccessRoleArn"> <summary> <para> <para>The ARN of the role used by the service to access Amazon Web Services resources, including <code>Transcribe</code> and <code>Transcribe Call Analytics</code>, on the caller’s behalf.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineConfigurationCmdlet.RealTimeAlertConfiguration_Rule"> <summary> <para> <para>The rules in the alert. Rules specify the words or phrases that you want to be notified about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineConfigurationCmdlet.Tag"> <summary> <para> <para>The tags assigned to the media insights pipeline configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MediaInsightsPipelineConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMediaPipelines.Model.CreateMediaInsightsPipelineConfigurationResponse). Specifying the name of a property of type Amazon.ChimeSDKMediaPipelines.Model.CreateMediaInsightsPipelineConfigurationResponse 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.NewCHMMPMediaInsightsPipelineConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MediaInsightsPipelineConfigurationName parameter. The -PassThru parameter is deprecated, use -Select '^MediaInsightsPipelineConfigurationName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaInsightsPipelineConfigurationCmdlet.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 media live connector 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 live connector pipeline's data sinks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.NewCHMMPMediaLiveConnectorPipelineCmdlet.Source"> <summary> <para> <para>The media live connector 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 live connector 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.RemoveCHMMPMediaInsightsPipelineConfigurationCmdlet"> <summary> Deletes the specified configuration settings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPMediaInsightsPipelineConfigurationCmdlet.Identifier"> <summary> <para> <para>The unique identifier of the resource to be deleted. Valid values include the name and ARN of the media insights pipeline configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPMediaInsightsPipelineConfigurationCmdlet.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.DeleteMediaInsightsPipelineConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPMediaInsightsPipelineConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Identifier parameter. The -PassThru parameter is deprecated, use -Select '^Identifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.RemoveCHMMPMediaInsightsPipelineConfigurationCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CHMMP.UpdateCHMMPMediaInsightsPipelineConfigurationCmdlet"> <summary> Updates the media insights pipeline's configuration settings. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.UpdateCHMMPMediaInsightsPipelineConfigurationCmdlet.RealTimeAlertConfiguration_Disabled"> <summary> <para> <para>Turns off real-time alerts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.UpdateCHMMPMediaInsightsPipelineConfigurationCmdlet.Element"> <summary> <para> <para>The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream..</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.UpdateCHMMPMediaInsightsPipelineConfigurationCmdlet.Identifier"> <summary> <para> <para>The unique identifier for the resource to be updated. Valid values include the name and ARN of the media insights pipeline configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.UpdateCHMMPMediaInsightsPipelineConfigurationCmdlet.ResourceAccessRoleArn"> <summary> <para> <para>The ARN of the role used by the service to access Amazon Web Services resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.UpdateCHMMPMediaInsightsPipelineConfigurationCmdlet.RealTimeAlertConfiguration_Rule"> <summary> <para> <para>The rules in the alert. Rules specify the words or phrases that you want to be notified about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.UpdateCHMMPMediaInsightsPipelineConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MediaInsightsPipelineConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ChimeSDKMediaPipelines.Model.UpdateMediaInsightsPipelineConfigurationResponse). Specifying the name of a property of type Amazon.ChimeSDKMediaPipelines.Model.UpdateMediaInsightsPipelineConfigurationResponse 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.UpdateCHMMPMediaInsightsPipelineConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Identifier parameter. The -PassThru parameter is deprecated, use -Select '^Identifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.UpdateCHMMPMediaInsightsPipelineConfigurationCmdlet.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.UpdateCHMMPMediaInsightsPipelineStatusCmdlet"> <summary> Updates the status of a media insights pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.UpdateCHMMPMediaInsightsPipelineStatusCmdlet.Identifier"> <summary> <para> <para>The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.UpdateCHMMPMediaInsightsPipelineStatusCmdlet.UpdateStatus"> <summary> <para> <para>The requested status of the media insights pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.UpdateCHMMPMediaInsightsPipelineStatusCmdlet.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.UpdateMediaInsightsPipelineStatusResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.UpdateCHMMPMediaInsightsPipelineStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Identifier parameter. The -PassThru parameter is deprecated, use -Select '^Identifier' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CHMMP.UpdateCHMMPMediaInsightsPipelineStatusCmdlet.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> |