@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonECRPublic
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonECRPublic
instead.
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
BatchCheckLayerAvailabilityResult |
batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest)
Checks the availability of one or more image layers that are within a repository in a public registry.
|
BatchDeleteImageResult |
batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest)
Deletes a list of specified images that are within a repository in a public registry.
|
CompleteLayerUploadResult |
completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest)
Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and
upload ID.
|
CreateRepositoryResult |
createRepository(CreateRepositoryRequest createRepositoryRequest)
Creates a repository in a public registry.
|
DeleteRepositoryResult |
deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)
Deletes a repository in a public registry.
|
DeleteRepositoryPolicyResult |
deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest)
Deletes the repository policy that's associated with the specified repository.
|
DescribeImagesResult |
describeImages(DescribeImagesRequest describeImagesRequest)
Returns metadata that's related to the images in a repository in a public registry.
|
DescribeImageTagsResult |
describeImageTags(DescribeImageTagsRequest describeImageTagsRequest)
Returns the image tag details for a repository in a public registry.
|
DescribeRegistriesResult |
describeRegistries(DescribeRegistriesRequest describeRegistriesRequest)
Returns details for a public registry.
|
DescribeRepositoriesResult |
describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest)
Describes repositories that are in a public registry.
|
GetAuthorizationTokenResult |
getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest)
Retrieves an authorization token.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetRegistryCatalogDataResult |
getRegistryCatalogData(GetRegistryCatalogDataRequest getRegistryCatalogDataRequest)
Retrieves catalog metadata for a public registry.
|
GetRepositoryCatalogDataResult |
getRepositoryCatalogData(GetRepositoryCatalogDataRequest getRepositoryCatalogDataRequest)
Retrieve catalog metadata for a repository in a public registry.
|
GetRepositoryPolicyResult |
getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest)
Retrieves the repository policy for the specified repository.
|
InitiateLayerUploadResult |
initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest)
Notifies Amazon ECR that you intend to upload an image layer.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for an Amazon ECR Public resource.
|
PutImageResult |
putImage(PutImageRequest putImageRequest)
Creates or updates the image manifest and tags that are associated with an image.
|
PutRegistryCatalogDataResult |
putRegistryCatalogData(PutRegistryCatalogDataRequest putRegistryCatalogDataRequest)
Create or update the catalog data for a public registry.
|
PutRepositoryCatalogDataResult |
putRepositoryCatalogData(PutRepositoryCatalogDataRequest putRepositoryCatalogDataRequest)
Creates or updates the catalog data for a repository in a public registry.
|
SetRepositoryPolicyResult |
setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest)
Applies a repository policy to the specified public repository to control access permissions.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Associates the specified tags to a resource with the specified
resourceArn . |
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes specified tags from a resource.
|
UploadLayerPartResult |
uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest)
Uploads an image layer part to Amazon ECR.
|
static final String ENDPOINT_PREFIX
BatchCheckLayerAvailabilityResult batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest)
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.
batchCheckLayerAvailabilityRequest
- 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.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.ServerException
- These errors are usually caused by a server-side issue.RegistryNotFoundException
- The registry doesn't exist.UnsupportedCommandException
- The action isn't supported in this Region.BatchDeleteImageResult batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest)
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.
batchDeleteImageRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.UnsupportedCommandException
- The action isn't supported in this Region.CompleteLayerUploadResult completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest)
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.
completeLayerUploadRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.UploadNotFoundException
- The upload can't be found, or the specified upload ID isn't valid for this repository.InvalidLayerException
- The layer digest calculation performed by Amazon ECR when the image layer doesn't match the digest
specified.LayerPartTooSmallException
- Layer parts must be at least 5 MiB in size.LayerAlreadyExistsException
- The image layer already exists in the associated repository.EmptyUploadException
- The specified layer upload doesn't contain any layer parts.RegistryNotFoundException
- The registry doesn't exist.UnsupportedCommandException
- The action isn't supported in this Region.CreateRepositoryResult createRepository(CreateRepositoryRequest createRepositoryRequest)
Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
createRepositoryRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.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.RepositoryAlreadyExistsException
- The specified repository already exists in the specified registry.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.UnsupportedCommandException
- The action isn't supported in this Region.DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)
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.
deleteRepositoryRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.RepositoryNotEmptyException
- The specified repository contains images. To delete a repository that contains images, you must force the
deletion with the force
parameter.UnsupportedCommandException
- The action isn't supported in this Region.DeleteRepositoryPolicyResult deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest)
Deletes the repository policy that's associated with the specified repository.
deleteRepositoryPolicyRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.RepositoryPolicyNotFoundException
- The specified repository and registry combination doesn't have an associated repository policy.UnsupportedCommandException
- The action isn't supported in this Region.DescribeImageTagsResult describeImageTags(DescribeImageTagsRequest describeImageTagsRequest)
Returns the image tag details for a repository in a public registry.
describeImageTagsRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.UnsupportedCommandException
- The action isn't supported in this Region.DescribeImagesResult describeImages(DescribeImagesRequest describeImagesRequest)
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.
describeImagesRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.ImageNotFoundException
- The image requested doesn't exist in the specified repository.UnsupportedCommandException
- The action isn't supported in this Region.DescribeRegistriesResult describeRegistries(DescribeRegistriesRequest describeRegistriesRequest)
Returns details for a public registry.
describeRegistriesRequest
- InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.UnsupportedCommandException
- The action isn't supported in this Region.ServerException
- These errors are usually caused by a server-side issue.DescribeRepositoriesResult describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest)
Describes repositories that are in a public registry.
describeRepositoriesRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.UnsupportedCommandException
- The action isn't supported in this Region.GetAuthorizationTokenResult getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest)
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.
getAuthorizationTokenRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.UnsupportedCommandException
- The action isn't supported in this Region.GetRegistryCatalogDataResult getRegistryCatalogData(GetRegistryCatalogDataRequest getRegistryCatalogDataRequest)
Retrieves catalog metadata for a public registry.
getRegistryCatalogDataRequest
- ServerException
- These errors are usually caused by a server-side issue.UnsupportedCommandException
- The action isn't supported in this Region.GetRepositoryCatalogDataResult getRepositoryCatalogData(GetRepositoryCatalogDataRequest getRepositoryCatalogDataRequest)
Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.
getRepositoryCatalogDataRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.RepositoryCatalogDataNotFoundException
- The repository catalog data doesn't exist.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.UnsupportedCommandException
- The action isn't supported in this Region.GetRepositoryPolicyResult getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest)
Retrieves the repository policy for the specified repository.
getRepositoryPolicyRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.RepositoryPolicyNotFoundException
- The specified repository and registry combination doesn't have an associated repository policy.UnsupportedCommandException
- The action isn't supported in this Region.InitiateLayerUploadResult initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest)
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.
initiateLayerUploadRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.RegistryNotFoundException
- The registry doesn't exist.UnsupportedCommandException
- The action isn't supported in this Region.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for an Amazon ECR Public resource.
listTagsForResourceRequest
- InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.UnsupportedCommandException
- The action isn't supported in this Region.ServerException
- These errors are usually caused by a server-side issue.PutImageResult putImage(PutImageRequest putImageRequest)
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.
putImageRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.ImageAlreadyExistsException
- The specified image has already been pushed, and there were no changes to the manifest or image tag after
the last push.LayersNotFoundException
- The specified layers can't be found, or the specified layer isn't valid for this repository.ReferencedImagesNotFoundException
- The manifest list is referencing an image that doesn't exist.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.ImageTagAlreadyExistsException
- The specified image is tagged with a tag that already exists. The repository is configured for tag
immutability.ImageDigestDoesNotMatchException
- The specified image digest doesn't match the digest that Amazon ECR calculated for the image.RegistryNotFoundException
- The registry doesn't exist.UnsupportedCommandException
- The action isn't supported in this Region.PutRegistryCatalogDataResult putRegistryCatalogData(PutRegistryCatalogDataRequest putRegistryCatalogDataRequest)
Create or update the catalog data for a public registry.
putRegistryCatalogDataRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.UnsupportedCommandException
- The action isn't supported in this Region.PutRepositoryCatalogDataResult putRepositoryCatalogData(PutRepositoryCatalogDataRequest putRepositoryCatalogDataRequest)
Creates or updates the catalog data for a repository in a public registry.
putRepositoryCatalogDataRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.UnsupportedCommandException
- The action isn't supported in this Region.SetRepositoryPolicyResult setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest)
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.
setRepositoryPolicyRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.UnsupportedCommandException
- The action isn't supported in this Region.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest
- InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.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.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.UnsupportedCommandException
- The action isn't supported in this Region.ServerException
- These errors are usually caused by a server-side issue.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Deletes specified tags from a resource.
untagResourceRequest
- InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.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.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.UnsupportedCommandException
- The action isn't supported in this Region.ServerException
- These errors are usually caused by a server-side issue.UploadLayerPartResult uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest)
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.
uploadLayerPartRequest
- ServerException
- These errors are usually caused by a server-side issue.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.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.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.UploadNotFoundException
- The upload can't be found, or the specified upload ID isn't valid for this repository.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.RegistryNotFoundException
- The registry doesn't exist.UnsupportedCommandException
- The action isn't supported in this Region.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.