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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeImages and EndDescribeImages.

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

Syntax

C#
public abstract Task<DescribeImagesResponse> DescribeImagesAsync(
         DescribeImagesRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ECR.Model.DescribeImagesRequest

Container for the necessary parameters to execute the DescribeImages service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DescribeImages service method, as returned by ECR.

Exceptions

ExceptionCondition
ImageNotFoundException The image requested does not exist in the specified repository.
InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
RepositoryNotFoundException The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.
ServerException These errors are usually caused by a server-side issue.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also