/******************************************************************************* * 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.AlexaForBusiness; using Amazon.AlexaForBusiness.Model; namespace Amazon.PowerShell.Cmdlets.ALXB { /// /// Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) /// using Alexa Voice Service (AVS).

This operation is deprecated. ///
[Cmdlet("Register", "ALXBAVSDevice", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the Alexa For Business RegisterAVSDevice API operation.", Operation = new[] {"RegisterAVSDevice"}, SelectReturnType = typeof(Amazon.AlexaForBusiness.Model.RegisterAVSDeviceResponse))] [AWSCmdletOutput("System.String or Amazon.AlexaForBusiness.Model.RegisterAVSDeviceResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.AlexaForBusiness.Model.RegisterAVSDeviceResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] [System.ObsoleteAttribute("Alexa For Business is no longer supported")] public partial class RegisterALXBAVSDeviceCmdlet : AmazonAlexaForBusinessClientCmdlet, IExecutor { #region Parameter AmazonId /// /// /// The device type ID for your AVS device generated by Amazon when the OEM creates a /// new product on Amazon's Developer Console. /// /// #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 AmazonId { get; set; } #endregion #region Parameter ClientId /// /// /// The client ID of the OEM used for code-based linking authorization on an AVS device. /// /// #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 ClientId { get; set; } #endregion #region Parameter DeviceSerialNumber /// /// /// The key generated by the OEM that uniquely identifies a specified instance of your /// AVS device. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String DeviceSerialNumber { get; set; } #endregion #region Parameter ProductId /// /// /// The product ID used to identify your AVS device during authorization. /// /// #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 ProductId { get; set; } #endregion #region Parameter RoomArn /// /// /// The Amazon Resource Name (ARN) of the room with which to associate your AVS device. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RoomArn { get; set; } #endregion #region Parameter Tag /// /// /// The tags to be added to the specified resource. Do not provide system tags. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public Amazon.AlexaForBusiness.Model.Tag[] Tag { get; set; } #endregion #region Parameter UserCode /// /// /// The code that is obtained after your AVS device has made a POST request to LWA as /// a part of the Device Authorization Request component of the OAuth code-based linking /// specification. /// /// #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 UserCode { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'DeviceArn'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AlexaForBusiness.Model.RegisterAVSDeviceResponse). /// Specifying the name of a property of type Amazon.AlexaForBusiness.Model.RegisterAVSDeviceResponse 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; } = "DeviceArn"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the DeviceSerialNumber parameter. /// The -PassThru parameter is deprecated, use -Select '^DeviceSerialNumber' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DeviceSerialNumber' 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.DeviceSerialNumber), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Register-ALXBAVSDevice (RegisterAVSDevice)")) { 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.DeviceSerialNumber; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AmazonId = this.AmazonId; #if MODULAR if (this.AmazonId == null && ParameterWasBound(nameof(this.AmazonId))) { WriteWarning("You are passing $null as a value for parameter AmazonId 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.ClientId = this.ClientId; #if MODULAR if (this.ClientId == null && ParameterWasBound(nameof(this.ClientId))) { WriteWarning("You are passing $null as a value for parameter ClientId 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.DeviceSerialNumber = this.DeviceSerialNumber; context.ProductId = this.ProductId; #if MODULAR if (this.ProductId == null && ParameterWasBound(nameof(this.ProductId))) { WriteWarning("You are passing $null as a value for parameter ProductId 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.RoomArn = this.RoomArn; if (this.Tag != null) { context.Tag = new List(this.Tag); } context.UserCode = this.UserCode; #if MODULAR if (this.UserCode == null && ParameterWasBound(nameof(this.UserCode))) { WriteWarning("You are passing $null as a value for parameter UserCode 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.AlexaForBusiness.Model.RegisterAVSDeviceRequest(); if (cmdletContext.AmazonId != null) { request.AmazonId = cmdletContext.AmazonId; } if (cmdletContext.ClientId != null) { request.ClientId = cmdletContext.ClientId; } if (cmdletContext.DeviceSerialNumber != null) { request.DeviceSerialNumber = cmdletContext.DeviceSerialNumber; } if (cmdletContext.ProductId != null) { request.ProductId = cmdletContext.ProductId; } if (cmdletContext.RoomArn != null) { request.RoomArn = cmdletContext.RoomArn; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } if (cmdletContext.UserCode != null) { request.UserCode = cmdletContext.UserCode; } 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.AlexaForBusiness.Model.RegisterAVSDeviceResponse CallAWSServiceOperation(IAmazonAlexaForBusiness client, Amazon.AlexaForBusiness.Model.RegisterAVSDeviceRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Alexa For Business", "RegisterAVSDevice"); try { #if DESKTOP return client.RegisterAVSDevice(request); #elif CORECLR return client.RegisterAVSDeviceAsync(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 AmazonId { get; set; } public System.String ClientId { get; set; } public System.String DeviceSerialNumber { get; set; } public System.String ProductId { get; set; } public System.String RoomArn { get; set; } public List Tag { get; set; } public System.String UserCode { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.DeviceArn; } } }