com.amazonaws.services.ecr

Class AbstractAmazonECR

java.lang.Object

com.amazonaws.services.ecr.AbstractAmazonECR

All Implemented Interfaces:

AmazonECR

Direct Known Subclasses:

AbstractAmazonECRAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonECR
extends Object
implements AmazonECR

Abstract implementation of AmazonECR. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.ecr.AmazonECR

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAmazonECR()

Method Summary

Modifier and Type	Method and Description
BatchCheckLayerAvailabilityResult	batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest request) Check the availability of multiple image layers in a specified registry and repository.
BatchDeleteImageResult	batchDeleteImage(BatchDeleteImageRequest request) Deletes a list of specified images within a specified repository.
BatchGetImageResult	batchGetImage(BatchGetImageRequest request) Gets detailed information for specified images within a specified repository.
CompleteLayerUploadResult	completeLayerUpload(CompleteLayerUploadRequest request) Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has completed.
CreateRepositoryResult	createRepository(CreateRepositoryRequest request) Creates an image repository.
DeleteRepositoryResult	deleteRepository(DeleteRepositoryRequest request) Deletes an existing image repository.
DeleteRepositoryPolicyResult	deleteRepositoryPolicy(DeleteRepositoryPolicyRequest request) Deletes the repository policy from a specified repository.
DescribeImagesResult	describeImages(DescribeImagesRequest request) Returns metadata about the images in a repository, including image size, image tags, and creation date.
DescribeRepositoriesResult	describeRepositories(DescribeRepositoriesRequest request) Describes image repositories in a registry.
GetAuthorizationTokenResult	getAuthorizationToken(GetAuthorizationTokenRequest request) Retrieves a token that is valid for a specified registry for 12 hours.
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.
GetRepositoryPolicyResult	getRepositoryPolicy(GetRepositoryPolicyRequest request) Retrieves the repository policy for a specified repository.
InitiateLayerUploadResult	initiateLayerUpload(InitiateLayerUploadRequest request) Notify Amazon ECR that you intend to upload an image layer.
ListImagesResult	listImages(ListImagesRequest request) Lists all the image IDs for a given repository.
PutImageResult	putImage(PutImageRequest request) Creates or updates the image manifest and tags associated with an image.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("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 on a specified repository to control access permissions.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UploadLayerPartResult	uploadLayerPart(UploadLayerPartRequest request) Uploads an image layer part to Amazon ECR.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAmazonECR

protected AbstractAmazonECR()

Method Detail

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AmazonECR

Overrides the default endpoint for this client ("ecr.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "ecr.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

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.

Specified by:

setEndpoint in interface AmazonECR

Parameters:

endpoint - The endpoint (ex: "ecr.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "ecr.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

public void setRegion(Region region)

Description copied from interface: AmazonECR

An alternative to 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.

Specified by:

setRegion in interface AmazonECR

Parameters:

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.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

batchCheckLayerAvailability

public BatchCheckLayerAvailabilityResult batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest request)

Description copied from interface: AmazonECR

Check the availability of multiple image layers in a specified registry and repository.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

Specified by:

batchCheckLayerAvailability in interface AmazonECR

Returns:

Result of the BatchCheckLayerAvailability operation returned by the service.

See Also:

AWS API Documentation

batchDeleteImage

public BatchDeleteImageResult batchDeleteImage(BatchDeleteImageRequest request)

Description copied from interface: AmazonECR

Deletes a list of specified images within a specified repository. Images are specified with either 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.

Specified by:

batchDeleteImage in interface AmazonECR

Parameters:

request - Deletes specified images within a specified repository. Images are specified with either the imageTag or imageDigest.

Returns:

Result of the BatchDeleteImage operation returned by the service.

See Also:

AWS API Documentation

batchGetImage

public BatchGetImageResult batchGetImage(BatchGetImageRequest request)

Description copied from interface: AmazonECR

Gets detailed information for specified images within a specified repository. Images are specified with either imageTag or imageDigest.

Specified by:

batchGetImage in interface AmazonECR

Returns:

Result of the BatchGetImage operation returned by the service.

See Also:

AWS API Documentation

completeLayerUpload

public CompleteLayerUploadResult completeLayerUpload(CompleteLayerUploadRequest request)

Description copied from interface: AmazonECR

Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has completed. You can optionally provide a sha256 digest of the image layer for data validation purposes.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

Specified by:

completeLayerUpload in interface AmazonECR

Returns:

Result of the CompleteLayerUpload operation returned by the service.

See Also:

AWS API Documentation

createRepository

public CreateRepositoryResult createRepository(CreateRepositoryRequest request)

Description copied from interface: AmazonECR

Creates an image repository.

Specified by:

createRepository in interface AmazonECR

Returns:

Result of the CreateRepository operation returned by the service.

See Also:

AWS API Documentation

deleteRepository

public DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest request)

Description copied from interface: AmazonECR

Deletes an existing image repository. If a repository contains images, you must use the force option to delete it.

Specified by:

deleteRepository in interface AmazonECR

Returns:

Result of the DeleteRepository operation returned by the service.

See Also:

AWS API Documentation

deleteRepositoryPolicy

public DeleteRepositoryPolicyResult deleteRepositoryPolicy(DeleteRepositoryPolicyRequest request)

Description copied from interface: AmazonECR

Deletes the repository policy from a specified repository.

Specified by:

deleteRepositoryPolicy in interface AmazonECR

Returns:

Result of the DeleteRepositoryPolicy operation returned by the service.

See Also:

AWS API Documentation

describeImages

public DescribeImagesResult describeImages(DescribeImagesRequest request)

Description copied from interface: AmazonECR

Returns metadata about the images in a repository, including image size, image tags, and creation date.

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.

Specified by:

describeImages in interface AmazonECR

Returns:

Result of the DescribeImages operation returned by the service.

See Also:

AWS API Documentation

describeRepositories

public DescribeRepositoriesResult describeRepositories(DescribeRepositoriesRequest request)

Description copied from interface: AmazonECR

Describes image repositories in a registry.

Specified by:

describeRepositories in interface AmazonECR

Returns:

Result of the DescribeRepositories operation returned by the service.

See Also:

AWS API Documentation

getAuthorizationToken

public GetAuthorizationTokenResult getAuthorizationToken(GetAuthorizationTokenRequest request)

Description copied from interface: AmazonECR

Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the docker CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed.

The authorizationToken returned for each registry specified 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 aws ecr get-login command that simplifies the login process.

Specified by:

getAuthorizationToken in interface AmazonECR

Returns:

Result of the GetAuthorizationToken operation returned by the service.

See Also:

AWS API Documentation

getDownloadUrlForLayer

public GetDownloadUrlForLayerResult getDownloadUrlForLayer(GetDownloadUrlForLayerRequest request)

Description copied from interface: 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.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

Specified by:

getDownloadUrlForLayer in interface AmazonECR

Returns:

Result of the GetDownloadUrlForLayer operation returned by the service.

See Also:

AWS API Documentation

getRepositoryPolicy

public GetRepositoryPolicyResult getRepositoryPolicy(GetRepositoryPolicyRequest request)

Description copied from interface: AmazonECR

Retrieves the repository policy for a specified repository.

Specified by:

getRepositoryPolicy in interface AmazonECR

Returns:

Result of the GetRepositoryPolicy operation returned by the service.

See Also:

AWS API Documentation

initiateLayerUpload

public InitiateLayerUploadResult initiateLayerUpload(InitiateLayerUploadRequest request)

Description copied from interface: AmazonECR

Notify Amazon ECR that you intend to upload an image layer.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

Specified by:

initiateLayerUpload in interface AmazonECR

Returns:

Result of the InitiateLayerUpload operation returned by the service.

See Also:

AWS API Documentation

listImages

public ListImagesResult listImages(ListImagesRequest request)

Description copied from interface: AmazonECR

Lists all the image IDs for a given repository.

You can filter images based on whether or not they are tagged by setting the tagStatus parameter to TAGGED or UNTAGGED. 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.

Specified by:

listImages in interface AmazonECR

Returns:

Result of the ListImages operation returned by the service.

See Also:

AWS API Documentation

putImage

public PutImageResult putImage(PutImageRequest request)

Description copied from interface: AmazonECR

Creates or updates the image manifest and tags associated with an image.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

Specified by:

putImage in interface AmazonECR

Returns:

Result of the PutImage operation returned by the service.

See Also:

AWS API Documentation

setRepositoryPolicy

public SetRepositoryPolicyResult setRepositoryPolicy(SetRepositoryPolicyRequest request)

Description copied from interface: AmazonECR

Applies a repository policy on a specified repository to control access permissions.

Specified by:

setRepositoryPolicy in interface AmazonECR

Returns:

Result of the SetRepositoryPolicy operation returned by the service.

See Also:

AWS API Documentation

uploadLayerPart

public UploadLayerPartResult uploadLayerPart(UploadLayerPartRequest request)

Description copied from interface: AmazonECR

Uploads an image layer part to Amazon ECR.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

Specified by:

uploadLayerPart in interface AmazonECR

Returns:

Result of the UploadLayerPart operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AmazonECR

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonECR

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AmazonECR

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Specified by:

getCachedResponseMetadata in interface AmazonECR

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.