@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonECRAsync extends AmazonECR
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonECRAsync instead.
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.
ENDPOINT_PREFIXbatchCheckLayerAvailability, batchDeleteImage, batchGetImage, batchGetRepositoryScanningConfiguration, completeLayerUpload, createPullThroughCacheRule, createRepository, deleteLifecyclePolicy, deletePullThroughCacheRule, deleteRegistryPolicy, deleteRepository, deleteRepositoryPolicy, describeImageReplicationStatus, describeImages, describeImageScanFindings, describePullThroughCacheRules, describeRegistry, describeRepositories, getAuthorizationToken, getCachedResponseMetadata, getDownloadUrlForLayer, getLifecyclePolicy, getLifecyclePolicyPreview, getRegistryPolicy, getRegistryScanningConfiguration, getRepositoryPolicy, initiateLayerUpload, listImages, listTagsForResource, putImage, putImageScanningConfiguration, putImageTagMutability, putLifecyclePolicy, putRegistryPolicy, putRegistryScanningConfiguration, putReplicationConfiguration, setEndpoint, setRegion, setRepositoryPolicy, shutdown, startImageScan, startLifecyclePolicyPreview, tagResource, untagResource, uploadLayerPart, waitersFuture<BatchCheckLayerAvailabilityResult> batchCheckLayerAvailabilityAsync(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.
batchCheckLayerAvailabilityRequest - Future<BatchCheckLayerAvailabilityResult> batchCheckLayerAvailabilityAsync(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest, AsyncHandler<BatchCheckLayerAvailabilityRequest,BatchCheckLayerAvailabilityResult> asyncHandler)
Checks the availability of one or more image layers in a repository.
When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
batchCheckLayerAvailabilityRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchDeleteImageResult> batchDeleteImageAsync(BatchDeleteImageRequest batchDeleteImageRequest)
Deletes a list of specified images within a repository. Images are specified with either an imageTag
or imageDigest.
You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
You can completely delete an image (and all of its tags) by specifying the image's digest in your request.
batchDeleteImageRequest - Deletes specified images within a specified repository. Images are specified with either the
imageTag or imageDigest.Future<BatchDeleteImageResult> batchDeleteImageAsync(BatchDeleteImageRequest batchDeleteImageRequest, AsyncHandler<BatchDeleteImageRequest,BatchDeleteImageResult> asyncHandler)
Deletes a list of specified images within a repository. Images are specified with either an imageTag
or imageDigest.
You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
You can completely delete an image (and all of its tags) by specifying the image's digest in your request.
batchDeleteImageRequest - Deletes specified images within a specified repository. Images are specified with either the
imageTag or imageDigest.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchGetImageResult> batchGetImageAsync(BatchGetImageRequest batchGetImageRequest)
Gets detailed information for an image. Images are specified with either an imageTag or
imageDigest.
When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.
batchGetImageRequest - Future<BatchGetImageResult> batchGetImageAsync(BatchGetImageRequest batchGetImageRequest, AsyncHandler<BatchGetImageRequest,BatchGetImageResult> asyncHandler)
Gets detailed information for an image. Images are specified with either an imageTag or
imageDigest.
When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.
batchGetImageRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<BatchGetRepositoryScanningConfigurationResult> batchGetRepositoryScanningConfigurationAsync(BatchGetRepositoryScanningConfigurationRequest batchGetRepositoryScanningConfigurationRequest)
Gets the scanning configuration for one or more repositories.
batchGetRepositoryScanningConfigurationRequest - Future<BatchGetRepositoryScanningConfigurationResult> batchGetRepositoryScanningConfigurationAsync(BatchGetRepositoryScanningConfigurationRequest batchGetRepositoryScanningConfigurationRequest, AsyncHandler<BatchGetRepositoryScanningConfigurationRequest,BatchGetRepositoryScanningConfigurationResult> asyncHandler)
Gets the scanning configuration for one or more repositories.
batchGetRepositoryScanningConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CompleteLayerUploadResult> completeLayerUploadAsync(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.
completeLayerUploadRequest - Future<CompleteLayerUploadResult> completeLayerUploadAsync(CompleteLayerUploadRequest completeLayerUploadRequest, AsyncHandler<CompleteLayerUploadRequest,CompleteLayerUploadResult> asyncHandler)
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and
upload ID. You can optionally provide a sha256 digest of the image layer for data validation
purposes.
When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
completeLayerUploadRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreatePullThroughCacheRuleResult> createPullThroughCacheRuleAsync(CreatePullThroughCacheRuleRequest createPullThroughCacheRuleRequest)
Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an external public registry in your Amazon ECR private registry.
createPullThroughCacheRuleRequest - Future<CreatePullThroughCacheRuleResult> createPullThroughCacheRuleAsync(CreatePullThroughCacheRuleRequest createPullThroughCacheRuleRequest, AsyncHandler<CreatePullThroughCacheRuleRequest,CreatePullThroughCacheRuleResult> asyncHandler)
Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an external public registry in your Amazon ECR private registry.
createPullThroughCacheRuleRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateRepositoryResult> createRepositoryAsync(CreateRepositoryRequest createRepositoryRequest)
Creates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
createRepositoryRequest - Future<CreateRepositoryResult> createRepositoryAsync(CreateRepositoryRequest createRepositoryRequest, AsyncHandler<CreateRepositoryRequest,CreateRepositoryResult> asyncHandler)
Creates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
createRepositoryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteLifecyclePolicyResult> deleteLifecyclePolicyAsync(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)
Deletes the lifecycle policy associated with the specified repository.
deleteLifecyclePolicyRequest - Future<DeleteLifecyclePolicyResult> deleteLifecyclePolicyAsync(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest, AsyncHandler<DeleteLifecyclePolicyRequest,DeleteLifecyclePolicyResult> asyncHandler)
Deletes the lifecycle policy associated with the specified repository.
deleteLifecyclePolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeletePullThroughCacheRuleResult> deletePullThroughCacheRuleAsync(DeletePullThroughCacheRuleRequest deletePullThroughCacheRuleRequest)
Deletes a pull through cache rule.
deletePullThroughCacheRuleRequest - Future<DeletePullThroughCacheRuleResult> deletePullThroughCacheRuleAsync(DeletePullThroughCacheRuleRequest deletePullThroughCacheRuleRequest, AsyncHandler<DeletePullThroughCacheRuleRequest,DeletePullThroughCacheRuleResult> asyncHandler)
Deletes a pull through cache rule.
deletePullThroughCacheRuleRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteRegistryPolicyResult> deleteRegistryPolicyAsync(DeleteRegistryPolicyRequest deleteRegistryPolicyRequest)
Deletes the registry permissions policy.
deleteRegistryPolicyRequest - Future<DeleteRegistryPolicyResult> deleteRegistryPolicyAsync(DeleteRegistryPolicyRequest deleteRegistryPolicyRequest, AsyncHandler<DeleteRegistryPolicyRequest,DeleteRegistryPolicyResult> asyncHandler)
Deletes the registry permissions policy.
deleteRegistryPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteRepositoryResult> deleteRepositoryAsync(DeleteRepositoryRequest deleteRepositoryRequest)
Deletes a repository. If the repository contains images, you must either delete all images in the repository or
use the force option to delete the repository.
deleteRepositoryRequest - Future<DeleteRepositoryResult> deleteRepositoryAsync(DeleteRepositoryRequest deleteRepositoryRequest, AsyncHandler<DeleteRepositoryRequest,DeleteRepositoryResult> asyncHandler)
Deletes a repository. If the repository contains images, you must either delete all images in the repository or
use the force option to delete the repository.
deleteRepositoryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteRepositoryPolicyResult> deleteRepositoryPolicyAsync(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest)
Deletes the repository policy associated with the specified repository.
deleteRepositoryPolicyRequest - Future<DeleteRepositoryPolicyResult> deleteRepositoryPolicyAsync(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest, AsyncHandler<DeleteRepositoryPolicyRequest,DeleteRepositoryPolicyResult> asyncHandler)
Deletes the repository policy associated with the specified repository.
deleteRepositoryPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeImageReplicationStatusResult> describeImageReplicationStatusAsync(DescribeImageReplicationStatusRequest describeImageReplicationStatusRequest)
Returns the replication status for a specified image.
describeImageReplicationStatusRequest - Future<DescribeImageReplicationStatusResult> describeImageReplicationStatusAsync(DescribeImageReplicationStatusRequest describeImageReplicationStatusRequest, AsyncHandler<DescribeImageReplicationStatusRequest,DescribeImageReplicationStatusResult> asyncHandler)
Returns the replication status for a specified image.
describeImageReplicationStatusRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeImageScanFindingsResult> describeImageScanFindingsAsync(DescribeImageScanFindingsRequest describeImageScanFindingsRequest)
Returns the scan findings for the specified image.
describeImageScanFindingsRequest - Future<DescribeImageScanFindingsResult> describeImageScanFindingsAsync(DescribeImageScanFindingsRequest describeImageScanFindingsRequest, AsyncHandler<DescribeImageScanFindingsRequest,DescribeImageScanFindingsResult> asyncHandler)
Returns the scan findings for the specified image.
describeImageScanFindingsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeImagesResult> describeImagesAsync(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.
describeImagesRequest - Future<DescribeImagesResult> describeImagesAsync(DescribeImagesRequest describeImagesRequest, AsyncHandler<DescribeImagesRequest,DescribeImagesResult> asyncHandler)
Returns metadata about the images in a repository.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker
registry. The output of the docker images command shows the uncompressed image size, so it may
return a larger image size than the image sizes returned by DescribeImages.
describeImagesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribePullThroughCacheRulesResult> describePullThroughCacheRulesAsync(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest)
Returns the pull through cache rules for a registry.
describePullThroughCacheRulesRequest - Future<DescribePullThroughCacheRulesResult> describePullThroughCacheRulesAsync(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest, AsyncHandler<DescribePullThroughCacheRulesRequest,DescribePullThroughCacheRulesResult> asyncHandler)
Returns the pull through cache rules for a registry.
describePullThroughCacheRulesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeRegistryResult> describeRegistryAsync(DescribeRegistryRequest describeRegistryRequest)
Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
describeRegistryRequest - Future<DescribeRegistryResult> describeRegistryAsync(DescribeRegistryRequest describeRegistryRequest, AsyncHandler<DescribeRegistryRequest,DescribeRegistryResult> asyncHandler)
Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
describeRegistryRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeRepositoriesResult> describeRepositoriesAsync(DescribeRepositoriesRequest describeRepositoriesRequest)
Describes image repositories in a registry.
describeRepositoriesRequest - Future<DescribeRepositoriesResult> describeRepositoriesAsync(DescribeRepositoriesRequest describeRepositoriesRequest, AsyncHandler<DescribeRepositoriesRequest,DescribeRepositoriesResult> asyncHandler)
Describes image repositories in a registry.
describeRepositoriesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAuthorizationTokenResult> getAuthorizationTokenAsync(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 a
docker login command to authenticate to a registry. The CLI offers an
get-login-password command that simplifies the login process. For more information, see Registry
authentication in the Amazon Elastic Container Registry User Guide.
getAuthorizationTokenRequest - Future<GetAuthorizationTokenResult> getAuthorizationTokenAsync(GetAuthorizationTokenRequest getAuthorizationTokenRequest, AsyncHandler<GetAuthorizationTokenRequest,GetAuthorizationTokenResult> asyncHandler)
Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.
The authorizationToken returned is a base64 encoded string that can be decoded and used in a
docker login command to authenticate to a registry. The CLI offers an
get-login-password command that simplifies the login process. For more information, see Registry
authentication in the Amazon Elastic Container Registry User Guide.
getAuthorizationTokenRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDownloadUrlForLayerResult> getDownloadUrlForLayerAsync(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.
getDownloadUrlForLayerRequest - Future<GetDownloadUrlForLayerResult> getDownloadUrlForLayerAsync(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest, AsyncHandler<GetDownloadUrlForLayerRequest,GetDownloadUrlForLayerResult> asyncHandler)
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.
When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
getDownloadUrlForLayerRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetLifecyclePolicyResult> getLifecyclePolicyAsync(GetLifecyclePolicyRequest getLifecyclePolicyRequest)
Retrieves the lifecycle policy for the specified repository.
getLifecyclePolicyRequest - Future<GetLifecyclePolicyResult> getLifecyclePolicyAsync(GetLifecyclePolicyRequest getLifecyclePolicyRequest, AsyncHandler<GetLifecyclePolicyRequest,GetLifecyclePolicyResult> asyncHandler)
Retrieves the lifecycle policy for the specified repository.
getLifecyclePolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetLifecyclePolicyPreviewResult> getLifecyclePolicyPreviewAsync(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest)
Retrieves the results of the lifecycle policy preview request for the specified repository.
getLifecyclePolicyPreviewRequest - Future<GetLifecyclePolicyPreviewResult> getLifecyclePolicyPreviewAsync(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest, AsyncHandler<GetLifecyclePolicyPreviewRequest,GetLifecyclePolicyPreviewResult> asyncHandler)
Retrieves the results of the lifecycle policy preview request for the specified repository.
getLifecyclePolicyPreviewRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetRegistryPolicyResult> getRegistryPolicyAsync(GetRegistryPolicyRequest getRegistryPolicyRequest)
Retrieves the permissions policy for a registry.
getRegistryPolicyRequest - Future<GetRegistryPolicyResult> getRegistryPolicyAsync(GetRegistryPolicyRequest getRegistryPolicyRequest, AsyncHandler<GetRegistryPolicyRequest,GetRegistryPolicyResult> asyncHandler)
Retrieves the permissions policy for a registry.
getRegistryPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetRegistryScanningConfigurationResult> getRegistryScanningConfigurationAsync(GetRegistryScanningConfigurationRequest getRegistryScanningConfigurationRequest)
Retrieves the scanning configuration for a registry.
getRegistryScanningConfigurationRequest - Future<GetRegistryScanningConfigurationResult> getRegistryScanningConfigurationAsync(GetRegistryScanningConfigurationRequest getRegistryScanningConfigurationRequest, AsyncHandler<GetRegistryScanningConfigurationRequest,GetRegistryScanningConfigurationResult> asyncHandler)
Retrieves the scanning configuration for a registry.
getRegistryScanningConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetRepositoryPolicyResult> getRepositoryPolicyAsync(GetRepositoryPolicyRequest getRepositoryPolicyRequest)
Retrieves the repository policy for the specified repository.
getRepositoryPolicyRequest - Future<GetRepositoryPolicyResult> getRepositoryPolicyAsync(GetRepositoryPolicyRequest getRepositoryPolicyRequest, AsyncHandler<GetRepositoryPolicyRequest,GetRepositoryPolicyResult> asyncHandler)
Retrieves the repository policy for the specified repository.
getRepositoryPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<InitiateLayerUploadResult> initiateLayerUploadAsync(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.
initiateLayerUploadRequest - Future<InitiateLayerUploadResult> initiateLayerUploadAsync(InitiateLayerUploadRequest initiateLayerUploadRequest, AsyncHandler<InitiateLayerUploadRequest,InitiateLayerUploadResult> asyncHandler)
Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
initiateLayerUploadRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListImagesResult> listImagesAsync(ListImagesRequest 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 either TAGGED, UNTAGGED or ANY. For example, you can filter
your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage
operation to delete them. Or, you can filter your results to return only TAGGED images to list all
of the tags in your repository.
listImagesRequest - Future<ListImagesResult> listImagesAsync(ListImagesRequest listImagesRequest, AsyncHandler<ListImagesRequest,ListImagesResult> asyncHandler)
Lists all the image IDs for the specified repository.
You can filter images based on whether or not they are tagged by using the tagStatus filter and
specifying either TAGGED, UNTAGGED or ANY. For example, you can filter
your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage
operation to delete them. Or, you can filter your results to return only TAGGED images to list all
of the tags in your repository.
listImagesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for an Amazon ECR resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
List the tags for an Amazon ECR resource.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutImageResult> putImageAsync(PutImageRequest 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.
putImageRequest - Future<PutImageResult> putImageAsync(PutImageRequest putImageRequest, AsyncHandler<PutImageRequest,PutImageResult> asyncHandler)
Creates or updates the image manifest and tags associated with an image.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
putImageRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutImageScanningConfigurationResult> putImageScanningConfigurationAsync(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.
putImageScanningConfigurationRequest - Future<PutImageScanningConfigurationResult> putImageScanningConfigurationAsync(PutImageScanningConfigurationRequest putImageScanningConfigurationRequest, AsyncHandler<PutImageScanningConfigurationRequest,PutImageScanningConfigurationResult> asyncHandler)
The PutImageScanningConfiguration API is being deprecated, in favor of specifying the image scanning
configuration at the registry level. For more information, see PutRegistryScanningConfiguration.
Updates the image scanning configuration for the specified repository.
putImageScanningConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutImageTagMutabilityResult> putImageTagMutabilityAsync(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.
putImageTagMutabilityRequest - Future<PutImageTagMutabilityResult> putImageTagMutabilityAsync(PutImageTagMutabilityRequest putImageTagMutabilityRequest, AsyncHandler<PutImageTagMutabilityRequest,PutImageTagMutabilityResult> asyncHandler)
Updates the image tag mutability settings for the specified repository. For more information, see Image tag mutability in the Amazon Elastic Container Registry User Guide.
putImageTagMutabilityRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutLifecyclePolicyResult> putLifecyclePolicyAsync(PutLifecyclePolicyRequest putLifecyclePolicyRequest)
Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.
putLifecyclePolicyRequest - Future<PutLifecyclePolicyResult> putLifecyclePolicyAsync(PutLifecyclePolicyRequest putLifecyclePolicyRequest, AsyncHandler<PutLifecyclePolicyRequest,PutLifecyclePolicyResult> asyncHandler)
Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.
putLifecyclePolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutRegistryPolicyResult> putRegistryPolicyAsync(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.
putRegistryPolicyRequest - Future<PutRegistryPolicyResult> putRegistryPolicyAsync(PutRegistryPolicyRequest putRegistryPolicyRequest, AsyncHandler<PutRegistryPolicyRequest,PutRegistryPolicyResult> asyncHandler)
Creates or updates the permissions policy for your registry.
A registry policy is used to specify permissions for another Amazon Web Services account and is used when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.
putRegistryPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutRegistryScanningConfigurationResult> putRegistryScanningConfigurationAsync(PutRegistryScanningConfigurationRequest putRegistryScanningConfigurationRequest)
Creates or updates the scanning configuration for your private registry.
putRegistryScanningConfigurationRequest - Future<PutRegistryScanningConfigurationResult> putRegistryScanningConfigurationAsync(PutRegistryScanningConfigurationRequest putRegistryScanningConfigurationRequest, AsyncHandler<PutRegistryScanningConfigurationRequest,PutRegistryScanningConfigurationResult> asyncHandler)
Creates or updates the scanning configuration for your private registry.
putRegistryScanningConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutReplicationConfigurationResult> putReplicationConfigurationAsync(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.
putReplicationConfigurationRequest - Future<PutReplicationConfigurationResult> putReplicationConfigurationAsync(PutReplicationConfigurationRequest putReplicationConfigurationRequest, AsyncHandler<PutReplicationConfigurationRequest,PutReplicationConfigurationResult> asyncHandler)
Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see Using service-linked roles for Amazon ECR in the Amazon Elastic Container Registry User Guide.
When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a registry permissions policy. For more information, see PutRegistryPolicy.
putReplicationConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SetRepositoryPolicyResult> setRepositoryPolicyAsync(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.
setRepositoryPolicyRequest - Future<SetRepositoryPolicyResult> setRepositoryPolicyAsync(SetRepositoryPolicyRequest setRepositoryPolicyRequest, AsyncHandler<SetRepositoryPolicyRequest,SetRepositoryPolicyResult> asyncHandler)
Applies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository policies in the Amazon Elastic Container Registry User Guide.
setRepositoryPolicyRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartImageScanResult> startImageScanAsync(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.
startImageScanRequest - Future<StartImageScanResult> startImageScanAsync(StartImageScanRequest startImageScanRequest, AsyncHandler<StartImageScanRequest,StartImageScanResult> asyncHandler)
Starts an image vulnerability scan. An image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image scanning in the Amazon Elastic Container Registry User Guide.
startImageScanRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartLifecyclePolicyPreviewResult> startLifecyclePolicyPreviewAsync(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.
startLifecyclePolicyPreviewRequest - Future<StartLifecyclePolicyPreviewResult> startLifecyclePolicyPreviewAsync(StartLifecyclePolicyPreviewRequest startLifecyclePolicyPreviewRequest, AsyncHandler<StartLifecyclePolicyPreviewRequest,StartLifecyclePolicyPreviewResult> asyncHandler)
Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.
startLifecyclePolicyPreviewRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest 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.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Deletes specified tags from a resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Deletes specified tags from a resource.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UploadLayerPartResult> uploadLayerPartAsync(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.
uploadLayerPartRequest - Future<UploadLayerPartResult> uploadLayerPartAsync(UploadLayerPartRequest uploadLayerPartRequest, AsyncHandler<UploadLayerPartRequest,UploadLayerPartResult> asyncHandler)
Uploads an image layer part to Amazon ECR.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing
images. In most cases, you should use the docker CLI to pull, tag, and push images.
uploadLayerPartRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.