Interface EcrPublicClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon Elastic Container Registry Public (Amazon ECR Public) is a managed container image registry service. Amazon ECR provides both public and private registries to host your container images. You can use the Docker CLI or your 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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchCheckLayerAvailability
(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest) Checks the availability of one or more image layers that are within a repository in a public registry.batchCheckLayerAvailability
(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) Checks the availability of one or more image layers that are within a repository in a public registry.default BatchDeleteImageResponse
batchDeleteImage
(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest) Deletes a list of specified images that are within a repository in a public registry.default BatchDeleteImageResponse
batchDeleteImage
(BatchDeleteImageRequest batchDeleteImageRequest) Deletes a list of specified images that are within a repository in a public registry.static EcrPublicClientBuilder
builder()
Create a builder that can be used to configure and create aEcrPublicClient
.default CompleteLayerUploadResponse
completeLayerUpload
(Consumer<CompleteLayerUploadRequest.Builder> completeLayerUploadRequest) Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and upload ID.default CompleteLayerUploadResponse
completeLayerUpload
(CompleteLayerUploadRequest completeLayerUploadRequest) Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and upload ID.static EcrPublicClient
create()
Create aEcrPublicClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateRepositoryResponse
createRepository
(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) Creates a repository in a public registry.default CreateRepositoryResponse
createRepository
(CreateRepositoryRequest createRepositoryRequest) Creates a repository in a public registry.default DeleteRepositoryResponse
deleteRepository
(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) Deletes a repository in a public registry.default DeleteRepositoryResponse
deleteRepository
(DeleteRepositoryRequest deleteRepositoryRequest) Deletes a repository in a public registry.default DeleteRepositoryPolicyResponse
deleteRepositoryPolicy
(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest) Deletes the repository policy that's associated with the specified repository.default DeleteRepositoryPolicyResponse
deleteRepositoryPolicy
(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) Deletes the repository policy that's associated with the specified repository.default DescribeImagesResponse
describeImages
(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) Returns metadata that's related to the images in a repository in a public registry.default DescribeImagesResponse
describeImages
(DescribeImagesRequest describeImagesRequest) Returns metadata that's related to the images in a repository in a public registry.default DescribeImagesIterable
describeImagesPaginator
(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) This is a variant ofdescribeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)
operation.default DescribeImagesIterable
describeImagesPaginator
(DescribeImagesRequest describeImagesRequest) This is a variant ofdescribeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)
operation.default DescribeImageTagsResponse
describeImageTags
(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest) Returns the image tag details for a repository in a public registry.default DescribeImageTagsResponse
describeImageTags
(DescribeImageTagsRequest describeImageTagsRequest) Returns the image tag details for a repository in a public registry.default DescribeImageTagsIterable
describeImageTagsPaginator
(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest) This is a variant ofdescribeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)
operation.default DescribeImageTagsIterable
describeImageTagsPaginator
(DescribeImageTagsRequest describeImageTagsRequest) This is a variant ofdescribeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)
operation.default DescribeRegistriesResponse
describeRegistries
(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest) Returns details for a public registry.default DescribeRegistriesResponse
describeRegistries
(DescribeRegistriesRequest describeRegistriesRequest) Returns details for a public registry.default DescribeRegistriesIterable
describeRegistriesPaginator
(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest) This is a variant ofdescribeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)
operation.default DescribeRegistriesIterable
describeRegistriesPaginator
(DescribeRegistriesRequest describeRegistriesRequest) This is a variant ofdescribeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)
operation.default DescribeRepositoriesResponse
describeRepositories
(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) Describes repositories that are in a public registry.default DescribeRepositoriesResponse
describeRepositories
(DescribeRepositoriesRequest describeRepositoriesRequest) Describes repositories that are in a public registry.default DescribeRepositoriesIterable
describeRepositoriesPaginator
(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) This is a variant ofdescribeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)
operation.default DescribeRepositoriesIterable
describeRepositoriesPaginator
(DescribeRepositoriesRequest describeRepositoriesRequest) This is a variant ofdescribeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)
operation.default GetAuthorizationTokenResponse
getAuthorizationToken
(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest) Retrieves an authorization token.default GetAuthorizationTokenResponse
getAuthorizationToken
(GetAuthorizationTokenRequest getAuthorizationTokenRequest) Retrieves an authorization token.default GetRegistryCatalogDataResponse
getRegistryCatalogData
(Consumer<GetRegistryCatalogDataRequest.Builder> getRegistryCatalogDataRequest) Retrieves catalog metadata for a public registry.default GetRegistryCatalogDataResponse
getRegistryCatalogData
(GetRegistryCatalogDataRequest getRegistryCatalogDataRequest) Retrieves catalog metadata for a public registry.default GetRepositoryCatalogDataResponse
getRepositoryCatalogData
(Consumer<GetRepositoryCatalogDataRequest.Builder> getRepositoryCatalogDataRequest) Retrieve catalog metadata for a repository in a public registry.default GetRepositoryCatalogDataResponse
getRepositoryCatalogData
(GetRepositoryCatalogDataRequest getRepositoryCatalogDataRequest) Retrieve catalog metadata for a repository in a public registry.default GetRepositoryPolicyResponse
getRepositoryPolicy
(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest) Retrieves the repository policy for the specified repository.default GetRepositoryPolicyResponse
getRepositoryPolicy
(GetRepositoryPolicyRequest getRepositoryPolicyRequest) Retrieves the repository policy for the specified repository.default InitiateLayerUploadResponse
initiateLayerUpload
(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest) Notifies Amazon ECR that you intend to upload an image layer.default InitiateLayerUploadResponse
initiateLayerUpload
(InitiateLayerUploadRequest initiateLayerUploadRequest) Notifies Amazon ECR that you intend to upload an image layer.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags for an Amazon ECR Public resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List the tags for an Amazon ECR Public resource.default PutImageResponse
putImage
(Consumer<PutImageRequest.Builder> putImageRequest) Creates or updates the image manifest and tags that are associated with an image.default PutImageResponse
putImage
(PutImageRequest putImageRequest) Creates or updates the image manifest and tags that are associated with an image.default PutRegistryCatalogDataResponse
putRegistryCatalogData
(Consumer<PutRegistryCatalogDataRequest.Builder> putRegistryCatalogDataRequest) Create or update the catalog data for a public registry.default PutRegistryCatalogDataResponse
putRegistryCatalogData
(PutRegistryCatalogDataRequest putRegistryCatalogDataRequest) Create or update the catalog data for a public registry.default PutRepositoryCatalogDataResponse
putRepositoryCatalogData
(Consumer<PutRepositoryCatalogDataRequest.Builder> putRepositoryCatalogDataRequest) Creates or updates the catalog data for a repository in a public registry.default PutRepositoryCatalogDataResponse
putRepositoryCatalogData
(PutRepositoryCatalogDataRequest putRepositoryCatalogDataRequest) Creates or updates the catalog data for a repository in a public registry.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default SetRepositoryPolicyResponse
setRepositoryPolicy
(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest) Applies a repository policy to the specified public repository to control access permissions.default SetRepositoryPolicyResponse
setRepositoryPolicy
(SetRepositoryPolicyRequest setRepositoryPolicyRequest) Applies a repository policy to the specified public repository to control access permissions.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates the specified tags to a resource with the specifiedresourceArn
.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Associates the specified tags to a resource with the specifiedresourceArn
.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes specified tags from a resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Deletes specified tags from a resource.default UploadLayerPartResponse
uploadLayerPart
(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest) Uploads an image layer part to Amazon ECR.default UploadLayerPartResponse
uploadLayerPart
(UploadLayerPartRequest uploadLayerPartRequest) Uploads an image layer part to Amazon ECR.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchCheckLayerAvailability
default BatchCheckLayerAvailabilityResponse batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) throws RepositoryNotFoundException, InvalidParameterException, ServerException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Checks the availability of one or more image layers that are 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.
- See Also:
-
batchCheckLayerAvailability
default BatchCheckLayerAvailabilityResponse batchCheckLayerAvailability(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest) throws RepositoryNotFoundException, InvalidParameterException, ServerException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Checks the availability of one or more image layers that are 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.
This is a convenience which creates an instance of the
BatchCheckLayerAvailabilityRequest.Builder
avoiding the need to create one manually viaBatchCheckLayerAvailabilityRequest.builder()
- Parameters:
batchCheckLayerAvailabilityRequest
- AConsumer
that will call methods onBatchCheckLayerAvailabilityRequest.Builder
to create a request.- Returns:
- Result of the BatchCheckLayerAvailability operation returned by the service.
- See Also:
-
batchDeleteImage
default BatchDeleteImageResponse batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Deletes a list of specified images that are within a repository in a public registry. Images are specified with either an
imageTag
orimageDigest
.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 digest of the image in your request.
- Parameters:
batchDeleteImageRequest
-- Returns:
- Result of the BatchDeleteImage operation returned by the service.
- See Also:
-
batchDeleteImage
default BatchDeleteImageResponse batchDeleteImage(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Deletes a list of specified images that are within a repository in a public registry. Images are specified with either an
imageTag
orimageDigest
.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 digest of the image in your request.
This is a convenience which creates an instance of the
BatchDeleteImageRequest.Builder
avoiding the need to create one manually viaBatchDeleteImageRequest.builder()
- Parameters:
batchDeleteImageRequest
- AConsumer
that will call methods onBatchDeleteImageRequest.Builder
to create a request.- Returns:
- Result of the BatchDeleteImage operation returned by the service.
- See Also:
-
completeLayerUpload
default CompleteLayerUploadResponse completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UploadNotFoundException, InvalidLayerException, LayerPartTooSmallException, LayerAlreadyExistsException, EmptyUploadException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Informs Amazon ECR that the image layer upload is complete 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 for each new image layer to verify that the upload is complete.
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.
- See Also:
-
completeLayerUpload
default CompleteLayerUploadResponse completeLayerUpload(Consumer<CompleteLayerUploadRequest.Builder> completeLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UploadNotFoundException, InvalidLayerException, LayerPartTooSmallException, LayerAlreadyExistsException, EmptyUploadException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Informs Amazon ECR that the image layer upload is complete 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 for each new image layer to verify that the upload is complete.
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.
This is a convenience which creates an instance of the
CompleteLayerUploadRequest.Builder
avoiding the need to create one manually viaCompleteLayerUploadRequest.builder()
- Parameters:
completeLayerUploadRequest
- AConsumer
that will call methods onCompleteLayerUploadRequest.Builder
to create a request.- Returns:
- Result of the CompleteLayerUpload operation returned by the service.
- See Also:
-
createRepository
default CreateRepositoryResponse createRepository(CreateRepositoryRequest createRepositoryRequest) throws ServerException, InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryAlreadyExistsException, LimitExceededException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException 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.
- See Also:
-
createRepository
default CreateRepositoryResponse createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) throws ServerException, InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryAlreadyExistsException, LimitExceededException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
CreateRepositoryRequest.Builder
avoiding the need to create one manually viaCreateRepositoryRequest.builder()
- Parameters:
createRepositoryRequest
- AConsumer
that will call methods onCreateRepositoryRequest.Builder
to create a request.- Returns:
- Result of the CreateRepository operation returned by the service.
- See Also:
-
deleteRepository
default DeleteRepositoryResponse deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryNotEmptyException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Deletes a repository in a public registry. If the repository contains images, you must either manually delete all images in the repository or use the
force
option. This option deletes all images on your behalf before deleting the repository.- Parameters:
deleteRepositoryRequest
-- Returns:
- Result of the DeleteRepository operation returned by the service.
- See Also:
-
deleteRepository
default DeleteRepositoryResponse deleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryNotEmptyException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Deletes a repository in a public registry. If the repository contains images, you must either manually delete all images in the repository or use the
force
option. This option deletes all images on your behalf before deleting the repository.
This is a convenience which creates an instance of the
DeleteRepositoryRequest.Builder
avoiding the need to create one manually viaDeleteRepositoryRequest.builder()
- Parameters:
deleteRepositoryRequest
- AConsumer
that will call methods onDeleteRepositoryRequest.Builder
to create a request.- Returns:
- Result of the DeleteRepository operation returned by the service.
- See Also:
-
deleteRepositoryPolicy
default DeleteRepositoryPolicyResponse deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Deletes the repository policy that's associated with the specified repository.
- Parameters:
deleteRepositoryPolicyRequest
-- Returns:
- Result of the DeleteRepositoryPolicy operation returned by the service.
- See Also:
-
deleteRepositoryPolicy
default DeleteRepositoryPolicyResponse deleteRepositoryPolicy(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Deletes the repository policy that's associated with the specified repository.
This is a convenience which creates an instance of the
DeleteRepositoryPolicyRequest.Builder
avoiding the need to create one manually viaDeleteRepositoryPolicyRequest.builder()
- Parameters:
deleteRepositoryPolicyRequest
- AConsumer
that will call methods onDeleteRepositoryPolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteRepositoryPolicy operation returned by the service.
- See Also:
-
describeImageTags
default DescribeImageTagsResponse describeImageTags(DescribeImageTagsRequest describeImageTagsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Returns the image tag details for a repository in a public registry.
- Parameters:
describeImageTagsRequest
-- Returns:
- Result of the DescribeImageTags operation returned by the service.
- See Also:
-
describeImageTags
default DescribeImageTagsResponse describeImageTags(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Returns the image tag details for a repository in a public registry.
This is a convenience which creates an instance of the
DescribeImageTagsRequest.Builder
avoiding the need to create one manually viaDescribeImageTagsRequest.builder()
- Parameters:
describeImageTagsRequest
- AConsumer
that will call methods onDescribeImageTagsRequest.Builder
to create a request.- Returns:
- Result of the DescribeImageTags operation returned by the service.
- See Also:
-
describeImageTagsPaginator
default DescribeImageTagsIterable describeImageTagsPaginator(DescribeImageTagsRequest describeImageTagsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException This is a variant of
describeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client.describeImageTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client .describeImageTagsPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client.describeImageTagsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)
operation.- Parameters:
describeImageTagsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeImageTagsPaginator
default DescribeImageTagsIterable describeImageTagsPaginator(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException This is a variant of
describeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client.describeImageTagsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client .describeImageTagsPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client.describeImageTagsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)
operation.
This is a convenience which creates an instance of the
DescribeImageTagsRequest.Builder
avoiding the need to create one manually viaDescribeImageTagsRequest.builder()
- Parameters:
describeImageTagsRequest
- AConsumer
that will call methods onDescribeImageTagsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeImages
default DescribeImagesResponse describeImages(DescribeImagesRequest describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Returns metadata that's related to 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. Therefore, it might return a larger image size than the image sizes that are returned by DescribeImages.- Parameters:
describeImagesRequest
-- Returns:
- Result of the DescribeImages operation returned by the service.
- See Also:
-
describeImages
default DescribeImagesResponse describeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Returns metadata that's related to 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. Therefore, it might return a larger image size than the image sizes that are returned by DescribeImages.
This is a convenience which creates an instance of the
DescribeImagesRequest.Builder
avoiding the need to create one manually viaDescribeImagesRequest.builder()
- Parameters:
describeImagesRequest
- AConsumer
that will call methods onDescribeImagesRequest.Builder
to create a request.- Returns:
- Result of the DescribeImages operation returned by the service.
- See Also:
-
describeImagesPaginator
default DescribeImagesIterable describeImagesPaginator(DescribeImagesRequest describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException This is a variant of
describeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client .describeImagesPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeImagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)
operation.- Parameters:
describeImagesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeImagesPaginator
default DescribeImagesIterable describeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException This is a variant of
describeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client .describeImagesPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeImagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)
operation.
This is a convenience which creates an instance of the
DescribeImagesRequest.Builder
avoiding the need to create one manually viaDescribeImagesRequest.builder()
- Parameters:
describeImagesRequest
- AConsumer
that will call methods onDescribeImagesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeRegistries
default DescribeRegistriesResponse describeRegistries(DescribeRegistriesRequest describeRegistriesRequest) throws InvalidParameterException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException Returns details for a public registry.
- Parameters:
describeRegistriesRequest
-- Returns:
- Result of the DescribeRegistries operation returned by the service.
- See Also:
-
describeRegistries
default DescribeRegistriesResponse describeRegistries(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest) throws InvalidParameterException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException Returns details for a public registry.
This is a convenience which creates an instance of the
DescribeRegistriesRequest.Builder
avoiding the need to create one manually viaDescribeRegistriesRequest.builder()
- Parameters:
describeRegistriesRequest
- AConsumer
that will call methods onDescribeRegistriesRequest.Builder
to create a request.- Returns:
- Result of the DescribeRegistries operation returned by the service.
- See Also:
-
describeRegistriesPaginator
default DescribeRegistriesIterable describeRegistriesPaginator(DescribeRegistriesRequest describeRegistriesRequest) throws InvalidParameterException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException This is a variant of
describeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client.describeRegistriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client .describeRegistriesPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client.describeRegistriesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)
operation.- Parameters:
describeRegistriesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeRegistriesPaginator
default DescribeRegistriesIterable describeRegistriesPaginator(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest) throws InvalidParameterException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException This is a variant of
describeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client.describeRegistriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client .describeRegistriesPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client.describeRegistriesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)
operation.
This is a convenience which creates an instance of the
DescribeRegistriesRequest.Builder
avoiding the need to create one manually viaDescribeRegistriesRequest.builder()
- Parameters:
describeRegistriesRequest
- AConsumer
that will call methods onDescribeRegistriesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeRepositories
default DescribeRepositoriesResponse describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Describes repositories that are in a public registry.
- Parameters:
describeRepositoriesRequest
-- Returns:
- Result of the DescribeRepositories operation returned by the service.
- See Also:
-
describeRepositories
default DescribeRepositoriesResponse describeRepositories(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Describes repositories that are in a public registry.
This is a convenience which creates an instance of the
DescribeRepositoriesRequest.Builder
avoiding the need to create one manually viaDescribeRepositoriesRequest.builder()
- Parameters:
describeRepositoriesRequest
- AConsumer
that will call methods onDescribeRepositoriesRequest.Builder
to create a request.- Returns:
- Result of the DescribeRepositories operation returned by the service.
- See Also:
-
describeRepositoriesPaginator
default DescribeRepositoriesIterable describeRepositoriesPaginator(DescribeRepositoriesRequest describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException This is a variant of
describeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client .describeRepositoriesPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)
operation.- Parameters:
describeRepositoriesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeRepositoriesPaginator
default DescribeRepositoriesIterable describeRepositoriesPaginator(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException This is a variant of
describeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client .describeRepositoriesPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)
operation.
This is a convenience which creates an instance of the
DescribeRepositoriesRequest.Builder
avoiding the need to create one manually viaDescribeRepositoriesRequest.builder()
- Parameters:
describeRepositoriesRequest
- AConsumer
that will call methods onDescribeRepositoriesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getAuthorizationToken
default GetAuthorizationTokenResponse getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest) throws ServerException, InvalidParameterException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Retrieves an authorization token. An authorization token represents your IAM authentication credentials. You can use it 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
andsts:GetServiceBearerToken
permissions.- Parameters:
getAuthorizationTokenRequest
-- Returns:
- Result of the GetAuthorizationToken operation returned by the service.
- See Also:
-
getAuthorizationToken
default GetAuthorizationTokenResponse getAuthorizationToken(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest) throws ServerException, InvalidParameterException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Retrieves an authorization token. An authorization token represents your IAM authentication credentials. You can use it 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
andsts:GetServiceBearerToken
permissions.
This is a convenience which creates an instance of the
GetAuthorizationTokenRequest.Builder
avoiding the need to create one manually viaGetAuthorizationTokenRequest.builder()
- Parameters:
getAuthorizationTokenRequest
- AConsumer
that will call methods onGetAuthorizationTokenRequest.Builder
to create a request.- Returns:
- Result of the GetAuthorizationToken operation returned by the service.
- See Also:
-
getRegistryCatalogData
default GetRegistryCatalogDataResponse getRegistryCatalogData(GetRegistryCatalogDataRequest getRegistryCatalogDataRequest) throws ServerException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Retrieves catalog metadata for a public registry.
- Parameters:
getRegistryCatalogDataRequest
-- Returns:
- Result of the GetRegistryCatalogData operation returned by the service.
- See Also:
-
getRegistryCatalogData
default GetRegistryCatalogDataResponse getRegistryCatalogData(Consumer<GetRegistryCatalogDataRequest.Builder> getRegistryCatalogDataRequest) throws ServerException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Retrieves catalog metadata for a public registry.
This is a convenience which creates an instance of the
GetRegistryCatalogDataRequest.Builder
avoiding the need to create one manually viaGetRegistryCatalogDataRequest.builder()
- Parameters:
getRegistryCatalogDataRequest
- AConsumer
that will call methods onGetRegistryCatalogDataRequest.Builder
to create a request.- Returns:
- Result of the GetRegistryCatalogData operation returned by the service.
- See Also:
-
getRepositoryCatalogData
default GetRepositoryCatalogDataResponse getRepositoryCatalogData(GetRepositoryCatalogDataRequest getRepositoryCatalogDataRequest) throws ServerException, InvalidParameterException, RepositoryCatalogDataNotFoundException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException 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.
- See Also:
-
getRepositoryCatalogData
default GetRepositoryCatalogDataResponse getRepositoryCatalogData(Consumer<GetRepositoryCatalogDataRequest.Builder> getRepositoryCatalogDataRequest) throws ServerException, InvalidParameterException, RepositoryCatalogDataNotFoundException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.
This is a convenience which creates an instance of the
GetRepositoryCatalogDataRequest.Builder
avoiding the need to create one manually viaGetRepositoryCatalogDataRequest.builder()
- Parameters:
getRepositoryCatalogDataRequest
- AConsumer
that will call methods onGetRepositoryCatalogDataRequest.Builder
to create a request.- Returns:
- Result of the GetRepositoryCatalogData operation returned by the service.
- See Also:
-
getRepositoryPolicy
default GetRepositoryPolicyResponse getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Retrieves the repository policy for the specified repository.
- Parameters:
getRepositoryPolicyRequest
-- Returns:
- Result of the GetRepositoryPolicy operation returned by the service.
- See Also:
-
getRepositoryPolicy
default GetRepositoryPolicyResponse getRepositoryPolicy(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Retrieves the repository policy for the specified repository.
This is a convenience which creates an instance of the
GetRepositoryPolicyRequest.Builder
avoiding the need to create one manually viaGetRepositoryPolicyRequest.builder()
- Parameters:
getRepositoryPolicyRequest
- AConsumer
that will call methods onGetRepositoryPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetRepositoryPolicy operation returned by the service.
- See Also:
-
initiateLayerUpload
default InitiateLayerUploadResponse initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once for each image layer that hasn't already been uploaded. Whether an image layer uploads 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.
- See Also:
-
initiateLayerUpload
default InitiateLayerUploadResponse initiateLayerUpload(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once for each image layer that hasn't already been uploaded. Whether an image layer uploads 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.
This is a convenience which creates an instance of the
InitiateLayerUploadRequest.Builder
avoiding the need to create one manually viaInitiateLayerUploadRequest.builder()
- Parameters:
initiateLayerUploadRequest
- AConsumer
that will call methods onInitiateLayerUploadRequest.Builder
to create a request.- Returns:
- Result of the InitiateLayerUpload operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException List the tags for an Amazon ECR Public resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException List the tags for an Amazon ECR Public resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
putImage
default PutImageResponse putImage(PutImageRequest putImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageAlreadyExistsException, LayersNotFoundException, ReferencedImagesNotFoundException, LimitExceededException, ImageTagAlreadyExistsException, ImageDigestDoesNotMatchException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Creates or updates the image manifest and tags that are 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 that are 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.
- See Also:
-
putImage
default PutImageResponse putImage(Consumer<PutImageRequest.Builder> putImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageAlreadyExistsException, LayersNotFoundException, ReferencedImagesNotFoundException, LimitExceededException, ImageTagAlreadyExistsException, ImageDigestDoesNotMatchException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Creates or updates the image manifest and tags that are 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 that are 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.
This is a convenience which creates an instance of the
PutImageRequest.Builder
avoiding the need to create one manually viaPutImageRequest.builder()
- Parameters:
putImageRequest
- AConsumer
that will call methods onPutImageRequest.Builder
to create a request.- Returns:
- Result of the PutImage operation returned by the service.
- See Also:
-
putRegistryCatalogData
default PutRegistryCatalogDataResponse putRegistryCatalogData(PutRegistryCatalogDataRequest putRegistryCatalogDataRequest) throws ServerException, InvalidParameterException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Create or update the catalog data for a public registry.
- Parameters:
putRegistryCatalogDataRequest
-- Returns:
- Result of the PutRegistryCatalogData operation returned by the service.
- See Also:
-
putRegistryCatalogData
default PutRegistryCatalogDataResponse putRegistryCatalogData(Consumer<PutRegistryCatalogDataRequest.Builder> putRegistryCatalogDataRequest) throws ServerException, InvalidParameterException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Create or update the catalog data for a public registry.
This is a convenience which creates an instance of the
PutRegistryCatalogDataRequest.Builder
avoiding the need to create one manually viaPutRegistryCatalogDataRequest.builder()
- Parameters:
putRegistryCatalogDataRequest
- AConsumer
that will call methods onPutRegistryCatalogDataRequest.Builder
to create a request.- Returns:
- Result of the PutRegistryCatalogData operation returned by the service.
- See Also:
-
putRepositoryCatalogData
default PutRepositoryCatalogDataResponse putRepositoryCatalogData(PutRepositoryCatalogDataRequest putRepositoryCatalogDataRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException 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.
- See Also:
-
putRepositoryCatalogData
default PutRepositoryCatalogDataResponse putRepositoryCatalogData(Consumer<PutRepositoryCatalogDataRequest.Builder> putRepositoryCatalogDataRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException Creates or updates the catalog data for a repository in a public registry.
This is a convenience which creates an instance of the
PutRepositoryCatalogDataRequest.Builder
avoiding the need to create one manually viaPutRepositoryCatalogDataRequest.builder()
- Parameters:
putRepositoryCatalogDataRequest
- AConsumer
that will call methods onPutRepositoryCatalogDataRequest.Builder
to create a request.- Returns:
- Result of the PutRepositoryCatalogData operation returned by the service.
- See Also:
-
setRepositoryPolicy
default SetRepositoryPolicyResponse setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException 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.
- See Also:
-
setRepositoryPolicy
default SetRepositoryPolicyResponse setRepositoryPolicy(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException 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.
This is a convenience which creates an instance of the
SetRepositoryPolicyRequest.Builder
avoiding the need to create one manually viaSetRepositoryPolicyRequest.builder()
- Parameters:
setRepositoryPolicyRequest
- AConsumer
that will call methods onSetRepositoryPolicyRequest.Builder
to create a request.- Returns:
- Result of the SetRepositoryPolicy operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException Associates the specified tags to a resource with the specified
resourceArn
. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException Associates the specified tags to a resource with the specified
resourceArn
. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException Deletes specified tags from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException Deletes specified tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
uploadLayerPart
default UploadLayerPartResponse uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest) throws ServerException, InvalidParameterException, InvalidLayerPartException, RepositoryNotFoundException, UploadNotFoundException, LimitExceededException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException 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 (about 20MB). The UploadLayerPart API is called once for 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.
- See Also:
-
uploadLayerPart
default UploadLayerPartResponse uploadLayerPart(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest) throws ServerException, InvalidParameterException, InvalidLayerPartException, RepositoryNotFoundException, UploadNotFoundException, LimitExceededException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException 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 (about 20MB). The UploadLayerPart API is called once for 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.
This is a convenience which creates an instance of the
UploadLayerPartRequest.Builder
avoiding the need to create one manually viaUploadLayerPartRequest.builder()
- Parameters:
uploadLayerPartRequest
- AConsumer
that will call methods onUploadLayerPartRequest.Builder
to create a request.- Returns:
- Result of the UploadLayerPart operation returned by the service.
- See Also:
-
create
Create aEcrPublicClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aEcrPublicClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-