/******************************************************************************* * 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.IdentityManagement; using Amazon.IdentityManagement.Model; namespace Amazon.PowerShell.Cmdlets.IAM { /// /// Lists all IAM users, groups, and roles that the specified managed policy is attached /// to. /// /// /// /// You can use the optional EntityFilter parameter to limit the results /// to a particular type of entity (users, groups, or roles). For example, to list only /// the roles that are attached to the specified policy, set EntityFilter /// to Role. /// /// You can paginate the results using the MaxItems and Marker /// parameters. ///

In the AWS.Tools.IdentityManagement module, this cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. ///
[Cmdlet("Get", "IAMEntitiesForPolicy")] [OutputType("Amazon.IdentityManagement.Model.ListEntitiesForPolicyResponse")] [AWSCmdlet("Calls the AWS Identity and Access Management ListEntitiesForPolicy API operation.", Operation = new[] {"ListEntitiesForPolicy"}, SelectReturnType = typeof(Amazon.IdentityManagement.Model.ListEntitiesForPolicyResponse))] [AWSCmdletOutput("Amazon.IdentityManagement.Model.ListEntitiesForPolicyResponse", "This cmdlet returns an Amazon.IdentityManagement.Model.ListEntitiesForPolicyResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetIAMEntitiesForPolicyCmdlet : AmazonIdentityManagementServiceClientCmdlet, IExecutor { #region Parameter EntityFilter /// /// /// The entity type to use for filtering the results.For example, when EntityFilter is Role, only the roles that /// are attached to the specified policy are returned. This parameter is optional. If /// it is not included, all attached entities (users, groups, and roles) are returned. /// The argument for this parameter must be one of the valid values listed below. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.IdentityManagement.EntityType")] public Amazon.IdentityManagement.EntityType EntityFilter { get; set; } #endregion #region Parameter PathPrefix /// /// /// The path prefix for filtering the results. This parameter is optional. If it is not /// included, it defaults to a slash (/), listing all entities.This parameter allows (through its regex /// pattern) a string of characters consisting of either a forward slash (/) by itself /// or a string that must begin and end with forward slashes. In addition, it can contain /// any ASCII character from the ! (\u0021) through the DEL character (\u007F), /// including most punctuation characters, digits, and upper and lowercased letters. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PathPrefix { get; set; } #endregion #region Parameter PolicyArn /// /// /// The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.For more information about ARNs, see Amazon /// Resource Names (ARNs) in the Amazon Web Services General Reference. /// /// #if !MODULAR [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(Position = 1, ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyString] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] public System.String PolicyArn { get; set; } #endregion #region Parameter PolicyUsageFilter /// /// /// The policy usage method to use for filtering the results.To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. /// To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.This parameter is optional. If it is not included, all policies are returned. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.IdentityManagement.PolicyUsageType")] public Amazon.IdentityManagement.PolicyUsageType PolicyUsageFilter { get; set; } #endregion #region Parameter Marker /// /// /// Use this parameter only when paginating results and only after you receive a response /// indicating that the results are truncated. Set it to the value of the Marker /// element in the response that you received to indicate where the next call should start. /// /// ///
Note: In the AWS.Tools.IdentityManagement module, this parameter is only used if you are manually controlling output pagination of the service API call. ///
In order to manually control output pagination, use '-Marker $null' for the first call and '-Marker $AWSHistory.LastServiceResponse.Marker' for subsequent calls. ///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("NextToken")] public System.String Marker { get; set; } #endregion #region Parameter MaxItem /// /// /// Use this only when paginating results to indicate the maximum number of items you /// want in the response. If additional items exist beyond the maximum you specify, the /// IsTruncated response element is true.If you do not include this parameter, the number of items defaults to 100. Note that /// IAM might return fewer results, even when there are more results available. In that /// case, the IsTruncated response element returns true, and /// Marker contains a value to include in the subsequent call that tells /// the service where to continue from. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxItems")] public System.Int32? MaxItem { 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.IdentityManagement.Model.ListEntitiesForPolicyResponse). /// Specifying the name of a property of type Amazon.IdentityManagement.Model.ListEntitiesForPolicyResponse 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 NoAutoIteration #if MODULAR /// /// By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple /// service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker /// as the start point. /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter NoAutoIteration { get; set; } #endif #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(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } context.EntityFilter = this.EntityFilter; context.Marker = this.Marker; context.MaxItem = this.MaxItem; context.PathPrefix = this.PathPrefix; context.PolicyArn = this.PolicyArn; #if MODULAR if (this.PolicyArn == null && ParameterWasBound(nameof(this.PolicyArn))) { WriteWarning("You are passing $null as a value for parameter PolicyArn 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.PolicyUsageFilter = this.PolicyUsageFilter; // allow further manipulation of loaded context prior to processing PostExecutionContextLoad(context); var output = Execute(context) as CmdletOutput; ProcessOutput(output); } #region IExecutor Members #if MODULAR public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; var useParameterSelect = this.Select.StartsWith("^"); // create request and set iteration invariants var request = new Amazon.IdentityManagement.Model.ListEntitiesForPolicyRequest(); if (cmdletContext.EntityFilter != null) { request.EntityFilter = cmdletContext.EntityFilter; } if (cmdletContext.MaxItem != null) { request.MaxItems = cmdletContext.MaxItem.Value; } if (cmdletContext.PathPrefix != null) { request.PathPrefix = cmdletContext.PathPrefix; } if (cmdletContext.PolicyArn != null) { request.PolicyArn = cmdletContext.PolicyArn; } if (cmdletContext.PolicyUsageFilter != null) { request.PolicyUsageFilter = cmdletContext.PolicyUsageFilter; } // Initialize loop variant and commence piping var _nextToken = cmdletContext.Marker; var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.Marker = _nextToken; CmdletOutput output; try { var response = CallAWSServiceOperation(client, request); object pipelineOutput = null; if (!useParameterSelect) { pipelineOutput = cmdletContext.Select(response, this); } output = new CmdletOutput { PipelineOutput = pipelineOutput, ServiceResponse = response }; _nextToken = response.Marker; } catch (Exception e) { output = new CmdletOutput { ErrorResponse = e }; } ProcessOutput(output); } while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken)); if (useParameterSelect) { WriteObject(cmdletContext.Select(null, this)); } return null; } #else public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.IdentityManagement.Model.ListEntitiesForPolicyRequest(); if (cmdletContext.EntityFilter != null) { request.EntityFilter = cmdletContext.EntityFilter; } if (cmdletContext.Marker != null) { request.Marker = cmdletContext.Marker; } if (cmdletContext.MaxItem != null) { request.MaxItems = cmdletContext.MaxItem.Value; } if (cmdletContext.PathPrefix != null) { request.PathPrefix = cmdletContext.PathPrefix; } if (cmdletContext.PolicyArn != null) { request.PolicyArn = cmdletContext.PolicyArn; } if (cmdletContext.PolicyUsageFilter != null) { request.PolicyUsageFilter = cmdletContext.PolicyUsageFilter; } 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; } #endif public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.IdentityManagement.Model.ListEntitiesForPolicyResponse CallAWSServiceOperation(IAmazonIdentityManagementService client, Amazon.IdentityManagement.Model.ListEntitiesForPolicyRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Identity and Access Management", "ListEntitiesForPolicy"); try { #if DESKTOP return client.ListEntitiesForPolicy(request); #elif CORECLR return client.ListEntitiesForPolicyAsync(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 Amazon.IdentityManagement.EntityType EntityFilter { get; set; } public System.String Marker { get; set; } public System.Int32? MaxItem { get; set; } public System.String PathPrefix { get; set; } public System.String PolicyArn { get; set; } public Amazon.IdentityManagement.PolicyUsageType PolicyUsageFilter { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }