@Generated(value="software.amazon.awssdk:codegen") public interface EcrClient extends SdkClient
builder()
method.
Amazon EC2 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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default BatchCheckLayerAvailabilityResponse |
batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest)
Check the availability of multiple image layers in a specified registry and repository.
|
default BatchCheckLayerAvailabilityResponse |
batchCheckLayerAvailability(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest)
Check the availability of multiple image layers in a specified registry and repository.
|
default BatchDeleteImageResponse |
batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest)
Deletes a list of specified images within a specified repository.
|
default BatchDeleteImageResponse |
batchDeleteImage(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest)
Deletes a list of specified images within a specified repository.
|
default BatchGetImageResponse |
batchGetImage(BatchGetImageRequest batchGetImageRequest)
Gets detailed information for specified images within a specified repository.
|
default BatchGetImageResponse |
batchGetImage(Consumer<BatchGetImageRequest.Builder> batchGetImageRequest)
Gets detailed information for specified images within a specified repository.
|
static EcrClientBuilder |
builder()
Create a builder that can be used to configure and create a
EcrClient . |
default CompleteLayerUploadResponse |
completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest)
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and
upload ID.
|
default CompleteLayerUploadResponse |
completeLayerUpload(Consumer<CompleteLayerUploadRequest.Builder> completeLayerUploadRequest)
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and
upload ID.
|
static EcrClient |
create()
Create a
EcrClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateRepositoryResponse |
createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest)
Creates an image repository.
|
default CreateRepositoryResponse |
createRepository(CreateRepositoryRequest createRepositoryRequest)
Creates an image repository.
|
default DeleteLifecyclePolicyResponse |
deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest)
Deletes the specified lifecycle policy.
|
default DeleteLifecyclePolicyResponse |
deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)
Deletes the specified lifecycle policy.
|
default DeleteRepositoryResponse |
deleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest)
Deletes an existing image repository.
|
default DeleteRepositoryResponse |
deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)
Deletes an existing image repository.
|
default DeleteRepositoryPolicyResponse |
deleteRepositoryPolicy(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest)
Deletes the repository policy from a specified repository.
|
default DeleteRepositoryPolicyResponse |
deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest)
Deletes the repository policy from a specified repository.
|
default DescribeImagesResponse |
describeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest)
Returns metadata about the images in a repository, including image size, image tags, and creation date.
|
default DescribeImagesResponse |
describeImages(DescribeImagesRequest describeImagesRequest)
Returns metadata about the images in a repository, including image size, image tags, and creation date.
|
default DescribeImagesIterable |
describeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest)
Returns metadata about the images in a repository, including image size, image tags, and creation date.
|
default DescribeImagesIterable |
describeImagesPaginator(DescribeImagesRequest describeImagesRequest)
Returns metadata about the images in a repository, including image size, image tags, and creation date.
|
default DescribeRepositoriesResponse |
describeRepositories()
Describes image repositories in a registry.
|
default DescribeRepositoriesResponse |
describeRepositories(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest)
Describes image repositories in a registry.
|
default DescribeRepositoriesResponse |
describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest)
Describes image repositories in a registry.
|
default DescribeRepositoriesIterable |
describeRepositoriesPaginator()
Describes image repositories in a registry.
|
default DescribeRepositoriesIterable |
describeRepositoriesPaginator(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest)
Describes image repositories in a registry.
|
default DescribeRepositoriesIterable |
describeRepositoriesPaginator(DescribeRepositoriesRequest describeRepositoriesRequest)
Describes image repositories in a registry.
|
default GetAuthorizationTokenResponse |
getAuthorizationToken()
Retrieves a token that is valid for a specified registry for 12 hours.
|
default GetAuthorizationTokenResponse |
getAuthorizationToken(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest)
Retrieves a token that is valid for a specified registry for 12 hours.
|
default GetAuthorizationTokenResponse |
getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest)
Retrieves a token that is valid for a specified registry for 12 hours.
|
default GetDownloadUrlForLayerResponse |
getDownloadUrlForLayer(Consumer<GetDownloadUrlForLayerRequest.Builder> getDownloadUrlForLayerRequest)
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.
|
default GetDownloadUrlForLayerResponse |
getDownloadUrlForLayer(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest)
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.
|
default GetLifecyclePolicyResponse |
getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest)
Retrieves the specified lifecycle policy.
|
default GetLifecyclePolicyResponse |
getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest)
Retrieves the specified lifecycle policy.
|
default GetLifecyclePolicyPreviewResponse |
getLifecyclePolicyPreview(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest)
Retrieves the results of the specified lifecycle policy preview request.
|
default GetLifecyclePolicyPreviewResponse |
getLifecyclePolicyPreview(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest)
Retrieves the results of the specified lifecycle policy preview request.
|
default GetRepositoryPolicyResponse |
getRepositoryPolicy(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest)
Retrieves the repository policy for a specified repository.
|
default GetRepositoryPolicyResponse |
getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest)
Retrieves the repository policy for a specified repository.
|
default InitiateLayerUploadResponse |
initiateLayerUpload(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest)
Notify Amazon ECR that you intend to upload an image layer.
|
default InitiateLayerUploadResponse |
initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest)
Notify Amazon ECR that you intend to upload an image layer.
|
default ListImagesResponse |
listImages(Consumer<ListImagesRequest.Builder> listImagesRequest)
Lists all the image IDs for a given repository.
|
default ListImagesResponse |
listImages(ListImagesRequest listImagesRequest)
Lists all the image IDs for a given repository.
|
default ListImagesIterable |
listImagesPaginator(Consumer<ListImagesRequest.Builder> listImagesRequest)
Lists all the image IDs for a given repository.
|
default ListImagesIterable |
listImagesPaginator(ListImagesRequest listImagesRequest)
Lists all the image IDs for a given repository.
|
default PutImageResponse |
putImage(Consumer<PutImageRequest.Builder> putImageRequest)
Creates or updates the image manifest and tags associated with an image.
|
default PutImageResponse |
putImage(PutImageRequest putImageRequest)
Creates or updates the image manifest and tags associated with an image.
|
default PutLifecyclePolicyResponse |
putLifecyclePolicy(Consumer<PutLifecyclePolicyRequest.Builder> putLifecyclePolicyRequest)
Creates or updates a lifecycle policy.
|
default PutLifecyclePolicyResponse |
putLifecyclePolicy(PutLifecyclePolicyRequest putLifecyclePolicyRequest)
Creates or updates a lifecycle policy.
|
static ServiceMetadata |
serviceMetadata() |
default SetRepositoryPolicyResponse |
setRepositoryPolicy(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest)
Applies a repository policy on a specified repository to control access permissions.
|
default SetRepositoryPolicyResponse |
setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest)
Applies a repository policy on a specified repository to control access permissions.
|
default StartLifecyclePolicyPreviewResponse |
startLifecyclePolicyPreview(Consumer<StartLifecyclePolicyPreviewRequest.Builder> startLifecyclePolicyPreviewRequest)
Starts a preview of the specified lifecycle policy.
|
default StartLifecyclePolicyPreviewResponse |
startLifecyclePolicyPreview(StartLifecyclePolicyPreviewRequest startLifecyclePolicyPreviewRequest)
Starts a preview of the specified lifecycle policy.
|
default UploadLayerPartResponse |
uploadLayerPart(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest)
Uploads an image layer part to Amazon ECR.
|
default UploadLayerPartResponse |
uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest)
Uploads an image layer part to Amazon ECR.
|
serviceName
close
static final String SERVICE_NAME
static EcrClient create()
EcrClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static EcrClientBuilder builder()
EcrClient
.default BatchCheckLayerAvailabilityResponse batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest) throws RepositoryNotFoundException, InvalidParameterException, ServerException, AwsServiceException, SdkClientException, EcrException
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.
batchCheckLayerAvailabilityRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchCheckLayerAvailabilityResponse batchCheckLayerAvailability(Consumer<BatchCheckLayerAvailabilityRequest.Builder> batchCheckLayerAvailabilityRequest) throws RepositoryNotFoundException, InvalidParameterException, ServerException, AwsServiceException, SdkClientException, EcrException
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.
This is a convenience which creates an instance of the BatchCheckLayerAvailabilityRequest.Builder
avoiding the need to create one manually via BatchCheckLayerAvailabilityRequest.builder()
batchCheckLayerAvailabilityRequest
- A Consumer
that will call methods on BatchCheckLayerAvailabilityRequest.Builder
to create
a 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.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchDeleteImageResponse batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
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.
batchDeleteImageRequest
- Deletes specified images within a specified repository. Images are specified with either the
imageTag
or imageDigest
.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchDeleteImageResponse batchDeleteImage(Consumer<BatchDeleteImageRequest.Builder> batchDeleteImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
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.
This is a convenience which creates an instance of the BatchDeleteImageRequest.Builder
avoiding the need
to create one manually via BatchDeleteImageRequest.builder()
batchDeleteImageRequest
- A Consumer
that will call methods on BatchDeleteImageRequest.Builder
to create a request.
Deletes specified images within a specified repository. Images are specified with either the
imageTag
or imageDigest
.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchGetImageResponse batchGetImage(BatchGetImageRequest batchGetImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Gets detailed information for specified images within a specified repository. Images are specified with either
imageTag
or imageDigest
.
batchGetImageRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchGetImageResponse batchGetImage(Consumer<BatchGetImageRequest.Builder> batchGetImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Gets detailed information for specified images within a specified repository. Images are specified with either
imageTag
or imageDigest
.
This is a convenience which creates an instance of the BatchGetImageRequest.Builder
avoiding the need to
create one manually via BatchGetImageRequest.builder()
batchGetImageRequest
- A Consumer
that will call methods on BatchGetImageRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CompleteLayerUploadResponse completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UploadNotFoundException, InvalidLayerException, LayerPartTooSmallException, LayerAlreadyExistsException, EmptyUploadException, AwsServiceException, SdkClientException, EcrException
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and
upload ID. You can optionally provide a sha256
digest of the image layer for data validation
purposes.
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.
completeLayerUploadRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CompleteLayerUploadResponse completeLayerUpload(Consumer<CompleteLayerUploadRequest.Builder> completeLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, UploadNotFoundException, InvalidLayerException, LayerPartTooSmallException, LayerAlreadyExistsException, EmptyUploadException, AwsServiceException, SdkClientException, EcrException
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and
upload ID. You can optionally provide a sha256
digest of the image layer for data validation
purposes.
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.
This is a convenience which creates an instance of the CompleteLayerUploadRequest.Builder
avoiding the
need to create one manually via CompleteLayerUploadRequest.builder()
completeLayerUploadRequest
- A Consumer
that will call methods on CompleteLayerUploadRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateRepositoryResponse createRepository(CreateRepositoryRequest createRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryAlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, EcrException
Creates an image repository.
createRepositoryRequest
- 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.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 EC2 Container Registry User Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateRepositoryResponse createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryAlreadyExistsException, LimitExceededException, AwsServiceException, SdkClientException, EcrException
Creates an image repository.
This is a convenience which creates an instance of the CreateRepositoryRequest.Builder
avoiding the need
to create one manually via CreateRepositoryRequest.builder()
createRepositoryRequest
- A Consumer
that will call methods on CreateRepositoryRequest.Builder
to create a request.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.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 EC2 Container Registry User Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes the specified lifecycle policy.
deleteLifecyclePolicyRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes the specified lifecycle policy.
This is a convenience which creates an instance of the DeleteLifecyclePolicyRequest.Builder
avoiding the
need to create one manually via DeleteLifecyclePolicyRequest.builder()
deleteLifecyclePolicyRequest
- A Consumer
that will call methods on DeleteLifecyclePolicyRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteRepositoryResponse deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryNotEmptyException, AwsServiceException, SdkClientException, EcrException
Deletes an existing image repository. If a repository contains images, you must use the force
option
to delete it.
deleteRepositoryRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteRepositoryResponse deleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryNotEmptyException, AwsServiceException, SdkClientException, EcrException
Deletes an existing image repository. If a repository contains images, you must use the force
option
to delete it.
This is a convenience which creates an instance of the DeleteRepositoryRequest.Builder
avoiding the need
to create one manually via DeleteRepositoryRequest.builder()
deleteRepositoryRequest
- A Consumer
that will call methods on DeleteRepositoryRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteRepositoryPolicyResponse deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes the repository policy from a specified repository.
deleteRepositoryPolicyRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteRepositoryPolicyResponse deleteRepositoryPolicy(Consumer<DeleteRepositoryPolicyRequest.Builder> deleteRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Deletes the repository policy from a specified repository.
This is a convenience which creates an instance of the DeleteRepositoryPolicyRequest.Builder
avoiding the
need to create one manually via DeleteRepositoryPolicyRequest.builder()
deleteRepositoryPolicyRequest
- A Consumer
that will call methods on DeleteRepositoryPolicyRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeImagesResponse describeImages(DescribeImagesRequest describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException
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.
describeImagesRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeImagesResponse describeImages(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException
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.
This is a convenience which creates an instance of the DescribeImagesRequest.Builder
avoiding the need to
create one manually via DescribeImagesRequest.builder()
describeImagesRequest
- A Consumer
that will call methods on DescribeImagesRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeImagesIterable describeImagesPaginator(DescribeImagesRequest describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException
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.
This is a variant of describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeImagesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation.
describeImagesRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeImagesIterable describeImagesPaginator(Consumer<DescribeImagesRequest.Builder> describeImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageNotFoundException, AwsServiceException, SdkClientException, EcrException
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.
This is a variant of describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeImagesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecr.paginators.DescribeImagesIterable responses = client.describeImagesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeImages(software.amazon.awssdk.services.ecr.model.DescribeImagesRequest)
operation.
This is a convenience which creates an instance of the DescribeImagesRequest.Builder
avoiding the need to
create one manually via DescribeImagesRequest.builder()
describeImagesRequest
- A Consumer
that will call methods on DescribeImagesRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeRepositoriesResponse describeRepositories() throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Describes image repositories in a registry.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeRepositories(DescribeRepositoriesRequest)
,
AWS API
Documentationdefault DescribeRepositoriesResponse describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Describes image repositories in a registry.
describeRepositoriesRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeRepositoriesResponse describeRepositories(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Describes image repositories in a registry.
This is a convenience which creates an instance of the DescribeRepositoriesRequest.Builder
avoiding the
need to create one manually via DescribeRepositoriesRequest.builder()
describeRepositoriesRequest
- A Consumer
that will call methods on DescribeRepositoriesRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeRepositoriesIterable describeRepositoriesPaginator() throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Describes image repositories in a registry.
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client .describeRepositoriesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeRepositoriesPaginator(DescribeRepositoriesRequest)
,
AWS API
Documentationdefault DescribeRepositoriesIterable describeRepositoriesPaginator(DescribeRepositoriesRequest describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Describes image repositories in a registry.
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client .describeRepositoriesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.
describeRepositoriesRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeRepositoriesIterable describeRepositoriesPaginator(Consumer<DescribeRepositoriesRequest.Builder> describeRepositoriesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Describes image repositories in a registry.
This is a variant of
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client .describeRepositoriesPaginator(request); for (software.amazon.awssdk.services.ecr.model.DescribeRepositoriesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecr.paginators.DescribeRepositoriesIterable responses = client.describeRepositoriesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeRepositories(software.amazon.awssdk.services.ecr.model.DescribeRepositoriesRequest)
operation.
This is a convenience which creates an instance of the DescribeRepositoriesRequest.Builder
avoiding the
need to create one manually via DescribeRepositoriesRequest.builder()
describeRepositoriesRequest
- A Consumer
that will call methods on DescribeRepositoriesRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAuthorizationTokenResponse getAuthorizationToken() throws ServerException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException
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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getAuthorizationToken(GetAuthorizationTokenRequest)
,
AWS API
Documentationdefault GetAuthorizationTokenResponse getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest) throws ServerException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException
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.
getAuthorizationTokenRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetAuthorizationTokenResponse getAuthorizationToken(Consumer<GetAuthorizationTokenRequest.Builder> getAuthorizationTokenRequest) throws ServerException, InvalidParameterException, AwsServiceException, SdkClientException, EcrException
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.
This is a convenience which creates an instance of the GetAuthorizationTokenRequest.Builder
avoiding the
need to create one manually via GetAuthorizationTokenRequest.builder()
getAuthorizationTokenRequest
- A Consumer
that will call methods on GetAuthorizationTokenRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDownloadUrlForLayerResponse getDownloadUrlForLayer(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest) throws ServerException, InvalidParameterException, LayersNotFoundException, LayerInaccessibleException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.
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.
getDownloadUrlForLayerRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDownloadUrlForLayerResponse getDownloadUrlForLayer(Consumer<GetDownloadUrlForLayerRequest.Builder> getDownloadUrlForLayerRequest) throws ServerException, InvalidParameterException, LayersNotFoundException, LayerInaccessibleException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.
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.
This is a convenience which creates an instance of the GetDownloadUrlForLayerRequest.Builder
avoiding the
need to create one manually via GetDownloadUrlForLayerRequest.builder()
getDownloadUrlForLayerRequest
- A Consumer
that will call methods on GetDownloadUrlForLayerRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetLifecyclePolicyResponse getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the specified lifecycle policy.
getLifecyclePolicyRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetLifecyclePolicyResponse getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the specified lifecycle policy.
This is a convenience which creates an instance of the GetLifecyclePolicyRequest.Builder
avoiding the
need to create one manually via GetLifecyclePolicyRequest.builder()
getLifecyclePolicyRequest
- A Consumer
that will call methods on GetLifecyclePolicyRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetLifecyclePolicyPreviewResponse getLifecyclePolicyPreview(GetLifecyclePolicyPreviewRequest getLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyPreviewNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the results of the specified lifecycle policy preview request.
getLifecyclePolicyPreviewRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetLifecyclePolicyPreviewResponse getLifecyclePolicyPreview(Consumer<GetLifecyclePolicyPreviewRequest.Builder> getLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyPreviewNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the results of the specified lifecycle policy preview request.
This is a convenience which creates an instance of the GetLifecyclePolicyPreviewRequest.Builder
avoiding
the need to create one manually via GetLifecyclePolicyPreviewRequest.builder()
getLifecyclePolicyPreviewRequest
- A Consumer
that will call methods on GetLifecyclePolicyPreviewRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetRepositoryPolicyResponse getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the repository policy for a specified repository.
getRepositoryPolicyRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetRepositoryPolicyResponse getRepositoryPolicy(Consumer<GetRepositoryPolicyRequest.Builder> getRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, RepositoryPolicyNotFoundException, AwsServiceException, SdkClientException, EcrException
Retrieves the repository policy for a specified repository.
This is a convenience which creates an instance of the GetRepositoryPolicyRequest.Builder
avoiding the
need to create one manually via GetRepositoryPolicyRequest.builder()
getRepositoryPolicyRequest
- A Consumer
that will call methods on GetRepositoryPolicyRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default InitiateLayerUploadResponse initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
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.
initiateLayerUploadRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default InitiateLayerUploadResponse initiateLayerUpload(Consumer<InitiateLayerUploadRequest.Builder> initiateLayerUploadRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
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.
This is a convenience which creates an instance of the InitiateLayerUploadRequest.Builder
avoiding the
need to create one manually via InitiateLayerUploadRequest.builder()
initiateLayerUploadRequest
- A Consumer
that will call methods on InitiateLayerUploadRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListImagesResponse listImages(ListImagesRequest listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
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.
listImagesRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListImagesResponse listImages(Consumer<ListImagesRequest.Builder> listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
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.
This is a convenience which creates an instance of the ListImagesRequest.Builder
avoiding the need to
create one manually via ListImagesRequest.builder()
listImagesRequest
- A Consumer
that will call methods on ListImagesRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListImagesIterable listImagesPaginator(ListImagesRequest listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
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.
This is a variant of listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request); for (software.amazon.awssdk.services.ecr.model.ListImagesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)
operation.
listImagesRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListImagesIterable listImagesPaginator(Consumer<ListImagesRequest.Builder> listImagesRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
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.
This is a variant of listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request); for (software.amazon.awssdk.services.ecr.model.ListImagesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecr.paginators.ListImagesIterable responses = client.listImagesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listImages(software.amazon.awssdk.services.ecr.model.ListImagesRequest)
operation.
This is a convenience which creates an instance of the ListImagesRequest.Builder
avoiding the need to
create one manually via ListImagesRequest.builder()
listImagesRequest
- A Consumer
that will call methods on ListImagesRequest.Builder
to create a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutImageResponse putImage(PutImageRequest putImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageAlreadyExistsException, LayersNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, EcrException
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.
putImageRequest
- 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 EC2 Container Registry User Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutImageResponse putImage(Consumer<PutImageRequest.Builder> putImageRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, ImageAlreadyExistsException, LayersNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, EcrException
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.
This is a convenience which creates an instance of the PutImageRequest.Builder
avoiding the need to
create one manually via PutImageRequest.builder()
putImageRequest
- A Consumer
that will call methods on PutImageRequest.Builder
to create a request.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 EC2 Container Registry User Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutLifecyclePolicyResponse putLifecyclePolicy(PutLifecyclePolicyRequest putLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Creates or updates a lifecycle policy.
putLifecyclePolicyRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutLifecyclePolicyResponse putLifecyclePolicy(Consumer<PutLifecyclePolicyRequest.Builder> putLifecyclePolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Creates or updates a lifecycle policy.
This is a convenience which creates an instance of the PutLifecyclePolicyRequest.Builder
avoiding the
need to create one manually via PutLifecyclePolicyRequest.builder()
putLifecyclePolicyRequest
- A Consumer
that will call methods on PutLifecyclePolicyRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SetRepositoryPolicyResponse setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Applies a repository policy on a specified repository to control access permissions.
setRepositoryPolicyRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SetRepositoryPolicyResponse setRepositoryPolicy(Consumer<SetRepositoryPolicyRequest.Builder> setRepositoryPolicyRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, AwsServiceException, SdkClientException, EcrException
Applies a repository policy on a specified repository to control access permissions.
This is a convenience which creates an instance of the SetRepositoryPolicyRequest.Builder
avoiding the
need to create one manually via SetRepositoryPolicyRequest.builder()
setRepositoryPolicyRequest
- A Consumer
that will call methods on SetRepositoryPolicyRequest.Builder
to create a
request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartLifecyclePolicyPreviewResponse startLifecyclePolicyPreview(StartLifecyclePolicyPreviewRequest startLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, LifecyclePolicyPreviewInProgressException, AwsServiceException, SdkClientException, EcrException
Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy.
startLifecyclePolicyPreviewRequest
- 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartLifecyclePolicyPreviewResponse startLifecyclePolicyPreview(Consumer<StartLifecyclePolicyPreviewRequest.Builder> startLifecyclePolicyPreviewRequest) throws ServerException, InvalidParameterException, RepositoryNotFoundException, LifecyclePolicyNotFoundException, LifecyclePolicyPreviewInProgressException, AwsServiceException, SdkClientException, EcrException
Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy.
This is a convenience which creates an instance of the StartLifecyclePolicyPreviewRequest.Builder
avoiding the need to create one manually via StartLifecyclePolicyPreviewRequest.builder()
startLifecyclePolicyPreviewRequest
- A Consumer
that will call methods on StartLifecyclePolicyPreviewRequest.Builder
to create
a request.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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UploadLayerPartResponse uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest) throws ServerException, InvalidParameterException, InvalidLayerPartException, RepositoryNotFoundException, UploadNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, EcrException
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.
uploadLayerPartRequest
- 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 EC2 Container Registry User Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UploadLayerPartResponse uploadLayerPart(Consumer<UploadLayerPartRequest.Builder> uploadLayerPartRequest) throws ServerException, InvalidParameterException, InvalidLayerPartException, RepositoryNotFoundException, UploadNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, EcrException
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.
This is a convenience which creates an instance of the UploadLayerPartRequest.Builder
avoiding the need
to create one manually via UploadLayerPartRequest.builder()
uploadLayerPartRequest
- A Consumer
that will call methods on UploadLayerPartRequest.Builder
to create a request.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 EC2 Container Registry User Guide.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.EcrException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.