AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface ECRClient 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 | Field | Description |
---|---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method | Description |
---|---|---|
default BatchCheckLayerAvailabilityResponse |
batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) |
Check the availability of multiple image layers in a specified registry and repository.
|
default BatchDeleteImageResponse |
batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest) |
Deletes a list of specified images within a specified repository.
|
default BatchGetImageResponse |
batchGetImage(BatchGetImageRequest batchGetImageRequest) |
Gets detailed information for specified images within a specified repository.
|
static ECRClientBuilder |
builder() |
Create a builder that can be used to configure and create a
ECRClient . |
default CompleteLayerUploadResponse |
completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest) |
Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has
completed.
|
static ECRClient |
create() |
Create a
ECRClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateRepositoryResponse |
createRepository(CreateRepositoryRequest createRepositoryRequest) |
Creates an image repository.
|
default DeleteRepositoryResponse |
deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) |
Deletes an existing image repository.
|
default DeleteRepositoryPolicyResponse |
deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) |
Deletes the repository policy from a specified repository.
|
default DescribeImagesResponse |
describeImages(DescribeImagesRequest describeImagesRequest) |
Returns metadata about the images in a repository, including image size, image tags, and creation date.
|
default DescribeRepositoriesResponse |
describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest) |
Describes image repositories in a registry.
|
default GetAuthorizationTokenResponse |
getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest) |
Retrieves a token that is valid for a specified registry for 12 hours.
|
default GetDownloadUrlForLayerResponse |
getDownloadUrlForLayer(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest) |
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.
|
default GetRepositoryPolicyResponse |
getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest) |
Retrieves the repository policy for a specified repository.
|
default InitiateLayerUploadResponse |
initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest) |
Notify Amazon ECR that you intend to upload an image layer.
|
default ListImagesResponse |
listImages(ListImagesRequest listImagesRequest) |
Lists all the image IDs for a given repository.
|
default PutImageResponse |
putImage(PutImageRequest putImageRequest) |
Creates or updates the image manifest and tags associated with an image.
|
static ServiceMetadata |
serviceMetadata() |
|
default SetRepositoryPolicyResponse |
setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest) |
Applies a repository policy on a specified repository to control access permissions.
|
default UploadLayerPartResponse |
uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest) |
Uploads an image layer part to Amazon ECR.
|
close
static final String SERVICE_NAME
static ECRClient create()
ECRClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ECRClientBuilder builder()
ECRClient
.default BatchCheckLayerAvailabilityResponse batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) throws RepositoryNotFoundException, InvalidParameterException, ServerException, SdkBaseException, SdkClientException, ECRException
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
- RepositoryNotFoundException
- The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault BatchDeleteImageResponse batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, SdkBaseException, SdkClientException, ECRException
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
.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 could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault BatchGetImageResponse batchGetImage(BatchGetImageRequest batchGetImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, SdkBaseException, SdkClientException, ECRException
Gets detailed information for specified images within a specified repository. Images are specified with either
imageTag
or imageDigest
.
batchGetImageRequest
- 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 could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CompleteLayerUploadResponse completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UploadNotFoundException, InvalidLayerException, LayerPartTooSmallException, LayerAlreadyExistsException, EmptyUploadException, SdkBaseException, SdkClientException, ECRException
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
- 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 could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.UploadNotFoundException
- The upload could not be found, or the specified upload id is not valid for this repository.InvalidLayerException
- The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not 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 does not contain any layer parts.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateRepositoryResponse createRepository(CreateRepositoryRequest createRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryAlreadyExistsException, LimitExceededException, SdkBaseException, SdkClientException, ECRException
Creates an image repository.
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.RepositoryAlreadyExistsException
- The specified repository already exists in the specified registry.LimitExceededException
- The operation did not succeed because it would have exceeded a service limit for your account. For more
information, see Amazon ECR Default
Service Limits in the Amazon EC2 Container Registry User Guide.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteRepositoryResponse deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryNotEmptyException, SdkBaseException, SdkClientException, ECRException
Deletes an existing image repository. If a repository contains images, you must use the force
option
to delete it.
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 could not be found. Check the spelling of the specified repository and ensure
that you are 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteRepositoryPolicyResponse deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, SdkBaseException, SdkClientException, ECRException
Deletes the repository policy from a 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 could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.RepositoryPolicyNotFoundException
- The specified repository and registry combination does not have an associated repository policy.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeImagesResponse describeImages(DescribeImagesRequest describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, SdkBaseException, SdkClientException, ECRException
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
- 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 could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ImageNotFoundException
- The image requested does not exist in the specified repository.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeRepositoriesResponse describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, SdkBaseException, SdkClientException, ECRException
Describes image repositories in a 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 could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetAuthorizationTokenResponse getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest) throws ServerException, InvalidParameterException, SdkBaseException, SdkClientException, ECRException
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
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetDownloadUrlForLayerResponse getDownloadUrlForLayer(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest) throws ServerException, InvalidParameterException, LayersNotFoundException, LayerInaccessibleException, RepositoryNotFoundException, SdkBaseException, SdkClientException, ECRException
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
- 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.LayersNotFoundException
- The specified layers could not be found, or the specified layer is not valid for this repository.LayerInaccessibleException
- The specified layer is not available because it is not associated with an image. Unassociated image
layers may be cleaned up at any time.RepositoryNotFoundException
- The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetRepositoryPolicyResponse getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, SdkBaseException, SdkClientException, ECRException
Retrieves the repository policy for a 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 could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.RepositoryPolicyNotFoundException
- The specified repository and registry combination does not have an associated repository policy.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault InitiateLayerUploadResponse initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, SdkBaseException, SdkClientException, ECRException
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
- 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 could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListImagesResponse listImages(ListImagesRequest listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, SdkBaseException, SdkClientException, ECRException
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
- 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 could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutImageResponse putImage(PutImageRequest putImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageAlreadyExistsException, LayersNotFoundException, LimitExceededException, SdkBaseException, SdkClientException, ECRException
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
- 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 could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ImageAlreadyExistsException
- The specified image has already been pushed, and there are no changes to the manifest or image tag since
the last push.LayersNotFoundException
- The specified layers could not be found, or the specified layer is not valid for this repository.LimitExceededException
- The operation did not succeed because it would have exceeded a service limit for your account. For more
information, see Amazon ECR Default
Service Limits in the Amazon EC2 Container Registry User Guide.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetRepositoryPolicyResponse setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, SdkBaseException, SdkClientException, ECRException
Applies a repository policy on a specified repository to control access permissions.
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 could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UploadLayerPartResponse uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest) throws ServerException, InvalidParameterException, InvalidLayerPartException, RepositoryNotFoundException, UploadNotFoundException, LimitExceededException, SdkBaseException, SdkClientException, ECRException
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
- 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 is not valid, or the first byte specified is not consecutive to the last byte of a
previous layer part upload.RepositoryNotFoundException
- The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.UploadNotFoundException
- The upload could not be found, or the specified upload id is not valid for this repository.LimitExceededException
- The operation did not succeed because it would have exceeded a service limit for your account. For more
information, see Amazon ECR Default
Service Limits in the Amazon EC2 Container Registry User Guide.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECRException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.