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.

Creates or updates the image manifest and tags associated with an image.

When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.

This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

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 BeginPutImage and EndPutImage.

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

Syntax

C#
public abstract Task<PutImageResponse> PutImageAsync(
         PutImageRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.ECR.Model.PutImageRequest

Container for the necessary parameters to execute the PutImage 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 PutImage service method, as returned by ECR.

Exceptions

ExceptionCondition
ImageAlreadyExistsException The specified image has already been pushed, and there were no changes to the manifest or image tag after the last push.
ImageDigestDoesNotMatchException The specified image digest does not match the digest that Amazon ECR calculated for the image.
ImageTagAlreadyExistsException The specified image is tagged with a tag that already exists. The repository is configured for tag immutability.
InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
KmsException The operation failed due to a KMS exception.
LayersNotFoundException The specified layers could not be found, or the specified layer is not valid for this repository.
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.
ReferencedImagesNotFoundException The manifest list is referencing an image that does not exist.
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