/*******************************************************************************
* 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.LocationService;
using Amazon.LocationService.Model;
namespace Amazon.PowerShell.Cmdlets.LOC
{
///
/// Uploads position update data for one or more devices to a tracker resource (up to
/// 10 devices per batch). Amazon Location uses the data when it reports the last known
/// device position and position history. Amazon Location retains location data for 30
/// days.
///
///
/// Position updates are handled based on the PositionFiltering
property
/// of the tracker. When PositionFiltering
is set to TimeBased
,
/// updates are evaluated against linked geofence collections, and location data is stored
/// at a maximum of one position per 30 second interval. If your update frequency is more
/// often than every 30 seconds, only one update per 30 seconds is stored for each unique
/// device ID.
///
/// When PositionFiltering
is set to DistanceBased
filtering,
/// location data is stored and evaluated against linked geofence collections only if
/// the device has moved more than 30 m (98.4 ft).
///
/// When PositionFiltering
is set to AccuracyBased
filtering,
/// location data is stored and evaluated against linked geofence collections only if
/// the device has moved more than the measured accuracy. For example, if two consecutive
/// updates from a device have a horizontal accuracy of 5 m and 10 m, the second update
/// is neither stored or evaluated if the device has moved less than 15 m. If PositionFiltering
/// is set to AccuracyBased
filtering, Amazon Location uses the default value
/// { "Horizontal": 0}
when accuracy is not provided on a DevicePositionUpdate
.
///
///
[Cmdlet("Set", "LOCDevicePositionBatch", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.LocationService.Model.BatchUpdateDevicePositionResponse")]
[AWSCmdlet("Calls the Amazon Location Service BatchUpdateDevicePosition API operation.", Operation = new[] {"BatchUpdateDevicePosition"}, SelectReturnType = typeof(Amazon.LocationService.Model.BatchUpdateDevicePositionResponse))]
[AWSCmdletOutput("Amazon.LocationService.Model.BatchUpdateDevicePositionResponse",
"This cmdlet returns an Amazon.LocationService.Model.BatchUpdateDevicePositionResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class SetLOCDevicePositionBatchCmdlet : AmazonLocationServiceClientCmdlet, IExecutor
{
protected override bool IsSensitiveRequest { get; set; } = true;
#region Parameter TrackerName
///
///
/// The name of the tracker resource to update.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String TrackerName { get; set; }
#endregion
#region Parameter Update
///
///
/// Contains the position update details for each device, up to 10 devices.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyCollection]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[Alias("Updates")]
public Amazon.LocationService.Model.DevicePositionUpdate[] Update { get; set; }
#endregion
#region Parameter Select
///
/// 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.LocationService.Model.BatchUpdateDevicePositionResponse).
/// Specifying the name of a property of type Amazon.LocationService.Model.BatchUpdateDevicePositionResponse 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; } = "*";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the TrackerName parameter.
/// The -PassThru parameter is deprecated, use -Select '^TrackerName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^TrackerName' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.TrackerName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Set-LOCDevicePositionBatch (BatchUpdateDevicePosition)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.TrackerName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.TrackerName = this.TrackerName;
#if MODULAR
if (this.TrackerName == null && ParameterWasBound(nameof(this.TrackerName)))
{
WriteWarning("You are passing $null as a value for parameter TrackerName 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
if (this.Update != null)
{
context.Update = new List(this.Update);
}
#if MODULAR
if (this.Update == null && ParameterWasBound(nameof(this.Update)))
{
WriteWarning("You are passing $null as a value for parameter Update 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)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.LocationService.Model.BatchUpdateDevicePositionRequest();
if (cmdletContext.TrackerName != null)
{
request.TrackerName = cmdletContext.TrackerName;
}
if (cmdletContext.Update != null)
{
request.Updates = cmdletContext.Update;
}
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;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.LocationService.Model.BatchUpdateDevicePositionResponse CallAWSServiceOperation(IAmazonLocationService client, Amazon.LocationService.Model.BatchUpdateDevicePositionRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Location Service", "BatchUpdateDevicePosition");
try
{
#if DESKTOP
return client.BatchUpdateDevicePosition(request);
#elif CORECLR
return client.BatchUpdateDevicePositionAsync(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 System.String TrackerName { get; set; }
public List Update { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}