# Amazon Elastic Container Registry API Reference

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

- [Welcome](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/Welcome.md)
- [Common Parameters](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/CommonParameters.md)
- [Common Error Types](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/CommonErrors.md)

## [Actions](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Operations.md)

- [BatchCheckLayerAvailability](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_BatchCheckLayerAvailability.md): Checks the availability of one or more image layers in a repository.
- [BatchDeleteImage](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_BatchDeleteImage.md): Deletes a list of specified images within a repository.
- [BatchGetImage](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_BatchGetImage.md): Gets detailed information for an image.
- [BatchGetRepositoryScanningConfiguration](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_BatchGetRepositoryScanningConfiguration.md): Gets the scanning configuration for one or more repositories.
- [CompleteLayerUpload](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_CompleteLayerUpload.md): Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID.
- [CreatePullThroughCacheRule](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_CreatePullThroughCacheRule.md): Creates a pull through cache rule.
- [CreateRepository](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_CreateRepository.md): Creates a repository.
- [CreateRepositoryCreationTemplate](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_CreateRepositoryCreationTemplate.md): Creates a repository creation template.
- [DeleteLifecyclePolicy](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DeleteLifecyclePolicy.md): Deletes the lifecycle policy associated with the specified repository.
- [DeletePullThroughCacheRule](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DeletePullThroughCacheRule.md): Deletes a pull through cache rule.
- [DeleteRegistryPolicy](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DeleteRegistryPolicy.md): Deletes the registry permissions policy.
- [DeleteRepository](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DeleteRepository.md): Deletes a repository.
- [DeleteRepositoryCreationTemplate](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DeleteRepositoryCreationTemplate.md): Deletes a repository creation template.
- [DeleteRepositoryPolicy](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DeleteRepositoryPolicy.md): Deletes the repository policy associated with the specified repository.
- [DeleteSigningConfiguration](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DeleteSigningConfiguration.md): Deletes the registry's signing configuration.
- [DeregisterPullTimeUpdateExclusion](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DeregisterPullTimeUpdateExclusion.md): Removes a principal from the pull time update exclusion list for a registry.
- [DescribeImageReplicationStatus](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DescribeImageReplicationStatus.md): Returns the replication status for a specified image.
- [DescribeImages](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DescribeImages.md): Returns metadata about the images in a repository.
- [DescribeImageScanFindings](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DescribeImageScanFindings.md): Returns the scan findings for the specified image.
- [DescribeImageSigningStatus](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DescribeImageSigningStatus.md): Returns the signing status for a specified image.
- [DescribePullThroughCacheRules](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DescribePullThroughCacheRules.md): Returns the pull through cache rules for a registry.
- [DescribeRegistry](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DescribeRegistry.md): Describes the settings for a registry.
- [DescribeReplicationBackfillResults](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DescribeReplicationBackfillResults.md): Returns the status, progress, and per-image results for a replication backfill.
- [DescribeRepositories](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DescribeRepositories.md): Describes image repositories in a registry.
- [DescribeRepositoryCreationTemplates](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DescribeRepositoryCreationTemplates.md): Returns details about the repository creation templates in a registry.
- [GetAccountSetting](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_GetAccountSetting.md): Retrieves the account setting value for the specified setting name.
- [GetAuthorizationToken](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_GetAuthorizationToken.md): Retrieves an authorization token.
- [GetDownloadUrlForLayer](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_GetDownloadUrlForLayer.md): Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.
- [GetLifecyclePolicy](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_GetLifecyclePolicy.md): Retrieves the lifecycle policy for the specified repository.
- [GetLifecyclePolicyPreview](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_GetLifecyclePolicyPreview.md): Retrieves the results of the lifecycle policy preview request for the specified repository.
- [GetRegistryPolicy](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_GetRegistryPolicy.md): Retrieves the permissions policy for a registry.
- [GetRegistryScanningConfiguration](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_GetRegistryScanningConfiguration.md): Retrieves the scanning configuration for a registry.
- [GetRepositoryPolicy](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_GetRepositoryPolicy.md): Retrieves the repository policy for the specified repository.
- [GetSigningConfiguration](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_GetSigningConfiguration.md): Retrieves the registry's signing configuration, which defines rules for automatically signing images using AWS Signer.
- [InitiateLayerUpload](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_InitiateLayerUpload.md): Notifies Amazon ECR that you intend to upload an image layer.
- [ListImageReferrers](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ListImageReferrers.md): Lists the artifacts associated with a specified subject image.
- [ListImages](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ListImages.md): Lists all the image IDs for the specified repository.
- [ListPullTimeUpdateExclusions](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ListPullTimeUpdateExclusions.md): Lists the IAM principals that are excluded from having their image pull times recorded.
- [ListReplicationBackfills](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ListReplicationBackfills.md): Lists the replication backfills for a registry, including their status and progress.
- [ListTagsForResource](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ListTagsForResource.md): List the tags for an Amazon ECR resource.
- [PutAccountSetting](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutAccountSetting.md): Allows you to change the basic scan type version or registry policy scope.
- [PutImage](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutImage.md): Creates or updates the image manifest and tags associated with an image.
- [PutImageScanningConfiguration](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutImageScanningConfiguration.md)
- [PutImageTagMutability](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutImageTagMutability.md): Updates the image tag mutability settings for the specified repository.
- [PutLifecyclePolicy](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutLifecyclePolicy.md): Creates or updates the lifecycle policy for the specified repository.
- [PutRegistryPolicy](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutRegistryPolicy.md): Creates or updates the permissions policy for your registry.
- [PutRegistryScanningConfiguration](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutRegistryScanningConfiguration.md): Creates or updates the scanning configuration for your private registry.
- [PutReplicationConfiguration](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutReplicationConfiguration.md): Creates or updates the replication configuration for a registry.
- [PutSigningConfiguration](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PutSigningConfiguration.md): Creates or updates the registry's signing configuration, which defines rules for automatically signing images with AWS Signer.
- [RegisterPullTimeUpdateExclusion](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_RegisterPullTimeUpdateExclusion.md): Adds an IAM principal to the pull time update exclusion list for a registry.
- [SetRepositoryPolicy](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_SetRepositoryPolicy.md): Applies a repository policy to the specified repository to control access permissions.
- [StartImageScan](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_StartImageScan.md): Starts a basic image vulnerability scan.
- [StartLifecyclePolicyPreview](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_StartLifecyclePolicyPreview.md): Starts a preview of a lifecycle policy for the specified repository.
- [StartReplicationBackfill](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_StartReplicationBackfill.md): Starts a replication backfill for a registry.
- [StopReplicationBackfill](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_StopReplicationBackfill.md): Stops an in progress replication backfill for a registry.
- [TagResource](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_TagResource.md): Adds specified tags to a resource with the specified ARN.
- [UntagResource](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_UntagResource.md): Deletes specified tags from a resource.
- [UpdateImageStorageClass](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_UpdateImageStorageClass.md): Transitions an image between storage classes.
- [UpdatePullThroughCacheRule](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_UpdatePullThroughCacheRule.md): Updates an existing pull through cache rule.
- [UpdateRepositoryCreationTemplate](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_UpdateRepositoryCreationTemplate.md): Updates an existing repository creation template.
- [UploadLayerPart](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_UploadLayerPart.md): Uploads an image layer part to Amazon ECR.
- [ValidatePullThroughCacheRule](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ValidatePullThroughCacheRule.md): Validates an existing pull through cache rule for an upstream registry that requires authentication.


## [Data Types](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Types.md)

- [Attribute](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Attribute.md): This data type is used in the ImageScanFinding data type.
- [AuthorizationData](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_AuthorizationData.md): An object representing authorization data for an Amazon ECR registry.
- [AwsEcrContainerImageDetails](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_AwsEcrContainerImageDetails.md): The image details of the Amazon ECR container image.
- [CvssScore](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_CvssScore.md): The CVSS score for a finding.
- [CvssScoreAdjustment](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_CvssScoreAdjustment.md): Details on adjustments Amazon Inspector made to the CVSS score for a finding.
- [CvssScoreDetails](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_CvssScoreDetails.md): Information about the CVSS score.
- [DescribeImagesFilter](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_DescribeImagesFilter.md): An object representing a filter on a DescribeImages operation.
- [EncryptionConfiguration](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_EncryptionConfiguration.md): The encryption configuration for the repository.
- [EncryptionConfigurationForRepositoryCreationTemplate](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_EncryptionConfigurationForRepositoryCreationTemplate.md): The encryption configuration to associate with the repository creation template.
- [EnhancedImageScanFinding](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_EnhancedImageScanFinding.md): The details of an enhanced image scan.
- [Image](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Image.md): An object representing an Amazon ECR image.
- [ImageDetail](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ImageDetail.md): An object that describes an image returned by a DescribeImages operation.
- [ImageFailure](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ImageFailure.md): An object representing an Amazon ECR image failure.
- [ImageIdentifier](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ImageIdentifier.md): An object with identifying information for an image in an Amazon ECR repository.
- [ImageReferrer](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ImageReferrer.md): An object representing an artifact associated with a subject image.
- [ImageReplicationStatus](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ImageReplicationStatus.md): The status of the replication process for an image.
- [ImageScanFinding](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ImageScanFinding.md): Contains information about an image scan finding.
- [ImageScanFindings](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ImageScanFindings.md): The details of an image scan.
- [ImageScanFindingsSummary](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ImageScanFindingsSummary.md): A summary of the last completed image scan.
- [ImageScanningConfiguration](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ImageScanningConfiguration.md): The image scanning configuration for a repository.
- [ImageScanStatus](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ImageScanStatus.md): The current status of an image scan.
- [ImageSigningStatus](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ImageSigningStatus.md): The signing status for an image.
- [ImageTagMutabilityExclusionFilter](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ImageTagMutabilityExclusionFilter.md): A filter that specifies which image tags should be excluded from the repository's image tag mutability setting.
- [Layer](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Layer.md): An object representing an Amazon ECR image layer.
- [LayerFailure](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_LayerFailure.md): An object representing an Amazon ECR image layer failure.
- [LifecyclePolicyPreviewFilter](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_LifecyclePolicyPreviewFilter.md): The filter for the lifecycle policy preview.
- [LifecyclePolicyPreviewResult](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_LifecyclePolicyPreviewResult.md): The result of the lifecycle policy preview.
- [LifecyclePolicyPreviewSummary](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_LifecyclePolicyPreviewSummary.md): The summary of the lifecycle policy preview request.
- [LifecyclePolicyRuleAction](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_LifecyclePolicyRuleAction.md): The type of action to be taken.
- [ListImageReferrersFilter](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ListImageReferrersFilter.md): An object representing a filter on a ListImageReferrers operation.
- [ListImagesFilter](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ListImagesFilter.md): An object representing a filter on a ListImages operation.
- [PackageVulnerabilityDetails](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PackageVulnerabilityDetails.md): Information about a package vulnerability finding.
- [PullThroughCacheRule](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_PullThroughCacheRule.md): The details of a pull through cache rule.
- [Recommendation](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Recommendation.md): Details about the recommended course of action to remediate the finding.
- [RegistryScanningConfiguration](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_RegistryScanningConfiguration.md): The scanning configuration for a private registry.
- [RegistryScanningRule](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_RegistryScanningRule.md): The details of a scanning rule for a private registry.
- [Remediation](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Remediation.md): Information on how to remediate a finding.
- [ReplicationBackfillProgress](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ReplicationBackfillProgress.md): An object representing the progress of a replication backfill, including the total, completed, and failed replication counts.
- [ReplicationBackfillResult](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ReplicationBackfillResult.md): An object representing the result of a single replication during a replication backfill.
- [ReplicationBackfillSummary](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ReplicationBackfillSummary.md): An object representing a summary of a replication backfill, including its status, destination, progress, and start and end times.
- [ReplicationConfiguration](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ReplicationConfiguration.md): The replication configuration for a registry.
- [ReplicationDestination](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ReplicationDestination.md): An array of objects representing the destination for a replication rule.
- [ReplicationRule](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ReplicationRule.md): An array of objects representing the replication destinations and repository filters for a replication configuration.
- [Repository](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Repository.md): An object representing a repository.
- [RepositoryCreationTemplate](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_RepositoryCreationTemplate.md): The details of the repository creation template associated with the request.
- [RepositoryFilter](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_RepositoryFilter.md): The filter settings used with image replication.
- [RepositoryScanningConfiguration](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_RepositoryScanningConfiguration.md): The details of the scanning configuration for a repository.
- [RepositoryScanningConfigurationFailure](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_RepositoryScanningConfigurationFailure.md): The details about any failures associated with the scanning configuration of a repository.
- [Resource](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Resource.md): Details about the resource involved in a finding.
- [ResourceDetails](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ResourceDetails.md): Contains details about the resource involved in the finding.
- [ScanningRepositoryFilter](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ScanningRepositoryFilter.md): The details of a scanning repository filter.
- [ScoreDetails](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ScoreDetails.md): Information about the Amazon Inspector score given to a finding.
- [SigningConfiguration](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_SigningConfiguration.md): The signing configuration for a registry, which specifies rules for automatically signing images when pushed.
- [SigningRepositoryFilter](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_SigningRepositoryFilter.md): A repository filter used to determine which repositories have their images automatically signed on push.
- [SigningRule](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_SigningRule.md): A signing rule that specifies a signing profile and optional repository filters.
- [SubjectIdentifier](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_SubjectIdentifier.md): An object that identifies an image subject.
- [Tag](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Tag.md): The metadata to apply to a resource to help you categorize and organize them.
- [TransitioningImageTotalCount](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_TransitioningImageTotalCount.md): The total count of images transitioning to a storage class.
- [VulnerablePackage](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_VulnerablePackage.md): Information on the vulnerable package identified by a finding.


## Full content

The entire guide is also available as a single markdown file, useful for feeding the full guide to an LLM in one pass:

- [Complete guide (single file)](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/full.md)