public interface AmazonECRAsync extends AmazonECR
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.
batchCheckLayerAvailability, batchDeleteImage, batchGetImage, completeLayerUpload, createRepository, deleteRepository, deleteRepositoryPolicy, describeRepositories, getAuthorizationToken, getCachedResponseMetadata, getDownloadUrlForLayer, getRepositoryPolicy, initiateLayerUpload, listImages, putImage, setEndpoint, setRegion, setRepositoryPolicy, shutdown, uploadLayerPart
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.
batchCheckLayerAvailabilityRequest
- Future<BatchCheckLayerAvailabilityResult> batchCheckLayerAvailabilityAsync(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest, AsyncHandler<BatchCheckLayerAvailabilityRequest,BatchCheckLayerAvailabilityResult> asyncHandler)
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.
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.Future<BatchDeleteImageResult> batchDeleteImageAsync(BatchDeleteImageRequest batchDeleteImageRequest)
Deletes a list of specified images within a specified repository. Images
are specified with either imageTag
or
imageDigest
.
batchDeleteImageRequest
- Deletes specified images within a specified repository. Images are
specified with either the imageTag
or
imageDigest
.Future<BatchDeleteImageResult> batchDeleteImageAsync(BatchDeleteImageRequest batchDeleteImageRequest, AsyncHandler<BatchDeleteImageRequest,BatchDeleteImageResult> asyncHandler)
Deletes a list of specified images within a specified repository. Images
are specified with either imageTag
or
imageDigest
.
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.Future<BatchGetImageResult> batchGetImageAsync(BatchGetImageRequest batchGetImageRequest)
Gets detailed information for specified images within a specified
repository. Images are specified with either imageTag
or
imageDigest
.
batchGetImageRequest
- 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
.
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.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.
completeLayerUploadRequest
- Future<CompleteLayerUploadResult> completeLayerUploadAsync(CompleteLayerUploadRequest completeLayerUploadRequest, AsyncHandler<CompleteLayerUploadRequest,CompleteLayerUploadResult> asyncHandler)
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.
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.Future<CreateRepositoryResult> createRepositoryAsync(CreateRepositoryRequest createRepositoryRequest)
Creates an image repository.
createRepositoryRequest
- Future<CreateRepositoryResult> createRepositoryAsync(CreateRepositoryRequest createRepositoryRequest, AsyncHandler<CreateRepositoryRequest,CreateRepositoryResult> asyncHandler)
Creates an image repository.
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.Future<DeleteRepositoryResult> deleteRepositoryAsync(DeleteRepositoryRequest deleteRepositoryRequest)
Deletes an existing image repository. If a repository contains images,
you must use the force
option to delete it.
deleteRepositoryRequest
- Future<DeleteRepositoryResult> deleteRepositoryAsync(DeleteRepositoryRequest deleteRepositoryRequest, AsyncHandler<DeleteRepositoryRequest,DeleteRepositoryResult> asyncHandler)
Deletes an existing image repository. If a repository contains images,
you must use the force
option to delete it.
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.Future<DeleteRepositoryPolicyResult> deleteRepositoryPolicyAsync(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest)
Deletes the repository policy from a specified repository.
deleteRepositoryPolicyRequest
- Future<DeleteRepositoryPolicyResult> deleteRepositoryPolicyAsync(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest, AsyncHandler<DeleteRepositoryPolicyRequest,DeleteRepositoryPolicyResult> asyncHandler)
Deletes the repository policy from a specified repository.
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.Future<DescribeRepositoriesResult> describeRepositoriesAsync(DescribeRepositoriesRequest describeRepositoriesRequest)
Describes image repositories in a registry.
describeRepositoriesRequest
- Future<DescribeRepositoriesResult> describeRepositoriesAsync(DescribeRepositoriesRequest describeRepositoriesRequest, AsyncHandler<DescribeRepositoriesRequest,DescribeRepositoriesResult> asyncHandler)
Describes image repositories in a registry.
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.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.
getAuthorizationTokenRequest
- Future<GetAuthorizationTokenResult> getAuthorizationTokenAsync(GetAuthorizationTokenRequest getAuthorizationTokenRequest, AsyncHandler<GetAuthorizationTokenRequest,GetAuthorizationTokenResult> asyncHandler)
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.
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.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.
getDownloadUrlForLayerRequest
- Future<GetDownloadUrlForLayerResult> getDownloadUrlForLayerAsync(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest, AsyncHandler<GetDownloadUrlForLayerRequest,GetDownloadUrlForLayerResult> asyncHandler)
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.
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.Future<GetRepositoryPolicyResult> getRepositoryPolicyAsync(GetRepositoryPolicyRequest getRepositoryPolicyRequest)
Retrieves the repository policy for a specified repository.
getRepositoryPolicyRequest
- Future<GetRepositoryPolicyResult> getRepositoryPolicyAsync(GetRepositoryPolicyRequest getRepositoryPolicyRequest, AsyncHandler<GetRepositoryPolicyRequest,GetRepositoryPolicyResult> asyncHandler)
Retrieves the repository policy for a specified repository.
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.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.
initiateLayerUploadRequest
- Future<InitiateLayerUploadResult> initiateLayerUploadAsync(InitiateLayerUploadRequest initiateLayerUploadRequest, AsyncHandler<InitiateLayerUploadRequest,InitiateLayerUploadResult> asyncHandler)
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.
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.Future<ListImagesResult> listImagesAsync(ListImagesRequest listImagesRequest)
Lists all the image IDs for a given repository.
listImagesRequest
- Future<ListImagesResult> listImagesAsync(ListImagesRequest listImagesRequest, AsyncHandler<ListImagesRequest,ListImagesResult> asyncHandler)
Lists all the image IDs for a given repository.
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.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.
putImageRequest
- 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.
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.Future<SetRepositoryPolicyResult> setRepositoryPolicyAsync(SetRepositoryPolicyRequest setRepositoryPolicyRequest)
Applies a repository policy on a specified repository to control access permissions.
setRepositoryPolicyRequest
- Future<SetRepositoryPolicyResult> setRepositoryPolicyAsync(SetRepositoryPolicyRequest setRepositoryPolicyRequest, AsyncHandler<SetRepositoryPolicyRequest,SetRepositoryPolicyResult> asyncHandler)
Applies a repository policy on a specified repository to control access permissions.
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.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.
uploadLayerPartRequest
- Future<UploadLayerPartResult> uploadLayerPartAsync(UploadLayerPartRequest uploadLayerPartRequest, AsyncHandler<UploadLayerPartRequest,UploadLayerPartResult> asyncHandler)
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.
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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.