CompleteLayerUpload
Informs Amazon ECR that the image layer upload is complete for a specified public 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 for each new image layer to verify that the upload is complete.
Note
This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker
CLI to pull, tag, and push images.
Request Syntax
{
"layerDigests": [ "string
" ],
"registryId": "string
",
"repositoryName": "string
",
"uploadId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- layerDigests
-
The
sha256
digest of the image layer.Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Pattern:
[a-zA-Z0-9-_+.]+:[a-fA-F0-9]+
Required: Yes
- registryId
-
The AWS account ID, or registry alias, associated with the registry where layers are uploaded. If you do not specify a registry, the default public registry is assumed.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 50.
Required: No
- repositoryName
-
The name of the repository in a public registry to associate with the image layer.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 205.
Pattern:
(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
Required: Yes
- uploadId
-
The upload ID from a previous InitiateLayerUpload operation to associate with the image layer.
Type: String
Pattern:
[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
Required: Yes
Response Syntax
{
"layerDigest": "string",
"registryId": "string",
"repositoryName": "string",
"uploadId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- layerDigest
-
The
sha256
digest of the image layer.Type: String
Pattern:
[a-zA-Z0-9-_+.]+:[a-fA-F0-9]+
- registryId
-
The public registry ID that's associated with the request.
Type: String
Pattern:
[0-9]{12}
- repositoryName
-
The repository name that's associated with the request.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 205.
Pattern:
(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*
- uploadId
-
The upload ID that's associated with the layer.
Type: String
Pattern:
[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
Errors
For information about the errors that are common to all actions, see Common Errors.
- EmptyUploadException
-
The specified layer upload doesn't contain any layer parts.
HTTP Status Code: 400
- InvalidLayerException
-
The layer digest calculation performed by Amazon ECR when the image layer doesn't match the digest specified.
HTTP Status Code: 400
- InvalidParameterException
-
The specified parameter is invalid. Review the available parameters for the API request.
HTTP Status Code: 400
- LayerAlreadyExistsException
-
The image layer already exists in the associated repository.
HTTP Status Code: 400
- LayerPartTooSmallException
-
Layer parts must be at least 5 MiB in size.
HTTP Status Code: 400
- RegistryNotFoundException
-
The registry doesn't exist.
HTTP Status Code: 400
- RepositoryNotFoundException
-
The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server-side issue.
HTTP Status Code: 500
- UnsupportedCommandException
-
The action isn't supported in this Region.
HTTP Status Code: 400
- UploadNotFoundException
-
The upload can't be found, or the specified upload ID isn't valid for this repository.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: