@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface EcrPublicClient extends AwsClient
builder() method.
Amazon Elastic Container Registry Public (Amazon ECR Public) is a managed container image registry service. Amazon ECR provides both public and private registries to host your container images. You can use the Docker CLI or your preferred client to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR supports public repositories with this API. For information about the Amazon ECR API for private repositories, see Amazon Elastic Container Registry API Reference.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default BatchCheckLayerAvailabilityResponse |
batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest)
Checks the availability of one or more image layers that are within a repository in a public registry.
|
default BatchCheckLayerAvailabilityResponse |
batchCheckLayerAvailability(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest)
Checks the availability of one or more image layers that are within a repository in a public registry.
|
default BatchDeleteImageResponse |
batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest)
Deletes a list of specified images that are within a repository in a public registry.
|
default BatchDeleteImageResponse |
batchDeleteImage(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest)
Deletes a list of specified images that are within a repository in a public registry.
|
static EcrPublicClientBuilder |
builder()
Create a builder that can be used to configure and create a
EcrPublicClient. |
default CompleteLayerUploadResponse |
completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest)
Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and
upload ID.
|
default CompleteLayerUploadResponse |
completeLayerUpload(Consumer<CompleteLayerUploadRequest.Builder> completeLayerUploadRequest)
Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and
upload ID.
|
static EcrPublicClient |
create()
Create a
EcrPublicClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateRepositoryResponse |
createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest)
Creates a repository in a public registry.
|
default CreateRepositoryResponse |
createRepository(CreateRepositoryRequest createRepositoryRequest)
Creates a repository in a public registry.
|
default DeleteRepositoryResponse |
deleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest)
Deletes a repository in a public registry.
|
default DeleteRepositoryResponse |
deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)
Deletes a repository in a public registry.
|
default DeleteRepositoryPolicyResponse |
deleteRepositoryPolicy(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest)
Deletes the repository policy that's associated with the specified repository.
|
default DeleteRepositoryPolicyResponse |
deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest)
Deletes the repository policy that's associated with the specified repository.
|
default DescribeImagesResponse |
describeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest)
Returns metadata that's related to the images in a repository in a public registry.
|
default DescribeImagesResponse |
describeImages(DescribeImagesRequest describeImagesRequest)
Returns metadata that's related to the images in a repository in a public registry.
|
default DescribeImagesIterable |
describeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest)
Returns metadata that's related to the images in a repository in a public registry.
|
default DescribeImagesIterable |
describeImagesPaginator(DescribeImagesRequest describeImagesRequest)
Returns metadata that's related to the images in a repository in a public registry.
|
default DescribeImageTagsResponse |
describeImageTags(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest)
Returns the image tag details for a repository in a public registry.
|
default DescribeImageTagsResponse |
describeImageTags(DescribeImageTagsRequest describeImageTagsRequest)
Returns the image tag details for a repository in a public registry.
|
default DescribeImageTagsIterable |
describeImageTagsPaginator(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest)
Returns the image tag details for a repository in a public registry.
|
default DescribeImageTagsIterable |
describeImageTagsPaginator(DescribeImageTagsRequest describeImageTagsRequest)
Returns the image tag details for a repository in a public registry.
|
default DescribeRegistriesResponse |
describeRegistries(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest)
Returns details for a public registry.
|
default DescribeRegistriesResponse |
describeRegistries(DescribeRegistriesRequest describeRegistriesRequest)
Returns details for a public registry.
|
default DescribeRegistriesIterable |
describeRegistriesPaginator(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest)
Returns details for a public registry.
|
default DescribeRegistriesIterable |
describeRegistriesPaginator(DescribeRegistriesRequest describeRegistriesRequest)
Returns details for a public registry.
|
default DescribeRepositoriesResponse |
describeRepositories(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest)
Describes repositories that are in a public registry.
|
default DescribeRepositoriesResponse |
describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest)
Describes repositories that are in a public registry.
|
default DescribeRepositoriesIterable |
describeRepositoriesPaginator(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest)
Describes repositories that are in a public registry.
|
default DescribeRepositoriesIterable |
describeRepositoriesPaginator(DescribeRepositoriesRequest describeRepositoriesRequest)
Describes repositories that are in a public registry.
|
default GetAuthorizationTokenResponse |
getAuthorizationToken(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest)
Retrieves an authorization token.
|
default GetAuthorizationTokenResponse |
getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest)
Retrieves an authorization token.
|
default GetRegistryCatalogDataResponse |
getRegistryCatalogData(Consumer<GetRegistryCatalogDataRequest.Builder> getRegistryCatalogDataRequest)
Retrieves catalog metadata for a public registry.
|
default GetRegistryCatalogDataResponse |
getRegistryCatalogData(GetRegistryCatalogDataRequest getRegistryCatalogDataRequest)
Retrieves catalog metadata for a public registry.
|
default GetRepositoryCatalogDataResponse |
getRepositoryCatalogData(Consumer<GetRepositoryCatalogDataRequest.Builder> getRepositoryCatalogDataRequest)
Retrieve catalog metadata for a repository in a public registry.
|
default GetRepositoryCatalogDataResponse |
getRepositoryCatalogData(GetRepositoryCatalogDataRequest getRepositoryCatalogDataRequest)
Retrieve catalog metadata for a repository in a public registry.
|
default GetRepositoryPolicyResponse |
getRepositoryPolicy(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest)
Retrieves the repository policy for the specified repository.
|
default GetRepositoryPolicyResponse |
getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest)
Retrieves the repository policy for the specified repository.
|
default InitiateLayerUploadResponse |
initiateLayerUpload(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest)
Notifies Amazon ECR that you intend to upload an image layer.
|
default InitiateLayerUploadResponse |
initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest)
Notifies Amazon ECR that you intend to upload an image layer.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List the tags for an Amazon ECR Public resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for an Amazon ECR Public resource.
|
default PutImageResponse |
putImage(Consumer<PutImageRequest.Builder> putImageRequest)
Creates or updates the image manifest and tags that are associated with an image.
|
default PutImageResponse |
putImage(PutImageRequest putImageRequest)
Creates or updates the image manifest and tags that are associated with an image.
|
default PutRegistryCatalogDataResponse |
putRegistryCatalogData(Consumer<PutRegistryCatalogDataRequest.Builder> putRegistryCatalogDataRequest)
Create or update the catalog data for a public registry.
|
default PutRegistryCatalogDataResponse |
putRegistryCatalogData(PutRegistryCatalogDataRequest putRegistryCatalogDataRequest)
Create or update the catalog data for a public registry.
|
default PutRepositoryCatalogDataResponse |
putRepositoryCatalogData(Consumer<PutRepositoryCatalogDataRequest.Builder> putRepositoryCatalogDataRequest)
Creates or updates the catalog data for a repository in a public registry.
|
default PutRepositoryCatalogDataResponse |
putRepositoryCatalogData(PutRepositoryCatalogDataRequest putRepositoryCatalogDataRequest)
Creates or updates the catalog data for a repository in a public registry.
|
default EcrPublicServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default SetRepositoryPolicyResponse |
setRepositoryPolicy(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest)
Applies a repository policy to the specified public repository to control access permissions.
|
default SetRepositoryPolicyResponse |
setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest)
Applies a repository policy to the specified public repository to control access permissions.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associates the specified tags to a resource with the specified
resourceArn. |
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Associates the specified tags to a resource with the specified
resourceArn. |
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Deletes specified tags from a resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes specified tags from a resource.
|
default UploadLayerPartResponse |
uploadLayerPart(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest)
Uploads an image layer part to Amazon ECR.
|
default UploadLayerPartResponse |
uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest)
Uploads an image layer part to Amazon ECR.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default BatchCheckLayerAvailabilityResponse batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) throws RepositoryNotFoundException, InvalidParameterException, ServerException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Checks the availability of one or more image layers that are within a repository in a public registry. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
batchCheckLayerAvailabilityRequest - 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.AwsServiceExceptiondefault BatchCheckLayerAvailabilityResponse batchCheckLayerAvailability(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest) throws RepositoryNotFoundException, InvalidParameterException, ServerException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Checks the availability of one or more image layers that are within a repository in a public registry. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
This is a convenience which creates an instance of the BatchCheckLayerAvailabilityRequest.Builder
avoiding the need to create one manually via BatchCheckLayerAvailabilityRequest.builder()
batchCheckLayerAvailabilityRequest - A Consumer that will call methods on
BatchCheckLayerAvailabilityRequest.Builder to
create a 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.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.AwsServiceExceptiondefault BatchDeleteImageResponse batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Deletes a list of specified images that are within a repository in a public registry. Images are specified with
either an imageTag or imageDigest.
You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
You can completely delete an image (and all of its tags) by specifying the digest of the image in your request.
batchDeleteImageRequest - 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.AwsServiceExceptiondefault BatchDeleteImageResponse batchDeleteImage(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Deletes a list of specified images that are within a repository in a public registry. Images are specified with
either an imageTag or imageDigest.
You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
You can completely delete an image (and all of its tags) by specifying the 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 via BatchDeleteImageRequest.builder()
batchDeleteImageRequest - A Consumer that will call methods on
BatchDeleteImageRequest.Builder to create a
request.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.AwsServiceExceptiondefault CompleteLayerUploadResponse completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UploadNotFoundException, InvalidLayerException, LayerPartTooSmallException, LayerAlreadyExistsException, EmptyUploadException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and
upload ID. You can optionally provide a sha256 digest of the image layer for data validation
purposes.
When an image is pushed, the CompleteLayerUpload API is called once for each new image layer to verify that the upload is complete.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
completeLayerUploadRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository 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.AwsServiceExceptiondefault CompleteLayerUploadResponse completeLayerUpload(Consumer<CompleteLayerUploadRequest.Builder> completeLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UploadNotFoundException, InvalidLayerException, LayerPartTooSmallException, LayerAlreadyExistsException, EmptyUploadException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and
upload ID. You can optionally provide a sha256 digest of the image layer for data validation
purposes.
When an image is pushed, the CompleteLayerUpload API is called once for each new image layer to verify that the upload is complete.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
This is a convenience which creates an instance of the CompleteLayerUploadRequest.Builder avoiding the
need to create one manually via CompleteLayerUploadRequest.builder()
completeLayerUploadRequest - A Consumer that will call methods on
CompleteLayerUploadRequest.Builder to create a
request.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.AwsServiceExceptiondefault CreateRepositoryResponse createRepository(CreateRepositoryRequest createRepositoryRequest) throws ServerException, InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryAlreadyExistsException, LimitExceededException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
createRepositoryRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.AwsServiceExceptiondefault CreateRepositoryResponse createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) throws ServerException, InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryAlreadyExistsException, LimitExceededException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the CreateRepositoryRequest.Builder avoiding the need
to create one manually via CreateRepositoryRequest.builder()
createRepositoryRequest - A Consumer that will call methods on
CreateRepositoryRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeleteRepositoryResponse deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryNotEmptyException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Deletes a repository in a public registry. If the repository contains images, you must either manually delete all
images in the repository or use the force option. This option deletes all images on your behalf
before deleting the repository.
deleteRepositoryRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository 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.AwsServiceExceptiondefault DeleteRepositoryResponse deleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryNotEmptyException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Deletes a repository in a public registry. If the repository contains images, you must either manually delete all
images in the repository or use the force option. This option deletes all images on your behalf
before deleting the repository.
This is a convenience which creates an instance of the DeleteRepositoryRequest.Builder avoiding the need
to create one manually via DeleteRepositoryRequest.builder()
deleteRepositoryRequest - A Consumer that will call methods on
DeleteRepositoryRequest.Builder to create a
request.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.AwsServiceExceptiondefault DeleteRepositoryPolicyResponse deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Deletes the repository policy that's associated with the specified repository.
deleteRepositoryPolicyRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository 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.AwsServiceExceptiondefault DeleteRepositoryPolicyResponse deleteRepositoryPolicy(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Deletes the repository policy that's associated with the specified repository.
This is a convenience which creates an instance of the DeleteRepositoryPolicyRequest.Builder avoiding the
need to create one manually via DeleteRepositoryPolicyRequest.builder()
deleteRepositoryPolicyRequest - A Consumer that will call methods on
DeleteRepositoryPolicyRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeImageTagsResponse describeImageTags(DescribeImageTagsRequest describeImageTagsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Returns the image tag details for a repository in a public registry.
describeImageTagsRequest - 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.AwsServiceExceptiondefault DescribeImageTagsResponse describeImageTags(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Returns the image tag details for a repository in a public registry.
This is a convenience which creates an instance of the DescribeImageTagsRequest.Builder avoiding the need
to create one manually via DescribeImageTagsRequest.builder()
describeImageTagsRequest - A Consumer that will call methods on
DescribeImageTagsRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeImageTagsIterable describeImageTagsPaginator(DescribeImageTagsRequest describeImageTagsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Returns the image tag details for a repository in a public registry.
This is a variant of
describeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client.describeImageTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client
.describeImageTagsPaginator(request);
for (software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client.describeImageTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)
operation.
describeImageTagsRequest - 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.AwsServiceExceptiondefault DescribeImageTagsIterable describeImageTagsPaginator(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Returns the image tag details for a repository in a public registry.
This is a variant of
describeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client.describeImageTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client
.describeImageTagsPaginator(request);
for (software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client.describeImageTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)
operation.
This is a convenience which creates an instance of the DescribeImageTagsRequest.Builder avoiding the need
to create one manually via DescribeImageTagsRequest.builder()
describeImageTagsRequest - A Consumer that will call methods on
DescribeImageTagsRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeImagesResponse describeImages(DescribeImagesRequest describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Returns metadata that's related to the images in a repository in a public registry.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker
registry. The output of the docker images command shows the uncompressed image size. Therefore, it
might return a larger image size than the image sizes that are returned by DescribeImages.
describeImagesRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository 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.AwsServiceExceptiondefault DescribeImagesResponse describeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Returns metadata that's related to the images in a repository in a public registry.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker
registry. The output of the docker images command shows the uncompressed image size. Therefore, it
might return a larger image size than the image sizes that are returned by DescribeImages.
This is a convenience which creates an instance of the DescribeImagesRequest.Builder avoiding the need to
create one manually via DescribeImagesRequest.builder()
describeImagesRequest - A Consumer that will call methods on
DescribeImagesRequest.Builder to create a request.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.AwsServiceExceptiondefault DescribeImagesIterable describeImagesPaginator(DescribeImagesRequest describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Returns metadata that's related to the images in a repository in a public registry.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker
registry. The output of the docker images command shows the uncompressed image size. Therefore, it
might return a larger image size than the image sizes that are returned by DescribeImages.
This is a variant of
describeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client
.describeImagesPaginator(request);
for (software.amazon.awssdk.services.ecrpublic.model.DescribeImagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest) operation.
describeImagesRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository 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.AwsServiceExceptiondefault DescribeImagesIterable describeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Returns metadata that's related to the images in a repository in a public registry.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker
registry. The output of the docker images command shows the uncompressed image size. Therefore, it
might return a larger image size than the image sizes that are returned by DescribeImages.
This is a variant of
describeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client
.describeImagesPaginator(request);
for (software.amazon.awssdk.services.ecrpublic.model.DescribeImagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest) operation.
This is a convenience which creates an instance of the DescribeImagesRequest.Builder avoiding the need to
create one manually via DescribeImagesRequest.builder()
describeImagesRequest - A Consumer that will call methods on
DescribeImagesRequest.Builder to create a request.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.AwsServiceExceptiondefault DescribeRegistriesResponse describeRegistries(DescribeRegistriesRequest describeRegistriesRequest) throws InvalidParameterException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
Returns details for a public registry.
describeRegistriesRequest - 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.AwsServiceExceptiondefault DescribeRegistriesResponse describeRegistries(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest) throws InvalidParameterException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
Returns details for a public registry.
This is a convenience which creates an instance of the DescribeRegistriesRequest.Builder avoiding the
need to create one manually via DescribeRegistriesRequest.builder()
describeRegistriesRequest - A Consumer that will call methods on
DescribeRegistriesRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeRegistriesIterable describeRegistriesPaginator(DescribeRegistriesRequest describeRegistriesRequest) throws InvalidParameterException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
Returns details for a public registry.
This is a variant of
describeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client.describeRegistriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client
.describeRegistriesPaginator(request);
for (software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client.describeRegistriesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)
operation.
describeRegistriesRequest - 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.AwsServiceExceptiondefault DescribeRegistriesIterable describeRegistriesPaginator(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest) throws InvalidParameterException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
Returns details for a public registry.
This is a variant of
describeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client.describeRegistriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client
.describeRegistriesPaginator(request);
for (software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client.describeRegistriesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)
operation.
This is a convenience which creates an instance of the DescribeRegistriesRequest.Builder avoiding the
need to create one manually via DescribeRegistriesRequest.builder()
describeRegistriesRequest - A Consumer that will call methods on
DescribeRegistriesRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeRepositoriesResponse describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Describes repositories that are in a public registry.
describeRepositoriesRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository 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.AwsServiceExceptiondefault DescribeRepositoriesResponse describeRepositories(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Describes repositories that are in a public registry.
This is a convenience which creates an instance of the DescribeRepositoriesRequest.Builder avoiding the
need to create one manually via DescribeRepositoriesRequest.builder()
describeRepositoriesRequest - A Consumer that will call methods on
DescribeRepositoriesRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeRepositoriesIterable describeRepositoriesPaginator(DescribeRepositoriesRequest describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Describes repositories that are in a public registry.
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client
.describeRepositoriesPaginator(request);
for (software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)
operation.
describeRepositoriesRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository 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.AwsServiceExceptiondefault DescribeRepositoriesIterable describeRepositoriesPaginator(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Describes repositories that are in a public registry.
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client
.describeRepositoriesPaginator(request);
for (software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)
operation.
This is a convenience which creates an instance of the DescribeRepositoriesRequest.Builder avoiding the
need to create one manually via DescribeRepositoriesRequest.builder()
describeRepositoriesRequest - A Consumer that will call methods on
DescribeRepositoriesRequest.Builder to create a
request.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.AwsServiceExceptiondefault GetAuthorizationTokenResponse getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest) throws ServerException, InvalidParameterException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieves an authorization token. An authorization token represents your IAM authentication credentials. You can
use it to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid
for 12 hours. This API requires the ecr-public:GetAuthorizationToken and
sts:GetServiceBearerToken permissions.
getAuthorizationTokenRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.AwsServiceExceptiondefault GetAuthorizationTokenResponse getAuthorizationToken(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest) throws ServerException, InvalidParameterException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieves an authorization token. An authorization token represents your IAM authentication credentials. You can
use it to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid
for 12 hours. This API requires the ecr-public:GetAuthorizationToken and
sts:GetServiceBearerToken permissions.
This is a convenience which creates an instance of the GetAuthorizationTokenRequest.Builder avoiding the
need to create one manually via GetAuthorizationTokenRequest.builder()
getAuthorizationTokenRequest - A Consumer that will call methods on
GetAuthorizationTokenRequest.Builder to create a
request.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.AwsServiceExceptiondefault GetRegistryCatalogDataResponse getRegistryCatalogData(GetRegistryCatalogDataRequest getRegistryCatalogDataRequest) throws ServerException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieves catalog metadata for a public registry.
getRegistryCatalogDataRequest - 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.AwsServiceExceptiondefault GetRegistryCatalogDataResponse getRegistryCatalogData(Consumer<GetRegistryCatalogDataRequest.Builder> getRegistryCatalogDataRequest) throws ServerException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieves catalog metadata for a public registry.
This is a convenience which creates an instance of the GetRegistryCatalogDataRequest.Builder avoiding the
need to create one manually via GetRegistryCatalogDataRequest.builder()
getRegistryCatalogDataRequest - A Consumer that will call methods on
GetRegistryCatalogDataRequest.Builder to create a
request.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.AwsServiceExceptiondefault GetRepositoryCatalogDataResponse getRepositoryCatalogData(GetRepositoryCatalogDataRequest getRepositoryCatalogDataRequest) throws ServerException, InvalidParameterException, RepositoryCatalogDataNotFoundException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.
getRepositoryCatalogDataRequest - 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.AwsServiceExceptiondefault GetRepositoryCatalogDataResponse getRepositoryCatalogData(Consumer<GetRepositoryCatalogDataRequest.Builder> getRepositoryCatalogDataRequest) throws ServerException, InvalidParameterException, RepositoryCatalogDataNotFoundException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.
This is a convenience which creates an instance of the GetRepositoryCatalogDataRequest.Builder avoiding
the need to create one manually via GetRepositoryCatalogDataRequest.builder()
getRepositoryCatalogDataRequest - A Consumer that will call methods on
GetRepositoryCatalogDataRequest.Builder to create
a request.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.AwsServiceExceptiondefault GetRepositoryPolicyResponse getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieves the repository policy for the specified repository.
getRepositoryPolicyRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository 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.AwsServiceExceptiondefault GetRepositoryPolicyResponse getRepositoryPolicy(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieves the repository policy for the specified repository.
This is a convenience which creates an instance of the GetRepositoryPolicyRequest.Builder avoiding the
need to create one manually via GetRepositoryPolicyRequest.builder()
getRepositoryPolicyRequest - A Consumer that will call methods on
GetRepositoryPolicyRequest.Builder to create a
request.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.AwsServiceExceptiondefault InitiateLayerUploadResponse initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once for each image layer that hasn't already been uploaded. Whether an image layer uploads is determined by the BatchCheckLayerAvailability API action.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
initiateLayerUploadRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository 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.AwsServiceExceptiondefault InitiateLayerUploadResponse initiateLayerUpload(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once for each image layer that hasn't already been uploaded. Whether an image layer uploads is determined by the BatchCheckLayerAvailability API action.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
This is a convenience which creates an instance of the InitiateLayerUploadRequest.Builder avoiding the
need to create one manually via InitiateLayerUploadRequest.builder()
initiateLayerUploadRequest - A Consumer that will call methods on
InitiateLayerUploadRequest.Builder to create a
request.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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
List the tags for an Amazon ECR Public resource.
listTagsForResourceRequest - 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.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
List the tags for an Amazon ECR Public resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.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.AwsServiceExceptiondefault PutImageResponse putImage(PutImageRequest putImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageAlreadyExistsException, LayersNotFoundException, ReferencedImagesNotFoundException, LimitExceededException, ImageTagAlreadyExistsException, ImageDigestDoesNotMatchException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Creates or updates the image manifest and tags that are associated with an image.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags that are associated with the image.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
putImageRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository 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.AwsServiceExceptiondefault PutImageResponse putImage(Consumer<PutImageRequest.Builder> putImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageAlreadyExistsException, LayersNotFoundException, ReferencedImagesNotFoundException, LimitExceededException, ImageTagAlreadyExistsException, ImageDigestDoesNotMatchException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Creates or updates the image manifest and tags that are associated with an image.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags that are associated with the image.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
This is a convenience which creates an instance of the PutImageRequest.Builder avoiding the need to
create one manually via PutImageRequest.builder()
putImageRequest - A Consumer that will call methods on
PutImageRequest.Builder to create a request.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.AwsServiceExceptiondefault PutRegistryCatalogDataResponse putRegistryCatalogData(PutRegistryCatalogDataRequest putRegistryCatalogDataRequest) throws ServerException, InvalidParameterException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Create or update the catalog data for a public registry.
putRegistryCatalogDataRequest - 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.AwsServiceExceptiondefault PutRegistryCatalogDataResponse putRegistryCatalogData(Consumer<PutRegistryCatalogDataRequest.Builder> putRegistryCatalogDataRequest) throws ServerException, InvalidParameterException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Create or update the catalog data for a public registry.
This is a convenience which creates an instance of the PutRegistryCatalogDataRequest.Builder avoiding the
need to create one manually via PutRegistryCatalogDataRequest.builder()
putRegistryCatalogDataRequest - A Consumer that will call methods on
PutRegistryCatalogDataRequest.Builder to create a
request.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.AwsServiceExceptiondefault PutRepositoryCatalogDataResponse putRepositoryCatalogData(PutRepositoryCatalogDataRequest putRepositoryCatalogDataRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Creates or updates the catalog data for a repository in a public registry.
putRepositoryCatalogDataRequest - 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.AwsServiceExceptiondefault PutRepositoryCatalogDataResponse putRepositoryCatalogData(Consumer<PutRepositoryCatalogDataRequest.Builder> putRepositoryCatalogDataRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Creates or updates the catalog data for a repository in a public registry.
This is a convenience which creates an instance of the PutRepositoryCatalogDataRequest.Builder avoiding
the need to create one manually via PutRepositoryCatalogDataRequest.builder()
putRepositoryCatalogDataRequest - A Consumer that will call methods on
PutRepositoryCatalogDataRequest.Builder to create
a request.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.AwsServiceExceptiondefault SetRepositoryPolicyResponse setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Applies a repository policy to the specified public repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.
setRepositoryPolicyRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository 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.AwsServiceExceptiondefault SetRepositoryPolicyResponse setRepositoryPolicy(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Applies a repository policy to the specified public repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the SetRepositoryPolicyRequest.Builder avoiding the
need to create one manually via SetRepositoryPolicyRequest.builder()
setRepositoryPolicyRequest - A Consumer that will call methods on
SetRepositoryPolicyRequest.Builder to create a
request.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a
resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags
associated with that resource are also deleted.
tagResourceRequest - 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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a
resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags
associated with that resource are also deleted.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
Deletes specified tags from a resource.
untagResourceRequest - 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
Deletes specified tags from a resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault UploadLayerPartResponse uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest) throws ServerException, InvalidParameterException, InvalidLayerPartException, RepositoryNotFoundException, UploadNotFoundException, LimitExceededException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Uploads an image layer part to Amazon ECR.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (about 20MB). The UploadLayerPart API is called once for each new image layer part.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
uploadLayerPartRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.InvalidLayerPartException - The layer part size 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.AwsServiceExceptiondefault UploadLayerPartResponse uploadLayerPart(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest) throws ServerException, InvalidParameterException, InvalidLayerPartException, RepositoryNotFoundException, UploadNotFoundException, LimitExceededException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Uploads an image layer part to Amazon ECR.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (about 20MB). The UploadLayerPart API is called once for each new image layer part.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
This is a convenience which creates an instance of the UploadLayerPartRequest.Builder avoiding the need
to create one manually via UploadLayerPartRequest.builder()
uploadLayerPartRequest - A Consumer that will call methods on
UploadLayerPartRequest.Builder to create a
request.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.AwsServiceExceptionstatic EcrPublicClient create()
EcrPublicClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static EcrPublicClientBuilder builder()
EcrPublicClient.static ServiceMetadata serviceMetadata()
default EcrPublicServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.