Interface EcrAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchCheckLayerAvailability
(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest) Checks the availability of one or more image layers in a repository.batchCheckLayerAvailability
(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) Checks the availability of one or more image layers in a repository.batchDeleteImage
(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest) Deletes a list of specified images within a repository.batchDeleteImage
(BatchDeleteImageRequest batchDeleteImageRequest) Deletes a list of specified images within a repository.default CompletableFuture
<BatchGetImageResponse> batchGetImage
(Consumer<BatchGetImageRequest.Builder> batchGetImageRequest) Gets detailed information for an image.default CompletableFuture
<BatchGetImageResponse> batchGetImage
(BatchGetImageRequest batchGetImageRequest) Gets detailed information for an image.batchGetRepositoryScanningConfiguration
(Consumer<BatchGetRepositoryScanningConfigurationRequest.Builder> batchGetRepositoryScanningConfigurationRequest) Gets the scanning configuration for one or more repositories.batchGetRepositoryScanningConfiguration
(BatchGetRepositoryScanningConfigurationRequest batchGetRepositoryScanningConfigurationRequest) Gets the scanning configuration for one or more repositories.static EcrAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aEcrAsyncClient
.completeLayerUpload
(Consumer<CompleteLayerUploadRequest.Builder> completeLayerUploadRequest) Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID.completeLayerUpload
(CompleteLayerUploadRequest completeLayerUploadRequest) Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID.static EcrAsyncClient
create()
Create aEcrAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createPullThroughCacheRule
(Consumer<CreatePullThroughCacheRuleRequest.Builder> createPullThroughCacheRuleRequest) Creates a pull through cache rule.createPullThroughCacheRule
(CreatePullThroughCacheRuleRequest createPullThroughCacheRuleRequest) Creates a pull through cache rule.createRepository
(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) Creates a repository.createRepository
(CreateRepositoryRequest createRepositoryRequest) Creates a repository.deleteLifecyclePolicy
(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest) Deletes the lifecycle policy associated with the specified repository.deleteLifecyclePolicy
(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest) Deletes the lifecycle policy associated with the specified repository.deletePullThroughCacheRule
(Consumer<DeletePullThroughCacheRuleRequest.Builder> deletePullThroughCacheRuleRequest) Deletes a pull through cache rule.deletePullThroughCacheRule
(DeletePullThroughCacheRuleRequest deletePullThroughCacheRuleRequest) Deletes a pull through cache rule.deleteRegistryPolicy
(Consumer<DeleteRegistryPolicyRequest.Builder> deleteRegistryPolicyRequest) Deletes the registry permissions policy.deleteRegistryPolicy
(DeleteRegistryPolicyRequest deleteRegistryPolicyRequest) Deletes the registry permissions policy.deleteRepository
(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) Deletes a repository.deleteRepository
(DeleteRepositoryRequest deleteRepositoryRequest) Deletes a repository.deleteRepositoryPolicy
(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest) Deletes the repository policy associated with the specified repository.deleteRepositoryPolicy
(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) Deletes the repository policy associated with the specified repository.describeImageReplicationStatus
(Consumer<DescribeImageReplicationStatusRequest.Builder> describeImageReplicationStatusRequest) Returns the replication status for a specified image.describeImageReplicationStatus
(DescribeImageReplicationStatusRequest describeImageReplicationStatusRequest) Returns the replication status for a specified image.default CompletableFuture
<DescribeImagesResponse> describeImages
(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) Returns metadata about the images in a repository.default CompletableFuture
<DescribeImagesResponse> describeImages
(DescribeImagesRequest describeImagesRequest) Returns metadata about the images in a repository.describeImageScanFindings
(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest) Returns the scan findings for the specified image.describeImageScanFindings
(DescribeImageScanFindingsRequest describeImageScanFindingsRequest) Returns the scan findings for the specified image.describeImageScanFindingsPaginator
(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest) This is a variant ofdescribeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation.describeImageScanFindingsPaginator
(DescribeImageScanFindingsRequest describeImageScanFindingsRequest) This is a variant ofdescribeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation.default DescribeImagesPublisher
describeImagesPaginator
(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) This is a variant ofdescribeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation.default DescribeImagesPublisher
describeImagesPaginator
(DescribeImagesRequest describeImagesRequest) This is a variant ofdescribeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation.describePullThroughCacheRules
(Consumer<DescribePullThroughCacheRulesRequest.Builder> describePullThroughCacheRulesRequest) Returns the pull through cache rules for a registry.describePullThroughCacheRules
(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest) Returns the pull through cache rules for a registry.describePullThroughCacheRulesPaginator
(Consumer<DescribePullThroughCacheRulesRequest.Builder> describePullThroughCacheRulesRequest) This is a variant ofdescribePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation.describePullThroughCacheRulesPaginator
(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest) This is a variant ofdescribePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation.describeRegistry
(Consumer<DescribeRegistryRequest.Builder> describeRegistryRequest) Describes the settings for a registry.describeRegistry
(DescribeRegistryRequest describeRegistryRequest) Describes the settings for a registry.Describes image repositories in a registry.describeRepositories
(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) Describes image repositories in a registry.describeRepositories
(DescribeRepositoriesRequest describeRepositoriesRequest) Describes image repositories in a registry.default DescribeRepositoriesPublisher
This is a variant ofdescribeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.default DescribeRepositoriesPublisher
describeRepositoriesPaginator
(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) This is a variant ofdescribeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.default DescribeRepositoriesPublisher
describeRepositoriesPaginator
(DescribeRepositoriesRequest describeRepositoriesRequest) This is a variant ofdescribeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.Retrieves an authorization token.getAuthorizationToken
(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest) Retrieves an authorization token.getAuthorizationToken
(GetAuthorizationTokenRequest getAuthorizationTokenRequest) Retrieves an authorization token.getDownloadUrlForLayer
(Consumer<GetDownloadUrlForLayerRequest.Builder> getDownloadUrlForLayerRequest) Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.getDownloadUrlForLayer
(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest) Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.getLifecyclePolicy
(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest) Retrieves the lifecycle policy for the specified repository.getLifecyclePolicy
(GetLifecyclePolicyRequest getLifecyclePolicyRequest) Retrieves the lifecycle policy for the specified repository.getLifecyclePolicyPreview
(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest) Retrieves the results of the lifecycle policy preview request for the specified repository.getLifecyclePolicyPreview
(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest) Retrieves the results of the lifecycle policy preview request for the specified repository.getLifecyclePolicyPreviewPaginator
(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest) This is a variant ofgetLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation.getLifecyclePolicyPreviewPaginator
(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest) This is a variant ofgetLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation.getRegistryPolicy
(Consumer<GetRegistryPolicyRequest.Builder> getRegistryPolicyRequest) Retrieves the permissions policy for a registry.getRegistryPolicy
(GetRegistryPolicyRequest getRegistryPolicyRequest) Retrieves the permissions policy for a registry.getRegistryScanningConfiguration
(Consumer<GetRegistryScanningConfigurationRequest.Builder> getRegistryScanningConfigurationRequest) Retrieves the scanning configuration for a registry.getRegistryScanningConfiguration
(GetRegistryScanningConfigurationRequest getRegistryScanningConfigurationRequest) Retrieves the scanning configuration for a registry.getRepositoryPolicy
(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest) Retrieves the repository policy for the specified repository.getRepositoryPolicy
(GetRepositoryPolicyRequest getRepositoryPolicyRequest) Retrieves the repository policy for the specified repository.initiateLayerUpload
(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest) Notifies Amazon ECR that you intend to upload an image layer.initiateLayerUpload
(InitiateLayerUploadRequest initiateLayerUploadRequest) Notifies Amazon ECR that you intend to upload an image layer.default CompletableFuture
<ListImagesResponse> listImages
(Consumer<ListImagesRequest.Builder> listImagesRequest) Lists all the image IDs for the specified repository.default CompletableFuture
<ListImagesResponse> listImages
(ListImagesRequest listImagesRequest) Lists all the image IDs for the specified repository.default ListImagesPublisher
listImagesPaginator
(Consumer<ListImagesRequest.Builder> listImagesRequest) This is a variant oflistImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)
operation.default ListImagesPublisher
listImagesPaginator
(ListImagesRequest listImagesRequest) This is a variant oflistImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags for an Amazon ECR resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List the tags for an Amazon ECR resource.default CompletableFuture
<PutImageResponse> putImage
(Consumer<PutImageRequest.Builder> putImageRequest) Creates or updates the image manifest and tags associated with an image.default CompletableFuture
<PutImageResponse> putImage
(PutImageRequest putImageRequest) Creates or updates the image manifest and tags associated with an image.putImageScanningConfiguration
(Consumer<PutImageScanningConfigurationRequest.Builder> putImageScanningConfigurationRequest) putImageScanningConfiguration
(PutImageScanningConfigurationRequest putImageScanningConfigurationRequest) putImageTagMutability
(Consumer<PutImageTagMutabilityRequest.Builder> putImageTagMutabilityRequest) Updates the image tag mutability settings for the specified repository.putImageTagMutability
(PutImageTagMutabilityRequest putImageTagMutabilityRequest) Updates the image tag mutability settings for the specified repository.putLifecyclePolicy
(Consumer<PutLifecyclePolicyRequest.Builder> putLifecyclePolicyRequest) Creates or updates the lifecycle policy for the specified repository.putLifecyclePolicy
(PutLifecyclePolicyRequest putLifecyclePolicyRequest) Creates or updates the lifecycle policy for the specified repository.putRegistryPolicy
(Consumer<PutRegistryPolicyRequest.Builder> putRegistryPolicyRequest) Creates or updates the permissions policy for your registry.putRegistryPolicy
(PutRegistryPolicyRequest putRegistryPolicyRequest) Creates or updates the permissions policy for your registry.putRegistryScanningConfiguration
(Consumer<PutRegistryScanningConfigurationRequest.Builder> putRegistryScanningConfigurationRequest) Creates or updates the scanning configuration for your private registry.putRegistryScanningConfiguration
(PutRegistryScanningConfigurationRequest putRegistryScanningConfigurationRequest) Creates or updates the scanning configuration for your private registry.putReplicationConfiguration
(Consumer<PutReplicationConfigurationRequest.Builder> putReplicationConfigurationRequest) Creates or updates the replication configuration for a registry.putReplicationConfiguration
(PutReplicationConfigurationRequest putReplicationConfigurationRequest) Creates or updates the replication configuration for a registry.default EcrServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationsetRepositoryPolicy
(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest) Applies a repository policy to the specified repository to control access permissions.setRepositoryPolicy
(SetRepositoryPolicyRequest setRepositoryPolicyRequest) Applies a repository policy to the specified repository to control access permissions.default CompletableFuture
<StartImageScanResponse> startImageScan
(Consumer<StartImageScanRequest.Builder> startImageScanRequest) Starts an image vulnerability scan.default CompletableFuture
<StartImageScanResponse> startImageScan
(StartImageScanRequest startImageScanRequest) Starts an image vulnerability scan.startLifecyclePolicyPreview
(Consumer<StartLifecyclePolicyPreviewRequest.Builder> startLifecyclePolicyPreviewRequest) Starts a preview of a lifecycle policy for the specified repository.startLifecyclePolicyPreview
(StartLifecyclePolicyPreviewRequest startLifecyclePolicyPreviewRequest) Starts a preview of a lifecycle policy for the specified repository.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds specified tags to a resource with the specified ARN.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds specified tags to a resource with the specified ARN.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes specified tags from a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Deletes specified tags from a resource.updatePullThroughCacheRule
(Consumer<UpdatePullThroughCacheRuleRequest.Builder> updatePullThroughCacheRuleRequest) Updates an existing pull through cache rule.updatePullThroughCacheRule
(UpdatePullThroughCacheRuleRequest updatePullThroughCacheRuleRequest) Updates an existing pull through cache rule.default CompletableFuture
<UploadLayerPartResponse> uploadLayerPart
(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest) Uploads an image layer part to Amazon ECR.default CompletableFuture
<UploadLayerPartResponse> uploadLayerPart
(UploadLayerPartRequest uploadLayerPartRequest) Uploads an image layer part to Amazon ECR.validatePullThroughCacheRule
(Consumer<ValidatePullThroughCacheRuleRequest.Builder> validatePullThroughCacheRuleRequest) Validates an existing pull through cache rule for an upstream registry that requires authentication.validatePullThroughCacheRule
(ValidatePullThroughCacheRuleRequest validatePullThroughCacheRuleRequest) Validates an existing pull through cache rule for an upstream registry that requires authentication.default EcrAsyncWaiter
waiter()
Create an instance ofEcrAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchCheckLayerAvailability
default CompletableFuture<BatchCheckLayerAvailabilityResponse> batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) Checks the availability of one or more image layers 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.- Parameters:
batchCheckLayerAvailabilityRequest
-- Returns:
- A Java Future containing the result of the BatchCheckLayerAvailability operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RepositoryNotFoundException The specified repository 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.
- See Also:
-
batchCheckLayerAvailability
default CompletableFuture<BatchCheckLayerAvailabilityResponse> batchCheckLayerAvailability(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest) 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 viaBatchCheckLayerAvailabilityRequest.builder()
- Parameters:
batchCheckLayerAvailabilityRequest
- AConsumer
that will call methods onBatchCheckLayerAvailabilityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchCheckLayerAvailability operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- RepositoryNotFoundException The specified repository 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.
- See Also:
-
batchDeleteImage
default CompletableFuture<BatchDeleteImageResponse> batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest) Deletes a list of specified images within a repository. Images are specified with either an
imageTag
orimageDigest
.You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
You can completely delete an image (and all of its tags) by specifying the image's digest in your request.
- Parameters:
batchDeleteImageRequest
- Deletes specified images within a specified repository. Images are specified with either theimageTag
orimageDigest
.- Returns:
- A Java Future containing the result of the BatchDeleteImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
batchDeleteImage
default CompletableFuture<BatchDeleteImageResponse> batchDeleteImage(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest) Deletes a list of specified images within a repository. Images are specified with either an
imageTag
orimageDigest
.You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
You can completely delete an image (and all of its tags) by specifying the 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 viaBatchDeleteImageRequest.builder()
- Parameters:
batchDeleteImageRequest
- AConsumer
that will call methods onBatchDeleteImageRequest.Builder
to create a request. Deletes specified images within a specified repository. Images are specified with either theimageTag
orimageDigest
.- Returns:
- A Java Future containing the result of the BatchDeleteImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
batchGetImage
default CompletableFuture<BatchGetImageResponse> batchGetImage(BatchGetImageRequest batchGetImageRequest) Gets detailed information for an image. Images are specified with either an
imageTag
orimageDigest
.When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.
- Parameters:
batchGetImageRequest
-- Returns:
- A Java Future containing the result of the BatchGetImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct 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.
- UnableToGetUpstreamImageException The image or images were unable to be pulled using the pull through cache rule. This is usually caused because of an issue with the Secrets Manager secret containing the credentials for the upstream 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.
- See Also:
-
batchGetImage
default CompletableFuture<BatchGetImageResponse> batchGetImage(Consumer<BatchGetImageRequest.Builder> batchGetImageRequest) Gets detailed information for an image. Images are specified with either an
imageTag
orimageDigest
.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 viaBatchGetImageRequest.builder()
- Parameters:
batchGetImageRequest
- AConsumer
that will call methods onBatchGetImageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchGetImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct 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.
- UnableToGetUpstreamImageException The image or images were unable to be pulled using the pull through cache rule. This is usually caused because of an issue with the Secrets Manager secret containing the credentials for the upstream 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.
- See Also:
-
batchGetRepositoryScanningConfiguration
default CompletableFuture<BatchGetRepositoryScanningConfigurationResponse> batchGetRepositoryScanningConfiguration(BatchGetRepositoryScanningConfigurationRequest batchGetRepositoryScanningConfigurationRequest) Gets the scanning configuration for one or more repositories.
- Parameters:
batchGetRepositoryScanningConfigurationRequest
-- Returns:
- A Java Future containing the result of the BatchGetRepositoryScanningConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
batchGetRepositoryScanningConfiguration
default CompletableFuture<BatchGetRepositoryScanningConfigurationResponse> batchGetRepositoryScanningConfiguration(Consumer<BatchGetRepositoryScanningConfigurationRequest.Builder> batchGetRepositoryScanningConfigurationRequest) 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 viaBatchGetRepositoryScanningConfigurationRequest.builder()
- Parameters:
batchGetRepositoryScanningConfigurationRequest
- AConsumer
that will call methods onBatchGetRepositoryScanningConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchGetRepositoryScanningConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
completeLayerUpload
default CompletableFuture<CompleteLayerUploadResponse> completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest) 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.- Parameters:
completeLayerUploadRequest
-- Returns:
- A Java Future containing the result of the CompleteLayerUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
completeLayerUpload
default CompletableFuture<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. 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 viaCompleteLayerUploadRequest.builder()
- Parameters:
completeLayerUploadRequest
- AConsumer
that will call methods onCompleteLayerUploadRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CompleteLayerUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
createPullThroughCacheRule
default CompletableFuture<CreatePullThroughCacheRuleResponse> createPullThroughCacheRule(CreatePullThroughCacheRuleRequest createPullThroughCacheRuleRequest) Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry source in your Amazon ECR private registry. For more information, see Using pull through cache rules in the Amazon Elastic Container Registry User Guide.
- Parameters:
createPullThroughCacheRuleRequest
-- Returns:
- A Java Future containing the result of the CreatePullThroughCacheRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- UnableToAccessSecretException The secret is unable to be accessed. Verify the resource permissions for the secret and try again.
- SecretNotFoundException The ARN of the secret specified in the pull through cache rule was not found. Update the pull through cache rule with a valid secret ARN and try again.
- UnableToDecryptSecretValueException The secret is accessible but is unable to be decrypted. Verify the resource permisisons 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.
- See Also:
-
createPullThroughCacheRule
default CompletableFuture<CreatePullThroughCacheRuleResponse> createPullThroughCacheRule(Consumer<CreatePullThroughCacheRuleRequest.Builder> createPullThroughCacheRuleRequest) Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry source in your Amazon ECR private registry. For more information, see Using pull through cache rules in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
CreatePullThroughCacheRuleRequest.Builder
avoiding the need to create one manually viaCreatePullThroughCacheRuleRequest.builder()
- Parameters:
createPullThroughCacheRuleRequest
- AConsumer
that will call methods onCreatePullThroughCacheRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreatePullThroughCacheRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- UnableToAccessSecretException The secret is unable to be accessed. Verify the resource permissions for the secret and try again.
- SecretNotFoundException The ARN of the secret specified in the pull through cache rule was not found. Update the pull through cache rule with a valid secret ARN and try again.
- UnableToDecryptSecretValueException The secret is accessible but is unable to be decrypted. Verify the resource permisisons 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.
- See Also:
-
createRepository
default CompletableFuture<CreateRepositoryResponse> createRepository(CreateRepositoryRequest createRepositoryRequest) Creates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
- Parameters:
createRepositoryRequest
-- Returns:
- A Java Future containing the result of the CreateRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- InvalidTagParameterException An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
- TooManyTagsException The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
- RepositoryAlreadyExistsException The specified repository already exists in the specified registry.
- LimitExceededException The operation 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.
- See Also:
-
createRepository
default CompletableFuture<CreateRepositoryResponse> createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) 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 viaCreateRepositoryRequest.builder()
- Parameters:
createRepositoryRequest
- AConsumer
that will call methods onCreateRepositoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- InvalidTagParameterException An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
- TooManyTagsException The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
- RepositoryAlreadyExistsException The specified repository already exists in the specified registry.
- LimitExceededException The operation 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.
- See Also:
-
deleteLifecyclePolicy
default CompletableFuture<DeleteLifecyclePolicyResponse> deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest) Deletes the lifecycle policy associated with the specified repository.
- Parameters:
deleteLifecyclePolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteLifecyclePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- 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.
- See Also:
-
deleteLifecyclePolicy
default CompletableFuture<DeleteLifecyclePolicyResponse> deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest) 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 viaDeleteLifecyclePolicyRequest.builder()
- Parameters:
deleteLifecyclePolicyRequest
- AConsumer
that will call methods onDeleteLifecyclePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteLifecyclePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- 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.
- See Also:
-
deletePullThroughCacheRule
default CompletableFuture<DeletePullThroughCacheRuleResponse> deletePullThroughCacheRule(DeletePullThroughCacheRuleRequest deletePullThroughCacheRuleRequest) Deletes a pull through cache rule.
- Parameters:
deletePullThroughCacheRuleRequest
-- Returns:
- A Java Future containing the result of the DeletePullThroughCacheRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
deletePullThroughCacheRule
default CompletableFuture<DeletePullThroughCacheRuleResponse> deletePullThroughCacheRule(Consumer<DeletePullThroughCacheRuleRequest.Builder> deletePullThroughCacheRuleRequest) 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 viaDeletePullThroughCacheRuleRequest.builder()
- Parameters:
deletePullThroughCacheRuleRequest
- AConsumer
that will call methods onDeletePullThroughCacheRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePullThroughCacheRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
deleteRegistryPolicy
default CompletableFuture<DeleteRegistryPolicyResponse> deleteRegistryPolicy(DeleteRegistryPolicyRequest deleteRegistryPolicyRequest) Deletes the registry permissions policy.
- Parameters:
deleteRegistryPolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteRegistryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
deleteRegistryPolicy
default CompletableFuture<DeleteRegistryPolicyResponse> deleteRegistryPolicy(Consumer<DeleteRegistryPolicyRequest.Builder> deleteRegistryPolicyRequest) Deletes the registry permissions policy.
This is a convenience which creates an instance of the
DeleteRegistryPolicyRequest.Builder
avoiding the need to create one manually viaDeleteRegistryPolicyRequest.builder()
- Parameters:
deleteRegistryPolicyRequest
- AConsumer
that will call methods onDeleteRegistryPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRegistryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
deleteRepository
default CompletableFuture<DeleteRepositoryResponse> deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) Deletes a repository. If the repository isn't empty, you must either delete the contents of the repository or use the
force
option to delete the repository and have Amazon ECR delete all of its contents on your behalf.- Parameters:
deleteRepositoryRequest
-- Returns:
- A Java Future containing the result of the DeleteRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
deleteRepository
default CompletableFuture<DeleteRepositoryResponse> deleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) Deletes a repository. If the repository isn't empty, you must either delete the contents of the repository or use the
force
option to delete the repository and have Amazon ECR delete all of its contents on your behalf.
This is a convenience which creates an instance of the
DeleteRepositoryRequest.Builder
avoiding the need to create one manually viaDeleteRepositoryRequest.builder()
- Parameters:
deleteRepositoryRequest
- AConsumer
that will call methods onDeleteRepositoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
deleteRepositoryPolicy
default CompletableFuture<DeleteRepositoryPolicyResponse> deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) Deletes the repository policy associated with the specified repository.
- Parameters:
deleteRepositoryPolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteRepositoryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
deleteRepositoryPolicy
default CompletableFuture<DeleteRepositoryPolicyResponse> deleteRepositoryPolicy(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest) 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 viaDeleteRepositoryPolicyRequest.builder()
- Parameters:
deleteRepositoryPolicyRequest
- AConsumer
that will call methods onDeleteRepositoryPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRepositoryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
describeImageReplicationStatus
default CompletableFuture<DescribeImageReplicationStatusResponse> describeImageReplicationStatus(DescribeImageReplicationStatusRequest describeImageReplicationStatusRequest) Returns the replication status for a specified image.
- Parameters:
describeImageReplicationStatusRequest
-- Returns:
- A Java Future containing the result of the DescribeImageReplicationStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
describeImageReplicationStatus
default CompletableFuture<DescribeImageReplicationStatusResponse> describeImageReplicationStatus(Consumer<DescribeImageReplicationStatusRequest.Builder> describeImageReplicationStatusRequest) 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 viaDescribeImageReplicationStatusRequest.builder()
- Parameters:
describeImageReplicationStatusRequest
- AConsumer
that will call methods onDescribeImageReplicationStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeImageReplicationStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
describeImageScanFindings
default CompletableFuture<DescribeImageScanFindingsResponse> describeImageScanFindings(DescribeImageScanFindingsRequest describeImageScanFindingsRequest) Returns the scan findings for the specified image.
- Parameters:
describeImageScanFindingsRequest
-- Returns:
- A Java Future containing the result of the DescribeImageScanFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
describeImageScanFindings
default CompletableFuture<DescribeImageScanFindingsResponse> describeImageScanFindings(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest) 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 viaDescribeImageScanFindingsRequest.builder()
- Parameters:
describeImageScanFindingsRequest
- AConsumer
that will call methods onDescribeImageScanFindingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeImageScanFindings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
describeImageScanFindingsPaginator
default DescribeImageScanFindingsPublisher describeImageScanFindingsPaginator(DescribeImageScanFindingsRequest describeImageScanFindingsRequest) This is a variant of
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsPublisher publisher = client.describeImageScanFindingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsPublisher publisher = client.describeImageScanFindingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation.- Parameters:
describeImageScanFindingsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
describeImageScanFindingsPaginator
default DescribeImageScanFindingsPublisher describeImageScanFindingsPaginator(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest) This is a variant of
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsPublisher publisher = client.describeImageScanFindingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsPublisher publisher = client.describeImageScanFindingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaDescribeImageScanFindingsRequest.builder()
- Parameters:
describeImageScanFindingsRequest
- AConsumer
that will call methods onDescribeImageScanFindingsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
describeImages
default CompletableFuture<DescribeImagesResponse> describeImages(DescribeImagesRequest describeImagesRequest) 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.- Parameters:
describeImagesRequest
-- Returns:
- A Java Future containing the result of the DescribeImages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
describeImages
default CompletableFuture<DescribeImagesResponse> describeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) 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 viaDescribeImagesRequest.builder()
- Parameters:
describeImagesRequest
- AConsumer
that will call methods onDescribeImagesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeImages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
describeImagesPaginator
default DescribeImagesPublisher describeImagesPaginator(DescribeImagesRequest describeImagesRequest) This is a variant of
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecr.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecr.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecr.model.DescribeImagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecr.model.DescribeImagesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation.- Parameters:
describeImagesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
describeImagesPaginator
default DescribeImagesPublisher describeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) This is a variant of
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecr.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecr.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecr.model.DescribeImagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecr.model.DescribeImagesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation.
This is a convenience which creates an instance of the
DescribeImagesRequest.Builder
avoiding the need to create one manually viaDescribeImagesRequest.builder()
- Parameters:
describeImagesRequest
- AConsumer
that will call methods onDescribeImagesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
describePullThroughCacheRules
default CompletableFuture<DescribePullThroughCacheRulesResponse> describePullThroughCacheRules(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest) Returns the pull through cache rules for a registry.
- Parameters:
describePullThroughCacheRulesRequest
-- Returns:
- A Java Future containing the result of the DescribePullThroughCacheRules operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
describePullThroughCacheRules
default CompletableFuture<DescribePullThroughCacheRulesResponse> describePullThroughCacheRules(Consumer<DescribePullThroughCacheRulesRequest.Builder> describePullThroughCacheRulesRequest) 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 viaDescribePullThroughCacheRulesRequest.builder()
- Parameters:
describePullThroughCacheRulesRequest
- AConsumer
that will call methods onDescribePullThroughCacheRulesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePullThroughCacheRules operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
describePullThroughCacheRulesPaginator
default DescribePullThroughCacheRulesPublisher describePullThroughCacheRulesPaginator(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest) This is a variant of
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesPublisher publisher = client.describePullThroughCacheRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesPublisher publisher = client.describePullThroughCacheRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation.- Parameters:
describePullThroughCacheRulesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
describePullThroughCacheRulesPaginator
default DescribePullThroughCacheRulesPublisher describePullThroughCacheRulesPaginator(Consumer<DescribePullThroughCacheRulesRequest.Builder> describePullThroughCacheRulesRequest) This is a variant of
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesPublisher publisher = client.describePullThroughCacheRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesPublisher publisher = client.describePullThroughCacheRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaDescribePullThroughCacheRulesRequest.builder()
- Parameters:
describePullThroughCacheRulesRequest
- AConsumer
that will call methods onDescribePullThroughCacheRulesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
describeRegistry
default CompletableFuture<DescribeRegistryResponse> describeRegistry(DescribeRegistryRequest describeRegistryRequest) Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
- Parameters:
describeRegistryRequest
-- Returns:
- A Java Future containing the result of the DescribeRegistry operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
describeRegistry
default CompletableFuture<DescribeRegistryResponse> describeRegistry(Consumer<DescribeRegistryRequest.Builder> describeRegistryRequest) 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 viaDescribeRegistryRequest.builder()
- Parameters:
describeRegistryRequest
- AConsumer
that will call methods onDescribeRegistryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRegistry operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
describeRepositories
default CompletableFuture<DescribeRepositoriesResponse> describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest) Describes image repositories in a registry.
- Parameters:
describeRepositoriesRequest
-- Returns:
- A Java Future containing the result of the DescribeRepositories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
describeRepositories
default CompletableFuture<DescribeRepositoriesResponse> describeRepositories(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) 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 viaDescribeRepositoriesRequest.builder()
- Parameters:
describeRepositoriesRequest
- AConsumer
that will call methods onDescribeRepositoriesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRepositories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
describeRepositories
Describes image repositories in a registry.
- Returns:
- A Java Future containing the result of the DescribeRepositories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
describeRepositoriesPaginator
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesPublisher publisher = client.describeRepositoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesPublisher publisher = client.describeRepositoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
describeRepositoriesPaginator
default DescribeRepositoriesPublisher describeRepositoriesPaginator(DescribeRepositoriesRequest describeRepositoriesRequest) This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesPublisher publisher = client.describeRepositoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesPublisher publisher = client.describeRepositoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.- Parameters:
describeRepositoriesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
describeRepositoriesPaginator
default DescribeRepositoriesPublisher describeRepositoriesPaginator(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesPublisher publisher = client.describeRepositoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesPublisher publisher = client.describeRepositoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.
This is a convenience which creates an instance of the
DescribeRepositoriesRequest.Builder
avoiding the need to create one manually viaDescribeRepositoriesRequest.builder()
- Parameters:
describeRepositoriesRequest
- AConsumer
that will call methods onDescribeRepositoriesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
getAuthorizationToken
default CompletableFuture<GetAuthorizationTokenResponse> getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest) 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 adocker login
command to authenticate to a registry. The CLI offers anget-login-password
command that simplifies the login process. For more information, see Registry authentication in the Amazon Elastic Container Registry User Guide.- Parameters:
getAuthorizationTokenRequest
-- Returns:
- A Java Future containing the result of the GetAuthorizationToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.
- See Also:
-
getAuthorizationToken
default CompletableFuture<GetAuthorizationTokenResponse> getAuthorizationToken(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest) 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 adocker login
command to authenticate to a registry. The CLI offers anget-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 viaGetAuthorizationTokenRequest.builder()
- Parameters:
getAuthorizationTokenRequest
- AConsumer
that will call methods onGetAuthorizationTokenRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAuthorizationToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.
- See Also:
-
getAuthorizationToken
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 adocker login
command to authenticate to a registry. The CLI offers anget-login-password
command that simplifies the login process. For more information, see Registry authentication in the Amazon Elastic Container Registry User Guide.- Returns:
- A Java Future containing the result of the GetAuthorizationToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.
- See Also:
-
getDownloadUrlForLayer
default CompletableFuture<GetDownloadUrlForLayerResponse> getDownloadUrlForLayer(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest) 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.- Parameters:
getDownloadUrlForLayerRequest
-- Returns:
- A Java Future containing the result of the GetDownloadUrlForLayer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- UnableToGetUpstreamLayerException There was an issue getting the upstream layer matching the pull through cache rule.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.
- See Also:
-
getDownloadUrlForLayer
default CompletableFuture<GetDownloadUrlForLayerResponse> getDownloadUrlForLayer(Consumer<GetDownloadUrlForLayerRequest.Builder> getDownloadUrlForLayerRequest) 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 viaGetDownloadUrlForLayerRequest.builder()
- Parameters:
getDownloadUrlForLayerRequest
- AConsumer
that will call methods onGetDownloadUrlForLayerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDownloadUrlForLayer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- UnableToGetUpstreamLayerException There was an issue getting the upstream layer matching the pull through cache rule.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can 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.
- See Also:
-
getLifecyclePolicy
default CompletableFuture<GetLifecyclePolicyResponse> getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest) Retrieves the lifecycle policy for the specified repository.
- Parameters:
getLifecyclePolicyRequest
-- Returns:
- A Java Future containing the result of the GetLifecyclePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- 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.
- See Also:
-
getLifecyclePolicy
default CompletableFuture<GetLifecyclePolicyResponse> getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest) 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 viaGetLifecyclePolicyRequest.builder()
- Parameters:
getLifecyclePolicyRequest
- AConsumer
that will call methods onGetLifecyclePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetLifecyclePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- 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.
- See Also:
-
getLifecyclePolicyPreview
default CompletableFuture<GetLifecyclePolicyPreviewResponse> getLifecyclePolicyPreview(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest) Retrieves the results of the lifecycle policy preview request for the specified repository.
- Parameters:
getLifecyclePolicyPreviewRequest
-- Returns:
- A Java Future containing the result of the GetLifecyclePolicyPreview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- 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.
- See Also:
-
getLifecyclePolicyPreview
default CompletableFuture<GetLifecyclePolicyPreviewResponse> getLifecyclePolicyPreview(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest) 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 viaGetLifecyclePolicyPreviewRequest.builder()
- Parameters:
getLifecyclePolicyPreviewRequest
- AConsumer
that will call methods onGetLifecyclePolicyPreviewRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetLifecyclePolicyPreview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- 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.
- See Also:
-
getLifecyclePolicyPreviewPaginator
default GetLifecyclePolicyPreviewPublisher getLifecyclePolicyPreviewPaginator(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest) This is a variant of
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewPublisher publisher = client.getLifecyclePolicyPreviewPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewPublisher publisher = client.getLifecyclePolicyPreviewPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation.- Parameters:
getLifecyclePolicyPreviewRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- 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.
- See Also:
-
getLifecyclePolicyPreviewPaginator
default GetLifecyclePolicyPreviewPublisher getLifecyclePolicyPreviewPaginator(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest) This is a variant of
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewPublisher publisher = client.getLifecyclePolicyPreviewPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewPublisher publisher = client.getLifecyclePolicyPreviewPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaGetLifecyclePolicyPreviewRequest.builder()
- Parameters:
getLifecyclePolicyPreviewRequest
- AConsumer
that will call methods onGetLifecyclePolicyPreviewRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- 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.
- See Also:
-
getRegistryPolicy
default CompletableFuture<GetRegistryPolicyResponse> getRegistryPolicy(GetRegistryPolicyRequest getRegistryPolicyRequest) Retrieves the permissions policy for a registry.
- Parameters:
getRegistryPolicyRequest
-- Returns:
- A Java Future containing the result of the GetRegistryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
getRegistryPolicy
default CompletableFuture<GetRegistryPolicyResponse> getRegistryPolicy(Consumer<GetRegistryPolicyRequest.Builder> getRegistryPolicyRequest) 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 viaGetRegistryPolicyRequest.builder()
- Parameters:
getRegistryPolicyRequest
- AConsumer
that will call methods onGetRegistryPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRegistryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
getRegistryScanningConfiguration
default CompletableFuture<GetRegistryScanningConfigurationResponse> getRegistryScanningConfiguration(GetRegistryScanningConfigurationRequest getRegistryScanningConfigurationRequest) Retrieves the scanning configuration for a registry.
- Parameters:
getRegistryScanningConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetRegistryScanningConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
getRegistryScanningConfiguration
default CompletableFuture<GetRegistryScanningConfigurationResponse> getRegistryScanningConfiguration(Consumer<GetRegistryScanningConfigurationRequest.Builder> getRegistryScanningConfigurationRequest) 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 viaGetRegistryScanningConfigurationRequest.builder()
- Parameters:
getRegistryScanningConfigurationRequest
- AConsumer
that will call methods onGetRegistryScanningConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRegistryScanningConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
getRepositoryPolicy
default CompletableFuture<GetRepositoryPolicyResponse> getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest) Retrieves the repository policy for the specified repository.
- Parameters:
getRepositoryPolicyRequest
-- Returns:
- A Java Future containing the result of the GetRepositoryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
getRepositoryPolicy
default CompletableFuture<GetRepositoryPolicyResponse> getRepositoryPolicy(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest) Retrieves the repository policy for the specified repository.
This is a convenience which creates an instance of the
GetRepositoryPolicyRequest.Builder
avoiding the need to create one manually viaGetRepositoryPolicyRequest.builder()
- Parameters:
getRepositoryPolicyRequest
- AConsumer
that will call methods onGetRepositoryPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetRepositoryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
initiateLayerUpload
default CompletableFuture<InitiateLayerUploadResponse> initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest) Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once 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.- Parameters:
initiateLayerUploadRequest
-- Returns:
- A Java Future containing the result of the InitiateLayerUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
initiateLayerUpload
default CompletableFuture<InitiateLayerUploadResponse> initiateLayerUpload(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest) Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once 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 viaInitiateLayerUploadRequest.builder()
- Parameters:
initiateLayerUploadRequest
- AConsumer
that will call methods onInitiateLayerUploadRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the InitiateLayerUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
listImages
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 eitherTAGGED
,UNTAGGED
orANY
. For example, you can filter your results to return onlyUNTAGGED
images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return onlyTAGGED
images to list all of the tags in your repository.- Parameters:
listImagesRequest
-- Returns:
- A Java Future containing the result of the ListImages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
listImages
default CompletableFuture<ListImagesResponse> listImages(Consumer<ListImagesRequest.Builder> listImagesRequest) 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 eitherTAGGED
,UNTAGGED
orANY
. For example, you can filter your results to return onlyUNTAGGED
images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return onlyTAGGED
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 viaListImagesRequest.builder()
- Parameters:
listImagesRequest
- AConsumer
that will call methods onListImagesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListImages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
listImagesPaginator
This is a variant of
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecr.paginators.ListImagesPublisher publisher = client.listImagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecr.paginators.ListImagesPublisher publisher = client.listImagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecr.model.ListImagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecr.model.ListImagesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)
operation.- Parameters:
listImagesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
listImagesPaginator
default ListImagesPublisher listImagesPaginator(Consumer<ListImagesRequest.Builder> listImagesRequest) This is a variant of
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ecr.paginators.ListImagesPublisher publisher = client.listImagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ecr.paginators.ListImagesPublisher publisher = client.listImagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecr.model.ListImagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ecr.model.ListImagesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaListImagesRequest.builder()
- Parameters:
listImagesRequest
- AConsumer
that will call methods onListImagesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List the tags for an Amazon ECR resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
putImage
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.- Parameters:
putImageRequest
-- Returns:
- A Java Future containing the result of the PutImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
putImage
default CompletableFuture<PutImageResponse> putImage(Consumer<PutImageRequest.Builder> putImageRequest) 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 viaPutImageRequest.builder()
- Parameters:
putImageRequest
- AConsumer
that will call methods onPutImageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutImage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
putImageScanningConfiguration
default CompletableFuture<PutImageScanningConfigurationResponse> putImageScanningConfiguration(PutImageScanningConfigurationRequest putImageScanningConfigurationRequest) 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.
- Parameters:
putImageScanningConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutImageScanningConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
putImageScanningConfiguration
default CompletableFuture<PutImageScanningConfigurationResponse> putImageScanningConfiguration(Consumer<PutImageScanningConfigurationRequest.Builder> putImageScanningConfigurationRequest) 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 viaPutImageScanningConfigurationRequest.builder()
- Parameters:
putImageScanningConfigurationRequest
- AConsumer
that will call methods onPutImageScanningConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutImageScanningConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
putImageTagMutability
default CompletableFuture<PutImageTagMutabilityResponse> putImageTagMutability(PutImageTagMutabilityRequest putImageTagMutabilityRequest) 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.
- Parameters:
putImageTagMutabilityRequest
-- Returns:
- A Java Future containing the result of the PutImageTagMutability operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
putImageTagMutability
default CompletableFuture<PutImageTagMutabilityResponse> putImageTagMutability(Consumer<PutImageTagMutabilityRequest.Builder> putImageTagMutabilityRequest) 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 viaPutImageTagMutabilityRequest.builder()
- Parameters:
putImageTagMutabilityRequest
- AConsumer
that will call methods onPutImageTagMutabilityRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutImageTagMutability operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
putLifecyclePolicy
default CompletableFuture<PutLifecyclePolicyResponse> putLifecyclePolicy(PutLifecyclePolicyRequest putLifecyclePolicyRequest) Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.
- Parameters:
putLifecyclePolicyRequest
-- Returns:
- A Java Future containing the result of the PutLifecyclePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
putLifecyclePolicy
default CompletableFuture<PutLifecyclePolicyResponse> putLifecyclePolicy(Consumer<PutLifecyclePolicyRequest.Builder> putLifecyclePolicyRequest) 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 viaPutLifecyclePolicyRequest.builder()
- Parameters:
putLifecyclePolicyRequest
- AConsumer
that will call methods onPutLifecyclePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutLifecyclePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
putRegistryPolicy
default CompletableFuture<PutRegistryPolicyResponse> putRegistryPolicy(PutRegistryPolicyRequest putRegistryPolicyRequest) 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.
- Parameters:
putRegistryPolicyRequest
-- Returns:
- A Java Future containing the result of the PutRegistryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
putRegistryPolicy
default CompletableFuture<PutRegistryPolicyResponse> putRegistryPolicy(Consumer<PutRegistryPolicyRequest.Builder> putRegistryPolicyRequest) 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 viaPutRegistryPolicyRequest.builder()
- Parameters:
putRegistryPolicyRequest
- AConsumer
that will call methods onPutRegistryPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutRegistryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
putRegistryScanningConfiguration
default CompletableFuture<PutRegistryScanningConfigurationResponse> putRegistryScanningConfiguration(PutRegistryScanningConfigurationRequest putRegistryScanningConfigurationRequest) Creates or updates the scanning configuration for your private registry.
- Parameters:
putRegistryScanningConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutRegistryScanningConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
putRegistryScanningConfiguration
default CompletableFuture<PutRegistryScanningConfigurationResponse> putRegistryScanningConfiguration(Consumer<PutRegistryScanningConfigurationRequest.Builder> putRegistryScanningConfigurationRequest) 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 viaPutRegistryScanningConfigurationRequest.builder()
- Parameters:
putRegistryScanningConfigurationRequest
- AConsumer
that will call methods onPutRegistryScanningConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutRegistryScanningConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
putReplicationConfiguration
default CompletableFuture<PutReplicationConfigurationResponse> putReplicationConfiguration(PutReplicationConfigurationRequest putReplicationConfigurationRequest) 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.
- Parameters:
putReplicationConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutReplicationConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
putReplicationConfiguration
default CompletableFuture<PutReplicationConfigurationResponse> putReplicationConfiguration(Consumer<PutReplicationConfigurationRequest.Builder> putReplicationConfigurationRequest) 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 viaPutReplicationConfigurationRequest.builder()
- Parameters:
putReplicationConfigurationRequest
- AConsumer
that will call methods onPutReplicationConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutReplicationConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
setRepositoryPolicy
default CompletableFuture<SetRepositoryPolicyResponse> setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest) 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.
- Parameters:
setRepositoryPolicyRequest
-- Returns:
- A Java Future containing the result of the SetRepositoryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
setRepositoryPolicy
default CompletableFuture<SetRepositoryPolicyResponse> setRepositoryPolicy(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest) 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 viaSetRepositoryPolicyRequest.builder()
- Parameters:
setRepositoryPolicyRequest
- AConsumer
that will call methods onSetRepositoryPolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SetRepositoryPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
startImageScan
default CompletableFuture<StartImageScanResponse> startImageScan(StartImageScanRequest startImageScanRequest) 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.
- Parameters:
startImageScanRequest
-- Returns:
- A Java Future containing the result of the StartImageScan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
startImageScan
default CompletableFuture<StartImageScanResponse> startImageScan(Consumer<StartImageScanRequest.Builder> startImageScanRequest) 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 viaStartImageScanRequest.builder()
- Parameters:
startImageScanRequest
- AConsumer
that will call methods onStartImageScanRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartImageScan operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
startLifecyclePolicyPreview
default CompletableFuture<StartLifecyclePolicyPreviewResponse> startLifecyclePolicyPreview(StartLifecyclePolicyPreviewRequest startLifecyclePolicyPreviewRequest) 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.
- Parameters:
startLifecyclePolicyPreviewRequest
-- Returns:
- A Java Future containing the result of the StartLifecyclePolicyPreview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- 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.
- See Also:
-
startLifecyclePolicyPreview
default CompletableFuture<StartLifecyclePolicyPreviewResponse> startLifecyclePolicyPreview(Consumer<StartLifecyclePolicyPreviewRequest.Builder> startLifecyclePolicyPreviewRequest) 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 viaStartLifecyclePolicyPreviewRequest.builder()
- Parameters:
startLifecyclePolicyPreviewRequest
- AConsumer
that will call methods onStartLifecyclePolicyPreviewRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartLifecyclePolicyPreview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- RepositoryNotFoundException The specified repository 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.
- 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.
- See Also:
-
tagResource
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.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- InvalidTagParameterException An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
- TooManyTagsException The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- InvalidTagParameterException An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
- TooManyTagsException The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Deletes specified tags from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- InvalidTagParameterException An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
- TooManyTagsException The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes specified tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- InvalidTagParameterException An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
- TooManyTagsException The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.
- RepositoryNotFoundException The specified repository 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.
- See Also:
-
updatePullThroughCacheRule
default CompletableFuture<UpdatePullThroughCacheRuleResponse> updatePullThroughCacheRule(UpdatePullThroughCacheRuleRequest updatePullThroughCacheRuleRequest) Updates an existing pull through cache rule.
- Parameters:
updatePullThroughCacheRuleRequest
-- Returns:
- A Java Future containing the result of the UpdatePullThroughCacheRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- ValidationException There was an exception validating this request.
- UnableToAccessSecretException The secret is unable to be accessed. Verify the resource permissions for the secret and try again.
- PullThroughCacheRuleNotFoundException The pull through cache rule was not found. Specify a valid pull through cache rule and try again.
- SecretNotFoundException The ARN of the secret specified in the pull through cache rule was not found. Update the pull through cache rule with a valid secret ARN and try again.
- UnableToDecryptSecretValueException The secret is accessible but is unable to be decrypted. Verify the resource permisisons 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.
- See Also:
-
updatePullThroughCacheRule
default CompletableFuture<UpdatePullThroughCacheRuleResponse> updatePullThroughCacheRule(Consumer<UpdatePullThroughCacheRuleRequest.Builder> updatePullThroughCacheRuleRequest) Updates an existing pull through cache rule.
This is a convenience which creates an instance of the
UpdatePullThroughCacheRuleRequest.Builder
avoiding the need to create one manually viaUpdatePullThroughCacheRuleRequest.builder()
- Parameters:
updatePullThroughCacheRuleRequest
- AConsumer
that will call methods onUpdatePullThroughCacheRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdatePullThroughCacheRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- ValidationException There was an exception validating this request.
- UnableToAccessSecretException The secret is unable to be accessed. Verify the resource permissions for the secret and try again.
- PullThroughCacheRuleNotFoundException The pull through cache rule was not found. Specify a valid pull through cache rule and try again.
- SecretNotFoundException The ARN of the secret specified in the pull through cache rule was not found. Update the pull through cache rule with a valid secret ARN and try again.
- UnableToDecryptSecretValueException The secret is accessible but is unable to be decrypted. Verify the resource permisisons 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.
- See Also:
-
uploadLayerPart
default CompletableFuture<UploadLayerPartResponse> uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest) Uploads an image layer part to Amazon ECR.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (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.- Parameters:
uploadLayerPartRequest
-- Returns:
- A Java Future containing the result of the UploadLayerPart operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- InvalidLayerPartException The layer part size 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.
- See Also:
-
uploadLayerPart
default CompletableFuture<UploadLayerPartResponse> uploadLayerPart(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest) Uploads an image layer part to Amazon ECR.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (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 viaUploadLayerPartRequest.builder()
- Parameters:
uploadLayerPartRequest
- AConsumer
that will call methods onUploadLayerPartRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UploadLayerPart operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- InvalidLayerPartException The layer part size 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.
- See Also:
-
validatePullThroughCacheRule
default CompletableFuture<ValidatePullThroughCacheRuleResponse> validatePullThroughCacheRule(ValidatePullThroughCacheRuleRequest validatePullThroughCacheRuleRequest) Validates an existing pull through cache rule for an upstream registry that requires authentication. This will retrieve the contents of the Amazon Web Services Secrets Manager secret, verify the syntax, and then validate that authentication to the upstream registry is successful.
- Parameters:
validatePullThroughCacheRuleRequest
-- Returns:
- A Java Future containing the result of the ValidatePullThroughCacheRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
validatePullThroughCacheRule
default CompletableFuture<ValidatePullThroughCacheRuleResponse> validatePullThroughCacheRule(Consumer<ValidatePullThroughCacheRuleRequest.Builder> validatePullThroughCacheRuleRequest) Validates an existing pull through cache rule for an upstream registry that requires authentication. This will retrieve the contents of the Amazon Web Services Secrets Manager secret, verify the syntax, and then validate that authentication to the upstream registry is successful.
This is a convenience which creates an instance of the
ValidatePullThroughCacheRuleRequest.Builder
avoiding the need to create one manually viaValidatePullThroughCacheRuleRequest.builder()
- Parameters:
validatePullThroughCacheRuleRequest
- AConsumer
that will call methods onValidatePullThroughCacheRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ValidatePullThroughCacheRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServerException These errors are usually caused by a server-side issue.
- InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
- 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.
- See Also:
-
waiter
Create an instance ofEcrAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
EcrAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aEcrAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aEcrAsyncClient
.
-