/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.ecrpublic; import javax.annotation.Generated; import com.amazonaws.*; import com.amazonaws.regions.*; import com.amazonaws.services.ecrpublic.model.*; /** * Interface for accessing Amazon ECR Public. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.ecrpublic.AbstractAmazonECRPublic} instead. *

*

* Amazon Elastic Container Registry Public *

* Amazon Elastic Container Registry Public (Amazon ECR Public) is a managed container image registry service. Amazon * ECR provides both public and private registries to host your container images. You can use the Docker CLI or your * preferred client to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for * your Docker or Open Container Initiative (OCI) images. Amazon ECR supports public repositories with this API. For * information about the Amazon ECR API for private repositories, see Amazon Elastic Container Registry API * Reference. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonECRPublic { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "api.ecr-public"; /** *

* Checks the availability of one or more image layers that are within a repository in a public registry. When an * image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has * been uploaded, then the image layer is skipped. *

* *

* 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. *

* * * @param batchCheckLayerAvailabilityRequest * @return Result of the BatchCheckLayerAvailability operation returned by the service. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws RegistryNotFoundException * The registry doesn't exist. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.BatchCheckLayerAvailability * @see AWS API Documentation */ BatchCheckLayerAvailabilityResult batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest); /** *

* Deletes a list of specified images that are within a repository in a public registry. Images are specified with * either an 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 digest of the image in your request. *

* * @param batchDeleteImageRequest * @return Result of the BatchDeleteImage operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.BatchDeleteImage * @see AWS * API Documentation */ BatchDeleteImageResult batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest); /** *

* Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and * upload ID. You can optionally provide a sha256 digest of the image layer for data validation * purposes. *

*

* When an image is pushed, the CompleteLayerUpload API is called once for each new image layer to verify that the * upload is complete. *

* *

* 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. *

* * * @param completeLayerUploadRequest * @return Result of the CompleteLayerUpload operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws UploadNotFoundException * The upload can't be found, or the specified upload ID isn't valid for this repository. * @throws InvalidLayerException * The layer digest calculation performed by Amazon ECR when the image layer doesn't match the digest * specified. * @throws LayerPartTooSmallException * Layer parts must be at least 5 MiB in size. * @throws LayerAlreadyExistsException * The image layer already exists in the associated repository. * @throws EmptyUploadException * The specified layer upload doesn't contain any layer parts. * @throws RegistryNotFoundException * The registry doesn't exist. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.CompleteLayerUpload * @see AWS * API Documentation */ CompleteLayerUploadResult completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest); /** *

* Creates a repository in a public registry. For more information, see Amazon ECR repositories in * the Amazon Elastic Container Registry User Guide. *

* * @param createRepositoryRequest * @return Result of the CreateRepository operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws InvalidTagParameterException * An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, * and tag values can have a maximum length of 256 characters. * @throws TooManyTagsException * The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a * repository is 50. * @throws RepositoryAlreadyExistsException * The specified repository already exists in the specified registry. * @throws LimitExceededException * The operation didn't 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. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.CreateRepository * @see AWS * API Documentation */ CreateRepositoryResult createRepository(CreateRepositoryRequest createRepositoryRequest); /** *

* Deletes a repository in a public registry. If the repository contains images, you must either manually delete all * images in the repository or use the force option. This option deletes all images on your behalf * before deleting the repository. *

* * @param deleteRepositoryRequest * @return Result of the DeleteRepository operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws RepositoryNotEmptyException * The specified repository contains images. To delete a repository that contains images, you must force the * deletion with the force parameter. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.DeleteRepository * @see AWS * API Documentation */ DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest); /** *

* Deletes the repository policy that's associated with the specified repository. *

* * @param deleteRepositoryPolicyRequest * @return Result of the DeleteRepositoryPolicy operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws RepositoryPolicyNotFoundException * The specified repository and registry combination doesn't have an associated repository policy. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.DeleteRepositoryPolicy * @see AWS API Documentation */ DeleteRepositoryPolicyResult deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest); /** *

* Returns the image tag details for a repository in a public registry. *

* * @param describeImageTagsRequest * @return Result of the DescribeImageTags operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.DescribeImageTags * @see AWS * API Documentation */ DescribeImageTagsResult describeImageTags(DescribeImageTagsRequest describeImageTagsRequest); /** *

* Returns metadata that's related to the images in a repository in a public registry. *

* *

* 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. Therefore, it * might return a larger image size than the image sizes that are returned by DescribeImages. *

* * * @param describeImagesRequest * @return Result of the DescribeImages operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws ImageNotFoundException * The image requested doesn't exist in the specified repository. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.DescribeImages * @see AWS API * Documentation */ DescribeImagesResult describeImages(DescribeImagesRequest describeImagesRequest); /** *

* Returns details for a public registry. *

* * @param describeRegistriesRequest * @return Result of the DescribeRegistries operation returned by the service. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @throws ServerException * These errors are usually caused by a server-side issue. * @sample AmazonECRPublic.DescribeRegistries * @see AWS * API Documentation */ DescribeRegistriesResult describeRegistries(DescribeRegistriesRequest describeRegistriesRequest); /** *

* Describes repositories that are in a public registry. *

* * @param describeRepositoriesRequest * @return Result of the DescribeRepositories operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.DescribeRepositories * @see AWS API Documentation */ DescribeRepositoriesResult describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest); /** *

* Retrieves an authorization token. An authorization token represents your IAM authentication credentials. You can * use it to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid * for 12 hours. This API requires the ecr-public:GetAuthorizationToken and * sts:GetServiceBearerToken permissions. *

* * @param getAuthorizationTokenRequest * @return Result of the GetAuthorizationToken operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.GetAuthorizationToken * @see AWS API Documentation */ GetAuthorizationTokenResult getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest); /** *

* Retrieves catalog metadata for a public registry. *

* * @param getRegistryCatalogDataRequest * @return Result of the GetRegistryCatalogData operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.GetRegistryCatalogData * @see AWS API Documentation */ GetRegistryCatalogDataResult getRegistryCatalogData(GetRegistryCatalogDataRequest getRegistryCatalogDataRequest); /** *

* Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the * Amazon ECR Public Gallery. *

* * @param getRepositoryCatalogDataRequest * @return Result of the GetRepositoryCatalogData operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws RepositoryCatalogDataNotFoundException * The repository catalog data doesn't exist. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.GetRepositoryCatalogData * @see AWS API Documentation */ GetRepositoryCatalogDataResult getRepositoryCatalogData(GetRepositoryCatalogDataRequest getRepositoryCatalogDataRequest); /** *

* Retrieves the repository policy for the specified repository. *

* * @param getRepositoryPolicyRequest * @return Result of the GetRepositoryPolicy operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws RepositoryPolicyNotFoundException * The specified repository and registry combination doesn't have an associated repository policy. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.GetRepositoryPolicy * @see AWS * API Documentation */ GetRepositoryPolicyResult getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest); /** *

* Notifies Amazon ECR that you intend to upload an image layer. *

*

* When an image is pushed, the InitiateLayerUpload API is called once for each image layer that hasn't already been * uploaded. Whether an image layer uploads is determined by the BatchCheckLayerAvailability API action. *

* *

* 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. *

* * * @param initiateLayerUploadRequest * @return Result of the InitiateLayerUpload operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws RegistryNotFoundException * The registry doesn't exist. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.InitiateLayerUpload * @see AWS * API Documentation */ InitiateLayerUploadResult initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest); /** *

* List the tags for an Amazon ECR Public resource. *

* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @throws ServerException * These errors are usually caused by a server-side issue. * @sample AmazonECRPublic.ListTagsForResource * @see AWS * API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* Creates or updates the image manifest and tags that are 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 that are 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. *

* * * @param putImageRequest * @return Result of the PutImage operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws ImageAlreadyExistsException * The specified image has already been pushed, and there were no changes to the manifest or image tag after * the last push. * @throws LayersNotFoundException * The specified layers can't be found, or the specified layer isn't valid for this repository. * @throws ReferencedImagesNotFoundException * The manifest list is referencing an image that doesn't exist. * @throws LimitExceededException * The operation didn't 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. * @throws ImageTagAlreadyExistsException * The specified image is tagged with a tag that already exists. The repository is configured for tag * immutability. * @throws ImageDigestDoesNotMatchException * The specified image digest doesn't match the digest that Amazon ECR calculated for the image. * @throws RegistryNotFoundException * The registry doesn't exist. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.PutImage * @see AWS API * Documentation */ PutImageResult putImage(PutImageRequest putImageRequest); /** *

* Create or update the catalog data for a public registry. *

* * @param putRegistryCatalogDataRequest * @return Result of the PutRegistryCatalogData operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.PutRegistryCatalogData * @see AWS API Documentation */ PutRegistryCatalogDataResult putRegistryCatalogData(PutRegistryCatalogDataRequest putRegistryCatalogDataRequest); /** *

* Creates or updates the catalog data for a repository in a public registry. *

* * @param putRepositoryCatalogDataRequest * @return Result of the PutRepositoryCatalogData operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.PutRepositoryCatalogData * @see AWS API Documentation */ PutRepositoryCatalogDataResult putRepositoryCatalogData(PutRepositoryCatalogDataRequest putRepositoryCatalogDataRequest); /** *

* Applies a repository policy to the specified public repository to control access permissions. For more * information, see Amazon * ECR Repository Policies in the Amazon Elastic Container Registry User Guide. *

* * @param setRepositoryPolicyRequest * @return Result of the SetRepositoryPolicy operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.SetRepositoryPolicy * @see AWS * API Documentation */ SetRepositoryPolicyResult setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest); /** *

* Associates the specified tags to a resource with the specified resourceArn. If existing tags on a * resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags * associated with that resource are also deleted. *

* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws InvalidTagParameterException * An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, * and tag values can have a maximum length of 256 characters. * @throws TooManyTagsException * The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a * repository is 50. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @throws ServerException * These errors are usually caused by a server-side issue. * @sample AmazonECRPublic.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** *

* Deletes specified tags from a resource. *

* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws InvalidTagParameterException * An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, * and tag values can have a maximum length of 256 characters. * @throws TooManyTagsException * The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a * repository is 50. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @throws ServerException * These errors are usually caused by a server-side issue. * @sample AmazonECRPublic.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** *

* Uploads an image layer part to Amazon ECR. *

*

* When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can * be 20971520 bytes (about 20MB). The UploadLayerPart API is called once for each new image layer part. *

* *

* 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. *

* * * @param uploadLayerPartRequest * @return Result of the UploadLayerPart operation returned by the service. * @throws ServerException * These errors are usually caused by a server-side issue. * @throws InvalidParameterException * The specified parameter is invalid. Review the available parameters for the API request. * @throws InvalidLayerPartException * The layer part size isn't valid, or the first byte specified isn't consecutive to the last byte of a * previous layer part upload. * @throws RepositoryNotFoundException * The specified repository can't be found. Check the spelling of the specified repository and ensure that * you're performing operations on the correct registry. * @throws UploadNotFoundException * The upload can't be found, or the specified upload ID isn't valid for this repository. * @throws LimitExceededException * The operation didn't 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. * @throws RegistryNotFoundException * The registry doesn't exist. * @throws UnsupportedCommandException * The action isn't supported in this Region. * @sample AmazonECRPublic.UploadLayerPart * @see AWS API * Documentation */ UploadLayerPartResult uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *

* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }