AWS.Tools.LookoutforVision.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.LookoutforVision</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.LFV.AddLFVResourceTagCmdlet"> <summary> Adds one or more key-value tags to an Amazon Lookout for Vision model. For more information, see <i>Tagging a model</i> in the <i>Amazon Lookout for Vision Developer Guide</i>. <para> This operation requires permissions to perform the <code>lookoutvision:TagResource</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.AddLFVResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the model to assign the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.AddLFVResourceTagCmdlet.Tag"> <summary> <para> <para>The key-value tags to assign to the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.AddLFVResourceTagCmdlet.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.LookoutforVision.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.AddLFVResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.AddLFVResourceTagCmdlet.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.LFV.FindLFVAnomalyCmdlet"> <summary> Detects anomalies in an image that you supply. <para> The response from <code>DetectAnomalies</code> includes a boolean prediction that the image contains one or more anomalies and a confidence value for the prediction. </para><note><para> Before calling <code>DetectAnomalies</code>, you must first start your model with the <a>StartModel</a> operation. You are charged for the amount of time, in minutes, that a model runs and for the number of anomaly detection units that your model uses. If you are not using a model, use the <a>StopModel</a> operation to stop your model. </para></note><para> This operation requires permissions to perform the <code>lookoutvision:DetectAnomalies</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.FindLFVAnomalyCmdlet.Body"> <summary> <para> <para>The unencrypted image bytes that you want to analyze. </para> </para> <para>The cmdlet accepts a parameter of type string, string[], System.IO.FileInfo or System.IO.Stream.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.FindLFVAnomalyCmdlet.ContentType"> <summary> <para> <para>The type of the image passed in <code>Body</code>. Valid values are <code>image/png</code> (PNG format images) and <code>image/jpeg</code> (JPG format images). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.FindLFVAnomalyCmdlet.ModelVersion"> <summary> <para> <para>The version of the model that you want to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.FindLFVAnomalyCmdlet.ProjectName"> <summary> <para> <para>The name of the project that contains the model version that you want to use.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.FindLFVAnomalyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DetectAnomalyResult'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.DetectAnomaliesResponse). Specifying the name of a property of type Amazon.LookoutforVision.Model.DetectAnomaliesResponse 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.LFV.GetLFVDatasetCmdlet"> <summary> Describe an Amazon Lookout for Vision dataset. <para> This operation requires permissions to perform the <code>lookoutvision:DescribeDataset</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVDatasetCmdlet.DatasetType"> <summary> <para> <para>The type of the dataset to describe. Specify <code>train</code> to describe the training dataset. Specify <code>test</code> to describe the test dataset. If you have a single dataset project, specify <code>train</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVDatasetCmdlet.ProjectName"> <summary> <para> <para>The name of the project that contains the dataset that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.DescribeDatasetResponse). Specifying the name of a property of type Amazon.LookoutforVision.Model.DescribeDatasetResponse 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.LFV.GetLFVDatasetEntryListCmdlet"> <summary> Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the anomaly information for a single image, including the image location and the assigned label. <para> This operation requires permissions to perform the <code>lookoutvision:ListDatasetEntries</code> operation. </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.LFV.GetLFVDatasetEntryListCmdlet.AfterCreationDate"> <summary> <para> <para>Only includes entries after the specified date in the response. For example, <code>2020-06-23T00:00:00</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVDatasetEntryListCmdlet.AnomalyClass"> <summary> <para> <para>Specify <code>normal</code> to include only normal images. Specify <code>anomaly</code> to only include anomalous entries. If you don't specify a value, Amazon Lookout for Vision returns normal and anomalous images.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVDatasetEntryListCmdlet.BeforeCreationDate"> <summary> <para> <para>Only includes entries before the specified date in the response. For example, <code>2020-06-23T00:00:00</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVDatasetEntryListCmdlet.DatasetType"> <summary> <para> <para>The type of the dataset that you want to list. Specify <code>train</code> to list the training dataset. Specify <code>test</code> to list the test dataset. If you have a single dataset project, specify <code>train</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVDatasetEntryListCmdlet.Labeled"> <summary> <para> <para>Specify <code>true</code> to include labeled entries, otherwise specify <code>false</code>. If you don't specify a value, Lookout for Vision returns all entries.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVDatasetEntryListCmdlet.ProjectName"> <summary> <para> <para>The name of the project that contains the dataset that you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVDatasetEntryListCmdlet.SourceRefContain"> <summary> <para> <para>Perform a "contains" search on the values of the <code>source-ref</code> key within the dataset. For example a value of "IMG_17" returns all JSON Lines where the <code>source-ref</code> key value matches <i>*IMG_17*</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVDatasetEntryListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVDatasetEntryListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of dataset entries.</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.LFV.GetLFVDatasetEntryListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetEntries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.ListDatasetEntriesResponse). Specifying the name of a property of type Amazon.LookoutforVision.Model.ListDatasetEntriesResponse 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.LFV.GetLFVDatasetEntryListCmdlet.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.LFV.GetLFVModelCmdlet"> <summary> Describes a version of an Amazon Lookout for Vision model. <para> This operation requires permissions to perform the <code>lookoutvision:DescribeModel</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVModelCmdlet.ModelVersion"> <summary> <para> <para>The version of the model that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVModelCmdlet.ProjectName"> <summary> <para> <para>The project that contains the version of a model that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVModelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.DescribeModelResponse). Specifying the name of a property of type Amazon.LookoutforVision.Model.DescribeModelResponse 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.LFV.GetLFVModelListCmdlet"> <summary> Lists the versions of a model in an Amazon Lookout for Vision project. <para> This operation requires permissions to perform the <code>lookoutvision:ListModels</code> operation. </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.LFV.GetLFVModelListCmdlet.ProjectName"> <summary> <para> <para>The name of the project that contains the model versions that you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVModelListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVModelListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of models.</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.LFV.GetLFVModelListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Models'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.ListModelsResponse). Specifying the name of a property of type Amazon.LookoutforVision.Model.ListModelsResponse 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.LFV.GetLFVModelListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVModelListCmdlet.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.LFV.GetLFVProjectCmdlet"> <summary> Describes an Amazon Lookout for Vision project. <para> This operation requires permissions to perform the <code>lookoutvision:DescribeProject</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVProjectCmdlet.ProjectName"> <summary> <para> <para>The name of the project that you want to describe.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVProjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProjectDescription'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.DescribeProjectResponse). Specifying the name of a property of type Amazon.LookoutforVision.Model.DescribeProjectResponse 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.LFV.GetLFVProjectListCmdlet"> <summary> Lists the Amazon Lookout for Vision projects in your AWS account. <para> This operation requires permissions to perform the <code>lookoutvision:ListProjects</code> operation. </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.LFV.GetLFVProjectListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVProjectListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of projects.</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.LFV.GetLFVProjectListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Projects'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.ListProjectsResponse). Specifying the name of a property of type Amazon.LookoutforVision.Model.ListProjectsResponse 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.LFV.GetLFVProjectListCmdlet.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.LFV.GetLFVResourceTagCmdlet"> <summary> Returns a list of tags attached to the specified Amazon Lookout for Vision model. <para> This operation requires permissions to perform the <code>lookoutvision:ListTagsForResource</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the model for which you want to list tags. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.GetLFVResourceTagCmdlet.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.LookoutforVision.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.LookoutforVision.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.LFV.GetLFVResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.LFV.NewLFVDatasetCmdlet"> <summary> Creates a new dataset in an Amazon Lookout for Vision project. <code>CreateDataset</code> can create a training or a test dataset from a valid dataset source (<code>DatasetSource</code>). <para> If you want a single dataset project, specify <code>train</code> for the value of <code>DatasetType</code>. </para><para> To have a project with separate training and test datasets, call <code>CreateDataset</code> twice. On the first call, specify <code>train</code> for the value of <code>DatasetType</code>. On the second call, specify <code>test</code> for the value of <code>DatasetType</code>. </para><para> This operation requires permissions to perform the <code>lookoutvision:CreateDataset</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVDatasetCmdlet.S3Object_Bucket"> <summary> <para> <para>The Amazon S3 bucket that contains the manifest.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVDatasetCmdlet.DatasetType"> <summary> <para> <para>The type of the dataset. Specify <code>train</code> for a training dataset. Specify <code>test</code> for a test dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVDatasetCmdlet.S3Object_Key"> <summary> <para> <para>The name and location of the manifest file withiin the bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVDatasetCmdlet.ProjectName"> <summary> <para> <para>The name of the project in which you want to create a dataset.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVDatasetCmdlet.S3Object_VersionId"> <summary> <para> <para>The version ID of the bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVDatasetCmdlet.ClientToken"> <summary> <para> <para>ClientToken is an idempotency token that ensures a call to <code>CreateDataset</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>CreateDataset</code>. In this case, safely retry your call to <code>CreateDataset</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>CreateDataset</code>. An idempotency token is active for 8 hours. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVDatasetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DatasetMetadata'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.CreateDatasetResponse). Specifying the name of a property of type Amazon.LookoutforVision.Model.CreateDatasetResponse 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.LFV.NewLFVDatasetCmdlet.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.LFV.NewLFVModelCmdlet"> <summary> Creates a new version of a model within an an Amazon Lookout for Vision project. <code>CreateModel</code> is an asynchronous operation in which Amazon Lookout for Vision trains, tests, and evaluates a new version of a model. <para> To get the current status, check the <code>Status</code> field returned in the response from <a>DescribeModel</a>. </para><para> If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset to create a training and a test dataset. If the project has a training and a test dataset, Lookout for Vision uses the respective datasets to train and test the model. </para><para> After training completes, the evaluation metrics are stored at the location specified in <code>OutputConfig</code>. </para><para> This operation requires permissions to perform the <code>lookoutvision:CreateModel</code> operation. If you want to tag your model, you also require permission to the <code>lookoutvision:TagResource</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVModelCmdlet.Output_S3Location_Bucket"> <summary> <para> <para>The S3 bucket that contains the training output.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVModelCmdlet.Description"> <summary> <para> <para>A description for the version of the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVModelCmdlet.KmsKeyId"> <summary> <para> <para>The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK). The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVModelCmdlet.Output_S3Location_Prefix"> <summary> <para> <para>The path of the folder, within the S3 bucket, that contains the training output.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVModelCmdlet.ProjectName"> <summary> <para> <para>The name of the project in which you want to create a model version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVModelCmdlet.Tag"> <summary> <para> <para>A set of tags (key-value pairs) that you want to attach to the model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVModelCmdlet.ClientToken"> <summary> <para> <para>ClientToken is an idempotency token that ensures a call to <code>CreateModel</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>CreateModel</code>. In this case, safely retry your call to <code>CreateModel</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>CreateModel</code>. An idempotency token is active for 8 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVModelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelMetadata'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.CreateModelResponse). Specifying the name of a property of type Amazon.LookoutforVision.Model.CreateModelResponse 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.LFV.NewLFVModelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVModelCmdlet.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.LFV.NewLFVProjectCmdlet"> <summary> Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling <a>CreateDataset</a>. <para> This operation requires permissions to perform the <code>lookoutvision:CreateProject</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVProjectCmdlet.ProjectName"> <summary> <para> <para>The name for the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVProjectCmdlet.ClientToken"> <summary> <para> <para>ClientToken is an idempotency token that ensures a call to <code>CreateProject</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>CreateProject</code>. In this case, safely retry your call to <code>CreateProject</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>CreateProject</code>. An idempotency token is active for 8 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVProjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProjectMetadata'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.CreateProjectResponse). Specifying the name of a property of type Amazon.LookoutforVision.Model.CreateProjectResponse 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.LFV.NewLFVProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.NewLFVProjectCmdlet.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.LFV.RemoveLFVDatasetCmdlet"> <summary> Deletes an existing Amazon Lookout for Vision <code>dataset</code>. <para> If your the project has a single dataset, you must create a new dataset before you can create a model. </para><para> If you project has a training dataset and a test dataset consider the following. </para><ul><li><para> If you delete the test dataset, your project reverts to a single dataset project. If you then train the model, Amazon Lookout for Vision internally splits the remaining dataset into a training and test dataset. </para></li><li><para> If you delete the training dataset, you must create a training dataset before you can create a model. </para></li></ul><para> This operation requires permissions to perform the <code>lookoutvision:DeleteDataset</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVDatasetCmdlet.DatasetType"> <summary> <para> <para>The type of the dataset to delete. Specify <code>train</code> to delete the training dataset. Specify <code>test</code> to delete the test dataset. To delete the dataset in a single dataset project, specify <code>train</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVDatasetCmdlet.ProjectName"> <summary> <para> <para>The name of the project that contains the dataset that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVDatasetCmdlet.ClientToken"> <summary> <para> <para>ClientToken is an idempotency token that ensures a call to <code>DeleteDataset</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>DeleteDataset</code>. In this case, safely retry your call to <code>DeleteDataset</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>DeleteDataset</code>. An idempotency token is active for 8 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVDatasetCmdlet.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.LookoutforVision.Model.DeleteDatasetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVDatasetCmdlet.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.LFV.RemoveLFVModelCmdlet"> <summary> Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the <a>StopModel</a> operation. <para> It might take a few seconds to delete a model. To determine if a model has been deleted, call <a>ListProjects</a> and check if the version of the model (<code>ModelVersion</code>) is in the <code>Models</code> array. </para><para> This operation requires permissions to perform the <code>lookoutvision:DeleteModel</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVModelCmdlet.ModelVersion"> <summary> <para> <para>The version of the model that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVModelCmdlet.ProjectName"> <summary> <para> <para>The name of the project that contains the model that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVModelCmdlet.ClientToken"> <summary> <para> <para>ClientToken is an idempotency token that ensures a call to <code>DeleteModel</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>DeleteModel</code>. In this case, safely retry your call to <code>DeleteModel</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>DeleteModel</code>. An idempotency token is active for 8 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVModelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ModelArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.DeleteModelResponse). Specifying the name of a property of type Amazon.LookoutforVision.Model.DeleteModelResponse 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.LFV.RemoveLFVModelCmdlet.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.LFV.RemoveLFVProjectCmdlet"> <summary> Deletes an Amazon Lookout for Vision project. <para> To delete a project, you must first delete each version of the model associated with the project. To delete a model use the <a>DeleteModel</a> operation. </para><para> You also have to delete the dataset(s) associated with the model. For more information, see <a>DeleteDataset</a>. The images referenced by the training and test datasets aren't deleted. </para><para> This operation requires permissions to perform the <code>lookoutvision:DeleteProject</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVProjectCmdlet.ProjectName"> <summary> <para> <para>The name of the project to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVProjectCmdlet.ClientToken"> <summary> <para> <para>ClientToken is an idempotency token that ensures a call to <code>DeleteProject</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>DeleteProject</code>. In this case, safely retry your call to <code>DeleteProject</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>DeleteProject</code>. An idempotency token is active for 8 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVProjectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ProjectArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.DeleteProjectResponse). Specifying the name of a property of type Amazon.LookoutforVision.Model.DeleteProjectResponse 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.LFV.RemoveLFVProjectCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVProjectCmdlet.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.LFV.RemoveLFVResourceTagCmdlet"> <summary> Removes one or more tags from an Amazon Lookout for Vision model. For more information, see <i>Tagging a model</i> in the <i>Amazon Lookout for Vision Developer Guide</i>. <para> This operation requires permissions to perform the <code>lookoutvision:UntagResource</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the model from which you want to remove tags. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVResourceTagCmdlet.TagKey"> <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.LFV.RemoveLFVResourceTagCmdlet.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.LookoutforVision.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.RemoveLFVResourceTagCmdlet.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.LFV.StartLFVModelCmdlet"> <summary> Starts the running of the version of an Amazon Lookout for Vision model. Starting a model takes a while to complete. To check the current state of the model, use <a>DescribeModel</a>. <para> A model is ready to use when its status is <code>HOSTED</code>. </para><para> Once the model is running, you can detect custom labels in new images by calling <a>DetectAnomalies</a>. </para><note><para> You are charged for the amount of time that the model is running. To stop a running model, call <a>StopModel</a>. </para></note><para> This operation requires permissions to perform the <code>lookoutvision:StartModel</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.StartLFVModelCmdlet.MinInferenceUnit"> <summary> <para> <para>The minimum number of inference units to use. A single inference unit represents 1 hour of processing and can support up to 5 Transaction Pers Second (TPS). Use a higher number to increase the TPS throughput of your model. You are charged for the number of inference units that you use. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.StartLFVModelCmdlet.ModelVersion"> <summary> <para> <para>The version of the model that you want to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.StartLFVModelCmdlet.ProjectName"> <summary> <para> <para>The name of the project that contains the model that you want to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.StartLFVModelCmdlet.ClientToken"> <summary> <para> <para>ClientToken is an idempotency token that ensures a call to <code>StartModel</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>StartModel</code>. In this case, safely retry your call to <code>StartModel</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>StartModel</code>. An idempotency token is active for 8 hours. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.StartLFVModelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.StartModelResponse). Specifying the name of a property of type Amazon.LookoutforVision.Model.StartModelResponse 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.LFV.StartLFVModelCmdlet.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.LFV.StopLFVModelCmdlet"> <summary> Stops the hosting of a running model. The operation might take a while to complete. To check the current status, call <a>DescribeModel</a>. <para> After the model hosting stops, the <code>Status</code> of the model is <code>TRAINED</code>. </para><para> This operation requires permissions to perform the <code>lookoutvision:StopModel</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.StopLFVModelCmdlet.ModelVersion"> <summary> <para> <para>The version of the model that you want to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.StopLFVModelCmdlet.ProjectName"> <summary> <para> <para>The name of the project that contains the model that you want to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.StopLFVModelCmdlet.ClientToken"> <summary> <para> <para>ClientToken is an idempotency token that ensures a call to <code>StopModel</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>StopModel</code>. In this case, safely retry your call to <code>StopModel</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>StopModel</code>. An idempotency token is active for 8 hours. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.StopLFVModelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.StopModelResponse). Specifying the name of a property of type Amazon.LookoutforVision.Model.StopModelResponse 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.LFV.StopLFVModelCmdlet.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.LFV.UpdateLFVDatasetEntryCmdlet"> <summary> Adds one or more JSON Line entries to a dataset. A JSON Line includes information about an image used for training or testing an Amazon Lookout for Vision model. The following is an example JSON Line. <para> Updating a dataset might take a while to complete. To check the current status, call <a>DescribeDataset</a> and check the <code>Status</code> field in the response. </para><para> This operation requires permissions to perform the <code>lookoutvision:UpdateDatasetEntries</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.UpdateLFVDatasetEntryCmdlet.Change"> <summary> <para> <para>The entries to add to the dataset.</para> </para> <para>The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.UpdateLFVDatasetEntryCmdlet.DatasetType"> <summary> <para> <para>The type of the dataset that you want to update. Specify <code>train</code> to update the training dataset. Specify <code>test</code> to update the test dataset. If you have a single dataset project, specify <code>train</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.UpdateLFVDatasetEntryCmdlet.ProjectName"> <summary> <para> <para>The name of the project that contains the dataset that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.UpdateLFVDatasetEntryCmdlet.ClientToken"> <summary> <para> <para>ClientToken is an idempotency token that ensures a call to <code>UpdateDatasetEntries</code> completes only once. You choose the value to pass. For example, An issue, such as an network outage, might prevent you from getting a response from <code>UpdateDatasetEntries</code>. In this case, safely retry your call to <code>UpdateDatasetEntries</code> by using the same <code>ClientToken</code> parameter value. An error occurs if the other input parameters are not the same as in the first request. Using a different value for <code>ClientToken</code> is considered a new call to <code>UpdateDatasetEntries</code>. An idempotency token is active for 8 hours. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.LFV.UpdateLFVDatasetEntryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.UpdateDatasetEntriesResponse). Specifying the name of a property of type Amazon.LookoutforVision.Model.UpdateDatasetEntriesResponse 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.LFV.UpdateLFVDatasetEntryCmdlet.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> |