BatchGetImageRequest Class | AWS SDK for .NET V3

Container for the parameters to the BatchGetImage operation. Gets detailed information for an image. Images are specified with either an imageTag or imageDigest.

When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.

Inheritance Hierarchy

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

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

Syntax

public class BatchGetImageRequest : AmazonECRRequest
         IAmazonWebServiceRequest

The BatchGetImageRequest type exposes the following members

Constructors

	Name	Description
	BatchGetImageRequest()

Properties

Name	Type	Description
AcceptedMediaTypes	System.Collections.Generic.List<System.String>	Gets and sets the property AcceptedMediaTypes. The accepted media types for the request. Valid values: `application/vnd.docker.distribution.manifest.v1+json` \| `application/vnd.docker.distribution.manifest.v2+json` \| `application/vnd.oci.image.manifest.v1+json`
ImageIds	System.Collections.Generic.List<Amazon.ECR.Model.ImageIdentifier>	Gets and sets the property ImageIds. A list of image ID references that correspond to images to describe. The format of the `imageIds` reference is `imageTag=tag` or `imageDigest=digest`.
RegistryId	System.String	Gets and sets the property RegistryId. The Amazon Web Services account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.
RepositoryName	System.String	Gets and sets the property RepositoryName. The repository that contains the images to describe.

Examples

This example obtains information for an image with a specified image digest ID from the repository named ubuntu in the current account.

To obtain multiple images in a single request


var client = new AmazonECRClient();
var response = client.BatchGetImage(new BatchGetImageRequest 
{
    ImageIds = new List<ImageIdentifier> {
        new ImageIdentifier { ImageTag = "precise" }
    },
    RepositoryName = "ubuntu"
});

List<ImageFailure> failures = response.Failures;
List<Image> images = response.Images;

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