@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_PREFIX
Modifier and Type | Method and Description |
---|---|
BatchCheckLayerAvailabilityResult |
batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest request)
Checks the availability of one or more image layers in a repository.
|
BatchDeleteImageResult |
batchDeleteImage(BatchDeleteImageRequest request)
Deletes a list of specified images within a repository.
|
BatchGetImageResult |
batchGetImage(BatchGetImageRequest request)
Gets detailed information for an image.
|
CompleteLayerUploadResult |
completeLayerUpload(CompleteLayerUploadRequest request)
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and
upload ID.
|
CreateRepositoryResult |
createRepository(CreateRepositoryRequest request)
Creates a repository.
|
DeleteLifecyclePolicyResult |
deleteLifecyclePolicy(DeleteLifecyclePolicyRequest request)
Deletes the lifecycle policy associated with the specified repository.
|
DeleteRegistryPolicyResult |
deleteRegistryPolicy(DeleteRegistryPolicyRequest request)
Deletes the registry permissions policy.
|
DeleteRepositoryResult |
deleteRepository(DeleteRepositoryRequest request)
Deletes a repository.
|
DeleteRepositoryPolicyResult |
deleteRepositoryPolicy(DeleteRepositoryPolicyRequest request)
Deletes the repository policy associated with the specified repository.
|
DescribeImagesResult |
describeImages(DescribeImagesRequest request)
Returns metadata about the images in a repository.
|
DescribeImageScanFindingsResult |
describeImageScanFindings(DescribeImageScanFindingsRequest request)
Returns the scan findings for the specified image.
|
DescribeRegistryResult |
describeRegistry(DescribeRegistryRequest request)
Describes the settings for a registry.
|
DescribeRepositoriesResult |
describeRepositories(DescribeRepositoriesRequest request)
Describes image repositories in a registry.
|
GetAuthorizationTokenResult |
getAuthorizationToken(GetAuthorizationTokenRequest request)
Retrieves an authorization token.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDownloadUrlForLayerResult |
getDownloadUrlForLayer(GetDownloadUrlForLayerRequest request)
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.
|
GetLifecyclePolicyResult |
getLifecyclePolicy(GetLifecyclePolicyRequest request)
Retrieves the lifecycle policy for the specified repository.
|
GetLifecyclePolicyPreviewResult |
getLifecyclePolicyPreview(GetLifecyclePolicyPreviewRequest request)
Retrieves the results of the lifecycle policy preview request for the specified repository.
|
GetRegistryPolicyResult |
getRegistryPolicy(GetRegistryPolicyRequest request)
Retrieves the permissions policy for a registry.
|
GetRepositoryPolicyResult |
getRepositoryPolicy(GetRepositoryPolicyRequest request)
Retrieves the repository policy for the specified repository.
|
InitiateLayerUploadResult |
initiateLayerUpload(InitiateLayerUploadRequest request)
Notifies Amazon ECR that you intend to upload an image layer.
|
ListImagesResult |
listImages(ListImagesRequest request)
Lists all the image IDs for the specified repository.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
List the tags for an Amazon ECR resource.
|
PutImageResult |
putImage(PutImageRequest request)
Creates or updates the image manifest and tags associated with an image.
|
PutImageScanningConfigurationResult |
putImageScanningConfiguration(PutImageScanningConfigurationRequest request)
Updates the image scanning configuration for the specified repository.
|
PutImageTagMutabilityResult |
putImageTagMutability(PutImageTagMutabilityRequest request)
Updates the image tag mutability settings for the specified repository.
|
PutLifecyclePolicyResult |
putLifecyclePolicy(PutLifecyclePolicyRequest request)
Creates or updates the lifecycle policy for the specified repository.
|
PutRegistryPolicyResult |
putRegistryPolicy(PutRegistryPolicyRequest request)
Creates or updates the permissions policy for your registry.
|
PutReplicationConfigurationResult |
putReplicationConfiguration(PutReplicationConfigurationRequest request)
Creates or updates the replication configuration for a registry.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("api.ecr.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AmazonECR.setEndpoint(String) , sets the regional endpoint for this client's service
calls. |
SetRepositoryPolicyResult |
setRepositoryPolicy(SetRepositoryPolicyRequest request)
Applies a repository policy to the specified repository to control access permissions.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartImageScanResult |
startImageScan(StartImageScanRequest request)
Starts an image vulnerability scan.
|
StartLifecyclePolicyPreviewResult |
startLifecyclePolicyPreview(StartLifecyclePolicyPreviewRequest request)
Starts a preview of a lifecycle policy for the specified repository.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds specified tags to a resource with the specified ARN.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Deletes specified tags from a resource.
|
UploadLayerPartResult |
uploadLayerPart(UploadLayerPartRequest request)
Uploads an image layer part to Amazon ECR.
|
AmazonECRWaiters |
waiters() |
public 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 AmazonECR
endpoint
- 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)
AmazonECR
AmazonECR.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 AmazonECR
region
- 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)
AmazonECR
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.
batchCheckLayerAvailability
in interface AmazonECR
public 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 AmazonECR
request
- 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 AmazonECR
public 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 AmazonECR
public CreateRepositoryResult createRepository(CreateRepositoryRequest request)
AmazonECR
Creates a repository. For more information, see Amazon ECR Repositories in the Amazon Elastic Container Registry User Guide.
createRepository
in interface AmazonECR
public DeleteLifecyclePolicyResult deleteLifecyclePolicy(DeleteLifecyclePolicyRequest request)
AmazonECR
Deletes the lifecycle policy associated with the specified repository.
deleteLifecyclePolicy
in interface AmazonECR
public DeleteRegistryPolicyResult deleteRegistryPolicy(DeleteRegistryPolicyRequest request)
AmazonECR
Deletes the registry permissions policy.
deleteRegistryPolicy
in interface AmazonECR
public DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest request)
AmazonECR
Deletes a repository. If the repository contains images, you must either delete all images in the repository or
use the force
option to delete the repository.
deleteRepository
in interface AmazonECR
public DeleteRepositoryPolicyResult deleteRepositoryPolicy(DeleteRepositoryPolicyRequest request)
AmazonECR
Deletes the repository policy associated with the specified repository.
deleteRepositoryPolicy
in interface AmazonECR
public DescribeImageScanFindingsResult describeImageScanFindings(DescribeImageScanFindingsRequest request)
AmazonECR
Returns the scan findings for the specified image.
describeImageScanFindings
in interface AmazonECR
public DescribeImagesResult describeImages(DescribeImagesRequest request)
AmazonECR
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.
describeImages
in interface AmazonECR
public DescribeRegistryResult describeRegistry(DescribeRegistryRequest request)
AmazonECR
Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
describeRegistry
in interface AmazonECR
public DescribeRepositoriesResult describeRepositories(DescribeRepositoriesRequest request)
AmazonECR
Describes image repositories in a registry.
describeRepositories
in interface AmazonECR
public GetAuthorizationTokenResult getAuthorizationToken(GetAuthorizationTokenRequest request)
AmazonECR
Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.
The authorizationToken
returned is a base64 encoded string that can be decoded and used in a
docker login
command to authenticate to a registry. The AWS 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 AmazonECR
public GetDownloadUrlForLayerResult getDownloadUrlForLayer(GetDownloadUrlForLayerRequest request)
AmazonECR
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.
getDownloadUrlForLayer
in interface AmazonECR
public GetLifecyclePolicyResult getLifecyclePolicy(GetLifecyclePolicyRequest request)
AmazonECR
Retrieves the lifecycle policy for the specified repository.
getLifecyclePolicy
in interface AmazonECR
public GetLifecyclePolicyPreviewResult getLifecyclePolicyPreview(GetLifecyclePolicyPreviewRequest request)
AmazonECR
Retrieves the results of the lifecycle policy preview request for the specified repository.
getLifecyclePolicyPreview
in interface AmazonECR
public GetRegistryPolicyResult getRegistryPolicy(GetRegistryPolicyRequest request)
AmazonECR
Retrieves the permissions policy for a registry.
getRegistryPolicy
in interface AmazonECR
public GetRepositoryPolicyResult getRepositoryPolicy(GetRepositoryPolicyRequest request)
AmazonECR
Retrieves the repository policy for the specified repository.
getRepositoryPolicy
in interface AmazonECR
public InitiateLayerUploadResult initiateLayerUpload(InitiateLayerUploadRequest request)
AmazonECR
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.
initiateLayerUpload
in interface AmazonECR
public ListImagesResult listImages(ListImagesRequest request)
AmazonECR
Lists all the image IDs for the specified repository.
You can filter images based on whether or not they are tagged by using the tagStatus
filter and
specifying either TAGGED
, UNTAGGED
or ANY
. For example, you can filter
your results to return only UNTAGGED
images and then pipe that result to a BatchDeleteImage
operation to delete them. Or, you can filter your results to return only TAGGED
images to list all
of the tags in your repository.
listImages
in interface AmazonECR
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonECR
List the tags for an Amazon ECR resource.
listTagsForResource
in interface AmazonECR
public PutImageResult putImage(PutImageRequest request)
AmazonECR
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.
putImage
in interface AmazonECR
public PutImageScanningConfigurationResult putImageScanningConfiguration(PutImageScanningConfigurationRequest request)
AmazonECR
Updates the image scanning configuration for the specified repository.
putImageScanningConfiguration
in interface AmazonECR
public PutImageTagMutabilityResult putImageTagMutability(PutImageTagMutabilityRequest request)
AmazonECR
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.
putImageTagMutability
in interface AmazonECR
public PutLifecyclePolicyResult putLifecyclePolicy(PutLifecyclePolicyRequest request)
AmazonECR
Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle Policy Template.
putLifecyclePolicy
in interface AmazonECR
public PutRegistryPolicyResult putRegistryPolicy(PutRegistryPolicyRequest request)
AmazonECR
Creates or updates the permissions policy for your registry.
A registry policy is used to specify permissions for another AWS 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 AmazonECR
public PutReplicationConfigurationResult putReplicationConfiguration(PutReplicationConfigurationRequest request)
AmazonECR
Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see Using Service-Linked Roles for Amazon ECR in the Amazon Elastic Container Registry User Guide.
When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a registry permissions policy. For more information, see PutRegistryPolicy.
putReplicationConfiguration
in interface AmazonECR
public SetRepositoryPolicyResult setRepositoryPolicy(SetRepositoryPolicyRequest request)
AmazonECR
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.
setRepositoryPolicy
in interface AmazonECR
public StartImageScanResult startImageScan(StartImageScanRequest request)
AmazonECR
Starts an image vulnerability scan. An image scan can only be started once per day 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 AmazonECR
public StartLifecyclePolicyPreviewResult startLifecyclePolicyPreview(StartLifecyclePolicyPreviewRequest request)
AmazonECR
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.
startLifecyclePolicyPreview
in interface AmazonECR
public TagResourceResult tagResource(TagResourceRequest request)
AmazonECR
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.
tagResource
in interface AmazonECR
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonECR
Deletes specified tags from a resource.
untagResource
in interface AmazonECR
public UploadLayerPartResult uploadLayerPart(UploadLayerPartRequest request)
AmazonECR
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.
uploadLayerPart
in interface AmazonECR
public void shutdown()
AmazonECR
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonECR
Response 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 AmazonECR
request
- The originally executed request.public AmazonECRWaiters waiters()