/*******************************************************************************
* Copyright 2012-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use
* this file except in compliance with the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file.
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.LookoutforVision;
using Amazon.LookoutforVision.Model;
namespace Amazon.PowerShell.Cmdlets.LFV
{
///
/// Detects anomalies in an image that you supply.
///
///
///
/// The response from DetectAnomalies
includes a boolean prediction that
/// the image contains one or more anomalies and a confidence value for the prediction.
/// If the model is an image segmentation model, the response also includes segmentation
/// information for each type of anomaly found in the image.
///
/// Before calling DetectAnomalies
, you must first start your model with
/// the StartModel 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 StopModel operation to stop your model.
///
///
/// For more information, see Detecting anomalies in an image in the Amazon Lookout
/// for Vision developer guide.
///
/// This operation requires permissions to perform the lookoutvision:DetectAnomalies
/// operation.
///
///
[Cmdlet("Find", "LFVAnomaly")]
[OutputType("Amazon.LookoutforVision.Model.DetectAnomalyResult")]
[AWSCmdlet("Calls the Amazon Lookout for Vision DetectAnomalies API operation.", Operation = new[] {"DetectAnomalies"}, SelectReturnType = typeof(Amazon.LookoutforVision.Model.DetectAnomaliesResponse))]
[AWSCmdletOutput("Amazon.LookoutforVision.Model.DetectAnomalyResult or Amazon.LookoutforVision.Model.DetectAnomaliesResponse",
"This cmdlet returns an Amazon.LookoutforVision.Model.DetectAnomalyResult object.",
"The service call response (type Amazon.LookoutforVision.Model.DetectAnomaliesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class FindLFVAnomalyCmdlet : AmazonLookoutforVisionClientCmdlet, IExecutor
{
#region Parameter Body
///
///
/// The unencrypted image bytes that you want to analyze.
///
/// The cmdlet accepts a parameter of type string, string[], System.IO.FileInfo or System.IO.Stream.
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public object Body { get; set; }
#endregion
#region Parameter ContentType
///
///
/// The type of the image passed in Body
. Valid values are image/png
/// (PNG format images) and image/jpeg
(JPG format images).
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String ContentType { get; set; }
#endregion
#region Parameter ModelVersion
///
///
/// The version of the model that you want to use.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String ModelVersion { get; set; }
#endregion
#region Parameter ProjectName
///
///
/// The name of the project that contains the model version that you want to use.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String ProjectName { get; set; }
#endregion
#region Parameter Select
///
/// 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.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "DetectAnomalyResult";
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.Body = this.Body;
#if MODULAR
if (this.Body == null && ParameterWasBound(nameof(this.Body)))
{
WriteWarning("You are passing $null as a value for parameter Body which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.ContentType = this.ContentType;
#if MODULAR
if (this.ContentType == null && ParameterWasBound(nameof(this.ContentType)))
{
WriteWarning("You are passing $null as a value for parameter ContentType which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.ModelVersion = this.ModelVersion;
#if MODULAR
if (this.ModelVersion == null && ParameterWasBound(nameof(this.ModelVersion)))
{
WriteWarning("You are passing $null as a value for parameter ModelVersion which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.ProjectName = this.ProjectName;
#if MODULAR
if (this.ProjectName == null && ParameterWasBound(nameof(this.ProjectName)))
{
WriteWarning("You are passing $null as a value for parameter ProjectName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
System.IO.Stream _BodyStream = null;
try
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.LookoutforVision.Model.DetectAnomaliesRequest();
if (cmdletContext.Body != null)
{
_BodyStream = Amazon.PowerShell.Common.StreamParameterConverter.TransformToStream(cmdletContext.Body);
request.Body = _BodyStream;
}
if (cmdletContext.ContentType != null)
{
request.ContentType = cmdletContext.ContentType;
}
if (cmdletContext.ModelVersion != null)
{
request.ModelVersion = cmdletContext.ModelVersion;
}
if (cmdletContext.ProjectName != null)
{
request.ProjectName = cmdletContext.ProjectName;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput { ErrorResponse = e };
}
return output;
}
finally
{
if( _BodyStream != null)
{
_BodyStream.Dispose();
}
}
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.LookoutforVision.Model.DetectAnomaliesResponse CallAWSServiceOperation(IAmazonLookoutforVision client, Amazon.LookoutforVision.Model.DetectAnomaliesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lookout for Vision", "DetectAnomalies");
try
{
#if DESKTOP
return client.DetectAnomalies(request);
#elif CORECLR
return client.DetectAnomaliesAsync(request).GetAwaiter().GetResult();
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public object Body { get; set; }
public System.String ContentType { get; set; }
public System.String ModelVersion { get; set; }
public System.String ProjectName { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.DetectAnomalyResult;
}
}
}