/*******************************************************************************
* 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.CognitoSync;
using Amazon.CognitoSync.Model;
namespace Amazon.PowerShell.Cmdlets.CGIS
{
///
/// Posts updates to records and adds and deletes records for a dataset and user.
///
///
///
/// The sync count in the record patch is your last known sync count for that record.
/// The server will reject an UpdateRecords request with a ResourceConflictException if
/// you try to patch a record with a new value but a stale sync count.
///
/// For example, if the sync count on the server is 5 for a key called highScore and you
/// try and submit a new highScore with sync count of 4, the request will be rejected.
/// To obtain the current sync count for a record, call ListRecords. On a successful update
/// of the record, the response returns the new sync count for that record. You should
/// present that sync count the next time you try to update that same record. When the
/// record does not exist, specify the sync count as 0.
///
/// This API can be called with temporary user credentials provided by Cognito Identity
/// or with developer credentials.
///
///
[Cmdlet("Update", "CGISRecord", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.CognitoSync.Model.Record")]
[AWSCmdlet("Calls the Amazon Cognito Sync UpdateRecords API operation.", Operation = new[] {"UpdateRecords"}, SelectReturnType = typeof(Amazon.CognitoSync.Model.UpdateRecordsResponse))]
[AWSCmdletOutput("Amazon.CognitoSync.Model.Record or Amazon.CognitoSync.Model.UpdateRecordsResponse",
"This cmdlet returns a collection of Amazon.CognitoSync.Model.Record objects.",
"The service call response (type Amazon.CognitoSync.Model.UpdateRecordsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateCGISRecordCmdlet : AmazonCognitoSyncClientCmdlet, IExecutor
{
#region Parameter ClientContext
///
///
/// Intended to supply a device ID that will
/// populate the lastModifiedBy field referenced in other methods. The ClientContext field
/// is not yet implemented.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ClientContext { get; set; }
#endregion
#region Parameter DatasetName
///
///
/// A string of up to 128 characters. Allowed
/// characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
///
///
#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 DatasetName { get; set; }
#endregion
#region Parameter DeviceId
///
///
/// The unique ID generated for this device by Cognito.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String DeviceId { get; set; }
#endregion
#region Parameter IdentityId
///
///
/// A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
/// created by Amazon Cognito. GUID generation is unique within a region.
///
///
#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 IdentityId { get; set; }
#endregion
#region Parameter IdentityPoolId
///
///
/// A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
/// created by Amazon Cognito. GUID generation is unique within a region.
///
///
#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 IdentityPoolId { get; set; }
#endregion
#region Parameter RecordPatch
///
///
/// A list of patch operations.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("RecordPatches")]
public Amazon.CognitoSync.Model.RecordPatch[] RecordPatch { get; set; }
#endregion
#region Parameter SyncSessionToken
///
///
/// The SyncSessionToken returned by a previous
/// call to ListRecords for this dataset and identity.
///
///
#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 SyncSessionToken { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Records'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoSync.Model.UpdateRecordsResponse).
/// Specifying the name of a property of type Amazon.CognitoSync.Model.UpdateRecordsResponse 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; } = "Records";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the DatasetName parameter.
/// The -PassThru parameter is deprecated, use -Select '^DatasetName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DatasetName' 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.DatasetName), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-CGISRecord (UpdateRecords)"))
{
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.DatasetName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ClientContext = this.ClientContext;
context.DatasetName = this.DatasetName;
#if MODULAR
if (this.DatasetName == null && ParameterWasBound(nameof(this.DatasetName)))
{
WriteWarning("You are passing $null as a value for parameter DatasetName 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.DeviceId = this.DeviceId;
context.IdentityId = this.IdentityId;
#if MODULAR
if (this.IdentityId == null && ParameterWasBound(nameof(this.IdentityId)))
{
WriteWarning("You are passing $null as a value for parameter IdentityId 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.IdentityPoolId = this.IdentityPoolId;
#if MODULAR
if (this.IdentityPoolId == null && ParameterWasBound(nameof(this.IdentityPoolId)))
{
WriteWarning("You are passing $null as a value for parameter IdentityPoolId 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.RecordPatch != null)
{
context.RecordPatch = new List(this.RecordPatch);
}
context.SyncSessionToken = this.SyncSessionToken;
#if MODULAR
if (this.SyncSessionToken == null && ParameterWasBound(nameof(this.SyncSessionToken)))
{
WriteWarning("You are passing $null as a value for parameter SyncSessionToken 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.CognitoSync.Model.UpdateRecordsRequest();
if (cmdletContext.ClientContext != null)
{
request.ClientContext = cmdletContext.ClientContext;
}
if (cmdletContext.DatasetName != null)
{
request.DatasetName = cmdletContext.DatasetName;
}
if (cmdletContext.DeviceId != null)
{
request.DeviceId = cmdletContext.DeviceId;
}
if (cmdletContext.IdentityId != null)
{
request.IdentityId = cmdletContext.IdentityId;
}
if (cmdletContext.IdentityPoolId != null)
{
request.IdentityPoolId = cmdletContext.IdentityPoolId;
}
if (cmdletContext.RecordPatch != null)
{
request.RecordPatches = cmdletContext.RecordPatch;
}
if (cmdletContext.SyncSessionToken != null)
{
request.SyncSessionToken = cmdletContext.SyncSessionToken;
}
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.CognitoSync.Model.UpdateRecordsResponse CallAWSServiceOperation(IAmazonCognitoSync client, Amazon.CognitoSync.Model.UpdateRecordsRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Cognito Sync", "UpdateRecords");
try
{
#if DESKTOP
return client.UpdateRecords(request);
#elif CORECLR
return client.UpdateRecordsAsync(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 ClientContext { get; set; }
public System.String DatasetName { get; set; }
public System.String DeviceId { get; set; }
public System.String IdentityId { get; set; }
public System.String IdentityPoolId { get; set; }
public List RecordPatch { get; set; }
public System.String SyncSessionToken { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Records;
}
}
}