AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DescribeImages operation. Returns metadata about the images in a repository.

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, so it may return a larger image size than the image sizes returned by DescribeImages.

Inheritance Hierarchy

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

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

Syntax

C#
public class DescribeImagesRequest : AmazonECRRequest
         IAmazonWebServiceRequest

The DescribeImagesRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeImagesRequest()

Properties

NameTypeDescription
Public Property Filter Amazon.ECR.Model.DescribeImagesFilter

Gets and sets the property Filter.

The filter key and value with which to filter your DescribeImages results.

Public Property ImageIds System.Collections.Generic.List<Amazon.ECR.Model.ImageIdentifier>

Gets and sets the property ImageIds.

The list of image IDs for the requested repository.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

The maximum number of repository results 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. The remaining results of the initial request can be seen by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.

Public Property NextToken System.String

Gets and sets the property NextToken.

The nextToken value 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. This value is null when there are no more results to return. This option cannot be used when you specify images with imageIds.

Public Property 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 describe images. If you do not specify a registry, the default registry is assumed.

Public Property RepositoryName System.String

Gets and sets the property RepositoryName.

The repository that contains the images to describe.

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