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.
service : AWS.Config.Region -> AWS.Service.Service
Configuration for this service.
batchCheckLayerAvailability : BatchCheckLayerAvailabilityRequest -> AWS.Http.Request AWS.Http.AWSAppError BatchCheckLayerAvailabilityResponse
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 for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
batchDeleteImage : BatchDeleteImageRequest -> AWS.Http.Request AWS.Http.AWSAppError BatchDeleteImageResponse
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 : BatchGetImageRequest -> AWS.Http.Request AWS.Http.AWSAppError BatchGetImageResponse
Gets detailed information for specified images within a specified repository. Images are specified with either imageTag
or imageDigest
.
completeLayerUpload : CompleteLayerUploadRequest -> AWS.Http.Request AWS.Http.AWSAppError CompleteLayerUploadResponse
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.
This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
createRepository : CreateRepositoryRequest -> AWS.Http.Request AWS.Http.AWSAppError CreateRepositoryResponse
Creates an image repository.
deleteLifecyclePolicy : DeleteLifecyclePolicyRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteLifecyclePolicyResponse
Deletes the specified lifecycle policy.
deleteRepository : DeleteRepositoryRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteRepositoryResponse
Deletes an existing image repository. If a repository contains images, you must use the force
option to delete it.
deleteRepositoryPolicy : DeleteRepositoryPolicyRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteRepositoryPolicyResponse
Deletes the repository policy from a specified repository.
describeImages : DescribeImagesRequest -> AWS.Http.Request AWS.Http.AWSAppError DescribeImagesResponse
Returns metadata about the images in a repository, including image size, image tags, and creation date.
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
.
describeRepositories : DescribeRepositoriesRequest -> AWS.Http.Request AWS.Http.AWSAppError DescribeRepositoriesResponse
Describes image repositories in a registry.
getAuthorizationToken : GetAuthorizationTokenRequest -> AWS.Http.Request AWS.Http.AWSAppError GetAuthorizationTokenResponse
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 : GetDownloadUrlForLayerRequest -> AWS.Http.Request AWS.Http.AWSAppError GetDownloadUrlForLayerResponse
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 for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
getLifecyclePolicy : GetLifecyclePolicyRequest -> AWS.Http.Request AWS.Http.AWSAppError GetLifecyclePolicyResponse
Retrieves the specified lifecycle policy.
getLifecyclePolicyPreview : GetLifecyclePolicyPreviewRequest -> AWS.Http.Request AWS.Http.AWSAppError GetLifecyclePolicyPreviewResponse
Retrieves the results of the specified lifecycle policy preview request.
getRepositoryPolicy : GetRepositoryPolicyRequest -> AWS.Http.Request AWS.Http.AWSAppError GetRepositoryPolicyResponse
Retrieves the repository policy for a specified repository.
initiateLayerUpload : InitiateLayerUploadRequest -> AWS.Http.Request AWS.Http.AWSAppError InitiateLayerUploadResponse
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 for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
listImages : ListImagesRequest -> AWS.Http.Request AWS.Http.AWSAppError ListImagesResponse
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.
listTagsForResource : ListTagsForResourceRequest -> AWS.Http.Request AWS.Http.AWSAppError ListTagsForResourceResponse
List the tags for an Amazon ECR resource.
putImage : PutImageRequest -> AWS.Http.Request AWS.Http.AWSAppError PutImageResponse
Creates or updates the image manifest and tags associated with an image.
This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
putImageTagMutability : PutImageTagMutabilityRequest -> AWS.Http.Request AWS.Http.AWSAppError PutImageTagMutabilityResponse
Updates the image tag mutability settings for a repository.
putLifecyclePolicy : PutLifecyclePolicyRequest -> AWS.Http.Request AWS.Http.AWSAppError PutLifecyclePolicyResponse
Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see Lifecycle Policy Template
.
setRepositoryPolicy : SetRepositoryPolicyRequest -> AWS.Http.Request AWS.Http.AWSAppError SetRepositoryPolicyResponse
Applies a repository policy on a specified repository to control access permissions. For more information, see Amazon ECR Repository Policies
in the Amazon Elastic Container Registry User Guide.
startLifecyclePolicyPreview : StartLifecyclePolicyPreviewRequest -> AWS.Http.Request AWS.Http.AWSAppError StartLifecyclePolicyPreviewResponse
Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy.
tagResource : TagResourceRequest -> AWS.Http.Request AWS.Http.AWSAppError ()
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.
untagResource : UntagResourceRequest -> AWS.Http.Request AWS.Http.AWSAppError ()
Deletes specified tags from a resource.
uploadLayerPart : UploadLayerPartRequest -> AWS.Http.Request AWS.Http.AWSAppError UploadLayerPartResponse
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 for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
{ authorizationToken : Maybe String
, expiresAt : Maybe String
, proxyEndpoint : Maybe String
}
The AuthorizationData data model.
List AuthorizationData
The AuthorizationDataList data model.
{ layerDigests : BatchedOperationLayerDigestList
, registryId : Maybe String
, repositoryName : String
}
The BatchCheckLayerAvailabilityRequest data model.
{ failures : Maybe LayerFailureList
, layers : Maybe LayerList
}
The BatchCheckLayerAvailabilityResponse data model.
{ imageIds : ImageIdentifierList
, registryId : Maybe String
, repositoryName : String
}
The BatchDeleteImageRequest data model.
{ failures : Maybe ImageFailureList
, imageIds : Maybe ImageIdentifierList
}
The BatchDeleteImageResponse data model.
{ acceptedMediaTypes : Maybe MediaTypeList
, imageIds : ImageIdentifierList
, registryId : Maybe String
, repositoryName : String
}
The BatchGetImageRequest data model.
{ failures : Maybe ImageFailureList
, images : Maybe ImageList
}
The BatchGetImageResponse data model.
List String
The BatchedOperationLayerDigestList data model.
{ layerDigests : LayerDigestList
, registryId : Maybe String
, repositoryName : String
, uploadId : String
}
The CompleteLayerUploadRequest data model.
{ layerDigest : Maybe String
, registryId : Maybe String
, repositoryName : Maybe String
, uploadId : Maybe String
}
The CompleteLayerUploadResponse data model.
{ imageTagMutability : Maybe ImageTagMutability
, repositoryName : String
, tags : Maybe TagList
}
The CreateRepositoryRequest data model.
{ repository : Maybe Repository }
The CreateRepositoryResponse data model.
{ registryId : Maybe String
, repositoryName : String
}
The DeleteLifecyclePolicyRequest data model.
{ lastEvaluatedAt : Maybe String
, lifecyclePolicyText : Maybe String
, registryId : Maybe String
, repositoryName : Maybe String
}
The DeleteLifecyclePolicyResponse data model.
{ registryId : Maybe String
, repositoryName : String
}
The DeleteRepositoryPolicyRequest data model.
{ policyText : Maybe String
, registryId : Maybe String
, repositoryName : Maybe String
}
The DeleteRepositoryPolicyResponse data model.
{ force : Maybe Basics.Bool
, registryId : Maybe String
, repositoryName : String
}
The DeleteRepositoryRequest data model.
{ repository : Maybe Repository }
The DeleteRepositoryResponse data model.
{ tagStatus : Maybe TagStatus }
The DescribeImagesFilter data model.
{ filter : Maybe DescribeImagesFilter
, imageIds : Maybe ImageIdentifierList
, maxResults : Maybe Basics.Int
, nextToken : Maybe String
, registryId : Maybe String
, repositoryName : String
}
The DescribeImagesRequest data model.
{ imageDetails : Maybe ImageDetailList
, nextToken : Maybe String
}
The DescribeImagesResponse data model.
{ maxResults : Maybe Basics.Int
, nextToken : Maybe String
, registryId : Maybe String
, repositoryNames : Maybe RepositoryNameList
}
The DescribeRepositoriesRequest data model.
{ nextToken : Maybe String
, repositories : Maybe RepositoryList
}
The DescribeRepositoriesResponse data model.
List String
The GetAuthorizationTokenRegistryIdList data model.
{ registryIds : Maybe GetAuthorizationTokenRegistryIdList }
The GetAuthorizationTokenRequest data model.
{ authorizationData : Maybe AuthorizationDataList }
The GetAuthorizationTokenResponse data model.
{ layerDigest : String
, registryId : Maybe String
, repositoryName : String
}
The GetDownloadUrlForLayerRequest data model.
{ downloadUrl : Maybe String
, layerDigest : Maybe String
}
The GetDownloadUrlForLayerResponse data model.
{ filter : Maybe LifecyclePolicyPreviewFilter
, imageIds : Maybe ImageIdentifierList
, maxResults : Maybe Basics.Int
, nextToken : Maybe String
, registryId : Maybe String
, repositoryName : String
}
The GetLifecyclePolicyPreviewRequest data model.
{ lifecyclePolicyText : Maybe String
, nextToken : Maybe String
, previewResults : Maybe LifecyclePolicyPreviewResultList
, registryId : Maybe String
, repositoryName : Maybe String
, status : Maybe LifecyclePolicyPreviewStatus
, summary : Maybe LifecyclePolicyPreviewSummary
}
The GetLifecyclePolicyPreviewResponse data model.
{ registryId : Maybe String
, repositoryName : String
}
The GetLifecyclePolicyRequest data model.
{ lastEvaluatedAt : Maybe String
, lifecyclePolicyText : Maybe String
, registryId : Maybe String
, repositoryName : Maybe String
}
The GetLifecyclePolicyResponse data model.
{ registryId : Maybe String
, repositoryName : String
}
The GetRepositoryPolicyRequest data model.
{ policyText : Maybe String
, registryId : Maybe String
, repositoryName : Maybe String
}
The GetRepositoryPolicyResponse data model.
{ imageId : Maybe ImageIdentifier
, imageManifest : Maybe String
, registryId : Maybe String
, repositoryName : Maybe String
}
The Image data model.
The ImageActionType data model.
{ imageDigest : Maybe String
, imagePushedAt : Maybe String
, imageSizeInBytes : Maybe Basics.Int
, imageTags : Maybe ImageTagList
, registryId : Maybe String
, repositoryName : Maybe String
}
The ImageDetail data model.
List ImageDetail
The ImageDetailList data model.
{ failureCode : Maybe ImageFailureCode
, failureReason : Maybe String
, imageId : Maybe ImageIdentifier
}
The ImageFailure data model.
The ImageFailureCode data model.
List ImageFailure
The ImageFailureList data model.
{ imageDigest : Maybe String
, imageTag : Maybe String
}
The ImageIdentifier data model.
List ImageIdentifier
The ImageIdentifierList data model.
List Image
The ImageList data model.
List String
The ImageTagList data model.
The ImageTagMutability data model.
{ registryId : Maybe String
, repositoryName : String
}
The InitiateLayerUploadRequest data model.
{ partSize : Maybe Basics.Int
, uploadId : Maybe String
}
The InitiateLayerUploadResponse data model.
{ layerAvailability : Maybe LayerAvailability
, layerDigest : Maybe String
, layerSize : Maybe Basics.Int
, mediaType : Maybe String
}
The Layer data model.
The LayerAvailability data model.
List String
The LayerDigestList data model.
{ failureCode : Maybe LayerFailureCode
, failureReason : Maybe String
, layerDigest : Maybe String
}
The LayerFailure data model.
The LayerFailureCode data model.
List LayerFailure
The LayerFailureList data model.
List Layer
The LayerList data model.
{ tagStatus : Maybe TagStatus }
The LifecyclePolicyPreviewFilter data model.
{ action : Maybe LifecyclePolicyRuleAction
, appliedRulePriority : Maybe Basics.Int
, imageDigest : Maybe String
, imagePushedAt : Maybe String
, imageTags : Maybe ImageTagList
}
The LifecyclePolicyPreviewResult data model.
List LifecyclePolicyPreviewResult
The LifecyclePolicyPreviewResultList data model.
The LifecyclePolicyPreviewStatus data model.
{ expiringImageTotalCount : Maybe Basics.Int }
The LifecyclePolicyPreviewSummary data model.
{ type_ : Maybe ImageActionType }
The LifecyclePolicyRuleAction data model.
{ tagStatus : Maybe TagStatus }
The ListImagesFilter data model.
{ filter : Maybe ListImagesFilter
, maxResults : Maybe Basics.Int
, nextToken : Maybe String
, registryId : Maybe String
, repositoryName : String
}
The ListImagesRequest data model.
{ imageIds : Maybe ImageIdentifierList
, nextToken : Maybe String
}
The ListImagesResponse data model.
{ resourceArn : String }
The ListTagsForResourceRequest data model.
{ tags : Maybe TagList }
The ListTagsForResourceResponse data model.
List String
The MediaTypeList data model.
{ imageManifest : String
, imageTag : Maybe String
, registryId : Maybe String
, repositoryName : String
}
The PutImageRequest data model.
{ image : Maybe Image }
The PutImageResponse data model.
{ imageTagMutability : ImageTagMutability
, registryId : Maybe String
, repositoryName : String
}
The PutImageTagMutabilityRequest data model.
{ imageTagMutability : Maybe ImageTagMutability
, registryId : Maybe String
, repositoryName : Maybe String
}
The PutImageTagMutabilityResponse data model.
{ lifecyclePolicyText : String
, registryId : Maybe String
, repositoryName : String
}
The PutLifecyclePolicyRequest data model.
{ lifecyclePolicyText : Maybe String
, registryId : Maybe String
, repositoryName : Maybe String
}
The PutLifecyclePolicyResponse data model.
{ createdAt : Maybe String
, imageTagMutability : Maybe ImageTagMutability
, registryId : Maybe String
, repositoryArn : Maybe String
, repositoryName : Maybe String
, repositoryUri : Maybe String
}
The Repository data model.
List Repository
The RepositoryList data model.
List String
The RepositoryNameList data model.
{ force : Maybe Basics.Bool
, policyText : String
, registryId : Maybe String
, repositoryName : String
}
The SetRepositoryPolicyRequest data model.
{ policyText : Maybe String
, registryId : Maybe String
, repositoryName : Maybe String
}
The SetRepositoryPolicyResponse data model.
{ lifecyclePolicyText : Maybe String
, registryId : Maybe String
, repositoryName : String
}
The StartLifecyclePolicyPreviewRequest data model.
{ lifecyclePolicyText : Maybe String
, registryId : Maybe String
, repositoryName : Maybe String
, status : Maybe LifecyclePolicyPreviewStatus
}
The StartLifecyclePolicyPreviewResponse data model.
{ key : Maybe String
, value : Maybe String
}
The Tag data model.
List String
The TagKeyList data model.
List Tag
The TagList data model.
{ resourceArn : String
, tags : TagList
}
The TagResourceRequest data model.
{}
The TagResourceResponse data model.
The TagStatus data model.
{ resourceArn : String
, tagKeys : TagKeyList
}
The UntagResourceRequest data model.
{}
The UntagResourceResponse data model.
{ layerPartBlob : String
, partFirstByte : Basics.Int
, partLastByte : Basics.Int
, registryId : Maybe String
, repositoryName : String
, uploadId : String
}
The UploadLayerPartRequest data model.
{ lastByteReceived : Maybe Basics.Int
, registryId : Maybe String
, repositoryName : Maybe String
, uploadId : Maybe String
}
The UploadLayerPartResponse data model.
imageActionType : Enum ImageActionType
The ImageActionType data model.
imageFailureCode : Enum ImageFailureCode
The ImageFailureCode data model.
imageTagMutability : Enum ImageTagMutability
The ImageTagMutability data model.
layerAvailability : Enum LayerAvailability
The LayerAvailability data model.
layerFailureCode : Enum LayerFailureCode
The LayerFailureCode data model.
lifecyclePolicyPreviewStatus : Enum LifecyclePolicyPreviewStatus
The LifecyclePolicyPreviewStatus data model.
tagStatus : Enum TagStatus
The TagStatus data model.