/******************************************************************************* * 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.IoTSiteWise; using Amazon.IoTSiteWise.Model; namespace Amazon.PowerShell.Cmdlets.IOTSW { /// /// Updates a gateway capability configuration or defines a new capability configuration. /// Each gateway capability defines data sources for a gateway. A capability configuration /// can contain multiple data source configurations. If you define OPC-UA sources for /// a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one /// capability configuration. To list all capability configurations for a gateway, use /// DescribeGateway. /// [Cmdlet("Update", "IOTSWGatewayCapabilityConfiguration", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.IoTSiteWise.Model.UpdateGatewayCapabilityConfigurationResponse")] [AWSCmdlet("Calls the AWS IoT SiteWise UpdateGatewayCapabilityConfiguration API operation.", Operation = new[] {"UpdateGatewayCapabilityConfiguration"}, SelectReturnType = typeof(Amazon.IoTSiteWise.Model.UpdateGatewayCapabilityConfigurationResponse))] [AWSCmdletOutput("Amazon.IoTSiteWise.Model.UpdateGatewayCapabilityConfigurationResponse", "This cmdlet returns an Amazon.IoTSiteWise.Model.UpdateGatewayCapabilityConfigurationResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateIOTSWGatewayCapabilityConfigurationCmdlet : AmazonIoTSiteWiseClientCmdlet, IExecutor { #region Parameter CapabilityConfiguration /// /// /// The JSON document that defines the configuration for the gateway capability. For more /// information, see Configuring /// data sources (CLI) in the IoT SiteWise User Guide. /// /// #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 CapabilityConfiguration { get; set; } #endregion #region Parameter CapabilityNamespace /// /// /// The namespace of the gateway capability configuration to be updated. For example, /// if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability /// configuration has the namespace iotsitewise:opcuacollector:version, where /// version is a number such as 1. /// /// #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 CapabilityNamespace { get; set; } #endregion #region Parameter GatewayId /// /// /// The ID of the gateway to be updated. /// /// #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 GatewayId { 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.IoTSiteWise.Model.UpdateGatewayCapabilityConfigurationResponse). /// Specifying the name of a property of type Amazon.IoTSiteWise.Model.UpdateGatewayCapabilityConfigurationResponse 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 GatewayId parameter. /// The -PassThru parameter is deprecated, use -Select '^GatewayId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^GatewayId' 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.GatewayId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-IOTSWGatewayCapabilityConfiguration (UpdateGatewayCapabilityConfiguration)")) { 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.GatewayId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.CapabilityConfiguration = this.CapabilityConfiguration; #if MODULAR if (this.CapabilityConfiguration == null && ParameterWasBound(nameof(this.CapabilityConfiguration))) { WriteWarning("You are passing $null as a value for parameter CapabilityConfiguration 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.CapabilityNamespace = this.CapabilityNamespace; #if MODULAR if (this.CapabilityNamespace == null && ParameterWasBound(nameof(this.CapabilityNamespace))) { WriteWarning("You are passing $null as a value for parameter CapabilityNamespace 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.GatewayId = this.GatewayId; #if MODULAR if (this.GatewayId == null && ParameterWasBound(nameof(this.GatewayId))) { WriteWarning("You are passing $null as a value for parameter GatewayId 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.IoTSiteWise.Model.UpdateGatewayCapabilityConfigurationRequest(); if (cmdletContext.CapabilityConfiguration != null) { request.CapabilityConfiguration = cmdletContext.CapabilityConfiguration; } if (cmdletContext.CapabilityNamespace != null) { request.CapabilityNamespace = cmdletContext.CapabilityNamespace; } if (cmdletContext.GatewayId != null) { request.GatewayId = cmdletContext.GatewayId; } 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.IoTSiteWise.Model.UpdateGatewayCapabilityConfigurationResponse CallAWSServiceOperation(IAmazonIoTSiteWise client, Amazon.IoTSiteWise.Model.UpdateGatewayCapabilityConfigurationRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS IoT SiteWise", "UpdateGatewayCapabilityConfiguration"); try { #if DESKTOP return client.UpdateGatewayCapabilityConfiguration(request); #elif CORECLR return client.UpdateGatewayCapabilityConfigurationAsync(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 CapabilityConfiguration { get; set; } public System.String CapabilityNamespace { get; set; } public System.String GatewayId { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }