AWS.Tools.KinesisVideo.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.KinesisVideo</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.KV.AddKVResourceTagCmdlet"> <summary> Adds one or more tags to a signaling channel. A <i>tag</i> is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation Tags</a> in the <i>Billing and Cost Management and Cost Management User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.AddKVResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the signaling channel to which you want to add tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.AddKVResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tags to associate with the specified signaling channel. Each tag is a key-value pair.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.AddKVResourceTagCmdlet.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.KinesisVideo.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.AddKVResourceTagCmdlet.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.KV.AddKVStreamTagCmdlet"> <summary> Adds one or more tags to a stream. A <i>tag</i> is a key-value pair (the value is optional) that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using Cost Allocation Tags</a> in the <i>Billing and Cost Management and Cost Management User Guide</i>. <para> You must provide either the <c>StreamName</c> or the <c>StreamARN</c>. </para><para> This operation requires permission for the <c>KinesisVideo:TagStream</c> action. </para><para> A Kinesis video stream can support up to 50 tags. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.AddKVStreamTagCmdlet.StreamARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.AddKVStreamTagCmdlet.StreamName"> <summary> <para> <para>The name of the stream that you want to add the tag or tags to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.AddKVStreamTagCmdlet.Tag"> <summary> <para> <para>A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.AddKVStreamTagCmdlet.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.KinesisVideo.Model.TagStreamResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.AddKVStreamTagCmdlet.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.KV.GetKVDataEndpointCmdlet"> <summary> Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the <c>GetMedia</c> or <c>GetMediaForFragmentList</c> operations) or write to it (using the <c>PutMedia</c> operation). <note><para> The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint. </para></note><para> In the request, specify the stream either by <c>StreamName</c> or <c>StreamARN</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVDataEndpointCmdlet.APIName"> <summary> <para> <para>The name of the API action for which to get an endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVDataEndpointCmdlet.StreamARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a <c>StreamName</c> in the request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVDataEndpointCmdlet.StreamName"> <summary> <para> <para>The name of the stream that you want to get the endpoint for. You must specify either this parameter or a <c>StreamARN</c> in the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVDataEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DataEndpoint'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideo.Model.GetDataEndpointResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.GetDataEndpointResponse 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.KV.GetKVEdgeAgentConfigurationListCmdlet"> <summary> Returns an array of edge configurations associated with the specified Edge Agent. <para> In the request, you must specify the Edge Agent <c>HubDeviceArn</c>. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVEdgeAgentConfigurationListCmdlet.HubDeviceArn"> <summary> <para> <para>The "Internet of Things (IoT) Thing" Arn of the edge agent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVEdgeAgentConfigurationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of edge configurations to return in the response. The default is 5.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVEdgeAgentConfigurationListCmdlet.NextToken"> <summary> <para> <para>If you specify this parameter, when the result of a <c>ListEdgeAgentConfigurations</c> operation is truncated, the call returns the <c>NextToken</c> in the response. To get another batch of edge configurations, provide this token in your next request. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVEdgeAgentConfigurationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EdgeConfigs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideo.Model.ListEdgeAgentConfigurationsResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.ListEdgeAgentConfigurationsResponse 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.KV.GetKVEdgeAgentConfigurationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KV.GetKVEdgeConfigurationCmdlet"> <summary> Describes a stream’s edge configuration that was set using the <c>StartEdgeConfigurationUpdate</c> API and the latest status of the edge agent's recorder and uploader jobs. Use this API to get the status of the configuration to determine if the configuration is in sync with the Edge Agent. Use this API to evaluate the health of the Edge Agent. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVEdgeConfigurationCmdlet.StreamARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the stream. Specify either the <c>StreamName</c>or the <c>StreamARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVEdgeConfigurationCmdlet.StreamName"> <summary> <para> <para>The name of the stream whose edge configuration you want to update. Specify either the <c>StreamName</c> or the <c>StreamARN</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVEdgeConfigurationCmdlet.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.KinesisVideo.Model.DescribeEdgeConfigurationResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.DescribeEdgeConfigurationResponse 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.KV.GetKVImageGenerationConfigurationCmdlet"> <summary> Gets the <c>ImageGenerationConfiguration</c> for a given Kinesis video stream. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVImageGenerationConfigurationCmdlet.StreamARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Kinesis video stream from which to retrieve the image generation configuration. You must specify either the <c>StreamName</c> or the <c>StreamARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVImageGenerationConfigurationCmdlet.StreamName"> <summary> <para> <para>The name of the stream from which to retrieve the image generation configuration. You must specify either the <c>StreamName</c> or the <c>StreamARN</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVImageGenerationConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ImageGenerationConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideo.Model.DescribeImageGenerationConfigurationResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.DescribeImageGenerationConfigurationResponse 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.KV.GetKVMappedResourceConfigurationCmdlet"> <summary> Returns the most current information about the stream. The <c>streamName</c> or <c>streamARN</c> should be provided in the input.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVMappedResourceConfigurationCmdlet.StreamARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVMappedResourceConfigurationCmdlet.StreamName"> <summary> <para> <para>The name of the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVMappedResourceConfigurationCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVMappedResourceConfigurationCmdlet.NextToken"> <summary> <para> <para>The token to provide in your next request, to get another batch of results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVMappedResourceConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MappedResourceConfigurationList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideo.Model.DescribeMappedResourceConfigurationResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.DescribeMappedResourceConfigurationResponse 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.KV.GetKVMappedResourceConfigurationCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KV.GetKVMediaStorageConfigurationCmdlet"> <summary> Returns the most current information about the channel. Specify the <c>ChannelName</c> or <c>ChannelARN</c> in the input. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVMediaStorageConfigurationCmdlet.ChannelARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVMediaStorageConfigurationCmdlet.ChannelName"> <summary> <para> <para>The name of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVMediaStorageConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MediaStorageConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideo.Model.DescribeMediaStorageConfigurationResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.DescribeMediaStorageConfigurationResponse 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.KV.GetKVNotificationConfigurationCmdlet"> <summary> Gets the <c>NotificationConfiguration</c> for a given Kinesis video stream. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVNotificationConfigurationCmdlet.StreamARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to retrieve the notification configuration. You must specify either the <c>StreamName</c> or the StreamARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVNotificationConfigurationCmdlet.StreamName"> <summary> <para> <para>The name of the stream from which to retrieve the notification configuration. You must specify either the <c>StreamName</c> or the <c>StreamARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVNotificationConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NotificationConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideo.Model.DescribeNotificationConfigurationResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.DescribeNotificationConfigurationResponse 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.KV.GetKVResourceTagCmdlet"> <summary> Returns a list of tags associated with the specified signaling channel.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the signaling channel for which you want to list tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVResourceTagCmdlet.NextToken"> <summary> <para> <para>If you specify this parameter and the result of a <c>ListTagsForResource</c> call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVResourceTagCmdlet.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.KinesisVideo.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.KinesisVideo.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.KV.GetKVResourceTagCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KV.GetKVSignalingChannelCmdlet"> <summary> Returns the most current information about the signaling channel. You must specify either the name or the Amazon Resource Name (ARN) of the channel that you want to describe. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVSignalingChannelCmdlet.ChannelARN"> <summary> <para> <para>The ARN of the signaling channel that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVSignalingChannelCmdlet.ChannelName"> <summary> <para> <para>The name of the signaling channel that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVSignalingChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelInfo'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideo.Model.DescribeSignalingChannelResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.DescribeSignalingChannelResponse 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.KV.GetKVSignalingChannelEndpointCmdlet"> <summary> Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the <c>SingleMasterChannelEndpointConfiguration</c> input parameter, which consists of the <c>Protocols</c> and <c>Role</c> properties. <para><c>Protocols</c> is used to determine the communication mechanism. For example, if you specify <c>WSS</c> as the protocol, this API produces a secure websocket endpoint. If you specify <c>HTTPS</c> as the protocol, this API generates an HTTPS endpoint. </para><para><c>Role</c> determines the messaging permissions. A <c>MASTER</c> role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A <c>VIEWER</c> role results in this API generating an endpoint that a client can use to communicate only with a <c>MASTER</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVSignalingChannelEndpointCmdlet.ChannelARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the signalling channel for which you want to get an endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVSignalingChannelEndpointCmdlet.SingleMasterChannelEndpointConfiguration_Protocol"> <summary> <para> <para>This property is used to determine the nature of communication over this <c>SINGLE_MASTER</c> signaling channel. If <c>WSS</c> is specified, this API returns a websocket endpoint. If <c>HTTPS</c> is specified, this API returns an <c>HTTPS</c> endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVSignalingChannelEndpointCmdlet.SingleMasterChannelEndpointConfiguration_Role"> <summary> <para> <para>This property is used to determine messaging permissions in this <c>SINGLE_MASTER</c> signaling channel. If <c>MASTER</c> is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If <c>VIEWER</c> is specified, this API returns an endpoint that a client can use only to send offers to another <c>MASTER</c> client on this signaling channel. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVSignalingChannelEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceEndpointList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideo.Model.GetSignalingChannelEndpointResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.GetSignalingChannelEndpointResponse 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.KV.GetKVSignalingChannelListCmdlet"> <summary> Returns an array of <c>ChannelInfo</c> objects. Each object describes a signaling channel. To retrieve only those channels that satisfy a specific condition, you can specify a <c>ChannelNameCondition</c>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVSignalingChannelListCmdlet.ChannelNameCondition_ComparisonOperator"> <summary> <para> <para>A comparison operator. Currently, you can only specify the <c>BEGINS_WITH</c> operator, which finds signaling channels whose names begin with a given prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVSignalingChannelListCmdlet.ChannelNameCondition_ComparisonValue"> <summary> <para> <para>A value to compare.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVSignalingChannelListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of channels to return in the response. The default is 500.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>10000</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVSignalingChannelListCmdlet.NextToken"> <summary> <para> <para>If you specify this parameter, when the result of a <c>ListSignalingChannels</c> operation is truncated, the call returns the <c>NextToken</c> in the response. To get another batch of channels, provide this token in your next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVSignalingChannelListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelInfoList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideo.Model.ListSignalingChannelsResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.ListSignalingChannelsResponse 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.KV.GetKVSignalingChannelListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KV.GetKVStreamCmdlet"> <summary> Returns the most current information about the specified stream. You must specify either the <c>StreamName</c> or the <c>StreamARN</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVStreamCmdlet.StreamARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVStreamCmdlet.StreamName"> <summary> <para> <para>The name of the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVStreamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamInfo'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideo.Model.DescribeStreamResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.DescribeStreamResponse 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.KV.GetKVStreamListCmdlet"> <summary> Returns an array of <c>StreamInfo</c> objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a <c>StreamNameCondition</c>.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVStreamListCmdlet.StreamNameCondition"> <summary> <para> <para>Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVStreamListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of streams to return in the response. The default is 10,000.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>10000</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVStreamListCmdlet.NextToken"> <summary> <para> <para>If you specify this parameter, when the result of a <c>ListStreams</c> operation is truncated, the call returns the <c>NextToken</c> in the response. To get another batch of streams, provide this token in your next request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVStreamListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamInfoList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideo.Model.ListStreamsResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.ListStreamsResponse 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.KV.GetKVStreamListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KV.GetKVTagsForStreamListCmdlet"> <summary> Returns a list of tags associated with the specified stream. <para> In the request, you must specify either the <c>StreamName</c> or the <c>StreamARN</c>. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVTagsForStreamListCmdlet.StreamARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the stream that you want to list tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVTagsForStreamListCmdlet.StreamName"> <summary> <para> <para>The name of the stream that you want to list tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVTagsForStreamListCmdlet.NextToken"> <summary> <para> <para>If you specify this parameter and the result of a <c>ListTagsForStream</c> call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.GetKVTagsForStreamListCmdlet.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.KinesisVideo.Model.ListTagsForStreamResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.ListTagsForStreamResponse 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.KV.GetKVTagsForStreamListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.KV.NewKVSignalingChannelCmdlet"> <summary> Creates a signaling channel. <para><c>CreateSignalingChannel</c> is an asynchronous operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.NewKVSignalingChannelCmdlet.ChannelName"> <summary> <para> <para>A name for the signaling channel that you are creating. It must be unique for each Amazon Web Services account and Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.NewKVSignalingChannelCmdlet.ChannelType"> <summary> <para> <para>A type of the signaling channel that you are creating. Currently, <c>SINGLE_MASTER</c> is the only supported channel type. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.NewKVSignalingChannelCmdlet.SingleMasterConfiguration_MessageTtlSecond"> <summary> <para> <para>The period of time a signaling channel retains undelivered messages before they are discarded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.NewKVSignalingChannelCmdlet.Tag"> <summary> <para> <para>A set of tags (key-value pairs) that you want to associate with this channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.NewKVSignalingChannelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChannelARN'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideo.Model.CreateSignalingChannelResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.CreateSignalingChannelResponse 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.KV.NewKVSignalingChannelCmdlet.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.KV.NewKVStreamCmdlet"> <summary> Creates a new Kinesis video stream. <para> When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version. </para><para><c>CreateStream</c> is an asynchronous operation. </para><para> For information about how the service works, see <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-it-works.html">How it Works</a>. </para><para> You must have permissions for the <c>KinesisVideo:CreateStream</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.NewKVStreamCmdlet.DataRetentionInHour"> <summary> <para> <para>The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.</para><para>The default value is 0, indicating that the stream does not persist data.</para><para>When the <c>DataRetentionInHours</c> value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.NewKVStreamCmdlet.DeviceName"> <summary> <para> <para>The name of the device that is writing to the stream. </para><note><para>In the current implementation, Kinesis Video Streams does not use this name.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.NewKVStreamCmdlet.KmsKeyId"> <summary> <para> <para>The ID of the Key Management Service (KMS) key that you want Kinesis Video Streams to use to encrypt stream data.</para><para>If no key ID is specified, the default, Kinesis Video-managed key (<c>Amazon Web Services/kinesisvideo</c>) is used.</para><para> For more information, see <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters">DescribeKey</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.NewKVStreamCmdlet.MediaType"> <summary> <para> <para>The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see <a href="http://www.iana.org/assignments/media-types/media-types.xhtml">Media Types</a>. If you choose to specify the <c>MediaType</c>, see <a href="https://tools.ietf.org/html/rfc6838#section-4.2">Naming Requirements</a> for guidelines.</para><para>Example valid values include "video/h264" and "video/h264,audio/aac".</para><para>This parameter is optional; the default value is <c>null</c> (or empty in JSON).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.NewKVStreamCmdlet.StreamName"> <summary> <para> <para>A name for the stream that you are creating.</para><para>The stream name is an identifier for the stream, and must be unique for each account and region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.NewKVStreamCmdlet.Tag"> <summary> <para> <para>A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.NewKVStreamCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamARN'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KinesisVideo.Model.CreateStreamResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.CreateStreamResponse 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.KV.NewKVStreamCmdlet.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.KV.RemoveKVEdgeConfigurationCmdlet"> <summary> An asynchronous API that deletes a stream’s existing edge configuration, as well as the corresponding media from the Edge Agent. <para> When you invoke this API, the sync status is set to <c>DELETING</c>. A deletion process starts, in which active edge jobs are stopped and all media is deleted from the edge device. The time to delete varies, depending on the total amount of stored media. If the deletion process fails, the sync status changes to <c>DELETE_FAILED</c>. You will need to re-try the deletion. </para><para> When the deletion process has completed successfully, the edge configuration is no longer accessible. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVEdgeConfigurationCmdlet.StreamARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the stream. Specify either the <c>StreamName</c> or the <c>StreamARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVEdgeConfigurationCmdlet.StreamName"> <summary> <para> <para>The name of the stream from which to delete the edge configuration. Specify either the <c>StreamName</c> or the <c>StreamARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVEdgeConfigurationCmdlet.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.KinesisVideo.Model.DeleteEdgeConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVEdgeConfigurationCmdlet.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.KV.RemoveKVResourceTagCmdlet"> <summary> Removes one or more tags from a signaling channel. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the signaling channel from which you want to remove tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVResourceTagCmdlet.TagKeyList"> <summary> <para> <para>A list of the keys of the tags that you want to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVResourceTagCmdlet.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.KinesisVideo.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVResourceTagCmdlet.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.KV.RemoveKVSignalingChannelCmdlet"> <summary> Deletes a specified signaling channel. <c>DeleteSignalingChannel</c> is an asynchronous operation. If you don't specify the channel's current version, the most recent version is deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVSignalingChannelCmdlet.ChannelARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the signaling channel that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVSignalingChannelCmdlet.CurrentVersion"> <summary> <para> <para>The current version of the signaling channel that you want to delete. You can obtain the current version by invoking the <c>DescribeSignalingChannel</c> or <c>ListSignalingChannels</c> API operations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVSignalingChannelCmdlet.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.KinesisVideo.Model.DeleteSignalingChannelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVSignalingChannelCmdlet.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.KV.RemoveKVStreamCmdlet"> <summary> Deletes a Kinesis video stream and the data contained in the stream. <para> This method marks the stream for deletion, and makes the data in the stream inaccessible immediately. </para><para></para><para> To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the <c>DescribeStream</c> API. </para><para> This operation requires permission for the <c>KinesisVideo:DeleteStream</c> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVStreamCmdlet.CurrentVersion"> <summary> <para> <para>Optional: The version of the stream that you want to delete. </para><para>Specify the version as a safeguard to ensure that your are deleting the correct stream. To get the stream version, use the <c>DescribeStream</c> API.</para><para>If not specified, only the <c>CreationTime</c> is checked before deleting the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVStreamCmdlet.StreamARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the stream that you want to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVStreamCmdlet.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.KinesisVideo.Model.DeleteStreamResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVStreamCmdlet.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.KV.RemoveKVStreamTagCmdlet"> <summary> Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored. <para> In the request, you must provide the <c>StreamName</c> or <c>StreamARN</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVStreamTagCmdlet.StreamARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the stream that you want to remove tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVStreamTagCmdlet.StreamName"> <summary> <para> <para>The name of the stream that you want to remove tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVStreamTagCmdlet.TagKeyList"> <summary> <para> <para>A list of the keys of the tags that you want to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVStreamTagCmdlet.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.KinesisVideo.Model.UntagStreamResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.RemoveKVStreamTagCmdlet.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.KV.StartKVEdgeConfigurationUpdateCmdlet"> <summary> An asynchronous API that updates a stream’s existing edge configuration. The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary and depends on the connectivity of the Hub Device. The <c>SyncStatus</c> will be updated as the edge configuration is acknowledged, and synced with the Edge Agent. <para> If this API is invoked for the first time, a new edge configuration will be created for the stream, and the sync status will be set to <c>SYNCING</c>. You will have to wait for the sync status to reach a terminal state such as: <c>IN_SYNC</c>, or <c>SYNC_FAILED</c>, before using this API again. If you invoke this API during the syncing process, a <c>ResourceInUseException</c> will be thrown. The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes, the status will transition into the <c>SYNC_FAILED</c> state. </para><para> To move an edge configuration from one device to another, use <a>DeleteEdgeConfiguration</a> to delete the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.StartKVEdgeConfigurationUpdateCmdlet.DeletionConfig_DeleteAfterUpload"> <summary> <para> <para>The <c>boolean</c> value used to indicate whether or not you want to mark the media for deletion, once it has been uploaded to the Kinesis Video Stream cloud. The media files can be deleted if any of the deletion configuration values are set to <c>true</c>, such as when the limit for the <c>EdgeRetentionInHours</c>, or the <c>MaxLocalMediaSizeInMB</c>, has been reached. </para><para>Since the default value is set to <c>true</c>, configure the uploader schedule such that the media files are not being deleted before they are initially uploaded to the Amazon Web Services cloud.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.StartKVEdgeConfigurationUpdateCmdlet.EdgeConfig_RecorderConfig_ScheduleConfig_DurationInSeconds"> <summary> <para> <para>The total duration to record the media. If the <c>ScheduleExpression</c> attribute is provided, then the <c>DurationInSeconds</c> attribute should also be specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.StartKVEdgeConfigurationUpdateCmdlet.EdgeConfig_UploaderConfig_ScheduleConfig_DurationInSeconds"> <summary> <para> <para>The total duration to record the media. If the <c>ScheduleExpression</c> attribute is provided, then the <c>DurationInSeconds</c> attribute should also be specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.StartKVEdgeConfigurationUpdateCmdlet.DeletionConfig_EdgeRetentionInHour"> <summary> <para> <para>The number of hours that you want to retain the data in the stream on the Edge Agent. The default value of the retention time is 720 hours, which translates to 30 days.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.StartKVEdgeConfigurationUpdateCmdlet.EdgeConfig_HubDeviceArn"> <summary> <para> <para>The "<b>Internet of Things (IoT) Thing</b>" Arn of the stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.StartKVEdgeConfigurationUpdateCmdlet.LocalSizeConfig_MaxLocalMediaSizeInMB"> <summary> <para> <para>The overall maximum size of the media that you want to store for a stream on the Edge Agent. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.StartKVEdgeConfigurationUpdateCmdlet.MediaSourceConfig_MediaUriSecretArn"> <summary> <para> <para>The Amazon Web Services Secrets Manager ARN for the username and password of the camera, or a local media file location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.StartKVEdgeConfigurationUpdateCmdlet.MediaSourceConfig_MediaUriType"> <summary> <para> <para>The Uniform Resource Identifier (URI) type. The <c>FILE_URI</c> value can be used to stream local media files.</para><note><para>Preview only supports the <c>RTSP_URI</c> media source URI format .</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.StartKVEdgeConfigurationUpdateCmdlet.EdgeConfig_RecorderConfig_ScheduleConfig_ScheduleExpression"> <summary> <para> <para>The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the <c>ScheduleExpression</c> is not provided for the <c>RecorderConfig</c>, then the Edge Agent will always be set to recording mode.</para><para>For more information about Quartz, refer to the <a href="http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html"><i>Cron Trigger Tutorial</i></a> page to understand the valid expressions and its use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.StartKVEdgeConfigurationUpdateCmdlet.EdgeConfig_UploaderConfig_ScheduleConfig_ScheduleExpression"> <summary> <para> <para>The Quartz cron expression that takes care of scheduling jobs to record from the camera, or local media file, onto the Edge Agent. If the <c>ScheduleExpression</c> is not provided for the <c>RecorderConfig</c>, then the Edge Agent will always be set to recording mode.</para><para>For more information about Quartz, refer to the <a href="http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html"><i>Cron Trigger Tutorial</i></a> page to understand the valid expressions and its use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.StartKVEdgeConfigurationUpdateCmdlet.LocalSizeConfig_StrategyOnFullSize"> <summary> <para> <para>The strategy to perform when a stream’s <c>MaxLocalMediaSizeInMB</c> limit is reached.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.StartKVEdgeConfigurationUpdateCmdlet.StreamARN"> <summary> <para> <para> The Amazon Resource Name (ARN) of the stream. Specify either the <c>StreamName</c> or the <c>StreamARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.StartKVEdgeConfigurationUpdateCmdlet.StreamName"> <summary> <para> <para>The name of the stream whose edge configuration you want to update. Specify either the <c>StreamName</c> or the <c>StreamARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.StartKVEdgeConfigurationUpdateCmdlet.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.KinesisVideo.Model.StartEdgeConfigurationUpdateResponse). Specifying the name of a property of type Amazon.KinesisVideo.Model.StartEdgeConfigurationUpdateResponse 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.KV.StartKVEdgeConfigurationUpdateCmdlet.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.KV.UpdateKVDataRetentionCmdlet"> <summary> Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the <c>Operation</c> parameter in the request body. In the request, you must specify either the <c>StreamName</c> or the <c>StreamARN</c>. <para> This operation requires permission for the <c>KinesisVideo:UpdateDataRetention</c> action. </para><para> Changing the data retention period affects the data in the stream as follows: </para><ul><li><para> If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours. </para></li><li><para> If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVDataRetentionCmdlet.CurrentVersion"> <summary> <para> <para>The version of the stream whose retention period you want to change. To get the version, call either the <c>DescribeStream</c> or the <c>ListStreams</c> API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVDataRetentionCmdlet.DataRetentionChangeInHour"> <summary> <para> <para>The number of hours to adjust the current retention by. The value you specify is added to or subtracted from the current value, depending on the <c>operation</c>.</para><para>The minimum value for data retention is 0 and the maximum value is 87600 (ten years).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVDataRetentionCmdlet.Operation"> <summary> <para> <para>Indicates whether you want to increase or decrease the retention period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVDataRetentionCmdlet.StreamARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the stream whose retention period you want to change.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVDataRetentionCmdlet.StreamName"> <summary> <para> <para>The name of the stream whose retention period you want to change.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVDataRetentionCmdlet.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.KinesisVideo.Model.UpdateDataRetentionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVDataRetentionCmdlet.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.KV.UpdateKVImageGenerationConfigurationCmdlet"> <summary> Updates the <c>StreamInfo</c> and <c>ImageProcessingConfiguration</c> fields. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVImageGenerationConfigurationCmdlet.DestinationConfig_DestinationRegion"> <summary> <para> <para>The Amazon Web Services Region of the S3 bucket where images will be delivered. This <c>DestinationRegion</c> must match the Region where the stream is located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVImageGenerationConfigurationCmdlet.ImageGenerationConfiguration_Format"> <summary> <para> <para>The accepted image format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVImageGenerationConfigurationCmdlet.ImageGenerationConfiguration_FormatConfig"> <summary> <para> <para>The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The <c>FormatConfig</c> key is the <c>JPEGQuality</c>, which indicates the JPEG quality key to be used to generate the image. The <c>FormatConfig</c> value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the <c>JPEGQuality</c> key will be set to 80.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVImageGenerationConfigurationCmdlet.ImageGenerationConfiguration_HeightPixel"> <summary> <para> <para>The height of the output image that is used in conjunction with the <c>WidthPixels</c> parameter. When both <c>HeightPixels</c> and <c>WidthPixels</c> parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the <c>HeightPixels</c> parameter is provided, its original aspect ratio will be used to calculate the <c>WidthPixels</c> ratio. If neither parameter is provided, the original image size will be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVImageGenerationConfigurationCmdlet.ImageGenerationConfiguration_ImageSelectorType"> <summary> <para> <para>The origin of the Server or Producer timestamps to use to generate the images.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVImageGenerationConfigurationCmdlet.ImageGenerationConfiguration_SamplingInterval"> <summary> <para> <para>The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the <c>StartTimestamp</c> will be returned if available. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVImageGenerationConfigurationCmdlet.ImageGenerationConfiguration_Status"> <summary> <para> <para>Indicates whether the <c>ContinuousImageGenerationConfigurations</c> API is enabled or disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVImageGenerationConfigurationCmdlet.StreamARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to update the image generation configuration. You must specify either the <c>StreamName</c> or the <c>StreamARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVImageGenerationConfigurationCmdlet.StreamName"> <summary> <para> <para>The name of the stream from which to update the image generation configuration. You must specify either the <c>StreamName</c> or the <c>StreamARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVImageGenerationConfigurationCmdlet.DestinationConfig_Uri"> <summary> <para> <para>The Uniform Resource Identifier (URI) that identifies where the images will be delivered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVImageGenerationConfigurationCmdlet.ImageGenerationConfiguration_WidthPixel"> <summary> <para> <para>The width of the output image that is used in conjunction with the <c>HeightPixels</c> parameter. When both <c>WidthPixels</c> and <c>HeightPixels</c> parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the <c>WidthPixels</c> parameter is provided, its original aspect ratio will be used to calculate the <c>HeightPixels</c> ratio. If neither parameter is provided, the original image size will be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVImageGenerationConfigurationCmdlet.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.KinesisVideo.Model.UpdateImageGenerationConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVImageGenerationConfigurationCmdlet.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.KV.UpdateKVMediaStorageConfigurationCmdlet"> <summary> Associates a <c>SignalingChannel</c> to a stream to store the media. There are two signaling modes that you can specify : <ul><li><para> If <c>StorageStatus</c> is enabled, the data will be stored in the <c>StreamARN</c> provided. In order for WebRTC Ingestion to work, the stream must have data retention enabled. </para></li><li><para> If <c>StorageStatus</c> is disabled, no data will be stored, and the <c>StreamARN</c> parameter will not be needed. </para></li></ul><important><para> If <c>StorageStatus</c> is enabled, direct peer-to-peer (master-viewer) connections no longer occur. Peers connect directly to the storage session. You must call the <c>JoinStorageSession</c> API to trigger an SDP offer send and establish a connection between a peer and the storage session. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVMediaStorageConfigurationCmdlet.ChannelARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVMediaStorageConfigurationCmdlet.MediaStorageConfiguration_Status"> <summary> <para> <para>The status of the media storage configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVMediaStorageConfigurationCmdlet.MediaStorageConfiguration_StreamARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the stream. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVMediaStorageConfigurationCmdlet.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.KinesisVideo.Model.UpdateMediaStorageConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVMediaStorageConfigurationCmdlet.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.KV.UpdateKVNotificationConfigurationCmdlet"> <summary> Updates the notification information for a stream. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVNotificationConfigurationCmdlet.NotificationConfiguration_Status"> <summary> <para> <para>Indicates if a notification configuration is enabled or disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVNotificationConfigurationCmdlet.StreamARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to update the notification configuration. You must specify either the <c>StreamName</c> or the <c>StreamARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVNotificationConfigurationCmdlet.StreamName"> <summary> <para> <para>The name of the stream from which to update the notification configuration. You must specify either the <c>StreamName</c> or the <c>StreamARN</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVNotificationConfigurationCmdlet.DestinationConfig_Uri"> <summary> <para> <para>The Uniform Resource Identifier (URI) that identifies where the images will be delivered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVNotificationConfigurationCmdlet.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.KinesisVideo.Model.UpdateNotificationConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVNotificationConfigurationCmdlet.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.KV.UpdateKVSignalingChannelCmdlet"> <summary> Updates the existing signaling channel. This is an asynchronous operation and takes time to complete. <para> If the <c>MessageTtlSeconds</c> value is updated (either increased or reduced), it only applies to new messages sent via this channel after it's been updated. Existing messages are still expired as per the previous <c>MessageTtlSeconds</c> value. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVSignalingChannelCmdlet.ChannelARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the signaling channel that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVSignalingChannelCmdlet.CurrentVersion"> <summary> <para> <para>The current version of the signaling channel that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVSignalingChannelCmdlet.SingleMasterConfiguration_MessageTtlSecond"> <summary> <para> <para>The period of time a signaling channel retains undelivered messages before they are discarded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVSignalingChannelCmdlet.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.KinesisVideo.Model.UpdateSignalingChannelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVSignalingChannelCmdlet.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.KV.UpdateKVStreamCmdlet"> <summary> Updates stream metadata, such as the device name and media type. <para> You must provide the stream name or the Amazon Resource Name (ARN) of the stream. </para><para> To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the <c>DescribeStream</c> API. </para><para><c>UpdateStream</c> is an asynchronous operation, and takes time to complete. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVStreamCmdlet.CurrentVersion"> <summary> <para> <para>The version of the stream whose metadata you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVStreamCmdlet.DeviceName"> <summary> <para> <para>The name of the device that is writing to the stream. </para><note><para> In the current implementation, Kinesis Video Streams does not use this name. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVStreamCmdlet.MediaType"> <summary> <para> <para>The stream's media type. Use <c>MediaType</c> to specify the type of content that the stream contains to the consumers of the stream. For more information about media types, see <a href="http://www.iana.org/assignments/media-types/media-types.xhtml">Media Types</a>. If you choose to specify the <c>MediaType</c>, see <a href="https://tools.ietf.org/html/rfc6838#section-4.2">Naming Requirements</a>.</para><para>To play video on the console, you must specify the correct video type. For example, if the video in the stream is H.264, specify <c>video/h264</c> as the <c>MediaType</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVStreamCmdlet.StreamARN"> <summary> <para> <para>The ARN of the stream whose metadata you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVStreamCmdlet.StreamName"> <summary> <para> <para>The name of the stream whose metadata you want to update.</para><para>The stream name is an identifier for the stream, and must be unique for each account and region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVStreamCmdlet.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.KinesisVideo.Model.UpdateStreamResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.KV.UpdateKVStreamCmdlet.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> |