@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface EcrClient extends AwsClient
builder() method.
Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR supports private repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images.
Amazon ECR has service endpoints in each supported Region. For more information, see Amazon ECR endpoints in the Amazon Web Services General Reference.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default BatchCheckLayerAvailabilityResponse |
batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest)
Checks the availability of one or more image layers in a repository.
|
default BatchCheckLayerAvailabilityResponse |
batchCheckLayerAvailability(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest)
Checks the availability of one or more image layers in a repository.
|
default BatchDeleteImageResponse |
batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest)
Deletes a list of specified images within a repository.
|
default BatchDeleteImageResponse |
batchDeleteImage(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest)
Deletes a list of specified images within a repository.
|
default BatchGetImageResponse |
batchGetImage(BatchGetImageRequest batchGetImageRequest)
Gets detailed information for an image.
|
default BatchGetImageResponse |
batchGetImage(Consumer<BatchGetImageRequest.Builder> batchGetImageRequest)
Gets detailed information for an image.
|
default BatchGetRepositoryScanningConfigurationResponse |
batchGetRepositoryScanningConfiguration(BatchGetRepositoryScanningConfigurationRequest batchGetRepositoryScanningConfigurationRequest)
Gets the scanning configuration for one or more repositories.
|
default BatchGetRepositoryScanningConfigurationResponse |
batchGetRepositoryScanningConfiguration(Consumer<BatchGetRepositoryScanningConfigurationRequest.Builder> batchGetRepositoryScanningConfigurationRequest)
Gets the scanning configuration for one or more repositories.
|
static EcrClientBuilder |
builder()
Create a builder that can be used to configure and create a
EcrClient. |
default CompleteLayerUploadResponse |
completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest)
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and
upload ID.
|
default CompleteLayerUploadResponse |
completeLayerUpload(Consumer<CompleteLayerUploadRequest.Builder> completeLayerUploadRequest)
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and
upload ID.
|
static EcrClient |
create()
Create a
EcrClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreatePullThroughCacheRuleResponse |
createPullThroughCacheRule(Consumer<CreatePullThroughCacheRuleRequest.Builder> createPullThroughCacheRuleRequest)
Creates a pull through cache rule.
|
default CreatePullThroughCacheRuleResponse |
createPullThroughCacheRule(CreatePullThroughCacheRuleRequest createPullThroughCacheRuleRequest)
Creates a pull through cache rule.
|
default CreateRepositoryResponse |
createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest)
Creates a repository.
|
default CreateRepositoryResponse |
createRepository(CreateRepositoryRequest createRepositoryRequest)
Creates a repository.
|
default DeleteLifecyclePolicyResponse |
deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest)
Deletes the lifecycle policy associated with the specified repository.
|
default DeleteLifecyclePolicyResponse |
deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)
Deletes the lifecycle policy associated with the specified repository.
|
default DeletePullThroughCacheRuleResponse |
deletePullThroughCacheRule(Consumer<DeletePullThroughCacheRuleRequest.Builder> deletePullThroughCacheRuleRequest)
Deletes a pull through cache rule.
|
default DeletePullThroughCacheRuleResponse |
deletePullThroughCacheRule(DeletePullThroughCacheRuleRequest deletePullThroughCacheRuleRequest)
Deletes a pull through cache rule.
|
default DeleteRegistryPolicyResponse |
deleteRegistryPolicy(Consumer<DeleteRegistryPolicyRequest.Builder> deleteRegistryPolicyRequest)
Deletes the registry permissions policy.
|
default DeleteRegistryPolicyResponse |
deleteRegistryPolicy(DeleteRegistryPolicyRequest deleteRegistryPolicyRequest)
Deletes the registry permissions policy.
|
default DeleteRepositoryResponse |
deleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest)
Deletes a repository.
|
default DeleteRepositoryResponse |
deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)
Deletes a repository.
|
default DeleteRepositoryPolicyResponse |
deleteRepositoryPolicy(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest)
Deletes the repository policy associated with the specified repository.
|
default DeleteRepositoryPolicyResponse |
deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest)
Deletes the repository policy associated with the specified repository.
|
default DescribeImageReplicationStatusResponse |
describeImageReplicationStatus(Consumer<DescribeImageReplicationStatusRequest.Builder> describeImageReplicationStatusRequest)
Returns the replication status for a specified image.
|
default DescribeImageReplicationStatusResponse |
describeImageReplicationStatus(DescribeImageReplicationStatusRequest describeImageReplicationStatusRequest)
Returns the replication status for a specified image.
|
default DescribeImagesResponse |
describeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest)
Returns metadata about the images in a repository.
|
default DescribeImagesResponse |
describeImages(DescribeImagesRequest describeImagesRequest)
Returns metadata about the images in a repository.
|
default DescribeImageScanFindingsResponse |
describeImageScanFindings(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest)
Returns the scan findings for the specified image.
|
default DescribeImageScanFindingsResponse |
describeImageScanFindings(DescribeImageScanFindingsRequest describeImageScanFindingsRequest)
Returns the scan findings for the specified image.
|
default DescribeImageScanFindingsIterable |
describeImageScanFindingsPaginator(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest)
Returns the scan findings for the specified image.
|
default DescribeImageScanFindingsIterable |
describeImageScanFindingsPaginator(DescribeImageScanFindingsRequest describeImageScanFindingsRequest)
Returns the scan findings for the specified image.
|
default DescribeImagesIterable |
describeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest)
Returns metadata about the images in a repository.
|
default DescribeImagesIterable |
describeImagesPaginator(DescribeImagesRequest describeImagesRequest)
Returns metadata about the images in a repository.
|
default DescribePullThroughCacheRulesResponse |
describePullThroughCacheRules(Consumer<DescribePullThroughCacheRulesRequest.Builder> describePullThroughCacheRulesRequest)
Returns the pull through cache rules for a registry.
|
default DescribePullThroughCacheRulesResponse |
describePullThroughCacheRules(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest)
Returns the pull through cache rules for a registry.
|
default DescribePullThroughCacheRulesIterable |
describePullThroughCacheRulesPaginator(Consumer<DescribePullThroughCacheRulesRequest.Builder> describePullThroughCacheRulesRequest)
Returns the pull through cache rules for a registry.
|
default DescribePullThroughCacheRulesIterable |
describePullThroughCacheRulesPaginator(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest)
Returns the pull through cache rules for a registry.
|
default DescribeRegistryResponse |
describeRegistry(Consumer<DescribeRegistryRequest.Builder> describeRegistryRequest)
Describes the settings for a registry.
|
default DescribeRegistryResponse |
describeRegistry(DescribeRegistryRequest describeRegistryRequest)
Describes the settings for a registry.
|
default DescribeRepositoriesResponse |
describeRepositories()
Describes image repositories in a registry.
|
default DescribeRepositoriesResponse |
describeRepositories(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest)
Describes image repositories in a registry.
|
default DescribeRepositoriesResponse |
describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest)
Describes image repositories in a registry.
|
default DescribeRepositoriesIterable |
describeRepositoriesPaginator()
Describes image repositories in a registry.
|
default DescribeRepositoriesIterable |
describeRepositoriesPaginator(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest)
Describes image repositories in a registry.
|
default DescribeRepositoriesIterable |
describeRepositoriesPaginator(DescribeRepositoriesRequest describeRepositoriesRequest)
Describes image repositories in a registry.
|
default GetAuthorizationTokenResponse |
getAuthorizationToken()
Retrieves an authorization token.
|
default GetAuthorizationTokenResponse |
getAuthorizationToken(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest)
Retrieves an authorization token.
|
default GetAuthorizationTokenResponse |
getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest)
Retrieves an authorization token.
|
default GetDownloadUrlForLayerResponse |
getDownloadUrlForLayer(Consumer<GetDownloadUrlForLayerRequest.Builder> getDownloadUrlForLayerRequest)
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.
|
default GetDownloadUrlForLayerResponse |
getDownloadUrlForLayer(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest)
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.
|
default GetLifecyclePolicyResponse |
getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest)
Retrieves the lifecycle policy for the specified repository.
|
default GetLifecyclePolicyResponse |
getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest)
Retrieves the lifecycle policy for the specified repository.
|
default GetLifecyclePolicyPreviewResponse |
getLifecyclePolicyPreview(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest)
Retrieves the results of the lifecycle policy preview request for the specified repository.
|
default GetLifecyclePolicyPreviewResponse |
getLifecyclePolicyPreview(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest)
Retrieves the results of the lifecycle policy preview request for the specified repository.
|
default GetLifecyclePolicyPreviewIterable |
getLifecyclePolicyPreviewPaginator(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest)
Retrieves the results of the lifecycle policy preview request for the specified repository.
|
default GetLifecyclePolicyPreviewIterable |
getLifecyclePolicyPreviewPaginator(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest)
Retrieves the results of the lifecycle policy preview request for the specified repository.
|
default GetRegistryPolicyResponse |
getRegistryPolicy(Consumer<GetRegistryPolicyRequest.Builder> getRegistryPolicyRequest)
Retrieves the permissions policy for a registry.
|
default GetRegistryPolicyResponse |
getRegistryPolicy(GetRegistryPolicyRequest getRegistryPolicyRequest)
Retrieves the permissions policy for a registry.
|
default GetRegistryScanningConfigurationResponse |
getRegistryScanningConfiguration(Consumer<GetRegistryScanningConfigurationRequest.Builder> getRegistryScanningConfigurationRequest)
Retrieves the scanning configuration for a registry.
|
default GetRegistryScanningConfigurationResponse |
getRegistryScanningConfiguration(GetRegistryScanningConfigurationRequest getRegistryScanningConfigurationRequest)
Retrieves the scanning configuration for a registry.
|
default GetRepositoryPolicyResponse |
getRepositoryPolicy(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest)
Retrieves the repository policy for the specified repository.
|
default GetRepositoryPolicyResponse |
getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest)
Retrieves the repository policy for the specified repository.
|
default InitiateLayerUploadResponse |
initiateLayerUpload(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest)
Notifies Amazon ECR that you intend to upload an image layer.
|
default InitiateLayerUploadResponse |
initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest)
Notifies Amazon ECR that you intend to upload an image layer.
|
default ListImagesResponse |
listImages(Consumer<ListImagesRequest.Builder> listImagesRequest)
Lists all the image IDs for the specified repository.
|
default ListImagesResponse |
listImages(ListImagesRequest listImagesRequest)
Lists all the image IDs for the specified repository.
|
default ListImagesIterable |
listImagesPaginator(Consumer<ListImagesRequest.Builder> listImagesRequest)
Lists all the image IDs for the specified repository.
|
default ListImagesIterable |
listImagesPaginator(ListImagesRequest listImagesRequest)
Lists all the image IDs for the specified repository.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List the tags for an Amazon ECR resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for an Amazon ECR resource.
|
default PutImageResponse |
putImage(Consumer<PutImageRequest.Builder> putImageRequest)
Creates or updates the image manifest and tags associated with an image.
|
default PutImageResponse |
putImage(PutImageRequest putImageRequest)
Creates or updates the image manifest and tags associated with an image.
|
default PutImageScanningConfigurationResponse |
putImageScanningConfiguration(Consumer<PutImageScanningConfigurationRequest.Builder> putImageScanningConfigurationRequest)
|
default PutImageScanningConfigurationResponse |
putImageScanningConfiguration(PutImageScanningConfigurationRequest putImageScanningConfigurationRequest)
|
default PutImageTagMutabilityResponse |
putImageTagMutability(Consumer<PutImageTagMutabilityRequest.Builder> putImageTagMutabilityRequest)
Updates the image tag mutability settings for the specified repository.
|
default PutImageTagMutabilityResponse |
putImageTagMutability(PutImageTagMutabilityRequest putImageTagMutabilityRequest)
Updates the image tag mutability settings for the specified repository.
|
default PutLifecyclePolicyResponse |
putLifecyclePolicy(Consumer<PutLifecyclePolicyRequest.Builder> putLifecyclePolicyRequest)
Creates or updates the lifecycle policy for the specified repository.
|
default PutLifecyclePolicyResponse |
putLifecyclePolicy(PutLifecyclePolicyRequest putLifecyclePolicyRequest)
Creates or updates the lifecycle policy for the specified repository.
|
default PutRegistryPolicyResponse |
putRegistryPolicy(Consumer<PutRegistryPolicyRequest.Builder> putRegistryPolicyRequest)
Creates or updates the permissions policy for your registry.
|
default PutRegistryPolicyResponse |
putRegistryPolicy(PutRegistryPolicyRequest putRegistryPolicyRequest)
Creates or updates the permissions policy for your registry.
|
default PutRegistryScanningConfigurationResponse |
putRegistryScanningConfiguration(Consumer<PutRegistryScanningConfigurationRequest.Builder> putRegistryScanningConfigurationRequest)
Creates or updates the scanning configuration for your private registry.
|
default PutRegistryScanningConfigurationResponse |
putRegistryScanningConfiguration(PutRegistryScanningConfigurationRequest putRegistryScanningConfigurationRequest)
Creates or updates the scanning configuration for your private registry.
|
default PutReplicationConfigurationResponse |
putReplicationConfiguration(Consumer<PutReplicationConfigurationRequest.Builder> putReplicationConfigurationRequest)
Creates or updates the replication configuration for a registry.
|
default PutReplicationConfigurationResponse |
putReplicationConfiguration(PutReplicationConfigurationRequest putReplicationConfigurationRequest)
Creates or updates the replication configuration for a registry.
|
default EcrServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default SetRepositoryPolicyResponse |
setRepositoryPolicy(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest)
Applies a repository policy to the specified repository to control access permissions.
|
default SetRepositoryPolicyResponse |
setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest)
Applies a repository policy to the specified repository to control access permissions.
|
default StartImageScanResponse |
startImageScan(Consumer<StartImageScanRequest.Builder> startImageScanRequest)
Starts an image vulnerability scan.
|
default StartImageScanResponse |
startImageScan(StartImageScanRequest startImageScanRequest)
Starts an image vulnerability scan.
|
default StartLifecyclePolicyPreviewResponse |
startLifecyclePolicyPreview(Consumer<StartLifecyclePolicyPreviewRequest.Builder> startLifecyclePolicyPreviewRequest)
Starts a preview of a lifecycle policy for the specified repository.
|
default StartLifecyclePolicyPreviewResponse |
startLifecyclePolicyPreview(StartLifecyclePolicyPreviewRequest startLifecyclePolicyPreviewRequest)
Starts a preview of a lifecycle policy for the specified repository.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds specified tags to a resource with the specified ARN.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds specified tags to a resource with the specified ARN.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Deletes specified tags from a resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes specified tags from a resource.
|
default UploadLayerPartResponse |
uploadLayerPart(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest)
Uploads an image layer part to Amazon ECR.
|
default UploadLayerPartResponse |
uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest)
Uploads an image layer part to Amazon ECR.
|
default EcrWaiter |
waiter()
Create an instance of
EcrWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default BatchCheckLayerAvailabilityResponse batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) throws RepositoryNotFoundException, InvalidParameterException, ServerException, AwsServiceException, SdkClientException, EcrException
Checks the availability of one or more image layers in a repository.
When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
batchCheckLayerAvailabilityRequest - RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ServerException - These errors are usually caused by a server-side issue.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchCheckLayerAvailabilityResponse batchCheckLayerAvailability(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest) throws RepositoryNotFoundException, InvalidParameterException, ServerException, AwsServiceException, SdkClientException, EcrException
Checks the availability of one or more image layers in a repository.
When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
This is a convenience which creates an instance of the BatchCheckLayerAvailabilityRequest.Builder
avoiding the need to create one manually via BatchCheckLayerAvailabilityRequest.builder()
batchCheckLayerAvailabilityRequest - A Consumer that will call methods on BatchCheckLayerAvailabilityRequest.Builder to create
a request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ServerException - These errors are usually caused by a server-side issue.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDeleteImageResponse batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes a list of specified images within a repository. Images are specified with either an imageTag
or imageDigest.
You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
You can completely delete an image (and all of its tags) by specifying the image's digest in your request.
batchDeleteImageRequest - Deletes specified images within a specified repository. Images are specified with either the
imageTag or imageDigest.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchDeleteImageResponse batchDeleteImage(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes a list of specified images within a repository. Images are specified with either an imageTag
or imageDigest.
You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
You can completely delete an image (and all of its tags) by specifying the image's digest in your request.
This is a convenience which creates an instance of the BatchDeleteImageRequest.Builder avoiding the need
to create one manually via BatchDeleteImageRequest.builder()
batchDeleteImageRequest - A Consumer that will call methods on BatchDeleteImageRequest.Builder to create a request.
Deletes specified images within a specified repository. Images are specified with either the
imageTag or imageDigest.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchGetImageResponse batchGetImage(BatchGetImageRequest batchGetImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Gets detailed information for an image. Images are specified with either an imageTag or
imageDigest.
When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.
batchGetImageRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchGetImageResponse batchGetImage(Consumer<BatchGetImageRequest.Builder> batchGetImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Gets detailed information for an image. Images are specified with either an imageTag or
imageDigest.
When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.
This is a convenience which creates an instance of the BatchGetImageRequest.Builder avoiding the need to
create one manually via BatchGetImageRequest.builder()
batchGetImageRequest - A Consumer that will call methods on BatchGetImageRequest.Builder to create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchGetRepositoryScanningConfigurationResponse batchGetRepositoryScanningConfiguration(BatchGetRepositoryScanningConfigurationRequest batchGetRepositoryScanningConfigurationRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Gets the scanning configuration for one or more repositories.
batchGetRepositoryScanningConfigurationRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault BatchGetRepositoryScanningConfigurationResponse batchGetRepositoryScanningConfiguration(Consumer<BatchGetRepositoryScanningConfigurationRequest.Builder> batchGetRepositoryScanningConfigurationRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Gets the scanning configuration for one or more repositories.
This is a convenience which creates an instance of the
BatchGetRepositoryScanningConfigurationRequest.Builder avoiding the need to create one manually via
BatchGetRepositoryScanningConfigurationRequest.builder()
batchGetRepositoryScanningConfigurationRequest - A Consumer that will call methods on
BatchGetRepositoryScanningConfigurationRequest.Builder to create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CompleteLayerUploadResponse completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UploadNotFoundException, InvalidLayerException, LayerPartTooSmallException, LayerAlreadyExistsException, EmptyUploadException, KmsException, AwsServiceException, SdkClientException, EcrException
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and
upload ID. You can optionally provide a sha256 digest of the image layer for data validation
purposes.
When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
completeLayerUploadRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.UploadNotFoundException - The upload could not be found, or the specified upload ID is not valid for this repository.InvalidLayerException - The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the
digest specified.LayerPartTooSmallException - Layer parts must be at least 5 MiB in size.LayerAlreadyExistsException - The image layer already exists in the associated repository.EmptyUploadException - The specified layer upload does not contain any layer parts.KmsException - The operation failed due to a KMS exception.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CompleteLayerUploadResponse completeLayerUpload(Consumer<CompleteLayerUploadRequest.Builder> completeLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UploadNotFoundException, InvalidLayerException, LayerPartTooSmallException, LayerAlreadyExistsException, EmptyUploadException, KmsException, AwsServiceException, SdkClientException, EcrException
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and
upload ID. You can optionally provide a sha256 digest of the image layer for data validation
purposes.
When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
This is a convenience which creates an instance of the CompleteLayerUploadRequest.Builder avoiding the
need to create one manually via CompleteLayerUploadRequest.builder()
completeLayerUploadRequest - A Consumer that will call methods on CompleteLayerUploadRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.UploadNotFoundException - The upload could not be found, or the specified upload ID is not valid for this repository.InvalidLayerException - The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the
digest specified.LayerPartTooSmallException - Layer parts must be at least 5 MiB in size.LayerAlreadyExistsException - The image layer already exists in the associated repository.EmptyUploadException - The specified layer upload does not contain any layer parts.KmsException - The operation failed due to a KMS exception.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePullThroughCacheRuleResponse createPullThroughCacheRule(CreatePullThroughCacheRuleRequest createPullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleAlreadyExistsException, UnsupportedUpstreamRegistryException, LimitExceededException, AwsServiceException, SdkClientException, EcrException
Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an external public registry in your Amazon ECR private registry.
createPullThroughCacheRuleRequest - 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.ValidationException - There was an exception validating this request.PullThroughCacheRuleAlreadyExistsException - A pull through cache rule with these settings already exists for the private registry.UnsupportedUpstreamRegistryException - The specified upstream registry isn't supported.LimitExceededException - The operation did not succeed because it would have exceeded a service limit for your account. For more
information, see Amazon ECR service
quotas in the Amazon Elastic Container Registry User Guide.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePullThroughCacheRuleResponse createPullThroughCacheRule(Consumer<CreatePullThroughCacheRuleRequest.Builder> createPullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleAlreadyExistsException, UnsupportedUpstreamRegistryException, LimitExceededException, AwsServiceException, SdkClientException, EcrException
Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an external public registry in your Amazon ECR private registry.
This is a convenience which creates an instance of the CreatePullThroughCacheRuleRequest.Builder avoiding
the need to create one manually via CreatePullThroughCacheRuleRequest.builder()
createPullThroughCacheRuleRequest - A Consumer that will call methods on CreatePullThroughCacheRuleRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ValidationException - There was an exception validating this request.PullThroughCacheRuleAlreadyExistsException - A pull through cache rule with these settings already exists for the private registry.UnsupportedUpstreamRegistryException - The specified upstream registry isn't supported.LimitExceededException - The operation did not succeed because it would have exceeded a service limit for your account. For more
information, see Amazon ECR service
quotas in the Amazon Elastic Container Registry User Guide.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRepositoryResponse createRepository(CreateRepositoryRequest createRepositoryRequest) throws ServerException, InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryAlreadyExistsException, LimitExceededException, KmsException, AwsServiceException, SdkClientException, EcrException
Creates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
createRepositoryRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.InvalidTagParameterException - An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters,
and tag values can have a maximum length of 256 characters.TooManyTagsException - The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a
repository is 50.RepositoryAlreadyExistsException - The specified repository already exists in the specified registry.LimitExceededException - The operation did not succeed because it would have exceeded a service limit for your account. For more
information, see Amazon ECR service
quotas in the Amazon Elastic Container Registry User Guide.KmsException - The operation failed due to a KMS exception.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateRepositoryResponse createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) throws ServerException, InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryAlreadyExistsException, LimitExceededException, KmsException, AwsServiceException, SdkClientException, EcrException
Creates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the CreateRepositoryRequest.Builder avoiding the need
to create one manually via CreateRepositoryRequest.builder()
createRepositoryRequest - A Consumer that will call methods on CreateRepositoryRequest.Builder to create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.InvalidTagParameterException - An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters,
and tag values can have a maximum length of 256 characters.TooManyTagsException - The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a
repository is 50.RepositoryAlreadyExistsException - The specified repository already exists in the specified registry.LimitExceededException - The operation did not succeed because it would have exceeded a service limit for your account. For more
information, see Amazon ECR service
quotas in the Amazon Elastic Container Registry User Guide.KmsException - The operation failed due to a KMS exception.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLifecyclePolicyResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes the lifecycle policy associated with the specified repository.
deleteLifecyclePolicyRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.LifecyclePolicyNotFoundException - The lifecycle policy could not be found, and no policy is set to the repository.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteLifecyclePolicyResponse deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes the lifecycle policy associated with the specified repository.
This is a convenience which creates an instance of the DeleteLifecyclePolicyRequest.Builder avoiding the
need to create one manually via DeleteLifecyclePolicyRequest.builder()
deleteLifecyclePolicyRequest - A Consumer that will call methods on DeleteLifecyclePolicyRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.LifecyclePolicyNotFoundException - The lifecycle policy could not be found, and no policy is set to the repository.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePullThroughCacheRuleResponse deletePullThroughCacheRule(DeletePullThroughCacheRuleRequest deletePullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes a pull through cache rule.
deletePullThroughCacheRuleRequest - 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.ValidationException - There was an exception validating this request.PullThroughCacheRuleNotFoundException - The pull through cache rule was not found. Specify a valid pull through cache rule and try again.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePullThroughCacheRuleResponse deletePullThroughCacheRule(Consumer<DeletePullThroughCacheRuleRequest.Builder> deletePullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes a pull through cache rule.
This is a convenience which creates an instance of the DeletePullThroughCacheRuleRequest.Builder avoiding
the need to create one manually via DeletePullThroughCacheRuleRequest.builder()
deletePullThroughCacheRuleRequest - A Consumer that will call methods on DeletePullThroughCacheRuleRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ValidationException - There was an exception validating this request.PullThroughCacheRuleNotFoundException - The pull through cache rule was not found. Specify a valid pull through cache rule and try again.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRegistryPolicyResponse deleteRegistryPolicy(DeleteRegistryPolicyRequest deleteRegistryPolicyRequest) throws ServerException, InvalidParameterException, RegistryPolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Deletes the registry permissions policy.
deleteRegistryPolicyRequest - 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.RegistryPolicyNotFoundException - The registry doesn't have an associated registry policy.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRegistryPolicyResponse deleteRegistryPolicy(Consumer<DeleteRegistryPolicyRequest.Builder> deleteRegistryPolicyRequest) throws ServerException, InvalidParameterException, RegistryPolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Deletes the registry permissions policy.
This is a convenience which creates an instance of the DeleteRegistryPolicyRequest.Builder avoiding the
need to create one manually via DeleteRegistryPolicyRequest.builder()
deleteRegistryPolicyRequest - A Consumer that will call methods on DeleteRegistryPolicyRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RegistryPolicyNotFoundException - The registry doesn't have an associated registry policy.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRepositoryResponse deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryNotEmptyException, KmsException, AwsServiceException, SdkClientException, EcrException
Deletes a repository. If the repository contains images, you must either delete all images in the repository or
use the force option to delete the repository.
deleteRepositoryRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.RepositoryNotEmptyException - The specified repository contains images. To delete a repository that contains images, you must force the
deletion with the force parameter.KmsException - The operation failed due to a KMS exception.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRepositoryResponse deleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryNotEmptyException, KmsException, AwsServiceException, SdkClientException, EcrException
Deletes a repository. If the repository contains images, you must either delete all images in the repository or
use the force option to delete the repository.
This is a convenience which creates an instance of the DeleteRepositoryRequest.Builder avoiding the need
to create one manually via DeleteRepositoryRequest.builder()
deleteRepositoryRequest - A Consumer that will call methods on DeleteRepositoryRequest.Builder to create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.RepositoryNotEmptyException - The specified repository contains images. To delete a repository that contains images, you must force the
deletion with the force parameter.KmsException - The operation failed due to a KMS exception.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRepositoryPolicyResponse deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes the repository policy associated with the specified repository.
deleteRepositoryPolicyRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.RepositoryPolicyNotFoundException - The specified repository and registry combination does not have an associated repository policy.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRepositoryPolicyResponse deleteRepositoryPolicy(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes the repository policy associated with the specified repository.
This is a convenience which creates an instance of the DeleteRepositoryPolicyRequest.Builder avoiding the
need to create one manually via DeleteRepositoryPolicyRequest.builder()
deleteRepositoryPolicyRequest - A Consumer that will call methods on DeleteRepositoryPolicyRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.RepositoryPolicyNotFoundException - The specified repository and registry combination does not have an associated repository policy.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImageReplicationStatusResponse describeImageReplicationStatus(DescribeImageReplicationStatusRequest describeImageReplicationStatusRequest) throws ServerException, InvalidParameterException, ImageNotFoundException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Returns the replication status for a specified image.
describeImageReplicationStatusRequest - 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.ImageNotFoundException - The image requested does not exist in the specified repository.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImageReplicationStatusResponse describeImageReplicationStatus(Consumer<DescribeImageReplicationStatusRequest.Builder> describeImageReplicationStatusRequest) throws ServerException, InvalidParameterException, ImageNotFoundException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Returns the replication status for a specified image.
This is a convenience which creates an instance of the DescribeImageReplicationStatusRequest.Builder
avoiding the need to create one manually via DescribeImageReplicationStatusRequest.builder()
describeImageReplicationStatusRequest - A Consumer that will call methods on DescribeImageReplicationStatusRequest.Builder to
create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ImageNotFoundException - The image requested does not exist in the specified repository.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImageScanFindingsResponse describeImageScanFindings(DescribeImageScanFindingsRequest describeImageScanFindingsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, ScanNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Returns the scan findings for the specified image.
describeImageScanFindingsRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ImageNotFoundException - The image requested does not exist in the specified repository.ScanNotFoundException - The specified image scan could not be found. Ensure that image scanning is enabled on the repository and
try again.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImageScanFindingsResponse describeImageScanFindings(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, ScanNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Returns the scan findings for the specified image.
This is a convenience which creates an instance of the DescribeImageScanFindingsRequest.Builder avoiding
the need to create one manually via DescribeImageScanFindingsRequest.builder()
describeImageScanFindingsRequest - A Consumer that will call methods on DescribeImageScanFindingsRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ImageNotFoundException - The image requested does not exist in the specified repository.ScanNotFoundException - The specified image scan could not be found. Ensure that image scanning is enabled on the repository and
try again.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImageScanFindingsIterable describeImageScanFindingsPaginator(DescribeImageScanFindingsRequest describeImageScanFindingsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, ScanNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Returns the scan findings for the specified image.
This is a variant of
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client.describeImageScanFindingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client
.describeImageScanFindingsPaginator(request);
for (software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client.describeImageScanFindingsPaginator(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
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation.
describeImageScanFindingsRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ImageNotFoundException - The image requested does not exist in the specified repository.ScanNotFoundException - The specified image scan could not be found. Ensure that image scanning is enabled on the repository and
try again.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImageScanFindingsIterable describeImageScanFindingsPaginator(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, ScanNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Returns the scan findings for the specified image.
This is a variant of
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client.describeImageScanFindingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client
.describeImageScanFindingsPaginator(request);
for (software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client.describeImageScanFindingsPaginator(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
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation.
This is a convenience which creates an instance of the DescribeImageScanFindingsRequest.Builder avoiding
the need to create one manually via DescribeImageScanFindingsRequest.builder()
describeImageScanFindingsRequest - A Consumer that will call methods on DescribeImageScanFindingsRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ImageNotFoundException - The image requested does not exist in the specified repository.ScanNotFoundException - The specified image scan could not be found. Ensure that image scanning is enabled on the repository and
try again.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImagesResponse describeImages(DescribeImagesRequest describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException
Returns metadata about the images in a repository.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker
registry. The output of the docker images command shows the uncompressed image size, so it may
return a larger image size than the image sizes returned by DescribeImages.
describeImagesRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ImageNotFoundException - The image requested does not exist in the specified repository.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImagesResponse describeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException
Returns metadata about the images in a repository.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker
registry. The output of the docker images command shows the uncompressed image size, so it may
return a larger image size than the image sizes returned by DescribeImages.
This is a convenience which creates an instance of the DescribeImagesRequest.Builder avoiding the need to
create one manually via DescribeImagesRequest.builder()
describeImagesRequest - A Consumer that will call methods on DescribeImagesRequest.Builder to create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ImageNotFoundException - The image requested does not exist in the specified repository.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImagesIterable describeImagesPaginator(DescribeImagesRequest describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException
Returns metadata about the images in a repository.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker
registry. The output of the docker images command shows the uncompressed image size, so it may
return a larger image size than the image sizes returned by DescribeImages.
This is a variant of describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
for (software.amazon.awssdk.services.ecr.model.DescribeImagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecr.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.ecr.model.DescribeImagesRequest) operation.
describeImagesRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ImageNotFoundException - The image requested does not exist in the specified repository.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeImagesIterable describeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException
Returns metadata about the images in a repository.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker
registry. The output of the docker images command shows the uncompressed image size, so it may
return a larger image size than the image sizes returned by DescribeImages.
This is a variant of describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
for (software.amazon.awssdk.services.ecr.model.DescribeImagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecr.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.ecr.model.DescribeImagesRequest) operation.
This is a convenience which creates an instance of the DescribeImagesRequest.Builder avoiding the need to
create one manually via DescribeImagesRequest.builder()
describeImagesRequest - A Consumer that will call methods on DescribeImagesRequest.Builder to create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ImageNotFoundException - The image requested does not exist in the specified repository.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePullThroughCacheRulesResponse describePullThroughCacheRules(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException
Returns the pull through cache rules for a registry.
describePullThroughCacheRulesRequest - 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.ValidationException - There was an exception validating this request.PullThroughCacheRuleNotFoundException - The pull through cache rule was not found. Specify a valid pull through cache rule and try again.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePullThroughCacheRulesResponse describePullThroughCacheRules(Consumer<DescribePullThroughCacheRulesRequest.Builder> describePullThroughCacheRulesRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException
Returns the pull through cache rules for a registry.
This is a convenience which creates an instance of the DescribePullThroughCacheRulesRequest.Builder
avoiding the need to create one manually via DescribePullThroughCacheRulesRequest.builder()
describePullThroughCacheRulesRequest - A Consumer that will call methods on DescribePullThroughCacheRulesRequest.Builder to
create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ValidationException - There was an exception validating this request.PullThroughCacheRuleNotFoundException - The pull through cache rule was not found. Specify a valid pull through cache rule and try again.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePullThroughCacheRulesIterable describePullThroughCacheRulesPaginator(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException
Returns the pull through cache rules for a registry.
This is a variant of
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client.describePullThroughCacheRulesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client
.describePullThroughCacheRulesPaginator(request);
for (software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client.describePullThroughCacheRulesPaginator(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
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation.
describePullThroughCacheRulesRequest - 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.ValidationException - There was an exception validating this request.PullThroughCacheRuleNotFoundException - The pull through cache rule was not found. Specify a valid pull through cache rule and try again.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePullThroughCacheRulesIterable describePullThroughCacheRulesPaginator(Consumer<DescribePullThroughCacheRulesRequest.Builder> describePullThroughCacheRulesRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException
Returns the pull through cache rules for a registry.
This is a variant of
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client.describePullThroughCacheRulesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client
.describePullThroughCacheRulesPaginator(request);
for (software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client.describePullThroughCacheRulesPaginator(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
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation.
This is a convenience which creates an instance of the DescribePullThroughCacheRulesRequest.Builder
avoiding the need to create one manually via DescribePullThroughCacheRulesRequest.builder()
describePullThroughCacheRulesRequest - A Consumer that will call methods on DescribePullThroughCacheRulesRequest.Builder to
create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ValidationException - There was an exception validating this request.PullThroughCacheRuleNotFoundException - The pull through cache rule was not found. Specify a valid pull through cache rule and try again.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRegistryResponse describeRegistry(DescribeRegistryRequest describeRegistryRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
describeRegistryRequest - 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.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRegistryResponse describeRegistry(Consumer<DescribeRegistryRequest.Builder> describeRegistryRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
This is a convenience which creates an instance of the DescribeRegistryRequest.Builder avoiding the need
to create one manually via DescribeRegistryRequest.builder()
describeRegistryRequest - A Consumer that will call methods on DescribeRegistryRequest.Builder to create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRepositoriesResponse describeRepositories() throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Describes image repositories in a registry.
ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeRepositories(DescribeRepositoriesRequest),
AWS API
Documentationdefault DescribeRepositoriesResponse describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Describes image repositories in a registry.
describeRepositoriesRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRepositoriesResponse describeRepositories(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Describes image repositories in a registry.
This is a convenience which creates an instance of the DescribeRepositoriesRequest.Builder avoiding the
need to create one manually via DescribeRepositoriesRequest.builder()
describeRepositoriesRequest - A Consumer that will call methods on DescribeRepositoriesRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRepositoriesIterable describeRepositoriesPaginator() throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Describes image repositories in a registry.
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client
.describeRepositoriesPaginator(request);
for (software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecr.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.ecr.model.DescribeRepositoriesRequest)
operation.
ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeRepositoriesPaginator(DescribeRepositoriesRequest),
AWS API
Documentationdefault DescribeRepositoriesIterable describeRepositoriesPaginator(DescribeRepositoriesRequest describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Describes image repositories in a registry.
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client
.describeRepositoriesPaginator(request);
for (software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecr.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.ecr.model.DescribeRepositoriesRequest)
operation.
describeRepositoriesRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRepositoriesIterable describeRepositoriesPaginator(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Describes image repositories in a registry.
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client
.describeRepositoriesPaginator(request);
for (software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecr.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.ecr.model.DescribeRepositoriesRequest)
operation.
This is a convenience which creates an instance of the DescribeRepositoriesRequest.Builder avoiding the
need to create one manually via DescribeRepositoriesRequest.builder()
describeRepositoriesRequest - A Consumer that will call methods on DescribeRepositoriesRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAuthorizationTokenResponse getAuthorizationToken() throws ServerException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException
Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.
The authorizationToken returned is a base64 encoded string that can be decoded and used in a
docker login command to authenticate to a registry. The CLI offers an
get-login-password command that simplifies the login process. For more information, see Registry
authentication in the Amazon Elastic Container Registry User Guide.
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.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetAuthorizationToken(GetAuthorizationTokenRequest),
AWS API
Documentationdefault GetAuthorizationTokenResponse getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest) throws ServerException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException
Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.
The authorizationToken returned is a base64 encoded string that can be decoded and used in a
docker login command to authenticate to a registry. The CLI offers an
get-login-password command that simplifies the login process. For more information, see Registry
authentication in the Amazon Elastic Container Registry User Guide.
getAuthorizationTokenRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetAuthorizationTokenResponse getAuthorizationToken(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest) throws ServerException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException
Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.
The authorizationToken returned is a base64 encoded string that can be decoded and used in a
docker login command to authenticate to a registry. The CLI offers an
get-login-password command that simplifies the login process. For more information, see Registry
authentication in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the GetAuthorizationTokenRequest.Builder avoiding the
need to create one manually via GetAuthorizationTokenRequest.builder()
getAuthorizationTokenRequest - A Consumer that will call methods on GetAuthorizationTokenRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDownloadUrlForLayerResponse getDownloadUrlForLayer(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest) throws ServerException, InvalidParameterException, LayersNotFoundException, LayerInaccessibleException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.
When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
getDownloadUrlForLayerRequest - 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.LayersNotFoundException - The specified layers could not be found, or the specified layer is not valid for this repository.LayerInaccessibleException - The specified layer is not available because it is not associated with an image. Unassociated image
layers may be cleaned up at any time.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetDownloadUrlForLayerResponse getDownloadUrlForLayer(Consumer<GetDownloadUrlForLayerRequest.Builder> getDownloadUrlForLayerRequest) throws ServerException, InvalidParameterException, LayersNotFoundException, LayerInaccessibleException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.
When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
This is a convenience which creates an instance of the GetDownloadUrlForLayerRequest.Builder avoiding the
need to create one manually via GetDownloadUrlForLayerRequest.builder()
getDownloadUrlForLayerRequest - A Consumer that will call methods on GetDownloadUrlForLayerRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.LayersNotFoundException - The specified layers could not be found, or the specified layer is not valid for this repository.LayerInaccessibleException - The specified layer is not available because it is not associated with an image. Unassociated image
layers may be cleaned up at any time.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLifecyclePolicyResponse getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the lifecycle policy for the specified repository.
getLifecyclePolicyRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.LifecyclePolicyNotFoundException - The lifecycle policy could not be found, and no policy is set to the repository.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLifecyclePolicyResponse getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the lifecycle policy for the specified repository.
This is a convenience which creates an instance of the GetLifecyclePolicyRequest.Builder avoiding the
need to create one manually via GetLifecyclePolicyRequest.builder()
getLifecyclePolicyRequest - A Consumer that will call methods on GetLifecyclePolicyRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.LifecyclePolicyNotFoundException - The lifecycle policy could not be found, and no policy is set to the repository.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLifecyclePolicyPreviewResponse getLifecyclePolicyPreview(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyPreviewNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the results of the lifecycle policy preview request for the specified repository.
getLifecyclePolicyPreviewRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.LifecyclePolicyPreviewNotFoundException - There is no dry run for this repository.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLifecyclePolicyPreviewResponse getLifecyclePolicyPreview(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyPreviewNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the results of the lifecycle policy preview request for the specified repository.
This is a convenience which creates an instance of the GetLifecyclePolicyPreviewRequest.Builder avoiding
the need to create one manually via GetLifecyclePolicyPreviewRequest.builder()
getLifecyclePolicyPreviewRequest - A Consumer that will call methods on GetLifecyclePolicyPreviewRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.LifecyclePolicyPreviewNotFoundException - There is no dry run for this repository.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLifecyclePolicyPreviewIterable getLifecyclePolicyPreviewPaginator(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyPreviewNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the results of the lifecycle policy preview request for the specified repository.
This is a variant of
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client.getLifecyclePolicyPreviewPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client
.getLifecyclePolicyPreviewPaginator(request);
for (software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client.getLifecyclePolicyPreviewPaginator(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
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation.
getLifecyclePolicyPreviewRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.LifecyclePolicyPreviewNotFoundException - There is no dry run for this repository.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLifecyclePolicyPreviewIterable getLifecyclePolicyPreviewPaginator(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyPreviewNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the results of the lifecycle policy preview request for the specified repository.
This is a variant of
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client.getLifecyclePolicyPreviewPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client
.getLifecyclePolicyPreviewPaginator(request);
for (software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client.getLifecyclePolicyPreviewPaginator(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
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation.
This is a convenience which creates an instance of the GetLifecyclePolicyPreviewRequest.Builder avoiding
the need to create one manually via GetLifecyclePolicyPreviewRequest.builder()
getLifecyclePolicyPreviewRequest - A Consumer that will call methods on GetLifecyclePolicyPreviewRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.LifecyclePolicyPreviewNotFoundException - There is no dry run for this repository.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRegistryPolicyResponse getRegistryPolicy(GetRegistryPolicyRequest getRegistryPolicyRequest) throws ServerException, InvalidParameterException, RegistryPolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Retrieves the permissions policy for a registry.
getRegistryPolicyRequest - 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.RegistryPolicyNotFoundException - The registry doesn't have an associated registry policy.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRegistryPolicyResponse getRegistryPolicy(Consumer<GetRegistryPolicyRequest.Builder> getRegistryPolicyRequest) throws ServerException, InvalidParameterException, RegistryPolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Retrieves the permissions policy for a registry.
This is a convenience which creates an instance of the GetRegistryPolicyRequest.Builder avoiding the need
to create one manually via GetRegistryPolicyRequest.builder()
getRegistryPolicyRequest - A Consumer that will call methods on GetRegistryPolicyRequest.Builder to create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RegistryPolicyNotFoundException - The registry doesn't have an associated registry policy.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRegistryScanningConfigurationResponse getRegistryScanningConfiguration(GetRegistryScanningConfigurationRequest getRegistryScanningConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Retrieves the scanning configuration for a registry.
getRegistryScanningConfigurationRequest - 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.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRegistryScanningConfigurationResponse getRegistryScanningConfiguration(Consumer<GetRegistryScanningConfigurationRequest.Builder> getRegistryScanningConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Retrieves the scanning configuration for a registry.
This is a convenience which creates an instance of the GetRegistryScanningConfigurationRequest.Builder
avoiding the need to create one manually via GetRegistryScanningConfigurationRequest.builder()
getRegistryScanningConfigurationRequest - A Consumer that will call methods on GetRegistryScanningConfigurationRequest.Builder to
create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRepositoryPolicyResponse getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the repository policy for the specified repository.
getRepositoryPolicyRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.RepositoryPolicyNotFoundException - The specified repository and registry combination does not have an associated repository policy.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetRepositoryPolicyResponse getRepositoryPolicy(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the repository policy for the specified repository.
This is a convenience which creates an instance of the GetRepositoryPolicyRequest.Builder avoiding the
need to create one manually via GetRepositoryPolicyRequest.builder()
getRepositoryPolicyRequest - A Consumer that will call methods on GetRepositoryPolicyRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.RepositoryPolicyNotFoundException - The specified repository and registry combination does not have an associated repository policy.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault InitiateLayerUploadResponse initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, KmsException, AwsServiceException, SdkClientException, EcrException
Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
initiateLayerUploadRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.KmsException - The operation failed due to a KMS exception.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault InitiateLayerUploadResponse initiateLayerUpload(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, KmsException, AwsServiceException, SdkClientException, EcrException
Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
This is a convenience which creates an instance of the InitiateLayerUploadRequest.Builder avoiding the
need to create one manually via InitiateLayerUploadRequest.builder()
initiateLayerUploadRequest - A Consumer that will call methods on InitiateLayerUploadRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.KmsException - The operation failed due to a KMS exception.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImagesResponse listImages(ListImagesRequest listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Lists all the image IDs for the specified repository.
You can filter images based on whether or not they are tagged by using the tagStatus filter and
specifying either TAGGED, UNTAGGED or ANY. For example, you can filter
your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage
operation to delete them. Or, you can filter your results to return only TAGGED images to list all
of the tags in your repository.
listImagesRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImagesResponse listImages(Consumer<ListImagesRequest.Builder> listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Lists all the image IDs for the specified repository.
You can filter images based on whether or not they are tagged by using the tagStatus filter and
specifying either TAGGED, UNTAGGED or ANY. For example, you can filter
your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage
operation to delete them. Or, you can filter your results to return only TAGGED images to list all
of the tags in your repository.
This is a convenience which creates an instance of the ListImagesRequest.Builder avoiding the need to
create one manually via ListImagesRequest.builder()
listImagesRequest - A Consumer that will call methods on ListImagesRequest.Builder to create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImagesIterable listImagesPaginator(ListImagesRequest listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Lists all the image IDs for the specified repository.
You can filter images based on whether or not they are tagged by using the tagStatus filter and
specifying either TAGGED, UNTAGGED or ANY. For example, you can filter
your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage
operation to delete them. Or, you can filter your results to return only TAGGED images to list all
of the tags in your repository.
This is a variant of listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request);
for (software.amazon.awssdk.services.ecr.model.ListImagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(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
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest) operation.
listImagesRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListImagesIterable listImagesPaginator(Consumer<ListImagesRequest.Builder> listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Lists all the image IDs for the specified repository.
You can filter images based on whether or not they are tagged by using the tagStatus filter and
specifying either TAGGED, UNTAGGED or ANY. For example, you can filter
your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage
operation to delete them. Or, you can filter your results to return only TAGGED images to list all
of the tags in your repository.
This is a variant of listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request);
for (software.amazon.awssdk.services.ecr.model.ListImagesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(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
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest) operation.
This is a convenience which creates an instance of the ListImagesRequest.Builder avoiding the need to
create one manually via ListImagesRequest.builder()
listImagesRequest - A Consumer that will call methods on ListImagesRequest.Builder to create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidParameterException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException
List the tags for an Amazon ECR resource.
listTagsForResourceRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidParameterException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException
List the tags for an Amazon ECR resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutImageResponse putImage(PutImageRequest putImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageAlreadyExistsException, LayersNotFoundException, ReferencedImagesNotFoundException, LimitExceededException, ImageTagAlreadyExistsException, ImageDigestDoesNotMatchException, KmsException, AwsServiceException, SdkClientException, EcrException
Creates or updates the image manifest and tags associated with an image.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
putImageRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ImageAlreadyExistsException - The specified image has already been pushed, and there were no changes to the manifest or image tag after
the last push.LayersNotFoundException - The specified layers could not be found, or the specified layer is not valid for this repository.ReferencedImagesNotFoundException - The manifest list is referencing an image that does not exist.LimitExceededException - The operation did not succeed because it would have exceeded a service limit for your account. For more
information, see Amazon ECR service
quotas in the Amazon Elastic Container Registry User Guide.ImageTagAlreadyExistsException - The specified image is tagged with a tag that already exists. The repository is configured for tag
immutability.ImageDigestDoesNotMatchException - The specified image digest does not match the digest that Amazon ECR calculated for the image.KmsException - The operation failed due to a KMS exception.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutImageResponse putImage(Consumer<PutImageRequest.Builder> putImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageAlreadyExistsException, LayersNotFoundException, ReferencedImagesNotFoundException, LimitExceededException, ImageTagAlreadyExistsException, ImageDigestDoesNotMatchException, KmsException, AwsServiceException, SdkClientException, EcrException
Creates or updates the image manifest and tags associated with an image.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
This is a convenience which creates an instance of the PutImageRequest.Builder avoiding the need to
create one manually via PutImageRequest.builder()
putImageRequest - A Consumer that will call methods on PutImageRequest.Builder to create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ImageAlreadyExistsException - The specified image has already been pushed, and there were no changes to the manifest or image tag after
the last push.LayersNotFoundException - The specified layers could not be found, or the specified layer is not valid for this repository.ReferencedImagesNotFoundException - The manifest list is referencing an image that does not exist.LimitExceededException - The operation did not succeed because it would have exceeded a service limit for your account. For more
information, see Amazon ECR service
quotas in the Amazon Elastic Container Registry User Guide.ImageTagAlreadyExistsException - The specified image is tagged with a tag that already exists. The repository is configured for tag
immutability.ImageDigestDoesNotMatchException - The specified image digest does not match the digest that Amazon ECR calculated for the image.KmsException - The operation failed due to a KMS exception.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutImageScanningConfigurationResponse putImageScanningConfiguration(PutImageScanningConfigurationRequest putImageScanningConfigurationRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
The PutImageScanningConfiguration API is being deprecated, in favor of specifying the image scanning
configuration at the registry level. For more information, see PutRegistryScanningConfiguration.
Updates the image scanning configuration for the specified repository.
putImageScanningConfigurationRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutImageScanningConfigurationResponse putImageScanningConfiguration(Consumer<PutImageScanningConfigurationRequest.Builder> putImageScanningConfigurationRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
The PutImageScanningConfiguration API is being deprecated, in favor of specifying the image scanning
configuration at the registry level. For more information, see PutRegistryScanningConfiguration.
Updates the image scanning configuration for the specified repository.
This is a convenience which creates an instance of the PutImageScanningConfigurationRequest.Builder
avoiding the need to create one manually via PutImageScanningConfigurationRequest.builder()
putImageScanningConfigurationRequest - A Consumer that will call methods on PutImageScanningConfigurationRequest.Builder to
create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutImageTagMutabilityResponse putImageTagMutability(PutImageTagMutabilityRequest putImageTagMutabilityRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Updates the image tag mutability settings for the specified repository. For more information, see Image tag mutability in the Amazon Elastic Container Registry User Guide.
putImageTagMutabilityRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutImageTagMutabilityResponse putImageTagMutability(Consumer<PutImageTagMutabilityRequest.Builder> putImageTagMutabilityRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Updates the image tag mutability settings for the specified repository. For more information, see Image tag mutability in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the PutImageTagMutabilityRequest.Builder avoiding the
need to create one manually via PutImageTagMutabilityRequest.builder()
putImageTagMutabilityRequest - A Consumer that will call methods on PutImageTagMutabilityRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutLifecyclePolicyResponse putLifecyclePolicy(PutLifecyclePolicyRequest putLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.
putLifecyclePolicyRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutLifecyclePolicyResponse putLifecyclePolicy(Consumer<PutLifecyclePolicyRequest.Builder> putLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.
This is a convenience which creates an instance of the PutLifecyclePolicyRequest.Builder avoiding the
need to create one manually via PutLifecyclePolicyRequest.builder()
putLifecyclePolicyRequest - A Consumer that will call methods on PutLifecyclePolicyRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRegistryPolicyResponse putRegistryPolicy(PutRegistryPolicyRequest putRegistryPolicyRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Creates or updates the permissions policy for your registry.
A registry policy is used to specify permissions for another Amazon Web Services account and is used when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.
putRegistryPolicyRequest - 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.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRegistryPolicyResponse putRegistryPolicy(Consumer<PutRegistryPolicyRequest.Builder> putRegistryPolicyRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Creates or updates the permissions policy for your registry.
A registry policy is used to specify permissions for another Amazon Web Services account and is used when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the PutRegistryPolicyRequest.Builder avoiding the need
to create one manually via PutRegistryPolicyRequest.builder()
putRegistryPolicyRequest - A Consumer that will call methods on PutRegistryPolicyRequest.Builder to create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRegistryScanningConfigurationResponse putRegistryScanningConfiguration(PutRegistryScanningConfigurationRequest putRegistryScanningConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Creates or updates the scanning configuration for your private registry.
putRegistryScanningConfigurationRequest - 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.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRegistryScanningConfigurationResponse putRegistryScanningConfiguration(Consumer<PutRegistryScanningConfigurationRequest.Builder> putRegistryScanningConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Creates or updates the scanning configuration for your private registry.
This is a convenience which creates an instance of the PutRegistryScanningConfigurationRequest.Builder
avoiding the need to create one manually via PutRegistryScanningConfigurationRequest.builder()
putRegistryScanningConfigurationRequest - A Consumer that will call methods on PutRegistryScanningConfigurationRequest.Builder to
create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutReplicationConfigurationResponse putReplicationConfiguration(PutReplicationConfigurationRequest putReplicationConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see Using service-linked roles for Amazon ECR in the Amazon Elastic Container Registry User Guide.
When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a registry permissions policy. For more information, see PutRegistryPolicy.
putReplicationConfigurationRequest - 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.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutReplicationConfigurationResponse putReplicationConfiguration(Consumer<PutReplicationConfigurationRequest.Builder> putReplicationConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException
Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see Using service-linked roles for Amazon ECR in the Amazon Elastic Container Registry User Guide.
When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a registry permissions policy. For more information, see PutRegistryPolicy.
This is a convenience which creates an instance of the PutReplicationConfigurationRequest.Builder
avoiding the need to create one manually via PutReplicationConfigurationRequest.builder()
putReplicationConfigurationRequest - A Consumer that will call methods on PutReplicationConfigurationRequest.Builder to create
a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetRepositoryPolicyResponse setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Applies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository policies in the Amazon Elastic Container Registry User Guide.
setRepositoryPolicyRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault SetRepositoryPolicyResponse setRepositoryPolicy(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Applies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository policies in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the SetRepositoryPolicyRequest.Builder avoiding the
need to create one manually via SetRepositoryPolicyRequest.builder()
setRepositoryPolicyRequest - A Consumer that will call methods on SetRepositoryPolicyRequest.Builder to create a
request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartImageScanResponse startImageScan(StartImageScanRequest startImageScanRequest) throws ServerException, InvalidParameterException, UnsupportedImageTypeException, LimitExceededException, RepositoryNotFoundException, ImageNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Starts an image vulnerability scan. An image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image scanning in the Amazon Elastic Container Registry User Guide.
startImageScanRequest - 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.UnsupportedImageTypeException - The image is of a type that cannot be scanned.LimitExceededException - The operation did not succeed because it would have exceeded a service limit for your account. For more
information, see Amazon ECR service
quotas in the Amazon Elastic Container Registry User Guide.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ImageNotFoundException - The image requested does not exist in the specified repository.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartImageScanResponse startImageScan(Consumer<StartImageScanRequest.Builder> startImageScanRequest) throws ServerException, InvalidParameterException, UnsupportedImageTypeException, LimitExceededException, RepositoryNotFoundException, ImageNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException
Starts an image vulnerability scan. An image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image scanning in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the StartImageScanRequest.Builder avoiding the need to
create one manually via StartImageScanRequest.builder()
startImageScanRequest - A Consumer that will call methods on StartImageScanRequest.Builder to create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.UnsupportedImageTypeException - The image is of a type that cannot be scanned.LimitExceededException - The operation did not succeed because it would have exceeded a service limit for your account. For more
information, see Amazon ECR service
quotas in the Amazon Elastic Container Registry User Guide.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.ImageNotFoundException - The image requested does not exist in the specified repository.ValidationException - There was an exception validating this request.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartLifecyclePolicyPreviewResponse startLifecyclePolicyPreview(StartLifecyclePolicyPreviewRequest startLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, LifecyclePolicyPreviewInProgressException, AwsServiceException, SdkClientException, EcrException
Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.
startLifecyclePolicyPreviewRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.LifecyclePolicyNotFoundException - The lifecycle policy could not be found, and no policy is set to the repository.LifecyclePolicyPreviewInProgressException - The previous lifecycle policy preview request has not completed. Wait and try again.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartLifecyclePolicyPreviewResponse startLifecyclePolicyPreview(Consumer<StartLifecyclePolicyPreviewRequest.Builder> startLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, LifecyclePolicyPreviewInProgressException, AwsServiceException, SdkClientException, EcrException
Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.
This is a convenience which creates an instance of the StartLifecyclePolicyPreviewRequest.Builder
avoiding the need to create one manually via StartLifecyclePolicyPreviewRequest.builder()
startLifecyclePolicyPreviewRequest - A Consumer that will call methods on StartLifecyclePolicyPreviewRequest.Builder to create
a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.LifecyclePolicyNotFoundException - The lifecycle policy could not be found, and no policy is set to the repository.LifecyclePolicyPreviewInProgressException - The previous lifecycle policy preview request has not completed. Wait and try again.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException
Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
tagResourceRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.InvalidTagParameterException - An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters,
and tag values can have a maximum length of 256 characters.TooManyTagsException - The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a
repository is 50.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException
Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.InvalidTagParameterException - An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters,
and tag values can have a maximum length of 256 characters.TooManyTagsException - The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a
repository is 50.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException
Deletes specified tags from a resource.
untagResourceRequest - InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.InvalidTagParameterException - An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters,
and tag values can have a maximum length of 256 characters.TooManyTagsException - The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a
repository is 50.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException
Deletes specified tags from a resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.InvalidTagParameterException - An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters,
and tag values can have a maximum length of 256 characters.TooManyTagsException - The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a
repository is 50.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UploadLayerPartResponse uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest) throws ServerException, InvalidParameterException, InvalidLayerPartException, RepositoryNotFoundException, UploadNotFoundException, LimitExceededException, KmsException, AwsServiceException, SdkClientException, EcrException
Uploads an image layer part to Amazon ECR.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
uploadLayerPartRequest - ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.InvalidLayerPartException - The layer part size is not valid, or the first byte specified is not consecutive to the last byte of a
previous layer part upload.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.UploadNotFoundException - The upload could not be found, or the specified upload ID is not valid for this repository.LimitExceededException - The operation did not succeed because it would have exceeded a service limit for your account. For more
information, see Amazon ECR service
quotas in the Amazon Elastic Container Registry User Guide.KmsException - The operation failed due to a KMS exception.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UploadLayerPartResponse uploadLayerPart(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest) throws ServerException, InvalidParameterException, InvalidLayerPartException, RepositoryNotFoundException, UploadNotFoundException, LimitExceededException, KmsException, AwsServiceException, SdkClientException, EcrException
Uploads an image layer part to Amazon ECR.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
This is a convenience which creates an instance of the UploadLayerPartRequest.Builder avoiding the need
to create one manually via UploadLayerPartRequest.builder()
uploadLayerPartRequest - A Consumer that will call methods on UploadLayerPartRequest.Builder to create a request.ServerException - These errors are usually caused by a server-side issue.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.InvalidLayerPartException - The layer part size is not valid, or the first byte specified is not consecutive to the last byte of a
previous layer part upload.RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure
that you are performing operations on the correct registry.UploadNotFoundException - The upload could not be found, or the specified upload ID is not valid for this repository.LimitExceededException - The operation did not succeed because it would have exceeded a service limit for your account. For more
information, see Amazon ECR service
quotas in the Amazon Elastic Container Registry User Guide.KmsException - The operation failed due to a KMS exception.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.EcrException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EcrWaiter waiter()
EcrWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
EcrWaiterstatic EcrClient create()
EcrClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static EcrClientBuilder builder()
EcrClient.static ServiceMetadata serviceMetadata()
default EcrServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.