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.

Classes

NameDescription
Class AuthorizationData

An object representing authorization data for an Amazon ECR registry.

Class BatchCheckLayerAvailabilityRequest

Container for the parameters to the BatchCheckLayerAvailability operation. Check the availability of multiple image layers in a specified registry and repository.

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

Class BatchCheckLayerAvailabilityResponse

This is the response object from the BatchCheckLayerAvailability operation.

Class BatchDeleteImageRequest

Container for the parameters to the BatchDeleteImage operation. Deletes a list of specified images within a specified repository. Images are specified with either imageTag or imageDigest.

You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.

You can completely delete an image (and all of its tags) by specifying the image's digest in your request.

Class BatchDeleteImageResponse

This is the response object from the BatchDeleteImage operation.

Class BatchGetImageRequest

Container for the parameters to the BatchGetImage operation. Gets detailed information for specified images within a specified repository. Images are specified with either imageTag or imageDigest.

Class BatchGetImageResponse

This is the response object from the BatchGetImage operation.

Class CompleteLayerUploadRequest

Container for the parameters to the CompleteLayerUpload operation. Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has completed. You can optionally provide a sha256 digest of the image layer for data validation purposes.

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

Class CompleteLayerUploadResponse

This is the response object from the CompleteLayerUpload operation.

Class CreateRepositoryRequest

Container for the parameters to the CreateRepository operation. Creates an image repository.

Class CreateRepositoryResponse

This is the response object from the CreateRepository operation.

Class DeleteRepositoryPolicyRequest

Container for the parameters to the DeleteRepositoryPolicy operation. Deletes the repository policy from a specified repository.

Class DeleteRepositoryPolicyResponse

This is the response object from the DeleteRepositoryPolicy operation.

Class DeleteRepositoryRequest

Container for the parameters to the DeleteRepository operation. Deletes an existing image repository. If a repository contains images, you must use the force option to delete it.

Class DeleteRepositoryResponse

This is the response object from the DeleteRepository operation.

Class DescribeImagesFilter

An object representing a filter on a DescribeImages operation.

Class DescribeImagesRequest

Container for the parameters to the DescribeImages operation. Returns metadata about the images in a repository, including image size, image tags, and creation date.

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.

Class DescribeImagesResponse

This is the response object from the DescribeImages operation.

Class DescribeRepositoriesRequest

Container for the parameters to the DescribeRepositories operation. Describes image repositories in a registry.

Class DescribeRepositoriesResponse

This is the response object from the DescribeRepositories operation.

Class EmptyUploadException

ECR exception

Class GetAuthorizationTokenRequest

Container for the parameters to the GetAuthorizationToken operation. Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the docker CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed.

The authorizationToken returned for each registry specified is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an aws ecr get-login command that simplifies the login process.

Class GetAuthorizationTokenResponse

This is the response object from the GetAuthorizationToken operation.

Class GetDownloadUrlForLayerRequest

Container for the parameters to the GetDownloadUrlForLayer operation. Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.

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

Class GetDownloadUrlForLayerResponse

This is the response object from the GetDownloadUrlForLayer operation.

Class GetRepositoryPolicyRequest

Container for the parameters to the GetRepositoryPolicy operation. Retrieves the repository policy for a specified repository.

Class GetRepositoryPolicyResponse

This is the response object from the GetRepositoryPolicy operation.

Class Image

An object representing an Amazon ECR image.

Class ImageAlreadyExistsException

ECR exception

Class ImageDetail

An object that describes an image returned by a DescribeImages operation.

Class ImageFailure

An object representing an Amazon ECR image failure.

Class ImageIdentifier

An object with identifying information for an Amazon ECR image.

Class ImageNotFoundException

ECR exception

Class InitiateLayerUploadRequest

Container for the parameters to the InitiateLayerUpload operation. Notify Amazon ECR that you intend to upload an image layer.

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

Class InitiateLayerUploadResponse

This is the response object from the InitiateLayerUpload operation.

Class InvalidLayerException

ECR exception

Class InvalidLayerPartException

ECR exception

Class InvalidParameterException

ECR exception

Class Layer

An object representing an Amazon ECR image layer.

Class LayerAlreadyExistsException

ECR exception

Class LayerFailure

An object representing an Amazon ECR image layer failure.

Class LayerInaccessibleException

ECR exception

Class LayerPartTooSmallException

ECR exception

Class LayersNotFoundException

ECR exception

Class LimitExceededException

ECR exception

Class ListImagesFilter

An object representing a filter on a ListImages operation.

Class ListImagesRequest

Container for the parameters to the ListImages operation. Lists all the image IDs for a given repository.

You can filter images based on whether or not they are tagged by setting the tagStatus parameter to TAGGED or UNTAGGED. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.

Class ListImagesResponse

This is the response object from the ListImages operation.

Class PutImageRequest

Container for the parameters to the PutImage operation. Creates or updates the image manifest and tags associated with an image.

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

Class PutImageResponse

This is the response object from the PutImage operation.

Class Repository

An object representing a repository.

Class RepositoryAlreadyExistsException

ECR exception

Class RepositoryNotEmptyException

ECR exception

Class RepositoryNotFoundException

ECR exception

Class RepositoryPolicyNotFoundException

ECR exception

Class ServerException

ECR exception

Class SetRepositoryPolicyRequest

Container for the parameters to the SetRepositoryPolicy operation. Applies a repository policy on a specified repository to control access permissions.

Class SetRepositoryPolicyResponse

This is the response object from the SetRepositoryPolicy operation.

Class UploadLayerPartRequest

Container for the parameters to the UploadLayerPart operation. Uploads an image layer part to Amazon ECR.

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

Class UploadLayerPartResponse

This is the response object from the UploadLayerPart operation.

Class UploadNotFoundException

ECR exception