/*******************************************************************************
* 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.WorkMail;
using Amazon.WorkMail.Model;
namespace Amazon.PowerShell.Cmdlets.WM
{
///
/// Creates or updates a mobile device access override for the given WorkMail organization,
/// user, and device.
///
[Cmdlet("Write", "WMMobileDeviceAccessOverride", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the Amazon WorkMail PutMobileDeviceAccessOverride API operation.", Operation = new[] {"PutMobileDeviceAccessOverride"}, SelectReturnType = typeof(Amazon.WorkMail.Model.PutMobileDeviceAccessOverrideResponse))]
[AWSCmdletOutput("None or Amazon.WorkMail.Model.PutMobileDeviceAccessOverrideResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.WorkMail.Model.PutMobileDeviceAccessOverrideResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class WriteWMMobileDeviceAccessOverrideCmdlet : AmazonWorkMailClientCmdlet, IExecutor
{
#region Parameter Description
///
///
/// A description of the override.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Description { get; set; }
#endregion
#region Parameter DeviceId
///
///
/// The mobile device for which you create the override. DeviceId
is case
/// insensitive.
///
///
#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 DeviceId { get; set; }
#endregion
#region Parameter Effect
///
///
/// The effect of the override, ALLOW
or DENY
.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
[AWSConstantClassSource("Amazon.WorkMail.MobileDeviceAccessRuleEffect")]
public Amazon.WorkMail.MobileDeviceAccessRuleEffect Effect { get; set; }
#endregion
#region Parameter OrganizationId
///
///
/// Identifies the WorkMail organization for which you create the override.
///
///
#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 OrganizationId { get; set; }
#endregion
#region Parameter UserId
///
///
/// The WorkMail user for which you create the override. Accepts the following types of
/// user identities:- User ID:
12345678-1234-1234-1234-123456789012
or S-1-1-12-1234567890-123456789-123456789-1234
- Email address:
user@domain.tld
- User name:
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 cmdlet doesn't have a return value by default.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkMail.Model.PutMobileDeviceAccessOverrideResponse).
/// 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 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.DeviceId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-WMMobileDeviceAccessOverride (PutMobileDeviceAccessOverride)"))
{
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.Description = this.Description;
context.DeviceId = this.DeviceId;
#if MODULAR
if (this.DeviceId == null && ParameterWasBound(nameof(this.DeviceId)))
{
WriteWarning("You are passing $null as a value for parameter DeviceId 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.Effect = this.Effect;
#if MODULAR
if (this.Effect == null && ParameterWasBound(nameof(this.Effect)))
{
WriteWarning("You are passing $null as a value for parameter Effect 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.OrganizationId = this.OrganizationId;
#if MODULAR
if (this.OrganizationId == null && ParameterWasBound(nameof(this.OrganizationId)))
{
WriteWarning("You are passing $null as a value for parameter OrganizationId 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.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.WorkMail.Model.PutMobileDeviceAccessOverrideRequest();
if (cmdletContext.Description != null)
{
request.Description = cmdletContext.Description;
}
if (cmdletContext.DeviceId != null)
{
request.DeviceId = cmdletContext.DeviceId;
}
if (cmdletContext.Effect != null)
{
request.Effect = cmdletContext.Effect;
}
if (cmdletContext.OrganizationId != null)
{
request.OrganizationId = cmdletContext.OrganizationId;
}
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.WorkMail.Model.PutMobileDeviceAccessOverrideResponse CallAWSServiceOperation(IAmazonWorkMail client, Amazon.WorkMail.Model.PutMobileDeviceAccessOverrideRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon WorkMail", "PutMobileDeviceAccessOverride");
try
{
#if DESKTOP
return client.PutMobileDeviceAccessOverride(request);
#elif CORECLR
return client.PutMobileDeviceAccessOverrideAsync(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 Description { get; set; }
public System.String DeviceId { get; set; }
public Amazon.WorkMail.MobileDeviceAccessRuleEffect Effect { get; set; }
public System.String OrganizationId { get; set; }
public System.String UserId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}