@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonECR extends Object implements AmazonECR
AmazonECR. Convenient method forms pass through to the corresponding overload that
takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIXpublic void setEndpoint(String endpoint)
AmazonECR
Callers can pass in just the endpoint (ex: "api.ecr.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "api.ecr.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol
from this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AmazonECRendpoint - The endpoint (ex: "api.ecr.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"api.ecr.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.public void setRegion(Region region)
AmazonECRAmazonECR.setEndpoint(String), sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AmazonECRregion - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public BatchCheckLayerAvailabilityResult batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest request)
AmazonECRChecks 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.
batchCheckLayerAvailability in interface AmazonECRpublic BatchDeleteImageResult batchDeleteImage(BatchDeleteImageRequest request)
AmazonECR
Deletes a list of specified images within a repository. Images are specified with either an imageTag
or imageDigest.
You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
You can completely delete an image (and all of its tags) by specifying the image's digest in your request.
batchDeleteImage in interface AmazonECRrequest - Deletes specified images within a specified repository. Images are specified with either the
imageTag or imageDigest.public BatchGetImageResult batchGetImage(BatchGetImageRequest request)
AmazonECR
Gets detailed information for an image. Images are specified with either an imageTag or
imageDigest.
When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.
batchGetImage in interface AmazonECRpublic BatchGetRepositoryScanningConfigurationResult batchGetRepositoryScanningConfiguration(BatchGetRepositoryScanningConfigurationRequest request)
AmazonECRGets the scanning configuration for one or more repositories.
batchGetRepositoryScanningConfiguration in interface AmazonECRpublic CompleteLayerUploadResult completeLayerUpload(CompleteLayerUploadRequest request)
AmazonECR
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.
completeLayerUpload in interface AmazonECRpublic CreatePullThroughCacheRuleResult createPullThroughCacheRule(CreatePullThroughCacheRuleRequest request)
AmazonECRCreates 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.
createPullThroughCacheRule in interface AmazonECRpublic CreateRepositoryResult createRepository(CreateRepositoryRequest request)
AmazonECRCreates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
createRepository in interface AmazonECRpublic CreateRepositoryCreationTemplateResult createRepositoryCreationTemplate(CreateRepositoryCreationTemplateRequest request)
AmazonECRCreates 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.
createRepositoryCreationTemplate in interface AmazonECRpublic DeleteLifecyclePolicyResult deleteLifecyclePolicy(DeleteLifecyclePolicyRequest request)
AmazonECRDeletes the lifecycle policy associated with the specified repository.
deleteLifecyclePolicy in interface AmazonECRpublic DeletePullThroughCacheRuleResult deletePullThroughCacheRule(DeletePullThroughCacheRuleRequest request)
AmazonECRDeletes a pull through cache rule.
deletePullThroughCacheRule in interface AmazonECRpublic DeleteRegistryPolicyResult deleteRegistryPolicy(DeleteRegistryPolicyRequest request)
AmazonECRDeletes the registry permissions policy.
deleteRegistryPolicy in interface AmazonECRpublic DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest request)
AmazonECR
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.
deleteRepository in interface AmazonECRpublic DeleteRepositoryCreationTemplateResult deleteRepositoryCreationTemplate(DeleteRepositoryCreationTemplateRequest request)
AmazonECRDeletes a repository creation template.
deleteRepositoryCreationTemplate in interface AmazonECRpublic DeleteRepositoryPolicyResult deleteRepositoryPolicy(DeleteRepositoryPolicyRequest request)
AmazonECRDeletes the repository policy associated with the specified repository.
deleteRepositoryPolicy in interface AmazonECRpublic DescribeImageReplicationStatusResult describeImageReplicationStatus(DescribeImageReplicationStatusRequest request)
AmazonECRReturns the replication status for a specified image.
describeImageReplicationStatus in interface AmazonECRpublic DescribeImageScanFindingsResult describeImageScanFindings(DescribeImageScanFindingsRequest request)
AmazonECRReturns the scan findings for the specified image.
describeImageScanFindings in interface AmazonECRpublic DescribeImagesResult describeImages(DescribeImagesRequest request)
AmazonECRReturns 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.
describeImages in interface AmazonECRpublic DescribePullThroughCacheRulesResult describePullThroughCacheRules(DescribePullThroughCacheRulesRequest request)
AmazonECRReturns the pull through cache rules for a registry.
describePullThroughCacheRules in interface AmazonECRpublic DescribeRegistryResult describeRegistry(DescribeRegistryRequest request)
AmazonECRDescribes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
describeRegistry in interface AmazonECRpublic DescribeRepositoriesResult describeRepositories(DescribeRepositoriesRequest request)
AmazonECRDescribes image repositories in a registry.
describeRepositories in interface AmazonECRpublic DescribeRepositoryCreationTemplatesResult describeRepositoryCreationTemplates(DescribeRepositoryCreationTemplatesRequest request)
AmazonECR
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.
describeRepositoryCreationTemplates in interface AmazonECRpublic GetAuthorizationTokenResult getAuthorizationToken(GetAuthorizationTokenRequest request)
AmazonECRRetrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.
The authorizationToken returned is a base64 encoded string that can be decoded and used in a
docker login command to authenticate to a registry. The CLI offers an
get-login-password command that simplifies the login process. For more information, see Registry
authentication in the Amazon Elastic Container Registry User Guide.
getAuthorizationToken in interface AmazonECRpublic GetDownloadUrlForLayerResult getDownloadUrlForLayer(GetDownloadUrlForLayerRequest request)
AmazonECRRetrieves 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.
getDownloadUrlForLayer in interface AmazonECRpublic GetLifecyclePolicyResult getLifecyclePolicy(GetLifecyclePolicyRequest request)
AmazonECRRetrieves the lifecycle policy for the specified repository.
getLifecyclePolicy in interface AmazonECRpublic GetLifecyclePolicyPreviewResult getLifecyclePolicyPreview(GetLifecyclePolicyPreviewRequest request)
AmazonECRRetrieves the results of the lifecycle policy preview request for the specified repository.
getLifecyclePolicyPreview in interface AmazonECRpublic GetRegistryPolicyResult getRegistryPolicy(GetRegistryPolicyRequest request)
AmazonECRRetrieves the permissions policy for a registry.
getRegistryPolicy in interface AmazonECRpublic GetRegistryScanningConfigurationResult getRegistryScanningConfiguration(GetRegistryScanningConfigurationRequest request)
AmazonECRRetrieves the scanning configuration for a registry.
getRegistryScanningConfiguration in interface AmazonECRpublic GetRepositoryPolicyResult getRepositoryPolicy(GetRepositoryPolicyRequest request)
AmazonECRRetrieves the repository policy for the specified repository.
getRepositoryPolicy in interface AmazonECRpublic InitiateLayerUploadResult initiateLayerUpload(InitiateLayerUploadRequest request)
AmazonECRNotifies 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.
initiateLayerUpload in interface AmazonECRpublic ListImagesResult listImages(ListImagesRequest request)
AmazonECRLists all the image IDs for the specified repository.
You can filter images based on whether or not they are tagged by using the tagStatus filter and
specifying either TAGGED, UNTAGGED or ANY. For example, you can filter
your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage
operation to delete them. Or, you can filter your results to return only TAGGED images to list all
of the tags in your repository.
listImages in interface AmazonECRpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonECRList the tags for an Amazon ECR resource.
listTagsForResource in interface AmazonECRpublic PutImageResult putImage(PutImageRequest request)
AmazonECRCreates 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.
putImage in interface AmazonECRpublic PutImageScanningConfigurationResult putImageScanningConfiguration(PutImageScanningConfigurationRequest request)
AmazonECR
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.
putImageScanningConfiguration in interface AmazonECRpublic PutImageTagMutabilityResult putImageTagMutability(PutImageTagMutabilityRequest request)
AmazonECRUpdates the image tag mutability settings for the specified repository. For more information, see Image tag mutability in the Amazon Elastic Container Registry User Guide.
putImageTagMutability in interface AmazonECRpublic PutLifecyclePolicyResult putLifecyclePolicy(PutLifecyclePolicyRequest request)
AmazonECRCreates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.
putLifecyclePolicy in interface AmazonECRpublic PutRegistryPolicyResult putRegistryPolicy(PutRegistryPolicyRequest request)
AmazonECRCreates 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.
putRegistryPolicy in interface AmazonECRpublic PutRegistryScanningConfigurationResult putRegistryScanningConfiguration(PutRegistryScanningConfigurationRequest request)
AmazonECRCreates or updates the scanning configuration for your private registry.
putRegistryScanningConfiguration in interface AmazonECRpublic PutReplicationConfigurationResult putReplicationConfiguration(PutReplicationConfigurationRequest request)
AmazonECRCreates 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.
putReplicationConfiguration in interface AmazonECRpublic SetRepositoryPolicyResult setRepositoryPolicy(SetRepositoryPolicyRequest request)
AmazonECRApplies 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.
setRepositoryPolicy in interface AmazonECRpublic StartImageScanResult startImageScan(StartImageScanRequest request)
AmazonECRStarts 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.
startImageScan in interface AmazonECRpublic StartLifecyclePolicyPreviewResult startLifecyclePolicyPreview(StartLifecyclePolicyPreviewRequest request)
AmazonECRStarts 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.
startLifecyclePolicyPreview in interface AmazonECRpublic TagResourceResult tagResource(TagResourceRequest request)
AmazonECRAdds 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.
tagResource in interface AmazonECRpublic UntagResourceResult untagResource(UntagResourceRequest request)
AmazonECRDeletes specified tags from a resource.
untagResource in interface AmazonECRpublic UpdatePullThroughCacheRuleResult updatePullThroughCacheRule(UpdatePullThroughCacheRuleRequest request)
AmazonECRUpdates an existing pull through cache rule.
updatePullThroughCacheRule in interface AmazonECRpublic UpdateRepositoryCreationTemplateResult updateRepositoryCreationTemplate(UpdateRepositoryCreationTemplateRequest request)
AmazonECRUpdates an existing repository creation template.
updateRepositoryCreationTemplate in interface AmazonECRpublic UploadLayerPartResult uploadLayerPart(UploadLayerPartRequest request)
AmazonECRUploads 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.
uploadLayerPart in interface AmazonECRpublic ValidatePullThroughCacheRuleResult validatePullThroughCacheRule(ValidatePullThroughCacheRuleRequest request)
AmazonECRValidates 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.
validatePullThroughCacheRule in interface AmazonECRpublic void shutdown()
AmazonECRpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonECRResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonECRrequest - The originally executed request.public AmazonECRWaiters waiters()