AmazonECRClient.BatchGetImage Method (BatchGetImageRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to BatchGetImageAsync.

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

Syntax

public virtual BatchGetImageResponse BatchGetImage(
         BatchGetImageRequest request
)

Parameters

request: Type: Amazon.ECR.Model.BatchGetImageRequest

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

Return Value

Type: BatchGetImageResponse

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

Exceptions

Exception	Condition
InvalidParameterException	The specified parameter is invalid. Review the available parameters for the API request.
LimitExceededException	The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR service quotas in the Amazon Elastic Container Registry User Guide.
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.
UnableToGetUpstreamImageException	The image or images were unable to be pulled using the pull through cache rule. This is usually caused because of an issue with the Secrets Manager secret containing the credentials for the upstream registry.

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 Framework:
Supported in: 4.5, 4.0, 3.5

AmazonECRClient.BatchGetImage (BatchGetImageRequest)

Method