AWS.Tools.ElementalInference.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ElementalInference</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.EMI.AddEMIFeedCmdlet"> <summary> Associates a resource with the feed. The resource provides the input that Elemental Inference needs needs in order to perform an Elemental Inference feature, such as cropping video. You always provide the resource by associating it with a feed. You can associate only one resource with each feed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.AddEMIFeedCmdlet.AssociatedResourceName"> <summary> <para> <para>An identifier for the resource. If the resource is from an AWS service, this identifier must be the full ARN of that resource. Otherwise, the identifier is a name that you assign and that is appropriate for the application that owns the resource. This name must not resemble an ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.AddEMIFeedCmdlet.DryRun"> <summary> <para> <para>Set to true if you want to do a dry run of the associate action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.AddEMIFeedCmdlet.Id"> <summary> <para> <para>The ID of the feed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.AddEMIFeedCmdlet.Output"> <summary> <para> <para>The outputs to add to this feed. You must specify at least one output. You can later use the UpdateFeed action to change the list of outputs.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.AddEMIFeedCmdlet.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.ElementalInference.Model.AssociateFeedResponse). Specifying the name of a property of type Amazon.ElementalInference.Model.AssociateFeedResponse 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.EMI.AddEMIFeedCmdlet.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.EMI.AddEMIResourceTagCmdlet"> <summary> Associates the specified tags to the resource identified by the specified resourceArn in the current region. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.AddEMIResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource where you want to add tags. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.AddEMIResourceTagCmdlet.Tag"> <summary> <para> <para>A list of tags to add to the resource.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.AddEMIResourceTagCmdlet.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.ElementalInference.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.AddEMIResourceTagCmdlet.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.EMI.GetEMIFeedCmdlet"> <summary> Retrieves information about the specified feed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.GetEMIFeedCmdlet.Id"> <summary> <para> <para>The ID of the feed to query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.GetEMIFeedCmdlet.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.ElementalInference.Model.GetFeedResponse). Specifying the name of a property of type Amazon.ElementalInference.Model.GetFeedResponse 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.EMI.GetEMIFeedListCmdlet"> <summary> Displays a list of feeds that belong to this AWS account.<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.EMI.GetEMIFeedListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per API request.</para><para>For example, you submit a list request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.)</para><para>The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.</para><para>Valid Range: Minimum value of 1. Maximum value of 1000.</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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.GetEMIFeedListCmdlet.NextToken"> <summary> <para> <para>The token that identifies the batch of results that you want to see.</para><para>For example, you submit a ListBridges request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListBridges request a second time and specify the NextToken value.</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/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.GetEMIFeedListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Feeds'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ElementalInference.Model.ListFeedsResponse). Specifying the name of a property of type Amazon.ElementalInference.Model.ListFeedsResponse 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.EMI.GetEMIFeedListCmdlet.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.EMI.GetEMIResourceTagCmdlet"> <summary> List all tags that are on an Elemental Inference resource in the current region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.GetEMIResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource whose tags you want to query. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.GetEMIResourceTagCmdlet.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.ElementalInference.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.ElementalInference.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="T:Amazon.PowerShell.Cmdlets.EMI.NewEMIFeedCmdlet"> <summary> Creates a feed. The feed is the target for live streams being sent by the calling application. An example of a calling application is AWS Elemental MediaLive. After you create the feed, you can associate a resource with the feed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.NewEMIFeedCmdlet.Name"> <summary> <para> <para>A name for this feed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.NewEMIFeedCmdlet.Output"> <summary> <para> <para>An array of outputs for this feed. Each output represents a specific Elemental Inference feature. For example, an output might represent the crop feature. </para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.NewEMIFeedCmdlet.Tag"> <summary> <para> <para>If you want to include tags, add them now. You won't be able to add them later.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.NewEMIFeedCmdlet.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.ElementalInference.Model.CreateFeedResponse). Specifying the name of a property of type Amazon.ElementalInference.Model.CreateFeedResponse 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.EMI.NewEMIFeedCmdlet.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.EMI.RemoveEMIFeedCmdlet"> <summary> Deletes the specified feed. The feed can be deleted at any time. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.RemoveEMIFeedCmdlet.Id"> <summary> <para> <para>The ID of the feed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.RemoveEMIFeedCmdlet.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.ElementalInference.Model.DeleteFeedResponse). Specifying the name of a property of type Amazon.ElementalInference.Model.DeleteFeedResponse 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.EMI.RemoveEMIFeedCmdlet.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.EMI.RemoveEMIResourceTagCmdlet"> <summary> Deletes specified tags from the specified resource in the current region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.RemoveEMIResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The ARN of the resource where you want to delete one or more tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.RemoveEMIResourceTagCmdlet.TagKey"> <summary> <para> <para>The keys of the tags to delete.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.RemoveEMIResourceTagCmdlet.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.ElementalInference.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.RemoveEMIResourceTagCmdlet.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.EMI.UnregisterEMIFeedCmdlet"> <summary> Releases the resource (for example, an MediaLive channel) that is associated with this feed. The outputs in the feed become disabled. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.UnregisterEMIFeedCmdlet.AssociatedResourceName"> <summary> <para> <para>The name of the resource currently associated with the feed'.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.UnregisterEMIFeedCmdlet.DryRun"> <summary> <para> <para>Set to true if you want to do a dry run of the disassociate action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.UnregisterEMIFeedCmdlet.Id"> <summary> <para> <para>The ID of the feed where you want to release the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.UnregisterEMIFeedCmdlet.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.ElementalInference.Model.DisassociateFeedResponse). Specifying the name of a property of type Amazon.ElementalInference.Model.DisassociateFeedResponse 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.EMI.UnregisterEMIFeedCmdlet.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.EMI.UpdateEMIFeedCmdlet"> <summary> Updates the name and/or outputs in a feed. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.UpdateEMIFeedCmdlet.Id"> <summary> <para> <para>The ID of the feed to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.UpdateEMIFeedCmdlet.Name"> <summary> <para> <para>Required. You can specify the existing name (to leave it unchanged) or a new name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.UpdateEMIFeedCmdlet.Output"> <summary> <para> <para>Required. You can specify the existing array of outputs (to leave outputs unchanged) or you can specify a new array. </para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.EMI.UpdateEMIFeedCmdlet.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.ElementalInference.Model.UpdateFeedResponse). Specifying the name of a property of type Amazon.ElementalInference.Model.UpdateFeedResponse 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.EMI.UpdateEMIFeedCmdlet.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> |