ListImagesRequest Class | AWS SDK for .NET V3

Container for the parameters to the ListImages operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ECR.AmazonECRRequest
      Amazon.ECR.Model.ListImagesRequest

Namespace: Amazon.ECR.Model
Assembly: AWSSDK.ECR.dll
Version: 3.x.y.z

Syntax

public class ListImagesRequest : AmazonECRRequest
         IAmazonWebServiceRequest

The ListImagesRequest type exposes the following members

Constructors

	Name	Description
	ListImagesRequest()

Properties

Name	Type	Description
Filter	Amazon.ECR.Model.ListImagesFilter	Gets and sets the property Filter. The filter key and value with which to filter your `ListImages` results.
MaxResults	System.Int32	Gets and sets the property MaxResults. 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.
NextToken	System.String	Gets and sets the property 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.
RegistryId	System.String	Gets and sets the property 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.
RepositoryName	System.String	Gets and sets the property RepositoryName. The repository with image IDs to be listed.

Examples

This example lists all of the images in the repository named ubuntu in the default registry in the current account.

To list all images in a repository


var client = new AmazonECRClient();
var response = client.ListImages(new ListImagesRequest 
{
    RepositoryName = "ubuntu"
});

List<ImageIdentifier> imageIds = response.ImageIds;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5