Class: AWS.ECR
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.ECR
- Identifier:
- ecr
- API Version:
- 2015-09-21
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Amazon Elastic Container Registry (Amazon ECR) is a managed Docker registry service. Customers can use the familiar Docker CLI to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry. Amazon ECR supports private Docker repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images. Developers can use the Docker CLI to author and manage images.
Sending a Request Using ECR
var ecr = new AWS.ECR();
ecr.batchCheckLayerAvailability(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the ECR object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var ecr = new AWS.ECR({apiVersion: '2015-09-21'});
You can also set the API version globally in AWS.config.apiVersions
using
the ecr service identifier:
AWS.config.apiVersions = {
ecr: '2015-09-21',
// other service API versions
};
var ecr = new AWS.ECR();
Constructor Summary
-
new AWS.ECR(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary
-
batchCheckLayerAvailability(params = {}, callback) ⇒ AWS.Request
Check the availability of multiple image layers in a specified registry and repository.
-
batchDeleteImage(params = {}, callback) ⇒ AWS.Request
Deletes a list of specified images within a specified repository.
-
batchGetImage(params = {}, callback) ⇒ AWS.Request
Gets detailed information for specified images within a specified repository.
-
completeLayerUpload(params = {}, callback) ⇒ AWS.Request
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID.
-
createRepository(params = {}, callback) ⇒ AWS.Request
Creates an image repository.
-
deleteLifecyclePolicy(params = {}, callback) ⇒ AWS.Request
Deletes the specified lifecycle policy.
-
deleteRepository(params = {}, callback) ⇒ AWS.Request
Deletes an existing image repository.
-
deleteRepositoryPolicy(params = {}, callback) ⇒ AWS.Request
Deletes the repository policy from a specified repository.
-
describeImages(params = {}, callback) ⇒ AWS.Request
Returns metadata about the images in a repository, including image size, image tags, and creation date.
-
describeRepositories(params = {}, callback) ⇒ AWS.Request
Describes image repositories in a registry.
-
getAuthorizationToken(params = {}, callback) ⇒ AWS.Request
Retrieves a token that is valid for a specified registry for 12 hours.
-
getDownloadUrlForLayer(params = {}, callback) ⇒ AWS.Request
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.
-
getLifecyclePolicy(params = {}, callback) ⇒ AWS.Request
Retrieves the specified lifecycle policy.
-
getLifecyclePolicyPreview(params = {}, callback) ⇒ AWS.Request
Retrieves the results of the specified lifecycle policy preview request.
-
getRepositoryPolicy(params = {}, callback) ⇒ AWS.Request
Retrieves the repository policy for a specified repository.
-
initiateLayerUpload(params = {}, callback) ⇒ AWS.Request
Notify Amazon ECR that you intend to upload an image layer.
-
listImages(params = {}, callback) ⇒ AWS.Request
Lists all the image IDs for a given repository.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
List the tags for an Amazon ECR resource.
-
putImage(params = {}, callback) ⇒ AWS.Request
Creates or updates the image manifest and tags associated with an image.
-
putLifecyclePolicy(params = {}, callback) ⇒ AWS.Request
Creates or updates a lifecycle policy.
-
setRepositoryPolicy(params = {}, callback) ⇒ AWS.Request
Applies a repository policy on a specified repository to control access permissions.
-
startLifecyclePolicyPreview(params = {}, callback) ⇒ AWS.Request
Starts a preview of the specified lifecycle policy.
-
tagResource(params = {}, callback) ⇒ AWS.Request
Adds specified tags to a resource with the specified ARN.
-
untagResource(params = {}, callback) ⇒ AWS.Request
Deletes specified tags from a resource.
-
uploadLayerPart(params = {}, callback) ⇒ AWS.Request
Uploads an image layer part to Amazon ECR.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
Property Details
Method Details
batchCheckLayerAvailability(params = {}, callback) ⇒ AWS.Request
Check the availability of multiple image layers in a specified registry and repository.
docker
CLI to pull, tag, and push images. batchDeleteImage(params = {}, callback) ⇒ AWS.Request
Deletes a list of specified images within a specified repository. Images are specified with either imageTag
or imageDigest
.
You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
You can completely delete an image (and all of its tags) by specifying the image's digest in your request.
batchGetImage(params = {}, callback) ⇒ AWS.Request
Gets detailed information for specified images within a specified repository. Images are specified with either imageTag
or imageDigest
.
completeLayerUpload(params = {}, callback) ⇒ AWS.Request
Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256
digest of the image layer for data validation purposes.
docker
CLI to pull, tag, and push images. deleteRepository(params = {}, callback) ⇒ AWS.Request
Deletes an existing image repository. If a repository contains images, you must use the force
option to delete it.
deleteRepositoryPolicy(params = {}, callback) ⇒ AWS.Request
Deletes the repository policy from a specified repository.
describeImages(params = {}, callback) ⇒ AWS.Request
Returns metadata about the images in a repository, including image size, image tags, and creation date.
docker images
command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages. describeRepositories(params = {}, callback) ⇒ AWS.Request
Describes image repositories in a registry.
getAuthorizationToken(params = {}, callback) ⇒ AWS.Request
Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the docker
CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed.
The authorizationToken
returned for each registry specified is a base64 encoded string that can be decoded and used in a docker login
command to authenticate to a registry. The AWS CLI offers an aws ecr get-login
command that simplifies the login process.
getDownloadUrlForLayer(params = {}, callback) ⇒ AWS.Request
Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.
docker
CLI to pull, tag, and push images. getLifecyclePolicyPreview(params = {}, callback) ⇒ AWS.Request
Retrieves the results of the specified lifecycle policy preview request.
getRepositoryPolicy(params = {}, callback) ⇒ AWS.Request
Retrieves the repository policy for a specified repository.
initiateLayerUpload(params = {}, callback) ⇒ AWS.Request
Notify Amazon ECR that you intend to upload an image layer.
docker
CLI to pull, tag, and push images. listImages(params = {}, callback) ⇒ AWS.Request
Lists all the image IDs for a given repository.
You can filter images based on whether or not they are tagged by setting the tagStatus
parameter to TAGGED
or UNTAGGED
. For example, you can filter your results to return only UNTAGGED
images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED
images to list all of the tags in your repository.
putImage(params = {}, callback) ⇒ AWS.Request
Creates or updates the image manifest and tags associated with an image.
docker
CLI to pull, tag, and push images. putLifecyclePolicy(params = {}, callback) ⇒ AWS.Request
Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see Lifecycle Policy Template.
setRepositoryPolicy(params = {}, callback) ⇒ AWS.Request
Applies a repository policy on a specified repository to control access permissions.
startLifecyclePolicyPreview(params = {}, callback) ⇒ AWS.Request
Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy.
tagResource(params = {}, callback) ⇒ AWS.Request
Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.
uploadLayerPart(params = {}, callback) ⇒ AWS.Request
Uploads an image layer part to Amazon ECR.
docker
CLI to pull, tag, and push images.