/******************************************************************************* * 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.ECR; using Amazon.ECR.Model; namespace Amazon.PowerShell.Cmdlets.ECR { /// /// Retrieves the results of the lifecycle policy preview request for the specified repository.

In the AWS.Tools.ECR 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", "ECRLifecyclePolicyPreview")] [OutputType("Amazon.ECR.Model.GetLifecyclePolicyPreviewResponse")] [AWSCmdlet("Calls the Amazon EC2 Container Registry GetLifecyclePolicyPreview API operation.", Operation = new[] {"GetLifecyclePolicyPreview"}, SelectReturnType = typeof(Amazon.ECR.Model.GetLifecyclePolicyPreviewResponse))] [AWSCmdletOutput("Amazon.ECR.Model.GetLifecyclePolicyPreviewResponse", "This cmdlet returns an Amazon.ECR.Model.GetLifecyclePolicyPreviewResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetECRLifecyclePolicyPreviewCmdlet : AmazonECRClientCmdlet, IExecutor { #region Parameter ImageId /// /// /// The list of imageIDs to be included. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ImageIds")] public Amazon.ECR.Model.ImageIdentifier[] ImageId { get; set; } #endregion #region Parameter RegistryId /// /// /// The Amazon Web Services account ID associated with the registry that contains the /// repository. If you do not specify a registry, the default registry is assumed. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RegistryId { get; set; } #endregion #region Parameter RepositoryName /// /// /// The name of the repository. /// /// #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 RepositoryName { get; set; } #endregion #region Parameter Filter_TagStatus /// /// /// The tag status of the image. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.ECR.TagStatus")] public Amazon.ECR.TagStatus Filter_TagStatus { get; set; } #endregion #region Parameter MaxResult /// /// /// The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest /// in paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest /// only returns maxResults results in a single page along with a /// nextToken response element. The remaining results of the initial /// request can be seen by sending another GetLifecyclePolicyPreviewRequest /// request with the returned nextToken value. This value can be /// between 1 and 1000. If this parameter is not used, then GetLifecyclePolicyPreviewRequest /// returns up to 100 results and a nextToken value, if applicable. /// This option cannot be used when you specify images with imageIds. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxResults")] public System.Int32? MaxResult { get; set; } #endregion #region Parameter NextToken /// /// /// The nextToken value returned from a previous paginated GetLifecyclePolicyPreviewRequest /// request where maxResults was used and the results exceeded the /// value of that parameter. Pagination continues from the end of the previous /// results that returned the nextToken value. This value is null /// when there are no more results to return. This option cannot be used when you specify /// images with imageIds. /// /// ///
Note: In the AWS.Tools.ECR 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 '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. ///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String NextToken { 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.ECR.Model.GetLifecyclePolicyPreviewResponse). /// Specifying the name of a property of type Amazon.ECR.Model.GetLifecyclePolicyPreviewResponse 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 PassThru /// /// Changes the cmdlet behavior to return the value passed to the RepositoryName parameter. /// The -PassThru parameter is deprecated, use -Select '^RepositoryName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^RepositoryName' 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 #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 NextToken /// 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); #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.RepositoryName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Filter_TagStatus = this.Filter_TagStatus; if (this.ImageId != null) { context.ImageId = new List(this.ImageId); } context.MaxResult = this.MaxResult; context.NextToken = this.NextToken; context.RegistryId = this.RegistryId; context.RepositoryName = this.RepositoryName; #if MODULAR if (this.RepositoryName == null && ParameterWasBound(nameof(this.RepositoryName))) { WriteWarning("You are passing $null as a value for parameter RepositoryName 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 #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.ECR.Model.GetLifecyclePolicyPreviewRequest(); // populate Filter var requestFilterIsNull = true; request.Filter = new Amazon.ECR.Model.LifecyclePolicyPreviewFilter(); Amazon.ECR.TagStatus requestFilter_filter_TagStatus = null; if (cmdletContext.Filter_TagStatus != null) { requestFilter_filter_TagStatus = cmdletContext.Filter_TagStatus; } if (requestFilter_filter_TagStatus != null) { request.Filter.TagStatus = requestFilter_filter_TagStatus; requestFilterIsNull = false; } // determine if request.Filter should be set to null if (requestFilterIsNull) { request.Filter = null; } if (cmdletContext.ImageId != null) { request.ImageIds = cmdletContext.ImageId; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.RegistryId != null) { request.RegistryId = cmdletContext.RegistryId; } if (cmdletContext.RepositoryName != null) { request.RepositoryName = cmdletContext.RepositoryName; } // Initialize loop variant and commence piping var _nextToken = cmdletContext.NextToken; var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken)); var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint); do { request.NextToken = _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.NextToken; } 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.ECR.Model.GetLifecyclePolicyPreviewRequest(); // populate Filter var requestFilterIsNull = true; request.Filter = new Amazon.ECR.Model.LifecyclePolicyPreviewFilter(); Amazon.ECR.TagStatus requestFilter_filter_TagStatus = null; if (cmdletContext.Filter_TagStatus != null) { requestFilter_filter_TagStatus = cmdletContext.Filter_TagStatus; } if (requestFilter_filter_TagStatus != null) { request.Filter.TagStatus = requestFilter_filter_TagStatus; requestFilterIsNull = false; } // determine if request.Filter should be set to null if (requestFilterIsNull) { request.Filter = null; } if (cmdletContext.ImageId != null) { request.ImageIds = cmdletContext.ImageId; } if (cmdletContext.MaxResult != null) { request.MaxResults = cmdletContext.MaxResult.Value; } if (cmdletContext.NextToken != null) { request.NextToken = cmdletContext.NextToken; } if (cmdletContext.RegistryId != null) { request.RegistryId = cmdletContext.RegistryId; } if (cmdletContext.RepositoryName != null) { request.RepositoryName = cmdletContext.RepositoryName; } 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.ECR.Model.GetLifecyclePolicyPreviewResponse CallAWSServiceOperation(IAmazonECR client, Amazon.ECR.Model.GetLifecyclePolicyPreviewRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon EC2 Container Registry", "GetLifecyclePolicyPreview"); try { #if DESKTOP return client.GetLifecyclePolicyPreview(request); #elif CORECLR return client.GetLifecyclePolicyPreviewAsync(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.ECR.TagStatus Filter_TagStatus { get; set; } public List ImageId { get; set; } public System.Int32? MaxResult { get; set; } public System.String NextToken { get; set; } public System.String RegistryId { get; set; } public System.String RepositoryName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }