@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface EcrAsyncClient extends AwsClient
builder()
method.
Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR supports private repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images.
Amazon ECR has service endpoints in each supported Region. For more information, see Amazon ECR endpoints in the Amazon Web Services General Reference.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.
batchCheckLayerAvailabilityRequest - 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 via BatchCheckLayerAvailabilityRequest.builder()
batchCheckLayerAvailabilityRequest - A Consumer that will call methods on
BatchCheckLayerAvailabilityRequest.Builder to create a
request.default CompletableFuture<BatchDeleteImageResponse> batchDeleteImage(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.default CompletableFuture<BatchDeleteImageResponse> batchDeleteImage(Consumer<BatchDeleteImageRequest.Builder> 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.
This is a convenience which creates an instance of the BatchDeleteImageRequest.Builder avoiding the need
to create one manually via BatchDeleteImageRequest.builder()
batchDeleteImageRequest - A Consumer that will call methods on
BatchDeleteImageRequest.Builder to create a request.
Deletes specified images within a specified repository. Images are specified with either the
imageTag or imageDigest.default CompletableFuture<BatchGetImageResponse> batchGetImage(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 - default CompletableFuture<BatchGetImageResponse> batchGetImage(Consumer<BatchGetImageRequest.Builder> 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.
This is a convenience which creates an instance of the BatchGetImageRequest.Builder avoiding the need to
create one manually via BatchGetImageRequest.builder()
batchGetImageRequest - A Consumer that will call methods on
BatchGetImageRequest.Builder to create a request.default CompletableFuture<BatchGetRepositoryScanningConfigurationResponse> batchGetRepositoryScanningConfiguration(BatchGetRepositoryScanningConfigurationRequest batchGetRepositoryScanningConfigurationRequest)
Gets the scanning configuration for one or more repositories.
batchGetRepositoryScanningConfigurationRequest - 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 via
BatchGetRepositoryScanningConfigurationRequest.builder()
batchGetRepositoryScanningConfigurationRequest - A Consumer that will call methods on
BatchGetRepositoryScanningConfigurationRequest.Builder
to create a request.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.
completeLayerUploadRequest - 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 via CompleteLayerUploadRequest.builder()
completeLayerUploadRequest - A Consumer that will call methods on
CompleteLayerUploadRequest.Builder to create a request.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 external public registry in your Amazon ECR private registry.
createPullThroughCacheRuleRequest - 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 external public registry in your Amazon ECR private registry.
This is a convenience which creates an instance of the CreatePullThroughCacheRuleRequest.Builder avoiding
the need to create one manually via CreatePullThroughCacheRuleRequest.builder()
createPullThroughCacheRuleRequest - A Consumer that will call methods on
CreatePullThroughCacheRuleRequest.Builder to create a
request.default CompletableFuture<CreateRepositoryResponse> createRepository(CreateRepositoryRequest createRepositoryRequest)
Creates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
createRepositoryRequest - 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 via CreateRepositoryRequest.builder()
createRepositoryRequest - A Consumer that will call methods on
CreateRepositoryRequest.Builder to create a request.default CompletableFuture<DeleteLifecyclePolicyResponse> deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)
Deletes the lifecycle policy associated with the specified repository.
deleteLifecyclePolicyRequest - 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 via DeleteLifecyclePolicyRequest.builder()
deleteLifecyclePolicyRequest - A Consumer that will call methods on
DeleteLifecyclePolicyRequest.Builder to create a
request.default CompletableFuture<DeletePullThroughCacheRuleResponse> deletePullThroughCacheRule(DeletePullThroughCacheRuleRequest deletePullThroughCacheRuleRequest)
Deletes a pull through cache rule.
deletePullThroughCacheRuleRequest - 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 via DeletePullThroughCacheRuleRequest.builder()
deletePullThroughCacheRuleRequest - A Consumer that will call methods on
DeletePullThroughCacheRuleRequest.Builder to create a
request.default CompletableFuture<DeleteRegistryPolicyResponse> deleteRegistryPolicy(DeleteRegistryPolicyRequest deleteRegistryPolicyRequest)
Deletes the registry permissions policy.
deleteRegistryPolicyRequest - 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 via DeleteRegistryPolicyRequest.builder()
deleteRegistryPolicyRequest - A Consumer that will call methods on
DeleteRegistryPolicyRequest.Builder to create a request.default CompletableFuture<DeleteRepositoryResponse> deleteRepository(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 - force parameter.default CompletableFuture<DeleteRepositoryResponse> deleteRepository(Consumer<DeleteRepositoryRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteRepositoryRequest.Builder avoiding the need
to create one manually via DeleteRepositoryRequest.builder()
deleteRepositoryRequest - A Consumer that will call methods on
DeleteRepositoryRequest.Builder to create a request.force parameter.default CompletableFuture<DeleteRepositoryPolicyResponse> deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest)
Deletes the repository policy associated with the specified repository.
deleteRepositoryPolicyRequest - 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 via DeleteRepositoryPolicyRequest.builder()
deleteRepositoryPolicyRequest - A Consumer that will call methods on
DeleteRepositoryPolicyRequest.Builder to create a
request.default CompletableFuture<DescribeImageReplicationStatusResponse> describeImageReplicationStatus(DescribeImageReplicationStatusRequest describeImageReplicationStatusRequest)
Returns the replication status for a specified image.
describeImageReplicationStatusRequest - 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 via DescribeImageReplicationStatusRequest.builder()
describeImageReplicationStatusRequest - A Consumer that will call methods on
DescribeImageReplicationStatusRequest.Builder to create
a request.default CompletableFuture<DescribeImageScanFindingsResponse> describeImageScanFindings(DescribeImageScanFindingsRequest describeImageScanFindingsRequest)
Returns the scan findings for the specified image.
describeImageScanFindingsRequest - 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 via DescribeImageScanFindingsRequest.builder()
describeImageScanFindingsRequest - A Consumer that will call methods on
DescribeImageScanFindingsRequest.Builder to create a
request.default DescribeImageScanFindingsPublisher describeImageScanFindingsPaginator(DescribeImageScanFindingsRequest describeImageScanFindingsRequest)
Returns the scan findings for the specified image.
This is a variant of
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation. The return type is a custom 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 new Subscription 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 method
software.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsPublisher publisher = client.describeImageScanFindingsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation.
describeImageScanFindingsRequest - default DescribeImageScanFindingsPublisher describeImageScanFindingsPaginator(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest)
Returns the scan findings for the specified image.
This is a variant of
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation. The return type is a custom 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 new Subscription 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 method
software.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsPublisher publisher = client.describeImageScanFindingsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation.
This is a convenience which creates an instance of the DescribeImageScanFindingsRequest.Builder avoiding
the need to create one manually via DescribeImageScanFindingsRequest.builder()
describeImageScanFindingsRequest - A Consumer that will call methods on
DescribeImageScanFindingsRequest.Builder to create a
request.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.
describeImagesRequest - 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 via DescribeImagesRequest.builder()
describeImagesRequest - A Consumer that will call methods on
DescribeImagesRequest.Builder to create a request.default DescribeImagesPublisher describeImagesPaginator(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.
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 new Subscription 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 method
software.amazon.awssdk.services.ecr.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest) operation.
describeImagesRequest - default DescribeImagesPublisher describeImagesPaginator(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 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 new Subscription 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 method
software.amazon.awssdk.services.ecr.paginators.DescribeImagesPublisher publisher = client.describeImagesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest) operation.
This is a convenience which creates an instance of the DescribeImagesRequest.Builder avoiding the need to
create one manually via DescribeImagesRequest.builder()
describeImagesRequest - A Consumer that will call methods on
DescribeImagesRequest.Builder to create a request.default CompletableFuture<DescribePullThroughCacheRulesResponse> describePullThroughCacheRules(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest)
Returns the pull through cache rules for a registry.
describePullThroughCacheRulesRequest - 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 via DescribePullThroughCacheRulesRequest.builder()
describePullThroughCacheRulesRequest - A Consumer that will call methods on
DescribePullThroughCacheRulesRequest.Builder to create a
request.default DescribePullThroughCacheRulesPublisher describePullThroughCacheRulesPaginator(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest)
Returns the pull through cache rules for a registry.
This is a variant of
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation. The return type is a custom 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 new Subscription 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 method
software.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesPublisher publisher = client.describePullThroughCacheRulesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation.
describePullThroughCacheRulesRequest - default DescribePullThroughCacheRulesPublisher describePullThroughCacheRulesPaginator(Consumer<DescribePullThroughCacheRulesRequest.Builder> describePullThroughCacheRulesRequest)
Returns the pull through cache rules for a registry.
This is a variant of
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation. The return type is a custom 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 new Subscription 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 method
software.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesPublisher publisher = client.describePullThroughCacheRulesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation.
This is a convenience which creates an instance of the DescribePullThroughCacheRulesRequest.Builder
avoiding the need to create one manually via DescribePullThroughCacheRulesRequest.builder()
describePullThroughCacheRulesRequest - A Consumer that will call methods on
DescribePullThroughCacheRulesRequest.Builder to create a
request.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.
describeRegistryRequest - 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 via DescribeRegistryRequest.builder()
describeRegistryRequest - A Consumer that will call methods on
DescribeRegistryRequest.Builder to create a request.default CompletableFuture<DescribeRepositoriesResponse> describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest)
Describes image repositories in a registry.
describeRepositoriesRequest - 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 via DescribeRepositoriesRequest.builder()
describeRepositoriesRequest - A Consumer that will call methods on
DescribeRepositoriesRequest.Builder to create a request.default CompletableFuture<DescribeRepositoriesResponse> describeRepositories()
Describes image repositories in a registry.
default DescribeRepositoriesPublisher describeRepositoriesPaginator()
Describes image repositories in a registry.
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest) operation.
The return type is a custom 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 new Subscription 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 method
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesPublisher publisher = client.describeRepositoriesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
default DescribeRepositoriesPublisher describeRepositoriesPaginator(DescribeRepositoriesRequest describeRepositoriesRequest)
Describes image repositories in a registry.
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest) operation.
The return type is a custom 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 new Subscription 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 method
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesPublisher publisher = client.describeRepositoriesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.
describeRepositoriesRequest - default DescribeRepositoriesPublisher describeRepositoriesPaginator(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest)
Describes image repositories in a registry.
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest) operation.
The return type is a custom 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 new Subscription 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 method
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesPublisher publisher = client.describeRepositoriesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.
This is a convenience which creates an instance of the DescribeRepositoriesRequest.Builder avoiding the
need to create one manually via DescribeRepositoriesRequest.builder()
describeRepositoriesRequest - A Consumer that will call methods on
DescribeRepositoriesRequest.Builder to create a request.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 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 - 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 a
docker login command to authenticate to a registry. The CLI offers an
get-login-password command that simplifies the login process. For more information, see Registry
authentication in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the GetAuthorizationTokenRequest.Builder avoiding the
need to create one manually via GetAuthorizationTokenRequest.builder()
getAuthorizationTokenRequest - A Consumer that will call methods on
GetAuthorizationTokenRequest.Builder to create a
request.default CompletableFuture<GetAuthorizationTokenResponse> 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 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.
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.
getDownloadUrlForLayerRequest - 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 via GetDownloadUrlForLayerRequest.builder()
getDownloadUrlForLayerRequest - A Consumer that will call methods on
GetDownloadUrlForLayerRequest.Builder to create a
request.default CompletableFuture<GetLifecyclePolicyResponse> getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest)
Retrieves the lifecycle policy for the specified repository.
getLifecyclePolicyRequest - 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 via GetLifecyclePolicyRequest.builder()
getLifecyclePolicyRequest - A Consumer that will call methods on
GetLifecyclePolicyRequest.Builder to create a request.default CompletableFuture<GetLifecyclePolicyPreviewResponse> getLifecyclePolicyPreview(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest)
Retrieves the results of the lifecycle policy preview request for the specified repository.
getLifecyclePolicyPreviewRequest - 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 via GetLifecyclePolicyPreviewRequest.builder()
getLifecyclePolicyPreviewRequest - A Consumer that will call methods on
GetLifecyclePolicyPreviewRequest.Builder to create a
request.default GetLifecyclePolicyPreviewPublisher getLifecyclePolicyPreviewPaginator(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest)
Retrieves the results of the lifecycle policy preview request for the specified repository.
This is a variant of
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation. The return type is a custom 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 new Subscription 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 method
software.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewPublisher publisher = client.getLifecyclePolicyPreviewPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation.
getLifecyclePolicyPreviewRequest - default GetLifecyclePolicyPreviewPublisher getLifecyclePolicyPreviewPaginator(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest)
Retrieves the results of the lifecycle policy preview request for the specified repository.
This is a variant of
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation. The return type is a custom 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 new Subscription 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 method
software.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewPublisher publisher = client.getLifecyclePolicyPreviewPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation.
This is a convenience which creates an instance of the GetLifecyclePolicyPreviewRequest.Builder avoiding
the need to create one manually via GetLifecyclePolicyPreviewRequest.builder()
getLifecyclePolicyPreviewRequest - A Consumer that will call methods on
GetLifecyclePolicyPreviewRequest.Builder to create a
request.default CompletableFuture<GetRegistryPolicyResponse> getRegistryPolicy(GetRegistryPolicyRequest getRegistryPolicyRequest)
Retrieves the permissions policy for a registry.
getRegistryPolicyRequest - 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 via GetRegistryPolicyRequest.builder()
getRegistryPolicyRequest - A Consumer that will call methods on
GetRegistryPolicyRequest.Builder to create a request.default CompletableFuture<GetRegistryScanningConfigurationResponse> getRegistryScanningConfiguration(GetRegistryScanningConfigurationRequest getRegistryScanningConfigurationRequest)
Retrieves the scanning configuration for a registry.
getRegistryScanningConfigurationRequest - 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 via GetRegistryScanningConfigurationRequest.builder()
getRegistryScanningConfigurationRequest - A Consumer that will call methods on
GetRegistryScanningConfigurationRequest.Builder to
create a request.default CompletableFuture<GetRepositoryPolicyResponse> getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest)
Retrieves the repository policy for the specified repository.
getRepositoryPolicyRequest - 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 via GetRepositoryPolicyRequest.builder()
getRepositoryPolicyRequest - A Consumer that will call methods on
GetRepositoryPolicyRequest.Builder to create a request.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.
initiateLayerUploadRequest - 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 via InitiateLayerUploadRequest.builder()
initiateLayerUploadRequest - A Consumer that will call methods on
InitiateLayerUploadRequest.Builder to create a request.default CompletableFuture<ListImagesResponse> listImages(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 - 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 either TAGGED, UNTAGGED or ANY. For example, you can filter
your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage
operation to delete them. Or, you can filter your results to return only TAGGED images to list all
of the tags in your repository.
This is a convenience which creates an instance of the ListImagesRequest.Builder avoiding the need to
create one manually via ListImagesRequest.builder()
listImagesRequest - A Consumer that will call methods on
ListImagesRequest.Builder to create a request.default ListImagesPublisher listImagesPaginator(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.
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 new Subscription 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 method
software.amazon.awssdk.services.ecr.paginators.ListImagesPublisher publisher = client.listImagesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest) operation.
listImagesRequest - default ListImagesPublisher listImagesPaginator(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 either TAGGED, UNTAGGED or ANY. For example, you can filter
your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage
operation to delete them. Or, you can filter your results to return only TAGGED images to list all
of the tags in your repository.
This is a variant of listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest) operation.
The return type is a custom 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 new Subscription 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 method
software.amazon.awssdk.services.ecr.paginators.ListImagesPublisher publisher = client.listImagesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest) operation.
This is a convenience which creates an instance of the ListImagesRequest.Builder avoiding the need to
create one manually via ListImagesRequest.builder()
listImagesRequest - A Consumer that will call methods on
ListImagesRequest.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for an Amazon ECR resource.
listTagsForResourceRequest - 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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a request.default CompletableFuture<PutImageResponse> putImage(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 - 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 via PutImageRequest.builder()
putImageRequest - A Consumer that will call methods on
PutImageRequest.Builder to create a request.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.
putImageScanningConfigurationRequest - 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 via PutImageScanningConfigurationRequest.builder()
putImageScanningConfigurationRequest - A Consumer that will call methods on
PutImageScanningConfigurationRequest.Builder to create a
request.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.
putImageTagMutabilityRequest - 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 via PutImageTagMutabilityRequest.builder()
putImageTagMutabilityRequest - A Consumer that will call methods on
PutImageTagMutabilityRequest.Builder to create a
request.default CompletableFuture<PutLifecyclePolicyResponse> putLifecyclePolicy(PutLifecyclePolicyRequest putLifecyclePolicyRequest)
Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.
putLifecyclePolicyRequest - 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 via PutLifecyclePolicyRequest.builder()
putLifecyclePolicyRequest - A Consumer that will call methods on
PutLifecyclePolicyRequest.Builder to create a request.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.
putRegistryPolicyRequest - 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 via PutRegistryPolicyRequest.builder()
putRegistryPolicyRequest - A Consumer that will call methods on
PutRegistryPolicyRequest.Builder to create a request.default CompletableFuture<PutRegistryScanningConfigurationResponse> putRegistryScanningConfiguration(PutRegistryScanningConfigurationRequest putRegistryScanningConfigurationRequest)
Creates or updates the scanning configuration for your private registry.
putRegistryScanningConfigurationRequest - 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 via PutRegistryScanningConfigurationRequest.builder()
putRegistryScanningConfigurationRequest - A Consumer that will call methods on
PutRegistryScanningConfigurationRequest.Builder to
create a request.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.
putReplicationConfigurationRequest - 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 via PutReplicationConfigurationRequest.builder()
putReplicationConfigurationRequest - A Consumer that will call methods on
PutReplicationConfigurationRequest.Builder to create a
request.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.
setRepositoryPolicyRequest - 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 via SetRepositoryPolicyRequest.builder()
setRepositoryPolicyRequest - A Consumer that will call methods on
SetRepositoryPolicyRequest.Builder to create a request.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.
startImageScanRequest - 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 via StartImageScanRequest.builder()
startImageScanRequest - A Consumer that will call methods on
StartImageScanRequest.Builder to create a request.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.
startLifecyclePolicyPreviewRequest - 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 via StartLifecyclePolicyPreviewRequest.builder()
startLifecyclePolicyPreviewRequest - A Consumer that will call methods on
StartLifecyclePolicyPreviewRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(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 - 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 via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Deletes specified tags from a resource.
untagResourceRequest - 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 via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.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.
uploadLayerPartRequest - 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 via UploadLayerPartRequest.builder()
uploadLayerPartRequest - A Consumer that will call methods on
UploadLayerPartRequest.Builder to create a request.default EcrAsyncWaiter waiter()
EcrAsyncWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
EcrAsyncWaiterdefault EcrServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic EcrAsyncClient create()
EcrAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static EcrAsyncClientBuilder builder()
EcrAsyncClient.Copyright © 2023. All rights reserved.