UploadLayerPart
Uploads an image layer part to Amazon ECR.
When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (about 20MB). The UploadLayerPart API is called once for each new image layer part.
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
{
"layerPartBlob": blob
,
"partFirstByte": number
,
"partLastByte": number
,
"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.
- layerPartBlob
-
The base64-encoded layer part payload.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 0. Maximum length of 20971520.
Required: Yes
- partFirstByte
-
The position of the first byte of the layer part witin the overall image layer.
Type: Long
Valid Range: Minimum value of 0.
Required: Yes
- partLastByte
-
The position of the last byte of the layer part within the overall image layer.
Type: Long
Valid Range: Minimum value of 0.
Required: Yes
- registryId
-
The AWS account ID, or registry alias, that's associated with the registry that you're uploading layer parts to. 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 that you're uploading layer parts to.
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 layer part upload.
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
{
"lastByteReceived": number,
"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.
- lastByteReceived
-
The integer value of the last byte that's received in the request.
Type: Long
Valid Range: Minimum value of 0.
- registryId
-
The 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 request.
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.
- InvalidLayerPartException
-
The layer part size isn't valid, or the first byte specified isn't consecutive to the last byte of a previous layer part upload.
HTTP Status Code: 400
- InvalidParameterException
-
The specified parameter is invalid. Review the available parameters for the API request.
HTTP Status Code: 400
- LimitExceededException
-
The operation didn't succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Public service quotas in the Amazon Elastic Container Registry Public User Guide.
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: