/******************************************************************************* * 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.IoT; using Amazon.IoT.Model; namespace Amazon.PowerShell.Cmdlets.IOT { /// /// Adds a thing to a thing group. /// /// /// /// Requires permission to access the AddThingToThingGroup /// action. /// /// [Cmdlet("Add", "IOTThingToThingGroup", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("None")] [AWSCmdlet("Calls the AWS IoT AddThingToThingGroup API operation.", Operation = new[] {"AddThingToThingGroup"}, SelectReturnType = typeof(Amazon.IoT.Model.AddThingToThingGroupResponse))] [AWSCmdletOutput("None or Amazon.IoT.Model.AddThingToThingGroupResponse", "This cmdlet does not generate any output." + "The service response (type Amazon.IoT.Model.AddThingToThingGroupResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class AddIOTThingToThingGroupCmdlet : AmazonIoTClientCmdlet, IExecutor { #region Parameter OverrideDynamicGroup /// /// /// Override dynamic thing groups with static thing groups when 10-group limit is reached. /// If a thing belongs to 10 thing groups, and one or more of those groups are dynamic /// thing groups, adding a thing to a static group removes the thing from the last dynamic /// group. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("OverrideDynamicGroups")] public System.Boolean? OverrideDynamicGroup { get; set; } #endregion #region Parameter ThingArn /// /// /// The ARN of the thing to add to a group. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ThingArn { get; set; } #endregion #region Parameter ThingGroupArn /// /// /// The ARN of the group to which you are adding a thing. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ThingGroupArn { get; set; } #endregion #region Parameter ThingGroupName /// /// /// The name of the group to which you are adding a thing. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ThingGroupName { get; set; } #endregion #region Parameter ThingName /// /// /// The name of the thing to add to a group. /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] public System.String ThingName { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoT.Model.AddThingToThingGroupResponse). /// 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 ThingName parameter. /// The -PassThru parameter is deprecated, use -Select '^ThingName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ThingName' 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.ThingName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Add-IOTThingToThingGroup (AddThingToThingGroup)")) { 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.ThingName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.OverrideDynamicGroup = this.OverrideDynamicGroup; context.ThingArn = this.ThingArn; context.ThingGroupArn = this.ThingGroupArn; context.ThingGroupName = this.ThingGroupName; context.ThingName = this.ThingName; // 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.IoT.Model.AddThingToThingGroupRequest(); if (cmdletContext.OverrideDynamicGroup != null) { request.OverrideDynamicGroups = cmdletContext.OverrideDynamicGroup.Value; } if (cmdletContext.ThingArn != null) { request.ThingArn = cmdletContext.ThingArn; } if (cmdletContext.ThingGroupArn != null) { request.ThingGroupArn = cmdletContext.ThingGroupArn; } if (cmdletContext.ThingGroupName != null) { request.ThingGroupName = cmdletContext.ThingGroupName; } if (cmdletContext.ThingName != null) { request.ThingName = cmdletContext.ThingName; } 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.IoT.Model.AddThingToThingGroupResponse CallAWSServiceOperation(IAmazonIoT client, Amazon.IoT.Model.AddThingToThingGroupRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS IoT", "AddThingToThingGroup"); try { #if DESKTOP return client.AddThingToThingGroup(request); #elif CORECLR return client.AddThingToThingGroupAsync(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.Boolean? OverrideDynamicGroup { get; set; } public System.String ThingArn { get; set; } public System.String ThingGroupArn { get; set; } public System.String ThingGroupName { get; set; } public System.String ThingName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => null; } } }