Interface EcrPublicClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface EcrPublicClient extends AwsClient
Service client for accessing Amazon ECR Public. This can be created using the staticbuilder()method.Amazon Elastic Container Registry Public Amazon Elastic Container Registry Public (Amazon ECR Public) is a managed container image registry service. Amazon ECR provides both public and private registries to host your container images. You can use the Docker CLI or your preferred client to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR supports public repositories with this API. For information about the Amazon ECR API for private repositories, see Amazon Elastic Container Registry API Reference.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default BatchCheckLayerAvailabilityResponsebatchCheckLayerAvailability(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest)Checks the availability of one or more image layers that are within a repository in a public registry.default BatchCheckLayerAvailabilityResponsebatchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest)Checks the availability of one or more image layers that are within a repository in a public registry.default BatchDeleteImageResponsebatchDeleteImage(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest)Deletes a list of specified images that are within a repository in a public registry.default BatchDeleteImageResponsebatchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest)Deletes a list of specified images that are within a repository in a public registry.static EcrPublicClientBuilderbuilder()Create a builder that can be used to configure and create aEcrPublicClient.default CompleteLayerUploadResponsecompleteLayerUpload(Consumer<CompleteLayerUploadRequest.Builder> completeLayerUploadRequest)Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and upload ID.default CompleteLayerUploadResponsecompleteLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest)Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and upload ID.static EcrPublicClientcreate()Create aEcrPublicClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateRepositoryResponsecreateRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest)Creates a repository in a public registry.default CreateRepositoryResponsecreateRepository(CreateRepositoryRequest createRepositoryRequest)Creates a repository in a public registry.default DeleteRepositoryResponsedeleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest)Deletes a repository in a public registry.default DeleteRepositoryResponsedeleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)Deletes a repository in a public registry.default DeleteRepositoryPolicyResponsedeleteRepositoryPolicy(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest)Deletes the repository policy that's associated with the specified repository.default DeleteRepositoryPolicyResponsedeleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest)Deletes the repository policy that's associated with the specified repository.default DescribeImagesResponsedescribeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest)Returns metadata that's related to the images in a repository in a public registry.default DescribeImagesResponsedescribeImages(DescribeImagesRequest describeImagesRequest)Returns metadata that's related to the images in a repository in a public registry.default DescribeImagesIterabledescribeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest)This is a variant ofdescribeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)operation.default DescribeImagesIterabledescribeImagesPaginator(DescribeImagesRequest describeImagesRequest)This is a variant ofdescribeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)operation.default DescribeImageTagsResponsedescribeImageTags(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest)Returns the image tag details for a repository in a public registry.default DescribeImageTagsResponsedescribeImageTags(DescribeImageTagsRequest describeImageTagsRequest)Returns the image tag details for a repository in a public registry.default DescribeImageTagsIterabledescribeImageTagsPaginator(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest)This is a variant ofdescribeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)operation.default DescribeImageTagsIterabledescribeImageTagsPaginator(DescribeImageTagsRequest describeImageTagsRequest)This is a variant ofdescribeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)operation.default DescribeRegistriesResponsedescribeRegistries(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest)Returns details for a public registry.default DescribeRegistriesResponsedescribeRegistries(DescribeRegistriesRequest describeRegistriesRequest)Returns details for a public registry.default DescribeRegistriesIterabledescribeRegistriesPaginator(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest)This is a variant ofdescribeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)operation.default DescribeRegistriesIterabledescribeRegistriesPaginator(DescribeRegistriesRequest describeRegistriesRequest)This is a variant ofdescribeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)operation.default DescribeRepositoriesResponsedescribeRepositories(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest)Describes repositories that are in a public registry.default DescribeRepositoriesResponsedescribeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest)Describes repositories that are in a public registry.default DescribeRepositoriesIterabledescribeRepositoriesPaginator(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest)This is a variant ofdescribeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)operation.default DescribeRepositoriesIterabledescribeRepositoriesPaginator(DescribeRepositoriesRequest describeRepositoriesRequest)This is a variant ofdescribeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)operation.default GetAuthorizationTokenResponsegetAuthorizationToken(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest)Retrieves an authorization token.default GetAuthorizationTokenResponsegetAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest)Retrieves an authorization token.default GetRegistryCatalogDataResponsegetRegistryCatalogData(Consumer<GetRegistryCatalogDataRequest.Builder> getRegistryCatalogDataRequest)Retrieves catalog metadata for a public registry.default GetRegistryCatalogDataResponsegetRegistryCatalogData(GetRegistryCatalogDataRequest getRegistryCatalogDataRequest)Retrieves catalog metadata for a public registry.default GetRepositoryCatalogDataResponsegetRepositoryCatalogData(Consumer<GetRepositoryCatalogDataRequest.Builder> getRepositoryCatalogDataRequest)Retrieve catalog metadata for a repository in a public registry.default GetRepositoryCatalogDataResponsegetRepositoryCatalogData(GetRepositoryCatalogDataRequest getRepositoryCatalogDataRequest)Retrieve catalog metadata for a repository in a public registry.default GetRepositoryPolicyResponsegetRepositoryPolicy(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest)Retrieves the repository policy for the specified repository.default GetRepositoryPolicyResponsegetRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest)Retrieves the repository policy for the specified repository.default InitiateLayerUploadResponseinitiateLayerUpload(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest)Notifies Amazon ECR that you intend to upload an image layer.default InitiateLayerUploadResponseinitiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest)Notifies Amazon ECR that you intend to upload an image layer.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)List the tags for an Amazon ECR Public resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)List the tags for an Amazon ECR Public resource.default PutImageResponseputImage(Consumer<PutImageRequest.Builder> putImageRequest)Creates or updates the image manifest and tags that are associated with an image.default PutImageResponseputImage(PutImageRequest putImageRequest)Creates or updates the image manifest and tags that are associated with an image.default PutRegistryCatalogDataResponseputRegistryCatalogData(Consumer<PutRegistryCatalogDataRequest.Builder> putRegistryCatalogDataRequest)Create or update the catalog data for a public registry.default PutRegistryCatalogDataResponseputRegistryCatalogData(PutRegistryCatalogDataRequest putRegistryCatalogDataRequest)Create or update the catalog data for a public registry.default PutRepositoryCatalogDataResponseputRepositoryCatalogData(Consumer<PutRepositoryCatalogDataRequest.Builder> putRepositoryCatalogDataRequest)Creates or updates the catalog data for a repository in a public registry.default PutRepositoryCatalogDataResponseputRepositoryCatalogData(PutRepositoryCatalogDataRequest putRepositoryCatalogDataRequest)Creates or updates the catalog data for a repository in a public registry.default EcrPublicServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default SetRepositoryPolicyResponsesetRepositoryPolicy(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest)Applies a repository policy to the specified public repository to control access permissions.default SetRepositoryPolicyResponsesetRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest)Applies a repository policy to the specified public repository to control access permissions.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Associates the specified tags to a resource with the specifiedresourceArn.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Associates the specified tags to a resource with the specifiedresourceArn.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Deletes specified tags from a resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Deletes specified tags from a resource.default UploadLayerPartResponseuploadLayerPart(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest)Uploads an image layer part to Amazon ECR.default UploadLayerPartResponseuploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest)Uploads an image layer part to Amazon ECR.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
batchCheckLayerAvailability
default BatchCheckLayerAvailabilityResponse batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) throws RepositoryNotFoundException, InvalidParameterException, ServerException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Checks the availability of one or more image layers that are within a repository in a public registry. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
dockerCLI to pull, tag, and push images.- Parameters:
batchCheckLayerAvailabilityRequest-- Returns:
- Result of the BatchCheckLayerAvailability operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchCheckLayerAvailability
default BatchCheckLayerAvailabilityResponse batchCheckLayerAvailability(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest) throws RepositoryNotFoundException, InvalidParameterException, ServerException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Checks the availability of one or more image layers that are within a repository in a public registry. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
dockerCLI to pull, tag, and push images.
This is a convenience which creates an instance of the
BatchCheckLayerAvailabilityRequest.Builderavoiding the need to create one manually viaBatchCheckLayerAvailabilityRequest.builder()- Parameters:
batchCheckLayerAvailabilityRequest- AConsumerthat will call methods onBatchCheckLayerAvailabilityRequest.Builderto create a request.- Returns:
- Result of the BatchCheckLayerAvailability operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDeleteImage
default BatchDeleteImageResponse batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Deletes a list of specified images that are within a repository in a public registry. Images are specified with either an
imageTagorimageDigest.You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
You can completely delete an image (and all of its tags) by specifying the digest of the image in your request.
- Parameters:
batchDeleteImageRequest-- Returns:
- Result of the BatchDeleteImage operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDeleteImage
default BatchDeleteImageResponse batchDeleteImage(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Deletes a list of specified images that are within a repository in a public registry. Images are specified with either an
imageTagorimageDigest.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.Builderavoiding the need to create one manually viaBatchDeleteImageRequest.builder()- Parameters:
batchDeleteImageRequest- AConsumerthat will call methods onBatchDeleteImageRequest.Builderto create a request.- Returns:
- Result of the BatchDeleteImage operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
completeLayerUpload
default CompleteLayerUploadResponse completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UploadNotFoundException, InvalidLayerException, LayerPartTooSmallException, LayerAlreadyExistsException, EmptyUploadException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and upload ID. You can optionally provide a
sha256digest 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
dockerCLI to pull, tag, and push images.- Parameters:
completeLayerUploadRequest-- Returns:
- Result of the CompleteLayerUpload operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
completeLayerUpload
default CompleteLayerUploadResponse completeLayerUpload(Consumer<CompleteLayerUploadRequest.Builder> completeLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UploadNotFoundException, InvalidLayerException, LayerPartTooSmallException, LayerAlreadyExistsException, EmptyUploadException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Informs Amazon ECR that the image layer upload is complete for a specified public registry, repository name, and upload ID. You can optionally provide a
sha256digest 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
dockerCLI to pull, tag, and push images.
This is a convenience which creates an instance of the
CompleteLayerUploadRequest.Builderavoiding the need to create one manually viaCompleteLayerUploadRequest.builder()- Parameters:
completeLayerUploadRequest- AConsumerthat will call methods onCompleteLayerUploadRequest.Builderto create a request.- Returns:
- Result of the CompleteLayerUpload operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
createRepository
default CreateRepositoryResponse createRepository(CreateRepositoryRequest createRepositoryRequest) throws ServerException, InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryAlreadyExistsException, LimitExceededException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
- Parameters:
createRepositoryRequest-- Returns:
- Result of the CreateRepository operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.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.AwsServiceException- See Also:
- AWS API Documentation
-
createRepository
default CreateRepositoryResponse createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) throws ServerException, InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryAlreadyExistsException, LimitExceededException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
CreateRepositoryRequest.Builderavoiding the need to create one manually viaCreateRepositoryRequest.builder()- Parameters:
createRepositoryRequest- AConsumerthat will call methods onCreateRepositoryRequest.Builderto create a request.- Returns:
- Result of the CreateRepository operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRepository
default DeleteRepositoryResponse deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryNotEmptyException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Deletes a repository in a public registry. If the repository contains images, you must either manually delete all images in the repository or use the
forceoption. This option deletes all images on your behalf before deleting the repository.- Parameters:
deleteRepositoryRequest-- Returns:
- Result of the DeleteRepository operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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 theforceparameter.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRepository
default DeleteRepositoryResponse deleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryNotEmptyException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Deletes a repository in a public registry. If the repository contains images, you must either manually delete all images in the repository or use the
forceoption. This option deletes all images on your behalf before deleting the repository.
This is a convenience which creates an instance of the
DeleteRepositoryRequest.Builderavoiding the need to create one manually viaDeleteRepositoryRequest.builder()- Parameters:
deleteRepositoryRequest- AConsumerthat will call methods onDeleteRepositoryRequest.Builderto create a request.- Returns:
- Result of the DeleteRepository operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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 theforceparameter.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRepositoryPolicy
default DeleteRepositoryPolicyResponse deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Deletes the repository policy that's associated with the specified repository.
- Parameters:
deleteRepositoryPolicyRequest-- Returns:
- Result of the DeleteRepositoryPolicy operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteRepositoryPolicy
default DeleteRepositoryPolicyResponse deleteRepositoryPolicy(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Deletes the repository policy that's associated with the specified repository.
This is a convenience which creates an instance of the
DeleteRepositoryPolicyRequest.Builderavoiding the need to create one manually viaDeleteRepositoryPolicyRequest.builder()- Parameters:
deleteRepositoryPolicyRequest- AConsumerthat will call methods onDeleteRepositoryPolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteRepositoryPolicy operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeImageTags
default DescribeImageTagsResponse describeImageTags(DescribeImageTagsRequest describeImageTagsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Returns the image tag details for a repository in a public registry.
- Parameters:
describeImageTagsRequest-- Returns:
- Result of the DescribeImageTags operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeImageTags
default DescribeImageTagsResponse describeImageTags(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Returns the image tag details for a repository in a public registry.
This is a convenience which creates an instance of the
DescribeImageTagsRequest.Builderavoiding the need to create one manually viaDescribeImageTagsRequest.builder()- Parameters:
describeImageTagsRequest- AConsumerthat will call methods onDescribeImageTagsRequest.Builderto create a request.- Returns:
- Result of the DescribeImageTags operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeImageTagsPaginator
default DescribeImageTagsIterable describeImageTagsPaginator(DescribeImageTagsRequest describeImageTagsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
This is a variant of
describeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client.describeImageTagsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client .describeImageTagsPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client.describeImageTagsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)operation.- Parameters:
describeImageTagsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeImageTagsPaginator
default DescribeImageTagsIterable describeImageTagsPaginator(Consumer<DescribeImageTagsRequest.Builder> describeImageTagsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
This is a variant of
describeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client.describeImageTagsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client .describeImageTagsPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImageTagsIterable responses = client.describeImageTagsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImageTags(software.amazon.awssdk.services.ecrpublic.model.DescribeImageTagsRequest)operation.
This is a convenience which creates an instance of the
DescribeImageTagsRequest.Builderavoiding the need to create one manually viaDescribeImageTagsRequest.builder()- Parameters:
describeImageTagsRequest- AConsumerthat will call methods onDescribeImageTagsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeImages
default DescribeImagesResponse describeImages(DescribeImagesRequest describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Returns metadata that's related to the images in a repository in a public registry.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the
docker imagescommand shows the uncompressed image size. Therefore, it might return a larger image size than the image sizes that are returned by DescribeImages.- Parameters:
describeImagesRequest-- Returns:
- Result of the DescribeImages operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeImages
default DescribeImagesResponse describeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Returns metadata that's related to the images in a repository in a public registry.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the
docker imagescommand 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.Builderavoiding the need to create one manually viaDescribeImagesRequest.builder()- Parameters:
describeImagesRequest- AConsumerthat will call methods onDescribeImagesRequest.Builderto create a request.- Returns:
- Result of the DescribeImages operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeImagesPaginator
default DescribeImagesIterable describeImagesPaginator(DescribeImagesRequest describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
This is a variant of
describeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client .describeImagesPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeImagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)operation.- Parameters:
describeImagesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeImagesPaginator
default DescribeImagesIterable describeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
This is a variant of
describeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client .describeImagesPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeImagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecrpublic.model.DescribeImagesRequest)operation.
This is a convenience which creates an instance of the
DescribeImagesRequest.Builderavoiding the need to create one manually viaDescribeImagesRequest.builder()- Parameters:
describeImagesRequest- AConsumerthat will call methods onDescribeImagesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRegistries
default DescribeRegistriesResponse describeRegistries(DescribeRegistriesRequest describeRegistriesRequest) throws InvalidParameterException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
Returns details for a public registry.
- Parameters:
describeRegistriesRequest-- Returns:
- Result of the DescribeRegistries operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRegistries
default DescribeRegistriesResponse describeRegistries(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest) throws InvalidParameterException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
Returns details for a public registry.
This is a convenience which creates an instance of the
DescribeRegistriesRequest.Builderavoiding the need to create one manually viaDescribeRegistriesRequest.builder()- Parameters:
describeRegistriesRequest- AConsumerthat will call methods onDescribeRegistriesRequest.Builderto create a request.- Returns:
- Result of the DescribeRegistries operation returned by the service.
- Throws:
InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.UnsupportedCommandException- The action 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRegistriesPaginator
default DescribeRegistriesIterable describeRegistriesPaginator(DescribeRegistriesRequest describeRegistriesRequest) throws InvalidParameterException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
This is a variant of
describeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client.describeRegistriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client .describeRegistriesPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client.describeRegistriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)operation.- Parameters:
describeRegistriesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRegistriesPaginator
default DescribeRegistriesIterable describeRegistriesPaginator(Consumer<DescribeRegistriesRequest.Builder> describeRegistriesRequest) throws InvalidParameterException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
This is a variant of
describeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client.describeRegistriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client .describeRegistriesPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRegistriesIterable responses = client.describeRegistriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRegistries(software.amazon.awssdk.services.ecrpublic.model.DescribeRegistriesRequest)operation.
This is a convenience which creates an instance of the
DescribeRegistriesRequest.Builderavoiding the need to create one manually viaDescribeRegistriesRequest.builder()- Parameters:
describeRegistriesRequest- AConsumerthat will call methods onDescribeRegistriesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRepositories
default DescribeRepositoriesResponse describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Describes repositories that are in a public registry.
- Parameters:
describeRepositoriesRequest-- Returns:
- Result of the DescribeRepositories operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRepositories
default DescribeRepositoriesResponse describeRepositories(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Describes repositories that are in a public registry.
This is a convenience which creates an instance of the
DescribeRepositoriesRequest.Builderavoiding the need to create one manually viaDescribeRepositoriesRequest.builder()- Parameters:
describeRepositoriesRequest- AConsumerthat will call methods onDescribeRepositoriesRequest.Builderto create a request.- Returns:
- Result of the DescribeRepositories operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRepositoriesPaginator
default DescribeRepositoriesIterable describeRepositoriesPaginator(DescribeRepositoriesRequest describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client .describeRepositoriesPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)operation.- Parameters:
describeRepositoriesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeRepositoriesPaginator
default DescribeRepositoriesIterable describeRepositoriesPaginator(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client .describeRepositoriesPaginator(request); for (software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ecrpublic.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecrpublic.model.DescribeRepositoriesRequest)operation.
This is a convenience which creates an instance of the
DescribeRepositoriesRequest.Builderavoiding the need to create one manually viaDescribeRepositoriesRequest.builder()- Parameters:
describeRepositoriesRequest- AConsumerthat will call methods onDescribeRepositoriesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
getAuthorizationToken
default GetAuthorizationTokenResponse getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest) throws ServerException, InvalidParameterException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieves an authorization token. An authorization token represents your IAM authentication credentials. You can use it to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. This API requires the
ecr-public:GetAuthorizationTokenandsts:GetServiceBearerTokenpermissions.- Parameters:
getAuthorizationTokenRequest-- Returns:
- Result of the GetAuthorizationToken operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.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.AwsServiceException- See Also:
- AWS API Documentation
-
getAuthorizationToken
default GetAuthorizationTokenResponse getAuthorizationToken(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest) throws ServerException, InvalidParameterException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieves an authorization token. An authorization token represents your IAM authentication credentials. You can use it to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. This API requires the
ecr-public:GetAuthorizationTokenandsts:GetServiceBearerTokenpermissions.
This is a convenience which creates an instance of the
GetAuthorizationTokenRequest.Builderavoiding the need to create one manually viaGetAuthorizationTokenRequest.builder()- Parameters:
getAuthorizationTokenRequest- AConsumerthat will call methods onGetAuthorizationTokenRequest.Builderto create a request.- Returns:
- Result of the GetAuthorizationToken operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.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.AwsServiceException- See Also:
- AWS API Documentation
-
getRegistryCatalogData
default GetRegistryCatalogDataResponse getRegistryCatalogData(GetRegistryCatalogDataRequest getRegistryCatalogDataRequest) throws ServerException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieves catalog metadata for a public registry.
- Parameters:
getRegistryCatalogDataRequest-- Returns:
- Result of the GetRegistryCatalogData operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getRegistryCatalogData
default GetRegistryCatalogDataResponse getRegistryCatalogData(Consumer<GetRegistryCatalogDataRequest.Builder> getRegistryCatalogDataRequest) throws ServerException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieves catalog metadata for a public registry.
This is a convenience which creates an instance of the
GetRegistryCatalogDataRequest.Builderavoiding the need to create one manually viaGetRegistryCatalogDataRequest.builder()- Parameters:
getRegistryCatalogDataRequest- AConsumerthat will call methods onGetRegistryCatalogDataRequest.Builderto create a request.- Returns:
- Result of the GetRegistryCatalogData operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.UnsupportedCommandException- The action 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.AwsServiceException- See Also:
- AWS API Documentation
-
getRepositoryCatalogData
default GetRepositoryCatalogDataResponse getRepositoryCatalogData(GetRepositoryCatalogDataRequest getRepositoryCatalogDataRequest) throws ServerException, InvalidParameterException, RepositoryCatalogDataNotFoundException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.
- Parameters:
getRepositoryCatalogDataRequest-- Returns:
- Result of the GetRepositoryCatalogData operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.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.AwsServiceException- See Also:
- AWS API Documentation
-
getRepositoryCatalogData
default GetRepositoryCatalogDataResponse getRepositoryCatalogData(Consumer<GetRepositoryCatalogDataRequest.Builder> getRepositoryCatalogDataRequest) throws ServerException, InvalidParameterException, RepositoryCatalogDataNotFoundException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.
This is a convenience which creates an instance of the
GetRepositoryCatalogDataRequest.Builderavoiding the need to create one manually viaGetRepositoryCatalogDataRequest.builder()- Parameters:
getRepositoryCatalogDataRequest- AConsumerthat will call methods onGetRepositoryCatalogDataRequest.Builderto create a request.- Returns:
- Result of the GetRepositoryCatalogData operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.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.AwsServiceException- See Also:
- AWS API Documentation
-
getRepositoryPolicy
default GetRepositoryPolicyResponse getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieves the repository policy for the specified repository.
- Parameters:
getRepositoryPolicyRequest-- Returns:
- Result of the GetRepositoryPolicy operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
getRepositoryPolicy
default GetRepositoryPolicyResponse getRepositoryPolicy(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Retrieves the repository policy for the specified repository.
This is a convenience which creates an instance of the
GetRepositoryPolicyRequest.Builderavoiding the need to create one manually viaGetRepositoryPolicyRequest.builder()- Parameters:
getRepositoryPolicyRequest- AConsumerthat will call methods onGetRepositoryPolicyRequest.Builderto create a request.- Returns:
- Result of the GetRepositoryPolicy operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
initiateLayerUpload
default InitiateLayerUploadResponse initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once for each image layer that hasn't already been uploaded. Whether an image layer uploads is determined by the BatchCheckLayerAvailability API action.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
dockerCLI to pull, tag, and push images.- Parameters:
initiateLayerUploadRequest-- Returns:
- Result of the InitiateLayerUpload operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
initiateLayerUpload
default InitiateLayerUploadResponse initiateLayerUpload(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once for each image layer that hasn't already been uploaded. Whether an image layer uploads is determined by the BatchCheckLayerAvailability API action.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
dockerCLI to pull, tag, and push images.
This is a convenience which creates an instance of the
InitiateLayerUploadRequest.Builderavoiding the need to create one manually viaInitiateLayerUploadRequest.builder()- Parameters:
initiateLayerUploadRequest- AConsumerthat will call methods onInitiateLayerUploadRequest.Builderto create a request.- Returns:
- Result of the InitiateLayerUpload operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
List the tags for an Amazon ECR Public resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
List the tags for an Amazon ECR Public resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putImage
default PutImageResponse putImage(PutImageRequest putImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageAlreadyExistsException, LayersNotFoundException, ReferencedImagesNotFoundException, LimitExceededException, ImageTagAlreadyExistsException, ImageDigestDoesNotMatchException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Creates or updates the image manifest and tags that are associated with an image.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags that are associated with the image.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
dockerCLI to pull, tag, and push images.- Parameters:
putImageRequest-- Returns:
- Result of the PutImage operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
putImage
default PutImageResponse putImage(Consumer<PutImageRequest.Builder> putImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageAlreadyExistsException, LayersNotFoundException, ReferencedImagesNotFoundException, LimitExceededException, ImageTagAlreadyExistsException, ImageDigestDoesNotMatchException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Creates or updates the image manifest and tags that are associated with an image.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags that are associated with the image.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
dockerCLI to pull, tag, and push images.
This is a convenience which creates an instance of the
PutImageRequest.Builderavoiding the need to create one manually viaPutImageRequest.builder()- Parameters:
putImageRequest- AConsumerthat will call methods onPutImageRequest.Builderto create a request.- Returns:
- Result of the PutImage operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
putRegistryCatalogData
default PutRegistryCatalogDataResponse putRegistryCatalogData(PutRegistryCatalogDataRequest putRegistryCatalogDataRequest) throws ServerException, InvalidParameterException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Create or update the catalog data for a public registry.
- Parameters:
putRegistryCatalogDataRequest-- Returns:
- Result of the PutRegistryCatalogData operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.UnsupportedCommandException- The action 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.AwsServiceException- See Also:
- AWS API Documentation
-
putRegistryCatalogData
default PutRegistryCatalogDataResponse putRegistryCatalogData(Consumer<PutRegistryCatalogDataRequest.Builder> putRegistryCatalogDataRequest) throws ServerException, InvalidParameterException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Create or update the catalog data for a public registry.
This is a convenience which creates an instance of the
PutRegistryCatalogDataRequest.Builderavoiding the need to create one manually viaPutRegistryCatalogDataRequest.builder()- Parameters:
putRegistryCatalogDataRequest- AConsumerthat will call methods onPutRegistryCatalogDataRequest.Builderto create a request.- Returns:
- Result of the PutRegistryCatalogData operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.UnsupportedCommandException- The action 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.AwsServiceException- See Also:
- AWS API Documentation
-
putRepositoryCatalogData
default PutRepositoryCatalogDataResponse putRepositoryCatalogData(PutRepositoryCatalogDataRequest putRepositoryCatalogDataRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Creates or updates the catalog data for a repository in a public registry.
- Parameters:
putRepositoryCatalogDataRequest-- Returns:
- Result of the PutRepositoryCatalogData operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
putRepositoryCatalogData
default PutRepositoryCatalogDataResponse putRepositoryCatalogData(Consumer<PutRepositoryCatalogDataRequest.Builder> putRepositoryCatalogDataRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Creates or updates the catalog data for a repository in a public registry.
This is a convenience which creates an instance of the
PutRepositoryCatalogDataRequest.Builderavoiding the need to create one manually viaPutRepositoryCatalogDataRequest.builder()- Parameters:
putRepositoryCatalogDataRequest- AConsumerthat will call methods onPutRepositoryCatalogDataRequest.Builderto create a request.- Returns:
- Result of the PutRepositoryCatalogData operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
setRepositoryPolicy
default SetRepositoryPolicyResponse setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Applies a repository policy to the specified public repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.
- Parameters:
setRepositoryPolicyRequest-- Returns:
- Result of the SetRepositoryPolicy operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
setRepositoryPolicy
default SetRepositoryPolicyResponse setRepositoryPolicy(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Applies a repository policy to the specified public repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
SetRepositoryPolicyRequest.Builderavoiding the need to create one manually viaSetRepositoryPolicyRequest.builder()- Parameters:
setRepositoryPolicyRequest- AConsumerthat will call methods onSetRepositoryPolicyRequest.Builderto create a request.- Returns:
- Result of the SetRepositoryPolicy operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException- The specified repository 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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
Associates the specified tags to a resource with the specified
resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
Associates the specified tags to a resource with the specified
resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
Deletes specified tags from a resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, UnsupportedCommandException, ServerException, AwsServiceException, SdkClientException, EcrPublicException
Deletes specified tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
uploadLayerPart
default UploadLayerPartResponse uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest) throws ServerException, InvalidParameterException, InvalidLayerPartException, RepositoryNotFoundException, UploadNotFoundException, LimitExceededException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Uploads an image layer part to Amazon ECR.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (about 20MB). The UploadLayerPart API is called once for each new image layer part.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
dockerCLI to pull, tag, and push images.- Parameters:
uploadLayerPartRequest-- Returns:
- Result of the UploadLayerPart operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.InvalidLayerPartException- The layer part size 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.AwsServiceException- See Also:
- AWS API Documentation
-
uploadLayerPart
default UploadLayerPartResponse uploadLayerPart(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest) throws ServerException, InvalidParameterException, InvalidLayerPartException, RepositoryNotFoundException, UploadNotFoundException, LimitExceededException, RegistryNotFoundException, UnsupportedCommandException, AwsServiceException, SdkClientException, EcrPublicException
Uploads an image layer part to Amazon ECR.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (about 20MB). The UploadLayerPart API is called once for each new image layer part.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
dockerCLI to pull, tag, and push images.
This is a convenience which creates an instance of the
UploadLayerPartRequest.Builderavoiding the need to create one manually viaUploadLayerPartRequest.builder()- Parameters:
uploadLayerPartRequest- AConsumerthat will call methods onUploadLayerPartRequest.Builderto create a request.- Returns:
- Result of the UploadLayerPart operation returned by the service.
- Throws:
ServerException- These errors are usually caused by a server-side issue.InvalidParameterException- The specified parameter is invalid. Review the available parameters for the API request.InvalidLayerPartException- The layer part size 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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static EcrPublicClient create()
Create aEcrPublicClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static EcrPublicClientBuilder builder()
Create a builder that can be used to configure and create aEcrPublicClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default EcrPublicServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-