/* * 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.services.ecrpublic.model.*; /** * Interface for accessing Amazon ECR Public asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.ecrpublic.AbstractAmazonECRPublicAsync} 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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonECRPublicAsync extends AmazonECRPublic { /** ** 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.
*
* 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.
*
* 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 A Java Future containing the result of the BatchDeleteImage operation returned by the service. * @sample AmazonECRPublicAsync.BatchDeleteImage * @see AWS * API Documentation */ java.util.concurrent.Future
* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the BatchDeleteImage operation returned by the service. * @sample AmazonECRPublicAsyncHandler.BatchDeleteImage * @see AWS * API Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* 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 A Java Future containing the result of the CreateRepository operation returned by the service. * @sample AmazonECRPublicAsync.CreateRepository * @see AWS * API Documentation */ java.util.concurrent.Future* Creates a repository in a public registry. For more information, see Amazon ECR repositories in * the Amazon Elastic Container Registry User Guide. *
* * @param createRepositoryRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateRepository operation returned by the service. * @sample AmazonECRPublicAsyncHandler.CreateRepository * @see AWS * API Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* Deletes the repository policy that's associated with the specified repository. *
* * @param deleteRepositoryPolicyRequest * @return A Java Future containing the result of the DeleteRepositoryPolicy operation returned by the service. * @sample AmazonECRPublicAsync.DeleteRepositoryPolicy * @see AWS API Documentation */ java.util.concurrent.Future* Deletes the repository policy that's associated with the specified repository. *
* * @param deleteRepositoryPolicyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteRepositoryPolicy operation returned by the service. * @sample AmazonECRPublicAsyncHandler.DeleteRepositoryPolicy * @see AWS API Documentation */ java.util.concurrent.Future* Returns the image tag details for a repository in a public registry. *
* * @param describeImageTagsRequest * @return A Java Future containing the result of the DescribeImageTags operation returned by the service. * @sample AmazonECRPublicAsync.DescribeImageTags * @see AWS * API Documentation */ java.util.concurrent.Future* Returns the image tag details for a repository in a public registry. *
* * @param describeImageTagsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeImageTags operation returned by the service. * @sample AmazonECRPublicAsyncHandler.DescribeImageTags * @see AWS * API Documentation */ java.util.concurrent.Future* 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.
*
* 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.
*
* Returns details for a public registry. *
* * @param describeRegistriesRequest * @return A Java Future containing the result of the DescribeRegistries operation returned by the service. * @sample AmazonECRPublicAsync.DescribeRegistries * @see AWS * API Documentation */ java.util.concurrent.Future* Returns details for a public registry. *
* * @param describeRegistriesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeRegistries operation returned by the service. * @sample AmazonECRPublicAsyncHandler.DescribeRegistries * @see AWS * API Documentation */ java.util.concurrent.Future* Describes repositories that are in a public registry. *
* * @param describeRepositoriesRequest * @return A Java Future containing the result of the DescribeRepositories operation returned by the service. * @sample AmazonECRPublicAsync.DescribeRepositories * @see AWS API Documentation */ java.util.concurrent.Future* Describes repositories that are in a public registry. *
* * @param describeRepositoriesRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeRepositories operation returned by the service. * @sample AmazonECRPublicAsyncHandler.DescribeRepositories * @see AWS API Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* Retrieves catalog metadata for a public registry. *
* * @param getRegistryCatalogDataRequest * @return A Java Future containing the result of the GetRegistryCatalogData operation returned by the service. * @sample AmazonECRPublicAsync.GetRegistryCatalogData * @see AWS API Documentation */ java.util.concurrent.Future* Retrieves catalog metadata for a public registry. *
* * @param getRegistryCatalogDataRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetRegistryCatalogData operation returned by the service. * @sample AmazonECRPublicAsyncHandler.GetRegistryCatalogData * @see AWS API Documentation */ java.util.concurrent.Future* Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the * Amazon ECR Public Gallery. *
* * @param getRepositoryCatalogDataRequest * @return A Java Future containing the result of the GetRepositoryCatalogData operation returned by the service. * @sample AmazonECRPublicAsync.GetRepositoryCatalogData * @see AWS API Documentation */ java.util.concurrent.Future* Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the * Amazon ECR Public Gallery. *
* * @param getRepositoryCatalogDataRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetRepositoryCatalogData operation returned by the service. * @sample AmazonECRPublicAsyncHandler.GetRepositoryCatalogData * @see AWS API Documentation */ java.util.concurrent.Future* Retrieves the repository policy for the specified repository. *
* * @param getRepositoryPolicyRequest * @return A Java Future containing the result of the GetRepositoryPolicy operation returned by the service. * @sample AmazonECRPublicAsync.GetRepositoryPolicy * @see AWS * API Documentation */ java.util.concurrent.Future* Retrieves the repository policy for the specified repository. *
* * @param getRepositoryPolicyRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetRepositoryPolicy operation returned by the service. * @sample AmazonECRPublicAsyncHandler.GetRepositoryPolicy * @see AWS * API Documentation */ java.util.concurrent.Future* 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.
*
* 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.
*
* List the tags for an Amazon ECR Public resource. *
* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonECRPublicAsync.ListTagsForResource * @see AWS * API Documentation */ java.util.concurrent.Future* List the tags for an Amazon ECR Public resource. *
* * @param listTagsForResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonECRPublicAsyncHandler.ListTagsForResource * @see AWS * API Documentation */ java.util.concurrent.Future* 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.
*
* 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.
*
* Create or update the catalog data for a public registry. *
* * @param putRegistryCatalogDataRequest * @return A Java Future containing the result of the PutRegistryCatalogData operation returned by the service. * @sample AmazonECRPublicAsync.PutRegistryCatalogData * @see AWS API Documentation */ java.util.concurrent.Future* Create or update the catalog data for a public registry. *
* * @param putRegistryCatalogDataRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the PutRegistryCatalogData operation returned by the service. * @sample AmazonECRPublicAsyncHandler.PutRegistryCatalogData * @see AWS API Documentation */ java.util.concurrent.Future* Creates or updates the catalog data for a repository in a public registry. *
* * @param putRepositoryCatalogDataRequest * @return A Java Future containing the result of the PutRepositoryCatalogData operation returned by the service. * @sample AmazonECRPublicAsync.PutRepositoryCatalogData * @see AWS API Documentation */ java.util.concurrent.Future* Creates or updates the catalog data for a repository in a public registry. *
* * @param putRepositoryCatalogDataRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the PutRepositoryCatalogData operation returned by the service. * @sample AmazonECRPublicAsyncHandler.PutRepositoryCatalogData * @see AWS API Documentation */ java.util.concurrent.Future* 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 A Java Future containing the result of the SetRepositoryPolicy operation returned by the service. * @sample AmazonECRPublicAsync.SetRepositoryPolicy * @see AWS * API Documentation */ java.util.concurrent.Future* 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 * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the SetRepositoryPolicy operation returned by the service. * @sample AmazonECRPublicAsyncHandler.SetRepositoryPolicy * @see AWS * API Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* Deletes specified tags from a resource. *
* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonECRPublicAsync.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes specified tags from a resource. *
* * @param untagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonECRPublicAsyncHandler.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future* 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.
*
* 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.
*