@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonECRClient extends AmazonWebServiceClient implements AmazonECR
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description | 
|---|
| AmazonECRClient()Deprecated. 
 | 
| AmazonECRClient(AWSCredentials awsCredentials)Deprecated. 
 use  AwsClientBuilder.withCredentials(AWSCredentialsProvider)for example:AmazonECRClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); | 
| AmazonECRClient(AWSCredentials awsCredentials,
               ClientConfiguration clientConfiguration) | 
| AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider)Deprecated. 
 | 
| AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider,
               ClientConfiguration clientConfiguration) | 
| AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider,
               ClientConfiguration clientConfiguration,
               RequestMetricCollector requestMetricCollector) | 
| AmazonECRClient(ClientConfiguration clientConfiguration)Deprecated. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
| BatchCheckLayerAvailabilityResult | batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest request)
 Check the availability of multiple image layers in a specified registry and repository. | 
| BatchDeleteImageResult | batchDeleteImage(BatchDeleteImageRequest request)
 Deletes a list of specified images within a specified repository. | 
| BatchGetImageResult | batchGetImage(BatchGetImageRequest request)
 Gets detailed information for specified images within a specified repository. | 
| static AmazonECRClientBuilder | builder() | 
| CompleteLayerUploadResult | completeLayerUpload(CompleteLayerUploadRequest request)
 Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has
 completed. | 
| CreateRepositoryResult | createRepository(CreateRepositoryRequest request)
 Creates an image repository. | 
| DeleteRepositoryResult | deleteRepository(DeleteRepositoryRequest request)
 Deletes an existing image repository. | 
| DeleteRepositoryPolicyResult | deleteRepositoryPolicy(DeleteRepositoryPolicyRequest request)
 Deletes the repository policy from a specified repository. | 
| DescribeImagesResult | describeImages(DescribeImagesRequest request)
 Returns metadata about the images in a repository, including image size, image tags, and creation date. | 
| DescribeRepositoriesResult | describeRepositories(DescribeRepositoriesRequest request)
 Describes image repositories in a registry. | 
| GetAuthorizationTokenResult | getAuthorizationToken(GetAuthorizationTokenRequest request)
 Retrieves a token that is valid for a specified registry for 12 hours. | 
| ResponseMetadata | getCachedResponseMetadata(AmazonWebServiceRequest request)Returns additional metadata for a previously executed successful, request, typically used for debugging issues
 where a service isn't acting as expected. | 
| GetDownloadUrlForLayerResult | getDownloadUrlForLayer(GetDownloadUrlForLayerRequest request)
 Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. | 
| GetRepositoryPolicyResult | getRepositoryPolicy(GetRepositoryPolicyRequest request)
 Retrieves the repository policy for a specified repository. | 
| InitiateLayerUploadResult | initiateLayerUpload(InitiateLayerUploadRequest request)
 Notify Amazon ECR that you intend to upload an image layer. | 
| ListImagesResult | listImages(ListImagesRequest request)
 Lists all the image IDs for a given repository. | 
| PutImageResult | putImage(PutImageRequest request)
 Creates or updates the image manifest and tags associated with an image. | 
| SetRepositoryPolicyResult | setRepositoryPolicy(SetRepositoryPolicyRequest request)
 Applies a repository policy on a specified repository to control access permissions. | 
| UploadLayerPartResult | uploadLayerPart(UploadLayerPartRequest request)
 Uploads an image layer part to Amazon ECR. | 
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdown@Deprecated public AmazonECRClient()
AmazonECRClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonECRClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to Amazon ECR (ex: proxy settings,
        retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AmazonECRClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
             AmazonECRClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonECRClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
             AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon ECR (ex: proxy settings,
        retry counts, etc.).@Deprecated public AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
             AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon ECR (ex: proxy settings,
        retry counts, etc.).@Deprecated public AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
             AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
             AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon ECR (ex: proxy settings,
        retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AmazonECRClientBuilder builder()
public BatchCheckLayerAvailabilityResult batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest request)
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.
 
batchCheckLayerAvailability in interface AmazonECRbatchCheckLayerAvailabilityRequest - 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.public BatchDeleteImageResult batchDeleteImage(BatchDeleteImageRequest request)
 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.
batchDeleteImage in interface AmazonECRbatchDeleteImageRequest - 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.public BatchGetImageResult batchGetImage(BatchGetImageRequest request)
 Gets detailed information for specified images within a specified repository. Images are specified with either
 imageTag or imageDigest.
 
batchGetImage in interface AmazonECRbatchGetImageRequest - 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.public CompleteLayerUploadResult completeLayerUpload(CompleteLayerUploadRequest request)
 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.
 
completeLayerUpload in interface AmazonECRcompleteLayerUploadRequest - 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.public CreateRepositoryResult createRepository(CreateRepositoryRequest request)
Creates an image repository.
createRepository in interface AmazonECRcreateRepositoryRequest - 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.public DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest request)
 Deletes an existing image repository. If a repository contains images, you must use the force option
 to delete it.
 
deleteRepository in interface AmazonECRdeleteRepositoryRequest - 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.public DeleteRepositoryPolicyResult deleteRepositoryPolicy(DeleteRepositoryPolicyRequest request)
Deletes the repository policy from a specified repository.
deleteRepositoryPolicy in interface AmazonECRdeleteRepositoryPolicyRequest - 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.public DescribeImagesResult describeImages(DescribeImagesRequest request)
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.
 
describeImages in interface AmazonECRdescribeImagesRequest - 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.public DescribeRepositoriesResult describeRepositories(DescribeRepositoriesRequest request)
Describes image repositories in a registry.
describeRepositories in interface AmazonECRdescribeRepositoriesRequest - 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.public GetAuthorizationTokenResult getAuthorizationToken(GetAuthorizationTokenRequest request)
 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.
 
getAuthorizationToken in interface AmazonECRgetAuthorizationTokenRequest - 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.public GetDownloadUrlForLayerResult getDownloadUrlForLayer(GetDownloadUrlForLayerRequest request)
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.
 
getDownloadUrlForLayer in interface AmazonECRgetDownloadUrlForLayerRequest - 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.public GetRepositoryPolicyResult getRepositoryPolicy(GetRepositoryPolicyRequest request)
Retrieves the repository policy for a specified repository.
getRepositoryPolicy in interface AmazonECRgetRepositoryPolicyRequest - 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.public InitiateLayerUploadResult initiateLayerUpload(InitiateLayerUploadRequest request)
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.
 
initiateLayerUpload in interface AmazonECRinitiateLayerUploadRequest - 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.public ListImagesResult listImages(ListImagesRequest request)
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.
 
listImages in interface AmazonECRlistImagesRequest - 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.public PutImageResult putImage(PutImageRequest request)
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.
 
putImage in interface AmazonECRputImageRequest - 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.public SetRepositoryPolicyResult setRepositoryPolicy(SetRepositoryPolicyRequest request)
Applies a repository policy on a specified repository to control access permissions.
setRepositoryPolicy in interface AmazonECRsetRepositoryPolicyRequest - 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.public UploadLayerPartResult uploadLayerPart(UploadLayerPartRequest request)
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.
 
uploadLayerPart in interface AmazonECRuploadLayerPartRequest - 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonECRrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.