com.amazonaws.services.ecr

Class AmazonECRClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.ecr.AmazonECRClient

All Implemented Interfaces:

AmazonECR

Direct Known Subclasses:

AmazonECRAsyncClient

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

Client for accessing Amazon ECR. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Elastic Container Registry

Amazon Elastic Container Registry (Amazon ECR) is a managed Docker registry service. Customers can use the familiar Docker CLI to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry. Amazon ECR supports private Docker repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images. Developers can use the Docker CLI to author and manage images.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonECRClient() Deprecated. use AmazonECRClientBuilder.defaultClient()
AmazonECRClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonECRClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AmazonECRClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AmazonECRClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

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.
static AmazonECRClientBuilder	builder()
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 an image repository.
DeleteLifecyclePolicyResult	deleteLifecyclePolicy(DeleteLifecyclePolicyRequest request) Deletes the specified lifecycle policy.
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.
GetLifecyclePolicyResult	getLifecyclePolicy(GetLifecyclePolicyRequest request) Retrieves the specified lifecycle policy.
GetLifecyclePolicyPreviewResult	getLifecyclePolicyPreview(GetLifecyclePolicyPreviewRequest request) Retrieves the results of the specified lifecycle policy preview request.
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.
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.
PutImageTagMutabilityResult	putImageTagMutability(PutImageTagMutabilityRequest request) Updates the image tag mutability settings for a repository.
PutLifecyclePolicyResult	putLifecyclePolicy(PutLifecyclePolicyRequest request) Creates or updates a lifecycle policy.
SetRepositoryPolicyResult	setRepositoryPolicy(SetRepositoryPolicyRequest request) Applies a repository policy on a specified repository to control access permissions.
StartLifecyclePolicyPreviewResult	startLifecyclePolicyPreview(StartLifecyclePolicyPreviewRequest request) Starts a preview of the specified lifecycle policy.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setEndpoint, setRegion, shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Constructor Detail

AmazonECRClient

@Deprecated
public AmazonECRClient()

Deprecated. use AmazonECRClientBuilder.defaultClient()

Constructs a new client to invoke service methods on Amazon ECR. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonECRClient

@Deprecated
public AmazonECRClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon ECR. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Amazon ECR (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonECRClient

@Deprecated
public AmazonECRClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonECRClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on Amazon ECR using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonECRClient

@Deprecated
public AmazonECRClient(AWSCredentials awsCredentials,
                                   ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon ECR using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon ECR (ex: proxy settings, retry counts, etc.).

AmazonECRClient

@Deprecated
public AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on Amazon ECR using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonECRClient

@Deprecated
public AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon ECR using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon ECR (ex: proxy settings, retry counts, etc.).

AmazonECRClient

@Deprecated
public AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration,
                                   RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on Amazon ECR using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon ECR (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AmazonECRClientBuilder builder()

batchCheckLayerAvailability

public BatchCheckLayerAvailabilityResult batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest request)

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

Parameters:

batchCheckLayerAvailabilityRequest -

Returns:

Result of the BatchCheckLayerAvailability operation returned by the service.

Throws:

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ServerException - These errors are usually caused by a server-side issue.

See Also:

AWS API Documentation

batchDeleteImage

public BatchDeleteImageResult batchDeleteImage(BatchDeleteImageRequest request)

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:

batchDeleteImageRequest - 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.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

See Also:

AWS API Documentation

batchGetImage

public BatchGetImageResult batchGetImage(BatchGetImageRequest request)

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

Specified by:

batchGetImage in interface AmazonECR

Parameters:

batchGetImageRequest -

Returns:

Result of the BatchGetImage operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

See Also:

AWS API Documentation

completeLayerUpload

public CompleteLayerUploadResult completeLayerUpload(CompleteLayerUploadRequest request)

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.

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

Parameters:

completeLayerUploadRequest -

Returns:

Result of the CompleteLayerUpload operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

UploadNotFoundException - The upload could not be found, or the specified upload id is not valid for this repository.

InvalidLayerException - The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest specified.

LayerPartTooSmallException - Layer parts must be at least 5 MiB in size.

LayerAlreadyExistsException - The image layer already exists in the associated repository.

EmptyUploadException - The specified layer upload does not contain any layer parts.

See Also:

AWS API Documentation

createRepository

public CreateRepositoryResult createRepository(CreateRepositoryRequest request)

Creates an image repository.

Specified by:

createRepository in interface AmazonECR

Parameters:

createRepositoryRequest -

Returns:

Result of the CreateRepository operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

InvalidTagParameterException - An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

TooManyTagsException - The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.

RepositoryAlreadyExistsException - The specified repository already exists in the specified registry.

LimitExceededException - The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Default Service Limits in the Amazon Elastic Container Registry User Guide.

See Also:

AWS API Documentation

deleteLifecyclePolicy

public DeleteLifecyclePolicyResult deleteLifecyclePolicy(DeleteLifecyclePolicyRequest request)

Deletes the specified lifecycle policy.

Specified by:

deleteLifecyclePolicy in interface AmazonECR

Parameters:

deleteLifecyclePolicyRequest -

Returns:

Result of the DeleteLifecyclePolicy operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

LifecyclePolicyNotFoundException - The lifecycle policy could not be found, and no policy is set to the repository.

See Also:

AWS API Documentation

deleteRepository

public DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest request)

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

Parameters:

deleteRepositoryRequest -

Returns:

Result of the DeleteRepository operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

RepositoryNotEmptyException - The specified repository contains images. To delete a repository that contains images, you must force the deletion with the force parameter.

See Also:

AWS API Documentation

deleteRepositoryPolicy

public DeleteRepositoryPolicyResult deleteRepositoryPolicy(DeleteRepositoryPolicyRequest request)

Deletes the repository policy from a specified repository.

Specified by:

deleteRepositoryPolicy in interface AmazonECR

Parameters:

deleteRepositoryPolicyRequest -

Returns:

Result of the DeleteRepositoryPolicy operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

RepositoryPolicyNotFoundException - The specified repository and registry combination does not have an associated repository policy.

See Also:

AWS API Documentation

describeImages

public DescribeImagesResult describeImages(DescribeImagesRequest request)

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

Parameters:

describeImagesRequest -

Returns:

Result of the DescribeImages operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ImageNotFoundException - The image requested does not exist in the specified repository.

See Also:

AWS API Documentation

describeRepositories

public DescribeRepositoriesResult describeRepositories(DescribeRepositoriesRequest request)

Describes image repositories in a registry.

Specified by:

describeRepositories in interface AmazonECR

Parameters:

describeRepositoriesRequest -

Returns:

Result of the DescribeRepositories operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

See Also:

AWS API Documentation

getAuthorizationToken

public GetAuthorizationTokenResult getAuthorizationToken(GetAuthorizationTokenRequest request)

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

Parameters:

getAuthorizationTokenRequest -

Returns:

Result of the GetAuthorizationToken operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

See Also:

AWS API Documentation

getDownloadUrlForLayer

public GetDownloadUrlForLayerResult getDownloadUrlForLayer(GetDownloadUrlForLayerRequest request)

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

Parameters:

getDownloadUrlForLayerRequest -

Returns:

Result of the GetDownloadUrlForLayer operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

LayersNotFoundException - The specified layers could not be found, or the specified layer is not valid for this repository.

LayerInaccessibleException - The specified layer is not available because it is not associated with an image. Unassociated image layers may be cleaned up at any time.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

See Also:

AWS API Documentation

getLifecyclePolicy

public GetLifecyclePolicyResult getLifecyclePolicy(GetLifecyclePolicyRequest request)

Retrieves the specified lifecycle policy.

Specified by:

getLifecyclePolicy in interface AmazonECR

Parameters:

getLifecyclePolicyRequest -

Returns:

Result of the GetLifecyclePolicy operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

LifecyclePolicyNotFoundException - The lifecycle policy could not be found, and no policy is set to the repository.

See Also:

AWS API Documentation

getLifecyclePolicyPreview

public GetLifecyclePolicyPreviewResult getLifecyclePolicyPreview(GetLifecyclePolicyPreviewRequest request)

Retrieves the results of the specified lifecycle policy preview request.

Specified by:

getLifecyclePolicyPreview in interface AmazonECR

Parameters:

getLifecyclePolicyPreviewRequest -

Returns:

Result of the GetLifecyclePolicyPreview operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

LifecyclePolicyPreviewNotFoundException - There is no dry run for this repository.

See Also:

AWS API Documentation

getRepositoryPolicy

public GetRepositoryPolicyResult getRepositoryPolicy(GetRepositoryPolicyRequest request)

Retrieves the repository policy for a specified repository.

Specified by:

getRepositoryPolicy in interface AmazonECR

Parameters:

getRepositoryPolicyRequest -

Returns:

Result of the GetRepositoryPolicy operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

RepositoryPolicyNotFoundException - The specified repository and registry combination does not have an associated repository policy.

See Also:

AWS API Documentation

initiateLayerUpload

public InitiateLayerUploadResult initiateLayerUpload(InitiateLayerUploadRequest request)

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

Parameters:

initiateLayerUploadRequest -

Returns:

Result of the InitiateLayerUpload operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

See Also:

AWS API Documentation

listImages

public ListImagesResult listImages(ListImagesRequest request)

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

Parameters:

listImagesRequest -

Returns:

Result of the ListImages operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

List the tags for an Amazon ECR resource.

Specified by:

listTagsForResource in interface AmazonECR

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ServerException - These errors are usually caused by a server-side issue.

See Also:

AWS API Documentation

putImage

public PutImageResult putImage(PutImageRequest request)

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

Parameters:

putImageRequest -

Returns:

Result of the PutImage operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ImageAlreadyExistsException - The specified image has already been pushed, and there were no changes to the manifest or image tag after the last push.

LayersNotFoundException - The specified layers could not be found, or the specified layer is not valid for this repository.

LimitExceededException - The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Default Service Limits in the Amazon Elastic Container Registry User Guide.

ImageTagAlreadyExistsException - The specified image is tagged with a tag that already exists. The repository is configured for tag immutability.

See Also:

AWS API Documentation

putImageTagMutability

public PutImageTagMutabilityResult putImageTagMutability(PutImageTagMutabilityRequest request)

Updates the image tag mutability settings for a repository.

Specified by:

putImageTagMutability in interface AmazonECR

Parameters:

putImageTagMutabilityRequest -

Returns:

Result of the PutImageTagMutability operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

See Also:

AWS API Documentation

putLifecyclePolicy

public PutLifecyclePolicyResult putLifecyclePolicy(PutLifecyclePolicyRequest request)

Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see Lifecycle Policy Template.

Specified by:

putLifecyclePolicy in interface AmazonECR

Parameters:

putLifecyclePolicyRequest -

Returns:

Result of the PutLifecyclePolicy operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

See Also:

AWS API Documentation

setRepositoryPolicy

public SetRepositoryPolicyResult setRepositoryPolicy(SetRepositoryPolicyRequest request)

Applies a repository policy on a specified repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.

Specified by:

setRepositoryPolicy in interface AmazonECR

Parameters:

setRepositoryPolicyRequest -

Returns:

Result of the SetRepositoryPolicy operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

See Also:

AWS API Documentation

startLifecyclePolicyPreview

public StartLifecyclePolicyPreviewResult startLifecyclePolicyPreview(StartLifecyclePolicyPreviewRequest request)

Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy.

Specified by:

startLifecyclePolicyPreview in interface AmazonECR

Parameters:

startLifecyclePolicyPreviewRequest -

Returns:

Result of the StartLifecyclePolicyPreview operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

LifecyclePolicyNotFoundException - The lifecycle policy could not be found, and no policy is set to the repository.

LifecyclePolicyPreviewInProgressException - The previous lifecycle policy preview request has not completed. Please try again later.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AmazonECR

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

InvalidTagParameterException - An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

TooManyTagsException - The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ServerException - These errors are usually caused by a server-side issue.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Deletes specified tags from a resource.

Specified by:

untagResource in interface AmazonECR

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

InvalidTagParameterException - An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

TooManyTagsException - The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

ServerException - These errors are usually caused by a server-side issue.

See Also:

AWS API Documentation

uploadLayerPart

public UploadLayerPartResult uploadLayerPart(UploadLayerPartRequest request)

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

Parameters:

uploadLayerPartRequest -

Returns:

Result of the UploadLayerPart operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server-side issue.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

InvalidLayerPartException - The layer part size is not valid, or the first byte specified is not consecutive to the last byte of a previous layer part upload.

RepositoryNotFoundException - The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

UploadNotFoundException - The upload could not be found, or the specified upload id is not valid for this repository.

LimitExceededException - The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Default Service Limits in the Amazon Elastic Container Registry User Guide.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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. 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 the 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.