/******************************************************************************* * 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.ECRPublic; using Amazon.ECRPublic.Model; namespace Amazon.PowerShell.Cmdlets.ECRP { /// /// Returns metadata that's related to the images in a repository in a public registry. /// /// /// Beginning with Docker version 1.9, the Docker client compresses image layers before /// pushing them to a V2 Docker registry. The output of the docker images /// command shows the uncompressed image size. Therefore, it might return a larger image /// size than the image sizes that are returned by DescribeImages. /// /// [Cmdlet("Get", "ECRPImage")] [OutputType("Amazon.ECRPublic.Model.ImageDetail")] [AWSCmdlet("Calls the Amazon Elastic Container Registry Public DescribeImages API operation.", Operation = new[] {"DescribeImages"}, SelectReturnType = typeof(Amazon.ECRPublic.Model.DescribeImagesResponse))] [AWSCmdletOutput("Amazon.ECRPublic.Model.ImageDetail or Amazon.ECRPublic.Model.DescribeImagesResponse", "This cmdlet returns a collection of Amazon.ECRPublic.Model.ImageDetail objects.", "The service call response (type Amazon.ECRPublic.Model.DescribeImagesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetECRPImageCmdlet : AmazonECRPublicClientCmdlet, IExecutor { #region Parameter ImageId /// /// /// The list of image IDs for the requested repository. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ImageIds")] public Amazon.ECRPublic.Model.ImageIdentifier[] ImageId { get; set; } #endregion #region Parameter RegistryId /// /// /// The Amazon Web Services account ID that's associated with the public registry that /// contains the repository where images are described. If you do not specify a registry, /// the default public registry is assumed. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RegistryId { get; set; } #endregion #region Parameter RepositoryName /// /// /// The repository that contains the images to describe. /// /// #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 MaxResult /// /// /// The maximum number of repository results that's returned by DescribeImages /// in paginated output. When this parameter is used, DescribeImages only /// returns maxResults results in a single page along with a nextToken /// response element. You can see the remaining results of the initial request by sending /// another DescribeImages request with the returned nextToken /// value. This value can be between 1 and 1000. If this parameter isn't used, then DescribeImages /// returns up to 100 results and a nextToken value, if applicable. If you /// specify images with imageIds, you can't use this option. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxResults")] public System.Int32? MaxResult { get; set; } #endregion #region Parameter NextToken /// /// /// The nextToken value that's returned from a previous paginated DescribeImages /// 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. If there are no more results to return, /// this value is null. If you specify images with imageIds, /// you can't use this option. /// /// [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 'ImageDetails'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ECRPublic.Model.DescribeImagesResponse). /// Specifying the name of a property of type Amazon.ECRPublic.Model.DescribeImagesResponse 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; } = "ImageDetails"; #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 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 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 public object Execute(ExecutorContext context) { var cmdletContext = context as CmdletContext; // create request var request = new Amazon.ECRPublic.Model.DescribeImagesRequest(); 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; } public ExecutorContext CreateContext() { return new CmdletContext(); } #endregion #region AWS Service Operation Call private Amazon.ECRPublic.Model.DescribeImagesResponse CallAWSServiceOperation(IAmazonECRPublic client, Amazon.ECRPublic.Model.DescribeImagesRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Elastic Container Registry Public", "DescribeImages"); try { #if DESKTOP return client.DescribeImages(request); #elif CORECLR return client.DescribeImagesAsync(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 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.ImageDetails; } } }