@ThreadSafe public class AmazonECRClient extends AmazonWebServiceClient implements AmazonECR
Amazon EC2 Container Registry (Amazon ECR) is a managed AWS 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 AWS 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 |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to
this client
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AmazonECRClient()
Constructs a new client to invoke service methods on Amazon ECR.
|
AmazonECRClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon ECR using the
specified AWS account credentials.
|
AmazonECRClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon ECR using the
specified AWS account credentials and client configuration options.
|
AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon ECR using the
specified AWS account credentials provider.
|
AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon ECR using the
specified AWS account credentials provider and client configuration
options.
|
AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Amazon ECR using the
specified AWS account credentials provider, client configuration options,
and request metric collector.
|
AmazonECRClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon ECR.
|
Modifier and Type | Method and Description |
---|---|
BatchCheckLayerAvailabilityResult |
batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest)
Check the availability of multiple image layers in a specified registry
and repository.
|
BatchDeleteImageResult |
batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest)
Deletes a list of specified images within a specified repository.
|
BatchGetImageResult |
batchGetImage(BatchGetImageRequest batchGetImageRequest)
Gets detailed information for specified images within a specified
repository.
|
CompleteLayerUploadResult |
completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest)
Inform Amazon ECR that the image layer upload for a specified registry,
repository name, and upload ID, has completed.
|
CreateRepositoryResult |
createRepository(CreateRepositoryRequest createRepositoryRequest)
Creates an image repository.
|
DeleteRepositoryResult |
deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)
Deletes an existing image repository.
|
DeleteRepositoryPolicyResult |
deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest)
Deletes the repository policy from a specified repository.
|
DescribeRepositoriesResult |
describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest)
Describes image repositories in a registry.
|
GetAuthorizationTokenResult |
getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest)
Retrieves a token that is valid for a specified registry for 12 hours.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful,
request, typically used for debugging issues where a service isn't acting
as expected.
|
GetDownloadUrlForLayerResult |
getDownloadUrlForLayer(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest)
Retrieves the pre-signed Amazon S3 download URL corresponding to an image
layer.
|
GetRepositoryPolicyResult |
getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest)
Retrieves the repository policy for a specified repository.
|
InitiateLayerUploadResult |
initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest)
Notify Amazon ECR that you intend to upload an image layer.
|
ListImagesResult |
listImages(ListImagesRequest listImagesRequest)
Lists all the image IDs for a given repository.
|
PutImageResult |
putImage(PutImageRequest putImageRequest)
Creates or updates the image manifest associated with an image.
|
SetRepositoryPolicyResult |
setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest)
Applies a repository policy on a specified repository to control access
permissions.
|
UploadLayerPartResult |
uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest)
Uploads an image layer part to Amazon ECR.
|
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected static final ClientConfigurationFactory configFactory
public AmazonECRClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonECRClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client
connects to Amazon ECR (ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonECRClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.public AmazonECRClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to Amazon ECR (ex: proxy settings, retry counts, etc.).public AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.public AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to Amazon ECR (ex: proxy settings, retry counts, etc.).public AmazonECRClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to Amazon ECR (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic BatchCheckLayerAvailabilityResult batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest)
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. Use the docker
CLI to pull,
tag, and push images.
batchCheckLayerAvailability
in interface AmazonECR
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.public BatchDeleteImageResult batchDeleteImage(BatchDeleteImageRequest batchDeleteImageRequest)
Deletes a list of specified images within a specified repository. Images
are specified with either imageTag
or
imageDigest
.
batchDeleteImage
in interface AmazonECR
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.public BatchGetImageResult batchGetImage(BatchGetImageRequest batchGetImageRequest)
Gets detailed information for specified images within a specified
repository. Images are specified with either imageTag
or
imageDigest
.
batchGetImage
in interface AmazonECR
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.public CompleteLayerUploadResult completeLayerUpload(CompleteLayerUploadRequest completeLayerUploadRequest)
Inform Amazon ECR that the image layer upload for a specified registry,
repository name, and upload ID, has completed. You can optionally provide
a sha256
digest of the image layer for data validation
purposes.
This operation is used by the Amazon ECR proxy, and it is not intended
for general use by customers. Use the docker
CLI to pull,
tag, and push images.
completeLayerUpload
in interface AmazonECR
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.public CreateRepositoryResult createRepository(CreateRepositoryRequest createRepositoryRequest)
Creates an image repository.
createRepository
in interface AmazonECR
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.public DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)
Deletes an existing image repository. If a repository contains images,
you must use the force
option to delete it.
deleteRepository
in interface AmazonECR
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.public DeleteRepositoryPolicyResult deleteRepositoryPolicy(DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest)
Deletes the repository policy from a specified repository.
deleteRepositoryPolicy
in interface AmazonECR
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.public DescribeRepositoriesResult describeRepositories(DescribeRepositoriesRequest describeRepositoriesRequest)
Describes image repositories in a registry.
describeRepositories
in interface AmazonECR
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.public GetAuthorizationTokenResult getAuthorizationToken(GetAuthorizationTokenRequest getAuthorizationTokenRequest)
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.
getAuthorizationToken
in interface AmazonECR
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.public GetDownloadUrlForLayerResult getDownloadUrlForLayer(GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest)
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. Use the docker
CLI to pull,
tag, and push images.
getDownloadUrlForLayer
in interface AmazonECR
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.public GetRepositoryPolicyResult getRepositoryPolicy(GetRepositoryPolicyRequest getRepositoryPolicyRequest)
Retrieves the repository policy for a specified repository.
getRepositoryPolicy
in interface AmazonECR
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.public InitiateLayerUploadResult initiateLayerUpload(InitiateLayerUploadRequest initiateLayerUploadRequest)
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. Use the docker
CLI to pull,
tag, and push images.
initiateLayerUpload
in interface AmazonECR
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.public ListImagesResult listImages(ListImagesRequest listImagesRequest)
Lists all the image IDs for a given repository.
listImages
in interface AmazonECR
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.public PutImageResult putImage(PutImageRequest putImageRequest)
Creates or updates the image manifest associated with an image.
This operation is used by the Amazon ECR proxy, and it is not intended
for general use by customers. Use the docker
CLI to pull,
tag, and push images.
putImage
in interface AmazonECR
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 are no
changes to the manifest or image tag since 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.public SetRepositoryPolicyResult setRepositoryPolicy(SetRepositoryPolicyRequest setRepositoryPolicyRequest)
Applies a repository policy on a specified repository to control access permissions.
setRepositoryPolicy
in interface AmazonECR
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.public UploadLayerPartResult uploadLayerPart(UploadLayerPartRequest uploadLayerPartRequest)
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. Use the docker
CLI to pull,
tag, and push images.
uploadLayerPart
in interface AmazonECR
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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonECR
request
- The originally executed requestCopyright © 2018. All rights reserved.