/*******************************************************************************
* 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
{
///
/// Registers a device to receive push sync notifications.
///
///
///
/// This API can only be called with temporary credentials provided by Cognito Identity.
/// You cannot call this API with developer credentials.
///
///
[Cmdlet("Register", "CGISDevice", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the Amazon Cognito Sync RegisterDevice API operation.", Operation = new[] {"RegisterDevice"}, SelectReturnType = typeof(Amazon.CognitoSync.Model.RegisterDeviceResponse))]
[AWSCmdletOutput("System.String or Amazon.CognitoSync.Model.RegisterDeviceResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.CognitoSync.Model.RegisterDeviceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class RegisterCGISDeviceCmdlet : AmazonCognitoSyncClientCmdlet, IExecutor
{
#region Parameter IdentityId
///
///
/// The unique ID for this identity.
///
///
#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 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. Here, the ID of the pool that the identity belongs to.
///
///
#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 Platform
///
///
/// The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).
///
///
#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]
[AWSConstantClassSource("Amazon.CognitoSync.Platform")]
public Amazon.CognitoSync.Platform Platform { get; set; }
#endregion
#region Parameter Token
///
///
/// The push token.
///
///
#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 Token { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'DeviceId'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CognitoSync.Model.RegisterDeviceResponse).
/// Specifying the name of a property of type Amazon.CognitoSync.Model.RegisterDeviceResponse 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; } = "DeviceId";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the IdentityId parameter.
/// The -PassThru parameter is deprecated, use -Select '^IdentityId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^IdentityId' 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.IdentityId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Register-CGISDevice (RegisterDevice)"))
{
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.IdentityId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
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
context.Platform = this.Platform;
#if MODULAR
if (this.Platform == null && ParameterWasBound(nameof(this.Platform)))
{
WriteWarning("You are passing $null as a value for parameter Platform 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.Token = this.Token;
#if MODULAR
if (this.Token == null && ParameterWasBound(nameof(this.Token)))
{
WriteWarning("You are passing $null as a value for parameter Token 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.RegisterDeviceRequest();
if (cmdletContext.IdentityId != null)
{
request.IdentityId = cmdletContext.IdentityId;
}
if (cmdletContext.IdentityPoolId != null)
{
request.IdentityPoolId = cmdletContext.IdentityPoolId;
}
if (cmdletContext.Platform != null)
{
request.Platform = cmdletContext.Platform;
}
if (cmdletContext.Token != null)
{
request.Token = cmdletContext.Token;
}
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.RegisterDeviceResponse CallAWSServiceOperation(IAmazonCognitoSync client, Amazon.CognitoSync.Model.RegisterDeviceRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Cognito Sync", "RegisterDevice");
try
{
#if DESKTOP
return client.RegisterDevice(request);
#elif CORECLR
return client.RegisterDeviceAsync(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 IdentityId { get; set; }
public System.String IdentityPoolId { get; set; }
public Amazon.CognitoSync.Platform Platform { get; set; }
public System.String Token { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.DeviceId;
}
}
}