/*******************************************************************************
* 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
{
///
/// Lists all the image IDs for the specified repository.
///
///
///
/// You can filter images based on whether or not they are tagged by using the tagStatus
/// filter and specifying either TAGGED
, UNTAGGED
or ANY
.
/// For example, you can filter your results to return only UNTAGGED
images
/// and then pipe that result to a BatchDeleteImage operation to delete them. Or,
/// you can filter your results to return only TAGGED
images to list all
/// of the tags in your repository.
///
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", "ECRImage")]
[OutputType("Amazon.ECR.Model.ImageIdentifier")]
[AWSCmdlet("Calls the Amazon EC2 Container Registry ListImages API operation.", Operation = new[] {"ListImages"}, SelectReturnType = typeof(Amazon.ECR.Model.ListImagesResponse))]
[AWSCmdletOutput("Amazon.ECR.Model.ImageIdentifier or Amazon.ECR.Model.ListImagesResponse",
"This cmdlet returns a collection of Amazon.ECR.Model.ImageIdentifier objects.",
"The service call response (type Amazon.ECR.Model.ListImagesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetECRImageCmdlet : AmazonECRClientCmdlet, IExecutor
{
#region Parameter RegistryId
///
///
/// The Amazon Web Services account ID associated with the registry that contains the
/// repository in which to list images. 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 repository with image IDs to be listed.
///
///
#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 with which to filter your ListImages results. You can filter
/// results based on whether they are TAGGED
or UNTAGGED
.
///
///
[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 image results returned by ListImages
in paginated
/// output. When this parameter is used, ListImages
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 ListImages
/// request with the returned nextToken
value. This value can be between
/// 1 and 1000. If this parameter is not used, then ListImages
returns up
/// to 100 results and a nextToken
value, if applicable.
///
///
///
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","MaxResults")]
public int? MaxResult { get; set; }
#endregion
#region Parameter NextToken
///
///
/// The nextToken
value returned from a previous paginated ListImages
/// 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 token should be treated as an opaque identifier that is only used to retrieve
/// the next items in a list and not for other programmatic purposes.
///
///
///
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 '-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 'ImageIds'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ECR.Model.ListImagesResponse).
/// Specifying the name of a property of type Amazon.ECR.Model.ListImagesResponse 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; } = "ImageIds";
#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
///
/// 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; }
#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;
context.MaxResult = this.MaxResult;
#if !MODULAR
if (ParameterWasBound(nameof(this.MaxResult)) && this.MaxResult.HasValue)
{
WriteWarning("AWSPowerShell and AWSPowerShell.NetCore use the MaxResult 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 MaxResult" +
" to the service to specify how many items should be returned by each service call.");
}
#endif
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.ListImagesRequest();
// populate Filter
var requestFilterIsNull = true;
request.Filter = new Amazon.ECR.Model.ListImagesFilter();
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.MaxResult != null)
{
request.MaxResults = AutoIterationHelpers.ConvertEmitLimitToServiceTypeInt32(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;
var useParameterSelect = this.Select.StartsWith("^") || this.PassThru.IsPresent;
// create request and set iteration invariants
var request = new Amazon.ECR.Model.ListImagesRequest();
// populate Filter
var requestFilterIsNull = true;
request.Filter = new Amazon.ECR.Model.ListImagesFilter();
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.RegistryId != null)
{
request.RegistryId = cmdletContext.RegistryId;
}
if (cmdletContext.RepositoryName != null)
{
request.RepositoryName = cmdletContext.RepositoryName;
}
// Initialize loop variants and commence piping
System.String _nextToken = null;
int? _emitLimit = null;
int _retrievedSoFar = 0;
if (AutoIterationHelpers.HasValue(cmdletContext.NextToken))
{
_nextToken = cmdletContext.NextToken;
}
if (cmdletContext.MaxResult.HasValue)
{
// The service has a maximum page size of 100. 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 100 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.MaxResult;
}
var _userControllingPaging = this.NoAutoIteration.IsPresent || ParameterWasBound(nameof(this.NextToken));
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
do
{
request.NextToken = _nextToken;
if (_emitLimit.HasValue)
{
int correctPageSize = Math.Min(100, _emitLimit.Value);
request.MaxResults = 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.ImageIds.Count;
_nextToken = response.NextToken;
_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.ECR.Model.ListImagesResponse CallAWSServiceOperation(IAmazonECR client, Amazon.ECR.Model.ListImagesRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon EC2 Container Registry", "ListImages");
try
{
#if DESKTOP
return client.ListImages(request);
#elif CORECLR
return client.ListImagesAsync(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 int? 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.ImageIds;
}
}
}