/******************************************************************************* * 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.Honeycode; using Amazon.Honeycode.Model; namespace Amazon.PowerShell.Cmdlets.HC { /// /// The InvokeScreenAutomation API allows invoking an action defined in a screen in a /// Honeycode app. The API allows setting local variables, which can then be used in the /// automation being invoked. This allows automating the Honeycode app interactions to /// write, update or delete data in the workbook. /// [Cmdlet("Invoke", "HCScreenAutomation", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.Int64")] [AWSCmdlet("Calls the Amazon Honeycode InvokeScreenAutomation API operation.", Operation = new[] {"InvokeScreenAutomation"}, SelectReturnType = typeof(Amazon.Honeycode.Model.InvokeScreenAutomationResponse))] [AWSCmdletOutput("System.Int64 or Amazon.Honeycode.Model.InvokeScreenAutomationResponse", "This cmdlet returns a System.Int64 object.", "The service call response (type Amazon.Honeycode.Model.InvokeScreenAutomationResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class InvokeHCScreenAutomationCmdlet : AmazonHoneycodeClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; #region Parameter AppId /// /// /// The ID of the app that contains the screen automation. /// /// #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 AppId { get; set; } #endregion #region Parameter ClientRequestToken /// /// /// The request token for performing the automation action. Request tokens help to identify /// duplicate requests. If a call times out or fails due to a transient error like a failed /// network connection, you can retry the call with the same request token. The service /// ensures that if the first call using that request token is successfully performed, /// the second call will return the response of the previous call rather than performing /// the action again. Note that request tokens are valid only for a few minutes. You cannot use request /// tokens to dedupe requests spanning hours or days. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientRequestToken { get; set; } #endregion #region Parameter RowId /// /// /// The row ID for the automation if the automation is defined inside a block with source /// or list. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RowId { get; set; } #endregion #region Parameter ScreenAutomationId /// /// /// The ID of the automation action to be performed. /// /// #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 ScreenAutomationId { get; set; } #endregion #region Parameter ScreenId /// /// /// The ID of the screen that contains the screen automation. /// /// #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 ScreenId { get; set; } #endregion #region Parameter Variable /// /// /// Variables are specified as a map where the key is the name of the variable as defined /// on the screen. The value is an object which currently has only one property, rawValue, /// which holds the value of the variable to be passed to the screen. Any variables defined /// in a screen are required to be passed in the call. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Variables")] public System.Collections.Hashtable Variable { get; set; } #endregion #region Parameter WorkbookId /// /// /// The ID of the workbook that contains the screen automation. /// /// #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 WorkbookId { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'WorkbookCursor'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Honeycode.Model.InvokeScreenAutomationResponse). /// Specifying the name of a property of type Amazon.Honeycode.Model.InvokeScreenAutomationResponse 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; } = "WorkbookCursor"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the ScreenAutomationId parameter. /// The -PassThru parameter is deprecated, use -Select '^ScreenAutomationId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ScreenAutomationId' 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.ScreenAutomationId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Invoke-HCScreenAutomation (InvokeScreenAutomation)")) { 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.ScreenAutomationId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.AppId = this.AppId; #if MODULAR if (this.AppId == null && ParameterWasBound(nameof(this.AppId))) { WriteWarning("You are passing $null as a value for parameter AppId 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.ClientRequestToken = this.ClientRequestToken; context.RowId = this.RowId; context.ScreenAutomationId = this.ScreenAutomationId; #if MODULAR if (this.ScreenAutomationId == null && ParameterWasBound(nameof(this.ScreenAutomationId))) { WriteWarning("You are passing $null as a value for parameter ScreenAutomationId 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.ScreenId = this.ScreenId; #if MODULAR if (this.ScreenId == null && ParameterWasBound(nameof(this.ScreenId))) { WriteWarning("You are passing $null as a value for parameter ScreenId 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.Variable != null) { context.Variable = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.Variable.Keys) { context.Variable.Add((String)hashKey, (VariableValue)(this.Variable[hashKey])); } } context.WorkbookId = this.WorkbookId; #if MODULAR if (this.WorkbookId == null && ParameterWasBound(nameof(this.WorkbookId))) { WriteWarning("You are passing $null as a value for parameter WorkbookId 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.Honeycode.Model.InvokeScreenAutomationRequest(); if (cmdletContext.AppId != null) { request.AppId = cmdletContext.AppId; } if (cmdletContext.ClientRequestToken != null) { request.ClientRequestToken = cmdletContext.ClientRequestToken; } if (cmdletContext.RowId != null) { request.RowId = cmdletContext.RowId; } if (cmdletContext.ScreenAutomationId != null) { request.ScreenAutomationId = cmdletContext.ScreenAutomationId; } if (cmdletContext.ScreenId != null) { request.ScreenId = cmdletContext.ScreenId; } if (cmdletContext.Variable != null) { request.Variables = cmdletContext.Variable; } if (cmdletContext.WorkbookId != null) { request.WorkbookId = cmdletContext.WorkbookId; } 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.Honeycode.Model.InvokeScreenAutomationResponse CallAWSServiceOperation(IAmazonHoneycode client, Amazon.Honeycode.Model.InvokeScreenAutomationRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Honeycode", "InvokeScreenAutomation"); try { #if DESKTOP return client.InvokeScreenAutomation(request); #elif CORECLR return client.InvokeScreenAutomationAsync(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 AppId { get; set; } public System.String ClientRequestToken { get; set; } public System.String RowId { get; set; } public System.String ScreenAutomationId { get; set; } public System.String ScreenId { get; set; } public Dictionary Variable { get; set; } public System.String WorkbookId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.WorkbookCursor; } } }