com.amazonaws.services.ecrpublic

Interface AmazonECRPublic

All Known Subinterfaces:

AmazonECRPublicAsync

All Known Implementing Classes:

AbstractAmazonECRPublic, AbstractAmazonECRPublicAsync, AmazonECRPublicAsyncClient, AmazonECRPublicClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonECRPublic

Interface for accessing Amazon ECR Public.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonECRPublic instead.

Amazon Elastic Container Registry Public

Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Amazon ECR provides both public and private registries to host your container images. You can use the familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR supports public repositories with this API. For information about the Amazon ECR API for private repositories, see Amazon Elastic Container Registry API Reference.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
BatchCheckLayerAvailabilityResult	batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) Checks the availability of one or more image layers within a repository in a public registry.
BatchDeleteImageResult	batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest) Deletes a list of specified images within a repository in a public registry.
CompleteLayerUploadResult	completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest) Informs Amazon ECR that the image layer upload has completed for a specified public registry, repository name, and upload ID.
CreateRepositoryResult	createRepository(CreateRepositoryRequest createRepositoryRequest) Creates a repository in a public registry.
DeleteRepositoryResult	deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) Deletes a repository in a public registry.
DeleteRepositoryPolicyResult	deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) Deletes the repository policy associated with the specified repository.
DescribeImagesResult	describeImages(DescribeImagesRequest describeImagesRequest) Returns metadata about the images in a repository in a public registry.
DescribeImageTagsResult	describeImageTags(DescribeImageTagsRequest describeImageTagsRequest) Returns the image tag details for a repository in a public registry.
DescribeRegistriesResult	describeRegistries(DescribeRegistriesRequest describeRegistriesRequest) Returns details for a public registry.
DescribeRepositoriesResult	describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest) Describes repositories in a public registry.
GetAuthorizationTokenResult	getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest) Retrieves an authorization token.
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.
GetRegistryCatalogDataResult	getRegistryCatalogData(GetRegistryCatalogDataRequest getRegistryCatalogDataRequest) Retrieves catalog metadata for a public registry.
GetRepositoryCatalogDataResult	getRepositoryCatalogData(GetRepositoryCatalogDataRequest getRepositoryCatalogDataRequest) Retrieve catalog metadata for a repository in a public registry.
GetRepositoryPolicyResult	getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest) Retrieves the repository policy for the specified repository.
InitiateLayerUploadResult	initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest) Notifies Amazon ECR that you intend to upload an image layer.
PutImageResult	putImage(PutImageRequest putImageRequest) Creates or updates the image manifest and tags associated with an image.
PutRegistryCatalogDataResult	putRegistryCatalogData(PutRegistryCatalogDataRequest putRegistryCatalogDataRequest) Create or updates the catalog data for a public registry.
PutRepositoryCatalogDataResult	putRepositoryCatalogData(PutRepositoryCatalogDataRequest putRepositoryCatalogDataRequest) Creates or updates the catalog data for a repository in a public registry.
SetRepositoryPolicyResult	setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest) Applies a repository policy to the specified public repository to control access permissions.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UploadLayerPartResult	uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest) Uploads an image layer part to Amazon ECR.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

batchCheckLayerAvailability

BatchCheckLayerAvailabilityResult batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest)

Checks the availability of one or more image layers within a repository in a public registry. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.

This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

Parameters:

batchCheckLayerAvailabilityRequest -

Returns:

Result of the BatchCheckLayerAvailability operation returned by the service.

Throws:

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.

RegistryNotFoundException - The registry does not exist.

See Also:

AWS API Documentation

batchDeleteImage

BatchDeleteImageResult batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest)

Deletes a list of specified images within a repository in a public registry. Images are specified with either an 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.

Parameters:

batchDeleteImageRequest -

Returns:

Result of the BatchDeleteImage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

completeLayerUpload

CompleteLayerUploadResult completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest)

Informs Amazon ECR that the image layer upload has completed for a specified public registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes.

When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.

This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

Parameters:

completeLayerUploadRequest -

Returns:

Result of the CompleteLayerUpload operation returned by the service.

Throws:

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.

RegistryNotFoundException - The registry does not exist.

UnsupportedCommandException - The action is not supported in this Region.

See Also:

AWS API Documentation

createRepository

CreateRepositoryResult createRepository(CreateRepositoryRequest createRepositoryRequest)

Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.

Parameters:

createRepositoryRequest -

Returns:

Result of the CreateRepository operation returned by the service.

Throws:

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 Service Quotas in the Amazon Elastic Container Registry User Guide.

See Also:

AWS API Documentation

deleteRepository

DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)

Deletes a repository in a public registry. If the repository contains images, you must either delete all images in the repository or use the force option which deletes all images on your behalf before deleting the repository.

Parameters:

deleteRepositoryRequest -

Returns:

Result of the DeleteRepository operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteRepositoryPolicy

DeleteRepositoryPolicyResult deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest)

Deletes the repository policy associated with the specified repository.

Parameters:

deleteRepositoryPolicyRequest -

Returns:

Result of the DeleteRepositoryPolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeImageTags

DescribeImageTagsResult describeImageTags(DescribeImageTagsRequest describeImageTagsRequest)

Returns the image tag details for a repository in a public registry.

Parameters:

describeImageTagsRequest -

Returns:

Result of the DescribeImageTags operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeImages

DescribeImagesResult describeImages(DescribeImagesRequest describeImagesRequest)

Returns metadata about the images in a repository in a public registry.

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.

Parameters:

describeImagesRequest -

Returns:

Result of the DescribeImages operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeRegistries

DescribeRegistriesResult describeRegistries(DescribeRegistriesRequest describeRegistriesRequest)

Returns details for a public registry.

Parameters:

describeRegistriesRequest -

Returns:

Result of the DescribeRegistries operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

UnsupportedCommandException - The action is not supported in this Region.

ServerException - These errors are usually caused by a server-side issue.

See Also:

AWS API Documentation

describeRepositories

DescribeRepositoriesResult describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest)

Describes repositories in a public registry.

Parameters:

describeRepositoriesRequest -

Returns:

Result of the DescribeRepositories operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getAuthorizationToken

GetAuthorizationTokenResult getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest)

Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. This API requires the ecr-public:GetAuthorizationToken and sts:GetServiceBearerToken permissions.

Parameters:

getAuthorizationTokenRequest -

Returns:

Result of the GetAuthorizationToken operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getRegistryCatalogData

GetRegistryCatalogDataResult getRegistryCatalogData(GetRegistryCatalogDataRequest getRegistryCatalogDataRequest)

Retrieves catalog metadata for a public registry.

Parameters:

getRegistryCatalogDataRequest -

Returns:

Result of the GetRegistryCatalogData operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

UnsupportedCommandException - The action is not supported in this Region.

See Also:

AWS API Documentation

getRepositoryCatalogData

GetRepositoryCatalogDataResult getRepositoryCatalogData(GetRepositoryCatalogDataRequest getRepositoryCatalogDataRequest)

Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.

Parameters:

getRepositoryCatalogDataRequest -

Returns:

Result of the GetRepositoryCatalogData operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getRepositoryPolicy

GetRepositoryPolicyResult getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest)

Retrieves the repository policy for the specified repository.

Parameters:

getRepositoryPolicyRequest -

Returns:

Result of the GetRepositoryPolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

initiateLayerUpload

InitiateLayerUploadResult initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest)

Notifies Amazon ECR that you intend to upload an image layer.

When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.

This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

Parameters:

initiateLayerUploadRequest -

Returns:

Result of the InitiateLayerUpload operation returned by the service.

Throws:

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.

RegistryNotFoundException - The registry does not exist.

UnsupportedCommandException - The action is not supported in this Region.

See Also:

AWS API Documentation

putImage

PutImageResult putImage(PutImageRequest putImageRequest)

Creates or updates the image manifest and tags associated with an image.

When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.

This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

Parameters:

putImageRequest -

Returns:

Result of the PutImage operation returned by the service.

Throws:

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 were no changes to the manifest or image tag after the last push.

LayersNotFoundException - The specified layers could not be found, or the specified layer is not valid for this repository.

ReferencedImagesNotFoundException - The manifest list is referencing an image that does not exist.

LimitExceededException - The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Service Quotas in the Amazon Elastic Container Registry User Guide.

ImageTagAlreadyExistsException - The specified image is tagged with a tag that already exists. The repository is configured for tag immutability.

ImageDigestDoesNotMatchException - The specified image digest does not match the digest that Amazon ECR calculated for the image.

RegistryNotFoundException - The registry does not exist.

UnsupportedCommandException - The action is not supported in this Region.

See Also:

AWS API Documentation

putRegistryCatalogData

PutRegistryCatalogDataResult putRegistryCatalogData(PutRegistryCatalogDataRequest putRegistryCatalogDataRequest)

Create or updates the catalog data for a public registry.

Parameters:

putRegistryCatalogDataRequest -

Returns:

Result of the PutRegistryCatalogData operation returned by the service.

Throws:

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.

UnsupportedCommandException - The action is not supported in this Region.

See Also:

AWS API Documentation

putRepositoryCatalogData

PutRepositoryCatalogDataResult putRepositoryCatalogData(PutRepositoryCatalogDataRequest putRepositoryCatalogDataRequest)

Creates or updates the catalog data for a repository in a public registry.

Parameters:

putRepositoryCatalogDataRequest -

Returns:

Result of the PutRepositoryCatalogData operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

setRepositoryPolicy

SetRepositoryPolicyResult setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest)

Applies a repository policy to the specified public repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.

Parameters:

setRepositoryPolicyRequest -

Returns:

Result of the SetRepositoryPolicy operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

uploadLayerPart

UploadLayerPartResult uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest)

Uploads an image layer part to Amazon ECR.

When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part.

This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

Parameters:

uploadLayerPartRequest -

Returns:

Result of the UploadLayerPart operation returned by the service.

Throws:

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 Service Quotas in the Amazon Elastic Container Registry User Guide.

RegistryNotFoundException - The registry does not exist.

UnsupportedCommandException - The action is not supported in this Region.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.