AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface ECRAsyncClient extends AutoCloseable
builder()
method.
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.
Modifier and Type | Method | Description |
---|---|---|
default CompletableFuture<BatchCheckLayerAvailabilityResponse> |
batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) |
Check the availability of multiple image layers in a specified registry and repository.
|
default CompletableFuture<BatchDeleteImageResponse> |
batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest) |
Deletes a list of specified images within a specified repository.
|
default CompletableFuture<BatchGetImageResponse> |
batchGetImage(BatchGetImageRequest batchGetImageRequest) |
Gets detailed information for specified images within a specified repository.
|
static ECRAsyncClientBuilder |
builder() |
Create a builder that can be used to configure and create a
ECRAsyncClient . |
default CompletableFuture<CompleteLayerUploadResponse> |
completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest) |
Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has
completed.
|
static ECRAsyncClient |
create() |
Create a
ECRAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateRepositoryResponse> |
createRepository(CreateRepositoryRequest createRepositoryRequest) |
Creates an image repository.
|
default CompletableFuture<DeleteRepositoryResponse> |
deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) |
Deletes an existing image repository.
|
default CompletableFuture<DeleteRepositoryPolicyResponse> |
deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) |
Deletes the repository policy from a specified repository.
|
default CompletableFuture<DescribeImagesResponse> |
describeImages(DescribeImagesRequest describeImagesRequest) |
Returns metadata about the images in a repository, including image size, image tags, and creation date.
|
default CompletableFuture<DescribeRepositoriesResponse> |
describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest) |
Describes image repositories in a registry.
|
default CompletableFuture<GetAuthorizationTokenResponse> |
getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest) |
Retrieves a token that is valid for a specified registry for 12 hours.
|
default CompletableFuture<GetDownloadUrlForLayerResponse> |
getDownloadUrlForLayer(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest) |
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.
|
default CompletableFuture<GetRepositoryPolicyResponse> |
getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest) |
Retrieves the repository policy for a specified repository.
|
default CompletableFuture<InitiateLayerUploadResponse> |
initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest) |
Notify Amazon ECR that you intend to upload an image layer.
|
default CompletableFuture<ListImagesResponse> |
listImages(ListImagesRequest listImagesRequest) |
Lists all the image IDs for a given repository.
|
default CompletableFuture<PutImageResponse> |
putImage(PutImageRequest putImageRequest) |
Creates or updates the image manifest and tags associated with an image.
|
default CompletableFuture<SetRepositoryPolicyResponse> |
setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest) |
Applies a repository policy on a specified repository to control access permissions.
|
default CompletableFuture<UploadLayerPartResponse> |
uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest) |
Uploads an image layer part to Amazon ECR.
|
close
static ECRAsyncClient create()
ECRAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ECRAsyncClientBuilder builder()
ECRAsyncClient
.default CompletableFuture<BatchCheckLayerAvailabilityResponse> batchCheckLayerAvailability(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 for pulling
and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
batchCheckLayerAvailabilityRequest
- default CompletableFuture<BatchDeleteImageResponse> batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest)
Deletes a list of specified images within a specified repository. Images are specified with either
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 image's digest in your request.
batchDeleteImageRequest
- Deletes specified images within a specified repository. Images are specified with either the
imageTag
or imageDigest
.default CompletableFuture<BatchGetImageResponse> batchGetImage(BatchGetImageRequest batchGetImageRequest)
Gets detailed information for specified images within a specified repository. Images are specified with either
imageTag
or imageDigest
.
batchGetImageRequest
- default CompletableFuture<CompleteLayerUploadResponse> completeLayerUpload(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 for pulling
and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
completeLayerUploadRequest
- default CompletableFuture<CreateRepositoryResponse> createRepository(CreateRepositoryRequest createRepositoryRequest)
Creates an image repository.
createRepositoryRequest
- default CompletableFuture<DeleteRepositoryResponse> deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)
Deletes an existing image repository. If a repository contains images, you must use the force
option
to delete it.
deleteRepositoryRequest
- force
parameter.default CompletableFuture<DeleteRepositoryPolicyResponse> deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest)
Deletes the repository policy from a specified repository.
deleteRepositoryPolicyRequest
- default CompletableFuture<DescribeImagesResponse> describeImages(DescribeImagesRequest describeImagesRequest)
Returns metadata about the images in a repository, including image size, image tags, and creation date.
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, so it may
return a larger image size than the image sizes returned by DescribeImages.
describeImagesRequest
- default CompletableFuture<DescribeRepositoriesResponse> describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest)
Describes image repositories in a registry.
describeRepositoriesRequest
- default CompletableFuture<GetAuthorizationTokenResponse> getAuthorizationToken(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
- default CompletableFuture<GetDownloadUrlForLayerResponse> getDownloadUrlForLayer(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 for pulling
and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
getDownloadUrlForLayerRequest
- default CompletableFuture<GetRepositoryPolicyResponse> getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest)
Retrieves the repository policy for a specified repository.
getRepositoryPolicyRequest
- default CompletableFuture<InitiateLayerUploadResponse> initiateLayerUpload(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 for pulling
and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
initiateLayerUploadRequest
- default CompletableFuture<ListImagesResponse> listImages(ListImagesRequest listImagesRequest)
Lists all the image IDs for a given repository.
You can filter images based on whether or not they are tagged by setting the tagStatus
parameter to
TAGGED
or UNTAGGED
. For example, you can filter your results to return only
UNTAGGED
images and then pipe that result to a BatchDeleteImage operation to delete them. Or,
you can filter your results to return only TAGGED
images to list all of the tags in your repository.
listImagesRequest
- default CompletableFuture<PutImageResponse> putImage(PutImageRequest putImageRequest)
Creates or updates the image manifest and tags associated with an image.
This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling
and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
putImageRequest
- default CompletableFuture<SetRepositoryPolicyResponse> setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest)
Applies a repository policy on a specified repository to control access permissions.
setRepositoryPolicyRequest
- default CompletableFuture<UploadLayerPartResponse> uploadLayerPart(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 for pulling
and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
uploadLayerPartRequest
- Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.