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.
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 is, then the image layer is skipped.
When an image is pulled from a repository, each image layer is checked once to verify it is available to be pulled.
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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.BatchCheckLayerAvailability |
Name | Data Type | Description |
---|---|---|
BatchCheckLayerAvailabilityRequest
|
object |
layerDigests
|
BatchedOperationLayerDigestList |
The digests of the image layers to check. |
|||||||||||
|
|||||||||||||
repositoryName
|
RepositoryName |
The name of the repository that is associated with the image layers to check. |
|||||||||||
|
|||||||||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the image layers to check. If you do not specify a registry, the default registry is assumed. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
BatchCheckLayerAvailabilityResponse
|
object |
failures
|
LayerFailureList |
Any failures associated with the call. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
layers
|
LayerList |
A list of image layer objects corresponding to the image layer references in the request. |
|||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
ServerException
|
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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.BatchDeleteImage |
Name | Data Type | Description |
---|---|---|
BatchDeleteImageRequest
|
object |
Deletes specified images within a specified repository. Images are specified with either the |
imageIds
|
ImageIdentifierList |
A list of image ID references that correspond to images to delete. The format of the |
|||||||||||||||||
|
|||||||||||||||||||
repositoryName
|
RepositoryName |
The repository that contains the image to delete. |
|||||||||||||||||
|
|||||||||||||||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed. |
|||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
BatchDeleteImageResponse
|
object |
failures
|
ImageFailureList |
Any failures associated with the call. |
||||||||||||||||||||
|
||||||||||||||||||||||
imageIds
|
ImageIdentifierList |
The image IDs of the deleted images. |
||||||||||||||||||||
|
{
"failures": [],
"imageIds": [
{
"imageDigest": "sha256:examplee6d1e504117a17000003d3753086354a38375961f2e665416ef4b1b2f",
"imageTag": "precise"
}
]
}
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.BatchGetImage |
Name | Data Type | Description |
---|---|---|
BatchGetImageRequest
|
object |
acceptedMediaTypes
|
MediaTypeList |
The accepted media types for the request. Valid values: |
|||||||||||||||||
|
|||||||||||||||||||
imageIds
|
ImageIdentifierList |
A list of image ID references that correspond to images to describe. The format of the |
|||||||||||||||||
|
|||||||||||||||||||
repositoryName
|
RepositoryName |
The repository that contains the images to describe. |
|||||||||||||||||
|
|||||||||||||||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed. |
|||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
BatchGetImageResponse
|
object |
failures
|
ImageFailureList |
Any failures associated with the call. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
images
|
ImageList |
A list of image objects corresponding to the image references in the request. |
|||||||||||||||||||||||
|
{
"failures": [],
"images": [
{
"imageId": {
"imageDigest": "sha256:example76bdff6d83a09ba2a818f0d00000063724a9ac3ba5019c56f74ebf42a",
"imageTag": "precise"
},
"imageManifest": "{\n \"schemaVersion\": 1,\n \"name\": \"ubuntu\",\n \"tag\": \"precise\",\n...",
"registryId": "244698725403",
"repositoryName": "ubuntu"
}
]
}
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
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 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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.CompleteLayerUpload |
Name | Data Type | Description |
---|---|---|
CompleteLayerUploadRequest
|
object |
layerDigests
|
LayerDigestList |
The |
|||||||||||
|
|||||||||||||
uploadId
|
UploadId |
The upload ID from a previous InitiateLayerUpload operation to associate with the image layer. |
|||||||||||
|
|||||||||||||
repositoryName
|
RepositoryName |
The name of the repository to associate with the image layer. |
|||||||||||
|
|||||||||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
CompleteLayerUploadResponse
|
object |
layerDigest
|
LayerDigest |
The |
||||
|
||||||
uploadId
|
UploadId |
The upload ID associated with the layer. |
||||
|
||||||
repositoryName
|
RepositoryName |
The repository name associated with the request. |
||||
|
||||||
registryId
|
RegistryId |
The registry ID associated with the request. |
||||
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
UploadNotFoundException
|
Name | Data Type | Description |
---|---|---|
InvalidLayerException
|
Name | Data Type | Description |
---|---|---|
LayerPartTooSmallException
|
Name | Data Type | Description |
---|---|---|
LayerAlreadyExistsException
|
Name | Data Type | Description |
---|---|---|
EmptyUploadException
|
Creates a repository. For more information, see Amazon ECR Repositories in the Amazon Elastic Container Registry User Guide.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.CreateRepository |
Name | Data Type | Description |
---|---|---|
CreateRepositoryRequest
|
object |
imageScanningConfiguration
|
ImageScanningConfiguration |
The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository. |
|||||||||||||||||
Properties
|
|||||||||||||||||||
imageTagMutability
|
ImageTagMutability |
The tag mutability setting for the repository. If this parameter is omitted, the default setting of |
|||||||||||||||||
|
|||||||||||||||||||
tags
|
TagList |
The metadata that you apply to the repository to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. |
|||||||||||||||||
|
|||||||||||||||||||
repositoryName
|
RepositoryName |
The name to use for the repository. The repository name may be specified on its own (such as |
|||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
CreateRepositoryResponse
|
object |
repository
|
Repository |
The repository that was created. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
{
"repository": {
"registryId": "012345678901",
"repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository\/project-a\/nginx-web-app",
"repositoryName": "project-a\/nginx-web-app"
}
}
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InvalidTagParameterException
|
Name | Data Type | Description |
---|---|---|
TooManyTagsException
|
Name | Data Type | Description |
---|---|---|
RepositoryAlreadyExistsException
|
Name | Data Type | Description |
---|---|---|
LimitExceededException
|
Deletes the lifecycle policy associated with the specified repository.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.DeleteLifecyclePolicy |
Name | Data Type | Description |
---|---|---|
DeleteLifecyclePolicyRequest
|
object |
repositoryName
|
RepositoryName |
The name of the repository. |
||||
|
||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteLifecyclePolicyResponse
|
object |
lastEvaluatedAt
|
EvaluationTimestamp |
The time stamp of the last time that the lifecycle policy was run. |
||||
|
||||||
lifecyclePolicyText
|
LifecyclePolicyText |
The JSON lifecycle policy text. |
||||
|
||||||
repositoryName
|
RepositoryName |
The repository name associated with the request. |
||||
|
||||||
registryId
|
RegistryId |
The registry ID associated with the request. |
||||
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
LifecyclePolicyNotFoundException
|
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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.DeleteRepository |
Name | Data Type | Description |
---|---|---|
DeleteRepositoryRequest
|
object |
force
|
ForceFlag |
If a repository contains images, forces the deletion. |
||||
|
||||||
repositoryName
|
RepositoryName |
The name of the repository to delete. |
||||
|
||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteRepositoryResponse
|
object |
repository
|
Repository |
The repository that was deleted. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
{
"repository": {
"registryId": "012345678901",
"repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository\/ubuntu",
"repositoryName": "ubuntu"
}
}
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotEmptyException
|
Deletes the repository policy associated with the specified repository.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.DeleteRepositoryPolicy |
Name | Data Type | Description |
---|---|---|
DeleteRepositoryPolicyRequest
|
object |
repositoryName
|
RepositoryName |
The name of the repository that is associated with the repository policy to delete. |
||||
|
||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository policy to delete. If you do not specify a registry, the default registry is assumed. |
||||
|
Name | Data Type | Description |
---|---|---|
DeleteRepositoryPolicyResponse
|
object |
policyText
|
RepositoryPolicyText |
The JSON repository policy that was deleted from the repository. |
||||
|
||||||
repositoryName
|
RepositoryName |
The repository name associated with the request. |
||||
|
||||||
registryId
|
RegistryId |
The registry ID associated with the request. |
||||
|
{
"policyText": "{ ... }",
"registryId": "012345678901",
"repositoryName": "ubuntu"
}
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
RepositoryPolicyNotFoundException
|
Returns the scan findings for the specified image.
Name | Data Type | Description |
---|---|---|
nextToken
|
string |
Pagination token |
maxResults
|
string |
Pagination limit |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.DescribeImageScanFindings |
Name | Data Type | Description |
---|---|---|
DescribeImageScanFindingsRequest
|
object |
maxResults
|
MaxResults |
The maximum number of image scan results returned by |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
nextToken
|
NextToken |
The |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
imageId
|
ImageIdentifier | |||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
repositoryName
|
RepositoryName |
The repository for the image for which to describe the scan findings. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository in which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed. |
||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
DescribeImageScanFindingsResponse
|
object |
nextToken
|
NextToken |
The |
||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
imageScanFindings
|
ImageScanFindings |
The information contained in the image scan findings. |
||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
imageScanStatus
|
ImageScanStatus |
The current state of the scan. |
||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
imageId
|
ImageIdentifier | |||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
repositoryName
|
RepositoryName |
The repository name associated with the request. |
||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
registryId
|
RegistryId |
The registry ID associated with the request. |
||||||||||||||||||||||||||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
ImageNotFoundException
|
Name | Data Type | Description |
---|---|---|
ScanNotFoundException
|
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.
Name | Data Type | Description |
---|---|---|
nextToken
|
string |
Pagination token |
maxResults
|
string |
Pagination limit |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.DescribeImages |
Name | Data Type | Description |
---|---|---|
DescribeImagesRequest
|
object |
filter
|
DescribeImagesFilter |
The filter key and value with which to filter your |
|||||||||||||||||
Properties
|
|||||||||||||||||||
maxResults
|
MaxResults |
The maximum number of repository results returned by |
|||||||||||||||||
|
|||||||||||||||||||
nextToken
|
NextToken |
The |
|||||||||||||||||
|
|||||||||||||||||||
imageIds
|
ImageIdentifierList |
The list of image IDs for the requested repository. |
|||||||||||||||||
|
|||||||||||||||||||
repositoryName
|
RepositoryName |
The repository that contains the images to describe. |
|||||||||||||||||
|
|||||||||||||||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed. |
|||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
DescribeImagesResponse
|
object |
nextToken
|
NextToken |
The |
|||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||
imageDetails
|
ImageDetailList |
A list of ImageDetail objects that contain data about the image. |
|||||||||||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
ImageNotFoundException
|
Describes image repositories in a registry.
Name | Data Type | Description |
---|---|---|
nextToken
|
string |
Pagination token |
maxResults
|
string |
Pagination limit |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.DescribeRepositories |
Name | Data Type | Description |
---|---|---|
DescribeRepositoriesRequest
|
object |
maxResults
|
MaxResults |
The maximum number of repository results returned by |
|||||||||||
|
|||||||||||||
nextToken
|
NextToken |
The This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. |
|||||||||||
|
|||||||||||||
repositoryNames
|
RepositoryNameList |
A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described. |
|||||||||||
|
|||||||||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
DescribeRepositoriesResponse
|
object |
nextToken
|
NextToken |
The |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||
repositories
|
RepositoryList |
A list of repository objects corresponding to valid repositories. |
||||||||||||||||||||||||||||||||
|
{
"repositories": [
{
"registryId": "012345678910",
"repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository\/ubuntu",
"repositoryName": "ubuntu"
},
{
"registryId": "012345678910",
"repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository\/test",
"repositoryName": "test"
}
]
}
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
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 AWS 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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.GetAuthorizationToken |
Name | Data Type | Description |
---|---|---|
GetAuthorizationTokenRequest
|
object |
registryIds
|
GetAuthorizationTokenRegistryIdList |
A list of AWS account IDs that are associated with the registries for which to get AuthorizationData objects. If you do not specify a registry, the default registry is assumed. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
GetAuthorizationTokenResponse
|
object |
authorizationData
|
AuthorizationDataList |
A list of authorization token data objects that correspond to the |
||||||||||||||||||||
|
{
"authorizationData": [
{
"authorizationToken": "QVdTOkN...",
"expiresAt": "1470951892432",
"proxyEndpoint": "https:\/\/012345678901.dkr.ecr.us-west-2.amazonaws.com"
}
]
}
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
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.
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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.GetDownloadUrlForLayer |
Name | Data Type | Description |
---|---|---|
GetDownloadUrlForLayerRequest
|
object |
layerDigest
|
LayerDigest |
The digest of the image layer to download. |
||||
|
||||||
repositoryName
|
RepositoryName |
The name of the repository that is associated with the image layer to download. |
||||
|
||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the image layer to download. If you do not specify a registry, the default registry is assumed. |
||||
|
Name | Data Type | Description |
---|---|---|
GetDownloadUrlForLayerResponse
|
object |
layerDigest
|
LayerDigest |
The digest of the image layer to download. |
||||
|
||||||
downloadUrl
|
Url |
The pre-signed Amazon S3 download URL for the requested layer. |
||||
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
LayersNotFoundException
|
Name | Data Type | Description |
---|---|---|
LayerInaccessibleException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Retrieves the lifecycle policy for the specified repository.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.GetLifecyclePolicy |
Name | Data Type | Description |
---|---|---|
GetLifecyclePolicyRequest
|
object |
repositoryName
|
RepositoryName |
The name of the repository. |
||||
|
||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. |
||||
|
Name | Data Type | Description |
---|---|---|
GetLifecyclePolicyResponse
|
object |
lastEvaluatedAt
|
EvaluationTimestamp |
The time stamp of the last time that the lifecycle policy was run. |
||||
|
||||||
lifecyclePolicyText
|
LifecyclePolicyText |
The JSON lifecycle policy text. |
||||
|
||||||
repositoryName
|
RepositoryName |
The repository name associated with the request. |
||||
|
||||||
registryId
|
RegistryId |
The registry ID associated with the request. |
||||
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
LifecyclePolicyNotFoundException
|
Retrieves the results of the lifecycle policy preview request for the specified repository.
Name | Data Type | Description |
---|---|---|
nextToken
|
string |
Pagination token |
maxResults
|
string |
Pagination limit |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.GetLifecyclePolicyPreview |
Name | Data Type | Description |
---|---|---|
GetLifecyclePolicyPreviewRequest
|
object |
filter
|
LifecyclePolicyPreviewFilter |
An optional parameter that filters results based on image tag status and all tags, if tagged. |
|||||||||||||||||
Properties
|
|||||||||||||||||||
maxResults
|
LifecyclePreviewMaxResults |
The maximum number of repository results returned by |
|||||||||||||||||
|
|||||||||||||||||||
nextToken
|
NextToken |
The |
|||||||||||||||||
|
|||||||||||||||||||
imageIds
|
ImageIdentifierList |
The list of imageIDs to be included. |
|||||||||||||||||
|
|||||||||||||||||||
repositoryName
|
RepositoryName |
The name of the repository. |
|||||||||||||||||
|
|||||||||||||||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. |
|||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
GetLifecyclePolicyPreviewResponse
|
object |
summary
|
LifecyclePolicyPreviewSummary |
The list of images that is returned as a result of the action. |
||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||
previewResults
|
LifecyclePolicyPreviewResultList |
The results of the lifecycle policy preview request. |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
nextToken
|
NextToken |
The |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
status
|
LifecyclePolicyPreviewStatus |
The status of the lifecycle policy preview request. |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
lifecyclePolicyText
|
LifecyclePolicyText |
The JSON lifecycle policy text. |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
repositoryName
|
RepositoryName |
The repository name associated with the request. |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
registryId
|
RegistryId |
The registry ID associated with the request. |
||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
LifecyclePolicyPreviewNotFoundException
|
Retrieves the repository policy for the specified repository.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.GetRepositoryPolicy |
Name | Data Type | Description |
---|---|---|
GetRepositoryPolicyRequest
|
object |
repositoryName
|
RepositoryName |
The name of the repository with the policy to retrieve. |
||||
|
||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. |
||||
|
Name | Data Type | Description |
---|---|---|
GetRepositoryPolicyResponse
|
object |
policyText
|
RepositoryPolicyText |
The JSON repository policy text associated with the repository. |
||||
|
||||||
repositoryName
|
RepositoryName |
The repository name associated with the request. |
||||
|
||||||
registryId
|
RegistryId |
The registry ID associated with the request. |
||||
|
{
"policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"new statement\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : \"arn:aws:iam::012345678901:role\/CodeDeployDemo\"\n },\n\"Action\" : [ \"ecr:GetDownloadUrlForLayer\", \"ecr:BatchGetImage\", \"ecr:BatchCheckLayerAvailability\" ]\n } ]\n}",
"registryId": "012345678901",
"repositoryName": "ubuntu"
}
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
RepositoryPolicyNotFoundException
|
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 an image layer has been uploaded before is determined by the BatchCheckLayerAvailability API action.
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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.InitiateLayerUpload |
Name | Data Type | Description |
---|---|---|
InitiateLayerUploadRequest
|
object |
repositoryName
|
RepositoryName |
The name of the repository to which you intend to upload layers. |
||||
|
||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry to which you intend to upload layers. If you do not specify a registry, the default registry is assumed. |
||||
|
Name | Data Type | Description |
---|---|---|
InitiateLayerUploadResponse
|
object |
partSize
|
PartSize |
The size, in bytes, that Amazon ECR expects future layer part uploads to be. |
||||
|
||||||
uploadId
|
UploadId |
The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations. |
||||
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
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 operation to delete them. Or, you can filter your results to return only TAGGED
images to list all of the tags in your repository.
Name | Data Type | Description |
---|---|---|
nextToken
|
string |
Pagination token |
maxResults
|
string |
Pagination limit |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.ListImages |
Name | Data Type | Description |
---|---|---|
ListImagesRequest
|
object |
filter
|
ListImagesFilter |
The filter key and value with which to filter your |
||||||||||||||
Properties
|
||||||||||||||||
maxResults
|
MaxResults |
The maximum number of image results returned by |
||||||||||||||
|
||||||||||||||||
nextToken
|
NextToken |
The This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. |
||||||||||||||
|
||||||||||||||||
repositoryName
|
RepositoryName |
The repository with image IDs to be listed. |
||||||||||||||
|
||||||||||||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed. |
||||||||||||||
|
Name | Data Type | Description |
---|---|---|
ListImagesResponse
|
object |
nextToken
|
NextToken |
The |
|||||||||||||||||
|
|||||||||||||||||||
imageIds
|
ImageIdentifierList |
The list of image IDs for the requested repository. |
|||||||||||||||||
|
{
"imageIds": [
{
"imageDigest": "sha256:764f63476bdff6d83a09ba2a818f0d35757063724a9ac3ba5019c56f74ebf42a",
"imageTag": "precise"
}
]
}
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
List the tags for an Amazon ECR resource.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.ListTagsForResource |
Name | Data Type | Description |
---|---|---|
ListTagsForResourceRequest
|
object |
resourceArn
|
Arn |
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the only supported resource is an Amazon ECR repository. |
||||
|
Name | Data Type | Description |
---|---|---|
ListTagsForResourceResponse
|
object |
tags
|
TagList |
The tags for the resource. |
|||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
ServerException
|
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 tags associated with the 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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.PutImage |
Name | Data Type | Description |
---|---|---|
PutImageRequest
|
object |
imageTag
|
ImageTag |
The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or OCI formats. |
||||
|
||||||
imageManifest
|
ImageManifest |
The image manifest corresponding to the image to be uploaded. |
||||
|
||||||
repositoryName
|
RepositoryName |
The name of the repository in which to put the image. |
||||
|
||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed. |
||||
|
Name | Data Type | Description |
---|---|---|
PutImageResponse
|
object |
image
|
Image |
Details of the image uploaded. |
||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
ImageAlreadyExistsException
|
Name | Data Type | Description |
---|---|---|
LayersNotFoundException
|
Name | Data Type | Description |
---|---|---|
LimitExceededException
|
Name | Data Type | Description |
---|---|---|
ImageTagAlreadyExistsException
|
Updates the image scanning configuration for the specified repository.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.PutImageScanningConfiguration |
Name | Data Type | Description |
---|---|---|
PutImageScanningConfigurationRequest
|
object |
imageScanningConfiguration
|
ImageScanningConfiguration |
The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository. |
||||||||||||||
Properties
|
||||||||||||||||
repositoryName
|
RepositoryName |
The name of the repository in which to update the image scanning configuration setting. |
||||||||||||||
|
||||||||||||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository in which to update the image scanning configuration setting. If you do not specify a registry, the default registry is assumed. |
||||||||||||||
|
Name | Data Type | Description |
---|---|---|
PutImageScanningConfigurationResponse
|
object |
imageScanningConfiguration
|
ImageScanningConfiguration |
The image scanning configuration setting for the repository. |
||||||||||||||
Properties
|
||||||||||||||||
repositoryName
|
RepositoryName |
The repository name associated with the request. |
||||||||||||||
|
||||||||||||||||
registryId
|
RegistryId |
The registry ID associated with the request. |
||||||||||||||
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Updates the image tag mutability settings for the specified repository. For more information, see Image Tag Mutability in the Amazon Elastic Container Registry User Guide.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.PutImageTagMutability |
Name | Data Type | Description |
---|---|---|
PutImageTagMutabilityRequest
|
object |
imageTagMutability
|
ImageTagMutability |
The tag mutability setting for the repository. If |
||||
|
||||||
repositoryName
|
RepositoryName |
The name of the repository in which to update the image tag mutability settings. |
||||
|
||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository in which to update the image tag mutability settings. If you do not specify a registry, the default registry is assumed. |
||||
|
Name | Data Type | Description |
---|---|---|
PutImageTagMutabilityResponse
|
object |
imageTagMutability
|
ImageTagMutability |
The image tag mutability setting for the repository. |
||||
|
||||||
repositoryName
|
RepositoryName |
The repository name associated with the request. |
||||
|
||||||
registryId
|
RegistryId |
The registry ID associated with the request. |
||||
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Creates or updates the lifecycle policy for the specified repository. For more information, see Lifecycle Policy Template.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.PutLifecyclePolicy |
Name | Data Type | Description |
---|---|---|
PutLifecyclePolicyRequest
|
object |
lifecyclePolicyText
|
LifecyclePolicyText |
The JSON repository policy text to apply to the repository. |
||||
|
||||||
repositoryName
|
RepositoryName |
The name of the repository to receive the policy. |
||||
|
||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. |
||||
|
Name | Data Type | Description |
---|---|---|
PutLifecyclePolicyResponse
|
object |
lifecyclePolicyText
|
LifecyclePolicyText |
The JSON repository policy text. |
||||
|
||||||
repositoryName
|
RepositoryName |
The repository name associated with the request. |
||||
|
||||||
registryId
|
RegistryId |
The registry ID associated with the request. |
||||
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Applies 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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.SetRepositoryPolicy |
Name | Data Type | Description |
---|---|---|
SetRepositoryPolicyRequest
|
object |
force
|
ForceFlag |
If the policy you are attempting to set on a repository policy would prevent you from setting another policy in the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental repository lock outs. |
||||
|
||||||
policyText
|
RepositoryPolicyText |
The JSON repository policy text to apply to the repository. For more information, see Amazon ECR Repository Policy Examples in the Amazon Elastic Container Registry User Guide. |
||||
|
||||||
repositoryName
|
RepositoryName |
The name of the repository to receive the policy. |
||||
|
||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. |
||||
|
Name | Data Type | Description |
---|---|---|
SetRepositoryPolicyResponse
|
object |
policyText
|
RepositoryPolicyText |
The JSON repository policy text applied to the repository. |
||||
|
||||||
repositoryName
|
RepositoryName |
The repository name associated with the request. |
||||
|
||||||
registryId
|
RegistryId |
The registry ID associated with the request. |
||||
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Starts an image vulnerability scan. An image scan can only be started once per day 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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.StartImageScan |
Name | Data Type | Description |
---|---|---|
StartImageScanRequest
|
object |
imageId
|
ImageIdentifier | |||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
repositoryName
|
RepositoryName |
The name of the repository that contains the images to scan. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository in which to start an image scan request. If you do not specify a registry, the default registry is assumed. |
||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
StartImageScanResponse
|
object |
imageScanStatus
|
ImageScanStatus |
The current state of the scan. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
imageId
|
ImageIdentifier | |||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
repositoryName
|
RepositoryName |
The repository name associated with the request. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
registryId
|
RegistryId |
The registry ID associated with the request. |
||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
ImageNotFoundException
|
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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.StartLifecyclePolicyPreview |
Name | Data Type | Description |
---|---|---|
StartLifecyclePolicyPreviewRequest
|
object |
lifecyclePolicyText
|
LifecyclePolicyText |
The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used. |
||||
|
||||||
repositoryName
|
RepositoryName |
The name of the repository to be evaluated. |
||||
|
||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. |
||||
|
Name | Data Type | Description |
---|---|---|
StartLifecyclePolicyPreviewResponse
|
object |
status
|
LifecyclePolicyPreviewStatus |
The status of the lifecycle policy preview request. |
||||
|
||||||
lifecyclePolicyText
|
LifecyclePolicyText |
The JSON repository policy text. |
||||
|
||||||
repositoryName
|
RepositoryName |
The repository name associated with the request. |
||||
|
||||||
registryId
|
RegistryId |
The registry ID associated with the request. |
||||
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
LifecyclePolicyNotFoundException
|
Name | Data Type | Description |
---|---|---|
LifecyclePolicyPreviewInProgressException
|
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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.TagResource |
Name | Data Type | Description |
---|---|---|
TagResourceRequest
|
object |
tags
|
TagList |
The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. |
|||||||||||||||||
|
|||||||||||||||||||
resourceArn
|
Arn |
The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported resource is an Amazon ECR repository. |
|||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
TagResourceResponse
|
object |
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InvalidTagParameterException
|
Name | Data Type | Description |
---|---|---|
TooManyTagsException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Deletes specified tags from a resource.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.UntagResource |
Name | Data Type | Description |
---|---|---|
UntagResourceRequest
|
object |
tagKeys
|
TagKeyList |
The keys of the tags to be removed. |
|||||||||||
|
|||||||||||||
resourceArn
|
Arn |
The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported resource is an Amazon ECR repository. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
UntagResourceResponse
|
object |
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InvalidTagParameterException
|
Name | Data Type | Description |
---|---|---|
TooManyTagsException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
ServerException
|
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 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.
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string | |
X-Amz-Target
|
string Allowed values: - AmazonEC2ContainerRegistry_V20150921.UploadLayerPart |
Name | Data Type | Description |
---|---|---|
UploadLayerPartRequest
|
object |
layerPartBlob
|
LayerPartBlob |
The base64-encoded layer part payload. |
||||
|
||||||
partLastByte
|
PartSize |
The integer value of the last byte of the layer part. |
||||
|
||||||
partFirstByte
|
PartSize |
The integer value of the first byte of the layer part. |
||||
|
||||||
uploadId
|
UploadId |
The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload. |
||||
|
||||||
repositoryName
|
RepositoryName |
The name of the repository to which you are uploading layer parts. |
||||
|
||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry to which you are uploading layer parts. If you do not specify a registry, the default registry is assumed. |
||||
|
Name | Data Type | Description |
---|---|---|
UploadLayerPartResponse
|
object |
lastByteReceived
|
PartSize |
The integer value of the last byte received in the request. |
||||
|
||||||
uploadId
|
UploadId |
The upload ID associated with the request. |
||||
|
||||||
repositoryName
|
RepositoryName |
The repository name associated with the request. |
||||
|
||||||
registryId
|
RegistryId |
The registry ID associated with the request. |
||||
|
Name | Data Type | Description |
---|---|---|
ServerException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InvalidLayerPartException
|
Name | Data Type | Description |
---|---|---|
RepositoryNotFoundException
|
Name | Data Type | Description |
---|---|---|
UploadNotFoundException
|
Name | Data Type | Description |
---|---|---|
LimitExceededException
|
Name | Data Type | Description |
---|---|---|
Arn
|
string |
This data type is used in the ImageScanFinding data type.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
value
|
AttributeValue |
The value assigned to the attribute key. |
||||
|
||||||
key
|
AttributeKey |
The attribute key. |
||||
|
Name | Data Type | Description |
---|---|---|
AttributeKey
|
string Minimum: 1 Maximum: 128 |
Name | Data Type | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AttributeList
|
array [Attribute] | |||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
AttributeValue
|
string Minimum: 1 Maximum: 256 |
An object representing authorization data for an Amazon ECR registry.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
proxyEndpoint
|
ProxyEndpoint |
The registry URL to use for this authorization token in a |
||||
|
||||||
expiresAt
|
ExpirationTimestamp |
The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours. |
||||
|
||||||
authorizationToken
|
Base64 |
A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string is decoded, it is presented in the format |
||||
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AuthorizationDataList
|
array [AuthorizationData] | |||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
Base64
|
string Pattern: ^\S+$
|
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
layerDigests
|
BatchedOperationLayerDigestList |
The digests of the image layers to check. |
|||||||||||
|
|||||||||||||
repositoryName
|
RepositoryName |
The name of the repository that is associated with the image layers to check. |
|||||||||||
|
|||||||||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the image layers to check. If you do not specify a registry, the default registry is assumed. |
|||||||||||
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
failures
|
LayerFailureList |
Any failures associated with the call. |
|||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||
layers
|
LayerList |
A list of image layer objects corresponding to the image layer references in the request. |
|||||||||||||||||||||||||||||||||||||||||||||||||||
|
Deletes specified images within a specified repository. Images are specified with either the imageTag
or imageDigest
.
Name | Data Type | Description | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
imageIds
|
ImageIdentifierList |
A list of image ID references that correspond to images to delete. The format of the |
|||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
repositoryName
|
RepositoryName |
The repository that contains the image to delete. |
|||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed. |
|||||||||||||||||||||||||||||||
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
failures
|
ImageFailureList |
Any failures associated with the call. |
|||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||
imageIds
|
ImageIdentifierList |
The image IDs of the deleted images. |
|||||||||||||||||||||||||||||||||||||||||||||||
|
{
"failures": [],
"imageIds": [
{
"imageDigest": "sha256:examplee6d1e504117a17000003d3753086354a38375961f2e665416ef4b1b2f",
"imageTag": "precise"
}
]
}
Name | Data Type | Description | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
acceptedMediaTypes
|
MediaTypeList |
The accepted media types for the request. Valid values: |
|||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
imageIds
|
ImageIdentifierList |
A list of image ID references that correspond to images to describe. The format of the |
|||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
repositoryName
|
RepositoryName |
The repository that contains the images to describe. |
|||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
registryId
|
RegistryId |
The AWS account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed. |
|||||||||||||||||||||||||||||||
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
failures
|
ImageFailureList |
Any failures associated with the call. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
images
|
ImageList |
A list of image objects corresponding to the image references in the request. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{
"failures": [],
"images": [
{
"imageId": {
"imageDigest": "sha256:example76bdff6d83a09ba2a818f0d00000063724a9ac3ba5019c56f74ebf42a",
"imageTag": "precise"
},
"imageManifest": "{\n \"schemaVersion\": 1,\n \"name\": \"ubuntu\",\n \"tag\": \"precise\",\n...",
"registryId": "244698725403",
"repositoryName": "ubuntu"
}
]
}
Name | Data Type | Description |
---|---|---|
BatchedOperationLayerDigest
|
string Minimum: 0 Maximum: 1000 |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
BatchedOperationLayerDigestList
|
array [BatchedOperationLayerDigest] Minimum: 0 Maximum: 1000 |
|||||
|
Name | Data Type | Description |
---|---|---|
layerDigests
|