Readonly configThe resolved configuration of ECRClient class. This is resolved and normalized from the constructor configuration interface.
Checks the availability of one or more image layers in a repository.
When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.
This operation is used by the Amazon ECR proxy and is not generally used by
customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
Optional options: HttpHandlerOptionsOptional data: BatchCheckLayerAvailabilityCommandOutputOptional data: BatchCheckLayerAvailabilityCommandOutputDeletes a list of specified images within a repository. Images are specified with
either an 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.
Optional options: HttpHandlerOptionsOptional data: BatchDeleteImageCommandOutputOptional data: BatchDeleteImageCommandOutputGets detailed information for an image. Images are specified with either an
imageTag or imageDigest.
When an image is pulled, the BatchGetImage API is called once to retrieve the image manifest.
Optional options: HttpHandlerOptionsOptional data: BatchGetImageCommandOutputOptional data: BatchGetImageCommandOutputGets the scanning configuration for one or more repositories.
Optional options: HttpHandlerOptionsOptional data: BatchGetRepositoryScanningConfigurationCommandOutputOptional data: BatchGetRepositoryScanningConfigurationCommandOutputInforms 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.
When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.
This operation is used by the Amazon ECR proxy and is not generally used by
customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
Optional options: HttpHandlerOptionsOptional data: CompleteLayerUploadCommandOutputOptional data: CompleteLayerUploadCommandOutputCreates a pull through cache rule. A pull through cache rule provides a way to cache images from an external public registry in your Amazon ECR private registry.
Optional options: HttpHandlerOptionsOptional data: CreatePullThroughCacheRuleCommandOutputOptional data: CreatePullThroughCacheRuleCommandOutputCreates a repository. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
Optional options: HttpHandlerOptionsOptional data: CreateRepositoryCommandOutputOptional data: CreateRepositoryCommandOutputDeletes the lifecycle policy associated with the specified repository.
Optional options: HttpHandlerOptionsOptional data: DeleteLifecyclePolicyCommandOutputOptional data: DeleteLifecyclePolicyCommandOutputDeletes a pull through cache rule.
Optional options: HttpHandlerOptionsOptional data: DeletePullThroughCacheRuleCommandOutputOptional data: DeletePullThroughCacheRuleCommandOutputDeletes the registry permissions policy.
Optional options: HttpHandlerOptionsOptional data: DeleteRegistryPolicyCommandOutputOptional data: DeleteRegistryPolicyCommandOutputDeletes a repository. If the repository contains images, you must either delete all
images in the repository or use the force option to delete the
repository.
Optional options: HttpHandlerOptionsOptional data: DeleteRepositoryCommandOutputOptional data: DeleteRepositoryCommandOutputDeletes the repository policy associated with the specified repository.
Optional options: HttpHandlerOptionsOptional data: DeleteRepositoryPolicyCommandOutputOptional data: DeleteRepositoryPolicyCommandOutputReturns the replication status for a specified image.
Optional options: HttpHandlerOptionsOptional data: DescribeImageReplicationStatusCommandOutputOptional data: DescribeImageReplicationStatusCommandOutputReturns the scan findings for the specified image.
Optional options: HttpHandlerOptionsOptional data: DescribeImageScanFindingsCommandOutputOptional data: DescribeImageScanFindingsCommandOutputReturns metadata about the images in a repository.
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.
Optional options: HttpHandlerOptionsOptional data: DescribeImagesCommandOutputOptional data: DescribeImagesCommandOutputReturns the pull through cache rules for a registry.
Optional options: HttpHandlerOptionsOptional data: DescribePullThroughCacheRulesCommandOutputOptional data: DescribePullThroughCacheRulesCommandOutputDescribes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration API action.
Optional options: HttpHandlerOptionsOptional data: DescribeRegistryCommandOutputOptional data: DescribeRegistryCommandOutputDescribes image repositories in a registry.
Optional options: HttpHandlerOptionsOptional data: DescribeRepositoriesCommandOutputOptional data: DescribeRepositoriesCommandOutputDestroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.
Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.
The authorizationToken returned is a base64 encoded string that can be
decoded and used in a docker login command to authenticate to a registry.
The CLI offers an get-login-password command that simplifies the login
process. For more information, see Registry
authentication in the Amazon Elastic Container Registry User Guide.
Optional options: HttpHandlerOptionsOptional data: GetAuthorizationTokenCommandOutputOptional data: GetAuthorizationTokenCommandOutputRetrieves 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.
When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached.
This operation is used by the Amazon ECR proxy and is not generally used by
customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
Optional options: HttpHandlerOptionsOptional data: GetDownloadUrlForLayerCommandOutputOptional data: GetDownloadUrlForLayerCommandOutputRetrieves the lifecycle policy for the specified repository.
Optional options: HttpHandlerOptionsOptional data: GetLifecyclePolicyCommandOutputOptional data: GetLifecyclePolicyCommandOutputRetrieves the results of the lifecycle policy preview request for the specified repository.
Optional options: HttpHandlerOptionsOptional data: GetLifecyclePolicyPreviewCommandOutputOptional data: GetLifecyclePolicyPreviewCommandOutputRetrieves the permissions policy for a registry.
Optional options: HttpHandlerOptionsOptional data: GetRegistryPolicyCommandOutputOptional data: GetRegistryPolicyCommandOutputRetrieves the scanning configuration for a registry.
Optional options: HttpHandlerOptionsOptional data: GetRegistryScanningConfigurationCommandOutputOptional data: GetRegistryScanningConfigurationCommandOutputRetrieves the repository policy for the specified repository.
Optional options: HttpHandlerOptionsOptional data: GetRepositoryPolicyCommandOutputOptional data: GetRepositoryPolicyCommandOutputNotifies Amazon ECR that you intend to upload an image layer.
When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.
This operation is used by the Amazon ECR proxy and is not generally used by
customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
Optional options: HttpHandlerOptionsOptional data: InitiateLayerUploadCommandOutputOptional data: InitiateLayerUploadCommandOutputLists all the image IDs for the specified repository.
You can filter images based on whether or not they are tagged by using the
tagStatus filter and specifying either TAGGED,
UNTAGGED or ANY. 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.
Optional options: HttpHandlerOptionsOptional data: ListImagesCommandOutputOptional data: ListImagesCommandOutputList the tags for an Amazon ECR resource.
Optional options: HttpHandlerOptionsOptional data: ListTagsForResourceCommandOutputOptional data: ListTagsForResourceCommandOutputCreates or updates the image manifest and tags associated with an image.
When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.
<note>
<p>This operation is used by the Amazon ECR proxy and is not generally used by
customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p>
</note>
Optional options: HttpHandlerOptionsOptional data: PutImageCommandOutputOptional data: PutImageCommandOutputThe PutImageScanningConfiguration API is being deprecated, in favor
of specifying the image scanning configuration at the registry level. For more
information, see PutRegistryScanningConfiguration.
Updates the image scanning configuration for the specified repository.
Optional options: HttpHandlerOptionsOptional data: PutImageScanningConfigurationCommandOutputOptional data: PutImageScanningConfigurationCommandOutputUpdates the image tag mutability settings for the specified repository. For more information, see Image tag mutability in the Amazon Elastic Container Registry User Guide.
Optional options: HttpHandlerOptionsOptional data: PutImageTagMutabilityCommandOutputOptional data: PutImageTagMutabilityCommandOutputCreates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle policy template.
Optional options: HttpHandlerOptionsOptional data: PutLifecyclePolicyCommandOutputOptional data: PutLifecyclePolicyCommandOutputCreates or updates the permissions policy for your registry.
A registry policy is used to specify permissions for another Amazon Web Services account and is used when configuring cross-account replication. For more information, see Registry permissions in the Amazon Elastic Container Registry User Guide.
Optional options: HttpHandlerOptionsOptional data: PutRegistryPolicyCommandOutputOptional data: PutRegistryPolicyCommandOutputCreates or updates the scanning configuration for your private registry.
Optional options: HttpHandlerOptionsOptional data: PutRegistryScanningConfigurationCommandOutputOptional data: PutRegistryScanningConfigurationCommandOutputCreates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry API action. The first time the PutReplicationConfiguration API is called, a service-linked IAM role is created in your account for the replication process. For more information, see Using service-linked roles for Amazon ECR in the Amazon Elastic Container Registry User Guide.
When configuring cross-account replication, the destination account must grant the source account permission to replicate. This permission is controlled using a registry permissions policy. For more information, see PutRegistryPolicy.
Optional options: HttpHandlerOptionsOptional data: PutReplicationConfigurationCommandOutputOptional data: PutReplicationConfigurationCommandOutputOptional options: HttpHandlerOptionsOptional data: OutputTypeOptional data: OutputTypeApplies a repository policy to the specified repository to control access permissions. For more information, see Amazon ECR Repository policies in the Amazon Elastic Container Registry User Guide.
Optional options: HttpHandlerOptionsOptional data: SetRepositoryPolicyCommandOutputOptional data: SetRepositoryPolicyCommandOutputStarts an image vulnerability scan. An image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image scanning in the Amazon Elastic Container Registry User Guide.
Optional options: HttpHandlerOptionsOptional data: StartImageScanCommandOutputOptional data: StartImageScanCommandOutputStarts a preview of a lifecycle policy for the specified repository. This allows you to see the results before associating the lifecycle policy with the repository.
Optional options: HttpHandlerOptionsOptional data: StartLifecyclePolicyPreviewCommandOutputOptional data: StartLifecyclePolicyPreviewCommandOutputAdds 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.
Optional options: HttpHandlerOptionsOptional data: TagResourceCommandOutputOptional data: TagResourceCommandOutputDeletes specified tags from a resource.
Optional options: HttpHandlerOptionsOptional data: UntagResourceCommandOutputOptional data: UntagResourceCommandOutputUploads an image layer part to Amazon ECR.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part.
This operation is used by the Amazon ECR proxy and is not generally used by
customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
Optional options: HttpHandlerOptionsOptional data: UploadLayerPartCommandOutputOptional data: UploadLayerPartCommandOutput
Amazon Elastic Container Registry (Amazon ECR) is a managed container image registry service. Customers can use the familiar Docker CLI, or their preferred client, to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry for your Docker or Open Container Initiative (OCI) images. Amazon ECR supports private repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images.
Amazon ECR has service endpoints in each supported Region. For more information, see Amazon ECR endpoints in the Amazon Web Services General Reference.