amazonaws.com – ecr

OpenAPI apis-guru cloud

Amazon Elastic Container Registry

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 in the Amazon Web Services General Reference.

Homepage: https://api.apis.guru/v2/specs/amazonaws.com:ecr/2015-09-21.json
Provider: amazonaws.com:ecr / ecr
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/amazonaws.com/ecr/2015-09-21/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/amazonaws.com/ecr/2015-09-21/openapi.yaml

Tools (43)

Extracted live via the executor SDK.

xAmzTargetAmazonEC2ContainerRegistryV20150921BatchCheckLayerAvailability.batchCheckLayerAvailability

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.
xAmzTargetAmazonEC2ContainerRegistryV20150921BatchDeleteImage.batchDeleteImage

Deletes 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.
xAmzTargetAmazonEC2ContainerRegistryV20150921BatchGetImage.batchGetImage

Gets 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.
xAmzTargetAmazonEC2ContainerRegistryV20150921BatchGetRepositoryScanningConfiguration.batchGetRepositoryScanningConfiguration

Gets the scanning configuration for one or more repositories.
xAmzTargetAmazonEC2ContainerRegistryV20150921CompleteLayerUpload.completeLayerUpload

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.

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.
xAmzTargetAmazonEC2ContainerRegistryV20150921CreatePullThroughCacheRule.createPullThroughCacheRule

Creates 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.
xAmzTargetAmazonEC2ContainerRegistryV20150921CreateRepository.createRepository

Creates a repository. For more information, see in the Amazon Elastic Container Registry User Guide.
xAmzTargetAmazonEC2ContainerRegistryV20150921DeleteLifecyclePolicy.deleteLifecyclePolicy

Deletes the lifecycle policy associated with the specified repository.
xAmzTargetAmazonEC2ContainerRegistryV20150921DeletePullThroughCacheRule.deletePullThroughCacheRule

Deletes a pull through cache rule.
xAmzTargetAmazonEC2ContainerRegistryV20150921DeleteRegistryPolicy.deleteRegistryPolicy

Deletes the registry permissions policy.
xAmzTargetAmazonEC2ContainerRegistryV20150921DeleteRepository.deleteRepository

Deletes 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.
xAmzTargetAmazonEC2ContainerRegistryV20150921DeleteRepositoryPolicy.deleteRepositoryPolicy

Deletes the repository policy associated with the specified repository.
xAmzTargetAmazonEC2ContainerRegistryV20150921DescribeImageReplicationStatus.describeImageReplicationStatus

Returns the replication status for a specified image.
xAmzTargetAmazonEC2ContainerRegistryV20150921DescribeImages.describeImages

Returns 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 [blocked].
xAmzTargetAmazonEC2ContainerRegistryV20150921DescribeImageScanFindings.describeImageScanFindings

Returns the scan findings for the specified image.
xAmzTargetAmazonEC2ContainerRegistryV20150921DescribePullThroughCacheRules.describePullThroughCacheRules

Returns the pull through cache rules for a registry.
xAmzTargetAmazonEC2ContainerRegistryV20150921DescribeRegistry.describeRegistry

Describes the settings for a registry. The replication configuration for a repository can be created or updated with the PutReplicationConfiguration [blocked] API action.
xAmzTargetAmazonEC2ContainerRegistryV20150921DescribeRepositories.describeRepositories

Describes image repositories in a registry.
xAmzTargetAmazonEC2ContainerRegistryV20150921GetAuthorizationToken.getAuthorizationToken

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 in the Amazon Elastic Container Registry User Guide.
xAmzTargetAmazonEC2ContainerRegistryV20150921GetDownloadUrlForLayer.getDownloadUrlForLayer

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.

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.
xAmzTargetAmazonEC2ContainerRegistryV20150921GetLifecyclePolicy.getLifecyclePolicy

Retrieves the lifecycle policy for the specified repository.
xAmzTargetAmazonEC2ContainerRegistryV20150921GetLifecyclePolicyPreview.getLifecyclePolicyPreview

Retrieves the results of the lifecycle policy preview request for the specified repository.
xAmzTargetAmazonEC2ContainerRegistryV20150921GetRegistryPolicy.getRegistryPolicy

Retrieves the permissions policy for a registry.
xAmzTargetAmazonEC2ContainerRegistryV20150921GetRegistryScanningConfiguration.getRegistryScanningConfiguration

Retrieves the scanning configuration for a registry.
xAmzTargetAmazonEC2ContainerRegistryV20150921GetRepositoryPolicy.getRepositoryPolicy

Retrieves the repository policy for the specified repository.
xAmzTargetAmazonEC2ContainerRegistryV20150921InitiateLayerUpload.initiateLayerUpload

Notifies 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.
xAmzTargetAmazonEC2ContainerRegistryV20150921ListImages.listImages

Lists 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 [blocked] operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.
xAmzTargetAmazonEC2ContainerRegistryV20150921ListTagsForResource.listTagsForResource

List the tags for an Amazon ECR resource.
xAmzTargetAmazonEC2ContainerRegistryV20150921PutImage.putImage

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

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.
xAmzTargetAmazonEC2ContainerRegistryV20150921PutImageScanningConfiguration.putImageScanningConfiguration

The PutImageScanningConfiguration API is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see PutRegistryScanningConfiguration [blocked].

Updates the image scanning configuration for the specified repository.
xAmzTargetAmazonEC2ContainerRegistryV20150921PutImageTagMutability.putImageTagMutability

Updates the image tag mutability settings for the specified repository. For more information, see in the Amazon Elastic Container Registry User Guide.
xAmzTargetAmazonEC2ContainerRegistryV20150921PutLifecyclePolicy.putLifecyclePolicy

Creates or updates the lifecycle policy for the specified repository. For more information, see .
xAmzTargetAmazonEC2ContainerRegistryV20150921PutRegistryPolicy.putRegistryPolicy

Creates 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 in the Amazon Elastic Container Registry User Guide.
xAmzTargetAmazonEC2ContainerRegistryV20150921PutRegistryScanningConfiguration.putRegistryScanningConfiguration

Creates or updates the scanning configuration for your private registry.
xAmzTargetAmazonEC2ContainerRegistryV20150921PutReplicationConfiguration.putReplicationConfiguration

Creates or updates the replication configuration for a registry. The existing replication configuration for a repository can be retrieved with the DescribeRegistry [blocked] 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 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 [blocked].
xAmzTargetAmazonEC2ContainerRegistryV20150921SetRepositoryPolicy.setRepositoryPolicy

Applies a repository policy to the specified repository to control access permissions. For more information, see in the Amazon Elastic Container Registry User Guide.
xAmzTargetAmazonEC2ContainerRegistryV20150921StartImageScan.startImageScan

Starts 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 in the Amazon Elastic Container Registry User Guide.
xAmzTargetAmazonEC2ContainerRegistryV20150921StartLifecyclePolicyPreview.startLifecyclePolicyPreview

Starts 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.
xAmzTargetAmazonEC2ContainerRegistryV20150921TagResource.tagResource

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.
xAmzTargetAmazonEC2ContainerRegistryV20150921UntagResource.untagResource

Deletes specified tags from a resource.
xAmzTargetAmazonEC2ContainerRegistryV20150921UploadLayerPart.uploadLayerPart

Uploads 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.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools