Interface EcrClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchCheckLayerAvailability
(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest) Checks the availability of one or more image layers in a repository.batchCheckLayerAvailability
(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) Checks the availability of one or more image layers in a repository.default BatchDeleteImageResponse
batchDeleteImage
(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest) Deletes a list of specified images within a repository.default BatchDeleteImageResponse
batchDeleteImage
(BatchDeleteImageRequest batchDeleteImageRequest) Deletes a list of specified images within a repository.default BatchGetImageResponse
batchGetImage
(Consumer<BatchGetImageRequest.Builder> batchGetImageRequest) Gets detailed information for an image.default BatchGetImageResponse
batchGetImage
(BatchGetImageRequest batchGetImageRequest) Gets detailed information for an image.batchGetRepositoryScanningConfiguration
(Consumer<BatchGetRepositoryScanningConfigurationRequest.Builder> batchGetRepositoryScanningConfigurationRequest) Gets the scanning configuration for one or more repositories.batchGetRepositoryScanningConfiguration
(BatchGetRepositoryScanningConfigurationRequest batchGetRepositoryScanningConfigurationRequest) Gets the scanning configuration for one or more repositories.static EcrClientBuilder
builder()
Create a builder that can be used to configure and create aEcrClient
.default CompleteLayerUploadResponse
completeLayerUpload
(Consumer<CompleteLayerUploadRequest.Builder> completeLayerUploadRequest) Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID.default CompleteLayerUploadResponse
completeLayerUpload
(CompleteLayerUploadRequest completeLayerUploadRequest) Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID.static EcrClient
create()
Create aEcrClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createPullThroughCacheRule
(Consumer<CreatePullThroughCacheRuleRequest.Builder> createPullThroughCacheRuleRequest) Creates a pull through cache rule.createPullThroughCacheRule
(CreatePullThroughCacheRuleRequest createPullThroughCacheRuleRequest) Creates a pull through cache rule.default CreateRepositoryResponse
createRepository
(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) Creates a repository.default CreateRepositoryResponse
createRepository
(CreateRepositoryRequest createRepositoryRequest) Creates a repository.createRepositoryCreationTemplate
(Consumer<CreateRepositoryCreationTemplateRequest.Builder> createRepositoryCreationTemplateRequest) Creates a repository creation template.createRepositoryCreationTemplate
(CreateRepositoryCreationTemplateRequest createRepositoryCreationTemplateRequest) Creates a repository creation template.default DeleteLifecyclePolicyResponse
deleteLifecyclePolicy
(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest) Deletes the lifecycle policy associated with the specified repository.default DeleteLifecyclePolicyResponse
deleteLifecyclePolicy
(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest) Deletes the lifecycle policy associated with the specified repository.deletePullThroughCacheRule
(Consumer<DeletePullThroughCacheRuleRequest.Builder> deletePullThroughCacheRuleRequest) Deletes a pull through cache rule.deletePullThroughCacheRule
(DeletePullThroughCacheRuleRequest deletePullThroughCacheRuleRequest) Deletes a pull through cache rule.default DeleteRegistryPolicyResponse
deleteRegistryPolicy
(Consumer<DeleteRegistryPolicyRequest.Builder> deleteRegistryPolicyRequest) Deletes the registry permissions policy.default DeleteRegistryPolicyResponse
deleteRegistryPolicy
(DeleteRegistryPolicyRequest deleteRegistryPolicyRequest) Deletes the registry permissions policy.default DeleteRepositoryResponse
deleteRepository
(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) Deletes a repository.default DeleteRepositoryResponse
deleteRepository
(DeleteRepositoryRequest deleteRepositoryRequest) Deletes a repository.deleteRepositoryCreationTemplate
(Consumer<DeleteRepositoryCreationTemplateRequest.Builder> deleteRepositoryCreationTemplateRequest) Deletes a repository creation template.deleteRepositoryCreationTemplate
(DeleteRepositoryCreationTemplateRequest deleteRepositoryCreationTemplateRequest) Deletes a repository creation template.default DeleteRepositoryPolicyResponse
deleteRepositoryPolicy
(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest) Deletes the repository policy associated with the specified repository.default DeleteRepositoryPolicyResponse
deleteRepositoryPolicy
(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) Deletes the repository policy associated with the specified repository.describeImageReplicationStatus
(Consumer<DescribeImageReplicationStatusRequest.Builder> describeImageReplicationStatusRequest) Returns the replication status for a specified image.describeImageReplicationStatus
(DescribeImageReplicationStatusRequest describeImageReplicationStatusRequest) Returns the replication status for a specified image.default DescribeImagesResponse
describeImages
(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) Returns metadata about the images in a repository.default DescribeImagesResponse
describeImages
(DescribeImagesRequest describeImagesRequest) Returns metadata about the images in a repository.describeImageScanFindings
(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest) Returns the scan findings for the specified image.describeImageScanFindings
(DescribeImageScanFindingsRequest describeImageScanFindingsRequest) Returns the scan findings for the specified image.describeImageScanFindingsPaginator
(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest) This is a variant ofdescribeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation.describeImageScanFindingsPaginator
(DescribeImageScanFindingsRequest describeImageScanFindingsRequest) This is a variant ofdescribeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation.default DescribeImagesIterable
describeImagesPaginator
(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) This is a variant ofdescribeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation.default DescribeImagesIterable
describeImagesPaginator
(DescribeImagesRequest describeImagesRequest) This is a variant ofdescribeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation.describePullThroughCacheRules
(Consumer<DescribePullThroughCacheRulesRequest.Builder> describePullThroughCacheRulesRequest) Returns the pull through cache rules for a registry.describePullThroughCacheRules
(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest) Returns the pull through cache rules for a registry.describePullThroughCacheRulesPaginator
(Consumer<DescribePullThroughCacheRulesRequest.Builder> describePullThroughCacheRulesRequest) This is a variant ofdescribePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation.describePullThroughCacheRulesPaginator
(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest) This is a variant ofdescribePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation.default DescribeRegistryResponse
describeRegistry
(Consumer<DescribeRegistryRequest.Builder> describeRegistryRequest) Describes the settings for a registry.default DescribeRegistryResponse
describeRegistry
(DescribeRegistryRequest describeRegistryRequest) Describes the settings for a registry.default DescribeRepositoriesResponse
Describes image repositories in a registry.default DescribeRepositoriesResponse
describeRepositories
(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) Describes image repositories in a registry.default DescribeRepositoriesResponse
describeRepositories
(DescribeRepositoriesRequest describeRepositoriesRequest) Describes image repositories in a registry.default DescribeRepositoriesIterable
This is a variant ofdescribeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.default DescribeRepositoriesIterable
describeRepositoriesPaginator
(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) This is a variant ofdescribeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.default DescribeRepositoriesIterable
describeRepositoriesPaginator
(DescribeRepositoriesRequest describeRepositoriesRequest) This is a variant ofdescribeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.describeRepositoryCreationTemplates
(Consumer<DescribeRepositoryCreationTemplatesRequest.Builder> describeRepositoryCreationTemplatesRequest) Returns details about the repository creation templates in a registry.describeRepositoryCreationTemplates
(DescribeRepositoryCreationTemplatesRequest describeRepositoryCreationTemplatesRequest) Returns details about the repository creation templates in a registry.describeRepositoryCreationTemplatesPaginator
(Consumer<DescribeRepositoryCreationTemplatesRequest.Builder> describeRepositoryCreationTemplatesRequest) This is a variant ofdescribeRepositoryCreationTemplates(software.amazon.awssdk.services.ecr.model.DescribeRepositoryCreationTemplatesRequest)
operation.describeRepositoryCreationTemplatesPaginator
(DescribeRepositoryCreationTemplatesRequest describeRepositoryCreationTemplatesRequest) This is a variant ofdescribeRepositoryCreationTemplates(software.amazon.awssdk.services.ecr.model.DescribeRepositoryCreationTemplatesRequest)
operation.default GetAccountSettingResponse
getAccountSetting
(Consumer<GetAccountSettingRequest.Builder> getAccountSettingRequest) Retrieves the basic scan type version name.default GetAccountSettingResponse
getAccountSetting
(GetAccountSettingRequest getAccountSettingRequest) Retrieves the basic scan type version name.default GetAuthorizationTokenResponse
Retrieves an authorization token.default GetAuthorizationTokenResponse
getAuthorizationToken
(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest) Retrieves an authorization token.default GetAuthorizationTokenResponse
getAuthorizationToken
(GetAuthorizationTokenRequest getAuthorizationTokenRequest) Retrieves an authorization token.default GetDownloadUrlForLayerResponse
getDownloadUrlForLayer
(Consumer<GetDownloadUrlForLayerRequest.Builder> getDownloadUrlForLayerRequest) Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.default GetDownloadUrlForLayerResponse
getDownloadUrlForLayer
(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest) Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.default GetLifecyclePolicyResponse
getLifecyclePolicy
(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest) Retrieves the lifecycle policy for the specified repository.default GetLifecyclePolicyResponse
getLifecyclePolicy
(GetLifecyclePolicyRequest getLifecyclePolicyRequest) Retrieves the lifecycle policy for the specified repository.getLifecyclePolicyPreview
(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest) Retrieves the results of the lifecycle policy preview request for the specified repository.getLifecyclePolicyPreview
(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest) Retrieves the results of the lifecycle policy preview request for the specified repository.getLifecyclePolicyPreviewPaginator
(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest) This is a variant ofgetLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation.getLifecyclePolicyPreviewPaginator
(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest) This is a variant ofgetLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation.default GetRegistryPolicyResponse
getRegistryPolicy
(Consumer<GetRegistryPolicyRequest.Builder> getRegistryPolicyRequest) Retrieves the permissions policy for a registry.default GetRegistryPolicyResponse
getRegistryPolicy
(GetRegistryPolicyRequest getRegistryPolicyRequest) Retrieves the permissions policy for a registry.getRegistryScanningConfiguration
(Consumer<GetRegistryScanningConfigurationRequest.Builder> getRegistryScanningConfigurationRequest) Retrieves the scanning configuration for a registry.getRegistryScanningConfiguration
(GetRegistryScanningConfigurationRequest getRegistryScanningConfigurationRequest) Retrieves the scanning configuration for a registry.default GetRepositoryPolicyResponse
getRepositoryPolicy
(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest) Retrieves the repository policy for the specified repository.default GetRepositoryPolicyResponse
getRepositoryPolicy
(GetRepositoryPolicyRequest getRepositoryPolicyRequest) Retrieves the repository policy for the specified repository.default InitiateLayerUploadResponse
initiateLayerUpload
(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest) Notifies Amazon ECR that you intend to upload an image layer.default InitiateLayerUploadResponse
initiateLayerUpload
(InitiateLayerUploadRequest initiateLayerUploadRequest) Notifies Amazon ECR that you intend to upload an image layer.default ListImagesResponse
listImages
(Consumer<ListImagesRequest.Builder> listImagesRequest) Lists all the image IDs for the specified repository.default ListImagesResponse
listImages
(ListImagesRequest listImagesRequest) Lists all the image IDs for the specified repository.default ListImagesIterable
listImagesPaginator
(Consumer<ListImagesRequest.Builder> listImagesRequest) This is a variant oflistImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)
operation.default ListImagesIterable
listImagesPaginator
(ListImagesRequest listImagesRequest) This is a variant oflistImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags for an Amazon ECR resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List the tags for an Amazon ECR resource.default PutAccountSettingResponse
putAccountSetting
(Consumer<PutAccountSettingRequest.Builder> putAccountSettingRequest) Allows you to change the basic scan type version by setting thename
parameter to eitherCLAIR
toAWS_NATIVE
.default PutAccountSettingResponse
putAccountSetting
(PutAccountSettingRequest putAccountSettingRequest) Allows you to change the basic scan type version by setting thename
parameter to eitherCLAIR
toAWS_NATIVE
.default PutImageResponse
putImage
(Consumer<PutImageRequest.Builder> putImageRequest) Creates or updates the image manifest and tags associated with an image.default PutImageResponse
putImage
(PutImageRequest putImageRequest) Creates or updates the image manifest and tags associated with an image.putImageScanningConfiguration
(Consumer<PutImageScanningConfigurationRequest.Builder> putImageScanningConfigurationRequest) putImageScanningConfiguration
(PutImageScanningConfigurationRequest putImageScanningConfigurationRequest) default PutImageTagMutabilityResponse
putImageTagMutability
(Consumer<PutImageTagMutabilityRequest.Builder> putImageTagMutabilityRequest) Updates the image tag mutability settings for the specified repository.default PutImageTagMutabilityResponse
putImageTagMutability
(PutImageTagMutabilityRequest putImageTagMutabilityRequest) Updates the image tag mutability settings for the specified repository.default PutLifecyclePolicyResponse
putLifecyclePolicy
(Consumer<PutLifecyclePolicyRequest.Builder> putLifecyclePolicyRequest) Creates or updates the lifecycle policy for the specified repository.default PutLifecyclePolicyResponse
putLifecyclePolicy
(PutLifecyclePolicyRequest putLifecyclePolicyRequest) Creates or updates the lifecycle policy for the specified repository.default PutRegistryPolicyResponse
putRegistryPolicy
(Consumer<PutRegistryPolicyRequest.Builder> putRegistryPolicyRequest) Creates or updates the permissions policy for your registry.default PutRegistryPolicyResponse
putRegistryPolicy
(PutRegistryPolicyRequest putRegistryPolicyRequest) Creates or updates the permissions policy for your registry.putRegistryScanningConfiguration
(Consumer<PutRegistryScanningConfigurationRequest.Builder> putRegistryScanningConfigurationRequest) Creates or updates the scanning configuration for your private registry.putRegistryScanningConfiguration
(PutRegistryScanningConfigurationRequest putRegistryScanningConfigurationRequest) Creates or updates the scanning configuration for your private registry.putReplicationConfiguration
(Consumer<PutReplicationConfigurationRequest.Builder> putReplicationConfigurationRequest) Creates or updates the replication configuration for a registry.putReplicationConfiguration
(PutReplicationConfigurationRequest putReplicationConfigurationRequest) Creates or updates the replication configuration for a registry.default EcrServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default SetRepositoryPolicyResponse
setRepositoryPolicy
(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest) Applies a repository policy to the specified repository to control access permissions.default SetRepositoryPolicyResponse
setRepositoryPolicy
(SetRepositoryPolicyRequest setRepositoryPolicyRequest) Applies a repository policy to the specified repository to control access permissions.default StartImageScanResponse
startImageScan
(Consumer<StartImageScanRequest.Builder> startImageScanRequest) Starts an image vulnerability scan.default StartImageScanResponse
startImageScan
(StartImageScanRequest startImageScanRequest) Starts an image vulnerability scan.startLifecyclePolicyPreview
(Consumer<StartLifecyclePolicyPreviewRequest.Builder> startLifecyclePolicyPreviewRequest) Starts a preview of a lifecycle policy for the specified repository.startLifecyclePolicyPreview
(StartLifecyclePolicyPreviewRequest startLifecyclePolicyPreviewRequest) Starts a preview of a lifecycle policy for the specified repository.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds specified tags to a resource with the specified ARN.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds specified tags to a resource with the specified ARN.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes specified tags from a resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Deletes specified tags from a resource.updatePullThroughCacheRule
(Consumer<UpdatePullThroughCacheRuleRequest.Builder> updatePullThroughCacheRuleRequest) Updates an existing pull through cache rule.updatePullThroughCacheRule
(UpdatePullThroughCacheRuleRequest updatePullThroughCacheRuleRequest) Updates an existing pull through cache rule.updateRepositoryCreationTemplate
(Consumer<UpdateRepositoryCreationTemplateRequest.Builder> updateRepositoryCreationTemplateRequest) Updates an existing repository creation template.updateRepositoryCreationTemplate
(UpdateRepositoryCreationTemplateRequest updateRepositoryCreationTemplateRequest) Updates an existing repository creation template.default UploadLayerPartResponse
uploadLayerPart
(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest) Uploads an image layer part to Amazon ECR.default UploadLayerPartResponse
uploadLayerPart
(UploadLayerPartRequest uploadLayerPartRequest) Uploads an image layer part to Amazon ECR.validatePullThroughCacheRule
(Consumer<ValidatePullThroughCacheRuleRequest.Builder> validatePullThroughCacheRuleRequest) Validates an existing pull through cache rule for an upstream registry that requires authentication.validatePullThroughCacheRule
(ValidatePullThroughCacheRuleRequest validatePullThroughCacheRuleRequest) Validates an existing pull through cache rule for an upstream registry that requires authentication.default EcrWaiter
waiter()
Create an instance ofEcrWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchCheckLayerAvailability
default BatchCheckLayerAvailabilityResponse batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) throws RepositoryNotFoundException, InvalidParameterException, ServerException, AwsServiceException, SdkClientException, EcrException Checks the availability of one or more image layers in a repository.
When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
docker
CLI to pull, tag, and push images.- Parameters:
batchCheckLayerAvailabilityRequest
-- Returns:
- Result of the BatchCheckLayerAvailability operation returned by the service.
- See Also:
-
batchCheckLayerAvailability
default BatchCheckLayerAvailabilityResponse batchCheckLayerAvailability(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest) throws RepositoryNotFoundException, InvalidParameterException, ServerException, AwsServiceException, SdkClientException, EcrException Checks the availability of one or more image layers in a repository.
When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
docker
CLI to pull, tag, and push images.
This is a convenience which creates an instance of the
BatchCheckLayerAvailabilityRequest.Builder
avoiding the need to create one manually viaBatchCheckLayerAvailabilityRequest.builder()
- Parameters:
batchCheckLayerAvailabilityRequest
- AConsumer
that will call methods onBatchCheckLayerAvailabilityRequest.Builder
to create a request.- Returns:
- Result of the BatchCheckLayerAvailability operation returned by the service.
- See Also:
-
batchDeleteImage
default BatchDeleteImageResponse batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException Deletes a list of specified images within a repository. Images are specified with either an
imageTag
orimageDigest
.You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
You can completely delete an image (and all of its tags) by specifying the image's digest in your request.
- Parameters:
batchDeleteImageRequest
- Deletes specified images within a specified repository. Images are specified with either theimageTag
orimageDigest
.- Returns:
- Result of the BatchDeleteImage operation returned by the service.
- See Also:
-
batchDeleteImage
default BatchDeleteImageResponse batchDeleteImage(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException Deletes a list of specified images within a repository. Images are specified with either an
imageTag
orimageDigest
.You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
You can completely delete an image (and all of its tags) by specifying the image's digest in your request.
This is a convenience which creates an instance of the
BatchDeleteImageRequest.Builder
avoiding the need to create one manually viaBatchDeleteImageRequest.builder()
- Parameters:
batchDeleteImageRequest
- AConsumer
that will call methods onBatchDeleteImageRequest.Builder
to create a request. Deletes specified images within a specified repository. Images are specified with either theimageTag
orimageDigest
.- Returns:
- Result of the BatchDeleteImage operation returned by the service.
- See Also:
-
batchGetImage
default BatchGetImageResponse batchGetImage(BatchGetImageRequest batchGetImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LimitExceededException, UnableToGetUpstreamImageException, AwsServiceException, SdkClientException, EcrException Gets detailed information for an image. Images are specified with either an
imageTag
orimageDigest
.When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.
- Parameters:
batchGetImageRequest
-- Returns:
- Result of the BatchGetImage operation returned by the service.
- See Also:
-
batchGetImage
default BatchGetImageResponse batchGetImage(Consumer<BatchGetImageRequest.Builder> batchGetImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LimitExceededException, UnableToGetUpstreamImageException, AwsServiceException, SdkClientException, EcrException Gets detailed information for an image. Images are specified with either an
imageTag
orimageDigest
.When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.
This is a convenience which creates an instance of the
BatchGetImageRequest.Builder
avoiding the need to create one manually viaBatchGetImageRequest.builder()
- Parameters:
batchGetImageRequest
- AConsumer
that will call methods onBatchGetImageRequest.Builder
to create a request.- Returns:
- Result of the BatchGetImage operation returned by the service.
- See Also:
-
batchGetRepositoryScanningConfiguration
default BatchGetRepositoryScanningConfigurationResponse batchGetRepositoryScanningConfiguration(BatchGetRepositoryScanningConfigurationRequest batchGetRepositoryScanningConfigurationRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Gets the scanning configuration for one or more repositories.
- Parameters:
batchGetRepositoryScanningConfigurationRequest
-- Returns:
- Result of the BatchGetRepositoryScanningConfiguration operation returned by the service.
- See Also:
-
batchGetRepositoryScanningConfiguration
default BatchGetRepositoryScanningConfigurationResponse batchGetRepositoryScanningConfiguration(Consumer<BatchGetRepositoryScanningConfigurationRequest.Builder> batchGetRepositoryScanningConfigurationRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Gets the scanning configuration for one or more repositories.
This is a convenience which creates an instance of the
BatchGetRepositoryScanningConfigurationRequest.Builder
avoiding the need to create one manually viaBatchGetRepositoryScanningConfigurationRequest.builder()
- Parameters:
batchGetRepositoryScanningConfigurationRequest
- AConsumer
that will call methods onBatchGetRepositoryScanningConfigurationRequest.Builder
to create a request.- Returns:
- Result of the BatchGetRepositoryScanningConfiguration operation returned by the service.
- See Also:
-
completeLayerUpload
default CompleteLayerUploadResponse completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UploadNotFoundException, InvalidLayerException, LayerPartTooSmallException, LayerAlreadyExistsException, EmptyUploadException, KmsException, AwsServiceException, SdkClientException, EcrException Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a
sha256
digest of the image layer for data validation purposes.When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
docker
CLI to pull, tag, and push images.- Parameters:
completeLayerUploadRequest
-- Returns:
- Result of the CompleteLayerUpload operation returned by the service.
- See Also:
-
completeLayerUpload
default CompleteLayerUploadResponse completeLayerUpload(Consumer<CompleteLayerUploadRequest.Builder> completeLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UploadNotFoundException, InvalidLayerException, LayerPartTooSmallException, LayerAlreadyExistsException, EmptyUploadException, KmsException, AwsServiceException, SdkClientException, EcrException Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a
sha256
digest of the image layer for data validation purposes.When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
docker
CLI to pull, tag, and push images.
This is a convenience which creates an instance of the
CompleteLayerUploadRequest.Builder
avoiding the need to create one manually viaCompleteLayerUploadRequest.builder()
- Parameters:
completeLayerUploadRequest
- AConsumer
that will call methods onCompleteLayerUploadRequest.Builder
to create a request.- Returns:
- Result of the CompleteLayerUpload operation returned by the service.
- See Also:
-
createPullThroughCacheRule
default CreatePullThroughCacheRuleResponse createPullThroughCacheRule(CreatePullThroughCacheRuleRequest createPullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleAlreadyExistsException, UnsupportedUpstreamRegistryException, LimitExceededException, UnableToAccessSecretException, SecretNotFoundException, UnableToDecryptSecretValueException, AwsServiceException, SdkClientException, EcrException Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry source in your Amazon ECR private registry. For more information, see Using pull through cache rules in the Amazon Elastic Container Registry User Guide.
- Parameters:
createPullThroughCacheRuleRequest
-- Returns:
- Result of the CreatePullThroughCacheRule operation returned by the service.
- See Also:
-
createPullThroughCacheRule
default CreatePullThroughCacheRuleResponse createPullThroughCacheRule(Consumer<CreatePullThroughCacheRuleRequest.Builder> createPullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleAlreadyExistsException, UnsupportedUpstreamRegistryException, LimitExceededException, UnableToAccessSecretException, SecretNotFoundException, UnableToDecryptSecretValueException, AwsServiceException, SdkClientException, EcrException Creates a pull through cache rule. A pull through cache rule provides a way to cache images from an upstream registry source in your Amazon ECR private registry. For more information, see Using pull through cache rules in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
CreatePullThroughCacheRuleRequest.Builder
avoiding the need to create one manually viaCreatePullThroughCacheRuleRequest.builder()
- Parameters:
createPullThroughCacheRuleRequest
- AConsumer
that will call methods onCreatePullThroughCacheRuleRequest.Builder
to create a request.- Returns:
- Result of the CreatePullThroughCacheRule operation returned by the service.
- See Also:
-
createRepository
default CreateRepositoryResponse createRepository(CreateRepositoryRequest createRepositoryRequest) throws ServerException, InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryAlreadyExistsException, LimitExceededException, KmsException, AwsServiceException, SdkClientException, EcrException Creates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
- Parameters:
createRepositoryRequest
-- Returns:
- Result of the CreateRepository operation returned by the service.
- See Also:
-
createRepository
default CreateRepositoryResponse createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) throws ServerException, InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryAlreadyExistsException, LimitExceededException, KmsException, AwsServiceException, SdkClientException, EcrException Creates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
CreateRepositoryRequest.Builder
avoiding the need to create one manually viaCreateRepositoryRequest.builder()
- Parameters:
createRepositoryRequest
- AConsumer
that will call methods onCreateRepositoryRequest.Builder
to create a request.- Returns:
- Result of the CreateRepository operation returned by the service.
- See Also:
-
createRepositoryCreationTemplate
default CreateRepositoryCreationTemplateResponse createRepositoryCreationTemplate(CreateRepositoryCreationTemplateRequest createRepositoryCreationTemplateRequest) throws ServerException, ValidationException, InvalidParameterException, LimitExceededException, TemplateAlreadyExistsException, AwsServiceException, SdkClientException, EcrException Creates a repository creation template. This template is used to define the settings for repositories created by Amazon ECR on your behalf. For example, repositories created through pull through cache actions. For more information, see Private repository creation templates in the Amazon Elastic Container Registry User Guide.
- Parameters:
createRepositoryCreationTemplateRequest
-- Returns:
- Result of the CreateRepositoryCreationTemplate operation returned by the service.
- See Also:
-
createRepositoryCreationTemplate
default CreateRepositoryCreationTemplateResponse createRepositoryCreationTemplate(Consumer<CreateRepositoryCreationTemplateRequest.Builder> createRepositoryCreationTemplateRequest) throws ServerException, ValidationException, InvalidParameterException, LimitExceededException, TemplateAlreadyExistsException, AwsServiceException, SdkClientException, EcrException Creates a repository creation template. This template is used to define the settings for repositories created by Amazon ECR on your behalf. For example, repositories created through pull through cache actions. For more information, see Private repository creation templates in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
CreateRepositoryCreationTemplateRequest.Builder
avoiding the need to create one manually viaCreateRepositoryCreationTemplateRequest.builder()
- Parameters:
createRepositoryCreationTemplateRequest
- AConsumer
that will call methods onCreateRepositoryCreationTemplateRequest.Builder
to create a request.- Returns:
- Result of the CreateRepositoryCreationTemplate operation returned by the service.
- See Also:
-
deleteLifecyclePolicy
default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Deletes the lifecycle policy associated with the specified repository.
- Parameters:
deleteLifecyclePolicyRequest
-- Returns:
- Result of the DeleteLifecyclePolicy operation returned by the service.
- See Also:
-
deleteLifecyclePolicy
default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Deletes the lifecycle policy associated with the specified repository.
This is a convenience which creates an instance of the
DeleteLifecyclePolicyRequest.Builder
avoiding the need to create one manually viaDeleteLifecyclePolicyRequest.builder()
- Parameters:
deleteLifecyclePolicyRequest
- AConsumer
that will call methods onDeleteLifecyclePolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteLifecyclePolicy operation returned by the service.
- See Also:
-
deletePullThroughCacheRule
default DeletePullThroughCacheRuleResponse deletePullThroughCacheRule(DeletePullThroughCacheRuleRequest deletePullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException Deletes a pull through cache rule.
- Parameters:
deletePullThroughCacheRuleRequest
-- Returns:
- Result of the DeletePullThroughCacheRule operation returned by the service.
- See Also:
-
deletePullThroughCacheRule
default DeletePullThroughCacheRuleResponse deletePullThroughCacheRule(Consumer<DeletePullThroughCacheRuleRequest.Builder> deletePullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException Deletes a pull through cache rule.
This is a convenience which creates an instance of the
DeletePullThroughCacheRuleRequest.Builder
avoiding the need to create one manually viaDeletePullThroughCacheRuleRequest.builder()
- Parameters:
deletePullThroughCacheRuleRequest
- AConsumer
that will call methods onDeletePullThroughCacheRuleRequest.Builder
to create a request.- Returns:
- Result of the DeletePullThroughCacheRule operation returned by the service.
- See Also:
-
deleteRegistryPolicy
default DeleteRegistryPolicyResponse deleteRegistryPolicy(DeleteRegistryPolicyRequest deleteRegistryPolicyRequest) throws ServerException, InvalidParameterException, RegistryPolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Deletes the registry permissions policy.
- Parameters:
deleteRegistryPolicyRequest
-- Returns:
- Result of the DeleteRegistryPolicy operation returned by the service.
- See Also:
-
deleteRegistryPolicy
default DeleteRegistryPolicyResponse deleteRegistryPolicy(Consumer<DeleteRegistryPolicyRequest.Builder> deleteRegistryPolicyRequest) throws ServerException, InvalidParameterException, RegistryPolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Deletes the registry permissions policy.
This is a convenience which creates an instance of the
DeleteRegistryPolicyRequest.Builder
avoiding the need to create one manually viaDeleteRegistryPolicyRequest.builder()
- Parameters:
deleteRegistryPolicyRequest
- AConsumer
that will call methods onDeleteRegistryPolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteRegistryPolicy operation returned by the service.
- See Also:
-
deleteRepository
default DeleteRepositoryResponse deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryNotEmptyException, KmsException, AwsServiceException, SdkClientException, EcrException Deletes a repository. If the repository isn't empty, you must either delete the contents of the repository or use the
force
option to delete the repository and have Amazon ECR delete all of its contents on your behalf.- Parameters:
deleteRepositoryRequest
-- Returns:
- Result of the DeleteRepository operation returned by the service.
- See Also:
-
deleteRepository
default DeleteRepositoryResponse deleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryNotEmptyException, KmsException, AwsServiceException, SdkClientException, EcrException Deletes a repository. If the repository isn't empty, you must either delete the contents of the repository or use the
force
option to delete the repository and have Amazon ECR delete all of its contents on your behalf.
This is a convenience which creates an instance of the
DeleteRepositoryRequest.Builder
avoiding the need to create one manually viaDeleteRepositoryRequest.builder()
- Parameters:
deleteRepositoryRequest
- AConsumer
that will call methods onDeleteRepositoryRequest.Builder
to create a request.- Returns:
- Result of the DeleteRepository operation returned by the service.
- See Also:
-
deleteRepositoryCreationTemplate
default DeleteRepositoryCreationTemplateResponse deleteRepositoryCreationTemplate(DeleteRepositoryCreationTemplateRequest deleteRepositoryCreationTemplateRequest) throws ServerException, ValidationException, InvalidParameterException, TemplateNotFoundException, AwsServiceException, SdkClientException, EcrException Deletes a repository creation template.
- Parameters:
deleteRepositoryCreationTemplateRequest
-- Returns:
- Result of the DeleteRepositoryCreationTemplate operation returned by the service.
- See Also:
-
deleteRepositoryCreationTemplate
default DeleteRepositoryCreationTemplateResponse deleteRepositoryCreationTemplate(Consumer<DeleteRepositoryCreationTemplateRequest.Builder> deleteRepositoryCreationTemplateRequest) throws ServerException, ValidationException, InvalidParameterException, TemplateNotFoundException, AwsServiceException, SdkClientException, EcrException Deletes a repository creation template.
This is a convenience which creates an instance of the
DeleteRepositoryCreationTemplateRequest.Builder
avoiding the need to create one manually viaDeleteRepositoryCreationTemplateRequest.builder()
- Parameters:
deleteRepositoryCreationTemplateRequest
- AConsumer
that will call methods onDeleteRepositoryCreationTemplateRequest.Builder
to create a request.- Returns:
- Result of the DeleteRepositoryCreationTemplate operation returned by the service.
- See Also:
-
deleteRepositoryPolicy
default DeleteRepositoryPolicyResponse deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException Deletes the repository policy associated with the specified repository.
- Parameters:
deleteRepositoryPolicyRequest
-- Returns:
- Result of the DeleteRepositoryPolicy operation returned by the service.
- See Also:
-
deleteRepositoryPolicy
default DeleteRepositoryPolicyResponse deleteRepositoryPolicy(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException Deletes the repository policy associated with the specified repository.
This is a convenience which creates an instance of the
DeleteRepositoryPolicyRequest.Builder
avoiding the need to create one manually viaDeleteRepositoryPolicyRequest.builder()
- Parameters:
deleteRepositoryPolicyRequest
- AConsumer
that will call methods onDeleteRepositoryPolicyRequest.Builder
to create a request.- Returns:
- Result of the DeleteRepositoryPolicy operation returned by the service.
- See Also:
-
describeImageReplicationStatus
default DescribeImageReplicationStatusResponse describeImageReplicationStatus(DescribeImageReplicationStatusRequest describeImageReplicationStatusRequest) throws ServerException, InvalidParameterException, ImageNotFoundException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Returns the replication status for a specified image.
- Parameters:
describeImageReplicationStatusRequest
-- Returns:
- Result of the DescribeImageReplicationStatus operation returned by the service.
- See Also:
-
describeImageReplicationStatus
default DescribeImageReplicationStatusResponse describeImageReplicationStatus(Consumer<DescribeImageReplicationStatusRequest.Builder> describeImageReplicationStatusRequest) throws ServerException, InvalidParameterException, ImageNotFoundException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Returns the replication status for a specified image.
This is a convenience which creates an instance of the
DescribeImageReplicationStatusRequest.Builder
avoiding the need to create one manually viaDescribeImageReplicationStatusRequest.builder()
- Parameters:
describeImageReplicationStatusRequest
- AConsumer
that will call methods onDescribeImageReplicationStatusRequest.Builder
to create a request.- Returns:
- Result of the DescribeImageReplicationStatus operation returned by the service.
- See Also:
-
describeImageScanFindings
default DescribeImageScanFindingsResponse describeImageScanFindings(DescribeImageScanFindingsRequest describeImageScanFindingsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, ScanNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Returns the scan findings for the specified image.
- Parameters:
describeImageScanFindingsRequest
-- Returns:
- Result of the DescribeImageScanFindings operation returned by the service.
- See Also:
-
describeImageScanFindings
default DescribeImageScanFindingsResponse describeImageScanFindings(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, ScanNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Returns the scan findings for the specified image.
This is a convenience which creates an instance of the
DescribeImageScanFindingsRequest.Builder
avoiding the need to create one manually viaDescribeImageScanFindingsRequest.builder()
- Parameters:
describeImageScanFindingsRequest
- AConsumer
that will call methods onDescribeImageScanFindingsRequest.Builder
to create a request.- Returns:
- Result of the DescribeImageScanFindings operation returned by the service.
- See Also:
-
describeImageScanFindingsPaginator
default DescribeImageScanFindingsIterable describeImageScanFindingsPaginator(DescribeImageScanFindingsRequest describeImageScanFindingsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, ScanNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException This is a variant of
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client.describeImageScanFindingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client .describeImageScanFindingsPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client.describeImageScanFindingsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation.- Parameters:
describeImageScanFindingsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeImageScanFindingsPaginator
default DescribeImageScanFindingsIterable describeImageScanFindingsPaginator(Consumer<DescribeImageScanFindingsRequest.Builder> describeImageScanFindingsRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, ScanNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException This is a variant of
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client.describeImageScanFindingsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client .describeImageScanFindingsPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeImageScanFindingsIterable responses = client.describeImageScanFindingsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImageScanFindings(software.amazon.awssdk.services.ecr.model.DescribeImageScanFindingsRequest)
operation.
This is a convenience which creates an instance of the
DescribeImageScanFindingsRequest.Builder
avoiding the need to create one manually viaDescribeImageScanFindingsRequest.builder()
- Parameters:
describeImageScanFindingsRequest
- AConsumer
that will call methods onDescribeImageScanFindingsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeImages
default DescribeImagesResponse describeImages(DescribeImagesRequest describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException Returns metadata about the images in a repository.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the
docker images
command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.- Parameters:
describeImagesRequest
-- Returns:
- Result of the DescribeImages operation returned by the service.
- See Also:
-
describeImages
default DescribeImagesResponse describeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException Returns metadata about the images in a repository.
Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the
docker images
command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.
This is a convenience which creates an instance of the
DescribeImagesRequest.Builder
avoiding the need to create one manually viaDescribeImagesRequest.builder()
- Parameters:
describeImagesRequest
- AConsumer
that will call methods onDescribeImagesRequest.Builder
to create a request.- Returns:
- Result of the DescribeImages operation returned by the service.
- See Also:
-
describeImagesPaginator
default DescribeImagesIterable describeImagesPaginator(DescribeImagesRequest describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException This is a variant of
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeImagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation.- Parameters:
describeImagesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeImagesPaginator
default DescribeImagesIterable describeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException This is a variant of
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeImagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation.
This is a convenience which creates an instance of the
DescribeImagesRequest.Builder
avoiding the need to create one manually viaDescribeImagesRequest.builder()
- Parameters:
describeImagesRequest
- AConsumer
that will call methods onDescribeImagesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePullThroughCacheRules
default DescribePullThroughCacheRulesResponse describePullThroughCacheRules(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException Returns the pull through cache rules for a registry.
- Parameters:
describePullThroughCacheRulesRequest
-- Returns:
- Result of the DescribePullThroughCacheRules operation returned by the service.
- See Also:
-
describePullThroughCacheRules
default DescribePullThroughCacheRulesResponse describePullThroughCacheRules(Consumer<DescribePullThroughCacheRulesRequest.Builder> describePullThroughCacheRulesRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException Returns the pull through cache rules for a registry.
This is a convenience which creates an instance of the
DescribePullThroughCacheRulesRequest.Builder
avoiding the need to create one manually viaDescribePullThroughCacheRulesRequest.builder()
- Parameters:
describePullThroughCacheRulesRequest
- AConsumer
that will call methods onDescribePullThroughCacheRulesRequest.Builder
to create a request.- Returns:
- Result of the DescribePullThroughCacheRules operation returned by the service.
- See Also:
-
describePullThroughCacheRulesPaginator
default DescribePullThroughCacheRulesIterable describePullThroughCacheRulesPaginator(DescribePullThroughCacheRulesRequest describePullThroughCacheRulesRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException This is a variant of
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client.describePullThroughCacheRulesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client .describePullThroughCacheRulesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client.describePullThroughCacheRulesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation.- Parameters:
describePullThroughCacheRulesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePullThroughCacheRulesPaginator
default DescribePullThroughCacheRulesIterable describePullThroughCacheRulesPaginator(Consumer<DescribePullThroughCacheRulesRequest.Builder> describePullThroughCacheRulesRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException This is a variant of
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client.describePullThroughCacheRulesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client .describePullThroughCacheRulesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribePullThroughCacheRulesIterable responses = client.describePullThroughCacheRulesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePullThroughCacheRules(software.amazon.awssdk.services.ecr.model.DescribePullThroughCacheRulesRequest)
operation.
This is a convenience which creates an instance of the
DescribePullThroughCacheRulesRequest.Builder
avoiding the need to create one manually viaDescribePullThroughCacheRulesRequest.builder()
- Parameters:
describePullThroughCacheRulesRequest
- AConsumer
that will call methods onDescribePullThroughCacheRulesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeRegistry
default DescribeRegistryResponse describeRegistry(DescribeRegistryRequest describeRegistryRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
- Parameters:
describeRegistryRequest
-- Returns:
- Result of the DescribeRegistry operation returned by the service.
- See Also:
-
describeRegistry
default DescribeRegistryResponse describeRegistry(Consumer<DescribeRegistryRequest.Builder> describeRegistryRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
This is a convenience which creates an instance of the
DescribeRegistryRequest.Builder
avoiding the need to create one manually viaDescribeRegistryRequest.builder()
- Parameters:
describeRegistryRequest
- AConsumer
that will call methods onDescribeRegistryRequest.Builder
to create a request.- Returns:
- Result of the DescribeRegistry operation returned by the service.
- See Also:
-
describeRepositories
default DescribeRepositoriesResponse describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException Describes image repositories in a registry.
- Parameters:
describeRepositoriesRequest
-- Returns:
- Result of the DescribeRepositories operation returned by the service.
- See Also:
-
describeRepositories
default DescribeRepositoriesResponse describeRepositories(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException Describes image repositories in a registry.
This is a convenience which creates an instance of the
DescribeRepositoriesRequest.Builder
avoiding the need to create one manually viaDescribeRepositoriesRequest.builder()
- Parameters:
describeRepositoriesRequest
- AConsumer
that will call methods onDescribeRepositoriesRequest.Builder
to create a request.- Returns:
- Result of the DescribeRepositories operation returned by the service.
- See Also:
-
describeRepositories
default DescribeRepositoriesResponse describeRepositories() throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrExceptionDescribes image repositories in a registry.
- Returns:
- Result of the DescribeRepositories operation returned by the service.
- See Also:
-
describeRepositoriesPaginator
default DescribeRepositoriesIterable describeRepositoriesPaginator() throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrExceptionThis is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client .describeRepositoriesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeRepositoriesPaginator
default DescribeRepositoriesIterable describeRepositoriesPaginator(DescribeRepositoriesRequest describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client .describeRepositoriesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.- Parameters:
describeRepositoriesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeRepositoriesPaginator
default DescribeRepositoriesIterable describeRepositoriesPaginator(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client .describeRepositoriesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.
This is a convenience which creates an instance of the
DescribeRepositoriesRequest.Builder
avoiding the need to create one manually viaDescribeRepositoriesRequest.builder()
- Parameters:
describeRepositoriesRequest
- AConsumer
that will call methods onDescribeRepositoriesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeRepositoryCreationTemplates
default DescribeRepositoryCreationTemplatesResponse describeRepositoryCreationTemplates(DescribeRepositoryCreationTemplatesRequest describeRepositoryCreationTemplatesRequest) throws ServerException, ValidationException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException Returns details about the repository creation templates in a registry. The
prefixes
request parameter can be used to return the details for a specific repository creation template.- Parameters:
describeRepositoryCreationTemplatesRequest
-- Returns:
- Result of the DescribeRepositoryCreationTemplates operation returned by the service.
- See Also:
-
describeRepositoryCreationTemplates
default DescribeRepositoryCreationTemplatesResponse describeRepositoryCreationTemplates(Consumer<DescribeRepositoryCreationTemplatesRequest.Builder> describeRepositoryCreationTemplatesRequest) throws ServerException, ValidationException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException Returns details about the repository creation templates in a registry. The
prefixes
request parameter can be used to return the details for a specific repository creation template.
This is a convenience which creates an instance of the
DescribeRepositoryCreationTemplatesRequest.Builder
avoiding the need to create one manually viaDescribeRepositoryCreationTemplatesRequest.builder()
- Parameters:
describeRepositoryCreationTemplatesRequest
- AConsumer
that will call methods onDescribeRepositoryCreationTemplatesRequest.Builder
to create a request.- Returns:
- Result of the DescribeRepositoryCreationTemplates operation returned by the service.
- See Also:
-
describeRepositoryCreationTemplatesPaginator
default DescribeRepositoryCreationTemplatesIterable describeRepositoryCreationTemplatesPaginator(DescribeRepositoryCreationTemplatesRequest describeRepositoryCreationTemplatesRequest) throws ServerException, ValidationException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException This is a variant of
describeRepositoryCreationTemplates(software.amazon.awssdk.services.ecr.model.DescribeRepositoryCreationTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoryCreationTemplatesIterable responses = client.describeRepositoryCreationTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecr.paginators.DescribeRepositoryCreationTemplatesIterable responses = client .describeRepositoryCreationTemplatesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeRepositoryCreationTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoryCreationTemplatesIterable responses = client.describeRepositoryCreationTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositoryCreationTemplates(software.amazon.awssdk.services.ecr.model.DescribeRepositoryCreationTemplatesRequest)
operation.- Parameters:
describeRepositoryCreationTemplatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeRepositoryCreationTemplatesPaginator
default DescribeRepositoryCreationTemplatesIterable describeRepositoryCreationTemplatesPaginator(Consumer<DescribeRepositoryCreationTemplatesRequest.Builder> describeRepositoryCreationTemplatesRequest) throws ServerException, ValidationException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException This is a variant of
describeRepositoryCreationTemplates(software.amazon.awssdk.services.ecr.model.DescribeRepositoryCreationTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoryCreationTemplatesIterable responses = client.describeRepositoryCreationTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecr.paginators.DescribeRepositoryCreationTemplatesIterable responses = client .describeRepositoryCreationTemplatesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeRepositoryCreationTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.DescribeRepositoryCreationTemplatesIterable responses = client.describeRepositoryCreationTemplatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRepositoryCreationTemplates(software.amazon.awssdk.services.ecr.model.DescribeRepositoryCreationTemplatesRequest)
operation.
This is a convenience which creates an instance of the
DescribeRepositoryCreationTemplatesRequest.Builder
avoiding the need to create one manually viaDescribeRepositoryCreationTemplatesRequest.builder()
- Parameters:
describeRepositoryCreationTemplatesRequest
- AConsumer
that will call methods onDescribeRepositoryCreationTemplatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getAccountSetting
default GetAccountSettingResponse getAccountSetting(GetAccountSettingRequest getAccountSettingRequest) throws ServerException, ValidationException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException Retrieves the basic scan type version name.
- Parameters:
getAccountSettingRequest
-- Returns:
- Result of the GetAccountSetting operation returned by the service.
- See Also:
-
getAccountSetting
default GetAccountSettingResponse getAccountSetting(Consumer<GetAccountSettingRequest.Builder> getAccountSettingRequest) throws ServerException, ValidationException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException Retrieves the basic scan type version name.
This is a convenience which creates an instance of the
GetAccountSettingRequest.Builder
avoiding the need to create one manually viaGetAccountSettingRequest.builder()
- Parameters:
getAccountSettingRequest
- AConsumer
that will call methods onGetAccountSettingRequest.Builder
to create a request.- Returns:
- Result of the GetAccountSetting operation returned by the service.
- See Also:
-
getAuthorizationToken
default GetAuthorizationTokenResponse getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest) throws ServerException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.
The
authorizationToken
returned is a base64 encoded string that can be decoded and used in adocker login
command to authenticate to a registry. The CLI offers anget-login-password
command that simplifies the login process. For more information, see Registry authentication in the Amazon Elastic Container Registry User Guide.- Parameters:
getAuthorizationTokenRequest
-- Returns:
- Result of the GetAuthorizationToken operation returned by the service.
- See Also:
-
getAuthorizationToken
default GetAuthorizationTokenResponse getAuthorizationToken(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest) throws ServerException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.
The
authorizationToken
returned is a base64 encoded string that can be decoded and used in adocker login
command to authenticate to a registry. The CLI offers anget-login-password
command that simplifies the login process. For more information, see Registry authentication in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
GetAuthorizationTokenRequest.Builder
avoiding the need to create one manually viaGetAuthorizationTokenRequest.builder()
- Parameters:
getAuthorizationTokenRequest
- AConsumer
that will call methods onGetAuthorizationTokenRequest.Builder
to create a request.- Returns:
- Result of the GetAuthorizationToken operation returned by the service.
- See Also:
-
getAuthorizationToken
default GetAuthorizationTokenResponse getAuthorizationToken() throws ServerException, InvalidParameterException, AwsServiceException, SdkClientException, EcrExceptionRetrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.
The
authorizationToken
returned is a base64 encoded string that can be decoded and used in adocker login
command to authenticate to a registry. The CLI offers anget-login-password
command that simplifies the login process. For more information, see Registry authentication in the Amazon Elastic Container Registry User Guide.- Returns:
- Result of the GetAuthorizationToken operation returned by the service.
- See Also:
-
getDownloadUrlForLayer
default GetDownloadUrlForLayerResponse getDownloadUrlForLayer(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest) throws ServerException, InvalidParameterException, LayersNotFoundException, LayerInaccessibleException, RepositoryNotFoundException, UnableToGetUpstreamLayerException, AwsServiceException, SdkClientException, EcrException Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.
When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
docker
CLI to pull, tag, and push images.- Parameters:
getDownloadUrlForLayerRequest
-- Returns:
- Result of the GetDownloadUrlForLayer operation returned by the service.
- See Also:
-
getDownloadUrlForLayer
default GetDownloadUrlForLayerResponse getDownloadUrlForLayer(Consumer<GetDownloadUrlForLayerRequest.Builder> getDownloadUrlForLayerRequest) throws ServerException, InvalidParameterException, LayersNotFoundException, LayerInaccessibleException, RepositoryNotFoundException, UnableToGetUpstreamLayerException, AwsServiceException, SdkClientException, EcrException Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.
When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
docker
CLI to pull, tag, and push images.
This is a convenience which creates an instance of the
GetDownloadUrlForLayerRequest.Builder
avoiding the need to create one manually viaGetDownloadUrlForLayerRequest.builder()
- Parameters:
getDownloadUrlForLayerRequest
- AConsumer
that will call methods onGetDownloadUrlForLayerRequest.Builder
to create a request.- Returns:
- Result of the GetDownloadUrlForLayer operation returned by the service.
- See Also:
-
getLifecyclePolicy
default GetLifecyclePolicyResponse getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Retrieves the lifecycle policy for the specified repository.
- Parameters:
getLifecyclePolicyRequest
-- Returns:
- Result of the GetLifecyclePolicy operation returned by the service.
- See Also:
-
getLifecyclePolicy
default GetLifecyclePolicyResponse getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Retrieves the lifecycle policy for the specified repository.
This is a convenience which creates an instance of the
GetLifecyclePolicyRequest.Builder
avoiding the need to create one manually viaGetLifecyclePolicyRequest.builder()
- Parameters:
getLifecyclePolicyRequest
- AConsumer
that will call methods onGetLifecyclePolicyRequest.Builder
to create a request.- Returns:
- Result of the GetLifecyclePolicy operation returned by the service.
- See Also:
-
getLifecyclePolicyPreview
default GetLifecyclePolicyPreviewResponse getLifecyclePolicyPreview(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyPreviewNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Retrieves the results of the lifecycle policy preview request for the specified repository.
- Parameters:
getLifecyclePolicyPreviewRequest
-- Returns:
- Result of the GetLifecyclePolicyPreview operation returned by the service.
- See Also:
-
getLifecyclePolicyPreview
default GetLifecyclePolicyPreviewResponse getLifecyclePolicyPreview(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyPreviewNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Retrieves the results of the lifecycle policy preview request for the specified repository.
This is a convenience which creates an instance of the
GetLifecyclePolicyPreviewRequest.Builder
avoiding the need to create one manually viaGetLifecyclePolicyPreviewRequest.builder()
- Parameters:
getLifecyclePolicyPreviewRequest
- AConsumer
that will call methods onGetLifecyclePolicyPreviewRequest.Builder
to create a request.- Returns:
- Result of the GetLifecyclePolicyPreview operation returned by the service.
- See Also:
-
getLifecyclePolicyPreviewPaginator
default GetLifecyclePolicyPreviewIterable getLifecyclePolicyPreviewPaginator(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyPreviewNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException This is a variant of
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client.getLifecyclePolicyPreviewPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client .getLifecyclePolicyPreviewPaginator(request); for (software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client.getLifecyclePolicyPreviewPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation.- Parameters:
getLifecyclePolicyPreviewRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getLifecyclePolicyPreviewPaginator
default GetLifecyclePolicyPreviewIterable getLifecyclePolicyPreviewPaginator(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyPreviewNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException This is a variant of
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client.getLifecyclePolicyPreviewPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client .getLifecyclePolicyPreviewPaginator(request); for (software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.GetLifecyclePolicyPreviewIterable responses = client.getLifecyclePolicyPreviewPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getLifecyclePolicyPreview(software.amazon.awssdk.services.ecr.model.GetLifecyclePolicyPreviewRequest)
operation.
This is a convenience which creates an instance of the
GetLifecyclePolicyPreviewRequest.Builder
avoiding the need to create one manually viaGetLifecyclePolicyPreviewRequest.builder()
- Parameters:
getLifecyclePolicyPreviewRequest
- AConsumer
that will call methods onGetLifecyclePolicyPreviewRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getRegistryPolicy
default GetRegistryPolicyResponse getRegistryPolicy(GetRegistryPolicyRequest getRegistryPolicyRequest) throws ServerException, InvalidParameterException, RegistryPolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Retrieves the permissions policy for a registry.
- Parameters:
getRegistryPolicyRequest
-- Returns:
- Result of the GetRegistryPolicy operation returned by the service.
- See Also:
-
getRegistryPolicy
default GetRegistryPolicyResponse getRegistryPolicy(Consumer<GetRegistryPolicyRequest.Builder> getRegistryPolicyRequest) throws ServerException, InvalidParameterException, RegistryPolicyNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Retrieves the permissions policy for a registry.
This is a convenience which creates an instance of the
GetRegistryPolicyRequest.Builder
avoiding the need to create one manually viaGetRegistryPolicyRequest.builder()
- Parameters:
getRegistryPolicyRequest
- AConsumer
that will call methods onGetRegistryPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetRegistryPolicy operation returned by the service.
- See Also:
-
getRegistryScanningConfiguration
default GetRegistryScanningConfigurationResponse getRegistryScanningConfiguration(GetRegistryScanningConfigurationRequest getRegistryScanningConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException Retrieves the scanning configuration for a registry.
- Parameters:
getRegistryScanningConfigurationRequest
-- Returns:
- Result of the GetRegistryScanningConfiguration operation returned by the service.
- See Also:
-
getRegistryScanningConfiguration
default GetRegistryScanningConfigurationResponse getRegistryScanningConfiguration(Consumer<GetRegistryScanningConfigurationRequest.Builder> getRegistryScanningConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException Retrieves the scanning configuration for a registry.
This is a convenience which creates an instance of the
GetRegistryScanningConfigurationRequest.Builder
avoiding the need to create one manually viaGetRegistryScanningConfigurationRequest.builder()
- Parameters:
getRegistryScanningConfigurationRequest
- AConsumer
that will call methods onGetRegistryScanningConfigurationRequest.Builder
to create a request.- Returns:
- Result of the GetRegistryScanningConfiguration operation returned by the service.
- See Also:
-
getRepositoryPolicy
default GetRepositoryPolicyResponse getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException Retrieves the repository policy for the specified repository.
- Parameters:
getRepositoryPolicyRequest
-- Returns:
- Result of the GetRepositoryPolicy operation returned by the service.
- See Also:
-
getRepositoryPolicy
default GetRepositoryPolicyResponse getRepositoryPolicy(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException Retrieves the repository policy for the specified repository.
This is a convenience which creates an instance of the
GetRepositoryPolicyRequest.Builder
avoiding the need to create one manually viaGetRepositoryPolicyRequest.builder()
- Parameters:
getRepositoryPolicyRequest
- AConsumer
that will call methods onGetRepositoryPolicyRequest.Builder
to create a request.- Returns:
- Result of the GetRepositoryPolicy operation returned by the service.
- See Also:
-
initiateLayerUpload
default InitiateLayerUploadResponse initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, KmsException, AwsServiceException, SdkClientException, EcrException Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
docker
CLI to pull, tag, and push images.- Parameters:
initiateLayerUploadRequest
-- Returns:
- Result of the InitiateLayerUpload operation returned by the service.
- See Also:
-
initiateLayerUpload
default InitiateLayerUploadResponse initiateLayerUpload(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, KmsException, AwsServiceException, SdkClientException, EcrException Notifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
docker
CLI to pull, tag, and push images.
This is a convenience which creates an instance of the
InitiateLayerUploadRequest.Builder
avoiding the need to create one manually viaInitiateLayerUploadRequest.builder()
- Parameters:
initiateLayerUploadRequest
- AConsumer
that will call methods onInitiateLayerUploadRequest.Builder
to create a request.- Returns:
- Result of the InitiateLayerUpload operation returned by the service.
- See Also:
-
listImages
default ListImagesResponse listImages(ListImagesRequest listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException Lists all the image IDs for the specified repository.
You can filter images based on whether or not they are tagged by using the
tagStatus
filter and specifying eitherTAGGED
,UNTAGGED
orANY
. For example, you can filter your results to return onlyUNTAGGED
images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return onlyTAGGED
images to list all of the tags in your repository.- Parameters:
listImagesRequest
-- Returns:
- Result of the ListImages operation returned by the service.
- See Also:
-
listImages
default ListImagesResponse listImages(Consumer<ListImagesRequest.Builder> listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException Lists all the image IDs for the specified repository.
You can filter images based on whether or not they are tagged by using the
tagStatus
filter and specifying eitherTAGGED
,UNTAGGED
orANY
. For example, you can filter your results to return onlyUNTAGGED
images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return onlyTAGGED
images to list all of the tags in your repository.
This is a convenience which creates an instance of the
ListImagesRequest.Builder
avoiding the need to create one manually viaListImagesRequest.builder()
- Parameters:
listImagesRequest
- AConsumer
that will call methods onListImagesRequest.Builder
to create a request.- Returns:
- Result of the ListImages operation returned by the service.
- See Also:
-
listImagesPaginator
default ListImagesIterable listImagesPaginator(ListImagesRequest listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException This is a variant of
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request); for (software.amazon.awssdk.services.ecr.model.ListImagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)
operation.- Parameters:
listImagesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listImagesPaginator
default ListImagesIterable listImagesPaginator(Consumer<ListImagesRequest.Builder> listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException This is a variant of
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request); for (software.amazon.awssdk.services.ecr.model.ListImagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)
operation.
This is a convenience which creates an instance of the
ListImagesRequest.Builder
avoiding the need to create one manually viaListImagesRequest.builder()
- Parameters:
listImagesRequest
- AConsumer
that will call methods onListImagesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidParameterException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException List the tags for an Amazon ECR resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidParameterException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException List the tags for an Amazon ECR resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
putAccountSetting
default PutAccountSettingResponse putAccountSetting(PutAccountSettingRequest putAccountSettingRequest) throws ServerException, ValidationException, InvalidParameterException, LimitExceededException, AwsServiceException, SdkClientException, EcrException Allows you to change the basic scan type version by setting the
name
parameter to eitherCLAIR
toAWS_NATIVE
.- Parameters:
putAccountSettingRequest
-- Returns:
- Result of the PutAccountSetting operation returned by the service.
- See Also:
-
putAccountSetting
default PutAccountSettingResponse putAccountSetting(Consumer<PutAccountSettingRequest.Builder> putAccountSettingRequest) throws ServerException, ValidationException, InvalidParameterException, LimitExceededException, AwsServiceException, SdkClientException, EcrException Allows you to change the basic scan type version by setting the
name
parameter to eitherCLAIR
toAWS_NATIVE
.
This is a convenience which creates an instance of the
PutAccountSettingRequest.Builder
avoiding the need to create one manually viaPutAccountSettingRequest.builder()
- Parameters:
putAccountSettingRequest
- AConsumer
that will call methods onPutAccountSettingRequest.Builder
to create a request.- Returns:
- Result of the PutAccountSetting operation returned by the service.
- See Also:
-
putImage
default PutImageResponse putImage(PutImageRequest putImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageAlreadyExistsException, LayersNotFoundException, ReferencedImagesNotFoundException, LimitExceededException, ImageTagAlreadyExistsException, ImageDigestDoesNotMatchException, KmsException, AwsServiceException, SdkClientException, EcrException Creates or updates the image manifest and tags associated with an image.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
docker
CLI to pull, tag, and push images.- Parameters:
putImageRequest
-- Returns:
- Result of the PutImage operation returned by the service.
- See Also:
-
putImage
default PutImageResponse putImage(Consumer<PutImageRequest.Builder> putImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageAlreadyExistsException, LayersNotFoundException, ReferencedImagesNotFoundException, LimitExceededException, ImageTagAlreadyExistsException, ImageDigestDoesNotMatchException, KmsException, AwsServiceException, SdkClientException, EcrException Creates or updates the image manifest and tags associated with an image.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
docker
CLI to pull, tag, and push images.
This is a convenience which creates an instance of the
PutImageRequest.Builder
avoiding the need to create one manually viaPutImageRequest.builder()
- Parameters:
putImageRequest
- AConsumer
that will call methods onPutImageRequest.Builder
to create a request.- Returns:
- Result of the PutImage operation returned by the service.
- See Also:
-
putImageScanningConfiguration
default PutImageScanningConfigurationResponse putImageScanningConfiguration(PutImageScanningConfigurationRequest putImageScanningConfigurationRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException The
PutImageScanningConfiguration
API is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see PutRegistryScanningConfiguration.Updates the image scanning configuration for the specified repository.
- Parameters:
putImageScanningConfigurationRequest
-- Returns:
- Result of the PutImageScanningConfiguration operation returned by the service.
- See Also:
-
putImageScanningConfiguration
default PutImageScanningConfigurationResponse putImageScanningConfiguration(Consumer<PutImageScanningConfigurationRequest.Builder> putImageScanningConfigurationRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException The
PutImageScanningConfiguration
API is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see PutRegistryScanningConfiguration.Updates the image scanning configuration for the specified repository.
This is a convenience which creates an instance of the
PutImageScanningConfigurationRequest.Builder
avoiding the need to create one manually viaPutImageScanningConfigurationRequest.builder()
- Parameters:
putImageScanningConfigurationRequest
- AConsumer
that will call methods onPutImageScanningConfigurationRequest.Builder
to create a request.- Returns:
- Result of the PutImageScanningConfiguration operation returned by the service.
- See Also:
-
putImageTagMutability
default PutImageTagMutabilityResponse putImageTagMutability(PutImageTagMutabilityRequest putImageTagMutabilityRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException Updates the image tag mutability settings for the specified repository. For more information, see Image tag mutability in the Amazon Elastic Container Registry User Guide.
- Parameters:
putImageTagMutabilityRequest
-- Returns:
- Result of the PutImageTagMutability operation returned by the service.
- See Also:
-
putImageTagMutability
default PutImageTagMutabilityResponse putImageTagMutability(Consumer<PutImageTagMutabilityRequest.Builder> putImageTagMutabilityRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException Updates the image tag mutability settings for the specified repository. For more information, see Image tag mutability in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
PutImageTagMutabilityRequest.Builder
avoiding the need to create one manually viaPutImageTagMutabilityRequest.builder()
- Parameters:
putImageTagMutabilityRequest
- AConsumer
that will call methods onPutImageTagMutabilityRequest.Builder
to create a request.- Returns:
- Result of the PutImageTagMutability operation returned by the service.
- See Also:
-
putLifecyclePolicy
default PutLifecyclePolicyResponse putLifecyclePolicy(PutLifecyclePolicyRequest putLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.
- Parameters:
putLifecyclePolicyRequest
-- Returns:
- Result of the PutLifecyclePolicy operation returned by the service.
- See Also:
-
putLifecyclePolicy
default PutLifecyclePolicyResponse putLifecyclePolicy(Consumer<PutLifecyclePolicyRequest.Builder> putLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.
This is a convenience which creates an instance of the
PutLifecyclePolicyRequest.Builder
avoiding the need to create one manually viaPutLifecyclePolicyRequest.builder()
- Parameters:
putLifecyclePolicyRequest
- AConsumer
that will call methods onPutLifecyclePolicyRequest.Builder
to create a request.- Returns:
- Result of the PutLifecyclePolicy operation returned by the service.
- See Also:
-
putRegistryPolicy
default PutRegistryPolicyResponse putRegistryPolicy(PutRegistryPolicyRequest putRegistryPolicyRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException Creates or updates the permissions policy for your registry.
A registry policy is used to specify permissions for another Amazon Web Services account and is used when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.
- Parameters:
putRegistryPolicyRequest
-- Returns:
- Result of the PutRegistryPolicy operation returned by the service.
- See Also:
-
putRegistryPolicy
default PutRegistryPolicyResponse putRegistryPolicy(Consumer<PutRegistryPolicyRequest.Builder> putRegistryPolicyRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException Creates or updates the permissions policy for your registry.
A registry policy is used to specify permissions for another Amazon Web Services account and is used when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
PutRegistryPolicyRequest.Builder
avoiding the need to create one manually viaPutRegistryPolicyRequest.builder()
- Parameters:
putRegistryPolicyRequest
- AConsumer
that will call methods onPutRegistryPolicyRequest.Builder
to create a request.- Returns:
- Result of the PutRegistryPolicy operation returned by the service.
- See Also:
-
putRegistryScanningConfiguration
default PutRegistryScanningConfigurationResponse putRegistryScanningConfiguration(PutRegistryScanningConfigurationRequest putRegistryScanningConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException Creates or updates the scanning configuration for your private registry.
- Parameters:
putRegistryScanningConfigurationRequest
-- Returns:
- Result of the PutRegistryScanningConfiguration operation returned by the service.
- See Also:
-
putRegistryScanningConfiguration
default PutRegistryScanningConfigurationResponse putRegistryScanningConfiguration(Consumer<PutRegistryScanningConfigurationRequest.Builder> putRegistryScanningConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException Creates or updates the scanning configuration for your private registry.
This is a convenience which creates an instance of the
PutRegistryScanningConfigurationRequest.Builder
avoiding the need to create one manually viaPutRegistryScanningConfigurationRequest.builder()
- Parameters:
putRegistryScanningConfigurationRequest
- AConsumer
that will call methods onPutRegistryScanningConfigurationRequest.Builder
to create a request.- Returns:
- Result of the PutRegistryScanningConfiguration operation returned by the service.
- See Also:
-
putReplicationConfiguration
default PutReplicationConfigurationResponse putReplicationConfiguration(PutReplicationConfigurationRequest putReplicationConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see Using service-linked roles for Amazon ECR in the Amazon Elastic Container Registry User Guide. For more information on the custom role for replication, see Creating an IAM role for replication.
When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a registry permissions policy. For more information, see PutRegistryPolicy.
- Parameters:
putReplicationConfigurationRequest
-- Returns:
- Result of the PutReplicationConfiguration operation returned by the service.
- See Also:
-
putReplicationConfiguration
default PutReplicationConfigurationResponse putReplicationConfiguration(Consumer<PutReplicationConfigurationRequest.Builder> putReplicationConfigurationRequest) throws ServerException, InvalidParameterException, ValidationException, AwsServiceException, SdkClientException, EcrException Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see Using service-linked roles for Amazon ECR in the Amazon Elastic Container Registry User Guide. For more information on the custom role for replication, see Creating an IAM role for replication.
When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a registry permissions policy. For more information, see PutRegistryPolicy.
This is a convenience which creates an instance of the
PutReplicationConfigurationRequest.Builder
avoiding the need to create one manually viaPutReplicationConfigurationRequest.builder()
- Parameters:
putReplicationConfigurationRequest
- AConsumer
that will call methods onPutReplicationConfigurationRequest.Builder
to create a request.- Returns:
- Result of the PutReplicationConfiguration operation returned by the service.
- See Also:
-
setRepositoryPolicy
default SetRepositoryPolicyResponse setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException Applies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository policies in the Amazon Elastic Container Registry User Guide.
- Parameters:
setRepositoryPolicyRequest
-- Returns:
- Result of the SetRepositoryPolicy operation returned by the service.
- See Also:
-
setRepositoryPolicy
default SetRepositoryPolicyResponse setRepositoryPolicy(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException Applies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository policies in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
SetRepositoryPolicyRequest.Builder
avoiding the need to create one manually viaSetRepositoryPolicyRequest.builder()
- Parameters:
setRepositoryPolicyRequest
- AConsumer
that will call methods onSetRepositoryPolicyRequest.Builder
to create a request.- Returns:
- Result of the SetRepositoryPolicy operation returned by the service.
- See Also:
-
startImageScan
default StartImageScanResponse startImageScan(StartImageScanRequest startImageScanRequest) throws ServerException, InvalidParameterException, UnsupportedImageTypeException, LimitExceededException, RepositoryNotFoundException, ImageNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Starts an image vulnerability scan. An image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image scanning in the Amazon Elastic Container Registry User Guide.
- Parameters:
startImageScanRequest
-- Returns:
- Result of the StartImageScan operation returned by the service.
- See Also:
-
startImageScan
default StartImageScanResponse startImageScan(Consumer<StartImageScanRequest.Builder> startImageScanRequest) throws ServerException, InvalidParameterException, UnsupportedImageTypeException, LimitExceededException, RepositoryNotFoundException, ImageNotFoundException, ValidationException, AwsServiceException, SdkClientException, EcrException Starts an image vulnerability scan. An image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image scanning in the Amazon Elastic Container Registry User Guide.
This is a convenience which creates an instance of the
StartImageScanRequest.Builder
avoiding the need to create one manually viaStartImageScanRequest.builder()
- Parameters:
startImageScanRequest
- AConsumer
that will call methods onStartImageScanRequest.Builder
to create a request.- Returns:
- Result of the StartImageScan operation returned by the service.
- See Also:
-
startLifecyclePolicyPreview
default StartLifecyclePolicyPreviewResponse startLifecyclePolicyPreview(StartLifecyclePolicyPreviewRequest startLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, LifecyclePolicyPreviewInProgressException, ValidationException, AwsServiceException, SdkClientException, EcrException Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.
- Parameters:
startLifecyclePolicyPreviewRequest
-- Returns:
- Result of the StartLifecyclePolicyPreview operation returned by the service.
- See Also:
-
startLifecyclePolicyPreview
default StartLifecyclePolicyPreviewResponse startLifecyclePolicyPreview(Consumer<StartLifecyclePolicyPreviewRequest.Builder> startLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, LifecyclePolicyPreviewInProgressException, ValidationException, AwsServiceException, SdkClientException, EcrException Starts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.
This is a convenience which creates an instance of the
StartLifecyclePolicyPreviewRequest.Builder
avoiding the need to create one manually viaStartLifecyclePolicyPreviewRequest.builder()
- Parameters:
startLifecyclePolicyPreviewRequest
- AConsumer
that will call methods onStartLifecyclePolicyPreviewRequest.Builder
to create a request.- Returns:
- Result of the StartLifecyclePolicyPreview operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException Deletes specified tags from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidParameterException, InvalidTagParameterException, TooManyTagsException, RepositoryNotFoundException, ServerException, AwsServiceException, SdkClientException, EcrException Deletes specified tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updatePullThroughCacheRule
default UpdatePullThroughCacheRuleResponse updatePullThroughCacheRule(UpdatePullThroughCacheRuleRequest updatePullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, UnableToAccessSecretException, PullThroughCacheRuleNotFoundException, SecretNotFoundException, UnableToDecryptSecretValueException, AwsServiceException, SdkClientException, EcrException Updates an existing pull through cache rule.
- Parameters:
updatePullThroughCacheRuleRequest
-- Returns:
- Result of the UpdatePullThroughCacheRule operation returned by the service.
- See Also:
-
updatePullThroughCacheRule
default UpdatePullThroughCacheRuleResponse updatePullThroughCacheRule(Consumer<UpdatePullThroughCacheRuleRequest.Builder> updatePullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, UnableToAccessSecretException, PullThroughCacheRuleNotFoundException, SecretNotFoundException, UnableToDecryptSecretValueException, AwsServiceException, SdkClientException, EcrException Updates an existing pull through cache rule.
This is a convenience which creates an instance of the
UpdatePullThroughCacheRuleRequest.Builder
avoiding the need to create one manually viaUpdatePullThroughCacheRuleRequest.builder()
- Parameters:
updatePullThroughCacheRuleRequest
- AConsumer
that will call methods onUpdatePullThroughCacheRuleRequest.Builder
to create a request.- Returns:
- Result of the UpdatePullThroughCacheRule operation returned by the service.
- See Also:
-
updateRepositoryCreationTemplate
default UpdateRepositoryCreationTemplateResponse updateRepositoryCreationTemplate(UpdateRepositoryCreationTemplateRequest updateRepositoryCreationTemplateRequest) throws ServerException, ValidationException, InvalidParameterException, TemplateNotFoundException, AwsServiceException, SdkClientException, EcrException Updates an existing repository creation template.
- Parameters:
updateRepositoryCreationTemplateRequest
-- Returns:
- Result of the UpdateRepositoryCreationTemplate operation returned by the service.
- See Also:
-
updateRepositoryCreationTemplate
default UpdateRepositoryCreationTemplateResponse updateRepositoryCreationTemplate(Consumer<UpdateRepositoryCreationTemplateRequest.Builder> updateRepositoryCreationTemplateRequest) throws ServerException, ValidationException, InvalidParameterException, TemplateNotFoundException, AwsServiceException, SdkClientException, EcrException Updates an existing repository creation template.
This is a convenience which creates an instance of the
UpdateRepositoryCreationTemplateRequest.Builder
avoiding the need to create one manually viaUpdateRepositoryCreationTemplateRequest.builder()
- Parameters:
updateRepositoryCreationTemplateRequest
- AConsumer
that will call methods onUpdateRepositoryCreationTemplateRequest.Builder
to create a request.- Returns:
- Result of the UpdateRepositoryCreationTemplate operation returned by the service.
- See Also:
-
uploadLayerPart
default UploadLayerPartResponse uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest) throws ServerException, InvalidParameterException, InvalidLayerPartException, RepositoryNotFoundException, UploadNotFoundException, LimitExceededException, KmsException, AwsServiceException, SdkClientException, EcrException Uploads an image layer part to Amazon ECR.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
docker
CLI to pull, tag, and push images.- Parameters:
uploadLayerPartRequest
-- Returns:
- Result of the UploadLayerPart operation returned by the service.
- See Also:
-
uploadLayerPart
default UploadLayerPartResponse uploadLayerPart(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest) throws ServerException, InvalidParameterException, InvalidLayerPartException, RepositoryNotFoundException, UploadNotFoundException, LimitExceededException, KmsException, AwsServiceException, SdkClientException, EcrException Uploads an image layer part to Amazon ECR.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part.
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the
docker
CLI to pull, tag, and push images.
This is a convenience which creates an instance of the
UploadLayerPartRequest.Builder
avoiding the need to create one manually viaUploadLayerPartRequest.builder()
- Parameters:
uploadLayerPartRequest
- AConsumer
that will call methods onUploadLayerPartRequest.Builder
to create a request.- Returns:
- Result of the UploadLayerPart operation returned by the service.
- See Also:
-
validatePullThroughCacheRule
default ValidatePullThroughCacheRuleResponse validatePullThroughCacheRule(ValidatePullThroughCacheRuleRequest validatePullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException Validates an existing pull through cache rule for an upstream registry that requires authentication. This will retrieve the contents of the Amazon Web Services Secrets Manager secret, verify the syntax, and then validate that authentication to the upstream registry is successful.
- Parameters:
validatePullThroughCacheRuleRequest
-- Returns:
- Result of the ValidatePullThroughCacheRule operation returned by the service.
- See Also:
-
validatePullThroughCacheRule
default ValidatePullThroughCacheRuleResponse validatePullThroughCacheRule(Consumer<ValidatePullThroughCacheRuleRequest.Builder> validatePullThroughCacheRuleRequest) throws ServerException, InvalidParameterException, ValidationException, PullThroughCacheRuleNotFoundException, AwsServiceException, SdkClientException, EcrException Validates an existing pull through cache rule for an upstream registry that requires authentication. This will retrieve the contents of the Amazon Web Services Secrets Manager secret, verify the syntax, and then validate that authentication to the upstream registry is successful.
This is a convenience which creates an instance of the
ValidatePullThroughCacheRuleRequest.Builder
avoiding the need to create one manually viaValidatePullThroughCacheRuleRequest.builder()
- Parameters:
validatePullThroughCacheRuleRequest
- AConsumer
that will call methods onValidatePullThroughCacheRuleRequest.Builder
to create a request.- Returns:
- Result of the ValidatePullThroughCacheRule operation returned by the service.
- See Also:
-
waiter
-
create
Create aEcrClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aEcrClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-