Interface EcrPublicAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
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.batchDeleteImage
(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest) Deletes a list of specified images that are within a repository in a public registry.batchDeleteImage
(BatchDeleteImageRequest batchDeleteImageRequest) Deletes a list of specified images that are within a repository in a public registry.static EcrPublicAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aEcrPublicAsyncClient
.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.completeLayerUpload
(CompleteLayerUploadRequest completeLayerUploadRequest) Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and upload ID.static EcrPublicAsyncClient
create()
Create aEcrPublicAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createRepository
(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) Creates a repository in a public registry.createRepository
(CreateRepositoryRequest createRepositoryRequest) Creates a repository in a public registry.deleteRepository
(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) Deletes a repository in a public registry.deleteRepository
(DeleteRepositoryRequest deleteRepositoryRequest) Deletes a repository in a public registry.deleteRepositoryPolicy
(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest) Deletes the repository policy that's associated with the specified repository.deleteRepositoryPolicy
(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) Deletes the repository policy that's associated with the specified repository.default CompletableFuture
<DescribeImagesResponse> describeImages
(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) Returns metadata that's related to the images in a repository in a public registry.default CompletableFuture
<DescribeImagesResponse> describeImages
(DescribeImagesRequest describeImagesRequest) Returns metadata that's related to the images in a repository in a public registry.default DescribeImagesPublisher
describeImagesPaginator
(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) This is a variant ofdescribeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)
operation.default DescribeImagesPublisher
describeImagesPaginator
(DescribeImagesRequest describeImagesRequest) This is a variant ofdescribeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)
operation.describeImageTags
(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest) Returns the image tag details for a repository in a public registry.describeImageTags
(DescribeImageTagsRequest describeImageTagsRequest) Returns the image tag details for a repository in a public registry.default DescribeImageTagsPublisher
describeImageTagsPaginator
(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest) This is a variant ofdescribeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)
operation.default DescribeImageTagsPublisher
describeImageTagsPaginator
(DescribeImageTagsRequest describeImageTagsRequest) This is a variant ofdescribeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)
operation.describeRegistries
(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest) Returns details for a public registry.describeRegistries
(DescribeRegistriesRequest describeRegistriesRequest) Returns details for a public registry.default DescribeRegistriesPublisher
describeRegistriesPaginator
(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest) This is a variant ofdescribeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)
operation.default DescribeRegistriesPublisher
describeRegistriesPaginator
(DescribeRegistriesRequest describeRegistriesRequest) This is a variant ofdescribeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)
operation.describeRepositories
(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) Describes repositories that are in a public registry.describeRepositories
(DescribeRepositoriesRequest describeRepositoriesRequest) Describes repositories that are in a public registry.default DescribeRepositoriesPublisher
describeRepositoriesPaginator
(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) This is a variant ofdescribeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)
operation.default DescribeRepositoriesPublisher
describeRepositoriesPaginator
(DescribeRepositoriesRequest describeRepositoriesRequest) This is a variant ofdescribeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)
operation.getAuthorizationToken
(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest) Retrieves an authorization token.getAuthorizationToken
(GetAuthorizationTokenRequest getAuthorizationTokenRequest) Retrieves an authorization token.getRegistryCatalogData
(Consumer<GetRegistryCatalogDataRequest.Builder> getRegistryCatalogDataRequest) Retrieves catalog metadata for a public registry.getRegistryCatalogData
(GetRegistryCatalogDataRequest getRegistryCatalogDataRequest) Retrieves catalog metadata for a public registry.getRepositoryCatalogData
(Consumer<GetRepositoryCatalogDataRequest.Builder> getRepositoryCatalogDataRequest) Retrieve catalog metadata for a repository in a public registry.getRepositoryCatalogData
(GetRepositoryCatalogDataRequest getRepositoryCatalogDataRequest) Retrieve catalog metadata for a repository in a public registry.getRepositoryPolicy
(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest) Retrieves the repository policy for the specified repository.getRepositoryPolicy
(GetRepositoryPolicyRequest getRepositoryPolicyRequest) Retrieves the repository policy for the specified repository.initiateLayerUpload
(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest) Notifies Amazon ECR that you intend to upload an image layer.initiateLayerUpload
(InitiateLayerUploadRequest initiateLayerUploadRequest) Notifies Amazon ECR that you intend to upload an image layer.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags for an Amazon ECR Public resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List the tags for an Amazon ECR Public resource.default CompletableFuture
<PutImageResponse> putImage
(Consumer<PutImageRequest.Builder> putImageRequest) Creates or updates the image manifest and tags that are associated with an image.default CompletableFuture
<PutImageResponse> putImage
(PutImageRequest putImageRequest) Creates or updates the image manifest and tags that are associated with an image.putRegistryCatalogData
(Consumer<PutRegistryCatalogDataRequest.Builder> putRegistryCatalogDataRequest) Create or update the catalog data for a public registry.putRegistryCatalogData
(PutRegistryCatalogDataRequest putRegistryCatalogDataRequest) Create or update the catalog data for a public registry.putRepositoryCatalogData
(Consumer<PutRepositoryCatalogDataRequest.Builder> putRepositoryCatalogDataRequest) Creates or updates the catalog data for a repository in a public registry.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., ClientOverrideConfigurationsetRepositoryPolicy
(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest) Applies a repository policy to the specified public repository to control access permissions.setRepositoryPolicy
(SetRepositoryPolicyRequest setRepositoryPolicyRequest) Applies a repository policy to the specified public repository to control access permissions.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates the specified tags to a resource with the specifiedresourceArn
.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Associates the specified tags to a resource with the specifiedresourceArn
.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes specified tags from a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Deletes specified tags from a resource.default CompletableFuture
<UploadLayerPartResponse> uploadLayerPart
(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest) Uploads an image layer part to Amazon ECR.default CompletableFuture
<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 CompletableFuture<BatchCheckLayerAvailabilityResponse> batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) 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:
- A Java Future containing the result of the BatchCheckLayerAvailability operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RepositoryNotFoundException The specified repository can't be found. Check the spelling of the specified repository and ensure that you're 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 doesn't exist.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchCheckLayerAvailability
default CompletableFuture<BatchCheckLayerAvailabilityResponse> batchCheckLayerAvailability(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest) 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:
- A Java Future containing the result of the BatchCheckLayerAvailability operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RepositoryNotFoundException The specified repository can't be found. Check the spelling of the specified repository and ensure that you're 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 doesn't exist.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteImage
default CompletableFuture<BatchDeleteImageResponse> batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest) 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:
- A Java Future containing the result of the BatchDeleteImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteImage
default CompletableFuture<BatchDeleteImageResponse> batchDeleteImage(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest) 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:
- A Java Future containing the result of the BatchDeleteImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
completeLayerUpload
default CompletableFuture<CompleteLayerUploadResponse> completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest) 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:
- A Java Future containing the result of the CompleteLayerUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UploadNotFoundException The upload can't be found, or the specified upload ID isn't valid for this repository.
- InvalidLayerException The layer digest calculation performed by Amazon ECR when the image layer doesn't 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 doesn't contain any layer parts.
- RegistryNotFoundException The registry doesn't exist.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
completeLayerUpload
default CompletableFuture<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. 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:
- A Java Future containing the result of the CompleteLayerUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UploadNotFoundException The upload can't be found, or the specified upload ID isn't valid for this repository.
- InvalidLayerException The layer digest calculation performed by Amazon ECR when the image layer doesn't 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 doesn't contain any layer parts.
- RegistryNotFoundException The registry doesn't exist.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRepository
default CompletableFuture<CreateRepositoryResponse> 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:
- A Java Future containing the result of the CreateRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- InvalidTagParameterException An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
- TooManyTagsException The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
- RepositoryAlreadyExistsException The specified repository already exists in the specified registry.
- LimitExceededException The operation didn't 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.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createRepository
default CompletableFuture<CreateRepositoryResponse> createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) 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:
- A Java Future containing the result of the CreateRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- InvalidTagParameterException An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
- TooManyTagsException The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
- RepositoryAlreadyExistsException The specified repository already exists in the specified registry.
- LimitExceededException The operation didn't 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.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRepository
default CompletableFuture<DeleteRepositoryResponse> deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) 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:
- A Java Future containing the result of the DeleteRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're 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. - UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRepository
default CompletableFuture<DeleteRepositoryResponse> deleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) 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:
- A Java Future containing the result of the DeleteRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're 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. - UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRepositoryPolicy
default CompletableFuture<DeleteRepositoryPolicyResponse> deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) Deletes the repository policy that's associated with the specified repository.
- Parameters:
deleteRepositoryPolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteRepositoryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- RepositoryPolicyNotFoundException The specified repository and registry combination doesn't have an associated repository policy.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRepositoryPolicy
default CompletableFuture<DeleteRepositoryPolicyResponse> deleteRepositoryPolicy(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest) 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:
- A Java Future containing the result of the DeleteRepositoryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- RepositoryPolicyNotFoundException The specified repository and registry combination doesn't have an associated repository policy.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImageTags
default CompletableFuture<DescribeImageTagsResponse> describeImageTags(DescribeImageTagsRequest describeImageTagsRequest) Returns the image tag details for a repository in a public registry.
- Parameters:
describeImageTagsRequest
-- Returns:
- A Java Future containing the result of the DescribeImageTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImageTags
default CompletableFuture<DescribeImageTagsResponse> describeImageTags(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest) 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:
- A Java Future containing the result of the DescribeImageTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImageTagsPaginator
default DescribeImageTagsPublisher describeImageTagsPaginator(DescribeImageTagsRequest describeImageTagsRequest) This is a variant of
describeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsPublisher publisher = client.describeImageTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsPublisher publisher = client.describeImageTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImageTagsPaginator
default DescribeImageTagsPublisher describeImageTagsPaginator(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest) This is a variant of
describeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsPublisher publisher = client.describeImageTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsPublisher publisher = client.describeImageTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImages
default CompletableFuture<DescribeImagesResponse> describeImages(DescribeImagesRequest describeImagesRequest) 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:
- A Java Future containing the result of the DescribeImages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- ImageNotFoundException The image requested doesn't exist in the specified repository.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImages
default CompletableFuture<DescribeImagesResponse> describeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) 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:
- A Java Future containing the result of the DescribeImages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- ImageNotFoundException The image requested doesn't exist in the specified repository.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImagesPaginator
default DescribeImagesPublisher describeImagesPaginator(DescribeImagesRequest describeImagesRequest) This is a variant of
describeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecrpublic.model.DescribeImagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- ImageNotFoundException The image requested doesn't exist in the specified repository.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeImagesPaginator
default DescribeImagesPublisher describeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) This is a variant of
describeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecrpublic.model.DescribeImagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- ImageNotFoundException The image requested doesn't exist in the specified repository.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistries
default CompletableFuture<DescribeRegistriesResponse> describeRegistries(DescribeRegistriesRequest describeRegistriesRequest) Returns details for a public registry.
- Parameters:
describeRegistriesRequest
-- Returns:
- A Java Future containing the result of the DescribeRegistries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- UnsupportedCommandException The action isn't supported in this Region.
- ServerException These errors are usually caused by a server-side issue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistries
default CompletableFuture<DescribeRegistriesResponse> describeRegistries(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest) 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:
- A Java Future containing the result of the DescribeRegistries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- UnsupportedCommandException The action isn't supported in this Region.
- ServerException These errors are usually caused by a server-side issue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistriesPaginator
default DescribeRegistriesPublisher describeRegistriesPaginator(DescribeRegistriesRequest describeRegistriesRequest) This is a variant of
describeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesPublisher publisher = client.describeRegistriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesPublisher publisher = client.describeRegistriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- UnsupportedCommandException The action isn't supported in this Region.
- ServerException These errors are usually caused by a server-side issue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRegistriesPaginator
default DescribeRegistriesPublisher describeRegistriesPaginator(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest) This is a variant of
describeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesPublisher publisher = client.describeRegistriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesPublisher publisher = client.describeRegistriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- UnsupportedCommandException The action isn't supported in this Region.
- ServerException These errors are usually caused by a server-side issue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRepositories
default CompletableFuture<DescribeRepositoriesResponse> describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest) Describes repositories that are in a public registry.
- Parameters:
describeRepositoriesRequest
-- Returns:
- A Java Future containing the result of the DescribeRepositories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRepositories
default CompletableFuture<DescribeRepositoriesResponse> describeRepositories(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) 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:
- A Java Future containing the result of the DescribeRepositories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRepositoriesPaginator
default DescribeRepositoriesPublisher describeRepositoriesPaginator(DescribeRepositoriesRequest describeRepositoriesRequest) This is a variant of
describeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesPublisher publisher = client.describeRepositoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesPublisher publisher = client.describeRepositoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRepositoriesPaginator
default DescribeRepositoriesPublisher describeRepositoriesPaginator(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) This is a variant of
describeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesPublisher publisher = client.describeRepositoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesPublisher publisher = client.describeRepositoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAuthorizationToken
default CompletableFuture<GetAuthorizationTokenResponse> getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest) 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:
- A Java Future containing the result of the GetAuthorizationToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAuthorizationToken
default CompletableFuture<GetAuthorizationTokenResponse> getAuthorizationToken(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest) 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:
- A Java Future containing the result of the GetAuthorizationToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRegistryCatalogData
default CompletableFuture<GetRegistryCatalogDataResponse> getRegistryCatalogData(GetRegistryCatalogDataRequest getRegistryCatalogDataRequest) Retrieves catalog metadata for a public registry.
- Parameters:
getRegistryCatalogDataRequest
-- Returns:
- A Java Future containing the result of the GetRegistryCatalogData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRegistryCatalogData
default CompletableFuture<GetRegistryCatalogDataResponse> getRegistryCatalogData(Consumer<GetRegistryCatalogDataRequest.Builder> getRegistryCatalogDataRequest) 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:
- A Java Future containing the result of the GetRegistryCatalogData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRepositoryCatalogData
default CompletableFuture<GetRepositoryCatalogDataResponse> 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:
- A Java Future containing the result of the GetRepositoryCatalogData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RepositoryCatalogDataNotFoundException The repository catalog data doesn't exist.
- RepositoryNotFoundException The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRepositoryCatalogData
default CompletableFuture<GetRepositoryCatalogDataResponse> getRepositoryCatalogData(Consumer<GetRepositoryCatalogDataRequest.Builder> getRepositoryCatalogDataRequest) 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:
- A Java Future containing the result of the GetRepositoryCatalogData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- RepositoryCatalogDataNotFoundException The repository catalog data doesn't exist.
- RepositoryNotFoundException The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRepositoryPolicy
default CompletableFuture<GetRepositoryPolicyResponse> getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest) Retrieves the repository policy for the specified repository.
- Parameters:
getRepositoryPolicyRequest
-- Returns:
- A Java Future containing the result of the GetRepositoryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- RepositoryPolicyNotFoundException The specified repository and registry combination doesn't have an associated repository policy.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRepositoryPolicy
default CompletableFuture<GetRepositoryPolicyResponse> getRepositoryPolicy(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest) 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:
- A Java Future containing the result of the GetRepositoryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- RepositoryPolicyNotFoundException The specified repository and registry combination doesn't have an associated repository policy.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
initiateLayerUpload
default CompletableFuture<InitiateLayerUploadResponse> 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 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:
- A Java Future containing the result of the InitiateLayerUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- RegistryNotFoundException The registry doesn't exist.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
initiateLayerUpload
default CompletableFuture<InitiateLayerUploadResponse> initiateLayerUpload(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest) 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:
- A Java Future containing the result of the InitiateLayerUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- RegistryNotFoundException The registry doesn't exist.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List the tags for an Amazon ECR Public resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- ServerException These errors are usually caused by a server-side issue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) 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:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- ServerException These errors are usually caused by a server-side issue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putImage
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:
- A Java Future containing the result of the PutImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're 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 can't be found, or the specified layer isn't valid for this repository.
- ReferencedImagesNotFoundException The manifest list is referencing an image that doesn't exist.
- LimitExceededException The operation didn't 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 doesn't match the digest that Amazon ECR calculated for the image.
- RegistryNotFoundException The registry doesn't exist.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putImage
default CompletableFuture<PutImageResponse> putImage(Consumer<PutImageRequest.Builder> putImageRequest) 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:
- A Java Future containing the result of the PutImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're 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 can't be found, or the specified layer isn't valid for this repository.
- ReferencedImagesNotFoundException The manifest list is referencing an image that doesn't exist.
- LimitExceededException The operation didn't 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 doesn't match the digest that Amazon ECR calculated for the image.
- RegistryNotFoundException The registry doesn't exist.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRegistryCatalogData
default CompletableFuture<PutRegistryCatalogDataResponse> putRegistryCatalogData(PutRegistryCatalogDataRequest putRegistryCatalogDataRequest) Create or update the catalog data for a public registry.
- Parameters:
putRegistryCatalogDataRequest
-- Returns:
- A Java Future containing the result of the PutRegistryCatalogData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRegistryCatalogData
default CompletableFuture<PutRegistryCatalogDataResponse> putRegistryCatalogData(Consumer<PutRegistryCatalogDataRequest.Builder> putRegistryCatalogDataRequest) 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:
- A Java Future containing the result of the PutRegistryCatalogData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRepositoryCatalogData
default CompletableFuture<PutRepositoryCatalogDataResponse> putRepositoryCatalogData(PutRepositoryCatalogDataRequest putRepositoryCatalogDataRequest) Creates or updates the catalog data for a repository in a public registry.
- Parameters:
putRepositoryCatalogDataRequest
-- Returns:
- A Java Future containing the result of the PutRepositoryCatalogData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRepositoryCatalogData
default CompletableFuture<PutRepositoryCatalogDataResponse> putRepositoryCatalogData(Consumer<PutRepositoryCatalogDataRequest.Builder> putRepositoryCatalogDataRequest) 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:
- A Java Future containing the result of the PutRepositoryCatalogData operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setRepositoryPolicy
default CompletableFuture<SetRepositoryPolicyResponse> 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:
- A Java Future containing the result of the SetRepositoryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
setRepositoryPolicy
default CompletableFuture<SetRepositoryPolicyResponse> setRepositoryPolicy(Consumer<SetRepositoryPolicyRequest.Builder> 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.
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:
- A Java Future containing the result of the SetRepositoryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- InvalidTagParameterException An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
- TooManyTagsException The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
- RepositoryNotFoundException The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- ServerException These errors are usually caused by a server-side issue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) 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:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- InvalidTagParameterException An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
- TooManyTagsException The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
- RepositoryNotFoundException The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- ServerException These errors are usually caused by a server-side issue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Deletes specified tags from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- InvalidTagParameterException An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
- TooManyTagsException The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
- RepositoryNotFoundException The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- ServerException These errors are usually caused by a server-side issue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) 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:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- InvalidTagParameterException An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
- TooManyTagsException The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
- RepositoryNotFoundException The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UnsupportedCommandException The action isn't supported in this Region.
- ServerException These errors are usually caused by a server-side issue.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
uploadLayerPart
default CompletableFuture<UploadLayerPartResponse> 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 (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:
- A Java Future containing the result of the UploadLayerPart operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 isn't valid, or the first byte specified isn't consecutive to the last byte of a previous layer part upload.
- RepositoryNotFoundException The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UploadNotFoundException The upload can't be found, or the specified upload ID isn't valid for this repository.
- LimitExceededException The operation didn't 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 doesn't exist.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
uploadLayerPart
default CompletableFuture<UploadLayerPartResponse> uploadLayerPart(Consumer<UploadLayerPartRequest.Builder> 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 (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:
- A Java Future containing the result of the UploadLayerPart operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 isn't valid, or the first byte specified isn't consecutive to the last byte of a previous layer part upload.
- RepositoryNotFoundException The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
- UploadNotFoundException The upload can't be found, or the specified upload ID isn't valid for this repository.
- LimitExceededException The operation didn't 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 doesn't exist.
- UnsupportedCommandException The action isn't supported in this Region.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- EcrPublicException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
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
-
create
Create aEcrPublicAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aEcrPublicAsyncClient
.
-