Interface AmazonECRAsync

All Superinterfaces:
AmazonECR
All Known Implementing Classes:
AbstractAmazonECRAsync, AmazonECRAsyncClient

public interface AmazonECRAsync extends AmazonECR
Interface for accessing Amazon ECR asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Amazon EC2 Container Registry (Amazon ECR) is a managed AWS Docker registry service. Customers can use the familiar Docker CLI to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry. Amazon ECR supports private Docker repositories with resource-based permissions using AWS IAM so that specific users or Amazon EC2 instances can access repositories and images. Developers can use the Docker CLI to author and manage images.

  • Method Details

    • batchCheckLayerAvailabilityAsync

      Future<BatchCheckLayerAvailabilityResult> batchCheckLayerAvailabilityAsync(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest)

      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. Use the docker CLI to pull, tag, and push images.

      Parameters:
      batchCheckLayerAvailabilityRequest -
      Returns:
      A Java Future containing the result of the BatchCheckLayerAvailability operation returned by the service.
    • batchCheckLayerAvailabilityAsync

      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. Use the docker CLI to pull, tag, and push images.

      Parameters:
      batchCheckLayerAvailabilityRequest -
      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.
      Returns:
      A Java Future containing the result of the BatchCheckLayerAvailability operation returned by the service.
    • batchDeleteImageAsync

      Future<BatchDeleteImageResult> batchDeleteImageAsync(BatchDeleteImageRequest batchDeleteImageRequest)

      Deletes a list of specified images within a specified repository. Images are specified with either imageTag or imageDigest.

      Parameters:
      batchDeleteImageRequest - Deletes specified images within a specified repository. Images are specified with either the imageTag or imageDigest.
      Returns:
      A Java Future containing the result of the BatchDeleteImage operation returned by the service.
    • batchDeleteImageAsync

      Deletes a list of specified images within a specified repository. Images are specified with either imageTag or imageDigest.

      Parameters:
      batchDeleteImageRequest - Deletes specified images within a specified repository. Images are specified with either the imageTag or imageDigest.
      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.
      Returns:
      A Java Future containing the result of the BatchDeleteImage operation returned by the service.
    • batchGetImageAsync

      Future<BatchGetImageResult> batchGetImageAsync(BatchGetImageRequest batchGetImageRequest)

      Gets detailed information for specified images within a specified repository. Images are specified with either imageTag or imageDigest.

      Parameters:
      batchGetImageRequest -
      Returns:
      A Java Future containing the result of the BatchGetImage operation returned by the service.
    • batchGetImageAsync

      Future<BatchGetImageResult> batchGetImageAsync(BatchGetImageRequest batchGetImageRequest, AsyncHandler<BatchGetImageRequest,BatchGetImageResult> asyncHandler)

      Gets detailed information for specified images within a specified repository. Images are specified with either imageTag or imageDigest.

      Parameters:
      batchGetImageRequest -
      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.
      Returns:
      A Java Future containing the result of the BatchGetImage operation returned by the service.
    • completeLayerUploadAsync

      Future<CompleteLayerUploadResult> completeLayerUploadAsync(CompleteLayerUploadRequest completeLayerUploadRequest)

      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. Use the docker CLI to pull, tag, and push images.

      Parameters:
      completeLayerUploadRequest -
      Returns:
      A Java Future containing the result of the CompleteLayerUpload operation returned by the service.
    • completeLayerUploadAsync

      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. Use the docker CLI to pull, tag, and push images.

      Parameters:
      completeLayerUploadRequest -
      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.
      Returns:
      A Java Future containing the result of the CompleteLayerUpload operation returned by the service.
    • createRepositoryAsync

      Future<CreateRepositoryResult> createRepositoryAsync(CreateRepositoryRequest createRepositoryRequest)

      Creates an image repository.

      Parameters:
      createRepositoryRequest -
      Returns:
      A Java Future containing the result of the CreateRepository operation returned by the service.
    • createRepositoryAsync

      Creates an image repository.

      Parameters:
      createRepositoryRequest -
      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.
      Returns:
      A Java Future containing the result of the CreateRepository operation returned by the service.
    • deleteRepositoryAsync

      Future<DeleteRepositoryResult> deleteRepositoryAsync(DeleteRepositoryRequest deleteRepositoryRequest)

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

      Parameters:
      deleteRepositoryRequest -
      Returns:
      A Java Future containing the result of the DeleteRepository operation returned by the service.
    • deleteRepositoryAsync

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

      Parameters:
      deleteRepositoryRequest -
      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.
      Returns:
      A Java Future containing the result of the DeleteRepository operation returned by the service.
    • deleteRepositoryPolicyAsync

      Future<DeleteRepositoryPolicyResult> deleteRepositoryPolicyAsync(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest)

      Deletes the repository policy from a specified repository.

      Parameters:
      deleteRepositoryPolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteRepositoryPolicy operation returned by the service.
    • deleteRepositoryPolicyAsync

      Deletes the repository policy from a specified repository.

      Parameters:
      deleteRepositoryPolicyRequest -
      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.
      Returns:
      A Java Future containing the result of the DeleteRepositoryPolicy operation returned by the service.
    • describeRepositoriesAsync

      Future<DescribeRepositoriesResult> describeRepositoriesAsync(DescribeRepositoriesRequest describeRepositoriesRequest)

      Describes image repositories in a registry.

      Parameters:
      describeRepositoriesRequest -
      Returns:
      A Java Future containing the result of the DescribeRepositories operation returned by the service.
    • describeRepositoriesAsync

      Describes image repositories in a registry.

      Parameters:
      describeRepositoriesRequest -
      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.
      Returns:
      A Java Future containing the result of the DescribeRepositories operation returned by the service.
    • getAuthorizationTokenAsync

      Future<GetAuthorizationTokenResult> getAuthorizationTokenAsync(GetAuthorizationTokenRequest getAuthorizationTokenRequest)

      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.

      Parameters:
      getAuthorizationTokenRequest -
      Returns:
      A Java Future containing the result of the GetAuthorizationToken operation returned by the service.
    • getAuthorizationTokenAsync

      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.

      Parameters:
      getAuthorizationTokenRequest -
      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.
      Returns:
      A Java Future containing the result of the GetAuthorizationToken operation returned by the service.
    • getDownloadUrlForLayerAsync

      Future<GetDownloadUrlForLayerResult> getDownloadUrlForLayerAsync(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest)

      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. Use the docker CLI to pull, tag, and push images.

      Parameters:
      getDownloadUrlForLayerRequest -
      Returns:
      A Java Future containing the result of the GetDownloadUrlForLayer operation returned by the service.
    • getDownloadUrlForLayerAsync

      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. Use the docker CLI to pull, tag, and push images.

      Parameters:
      getDownloadUrlForLayerRequest -
      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.
      Returns:
      A Java Future containing the result of the GetDownloadUrlForLayer operation returned by the service.
    • getRepositoryPolicyAsync

      Future<GetRepositoryPolicyResult> getRepositoryPolicyAsync(GetRepositoryPolicyRequest getRepositoryPolicyRequest)

      Retrieves the repository policy for a specified repository.

      Parameters:
      getRepositoryPolicyRequest -
      Returns:
      A Java Future containing the result of the GetRepositoryPolicy operation returned by the service.
    • getRepositoryPolicyAsync

      Retrieves the repository policy for a specified repository.

      Parameters:
      getRepositoryPolicyRequest -
      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.
      Returns:
      A Java Future containing the result of the GetRepositoryPolicy operation returned by the service.
    • initiateLayerUploadAsync

      Future<InitiateLayerUploadResult> initiateLayerUploadAsync(InitiateLayerUploadRequest initiateLayerUploadRequest)

      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. Use the docker CLI to pull, tag, and push images.

      Parameters:
      initiateLayerUploadRequest -
      Returns:
      A Java Future containing the result of the InitiateLayerUpload operation returned by the service.
    • initiateLayerUploadAsync

      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. Use the docker CLI to pull, tag, and push images.

      Parameters:
      initiateLayerUploadRequest -
      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.
      Returns:
      A Java Future containing the result of the InitiateLayerUpload operation returned by the service.
    • listImagesAsync

      Future<ListImagesResult> listImagesAsync(ListImagesRequest listImagesRequest)

      Lists all the image IDs for a given repository.

      Parameters:
      listImagesRequest -
      Returns:
      A Java Future containing the result of the ListImages operation returned by the service.
    • listImagesAsync

      Future<ListImagesResult> listImagesAsync(ListImagesRequest listImagesRequest, AsyncHandler<ListImagesRequest,ListImagesResult> asyncHandler)

      Lists all the image IDs for a given repository.

      Parameters:
      listImagesRequest -
      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.
      Returns:
      A Java Future containing the result of the ListImages operation returned by the service.
    • putImageAsync

      Future<PutImageResult> putImageAsync(PutImageRequest putImageRequest)

      Creates or updates the image manifest associated with an image.

      This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the docker CLI to pull, tag, and push images.

      Parameters:
      putImageRequest -
      Returns:
      A Java Future containing the result of the PutImage operation returned by the service.
    • putImageAsync

      Future<PutImageResult> putImageAsync(PutImageRequest putImageRequest, AsyncHandler<PutImageRequest,PutImageResult> asyncHandler)

      Creates or updates the image manifest associated with an image.

      This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers. Use the docker CLI to pull, tag, and push images.

      Parameters:
      putImageRequest -
      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.
      Returns:
      A Java Future containing the result of the PutImage operation returned by the service.
    • setRepositoryPolicyAsync

      Future<SetRepositoryPolicyResult> setRepositoryPolicyAsync(SetRepositoryPolicyRequest setRepositoryPolicyRequest)

      Applies a repository policy on a specified repository to control access permissions.

      Parameters:
      setRepositoryPolicyRequest -
      Returns:
      A Java Future containing the result of the SetRepositoryPolicy operation returned by the service.
    • setRepositoryPolicyAsync

      Applies a repository policy on a specified repository to control access permissions.

      Parameters:
      setRepositoryPolicyRequest -
      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.
      Returns:
      A Java Future containing the result of the SetRepositoryPolicy operation returned by the service.
    • uploadLayerPartAsync

      Future<UploadLayerPartResult> uploadLayerPartAsync(UploadLayerPartRequest uploadLayerPartRequest)

      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. Use the docker CLI to pull, tag, and push images.

      Parameters:
      uploadLayerPartRequest -
      Returns:
      A Java Future containing the result of the UploadLayerPart operation returned by the service.
    • uploadLayerPartAsync

      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. Use the docker CLI to pull, tag, and push images.

      Parameters:
      uploadLayerPartRequest -
      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.
      Returns:
      A Java Future containing the result of the UploadLayerPart operation returned by the service.