/******************************************************************************* * 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.KeyManagementService; using Amazon.KeyManagementService.Model; namespace Amazon.PowerShell.Cmdlets.KMS { /// /// Gets a list of all grants for the specified KMS key. /// /// /// /// You must specify the KMS key in all requests. You can filter the grant list by grant /// ID or grantee principal. /// /// For detailed information about grants, including grant terminology, see Grants /// in KMS in the Key Management Service Developer Guide. For examples /// of working with grants in several programming languages, see Programming /// grants. /// /// The GranteePrincipal field in the ListGrants response usually /// contains the user or role designated as the grantee principal in the grant. However, /// when the grantee principal in the grant is an Amazon Web Services service, the GranteePrincipal /// field contains the service /// principal, which might represent several different grantee principals. /// Cross-account use: Yes. To perform this operation on a KMS key in a different /// Amazon Web Services account, specify the key ARN in the value of the KeyId /// parameter. /// Required permissions: kms:ListGrants /// (key policy) /// Related operations:

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", "KMSGrantList")] [OutputType("Amazon.KeyManagementService.Model.GrantListEntry")] [AWSCmdlet("Calls the AWS Key Management Service ListGrants API operation.", Operation = new[] {"ListGrants"}, SelectReturnType = typeof(Amazon.KeyManagementService.Model.ListGrantsResponse), LegacyAlias="Get-KMSGrants")] [AWSCmdletOutput("Amazon.KeyManagementService.Model.GrantListEntry or Amazon.KeyManagementService.Model.ListGrantsResponse", "This cmdlet returns a collection of Amazon.KeyManagementService.Model.GrantListEntry objects.", "The service call response (type Amazon.KeyManagementService.Model.ListGrantsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetKMSGrantListCmdlet : AmazonKeyManagementServiceClientCmdlet, IExecutor { #region Parameter GranteePrincipal /// /// /// Returns only grants where the specified principal is the grantee principal for the /// grant. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String GranteePrincipal { get; set; } #endregion #region Parameter GrantId /// /// /// Returns only the grant with the specified grant ID. The grant ID uniquely identifies /// the grant. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String GrantId { get; set; } #endregion #region Parameter KeyId /// /// /// Returns only grants for the specified KMS key. This parameter is required.Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different /// Amazon Web Services account, you must use the key ARN.For example:To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. /// /// #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 KeyId { get; set; } #endregion #region Parameter Limit /// /// /// Use this parameter to specify the maximum number of items to return. When this value /// is present, KMS does not return more than the specified number of items, but it might /// return fewer.This value is optional. If you include a value, it must be between 1 and 100, inclusive. /// If you do not include a value, it defaults to 50. /// /// ///
Note: In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. ///
In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. ///
Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxItems")] public int? Limit { get; set; } #endregion #region Parameter Marker /// /// /// Use this parameter in a subsequent request after you receive a response with truncated /// results. Set it to the value of NextMarker from the truncated response /// you just received. /// /// ///
Note: 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.NextMarker' for subsequent calls. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("NextToken")] public System.String Marker { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Grants'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.KeyManagementService.Model.ListGrantsResponse). /// Specifying the name of a property of type Amazon.KeyManagementService.Model.ListGrantsResponse 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; } = "Grants"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the KeyId parameter. /// The -PassThru parameter is deprecated, use -Select '^KeyId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^KeyId' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion #region Parameter NoAutoIteration /// /// 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; } #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); #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.KeyId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.GranteePrincipal = this.GranteePrincipal; context.GrantId = this.GrantId; context.KeyId = this.KeyId; #if MODULAR if (this.KeyId == null && ParameterWasBound(nameof(this.KeyId))) { WriteWarning("You are passing $null as a value for parameter KeyId 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.Limit = this.Limit; #if !MODULAR if (ParameterWasBound(nameof(this.Limit)) && this.Limit.HasValue) { WriteWarning("AWSPowerShell and AWSPowerShell.NetCore use the Limit parameter to limit the total number of items returned by the cmdlet." + " This behavior is obsolete and will be removed in a future version of these modules. Pipe the output of this cmdlet into Select-Object -First to terminate" + " retrieving data pages early and control the number of items returned. AWS.Tools already implements the new behavior of simply passing Limit" + " to the service to specify how many items should be returned by each service call."); } #endif context.Marker = this.Marker; // 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; #pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent; #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute // create request and set iteration invariants var request = new Amazon.KeyManagementService.Model.ListGrantsRequest(); if (cmdletContext.GranteePrincipal != null) { request.GranteePrincipal = cmdletContext.GranteePrincipal; } if (cmdletContext.GrantId != null) { request.GrantId = cmdletContext.GrantId; } if (cmdletContext.KeyId != null) { request.KeyId = cmdletContext.KeyId; } if (cmdletContext.Limit != null) { request.Limit = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(cmdletContext.Limit.Value); } // 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.NextMarker; } 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; var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent; // create request and set iteration invariants var request = new Amazon.KeyManagementService.Model.ListGrantsRequest(); if (cmdletContext.GranteePrincipal != null) { request.GranteePrincipal = cmdletContext.GranteePrincipal; } if (cmdletContext.GrantId != null) { request.GrantId = cmdletContext.GrantId; } if (cmdletContext.KeyId != null) { request.KeyId = cmdletContext.KeyId; } // Initialize loop variants and commence piping System.String _nextToken = null; int? _emitLimit = null; int _retrievedSoFar = 0; if (AutoIterationHelpers.HasValue(cmdletContext.Marker)) { _nextToken = cmdletContext.Marker; } if (cmdletContext.Limit.HasValue) { // The service has a maximum page size of 1000. If the user has // asked for more items than page max, and there is no page size // configured, we rely on the service ignoring the set maximum // and giving us 1000 items back. If a page size is set, that will // be used to configure the pagination. // We'll make further calls to satisfy the user's request. _emitLimit = cmdletContext.Limit; } var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.Marker)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.Marker = _nextToken; if (_emitLimit.HasValue) { int correctPageSize = Math.Min(1000, _emitLimit.Value); request.Limit = AutoIterationHelpers.ConvertEmitLimitToInt32(correctPageSize); } 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 }; int _receivedThisCall = response.Grants.Count; _nextToken = response.NextMarker; _retrievedSoFar += _receivedThisCall; if (_emitLimit.HasValue) { _emitLimit -= _receivedThisCall; } } catch (Exception e) { if (_retrievedSoFar == 0 || !_emitLimit.HasValue) { output = new CmdletOutput { ErrorResponse = e }; } else { break; } } ProcessOutput(output); } while (!_userControllingPaging && AutoIterationHelpers.HasValue(_nextToken) && (!_emitLimit.HasValue || _emitLimit.Value >= 1)); if (useParameterSelect) { WriteObject(cmdletContext.Select(null, this)); } return null; } #endif public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.KeyManagementService.Model.ListGrantsResponse CallAWSServiceOperation(IAmazonKeyManagementService client, Amazon.KeyManagementService.Model.ListGrantsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Key Management Service", "ListGrants"); try { #if DESKTOP return client.ListGrants(request); #elif CORECLR return client.ListGrantsAsync(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 GranteePrincipal { get; set; } public System.String GrantId { get; set; } public System.String KeyId { get; set; } public int? Limit { get; set; } public System.String Marker { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Grants; } } }