/*******************************************************************************
* 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.WorkDocs;
using Amazon.WorkDocs.Model;
namespace Amazon.PowerShell.Cmdlets.WD
{
///
/// Updates the specified attributes of the specified user, and grants or revokes administrative
/// privileges to the Amazon WorkDocs site.
///
[Cmdlet("Update", "WDUser", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.WorkDocs.Model.User")]
[AWSCmdlet("Calls the Amazon WorkDocs UpdateUser API operation.", Operation = new[] {"UpdateUser"}, SelectReturnType = typeof(Amazon.WorkDocs.Model.UpdateUserResponse))]
[AWSCmdletOutput("Amazon.WorkDocs.Model.User or Amazon.WorkDocs.Model.UpdateUserResponse",
"This cmdlet returns an Amazon.WorkDocs.Model.User object.",
"The service call response (type Amazon.WorkDocs.Model.UpdateUserResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class UpdateWDUserCmdlet : AmazonWorkDocsClientCmdlet, IExecutor
{
protected override bool IsSensitiveRequest { get; set; } = true;
protected override bool IsSensitiveResponse { get; set; } = true;
#region Parameter AuthenticationToken
///
///
/// Amazon WorkDocs authentication token. Not required when using Amazon Web Services
/// administrator credentials to access the API.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String AuthenticationToken { get; set; }
#endregion
#region Parameter GivenName
///
///
/// The given name of the user.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String GivenName { get; set; }
#endregion
#region Parameter GrantPoweruserPrivilege
///
///
/// Boolean value to determine whether the user is granted Power user privileges.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("GrantPoweruserPrivileges")]
[AWSConstantClassSource("Amazon.WorkDocs.BooleanEnumType")]
public Amazon.WorkDocs.BooleanEnumType GrantPoweruserPrivilege { get; set; }
#endregion
#region Parameter Locale
///
///
/// The locale of the user.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.WorkDocs.LocaleType")]
public Amazon.WorkDocs.LocaleType Locale { get; set; }
#endregion
#region Parameter StorageRule_StorageAllocatedInByte
///
///
/// The amount of storage allocated, in bytes.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("StorageRule_StorageAllocatedInBytes")]
public System.Int64? StorageRule_StorageAllocatedInByte { get; set; }
#endregion
#region Parameter StorageRule_StorageType
///
///
/// The type of storage.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.WorkDocs.StorageType")]
public Amazon.WorkDocs.StorageType StorageRule_StorageType { get; set; }
#endregion
#region Parameter Surname
///
///
/// The surname of the user.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Surname { get; set; }
#endregion
#region Parameter TimeZoneId
///
///
/// The time zone ID of the user.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TimeZoneId { get; set; }
#endregion
#region Parameter Type
///
///
/// The type of the user.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.WorkDocs.UserType")]
public Amazon.WorkDocs.UserType Type { get; set; }
#endregion
#region Parameter UserId
///
///
/// The ID of the user.
///
///
#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 UserId { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'User'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkDocs.Model.UpdateUserResponse).
/// Specifying the name of a property of type Amazon.WorkDocs.Model.UpdateUserResponse 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; } = "User";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the UserId parameter.
/// The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^UserId' 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.UserId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-WDUser (UpdateUser)"))
{
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.UserId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.AuthenticationToken = this.AuthenticationToken;
context.GivenName = this.GivenName;
context.GrantPoweruserPrivilege = this.GrantPoweruserPrivilege;
context.Locale = this.Locale;
context.StorageRule_StorageAllocatedInByte = this.StorageRule_StorageAllocatedInByte;
context.StorageRule_StorageType = this.StorageRule_StorageType;
context.Surname = this.Surname;
context.TimeZoneId = this.TimeZoneId;
context.Type = this.Type;
context.UserId = this.UserId;
#if MODULAR
if (this.UserId == null && ParameterWasBound(nameof(this.UserId)))
{
WriteWarning("You are passing $null as a value for parameter UserId 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.WorkDocs.Model.UpdateUserRequest();
if (cmdletContext.AuthenticationToken != null)
{
request.AuthenticationToken = cmdletContext.AuthenticationToken;
}
if (cmdletContext.GivenName != null)
{
request.GivenName = cmdletContext.GivenName;
}
if (cmdletContext.GrantPoweruserPrivilege != null)
{
request.GrantPoweruserPrivileges = cmdletContext.GrantPoweruserPrivilege;
}
if (cmdletContext.Locale != null)
{
request.Locale = cmdletContext.Locale;
}
// populate StorageRule
var requestStorageRuleIsNull = true;
request.StorageRule = new Amazon.WorkDocs.Model.StorageRuleType();
System.Int64? requestStorageRule_storageRule_StorageAllocatedInByte = null;
if (cmdletContext.StorageRule_StorageAllocatedInByte != null)
{
requestStorageRule_storageRule_StorageAllocatedInByte = cmdletContext.StorageRule_StorageAllocatedInByte.Value;
}
if (requestStorageRule_storageRule_StorageAllocatedInByte != null)
{
request.StorageRule.StorageAllocatedInBytes = requestStorageRule_storageRule_StorageAllocatedInByte.Value;
requestStorageRuleIsNull = false;
}
Amazon.WorkDocs.StorageType requestStorageRule_storageRule_StorageType = null;
if (cmdletContext.StorageRule_StorageType != null)
{
requestStorageRule_storageRule_StorageType = cmdletContext.StorageRule_StorageType;
}
if (requestStorageRule_storageRule_StorageType != null)
{
request.StorageRule.StorageType = requestStorageRule_storageRule_StorageType;
requestStorageRuleIsNull = false;
}
// determine if request.StorageRule should be set to null
if (requestStorageRuleIsNull)
{
request.StorageRule = null;
}
if (cmdletContext.Surname != null)
{
request.Surname = cmdletContext.Surname;
}
if (cmdletContext.TimeZoneId != null)
{
request.TimeZoneId = cmdletContext.TimeZoneId;
}
if (cmdletContext.Type != null)
{
request.Type = cmdletContext.Type;
}
if (cmdletContext.UserId != null)
{
request.UserId = cmdletContext.UserId;
}
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.WorkDocs.Model.UpdateUserResponse CallAWSServiceOperation(IAmazonWorkDocs client, Amazon.WorkDocs.Model.UpdateUserRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon WorkDocs", "UpdateUser");
try
{
#if DESKTOP
return client.UpdateUser(request);
#elif CORECLR
return client.UpdateUserAsync(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 AuthenticationToken { get; set; }
public System.String GivenName { get; set; }
public Amazon.WorkDocs.BooleanEnumType GrantPoweruserPrivilege { get; set; }
public Amazon.WorkDocs.LocaleType Locale { get; set; }
public System.Int64? StorageRule_StorageAllocatedInByte { get; set; }
public Amazon.WorkDocs.StorageType StorageRule_StorageType { get; set; }
public System.String Surname { get; set; }
public System.String TimeZoneId { get; set; }
public Amazon.WorkDocs.UserType Type { get; set; }
public System.String UserId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.User;
}
}
}