/*******************************************************************************
* 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
{
/// <summary>
/// Gets a list of the policies that have an effect on the authorization behavior of the
/// specified device when it connects to the IoT device gateway.
///
///
/// <para>
/// Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetEffectivePolicies</a>
/// action.
/// </para>
/// </summary>
[Cmdlet("Get", "IOTEffectivePolicy")]
[OutputType("Amazon.IoT.Model.EffectivePolicy")]
[AWSCmdlet("Calls the AWS IoT GetEffectivePolicies API operation.", Operation = new[] {"GetEffectivePolicies"}, SelectReturnType = typeof(Amazon.IoT.Model.GetEffectivePoliciesResponse))]
[AWSCmdletOutput("Amazon.IoT.Model.EffectivePolicy or Amazon.IoT.Model.GetEffectivePoliciesResponse",
"This cmdlet returns a collection of Amazon.IoT.Model.EffectivePolicy objects.",
"The service call response (type Amazon.IoT.Model.GetEffectivePoliciesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetIOTEffectivePolicyCmdlet : AmazonIoTClientCmdlet, IExecutor
{
#region Parameter CognitoIdentityPoolId
/// <summary>
/// <para>
/// <para>The Cognito identity pool ID.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String CognitoIdentityPoolId { get; set; }
#endregion
#region Parameter Principal
/// <summary>
/// <para>
/// <para>The principal. Valid principals are CertificateArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:cert/<i>certificateId</i>),
/// thingGroupArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:thinggroup/<i>groupName</i>)
/// and CognitoId (<i>region</i>:<i>id</i>).</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Principal { get; set; }
#endregion
#region Parameter ThingName
/// <summary>
/// <para>
/// <para>The thing name.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ThingName { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// Use the -Select parameter to control the cmdlet output. The default value is 'EffectivePolicies'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoT.Model.GetEffectivePoliciesResponse).
/// Specifying the name of a property of type Amazon.IoT.Model.GetEffectivePoliciesResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "EffectivePolicies";
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate<Amazon.IoT.Model.GetEffectivePoliciesResponse, GetIOTEffectivePolicyCmdlet>(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.CognitoIdentityPoolId = this.CognitoIdentityPoolId;
context.Principal = this.Principal;
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.GetEffectivePoliciesRequest();
if (cmdletContext.CognitoIdentityPoolId != null)
{
request.CognitoIdentityPoolId = cmdletContext.CognitoIdentityPoolId;
}
if (cmdletContext.Principal != null)
{
request.Principal = cmdletContext.Principal;
}
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.GetEffectivePoliciesResponse CallAWSServiceOperation(IAmazonIoT client, Amazon.IoT.Model.GetEffectivePoliciesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS IoT", "GetEffectivePolicies");
try
{
#if DESKTOP
return client.GetEffectivePolicies(request);
#elif CORECLR
return client.GetEffectivePoliciesAsync(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 CognitoIdentityPoolId { get; set; }
public System.String Principal { get; set; }
public System.String ThingName { get; set; }
public System.Func<Amazon.IoT.Model.GetEffectivePoliciesResponse, GetIOTEffectivePolicyCmdlet, object> Select { get; set; } =
(response, cmdlet) => response.EffectivePolicies;
}
}
}